Class: Kaltura::KalturaScheduleEventService
- Inherits:
-
KalturaServiceBase
- Object
- KalturaServiceBase
- Kaltura::KalturaScheduleEventService
- Defined in:
- lib/kaltura_plugins/kaltura_schedule_client_plugin.rb
Overview
The ScheduleEvent service enables you to create and manage (update, delete, retrieve, etc.) scheduled recording events.
Instance Attribute Summary
Attributes inherited from KalturaServiceBase
Instance Method Summary collapse
-
#add(schedule_event) ⇒ KalturaScheduleEvent
Allows you to add a new KalturaScheduleEvent object.
-
#add_from_bulk_upload(file_data, bulk_upload_data = KalturaNotImplemented) ⇒ KalturaBulkUpload
Add new bulk upload batch job.
-
#cancel(schedule_event_id) ⇒ KalturaScheduleEvent
Mark the KalturaScheduleEvent object as cancelled.
-
#delete(schedule_event_id) ⇒ KalturaScheduleEvent
Mark the KalturaScheduleEvent object as deleted.
-
#get(schedule_event_id) ⇒ KalturaScheduleEvent
Retrieve a KalturaScheduleEvent object by ID.
-
#get_conflicts(resource_ids, schedule_event, schedule_event_id_to_ignore = KalturaNotImplemented, schedule_event_conflict_type = 1) ⇒ KalturaScheduleEventListResponse
List conflicting events for resourcesIds by event’s dates.
-
#initialize(client) ⇒ KalturaScheduleEventService
constructor
A new instance of KalturaScheduleEventService.
-
#list(filter = KalturaNotImplemented, pager = KalturaNotImplemented) ⇒ KalturaScheduleEventListResponse
List KalturaScheduleEvent objects.
-
#update(schedule_event_id, schedule_event) ⇒ KalturaScheduleEvent
Update an existing KalturaScheduleEvent object.
Constructor Details
#initialize(client) ⇒ KalturaScheduleEventService
Returns a new instance of KalturaScheduleEventService.
1289 1290 1291 |
# File 'lib/kaltura_plugins/kaltura_schedule_client_plugin.rb', line 1289 def initialize(client) super(client) end |
Instance Method Details
#add(schedule_event) ⇒ KalturaScheduleEvent
Allows you to add a new KalturaScheduleEvent object
1295 1296 1297 1298 1299 1300 1301 1302 1303 |
# File 'lib/kaltura_plugins/kaltura_schedule_client_plugin.rb', line 1295 def add(schedule_event) kparams = {} client.add_param(kparams, 'scheduleEvent', schedule_event) client.queue_service_action_call('schedule_scheduleevent', 'add', 'KalturaScheduleEvent', kparams) if (client.is_multirequest) return nil end return client.do_queue() end |
#add_from_bulk_upload(file_data, bulk_upload_data = KalturaNotImplemented) ⇒ KalturaBulkUpload
Add new bulk upload batch job
1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 |
# File 'lib/kaltura_plugins/kaltura_schedule_client_plugin.rb', line 1307 def add_from_bulk_upload(file_data, bulk_upload_data=KalturaNotImplemented) kparams = {} kfiles = {} client.add_param(kfiles, 'fileData', file_data) client.add_param(kparams, 'bulkUploadData', bulk_upload_data) client.queue_service_action_call('schedule_scheduleevent', 'addFromBulkUpload', 'KalturaBulkUpload', kparams, kfiles) if (client.is_multirequest) return nil end return client.do_queue() end |
#cancel(schedule_event_id) ⇒ KalturaScheduleEvent
Mark the KalturaScheduleEvent object as cancelled
1321 1322 1323 1324 1325 1326 1327 1328 1329 |
# File 'lib/kaltura_plugins/kaltura_schedule_client_plugin.rb', line 1321 def cancel(schedule_event_id) kparams = {} client.add_param(kparams, 'scheduleEventId', schedule_event_id) client.queue_service_action_call('schedule_scheduleevent', 'cancel', 'KalturaScheduleEvent', kparams) if (client.is_multirequest) return nil end return client.do_queue() end |
#delete(schedule_event_id) ⇒ KalturaScheduleEvent
Mark the KalturaScheduleEvent object as deleted
1333 1334 1335 1336 1337 1338 1339 1340 1341 |
# File 'lib/kaltura_plugins/kaltura_schedule_client_plugin.rb', line 1333 def delete(schedule_event_id) kparams = {} client.add_param(kparams, 'scheduleEventId', schedule_event_id) client.queue_service_action_call('schedule_scheduleevent', 'delete', 'KalturaScheduleEvent', kparams) if (client.is_multirequest) return nil end return client.do_queue() end |
#get(schedule_event_id) ⇒ KalturaScheduleEvent
Retrieve a KalturaScheduleEvent object by ID
1345 1346 1347 1348 1349 1350 1351 1352 1353 |
# File 'lib/kaltura_plugins/kaltura_schedule_client_plugin.rb', line 1345 def get(schedule_event_id) kparams = {} client.add_param(kparams, 'scheduleEventId', schedule_event_id) client.queue_service_action_call('schedule_scheduleevent', 'get', 'KalturaScheduleEvent', kparams) if (client.is_multirequest) return nil end return client.do_queue() end |
#get_conflicts(resource_ids, schedule_event, schedule_event_id_to_ignore = KalturaNotImplemented, schedule_event_conflict_type = 1) ⇒ KalturaScheduleEventListResponse
List conflicting events for resourcesIds by event’s dates
1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 |
# File 'lib/kaltura_plugins/kaltura_schedule_client_plugin.rb', line 1357 def get_conflicts(resource_ids, schedule_event, schedule_event_id_to_ignore=KalturaNotImplemented, schedule_event_conflict_type=1) kparams = {} client.add_param(kparams, 'resourceIds', resource_ids) client.add_param(kparams, 'scheduleEvent', schedule_event) client.add_param(kparams, 'scheduleEventIdToIgnore', schedule_event_id_to_ignore) client.add_param(kparams, 'scheduleEventConflictType', schedule_event_conflict_type) client.queue_service_action_call('schedule_scheduleevent', 'getConflicts', 'KalturaScheduleEventListResponse', kparams) if (client.is_multirequest) return nil end return client.do_queue() end |
#list(filter = KalturaNotImplemented, pager = KalturaNotImplemented) ⇒ KalturaScheduleEventListResponse
List KalturaScheduleEvent objects
1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 |
# File 'lib/kaltura_plugins/kaltura_schedule_client_plugin.rb', line 1372 def list(filter=KalturaNotImplemented, pager=KalturaNotImplemented) kparams = {} client.add_param(kparams, 'filter', filter) client.add_param(kparams, 'pager', pager) client.queue_service_action_call('schedule_scheduleevent', 'list', 'KalturaScheduleEventListResponse', kparams) if (client.is_multirequest) return nil end return client.do_queue() end |
#update(schedule_event_id, schedule_event) ⇒ KalturaScheduleEvent
Update an existing KalturaScheduleEvent object
1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 |
# File 'lib/kaltura_plugins/kaltura_schedule_client_plugin.rb', line 1385 def update(schedule_event_id, schedule_event) kparams = {} client.add_param(kparams, 'scheduleEventId', schedule_event_id) client.add_param(kparams, 'scheduleEvent', schedule_event) client.queue_service_action_call('schedule_scheduleevent', 'update', 'KalturaScheduleEvent', kparams) if (client.is_multirequest) return nil end return client.do_queue() end |