Class: Kaltura::KalturaScheduleEventService

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

#client

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ KalturaScheduleEventService 



1379
1380
1381
 
# File 'lib/kaltura_plugins/kaltura_schedule_client_plugin.rb', line 1379

def initialize(client)
  super(client)
end

Instance Method Details

#add(schedule_event) ⇒ KalturaScheduleEvent

Allows you to add a new KalturaScheduleEvent object



1385
1386
1387
1388
1389
1390
1391
1392
1393
 
# File 'lib/kaltura_plugins/kaltura_schedule_client_plugin.rb', line 1385

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



1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
 
# File 'lib/kaltura_plugins/kaltura_schedule_client_plugin.rb', line 1397

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



1411
1412
1413
1414
1415
1416
1417
1418
1419
 
# File 'lib/kaltura_plugins/kaltura_schedule_client_plugin.rb', line 1411

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



1423
1424
1425
1426
1427
1428
1429
1430
1431
 
# File 'lib/kaltura_plugins/kaltura_schedule_client_plugin.rb', line 1423

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



1435
1436
1437
1438
1439
1440
1441
1442
1443
 
# File 'lib/kaltura_plugins/kaltura_schedule_client_plugin.rb', line 1435

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



1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
 
# File 'lib/kaltura_plugins/kaltura_schedule_client_plugin.rb', line 1447

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



1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
 
# File 'lib/kaltura_plugins/kaltura_schedule_client_plugin.rb', line 1462

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



1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
 
# File 'lib/kaltura_plugins/kaltura_schedule_client_plugin.rb', line 1475

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