class Kaltura::KalturaUserRoleService

UserRole service lets you create and manage user roles

Public Class Methods

new(client) click to toggle source
Calls superclass method
# File lib/kaltura_client.rb, line 5427
def initialize(client)
        super(client)
end

Public Instance Methods

add(user_role) click to toggle source

Adds a new user role object to the account. @return [KalturaUserRole]

# 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) click to toggle source

Creates a new user role object that is a duplicate of an existing role. @return [KalturaUserRole]

# 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) click to toggle source

Deletes an existing user role object. @return [KalturaUserRole]

# 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) click to toggle source

Retrieves a user role object using its ID. @return [KalturaUserRole]

# 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) click to toggle source

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.

@return [KalturaUserRoleListResponse]

# 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) click to toggle source

Updates an existing user role object. @return [KalturaUserRole]

# 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