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.



1310
1311
1312
 
# File 'lib/kaltura_plugins/kaltura_schedule_client_plugin.rb', line 1310

def initialize(client)
	super(client)
end

Instance Method Details

#add(schedule_event) ⇒ KalturaScheduleEvent

Allows you to add a new KalturaScheduleEvent object

Returns:



1316
1317
1318
1319
1320
1321
1322
1323
1324
 
# File 'lib/kaltura_plugins/kaltura_schedule_client_plugin.rb', line 1316

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:



1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
 
# File 'lib/kaltura_plugins/kaltura_schedule_client_plugin.rb', line 1328

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:



1342
1343
1344
1345
1346
1347
1348
1349
1350
 
# File 'lib/kaltura_plugins/kaltura_schedule_client_plugin.rb', line 1342

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:



1354
1355
1356
1357
1358
1359
1360
1361
1362
 
# File 'lib/kaltura_plugins/kaltura_schedule_client_plugin.rb', line 1354

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:



1366
1367
1368
1369
1370
1371
1372
1373
1374
 
# File 'lib/kaltura_plugins/kaltura_schedule_client_plugin.rb', line 1366

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:



1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
 
# File 'lib/kaltura_plugins/kaltura_schedule_client_plugin.rb', line 1378

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:



1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
 
# File 'lib/kaltura_plugins/kaltura_schedule_client_plugin.rb', line 1393

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:



1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
 
# File 'lib/kaltura_plugins/kaltura_schedule_client_plugin.rb', line 1406

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