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



9085
9086
9087
 
# File 'lib/kaltura_types.rb', line 9085

def application_id
  @application_id
end

#client_ver ⇒ Object

Returns the value of attribute client_ver.



9052
9053
9054
 
# File 'lib/kaltura_types.rb', line 9052

def client_ver
  @client_ver
end

#context_id ⇒ Object

Returns the value of attribute context_id.



9086
9087
9088
 
# File 'lib/kaltura_types.rb', line 9086

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



9075
9076
9077
 
# File 'lib/kaltura_types.rb', line 9075

def control_id
  @control_id
end

#current_point ⇒ Object

the timestamp along the video when the event happend



9067
9068
9069
 
# File 'lib/kaltura_types.rb', line 9067

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



9069
9070
9071
 
# File 'lib/kaltura_types.rb', line 9069

def duration
  @duration
end

#entry_id ⇒ Object

Returns the value of attribute entry_id.



9059
9060
9061
 
# File 'lib/kaltura_types.rb', line 9059

def entry_id
  @entry_id
end

#event_timestamp ⇒ Object

the client’s timestamp of this event



9055
9056
9057
 
# File 'lib/kaltura_types.rb', line 9055

def event_timestamp
  @event_timestamp
end

#event_type ⇒ Object

Returns the value of attribute event_type.



9053
9054
9055
 
# File 'lib/kaltura_types.rb', line 9053

def event_type
  @event_type
end

#feature_type ⇒ Object

Returns the value of attribute feature_type.



9087
9088
9089
 
# File 'lib/kaltura_types.rb', line 9087

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



9083
9084
9085
 
# File 'lib/kaltura_types.rb', line 9083

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



9079
9080
9081
 
# File 'lib/kaltura_types.rb', line 9079

def new_point
  @new_point
end

#partner_id ⇒ Object

Returns the value of attribute partner_id.



9058
9059
9060
 
# File 'lib/kaltura_types.rb', line 9058

def partner_id
  @partner_id
end

#process_duration ⇒ Object

the time in milliseconds the event took



9073
9074
9075
 
# File 'lib/kaltura_types.rb', line 9073

def process_duration
  @process_duration
end

#referrer ⇒ Object

the referrer of the client



9081
9082
9083
 
# File 'lib/kaltura_types.rb', line 9081

def referrer
  @referrer
end

#seek ⇒ Object

true if the user ever used seek in this session



9077
9078
9079
 
# File 'lib/kaltura_types.rb', line 9077

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



9057
9058
9059
 
# File 'lib/kaltura_types.rb', line 9057

def session_id
  @session_id
end

#uiconf_id ⇒ Object

Returns the value of attribute uiconf_id.



9063
9064
9065
 
# File 'lib/kaltura_types.rb', line 9063

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



9061
9062
9063
 
# File 'lib/kaltura_types.rb', line 9061

def unique_viewer
  @unique_viewer
end

#user_id ⇒ Object

the partner’s user id



9065
9066
9067
 
# File 'lib/kaltura_types.rb', line 9065

def user_id
  @user_id
end

#user_ip ⇒ Object

will be retrieved from the request of the user



9071
9072
9073
 
# File 'lib/kaltura_types.rb', line 9071

def user_ip
  @user_ip
end

#widget_id ⇒ Object

Returns the value of attribute widget_id.



9062
9063
9064
 
# File 'lib/kaltura_types.rb', line 9062

def widget_id
  @widget_id
end

Instance Method Details

#from_xml(xml_element) ⇒ Object 



9126
9127
9128
9129
9130
9131
9132
9133
9134
9135
9136
9137
9138
9139
9140
9141
9142
9143
9144
9145
9146
9147
9148
9149
9150
9151
9152
9153
9154
9155
9156
9157
9158
9159
9160
9161
9162
9163
9164
9165
9166
9167
9168
9169
9170
9171
9172
9173
9174
9175
9176
9177
9178
9179
9180
9181
9182
9183
9184
9185
9186
9187
9188
9189
9190
9191
9192
9193
9194
 
# File 'lib/kaltura_types.rb', line 9126

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