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



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

def application_id
  @application_id
end

#client_ver ⇒ Object

Returns the value of attribute client_ver.



9562
9563
9564
 
# File 'lib/kaltura_types.rb', line 9562

def client_ver
  @client_ver
end

#context_id ⇒ Object

Returns the value of attribute context_id.



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

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



9585
9586
9587
 
# File 'lib/kaltura_types.rb', line 9585

def control_id
  @control_id
end

#current_point ⇒ Object

the timestamp along the video when the event happend



9577
9578
9579
 
# File 'lib/kaltura_types.rb', line 9577

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



9579
9580
9581
 
# File 'lib/kaltura_types.rb', line 9579

def duration
  @duration
end

#entry_id ⇒ Object

Returns the value of attribute entry_id.



9569
9570
9571
 
# File 'lib/kaltura_types.rb', line 9569

def entry_id
  @entry_id
end

#event_timestamp ⇒ Object

the client’s timestamp of this event



9565
9566
9567
 
# File 'lib/kaltura_types.rb', line 9565

def event_timestamp
  @event_timestamp
end

#event_type ⇒ Object

Returns the value of attribute event_type.



9563
9564
9565
 
# File 'lib/kaltura_types.rb', line 9563

def event_type
  @event_type
end

#feature_type ⇒ Object

Returns the value of attribute feature_type.



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

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



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

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



9589
9590
9591
 
# File 'lib/kaltura_types.rb', line 9589

def new_point
  @new_point
end

#partner_id ⇒ Object

Returns the value of attribute partner_id.



9568
9569
9570
 
# File 'lib/kaltura_types.rb', line 9568

def partner_id
  @partner_id
end

#process_duration ⇒ Object

the time in milliseconds the event took



9583
9584
9585
 
# File 'lib/kaltura_types.rb', line 9583

def process_duration
  @process_duration
end

#referrer ⇒ Object

the referrer of the client



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

def referrer
  @referrer
end

#seek ⇒ Object

true if the user ever used seek in this session



9587
9588
9589
 
# File 'lib/kaltura_types.rb', line 9587

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



9567
9568
9569
 
# File 'lib/kaltura_types.rb', line 9567

def session_id
  @session_id
end

#uiconf_id ⇒ Object

Returns the value of attribute uiconf_id.



9573
9574
9575
 
# File 'lib/kaltura_types.rb', line 9573

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



9571
9572
9573
 
# File 'lib/kaltura_types.rb', line 9571

def unique_viewer
  @unique_viewer
end

#user_id ⇒ Object

the partner’s user id



9575
9576
9577
 
# File 'lib/kaltura_types.rb', line 9575

def user_id
  @user_id
end

#user_ip ⇒ Object

will be retrieved from the request of the user



9581
9582
9583
 
# File 'lib/kaltura_types.rb', line 9581

def user_ip
  @user_ip
end

#widget_id ⇒ Object

Returns the value of attribute widget_id.



9572
9573
9574
 
# File 'lib/kaltura_types.rb', line 9572

def widget_id
  @widget_id
end

Instance Method Details

#from_xml(xml_element) ⇒ Object 



9636
9637
9638
9639
9640
9641
9642
9643
9644
9645
9646
9647
9648
9649
9650
9651
9652
9653
9654
9655
9656
9657
9658
9659
9660
9661
9662
9663
9664
9665
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
 
# File 'lib/kaltura_types.rb', line 9636

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