class Kaltura::KalturaCategoryUserService

Add & Manage CategoryUser - membership of a user in a category

Public Class Methods

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

Public Instance Methods

activate(category_id, user_id) click to toggle source

activate CategoryUser @return [KalturaCategoryUser]

# File lib/kaltura_client.rb, line 1032
def activate(category_id, user_id)
        kparams = {}
        client.add_param(kparams, 'categoryId', category_id)
        client.add_param(kparams, 'userId', user_id)
        client.queue_service_action_call('categoryuser', 'activate', 'KalturaCategoryUser', kparams)
        if (client.is_multirequest)
                return nil
        end
        return client.do_queue()
end
add(category_user) click to toggle source

Add new CategoryUser @return [KalturaCategoryUser]

# File lib/kaltura_client.rb, line 1045
def add(category_user)
        kparams = {}
        client.add_param(kparams, 'categoryUser', category_user)
        client.queue_service_action_call('categoryuser', 'add', 'KalturaCategoryUser', kparams)
        if (client.is_multirequest)
                return nil
        end
        return client.do_queue()
end
add_from_bulk_upload(file_data, bulk_upload_data=KalturaNotImplemented, bulk_upload_category_user_data=KalturaNotImplemented) click to toggle source

@return [KalturaBulkUpload]

# File lib/kaltura_client.rb, line 1056
def add_from_bulk_upload(file_data, bulk_upload_data=KalturaNotImplemented, bulk_upload_category_user_data=KalturaNotImplemented)
        kparams = {}
        kfiles = {}
        client.add_param(kfiles, 'fileData', file_data)
        client.add_param(kparams, 'bulkUploadData', bulk_upload_data)
        client.add_param(kparams, 'bulkUploadCategoryUserData', bulk_upload_category_user_data)
        client.queue_service_action_call('categoryuser', 'addFromBulkUpload', 'KalturaBulkUpload', kparams, kfiles)
        if (client.is_multirequest)
                return nil
        end
        return client.do_queue()
end
copy_from_category(category_id) click to toggle source

Copy all member from parent category @return []

# File lib/kaltura_client.rb, line 1071
def copy_from_category(category_id)
        kparams = {}
        client.add_param(kparams, 'categoryId', category_id)
        client.queue_service_action_call('categoryuser', 'copyFromCategory', '', kparams)
        if (client.is_multirequest)
                return nil
        end
        return client.do_queue()
end
deactivate(category_id, user_id) click to toggle source

reject CategoryUser @return [KalturaCategoryUser]

# File lib/kaltura_client.rb, line 1083
def deactivate(category_id, user_id)
        kparams = {}
        client.add_param(kparams, 'categoryId', category_id)
        client.add_param(kparams, 'userId', user_id)
        client.queue_service_action_call('categoryuser', 'deactivate', 'KalturaCategoryUser', kparams)
        if (client.is_multirequest)
                return nil
        end
        return client.do_queue()
end
delete(category_id, user_id) click to toggle source

Delete a CategoryUser @return []

# File lib/kaltura_client.rb, line 1096
def delete(category_id, user_id)
        kparams = {}
        client.add_param(kparams, 'categoryId', category_id)
        client.add_param(kparams, 'userId', user_id)
        client.queue_service_action_call('categoryuser', 'delete', '', kparams)
        if (client.is_multirequest)
                return nil
        end
        return client.do_queue()
end
get(category_id, user_id) click to toggle source

Get CategoryUser by id @return [KalturaCategoryUser]

# File lib/kaltura_client.rb, line 1109
def get(category_id, user_id)
        kparams = {}
        client.add_param(kparams, 'categoryId', category_id)
        client.add_param(kparams, 'userId', user_id)
        client.queue_service_action_call('categoryuser', 'get', 'KalturaCategoryUser', kparams)
        if (client.is_multirequest)
                return nil
        end
        return client.do_queue()
end
index(user_id, category_id, should_update=true) click to toggle source

Index CategoryUser by userid and category id @return [int]

# File lib/kaltura_client.rb, line 1122
def index(user_id, category_id, should_update=true)
        kparams = {}
        client.add_param(kparams, 'userId', user_id)
        client.add_param(kparams, 'categoryId', category_id)
        client.add_param(kparams, 'shouldUpdate', should_update)
        client.queue_service_action_call('categoryuser', 'index', 'int', kparams)
        if (client.is_multirequest)
                return nil
        end
        return client.do_queue()
end
list(filter=KalturaNotImplemented, pager=KalturaNotImplemented) click to toggle source

List all categories @return [KalturaCategoryUserListResponse]

# File lib/kaltura_client.rb, line 1136
def list(filter=KalturaNotImplemented, pager=KalturaNotImplemented)
        kparams = {}
        client.add_param(kparams, 'filter', filter)
        client.add_param(kparams, 'pager', pager)
        client.queue_service_action_call('categoryuser', 'list', 'KalturaCategoryUserListResponse', kparams)
        if (client.is_multirequest)
                return nil
        end
        return client.do_queue()
end
update(category_id, user_id, category_user, override=false) click to toggle source

Update CategoryUser by id @return [KalturaCategoryUser]

# File lib/kaltura_client.rb, line 1149
def update(category_id, user_id, category_user, override=false)
        kparams = {}
        client.add_param(kparams, 'categoryId', category_id)
        client.add_param(kparams, 'userId', user_id)
        client.add_param(kparams, 'categoryUser', category_user)
        client.add_param(kparams, 'override', override)
        client.queue_service_action_call('categoryuser', 'update', 'KalturaCategoryUser', kparams)
        if (client.is_multirequest)
                return nil
        end
        return client.do_queue()
end