Package com.kaltura.client.services

Class EventNotificationTemplateService

java.lang.Object

com.kaltura.client.services.EventNotificationTemplateService

public class EventNotificationTemplateService
extends Object

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EventNotificationTemplateService.AddEventNotificationTemplateBuilder
static class	EventNotificationTemplateService.CloneEventNotificationTemplateBuilder
static class	EventNotificationTemplateService.DeleteEventNotificationTemplateBuilder
static class	EventNotificationTemplateService.DispatchEventNotificationTemplateBuilder
static class	EventNotificationTemplateService.GetEventNotificationTemplateBuilder
static class	EventNotificationTemplateService.ListByPartnerEventNotificationTemplateBuilder
static class	EventNotificationTemplateService.ListEventNotificationTemplateBuilder
static class	EventNotificationTemplateService.ListTemplatesEventNotificationTemplateBuilder
static class	EventNotificationTemplateService.RegisterEventNotificationTemplateBuilder
static class	EventNotificationTemplateService.SendCommandEventNotificationTemplateBuilder
static class	EventNotificationTemplateService.UpdateEventNotificationTemplateBuilder
static class	EventNotificationTemplateService.UpdateStatusEventNotificationTemplateBuilder

Constructor Summary

Constructors

Constructor	Description
EventNotificationTemplateService()

Method Summary

Modifier and Type	Method	Description
static EventNotificationTemplateService.AddEventNotificationTemplateBuilder	add(EventNotificationTemplate eventNotificationTemplate)	This action allows for the creation of new backend event types in the system.
static EventNotificationTemplateService.CloneEventNotificationTemplateBuilder	clone(int id)
static EventNotificationTemplateService.CloneEventNotificationTemplateBuilder	clone(int id, EventNotificationTemplate eventNotificationTemplate)	This action allows registering to various backend event.
static EventNotificationTemplateService.DeleteEventNotificationTemplateBuilder	delete(int id)	Delete an event notification template object
static EventNotificationTemplateService.DispatchEventNotificationTemplateBuilder	dispatch(int id, EventNotificationScope scope)	Dispatch event notification object by id
static EventNotificationTemplateService.GetEventNotificationTemplateBuilder	get(int id)	Retrieve an event notification template object by id
static EventNotificationTemplateService.ListEventNotificationTemplateBuilder	list()
static EventNotificationTemplateService.ListEventNotificationTemplateBuilder	list(EventNotificationTemplateFilter filter)
static EventNotificationTemplateService.ListEventNotificationTemplateBuilder	list(EventNotificationTemplateFilter filter, FilterPager pager)	list event notification template objects
static EventNotificationTemplateService.ListByPartnerEventNotificationTemplateBuilder	listByPartner()
static EventNotificationTemplateService.ListByPartnerEventNotificationTemplateBuilder	listByPartner(PartnerFilter filter)
static EventNotificationTemplateService.ListByPartnerEventNotificationTemplateBuilder	listByPartner(PartnerFilter filter, FilterPager pager)
static EventNotificationTemplateService.ListTemplatesEventNotificationTemplateBuilder	listTemplates()
static EventNotificationTemplateService.ListTemplatesEventNotificationTemplateBuilder	listTemplates(EventNotificationTemplateFilter filter)
static EventNotificationTemplateService.ListTemplatesEventNotificationTemplateBuilder	listTemplates(EventNotificationTemplateFilter filter, FilterPager pager)	Action lists the template partner event notification templates.
static EventNotificationTemplateService.RegisterEventNotificationTemplateBuilder	register(String notificationTemplateSystemName, PushNotificationParams pushNotificationParams)	Register to a queue from which event messages will be provided according to given template.
static EventNotificationTemplateService.SendCommandEventNotificationTemplateBuilder	sendCommand(String notificationTemplateSystemName, PushNotificationParams pushNotificationParams, PushNotificationCommandType command)	Clear queue messages
static EventNotificationTemplateService.UpdateEventNotificationTemplateBuilder	update(int id, EventNotificationTemplate eventNotificationTemplate)	Update an existing event notification template object
static EventNotificationTemplateService.UpdateStatusEventNotificationTemplateBuilder	updateStatus(int id, EventNotificationTemplateStatus status)	Update event notification template status by id

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EventNotificationTemplateService

