Class: Kaltura::KalturaUserRoleService
- Inherits:
-
KalturaServiceBase
- Object
- KalturaServiceBase
- Kaltura::KalturaUserRoleService
- Defined in:
- lib/kaltura_client.rb
Overview
UserRole service lets you create and manage user roles
Instance Attribute Summary
Attributes inherited from KalturaServiceBase
Instance Method Summary collapse
-
#add(user_role) ⇒ KalturaUserRole
Adds a new user role object to the account.
-
#clone(user_role_id) ⇒ KalturaUserRole
Creates a new user role object that is a duplicate of an existing role.
-
#delete(user_role_id) ⇒ KalturaUserRole
Deletes an existing user role object.
-
#get(user_role_id) ⇒ KalturaUserRole
Retrieves a user role object using its ID.
-
#initialize(client) ⇒ KalturaUserRoleService
constructor
A new instance of KalturaUserRoleService.
-
#list(filter = KalturaNotImplemented, pager = KalturaNotImplemented) ⇒ KalturaUserRoleListResponse
Lists user role objects that are associated with an account.
-
#update(user_role_id, user_role) ⇒ KalturaUserRole
Updates an existing user role object.
Constructor Details
#initialize(client) ⇒ KalturaUserRoleService
Returns a new instance of KalturaUserRoleService.
5324 5325 5326 |
# File 'lib/kaltura_client.rb', line 5324 def initialize(client) super(client) end |
Instance Method Details
#add(user_role) ⇒ KalturaUserRole
Adds a new user role object to the account.
5330 5331 5332 5333 5334 5335 5336 5337 5338 |
# File 'lib/kaltura_client.rb', line 5330 def add(user_role) kparams = {} client.add_param(kparams, 'userRole', user_role) client.queue_service_action_call('userrole', 'add', 'KalturaUserRole', kparams) if (client.is_multirequest) return nil end return client.do_queue() end |
#clone(user_role_id) ⇒ KalturaUserRole
Creates a new user role object that is a duplicate of an existing role.
5342 5343 5344 5345 5346 5347 5348 5349 5350 |
# File 'lib/kaltura_client.rb', line 5342 def clone(user_role_id) kparams = {} client.add_param(kparams, 'userRoleId', user_role_id) client.queue_service_action_call('userrole', 'clone', 'KalturaUserRole', kparams) if (client.is_multirequest) return nil end return client.do_queue() end |
#delete(user_role_id) ⇒ KalturaUserRole
Deletes an existing user role object.
5354 5355 5356 5357 5358 5359 5360 5361 5362 |
# File 'lib/kaltura_client.rb', line 5354 def delete(user_role_id) kparams = {} client.add_param(kparams, 'userRoleId', user_role_id) client.queue_service_action_call('userrole', 'delete', 'KalturaUserRole', kparams) if (client.is_multirequest) return nil end return client.do_queue() end |
#get(user_role_id) ⇒ KalturaUserRole
Retrieves a user role object using its ID.
5366 5367 5368 5369 5370 5371 5372 5373 5374 |
# File 'lib/kaltura_client.rb', line 5366 def get(user_role_id) kparams = {} client.add_param(kparams, 'userRoleId', user_role_id) client.queue_service_action_call('userrole', 'get', 'KalturaUserRole', kparams) if (client.is_multirequest) return nil end return client.do_queue() end |
#list(filter = KalturaNotImplemented, pager = KalturaNotImplemented) ⇒ KalturaUserRoleListResponse
Lists user role objects that are associated with an account. Blocked user roles are listed unless you use a filter to exclude them. Deleted user roles are not listed unless you use a filter to include them.
5380 5381 5382 5383 5384 5385 5386 5387 5388 5389 |
# File 'lib/kaltura_client.rb', line 5380 def list(filter=KalturaNotImplemented, pager=KalturaNotImplemented) kparams = {} client.add_param(kparams, 'filter', filter) client.add_param(kparams, 'pager', pager) client.queue_service_action_call('userrole', 'list', 'KalturaUserRoleListResponse', kparams) if (client.is_multirequest) return nil end return client.do_queue() end |
#update(user_role_id, user_role) ⇒ KalturaUserRole
Updates an existing user role object.
5393 5394 5395 5396 5397 5398 5399 5400 5401 5402 |
# File 'lib/kaltura_client.rb', line 5393 def update(user_role_id, user_role) kparams = {} client.add_param(kparams, 'userRoleId', user_role_id) client.add_param(kparams, 'userRole', user_role) client.queue_service_action_call('userrole', 'update', 'KalturaUserRole', kparams) if (client.is_multirequest) return nil end return client.do_queue() end |