Class: Kaltura::KalturaDropFolderFileService

Inherits:
KalturaServiceBase show all
Defined in:
lib/kaltura_plugins/kaltura_drop_folder_client_plugin.rb

Overview

DropFolderFile service lets you create and manage drop folder files

Instance Attribute Summary

Attributes inherited from KalturaServiceBase

#client

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ KalturaDropFolderFileService

Returns a new instance of KalturaDropFolderFileService.



700
701
702
 
# File 'lib/kaltura_plugins/kaltura_drop_folder_client_plugin.rb', line 700

def initialize(client)
	super(client)
end

Instance Method Details

#add(drop_folder_file) ⇒ Object

Allows you to add a new KalturaDropFolderFile object



706
707
708
709
710
711
712
713
714
 
# File 'lib/kaltura_plugins/kaltura_drop_folder_client_plugin.rb', line 706

def add(drop_folder_file)
	kparams = {}
	client.add_param(kparams, 'dropFolderFile', drop_folder_file);
	client.queue_service_action_call('dropfolder_dropfolderfile', 'add', kparams);
	if (client.is_multirequest)
		return nil;
	end
	return client.do_queue();
end

#delete(drop_folder_file_id) ⇒ Object

Mark the KalturaDropFolderFile object as deleted



757
758
759
760
761
762
763
764
765
 
# File 'lib/kaltura_plugins/kaltura_drop_folder_client_plugin.rb', line 757

def delete(drop_folder_file_id)
	kparams = {}
	client.add_param(kparams, 'dropFolderFileId', drop_folder_file_id);
	client.queue_service_action_call('dropfolder_dropfolderfile', 'delete', kparams);
	if (client.is_multirequest)
		return nil;
	end
	return client.do_queue();
end

#get(drop_folder_file_id) ⇒ Object

Retrieve a KalturaDropFolderFile object by ID



718
719
720
721
722
723
724
725
726
 
# File 'lib/kaltura_plugins/kaltura_drop_folder_client_plugin.rb', line 718

def get(drop_folder_file_id)
	kparams = {}
	client.add_param(kparams, 'dropFolderFileId', drop_folder_file_id);
	client.queue_service_action_call('dropfolder_dropfolderfile', 'get', kparams);
	if (client.is_multirequest)
		return nil;
	end
	return client.do_queue();
end

#ignore(drop_folder_file_id) ⇒ Object

Set the KalturaDropFolderFile status to ignore (KalturaDropFolderFileStatus::IGNORE)



782
783
784
785
786
787
788
789
790
 
# File 'lib/kaltura_plugins/kaltura_drop_folder_client_plugin.rb', line 782

def ignore(drop_folder_file_id)
	kparams = {}
	client.add_param(kparams, 'dropFolderFileId', drop_folder_file_id);
	client.queue_service_action_call('dropfolder_dropfolderfile', 'ignore', kparams);
	if (client.is_multirequest)
		return nil;
	end
	return client.do_queue();
end

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

List KalturaDropFolderFile objects



769
770
771
772
773
774
775
776
777
778
 
# File 'lib/kaltura_plugins/kaltura_drop_folder_client_plugin.rb', line 769

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

#update(drop_folder_file_id, drop_folder_file) ⇒ Object

Update an existing KalturaDropFolderFile object



730
731
732
733
734
735
736
737
738
739
740
 
# File 'lib/kaltura_plugins/kaltura_drop_folder_client_plugin.rb', line 730

def update(drop_folder_file_id, drop_folder_file)
	kparams = {}
	client.add_param(kparams, 'dropFolderFileId', drop_folder_file_id);
	# Id
	client.add_param(kparams, 'dropFolderFile', drop_folder_file);
	client.queue_service_action_call('dropfolder_dropfolderfile', 'update', kparams);
	if (client.is_multirequest)
		return nil;
	end
	return client.do_queue();
end

#update_status(drop_folder_file_id, status) ⇒ Object

Update status of KalturaDropFolderFile



744
745
746
747
748
749
750
751
752
753
 
# File 'lib/kaltura_plugins/kaltura_drop_folder_client_plugin.rb', line 744

def update_status(drop_folder_file_id, status)
	kparams = {}
	client.add_param(kparams, 'dropFolderFileId', drop_folder_file_id);
	client.add_param(kparams, 'status', status);
	client.queue_service_action_call('dropfolder_dropfolderfile', 'updateStatus', kparams);
	if (client.is_multirequest)
		return nil;
	end
	return client.do_queue();
end