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 



1545
1546
1547
 
# File 'lib/kaltura_plugins/kaltura_schedule_client_plugin.rb', line 1545

def initialize(client)
  super(client)
end

Instance Method Details

#add(schedule_event) ⇒ KalturaScheduleEvent

Allows you to add a new KalturaScheduleEvent object



1551
1552
1553
1554
1555
1556
1557
1558
1559
 
# File 'lib/kaltura_plugins/kaltura_schedule_client_plugin.rb', line 1551

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



1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
 
# File 'lib/kaltura_plugins/kaltura_schedule_client_plugin.rb', line 1563

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



1577
1578
1579
1580
1581
1582
1583
1584
1585
 
# File 'lib/kaltura_plugins/kaltura_schedule_client_plugin.rb', line 1577

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



1589
1590
1591
1592
1593
1594
1595
1596
1597
 
# File 'lib/kaltura_plugins/kaltura_schedule_client_plugin.rb', line 1589

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



1601
1602
1603
1604
1605
1606
1607
1608
1609
 
# File 'lib/kaltura_plugins/kaltura_schedule_client_plugin.rb', line 1601

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



1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
 
# File 'lib/kaltura_plugins/kaltura_schedule_client_plugin.rb', line 1613

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



1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
 
# File 'lib/kaltura_plugins/kaltura_schedule_client_plugin.rb', line 1628

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



1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
 
# File 'lib/kaltura_plugins/kaltura_schedule_client_plugin.rb', line 1641

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

#update_live_feature(scheduled_event_id, feature_name, live_feature) ⇒ KalturaLiveStreamScheduleEvent

Add feature to live event



1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
 
# File 'lib/kaltura_plugins/kaltura_schedule_client_plugin.rb', line 1654

def update_live_feature(scheduled_event_id, feature_name, live_feature)
  kparams = {}
  client.add_param(kparams, 'scheduledEventId', scheduled_event_id)
  client.add_param(kparams, 'featureName', feature_name)
  client.add_param(kparams, 'liveFeature', live_feature)
  client.queue_service_action_call('schedule_scheduleevent', 'updateLiveFeature', 'KalturaLiveStreamScheduleEvent', kparams)
  if (client.is_multirequest)
    return nil
  end
  return client.do_queue()
end