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



9008
9009
9010
 
# File 'lib/kaltura_types.rb', line 9008

def application_id
  @application_id
end

#client_ver ⇒ Object

Returns the value of attribute client_ver.



8975
8976
8977
 
# File 'lib/kaltura_types.rb', line 8975

def client_ver
  @client_ver
end

#context_id ⇒ Object

Returns the value of attribute context_id.



9009
9010
9011
 
# File 'lib/kaltura_types.rb', line 9009

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



8998
8999
9000
 
# File 'lib/kaltura_types.rb', line 8998

def control_id
  @control_id
end

#current_point ⇒ Object

the timestamp along the video when the event happend



8990
8991
8992
 
# File 'lib/kaltura_types.rb', line 8990

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



8992
8993
8994
 
# File 'lib/kaltura_types.rb', line 8992

def duration
  @duration
end

#entry_id ⇒ Object

Returns the value of attribute entry_id.



8982
8983
8984
 
# File 'lib/kaltura_types.rb', line 8982

def entry_id
  @entry_id
end

#event_timestamp ⇒ Object

the client’s timestamp of this event



8978
8979
8980
 
# File 'lib/kaltura_types.rb', line 8978

def event_timestamp
  @event_timestamp
end

#event_type ⇒ Object

Returns the value of attribute event_type.



8976
8977
8978
 
# File 'lib/kaltura_types.rb', line 8976

def event_type
  @event_type
end

#feature_type ⇒ Object

Returns the value of attribute feature_type.



9010
9011
9012
 
# File 'lib/kaltura_types.rb', line 9010

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



9006
9007
9008
 
# File 'lib/kaltura_types.rb', line 9006

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



9002
9003
9004
 
# File 'lib/kaltura_types.rb', line 9002

def new_point
  @new_point
end

#partner_id ⇒ Object

Returns the value of attribute partner_id.



8981
8982
8983
 
# File 'lib/kaltura_types.rb', line 8981

def partner_id
  @partner_id
end

#process_duration ⇒ Object

the time in milliseconds the event took



8996
8997
8998
 
# File 'lib/kaltura_types.rb', line 8996

def process_duration
  @process_duration
end

#referrer ⇒ Object

the referrer of the client



9004
9005
9006
 
# File 'lib/kaltura_types.rb', line 9004

def referrer
  @referrer
end

#seek ⇒ Object

true if the user ever used seek in this session



9000
9001
9002
 
# File 'lib/kaltura_types.rb', line 9000

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



8980
8981
8982
 
# File 'lib/kaltura_types.rb', line 8980

def session_id
  @session_id
end

#uiconf_id ⇒ Object

Returns the value of attribute uiconf_id.



8986
8987
8988
 
# File 'lib/kaltura_types.rb', line 8986

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



8984
8985
8986
 
# File 'lib/kaltura_types.rb', line 8984

def unique_viewer
  @unique_viewer
end

#user_id ⇒ Object

the partner’s user id



8988
8989
8990
 
# File 'lib/kaltura_types.rb', line 8988

def user_id
  @user_id
end

#user_ip ⇒ Object

will be retrieved from the request of the user



8994
8995
8996
 
# File 'lib/kaltura_types.rb', line 8994

def user_ip
  @user_ip
end

#widget_id ⇒ Object

Returns the value of attribute widget_id.



8985
8986
8987
 
# File 'lib/kaltura_types.rb', line 8985

def widget_id
  @widget_id
end

Instance Method Details

#from_xml(xml_element) ⇒ Object 



9049
9050
9051
9052
9053
9054
9055
9056
9057
9058
9059
9060
9061
9062
9063
9064
9065
9066
9067
9068
9069
9070
9071
9072
9073
9074
9075
9076
9077
9078
9079
9080
9081
9082
9083
9084
9085
9086
9087
9088
9089
9090
9091
9092
9093
9094
9095
9096
9097
9098
9099
9100
9101
9102
9103
9104
9105
9106
9107
9108
9109
9110
9111
9112
9113
9114
9115
9116
9117
 
# File 'lib/kaltura_types.rb', line 9049

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