class Kaltura::KalturaDropFolderService

DropFolder service lets you create and manage drop folders

Public Class Methods

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

Public Instance Methods

add(drop_folder) click to toggle source

Allows you to add a new KalturaDropFolder object @return [KalturaDropFolder]

# File lib/kaltura_plugins/kaltura_drop_folder_client_plugin.rb, line 1184
def add(drop_folder)
        kparams = {}
        client.add_param(kparams, 'dropFolder', drop_folder)
        client.queue_service_action_call('dropfolder_dropfolder', 'add', 'KalturaDropFolder', kparams)
        if (client.is_multirequest)
                return nil
        end
        return client.do_queue()
end
delete(drop_folder_id) click to toggle source

Mark the KalturaDropFolder object as deleted @return [KalturaDropFolder]

# File lib/kaltura_plugins/kaltura_drop_folder_client_plugin.rb, line 1196
def delete(drop_folder_id)
        kparams = {}
        client.add_param(kparams, 'dropFolderId', drop_folder_id)
        client.queue_service_action_call('dropfolder_dropfolder', 'delete', 'KalturaDropFolder', kparams)
        if (client.is_multirequest)
                return nil
        end
        return client.do_queue()
end
free_exclusive_drop_folder(drop_folder_id, error_code=KalturaNotImplemented, error_description=KalturaNotImplemented) click to toggle source

freeExclusive KalturaDropFolder object @return [KalturaDropFolder]

# File lib/kaltura_plugins/kaltura_drop_folder_client_plugin.rb, line 1208
def free_exclusive_drop_folder(drop_folder_id, error_code=KalturaNotImplemented, error_description=KalturaNotImplemented)
        kparams = {}
        client.add_param(kparams, 'dropFolderId', drop_folder_id)
        client.add_param(kparams, 'errorCode', error_code)
        client.add_param(kparams, 'errorDescription', error_description)
        client.queue_service_action_call('dropfolder_dropfolder', 'freeExclusiveDropFolder', 'KalturaDropFolder', kparams)
        if (client.is_multirequest)
                return nil
        end
        return client.do_queue()
end
get(drop_folder_id) click to toggle source

Retrieve a KalturaDropFolder object by ID @return [KalturaDropFolder]

# File lib/kaltura_plugins/kaltura_drop_folder_client_plugin.rb, line 1222
def get(drop_folder_id)
        kparams = {}
        client.add_param(kparams, 'dropFolderId', drop_folder_id)
        client.queue_service_action_call('dropfolder_dropfolder', 'get', 'KalturaDropFolder', kparams)
        if (client.is_multirequest)
                return nil
        end
        return client.do_queue()
end
get_exclusive_drop_folder(tag, max_time) click to toggle source

getExclusive KalturaDropFolder object @return [KalturaDropFolder]

# File lib/kaltura_plugins/kaltura_drop_folder_client_plugin.rb, line 1234
def get_exclusive_drop_folder(tag, max_time)
        kparams = {}
        client.add_param(kparams, 'tag', tag)
        client.add_param(kparams, 'maxTime', max_time)
        client.queue_service_action_call('dropfolder_dropfolder', 'getExclusiveDropFolder', 'KalturaDropFolder', kparams)
        if (client.is_multirequest)
                return nil
        end
        return client.do_queue()
end
list(filter=KalturaNotImplemented, pager=KalturaNotImplemented) click to toggle source

List KalturaDropFolder objects @return [KalturaDropFolderListResponse]

# File lib/kaltura_plugins/kaltura_drop_folder_client_plugin.rb, line 1247
def list(filter=KalturaNotImplemented, pager=KalturaNotImplemented)
        kparams = {}
        client.add_param(kparams, 'filter', filter)
        client.add_param(kparams, 'pager', pager)
        client.queue_service_action_call('dropfolder_dropfolder', 'list', 'KalturaDropFolderListResponse', kparams)
        if (client.is_multirequest)
                return nil
        end
        return client.do_queue()
end
update(drop_folder_id, drop_folder) click to toggle source

Update an existing KalturaDropFolder object @return [KalturaDropFolder]

# File lib/kaltura_plugins/kaltura_drop_folder_client_plugin.rb, line 1260
def update(drop_folder_id, drop_folder)
        kparams = {}
        client.add_param(kparams, 'dropFolderId', drop_folder_id)
        client.add_param(kparams, 'dropFolder', drop_folder)
        client.queue_service_action_call('dropfolder_dropfolder', 'update', 'KalturaDropFolder', kparams)
        if (client.is_multirequest)
                return nil
        end
        return client.do_queue()
end
update_status(drop_folder_id, status) click to toggle source

@return []

# File lib/kaltura_plugins/kaltura_drop_folder_client_plugin.rb, line 1272
def update_status(drop_folder_id, status)
        kparams = {}
        client.add_param(kparams, 'dropFolderId', drop_folder_id)
        client.add_param(kparams, 'status', status)
        client.queue_service_action_call('dropfolder_dropfolder', 'updateStatus', '', kparams)
        if (client.is_multirequest)
                return nil
        end
        return client.do_queue()
end