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



5776
5777
5778
 
# File 'lib/kaltura_types.rb', line 5776

def application_id
  @application_id
end

#client_ver ⇒ Object

Returns the value of attribute client_ver.



5729
5730
5731
 
# File 'lib/kaltura_types.rb', line 5729

def client_ver
  @client_ver
end

#context_id ⇒ Object

Returns the value of attribute context_id.



5777
5778
5779
 
# File 'lib/kaltura_types.rb', line 5777

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



5761
5762
5763
 
# File 'lib/kaltura_types.rb', line 5761

def control_id
  @control_id
end

#current_point ⇒ Object

the timestamp along the video when the event happend



5749
5750
5751
 
# File 'lib/kaltura_types.rb', line 5749

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



5752
5753
5754
 
# File 'lib/kaltura_types.rb', line 5752

def duration
  @duration
end

#entry_id ⇒ Object

Returns the value of attribute entry_id.



5738
5739
5740
 
# File 'lib/kaltura_types.rb', line 5738

def entry_id
  @entry_id
end

#event_timestamp ⇒ Object

the client’s timestamp of this event



5733
5734
5735
 
# File 'lib/kaltura_types.rb', line 5733

def event_timestamp
  @event_timestamp
end

#event_type ⇒ Object

Returns the value of attribute event_type.



5730
5731
5732
 
# File 'lib/kaltura_types.rb', line 5730

def event_type
  @event_type
end

#feature_type ⇒ Object

Returns the value of attribute feature_type.



5778
5779
5780
 
# File 'lib/kaltura_types.rb', line 5778

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



5773
5774
5775
 
# File 'lib/kaltura_types.rb', line 5773

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



5767
5768
5769
 
# File 'lib/kaltura_types.rb', line 5767

def new_point
  @new_point
end

#partner_id ⇒ Object

Returns the value of attribute partner_id.



5737
5738
5739
 
# File 'lib/kaltura_types.rb', line 5737

def partner_id
  @partner_id
end

#process_duration ⇒ Object

the time in milliseconds the event took



5758
5759
5760
 
# File 'lib/kaltura_types.rb', line 5758

def process_duration
  @process_duration
end

#referrer ⇒ Object

the referrer of the client



5770
5771
5772
 
# File 'lib/kaltura_types.rb', line 5770

def referrer
  @referrer
end

#seek ⇒ Object

true if the user ever used seek in this session



5764
5765
5766
 
# File 'lib/kaltura_types.rb', line 5764

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



5736
5737
5738
 
# File 'lib/kaltura_types.rb', line 5736

def session_id
  @session_id
end

#uiconf_id ⇒ Object

Returns the value of attribute uiconf_id.



5743
5744
5745
 
# File 'lib/kaltura_types.rb', line 5743

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



5741
5742
5743
 
# File 'lib/kaltura_types.rb', line 5741

def unique_viewer
  @unique_viewer
end

#user_id ⇒ Object

the partner’s user id



5746
5747
5748
 
# File 'lib/kaltura_types.rb', line 5746

def user_id
  @user_id
end

#user_ip ⇒ Object

will be retrieved from the request of the user



5755
5756
5757
 
# File 'lib/kaltura_types.rb', line 5755

def user_ip
  @user_ip
end

#widget_id ⇒ Object

Returns the value of attribute widget_id.



5742
5743
5744
 
# File 'lib/kaltura_types.rb', line 5742

def widget_id
  @widget_id
end

Instance Method Details

#from_xml(xml_element) ⇒ Object 



5817
5818
5819
5820
5821
5822
5823
5824
5825
5826
5827
5828
5829
5830
5831
5832
5833
5834
5835
5836
5837
5838
5839
5840
5841
 
# File 'lib/kaltura_types.rb', line 5817

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