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.



5470
5471
5472
 
# File 'lib/kaltura_client.rb', line 5470

def initialize(client)
	super(client)
end

Instance Method Details

#add(user_role) ⇒ KalturaUserRole

Adds a new user role object to the account.

Returns:



5476
5477
5478
5479
5480
5481
5482
5483
5484
 
# File 'lib/kaltura_client.rb', line 5476

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:



5488
5489
5490
5491
5492
5493
5494
5495
5496
 
# File 'lib/kaltura_client.rb', line 5488

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:



5500
5501
5502
5503
5504
5505
5506
5507
5508
 
# File 'lib/kaltura_client.rb', line 5500

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:



5512
5513
5514
5515
5516
5517
5518
5519
5520
 
# File 'lib/kaltura_client.rb', line 5512

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:



5526
5527
5528
5529
5530
5531
5532
5533
5534
5535
 
# File 'lib/kaltura_client.rb', line 5526

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:



5539
5540
5541
5542
5543
5544
5545
5546
5547
5548
 
# File 'lib/kaltura_client.rb', line 5539

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