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



9179
9180
9181
 
# File 'lib/kaltura_types.rb', line 9179

def application_id
  @application_id
end

#client_ver ⇒ Object

Returns the value of attribute client_ver.



9146
9147
9148
 
# File 'lib/kaltura_types.rb', line 9146

def client_ver
  @client_ver
end

#context_id ⇒ Object

Returns the value of attribute context_id.



9180
9181
9182
 
# File 'lib/kaltura_types.rb', line 9180

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



9169
9170
9171
 
# File 'lib/kaltura_types.rb', line 9169

def control_id
  @control_id
end

#current_point ⇒ Object

the timestamp along the video when the event happend



9161
9162
9163
 
# File 'lib/kaltura_types.rb', line 9161

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



9163
9164
9165
 
# File 'lib/kaltura_types.rb', line 9163

def duration
  @duration
end

#entry_id ⇒ Object

Returns the value of attribute entry_id.



9153
9154
9155
 
# File 'lib/kaltura_types.rb', line 9153

def entry_id
  @entry_id
end

#event_timestamp ⇒ Object

the client’s timestamp of this event



9149
9150
9151
 
# File 'lib/kaltura_types.rb', line 9149

def event_timestamp
  @event_timestamp
end

#event_type ⇒ Object

Returns the value of attribute event_type.



9147
9148
9149
 
# File 'lib/kaltura_types.rb', line 9147

def event_type
  @event_type
end

#feature_type ⇒ Object

Returns the value of attribute feature_type.



9181
9182
9183
 
# File 'lib/kaltura_types.rb', line 9181

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



9177
9178
9179
 
# File 'lib/kaltura_types.rb', line 9177

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



9173
9174
9175
 
# File 'lib/kaltura_types.rb', line 9173

def new_point
  @new_point
end

#partner_id ⇒ Object

Returns the value of attribute partner_id.



9152
9153
9154
 
# File 'lib/kaltura_types.rb', line 9152

def partner_id
  @partner_id
end

#process_duration ⇒ Object

the time in milliseconds the event took



9167
9168
9169
 
# File 'lib/kaltura_types.rb', line 9167

def process_duration
  @process_duration
end

#referrer ⇒ Object

the referrer of the client



9175
9176
9177
 
# File 'lib/kaltura_types.rb', line 9175

def referrer
  @referrer
end

#seek ⇒ Object

true if the user ever used seek in this session



9171
9172
9173
 
# File 'lib/kaltura_types.rb', line 9171

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



9151
9152
9153
 
# File 'lib/kaltura_types.rb', line 9151

def session_id
  @session_id
end

#uiconf_id ⇒ Object

Returns the value of attribute uiconf_id.



9157
9158
9159
 
# File 'lib/kaltura_types.rb', line 9157

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



9155
9156
9157
 
# File 'lib/kaltura_types.rb', line 9155

def unique_viewer
  @unique_viewer
end

#user_id ⇒ Object

the partner’s user id



9159
9160
9161
 
# File 'lib/kaltura_types.rb', line 9159

def user_id
  @user_id
end

#user_ip ⇒ Object

will be retrieved from the request of the user



9165
9166
9167
 
# File 'lib/kaltura_types.rb', line 9165

def user_ip
  @user_ip
end

#widget_id ⇒ Object

Returns the value of attribute widget_id.



9156
9157
9158
 
# File 'lib/kaltura_types.rb', line 9156

def widget_id
  @widget_id
end

Instance Method Details

#from_xml(xml_element) ⇒ Object 



9220
9221
9222
9223
9224
9225
9226
9227
9228
9229
9230
9231
9232
9233
9234
9235
9236
9237
9238
9239
9240
9241
9242
9243
9244
9245
9246
9247
9248
9249
9250
9251
9252
9253
9254
9255
9256
9257
9258
9259
9260
9261
9262
9263
9264
9265
9266
9267
9268
9269
9270
9271
9272
9273
9274
9275
9276
9277
9278
9279
9280
9281
9282
9283
9284
9285
9286
9287
9288
 
# File 'lib/kaltura_types.rb', line 9220

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