public EventNotificationTemplateService()

Method Detail

add

public static EventNotificationTemplateService.AddEventNotificationTemplateBuilder add(EventNotificationTemplate eventNotificationTemplate)

This action allows for the creation of new backend event types in the system. This action requires access to the Kaltura server Admin Console. If you're looking to register to existing event types, please use the clone action instead.

Parameters:

eventNotificationTemplate -

clone

public static EventNotificationTemplateService.CloneEventNotificationTemplateBuilder clone(int id)

clone

public static EventNotificationTemplateService.CloneEventNotificationTemplateBuilder clone(int id,
                                                                                           EventNotificationTemplate eventNotificationTemplate)

This action allows registering to various backend event. Use this action to create notifications that will react to events such as new video was uploaded or metadata field was updated. To see the list of available event types, call the listTemplates action.

Parameters:

id - source template to clone

eventNotificationTemplate - overwrite configuration object

delete

public static EventNotificationTemplateService.DeleteEventNotificationTemplateBuilder delete(int id)

Delete an event notification template object

Parameters:

id -

dispatch

public static EventNotificationTemplateService.DispatchEventNotificationTemplateBuilder dispatch(int id,
                                                                                                 EventNotificationScope scope)

Dispatch event notification object by id

Parameters:

id -

scope -

get

public static EventNotificationTemplateService.GetEventNotificationTemplateBuilder get(int id)

Retrieve an event notification template object by id

Parameters:

id -

list

public static EventNotificationTemplateService.ListEventNotificationTemplateBuilder list()

list

public static EventNotificationTemplateService.ListEventNotificationTemplateBuilder list(EventNotificationTemplateFilter filter)

list

public static EventNotificationTemplateService.ListEventNotificationTemplateBuilder list(EventNotificationTemplateFilter filter,
                                                                                         FilterPager pager)

list event notification template objects

Parameters:

filter -

pager -

listByPartner

public static EventNotificationTemplateService.ListByPartnerEventNotificationTemplateBuilder listByPartner()

listByPartner

public static EventNotificationTemplateService.ListByPartnerEventNotificationTemplateBuilder listByPartner(PartnerFilter filter)

listByPartner

public static EventNotificationTemplateService.ListByPartnerEventNotificationTemplateBuilder listByPartner(PartnerFilter filter,
                                                                                                           FilterPager pager)

listTemplates

public static EventNotificationTemplateService.ListTemplatesEventNotificationTemplateBuilder listTemplates()

listTemplates

public static EventNotificationTemplateService.ListTemplatesEventNotificationTemplateBuilder listTemplates(EventNotificationTemplateFilter filter)

listTemplates

public static EventNotificationTemplateService.ListTemplatesEventNotificationTemplateBuilder listTemplates(EventNotificationTemplateFilter filter,
                                                                                                           FilterPager pager)

Action lists the template partner event notification templates.

Parameters:

filter -

pager -

register

public static EventNotificationTemplateService.RegisterEventNotificationTemplateBuilder register(String notificationTemplateSystemName,
                                                                                                 PushNotificationParams pushNotificationParams)

Register to a queue from which event messages will be provided according to given template. Queue will be created if not already exists

Parameters:

notificationTemplateSystemName - Existing push notification template system name

pushNotificationParams -

sendCommand

public static EventNotificationTemplateService.SendCommandEventNotificationTemplateBuilder sendCommand(String notificationTemplateSystemName,
                                                                                                       PushNotificationParams pushNotificationParams,
                                                                                                       PushNotificationCommandType command)

Clear queue messages

Parameters:

notificationTemplateSystemName - Existing push notification template system name

pushNotificationParams -

command - Command to be sent to push server

update

public static EventNotificationTemplateService.UpdateEventNotificationTemplateBuilder update(int id,
                                                                                             EventNotificationTemplate eventNotificationTemplate)

Update an existing event notification template object

Parameters:

id -

eventNotificationTemplate -

updateStatus

public static EventNotificationTemplateService.UpdateStatusEventNotificationTemplateBuilder updateStatus(int id,
                                                                                                         EventNotificationTemplateStatus status)

Update event notification template status by id

Parameters:

id -

status -