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.



13655
13656
13657
 
# File 'lib/kaltura_client.rb', line 13655

def initialize(client)
	super(client)
end

Instance Method Details

#add(user_role) ⇒ Object

Adds a new user role object to the account.



13661
13662
13663
13664
13665
13666
13667
13668
13669
13670
 
# File 'lib/kaltura_client.rb', line 13661

def add(user_role)
	kparams = {}
	# A new role
	client.add_param(kparams, 'userRole', user_role);
	client.queue_service_action_call('userrole', 'add', kparams);
	if (client.is_multirequest)
		return nil;
	end
	return client.do_queue();
end

#clone(user_role_id) ⇒ Object

Creates a new user role object that is a duplicate of an existing role.



13732
13733
13734
13735
13736
13737
13738
13739
13740
13741
 
# File 'lib/kaltura_client.rb', line 13732

def clone(user_role_id)
	kparams = {}
	# The user role's unique identifier
	client.add_param(kparams, 'userRoleId', user_role_id);
	client.queue_service_action_call('userrole', 'clone', kparams);
	if (client.is_multirequest)
		return nil;
	end
	return client.do_queue();
end

#delete(user_role_id) ⇒ Object

Deletes an existing user role object.



13702
13703
13704
13705
13706
13707
13708
13709
13710
13711
 
# File 'lib/kaltura_client.rb', line 13702

def delete(user_role_id)
	kparams = {}
	# The user role's unique identifier
	client.add_param(kparams, 'userRoleId', user_role_id);
	client.queue_service_action_call('userrole', 'delete', kparams);
	if (client.is_multirequest)
		return nil;
	end
	return client.do_queue();
end

#get(user_role_id) ⇒ Object

Retrieves a user role object using its ID.



13674
13675
13676
13677
13678
13679
13680
13681
13682
13683
 
# File 'lib/kaltura_client.rb', line 13674

def get(user_role_id)
	kparams = {}
	# The user role's unique identifier
	client.add_param(kparams, 'userRoleId', user_role_id);
	client.queue_service_action_call('userrole', 'get', kparams);
	if (client.is_multirequest)
		return nil;
	end
	return client.do_queue();
end

#list(filter = KalturaNotImplemented, pager = KalturaNotImplemented) ⇒ Object

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.



13717
13718
13719
13720
13721
13722
13723
13724
13725
13726
13727
13728
 
# File 'lib/kaltura_client.rb', line 13717

def list(filter=KalturaNotImplemented, pager=KalturaNotImplemented)
	kparams = {}
	# A filter used to exclude specific types of user roles
	client.add_param(kparams, 'filter', filter);
	# A limit for the number of records to display on a page
	client.add_param(kparams, 'pager', pager);
	client.queue_service_action_call('userrole', 'list', kparams);
	if (client.is_multirequest)
		return nil;
	end
	return client.do_queue();
end

#update(user_role_id, user_role) ⇒ Object

Updates an existing user role object.



13687
13688
13689
13690
13691
13692
13693
13694
13695
13696
13697
13698
 
# File 'lib/kaltura_client.rb', line 13687

def update(user_role_id, user_role)
	kparams = {}
	# The user role's unique identifier
	client.add_param(kparams, 'userRoleId', user_role_id);
	# Id The user role's unique identifier
	client.add_param(kparams, 'userRole', user_role);
	client.queue_service_action_call('userrole', 'update', kparams);
	if (client.is_multirequest)
		return nil;
	end
	return client.do_queue();
end