Class: Kaltura::KalturaStatsEvent
- Inherits:
-
KalturaObjectBase
- Object
- KalturaObjectBase
- Kaltura::KalturaStatsEvent
- 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
-
#application_id ⇒ Object
kaltura application name.
-
#client_ver ⇒ Object
Returns the value of attribute client_ver.
-
#context_id ⇒ Object
Returns the value of attribute context_id.
-
#control_id ⇒ Object
the id of the GUI control - will be used in the future to better understand what the user clicked.
-
#current_point ⇒ Object
the timestamp along the video when the event happend.
-
#duration ⇒ Object
the duration of the video in milliseconds - will make it much faster than quering the db for each entry.
-
#entry_id ⇒ Object
Returns the value of attribute entry_id.
-
#event_timestamp ⇒ Object
the client’s timestamp of this event.
-
#event_type ⇒ Object
Returns the value of attribute event_type.
-
#feature_type ⇒ Object
Returns the value of attribute feature_type.
-
#is_first_in_session ⇒ Object
will indicate if the event is thrown for the first video in the session.
-
#new_point ⇒ Object
timestamp of the new point on the timeline of the video after the user seeks.
-
#partner_id ⇒ Object
Returns the value of attribute partner_id.
-
#process_duration ⇒ Object
the time in milliseconds the event took.
-
#referrer ⇒ Object
the referrer of the client.
-
#seek ⇒ Object
true if the user ever used seek in this session.
-
#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.
-
#uiconf_id ⇒ Object
Returns the value of attribute uiconf_id.
-
#unique_viewer ⇒ Object
the UV cookie - creates in the operational system and should be passed on ofr every event.
-
#user_id ⇒ Object
the partner’s user id.
-
#user_ip ⇒ Object
will be retrieved from the request of the user.
-
#widget_id ⇒ Object
Returns the value of attribute widget_id.
Attributes inherited from KalturaObjectBase
#object_type, #related_objects
Instance Method Summary collapse
Methods inherited from KalturaObjectBase
Instance Attribute Details
#application_id ⇒ Object
kaltura application name
9551 9552 9553 |
# File 'lib/kaltura_types.rb', line 9551 def application_id @application_id end |
#client_ver ⇒ Object
Returns the value of attribute client_ver.
9518 9519 9520 |
# File 'lib/kaltura_types.rb', line 9518 def client_ver @client_ver end |
#context_id ⇒ Object
Returns the value of attribute context_id.
9552 9553 9554 |
# File 'lib/kaltura_types.rb', line 9552 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
9541 9542 9543 |
# File 'lib/kaltura_types.rb', line 9541 def control_id @control_id end |
#current_point ⇒ Object
the timestamp along the video when the event happend
9533 9534 9535 |
# File 'lib/kaltura_types.rb', line 9533 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
9535 9536 9537 |
# File 'lib/kaltura_types.rb', line 9535 def duration @duration end |
#entry_id ⇒ Object
Returns the value of attribute entry_id.
9525 9526 9527 |
# File 'lib/kaltura_types.rb', line 9525 def entry_id @entry_id end |
#event_timestamp ⇒ Object
the client’s timestamp of this event
9521 9522 9523 |
# File 'lib/kaltura_types.rb', line 9521 def @event_timestamp end |
#event_type ⇒ Object
Returns the value of attribute event_type.
9519 9520 9521 |
# File 'lib/kaltura_types.rb', line 9519 def event_type @event_type end |
#feature_type ⇒ Object
Returns the value of attribute feature_type.
9553 9554 9555 |
# File 'lib/kaltura_types.rb', line 9553 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
9549 9550 9551 |
# File 'lib/kaltura_types.rb', line 9549 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
9545 9546 9547 |
# File 'lib/kaltura_types.rb', line 9545 def new_point @new_point end |
#partner_id ⇒ Object
Returns the value of attribute partner_id.
9524 9525 9526 |
# File 'lib/kaltura_types.rb', line 9524 def partner_id @partner_id end |
#process_duration ⇒ Object
the time in milliseconds the event took
9539 9540 9541 |
# File 'lib/kaltura_types.rb', line 9539 def process_duration @process_duration end |
#referrer ⇒ Object
the referrer of the client
9547 9548 9549 |
# File 'lib/kaltura_types.rb', line 9547 def referrer @referrer end |
#seek ⇒ Object
true if the user ever used seek in this session
9543 9544 9545 |
# File 'lib/kaltura_types.rb', line 9543 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
9523 9524 9525 |
# File 'lib/kaltura_types.rb', line 9523 def session_id @session_id end |
#uiconf_id ⇒ Object
Returns the value of attribute uiconf_id.
9529 9530 9531 |
# File 'lib/kaltura_types.rb', line 9529 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
9527 9528 9529 |
# File 'lib/kaltura_types.rb', line 9527 def unique_viewer @unique_viewer end |
#user_id ⇒ Object
the partner’s user id
9531 9532 9533 |
# File 'lib/kaltura_types.rb', line 9531 def user_id @user_id end |
#user_ip ⇒ Object
will be retrieved from the request of the user
9537 9538 9539 |
# File 'lib/kaltura_types.rb', line 9537 def user_ip @user_ip end |
#widget_id ⇒ Object
Returns the value of attribute widget_id.
9528 9529 9530 |
# File 'lib/kaltura_types.rb', line 9528 def @widget_id end |
Instance Method Details
#from_xml(xml_element) ⇒ Object
9592 9593 9594 9595 9596 9597 9598 9599 9600 9601 9602 9603 9604 9605 9606 9607 9608 9609 9610 9611 9612 9613 9614 9615 9616 9617 9618 9619 9620 9621 9622 9623 9624 9625 9626 9627 9628 9629 9630 9631 9632 9633 9634 9635 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 |
# File 'lib/kaltura_types.rb', line 9592 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. = 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. = 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 |