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.
5453 5454 5455 |
# File 'lib/kaltura_client.rb', line 5453 def initialize(client) super(client) end |
Instance Method Details
#add(user_role) ⇒ KalturaUserRole
Adds a new user role object to the account.
5459 5460 5461 5462 5463 5464 5465 5466 5467 |
# File 'lib/kaltura_client.rb', line 5459 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.
5471 5472 5473 5474 5475 5476 5477 5478 5479 |
# File 'lib/kaltura_client.rb', line 5471 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.
5483 5484 5485 5486 5487 5488 5489 5490 5491 |
# File 'lib/kaltura_client.rb', line 5483 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.
5495 5496 5497 5498 5499 5500 5501 5502 5503 |
# File 'lib/kaltura_client.rb', line 5495 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.
5509 5510 5511 5512 5513 5514 5515 5516 5517 5518 |
# File 'lib/kaltura_client.rb', line 5509 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.
5522 5523 5524 5525 5526 5527 5528 5529 5530 5531 |
# File 'lib/kaltura_client.rb', line 5522 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 |