Class: Kaltura::KalturaSessionService
- Inherits:
-
KalturaServiceBase
- Object
- KalturaServiceBase
- Kaltura::KalturaSessionService
- Defined in:
- lib/kaltura_client.rb
Overview
Session service
Instance Attribute Summary
Attributes inherited from KalturaServiceBase
Instance Method Summary collapse
-
#end ⇒ Object
End a session with the Kaltura server, making the current KS invalid.
-
#get(session = KalturaNotImplemented) ⇒ KalturaSessionInfo
Parse session key and return its info.
-
#impersonate(secret, impersonated_partner_id, user_id = '', type = 0, partner_id = KalturaNotImplemented, expiry = 86400, privileges = KalturaNotImplemented) ⇒ string
Start an impersonated session with Kaltura’s server.
-
#impersonate_by_ks(session, type = KalturaNotImplemented, expiry = KalturaNotImplemented, privileges = KalturaNotImplemented) ⇒ KalturaSessionInfo
Start an impersonated session with Kaltura’s server.
-
#initialize(client) ⇒ KalturaSessionService
constructor
A new instance of KalturaSessionService.
-
#start(secret, user_id = '', type = 0, partner_id = KalturaNotImplemented, expiry = 86400, privileges = KalturaNotImplemented) ⇒ string
Start a session with Kaltura’s server.
-
#start_widget_session(widget_id, expiry = 86400) ⇒ KalturaStartWidgetSessionResponse
Start a session for Kaltura’s flash widgets.
Constructor Details
#initialize(client) ⇒ KalturaSessionService
Returns a new instance of KalturaSessionService.
4285 4286 4287 |
# File 'lib/kaltura_client.rb', line 4285 def initialize(client) super(client) end |
Instance Method Details
#end ⇒ Object
End a session with the Kaltura server, making the current KS invalid.
4291 4292 4293 4294 4295 4296 4297 4298 |
# File 'lib/kaltura_client.rb', line 4291 def end() kparams = {} client.queue_service_action_call('session', 'end', '', kparams) if (client.is_multirequest) return nil end return client.do_queue() end |
#get(session = KalturaNotImplemented) ⇒ KalturaSessionInfo
Parse session key and return its info
4302 4303 4304 4305 4306 4307 4308 4309 4310 |
# File 'lib/kaltura_client.rb', line 4302 def get(session=KalturaNotImplemented) kparams = {} client.add_param(kparams, 'session', session) client.queue_service_action_call('session', 'get', 'KalturaSessionInfo', kparams) if (client.is_multirequest) return nil end return client.do_queue() end |
#impersonate(secret, impersonated_partner_id, user_id = '', type = 0, partner_id = KalturaNotImplemented, expiry = 86400, privileges = KalturaNotImplemented) ⇒ string
Start an impersonated session with Kaltura’s server. The result KS is the session key that you should pass to all services that requires a ticket.
4315 4316 4317 4318 4319 4320 4321 4322 4323 4324 4325 4326 4327 4328 4329 |
# File 'lib/kaltura_client.rb', line 4315 def impersonate(secret, impersonated_partner_id, user_id='', type=0, partner_id=KalturaNotImplemented, expiry=86400, privileges=KalturaNotImplemented) kparams = {} client.add_param(kparams, 'secret', secret) client.add_param(kparams, 'impersonatedPartnerId', impersonated_partner_id) client.add_param(kparams, 'userId', user_id) client.add_param(kparams, 'type', type) client.add_param(kparams, 'partnerId', partner_id) client.add_param(kparams, 'expiry', expiry) client.add_param(kparams, 'privileges', privileges) client.queue_service_action_call('session', 'impersonate', 'string', kparams) if (client.is_multirequest) return nil end return client.do_queue() end |
#impersonate_by_ks(session, type = KalturaNotImplemented, expiry = KalturaNotImplemented, privileges = KalturaNotImplemented) ⇒ KalturaSessionInfo
Start an impersonated session with Kaltura’s server. The result KS info contains the session key that you should pass to all services that requires a ticket. Type, expiry and privileges won’t be changed if they’re not set
4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 |
# File 'lib/kaltura_client.rb', line 4335 def impersonate_by_ks(session, type=KalturaNotImplemented, expiry=KalturaNotImplemented, privileges=KalturaNotImplemented) kparams = {} client.add_param(kparams, 'session', session) client.add_param(kparams, 'type', type) client.add_param(kparams, 'expiry', expiry) client.add_param(kparams, 'privileges', privileges) client.queue_service_action_call('session', 'impersonateByKs', 'KalturaSessionInfo', kparams) if (client.is_multirequest) return nil end return client.do_queue() end |
#start(secret, user_id = '', type = 0, partner_id = KalturaNotImplemented, expiry = 86400, privileges = KalturaNotImplemented) ⇒ string
Start a session with Kaltura’s server. The result KS is the session key that you should pass to all services that requires a ticket.
4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363 4364 |
# File 'lib/kaltura_client.rb', line 4351 def start(secret, user_id='', type=0, partner_id=KalturaNotImplemented, expiry=86400, privileges=KalturaNotImplemented) kparams = {} client.add_param(kparams, 'secret', secret) client.add_param(kparams, 'userId', user_id) client.add_param(kparams, 'type', type) client.add_param(kparams, 'partnerId', partner_id) client.add_param(kparams, 'expiry', expiry) client.add_param(kparams, 'privileges', privileges) client.queue_service_action_call('session', 'start', 'string', kparams) if (client.is_multirequest) return nil end return client.do_queue() end |
#start_widget_session(widget_id, expiry = 86400) ⇒ KalturaStartWidgetSessionResponse
Start a session for Kaltura’s flash widgets
4368 4369 4370 4371 4372 4373 4374 4375 4376 4377 |
# File 'lib/kaltura_client.rb', line 4368 def (, expiry=86400) kparams = {} client.add_param(kparams, 'widgetId', ) client.add_param(kparams, 'expiry', expiry) client.queue_service_action_call('session', 'startWidgetSession', 'KalturaStartWidgetSessionResponse', kparams) if (client.is_multirequest) return nil end return client.do_queue() end |