Class: Kaltura::KalturaUserRoleService

Inherits:
KalturaServiceBase show all
Defined in:
lib/kaltura_client.rb

Overview

UserRole service lets you create and manage user roles

Instance Attribute Summary

Attributes inherited from KalturaServiceBase

#client

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ KalturaUserRoleService

Returns a new instance of KalturaUserRoleService.



5427
5428
5429
 
# File 'lib/kaltura_client.rb', line 5427

def initialize(client)
  super(client)
end

Instance Method Details

#add(user_role) ⇒ KalturaUserRole

Adds a new user role object to the account.

Returns:



5433
5434
5435
5436
5437
5438
5439
5440
5441
 
# File 'lib/kaltura_client.rb', line 5433

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.

Returns:



5445
5446
5447
5448
5449
5450
5451
5452
5453
 
# File 'lib/kaltura_client.rb', line 5445

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.

Returns:



5457
5458
5459
5460
5461
5462
5463
5464
5465
 
# File 'lib/kaltura_client.rb', line 5457

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.

Returns:



5469
5470
5471
5472
5473
5474
5475
5476
5477
 
# File 'lib/kaltura_client.rb', line 5469

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.

Returns:



5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
 
# File 'lib/kaltura_client.rb', line 5483

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.

Returns:



5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
 
# File 'lib/kaltura_client.rb', line 5496

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