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.



1282
1283
1284
 
# File 'lib/kaltura_plugins/kaltura_drop_folder_client_plugin.rb', line 1282

def initialize(client)
  super(client)
end

Instance Method Details

#add(drop_folder_file) ⇒ KalturaDropFolderFile

Allows you to add a new KalturaDropFolderFile object

Returns:



1288
1289
1290
1291
1292
1293
1294
1295
1296
 
# File 'lib/kaltura_plugins/kaltura_drop_folder_client_plugin.rb', line 1288

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

#delete(drop_folder_file_id) ⇒ KalturaDropFolderFile

Mark the KalturaDropFolderFile object as deleted

Returns:



1300
1301
1302
1303
1304
1305
1306
1307
1308
 
# File 'lib/kaltura_plugins/kaltura_drop_folder_client_plugin.rb', line 1300

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

#get(drop_folder_file_id) ⇒ KalturaDropFolderFile

Retrieve a KalturaDropFolderFile object by ID

Returns:



1312
1313
1314
1315
1316
1317
1318
1319
1320
 
# File 'lib/kaltura_plugins/kaltura_drop_folder_client_plugin.rb', line 1312

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

#ignore(drop_folder_file_id) ⇒ KalturaDropFolderFile

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

Returns:



1324
1325
1326
1327
1328
1329
1330
1331
1332
 
# File 'lib/kaltura_plugins/kaltura_drop_folder_client_plugin.rb', line 1324

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

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

List KalturaDropFolderFile objects

Returns:



1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
 
# File 'lib/kaltura_plugins/kaltura_drop_folder_client_plugin.rb', line 1336

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

#update(drop_folder_file_id, drop_folder_file) ⇒ KalturaDropFolderFile

Update an existing KalturaDropFolderFile object

Returns:



1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
 
# File 'lib/kaltura_plugins/kaltura_drop_folder_client_plugin.rb', line 1349

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

#update_status(drop_folder_file_id, status) ⇒ KalturaDropFolderFile

Update status of KalturaDropFolderFile

Returns:



1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
 
# File 'lib/kaltura_plugins/kaltura_drop_folder_client_plugin.rb', line 1362

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