Class: Kaltura::KalturaStatsEvent

Inherits:
KalturaObjectBase show all
Defined in:
lib/kaltura_types.rb

Overview

Will hold data from the Kaltura UI components to be passed on to the reports and analytics system

Instance Attribute Summary collapse

Attributes inherited from KalturaObjectBase

#object_type, #related_objects

Instance Method Summary collapse

Methods inherited from KalturaObjectBase

#camelcase, #to_b, #to_params

Instance Attribute Details

#application_id ⇒ Object

kaltura application name



9488
9489
9490
 
# File 'lib/kaltura_types.rb', line 9488

def application_id
  @application_id
end

#client_ver ⇒ Object

Returns the value of attribute client_ver.



9455
9456
9457
 
# File 'lib/kaltura_types.rb', line 9455

def client_ver
  @client_ver
end

#context_id ⇒ Object

Returns the value of attribute context_id.



9489
9490
9491
 
# File 'lib/kaltura_types.rb', line 9489

def context_id
  @context_id
end

#control_id ⇒ Object

the id of the GUI control - will be used in the future to better understand what the user clicked



9478
9479
9480
 
# File 'lib/kaltura_types.rb', line 9478

def control_id
  @control_id
end

#current_point ⇒ Object

the timestamp along the video when the event happend



9470
9471
9472
 
# File 'lib/kaltura_types.rb', line 9470

def current_point
  @current_point
end

#duration ⇒ Object

the duration of the video in milliseconds - will make it much faster than quering the db for each entry



9472
9473
9474
 
# File 'lib/kaltura_types.rb', line 9472

def duration
  @duration
end

#entry_id ⇒ Object

Returns the value of attribute entry_id.



9462
9463
9464
 
# File 'lib/kaltura_types.rb', line 9462

def entry_id
  @entry_id
end

#event_timestamp ⇒ Object

the client’s timestamp of this event



9458
9459
9460
 
# File 'lib/kaltura_types.rb', line 9458

def event_timestamp
  @event_timestamp
end

#event_type ⇒ Object

Returns the value of attribute event_type.



9456
9457
9458
 
# File 'lib/kaltura_types.rb', line 9456

def event_type
  @event_type
end

#feature_type ⇒ Object

Returns the value of attribute feature_type.



9490
9491
9492
 
# File 'lib/kaltura_types.rb', line 9490

def feature_type
  @feature_type
end

#is_first_in_session ⇒ Object

will indicate if the event is thrown for the first video in the session



9486
9487
9488
 
# File 'lib/kaltura_types.rb', line 9486

def is_first_in_session
  @is_first_in_session
end

#new_point ⇒ Object

timestamp of the new point on the timeline of the video after the user seeks



9482
9483
9484
 
# File 'lib/kaltura_types.rb', line 9482

def new_point
  @new_point
end

#partner_id ⇒ Object

Returns the value of attribute partner_id.



9461
9462
9463
 
# File 'lib/kaltura_types.rb', line 9461

def partner_id
  @partner_id
end

#process_duration ⇒ Object

the time in milliseconds the event took



9476
9477
9478
 
# File 'lib/kaltura_types.rb', line 9476

def process_duration
  @process_duration
end

#referrer ⇒ Object

the referrer of the client



9484
9485
9486
 
# File 'lib/kaltura_types.rb', line 9484

def referrer
  @referrer
end

#seek ⇒ Object

true if the user ever used seek in this session



9480
9481
9482
 
# File 'lib/kaltura_types.rb', line 9480

def seek
  @seek
end

#session_id ⇒ Object

a unique string generated by the client that will represent the client-side session: the primary component will pass it on to other components that sprout from it



9460
9461
9462
 
# File 'lib/kaltura_types.rb', line 9460

def session_id
  @session_id
end

#uiconf_id ⇒ Object

Returns the value of attribute uiconf_id.



9466
9467
9468
 
# File 'lib/kaltura_types.rb', line 9466

def uiconf_id
  @uiconf_id
end

#unique_viewer ⇒ Object

