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.



5118
5119
5120
 
# File 'lib/kaltura_client.rb', line 5118

def initialize(client)
	super(client)
end

Instance Method Details

#add(user_role) ⇒ Object

Adds a new user role object to the account.



5124
5125
5126
5127
5128
5129
5130
5131
5132
 
# File 'lib/kaltura_client.rb', line 5124

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) ⇒ Object

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



5188
5189
5190
5191
5192
5193
5194
5195
5196
 
# File 'lib/kaltura_client.rb', line 5188

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) ⇒ Object

Deletes an existing user role object.



5161
5162
5163
5164
5165
5166
5167
5168
5169
 
# File 'lib/kaltura_client.rb', line 5161

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) ⇒ Object

Retrieves a user role object using its ID.



5136
5137
5138
5139
5140
5141
5142
5143
5144
 
# File 'lib/kaltura_client.rb', line 5136

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) ⇒ 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.



5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
 
# File 'lib/kaltura_client.rb', line 5175

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) ⇒ Object

Updates an existing user role object.



5148
5149
5150
5151
5152
5153
5154
5155
5156
5157
 
# File 'lib/kaltura_client.rb', line 5148

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