Class: Kaltura::KalturaEventNotificationTemplateService

Inherits:
KalturaServiceBase show all
Defined in:
lib/kaltura_plugins/kaltura_event_notification_client_plugin.rb

Overview

Event notification template service lets you create and manage event notification templates

Instance Attribute Summary

Attributes inherited from KalturaServiceBase

#client

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ KalturaEventNotificationTemplateService

Returns a new instance of KalturaEventNotificationTemplateService.



263
264
265
 
# File 'lib/kaltura_plugins/kaltura_event_notification_client_plugin.rb', line 263

def initialize(client)
	super(client)
end

Instance Method Details

#add(event_notification_template) ⇒ Object

Allows you to add a new event notification template object



269
270
271
272
273
274
275
276
277
 
# File 'lib/kaltura_plugins/kaltura_event_notification_client_plugin.rb', line 269

def add(event_notification_template)
	kparams = {}
	client.add_param(kparams, 'eventNotificationTemplate', event_notification_template);
	client.queue_service_action_call('eventnotification_eventnotificationtemplate', 'add', kparams);
	if (client.is_multirequest)
		return nil;
	end
	return client.do_queue();
end

#clone(id, event_notification_template = KalturaNotImplemented) ⇒ Object

Allows you to clone exiting event notification template object and create a new one with similar configuration



281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'lib/kaltura_plugins/kaltura_event_notification_client_plugin.rb', line 281

def clone(id, event_notification_template=KalturaNotImplemented)
	kparams = {}
	# source template to clone
	client.add_param(kparams, 'id', id);
	# overwrite configuration object
	client.add_param(kparams, 'eventNotificationTemplate', event_notification_template);
	client.queue_service_action_call('eventnotification_eventnotificationtemplate', 'clone', kparams);
	if (client.is_multirequest)
		return nil;
	end
	return client.do_queue();
end

#delete(id) ⇒ Object

Delete an event notification template object



334
335
336
337
338
339
340
341
342
 
# File 'lib/kaltura_plugins/kaltura_event_notification_client_plugin.rb', line 334

def delete(id)
	kparams = {}
	client.add_param(kparams, 'id', id);
	client.queue_service_action_call('eventnotification_eventnotificationtemplate', 'delete', kparams);
	if (client.is_multirequest)
		return nil;
	end
	return client.do_queue();
end

#dispatch(id, data) ⇒ Object

Dispatch event notification object by id



370
371
372
373
374
375
376
377
378
379
 
# File 'lib/kaltura_plugins/kaltura_event_notification_client_plugin.rb', line 370

def dispatch(id, data)
	kparams = {}
	client.add_param(kparams, 'id', id);
	client.add_param(kparams, 'data', data);
	client.queue_service_action_call('eventnotification_eventnotificationtemplate', 'dispatch', kparams);
	if (client.is_multirequest)
		return nil;
	end
	return client.do_queue();
end

#get(id) ⇒ Object

Retrieve an event notification template object by id



296
297
298
299
300
301
302
303
304
 
# File 'lib/kaltura_plugins/kaltura_event_notification_client_plugin.rb', line 296

def get(id)
	kparams = {}
	client.add_param(kparams, 'id', id);
	client.queue_service_action_call('eventnotification_eventnotificationtemplate', 'get', kparams);
	if (client.is_multirequest)
		return nil;
	end
	return client.do_queue();
end

#list(filter = KalturaNotImplemented, pager = KalturaNotImplemented) ⇒ Object

list event notification template objects



346
347
348
349
350
351
352
353
354
355
 
# File 'lib/kaltura_plugins/kaltura_event_notification_client_plugin.rb', line 346

def list(filter=KalturaNotImplemented, pager=KalturaNotImplemented)
	kparams = {}
	client.add_param(kparams, 'filter', filter);
	client.add_param(kparams, 'pager', pager);
	client.queue_service_action_call('eventnotification_eventnotificationtemplate', 'list', kparams);
	if (client.is_multirequest)
		return nil;
	end
	return client.do_queue();
end

#list_by_partner(filter = KalturaNotImplemented, pager = KalturaNotImplemented) ⇒ Object 



357
358
359
360
361
362
363
364
365
366
 
# File 'lib/kaltura_plugins/kaltura_event_notification_client_plugin.rb', line 357

def list_by_partner(filter=KalturaNotImplemented, pager=KalturaNotImplemented)
	kparams = {}
	client.add_param(kparams, 'filter', filter);
	client.add_param(kparams, 'pager', pager);
	client.queue_service_action_call('eventnotification_eventnotificationtemplate', 'listByPartner', kparams);
	if (client.is_multirequest)
		return nil;
	end
	return client.do_queue();
end

#list_templates(filter = KalturaNotImplemented, pager = KalturaNotImplemented) ⇒ Object

Action lists the template partner event notification templates.



383
384
385
386
387
388
389
390
391
392
 
# File 'lib/kaltura_plugins/kaltura_event_notification_client_plugin.rb', line 383

def list_templates(filter=KalturaNotImplemented, pager=KalturaNotImplemented)
	kparams = {}
	client.add_param(kparams, 'filter', filter);
	client.add_param(kparams, 'pager', pager);
	client.queue_service_action_call('eventnotification_eventnotificationtemplate', 'listTemplates', kparams);
	if (client.is_multirequest)
		return nil;
	end
	return client.do_queue();
end

#update(id, event_notification_template) ⇒ Object

Update an existing event notification template object



308
309
310
311
312
313
314
315
316
317
 
# File 'lib/kaltura_plugins/kaltura_event_notification_client_plugin.rb', line 308

def update(id, event_notification_template)
	kparams = {}
	client.add_param(kparams, 'id', id);
	client.add_param(kparams, 'eventNotificationTemplate', event_notification_template);
	client.queue_service_action_call('eventnotification_eventnotificationtemplate', 'update', kparams);
	if (client.is_multirequest)
		return nil;
	end
	return client.do_queue();
end

#update_status(id, status) ⇒ Object

Update event notification template status by id



321
322
323
324
325
326
327
328
329
330
 
# File 'lib/kaltura_plugins/kaltura_event_notification_client_plugin.rb', line 321

def update_status(id, status)
	kparams = {}
	client.add_param(kparams, 'id', id);
	client.add_param(kparams, 'status', status);
	client.queue_service_action_call('eventnotification_eventnotificationtemplate', 'updateStatus', kparams);
	if (client.is_multirequest)
		return nil;
	end
	return client.do_queue();
end