class Kaltura::KalturaScheduleEventService

The ScheduleEvent service enables you to create and manage (update, delete, retrieve, etc.) scheduled recording events.

Public Class Methods

new(client) click to toggle source
Calls superclass method Kaltura::KalturaServiceBase::new
# File lib/kaltura_plugins/kaltura_schedule_client_plugin.rb, line 1379
def initialize(client)
        super(client)
end

Public Instance Methods

add(schedule_event) click to toggle source

Allows you to add a new KalturaScheduleEvent object @return [KalturaScheduleEvent]

# 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) click to toggle source

Add new bulk upload batch job @return [KalturaBulkUpload]

# 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) click to toggle source

Mark the KalturaScheduleEvent object as cancelled @return [KalturaScheduleEvent]

# 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) click to toggle source

Mark the KalturaScheduleEvent object as deleted @return [KalturaScheduleEvent]

# 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) click to toggle source

Retrieve a KalturaScheduleEvent object by ID @return [KalturaScheduleEvent]

# 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) click to toggle source

List conflicting events for resourcesIds by event's dates @return [KalturaScheduleEventListResponse]

# 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) click to toggle source

List KalturaScheduleEvent objects @return [KalturaScheduleEventListResponse]

# 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) click to toggle source

Update an existing KalturaScheduleEvent object @return [KalturaScheduleEvent]

# 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