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

Returns a new instance of KalturaScheduleEventService.



1452
1453
1454
 
# File 'lib/kaltura_plugins/kaltura_schedule_client_plugin.rb', line 1452

def initialize(client)
  super(client)
end

Instance Method Details

#add(schedule_event) ⇒ KalturaScheduleEvent

Allows you to add a new KalturaScheduleEvent object

Returns:



1458
1459
1460
1461
1462
1463
1464
1465
1466
 
# File 'lib/kaltura_plugins/kaltura_schedule_client_plugin.rb', line 1458

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

Returns:



1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
 
# File 'lib/kaltura_plugins/kaltura_schedule_client_plugin.rb', line 1470

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

Returns:



1484
1485
1486
1487
1488
1489
1490
1491
1492
 
# File 'lib/kaltura_plugins/kaltura_schedule_client_plugin.rb', line 1484

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

Returns:



1496
1497
1498
1499
1500
1501
1502
1503
1504
 
# File 'lib/kaltura_plugins/kaltura_schedule_client_plugin.rb', line 1496

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

Returns:



1508
1509
1510
1511
1512
1513
1514
1515
1516
 
# File 'lib/kaltura_plugins/kaltura_schedule_client_plugin.rb', line 1508

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

Returns:



1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
 
# File 'lib/kaltura_plugins/kaltura_schedule_client_plugin.rb', line 1520

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

Returns:



1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
 
# File 'lib/kaltura_plugins/kaltura_schedule_client_plugin.rb', line 1535

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

Returns:



1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
 
# File 'lib/kaltura_plugins/kaltura_schedule_client_plugin.rb', line 1548

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