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



9625
9626
9627
 
# File 'lib/kaltura_types.rb', line 9625

def application_id
  @application_id
end

#client_ver ⇒ Object

Returns the value of attribute client_ver.



9592
9593
9594
 
# File 'lib/kaltura_types.rb', line 9592

def client_ver
  @client_ver
end

#context_id ⇒ Object

Returns the value of attribute context_id.



9626
9627
9628
 
# File 'lib/kaltura_types.rb', line 9626

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



9615
9616
9617
 
# File 'lib/kaltura_types.rb', line 9615

def control_id
  @control_id
end

#current_point ⇒ Object

the timestamp along the video when the event happend



9607
9608
9609
 
# File 'lib/kaltura_types.rb', line 9607

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



9609
9610
9611
 
# File 'lib/kaltura_types.rb', line 9609

def duration
  @duration
end

#entry_id ⇒ Object

Returns the value of attribute entry_id.



9599
9600
9601
 
# File 'lib/kaltura_types.rb', line 9599

def entry_id
  @entry_id
end

#event_timestamp ⇒ Object

the client’s timestamp of this event



9595
9596
9597
 
# File 'lib/kaltura_types.rb', line 9595

def event_timestamp
  @event_timestamp
end

#event_type ⇒ Object

Returns the value of attribute event_type.



9593
9594
9595
 
# File 'lib/kaltura_types.rb', line 9593

def event_type
  @event_type
end

#feature_type ⇒ Object

Returns the value of attribute feature_type.



9627
9628
9629
 
# File 'lib/kaltura_types.rb', line 9627

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



9623
9624
9625
 
# File 'lib/kaltura_types.rb', line 9623

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



9619
9620
9621
 
# File 'lib/kaltura_types.rb', line 9619

def new_point
  @new_point
end

#partner_id ⇒ Object

Returns the value of attribute partner_id.



9598
9599
9600
 
# File 'lib/kaltura_types.rb', line 9598

def partner_id
  @partner_id
end

#process_duration ⇒ Object

the time in milliseconds the event took



9613
9614
9615
 
# File 'lib/kaltura_types.rb', line 9613

def process_duration
  @process_duration
end

#referrer ⇒ Object

the referrer of the client



9621
9622
9623
 
# File 'lib/kaltura_types.rb', line 9621

def referrer
  @referrer
end

#seek ⇒ Object

true if the user ever used seek in this session



9617
9618
9619
 
# File 'lib/kaltura_types.rb', line 9617

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



9597
9598
9599
 
# File 'lib/kaltura_types.rb', line 9597

def session_id
  @session_id
end

#uiconf_id ⇒ Object

Returns the value of attribute uiconf_id.



9603
9604
9605
 
# File 'lib/kaltura_types.rb', line 9603

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



9601
9602
9603
 
# File 'lib/kaltura_types.rb', line 9601

def unique_viewer
  @unique_viewer
end

#user_id ⇒ Object

the partner’s user id



9605
9606
9607
 
# File 'lib/kaltura_types.rb', line 9605

def user_id
  @user_id
end

#user_ip ⇒ Object

will be retrieved from the request of the user



9611
9612
9613
 
# File 'lib/kaltura_types.rb', line 9611

def user_ip
  @user_ip
end

#widget_id ⇒ Object

Returns the value of attribute widget_id.



9602
9603
9604
 
# File 'lib/kaltura_types.rb', line 9602

def widget_id
  @widget_id
end

Instance Method Details

#from_xml(xml_element) ⇒ Object 



9666
9667
9668
9669
9670
9671
9672
9673
9674
9675
9676
9677
9678
9679
9680
9681
9682
9683
9684
9685
9686
9687
9688
9689
9690
9691
9692
9693
9694
9695
9696
9697
9698
9699
9700
9701
9702
9703
9704
9705
9706
9707
9708
9709
9710
9711
9712
9713
9714
9715
9716
9717
9718
9719
9720
9721
9722
9723
9724
9725
9726
9727
9728
9729
9730
9731
9732
9733
9734
 
# File 'lib/kaltura_types.rb', line 9666

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