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.



1460
1461
1462
 
# File 'lib/kaltura_plugins/kaltura_schedule_client_plugin.rb', line 1460

def initialize(client)
	super(client)
end

Instance Method Details

#add(schedule_event) ⇒ KalturaScheduleEvent

Allows you to add a new KalturaScheduleEvent object

Returns:



1466
1467
1468
1469
1470
1471
1472
1473
1474
 
# File 'lib/kaltura_plugins/kaltura_schedule_client_plugin.rb', line 1466

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:



1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
 
# File 'lib/kaltura_plugins/kaltura_schedule_client_plugin.rb', line 1478

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:



1492
1493
1494
1495
1496
1497
1498
1499
1500
 
# File 'lib/kaltura_plugins/kaltura_schedule_client_plugin.rb', line 1492

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:



1504
1505
1506
1507
1508
1509
1510
1511
1512
 
# File 'lib/kaltura_plugins/kaltura_schedule_client_plugin.rb', line 1504

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:



1516
1517
1518
1519
1520
1521
1522
1523
1524
 
# File 'lib/kaltura_plugins/kaltura_schedule_client_plugin.rb', line 1516

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:



1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
 
# File 'lib/kaltura_plugins/kaltura_schedule_client_plugin.rb', line 1528

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:



1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
 
# File 'lib/kaltura_plugins/kaltura_schedule_client_plugin.rb', line 1543

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:



1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
 
# File 'lib/kaltura_plugins/kaltura_schedule_client_plugin.rb', line 1556

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