class Kaltura::KalturaGroupService

Public Class Methods

new(client) click to toggle source
Calls superclass method Kaltura::KalturaServiceBase::new
# File lib/kaltura_plugins/kaltura_group_client_plugin.rb, line 207
def initialize(client)
        super(client)
end

Public Instance Methods

add(group) click to toggle source

Adds a new group (user of type group). @return [KalturaGroup]

# File lib/kaltura_plugins/kaltura_group_client_plugin.rb, line 213
def add(group)
        kparams = {}
        client.add_param(kparams, 'group', group)
        client.queue_service_action_call('group_group', 'add', 'KalturaGroup', kparams)
        if (client.is_multirequest)
                return nil
        end
        return client.do_queue()
end
clone(original_group_id, new_group_id, new_group_name=KalturaNotImplemented) click to toggle source

clone the group (groupId), and set group id with the neeGroupName. @return [KalturaGroup]

# File lib/kaltura_plugins/kaltura_group_client_plugin.rb, line 225
def clone(original_group_id, new_group_id, new_group_name=KalturaNotImplemented)
        kparams = {}
        client.add_param(kparams, 'originalGroupId', original_group_id)
        client.add_param(kparams, 'newGroupId', new_group_id)
        client.add_param(kparams, 'newGroupName', new_group_name)
        client.queue_service_action_call('group_group', 'clone', 'KalturaGroup', kparams)
        if (client.is_multirequest)
                return nil
        end
        return client.do_queue()
end
delete(group_id) click to toggle source

Delete group by ID @return [KalturaGroup]

# File lib/kaltura_plugins/kaltura_group_client_plugin.rb, line 239
def delete(group_id)
        kparams = {}
        client.add_param(kparams, 'groupId', group_id)
        client.queue_service_action_call('group_group', 'delete', 'KalturaGroup', kparams)
        if (client.is_multirequest)
                return nil
        end
        return client.do_queue()
end
get(group_id) click to toggle source

Retrieves a group object for a specified group ID. @return [KalturaGroup]

# File lib/kaltura_plugins/kaltura_group_client_plugin.rb, line 251
def get(group_id)
        kparams = {}
        client.add_param(kparams, 'groupId', group_id)
        client.queue_service_action_call('group_group', 'get', 'KalturaGroup', kparams)
        if (client.is_multirequest)
                return nil
        end
        return client.do_queue()
end
list(filter=KalturaNotImplemented, pager=KalturaNotImplemented) click to toggle source

Lists group objects that are associated with an account.

Blocked users are listed unless you use a filter to exclude them.
Deleted users are not listed unless you use a filter to include them.

@return [KalturaGroupListResponse]

# File lib/kaltura_plugins/kaltura_group_client_plugin.rb, line 265
def list(filter=KalturaNotImplemented, pager=KalturaNotImplemented)
        kparams = {}
        client.add_param(kparams, 'filter', filter)
        client.add_param(kparams, 'pager', pager)
        client.queue_service_action_call('group_group', 'list', 'KalturaGroupListResponse', kparams)
        if (client.is_multirequest)
                return nil
        end
        return client.do_queue()
end
update(group_id, group) click to toggle source

Update group by ID @return [KalturaGroup]

# File lib/kaltura_plugins/kaltura_group_client_plugin.rb, line 278
def update(group_id, group)
        kparams = {}
        client.add_param(kparams, 'groupId', group_id)
        client.add_param(kparams, 'group', group)
        client.queue_service_action_call('group_group', 'update', 'KalturaGroup', kparams)
        if (client.is_multirequest)
                return nil
        end
        return client.do_queue()
end