Class: KalturaApi::KalturaDropFolderService

Inherits:

KalturaServiceBase

• Object
• KalturaServiceBase
• KalturaApi::KalturaDropFolderService

Defined in:

lib/kaltura_plugins/kaltura_drop_folder_client_plugin.rb

Overview

DropFolder service lets you create and manage drop folders

Instance Attribute Summary

Attributes inherited from KalturaServiceBase

#client

Instance Method Summary

• #add(drop_folder) ⇒ Object

  Allows you to add a new KalturaDropFolder object.

• #delete(drop_folder_id) ⇒ Object

  Mark the KalturaDropFolder object as deleted.

• #get(drop_folder_id) ⇒ Object

  Retrieve a KalturaDropFolder object by ID.

• #initialize(client) ⇒ KalturaDropFolderService constructor

  A new instance of KalturaDropFolderService.

• #list(filter = KalturaNotImplemented, pager = KalturaNotImplemented) ⇒ Object

  List KalturaDropFolder objects.

• #update(drop_folder_id, drop_folder) ⇒ Object

  Update an existing KalturaDropFolder object.

Constructor Details

#initialize(client) ⇒ KalturaDropFolderService

Returns a new instance of KalturaDropFolderService.

# File 'lib/kaltura_plugins/kaltura_drop_folder_client_plugin.rb', line 629

def initialize(client)
	super(client)
end

Instance Method Details

#add(drop_folder) ⇒ Object

Allows you to add a new KalturaDropFolder object

# File 'lib/kaltura_plugins/kaltura_drop_folder_client_plugin.rb', line 635

def add(drop_folder)
	kparams = {}
	client.add_param(kparams, 'dropFolder', drop_folder);
	client.queue_service_action_call('dropfolder_dropfolder', 'add', kparams);
	if (client.is_multirequest)
		return nil;
	end
	return client.do_queue();
end

#delete(drop_folder_id) ⇒ Object

Mark the KalturaDropFolder object as deleted

# File 'lib/kaltura_plugins/kaltura_drop_folder_client_plugin.rb', line 673

def delete(drop_folder_id)
	kparams = {}
	client.add_param(kparams, 'dropFolderId', drop_folder_id);
	client.queue_service_action_call('dropfolder_dropfolder', 'delete', kparams);
	if (client.is_multirequest)
		return nil;
	end
	return client.do_queue();
end

#get(drop_folder_id) ⇒ Object

Retrieve a KalturaDropFolder object by ID

# File 'lib/kaltura_plugins/kaltura_drop_folder_client_plugin.rb', line 647

def get(drop_folder_id)
	kparams = {}
	client.add_param(kparams, 'dropFolderId', drop_folder_id);
	client.queue_service_action_call('dropfolder_dropfolder', 'get', kparams);
	if (client.is_multirequest)
		return nil;
	end
	return client.do_queue();
end

#list(filter = KalturaNotImplemented, pager = KalturaNotImplemented) ⇒ Object

List KalturaDropFolder objects

# File 'lib/kaltura_plugins/kaltura_drop_folder_client_plugin.rb', line 685

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', kparams);
	if (client.is_multirequest)
		return nil;
	end
	return client.do_queue();
end

#update(drop_folder_id, drop_folder) ⇒ Object

Update an existing KalturaDropFolder object

# File 'lib/kaltura_plugins/kaltura_drop_folder_client_plugin.rb', line 659

def update(drop_folder_id, drop_folder)
	kparams = {}
	client.add_param(kparams, 'dropFolderId', drop_folder_id);
	# Id
	client.add_param(kparams, 'dropFolder', drop_folder);
	client.queue_service_action_call('dropfolder_dropfolder', 'update', kparams);
	if (client.is_multirequest)
		return nil;
	end
	return client.do_queue();
end