Class: Kaltura::KalturaDropFolderService

Inherits:
KalturaServiceBase show all
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 collapse

Constructor Details

#initialize(client) ⇒ KalturaDropFolderService

Returns a new instance of KalturaDropFolderService.



1179
1180
1181
 
# File 'lib/kaltura_plugins/kaltura_drop_folder_client_plugin.rb', line 1179

def initialize(client)
	super(client)
end

Instance Method Details

#add(drop_folder) ⇒ KalturaDropFolder

Allows you to add a new KalturaDropFolder object

Returns:



1185
1186
1187
1188
1189
1190
1191
1192
1193
 
# File 'lib/kaltura_plugins/kaltura_drop_folder_client_plugin.rb', line 1185

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) ⇒ KalturaDropFolder

Mark the KalturaDropFolder object as deleted

Returns:



1197
1198
1199
1200
1201
1202
1203
1204
1205
 
# File 'lib/kaltura_plugins/kaltura_drop_folder_client_plugin.rb', line 1197

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) ⇒ KalturaDropFolder

freeExclusive KalturaDropFolder object

Returns:



1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
 
# File 'lib/kaltura_plugins/kaltura_drop_folder_client_plugin.rb', line 1209

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) ⇒ KalturaDropFolder

Retrieve a KalturaDropFolder object by ID

Returns:



1223
1224
1225
1226
1227
1228
1229
1230
1231
 
# File 'lib/kaltura_plugins/kaltura_drop_folder_client_plugin.rb', line 1223

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) ⇒ KalturaDropFolder

getExclusive KalturaDropFolder object

Returns:



1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
 
# File 'lib/kaltura_plugins/kaltura_drop_folder_client_plugin.rb', line 1235

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) ⇒ KalturaDropFolderListResponse

List KalturaDropFolder objects

Returns:



1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
 
# File 'lib/kaltura_plugins/kaltura_drop_folder_client_plugin.rb', line 1248

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) ⇒ KalturaDropFolder

Update an existing KalturaDropFolder object

Returns:



1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
 
# File 'lib/kaltura_plugins/kaltura_drop_folder_client_plugin.rb', line 1261

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) ⇒ Object

Returns [].

Returns:



1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
 
# File 'lib/kaltura_plugins/kaltura_drop_folder_client_plugin.rb', line 1273

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