the UV cookie - creates in the operational system and should be passed on ofr every event



9464
9465
9466
 
# File 'lib/kaltura_types.rb', line 9464

def unique_viewer
  @unique_viewer
end

#user_id ⇒ Object

the partner’s user id



9468
9469
9470
 
# File 'lib/kaltura_types.rb', line 9468

def user_id
  @user_id
end

#user_ip ⇒ Object

will be retrieved from the request of the user



9474
9475
9476
 
# File 'lib/kaltura_types.rb', line 9474

def user_ip
  @user_ip
end

#widget_id ⇒ Object

Returns the value of attribute widget_id.



9465
9466
9467
 
# File 'lib/kaltura_types.rb', line 9465

def widget_id
  @widget_id
end

Instance Method Details

#from_xml(xml_element) ⇒ Object 



9529
9530
9531
9532
9533
9534
9535
9536
9537
9538
9539
9540
9541
9542
9543
9544
9545
9546
9547
9548
9549
9550
9551
9552
9553
9554
9555
9556
9557
9558
9559
9560
9561
9562
9563
9564
9565
9566
9567
9568
9569
9570
9571
9572
9573
9574
9575
9576
9577
9578
9579
9580
9581
9582
9583
9584
9585
9586
9587
9588
9589
9590
9591
9592
9593
9594
9595
9596
9597
 
# File 'lib/kaltura_types.rb', line 9529

def from_xml(xml_element)
	super
	if xml_element.elements['clientVer'] != nil
		self.client_ver = xml_element.elements['clientVer'].text
	end
	if xml_element.elements['eventType'] != nil
		self.event_type = xml_element.elements['eventType'].text
	end
	if xml_element.elements['eventTimestamp'] != nil
		self.event_timestamp = xml_element.elements['eventTimestamp'].text
	end
	if xml_element.elements['sessionId'] != nil
		self.session_id = xml_element.elements['sessionId'].text
	end
	if xml_element.elements['partnerId'] != nil
		self.partner_id = xml_element.elements['partnerId'].text
	end
	if xml_element.elements['entryId'] != nil
		self.entry_id = xml_element.elements['entryId'].text
	end
	if xml_element.elements['uniqueViewer'] != nil
		self.unique_viewer = xml_element.elements['uniqueViewer'].text
	end
	if xml_element.elements['widgetId'] != nil
		self.widget_id = xml_element.elements['widgetId'].text
	end
	if xml_element.elements['uiconfId'] != nil
		self.uiconf_id = xml_element.elements['uiconfId'].text
	end
	if xml_element.elements['userId'] != nil
		self.user_id = xml_element.elements['userId'].text
	end
	if xml_element.elements['currentPoint'] != nil
		self.current_point = xml_element.elements['currentPoint'].text
	end
	if xml_element.elements['duration'] != nil
		self.duration = xml_element.elements['duration'].text
	end
	if xml_element.elements['userIp'] != nil
		self.user_ip = xml_element.elements['userIp'].text
	end
	if xml_element.elements['processDuration'] != nil
		self.process_duration = xml_element.elements['processDuration'].text
	end
	if xml_element.elements['controlId'] != nil
		self.control_id = xml_element.elements['controlId'].text
	end
	if xml_element.elements['seek'] != nil
		self.seek = xml_element.elements['seek'].text
	end
	if xml_element.elements['newPoint'] != nil
		self.new_point = xml_element.elements['newPoint'].text
	end
	if xml_element.elements['referrer'] != nil
		self.referrer = xml_element.elements['referrer'].text
	end
	if xml_element.elements['isFirstInSession'] != nil
		self.is_first_in_session = xml_element.elements['isFirstInSession'].text
	end
	if xml_element.elements['applicationId'] != nil
		self.application_id = xml_element.elements['applicationId'].text
	end
	if xml_element.elements['contextId'] != nil
		self.context_id = xml_element.elements['contextId'].text
	end
	if xml_element.elements['featureType'] != nil
		self.feature_type = xml_element.elements['featureType'].text
	end
end