Class: Kaltura::KalturaDropFolderService
- Inherits:
-
KalturaServiceBase
- Object
- KalturaServiceBase
- Kaltura::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
Instance Method Summary collapse
-
#add(drop_folder) ⇒ KalturaDropFolder
Allows you to add a new KalturaDropFolder object.
-
#delete(drop_folder_id) ⇒ KalturaDropFolder
Mark the KalturaDropFolder object as deleted.
-
#free_exclusive_drop_folder(drop_folder_id, error_code = KalturaNotImplemented, error_description = KalturaNotImplemented) ⇒ KalturaDropFolder
freeExclusive KalturaDropFolder object.
-
#get(drop_folder_id) ⇒ KalturaDropFolder
Retrieve a KalturaDropFolder object by ID.
-
#get_exclusive_drop_folder(tag, max_time) ⇒ KalturaDropFolder
getExclusive KalturaDropFolder object.
-
#initialize(client) ⇒ KalturaDropFolderService
constructor
A new instance of KalturaDropFolderService.
-
#list(filter = KalturaNotImplemented, pager = KalturaNotImplemented) ⇒ KalturaDropFolderListResponse
List KalturaDropFolder objects.
-
#update(drop_folder_id, drop_folder) ⇒ KalturaDropFolder
Update an existing KalturaDropFolder object.
Constructor Details
#initialize(client) ⇒ KalturaDropFolderService
Returns a new instance of KalturaDropFolderService.
1175 1176 1177 |
# File 'lib/kaltura_plugins/kaltura_drop_folder_client_plugin.rb', line 1175 def initialize(client) super(client) end |
Instance Method Details
#add(drop_folder) ⇒ KalturaDropFolder
Allows you to add a new KalturaDropFolder object
1181 1182 1183 1184 1185 1186 1187 1188 1189 |
# File 'lib/kaltura_plugins/kaltura_drop_folder_client_plugin.rb', line 1181 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
1193 1194 1195 1196 1197 1198 1199 1200 1201 |
# File 'lib/kaltura_plugins/kaltura_drop_folder_client_plugin.rb', line 1193 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
1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 |
# File 'lib/kaltura_plugins/kaltura_drop_folder_client_plugin.rb', line 1205 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
1219 1220 1221 1222 1223 1224 1225 1226 1227 |
# File 'lib/kaltura_plugins/kaltura_drop_folder_client_plugin.rb', line 1219 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
1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 |
# File 'lib/kaltura_plugins/kaltura_drop_folder_client_plugin.rb', line 1231 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
1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 |
# File 'lib/kaltura_plugins/kaltura_drop_folder_client_plugin.rb', line 1244 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
1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 |
# File 'lib/kaltura_plugins/kaltura_drop_folder_client_plugin.rb', line 1257 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 |