com.kaltura.client.services.EventNotificationTemplateService Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of kalturaApiClient Show documentation
Show all versions of kalturaApiClient Show documentation
KalturaClient is a library of Java classes that can be used to interact
with the Kaltura REST API. More information about the REST API can be
found at http://corp.kaltura.com/Products/Kaltura-API Many of the Java classes
in this library are auto-generated from a schema that defines the objects that
are used to interect with the API. The current schema can be found at
http://www.kaltura.com/api_v3/api_schema.php
// ===================================================================================================
// _ __ _ _
// | |/ /__ _| | |_ _ _ _ _ __ _
// | ' .
//
// @ignore
// ===================================================================================================
package com.kaltura.client.services;
import com.kaltura.client.enums.EventNotificationTemplateStatus;
import com.kaltura.client.enums.PushNotificationCommandType;
import com.kaltura.client.types.EventNotificationScope;
import com.kaltura.client.types.EventNotificationTemplate;
import com.kaltura.client.types.EventNotificationTemplateFilter;
import com.kaltura.client.types.FilterPager;
import com.kaltura.client.types.PartnerFilter;
import com.kaltura.client.types.PushNotificationData;
import com.kaltura.client.types.PushNotificationParams;
import com.kaltura.client.utils.request.ListResponseRequestBuilder;
import com.kaltura.client.utils.request.NullRequestBuilder;
import com.kaltura.client.utils.request.RequestBuilder;
/**
* This class was generated using generate.php
* against an XML schema provided by Kaltura.
*
* MANUAL CHANGES TO THIS CLASS WILL BE OVERWRITTEN.
*/
/**
* Event notification template service lets you create and manage event
notification templates
*
* @param eventNotificationTemplate
* @param id source template to clone
* @param eventNotificationTemplate overwrite configuration object
* @param id
* @param id
* @param scope
* @param id
* @param filter
* @param pager
* @param filter
* @param pager
* @param filter
* @param pager
* @param notificationTemplateSystemName Existing push notification template system name
* @param pushNotificationParams
* @param notificationTemplateSystemName Existing push notification template system name
* @param pushNotificationParams
* @param command Command to be sent to push server
* @param id
* @param eventNotificationTemplate
* @param id
* @param status
*/
public class EventNotificationTemplateService {
public static class AddEventNotificationTemplateBuilder extends RequestBuilder {
public AddEventNotificationTemplateBuilder(EventNotificationTemplate eventNotificationTemplate) {
super(EventNotificationTemplate.class, "eventnotification_eventnotificationtemplate", "add");
params.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.
*
* @param eventNotificationTemplate
*/
public static AddEventNotificationTemplateBuilder add(EventNotificationTemplate eventNotificationTemplate) {
return new AddEventNotificationTemplateBuilder(eventNotificationTemplate);
}
public static class CloneEventNotificationTemplateBuilder extends RequestBuilder {
public CloneEventNotificationTemplateBuilder(int id, EventNotificationTemplate eventNotificationTemplate) {
super(EventNotificationTemplate.class, "eventnotification_eventnotificationtemplate", "clone");
params.add("id", id);
params.add("eventNotificationTemplate", eventNotificationTemplate);
}
public void id(String multirequestToken) {
params.add("id", multirequestToken);
}
}
public static CloneEventNotificationTemplateBuilder clone(int id) {
return clone(id, null);
}
/**
* 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.
*
* @param id source template to clone
* @param eventNotificationTemplate overwrite configuration object
*/
public static CloneEventNotificationTemplateBuilder clone(int id, EventNotificationTemplate eventNotificationTemplate) {
return new CloneEventNotificationTemplateBuilder(id, eventNotificationTemplate);
}
public static class DeleteEventNotificationTemplateBuilder extends NullRequestBuilder {
public DeleteEventNotificationTemplateBuilder(int id) {
super("eventnotification_eventnotificationtemplate", "delete");
params.add("id", id);
}
public void id(String multirequestToken) {
params.add("id", multirequestToken);
}
}
/**
* Delete an event notification template object
*
* @param id
*/
public static DeleteEventNotificationTemplateBuilder delete(int id) {
return new DeleteEventNotificationTemplateBuilder(id);
}
public static class DispatchEventNotificationTemplateBuilder extends RequestBuilder {
public DispatchEventNotificationTemplateBuilder(int id, EventNotificationScope scope) {
super(Integer.class, "eventnotification_eventnotificationtemplate", "dispatch");
params.add("id", id);
params.add("scope", scope);
}
public void id(String multirequestToken) {
params.add("id", multirequestToken);
}
}
/**
* Dispatch event notification object by id
*
* @param id
* @param scope
*/
public static DispatchEventNotificationTemplateBuilder dispatch(int id, EventNotificationScope scope) {
return new DispatchEventNotificationTemplateBuilder(id, scope);
}
public static class GetEventNotificationTemplateBuilder extends RequestBuilder {
public GetEventNotificationTemplateBuilder(int id) {
super(EventNotificationTemplate.class, "eventnotification_eventnotificationtemplate", "get");
params.add("id", id);
}
public void id(String multirequestToken) {
params.add("id", multirequestToken);
}
}
/**
* Retrieve an event notification template object by id
*
* @param id
*/
public static GetEventNotificationTemplateBuilder get(int id) {
return new GetEventNotificationTemplateBuilder(id);
}
public static class ListEventNotificationTemplateBuilder extends ListResponseRequestBuilder {
public ListEventNotificationTemplateBuilder(EventNotificationTemplateFilter filter, FilterPager pager) {
super(EventNotificationTemplate.class, "eventnotification_eventnotificationtemplate", "list");
params.add("filter", filter);
params.add("pager", pager);
}
}
public static ListEventNotificationTemplateBuilder list() {
return list(null);
}
public static ListEventNotificationTemplateBuilder list(EventNotificationTemplateFilter filter) {
return list(filter, null);
}
/**
* list event notification template objects
*
* @param filter
* @param pager
*/
public static ListEventNotificationTemplateBuilder list(EventNotificationTemplateFilter filter, FilterPager pager) {
return new ListEventNotificationTemplateBuilder(filter, pager);
}
public static class ListByPartnerEventNotificationTemplateBuilder extends ListResponseRequestBuilder {
public ListByPartnerEventNotificationTemplateBuilder(PartnerFilter filter, FilterPager pager) {
super(EventNotificationTemplate.class, "eventnotification_eventnotificationtemplate", "listByPartner");
params.add("filter", filter);
params.add("pager", pager);
}
}
public static ListByPartnerEventNotificationTemplateBuilder listByPartner() {
return listByPartner(null);
}
public static ListByPartnerEventNotificationTemplateBuilder listByPartner(PartnerFilter filter) {
return listByPartner(filter, null);
}
public static ListByPartnerEventNotificationTemplateBuilder listByPartner(PartnerFilter filter, FilterPager pager) {
return new ListByPartnerEventNotificationTemplateBuilder(filter, pager);
}
public static class ListTemplatesEventNotificationTemplateBuilder extends ListResponseRequestBuilder {
public ListTemplatesEventNotificationTemplateBuilder(EventNotificationTemplateFilter filter, FilterPager pager) {
super(EventNotificationTemplate.class, "eventnotification_eventnotificationtemplate", "listTemplates");
params.add("filter", filter);
params.add("pager", pager);
}
}
public static ListTemplatesEventNotificationTemplateBuilder listTemplates() {
return listTemplates(null);
}
public static ListTemplatesEventNotificationTemplateBuilder listTemplates(EventNotificationTemplateFilter filter) {
return listTemplates(filter, null);
}
/**
* Action lists the template partner event notification templates.
*
* @param filter
* @param pager
*/
public static ListTemplatesEventNotificationTemplateBuilder listTemplates(EventNotificationTemplateFilter filter, FilterPager pager) {
return new ListTemplatesEventNotificationTemplateBuilder(filter, pager);
}
public static class RegisterEventNotificationTemplateBuilder extends RequestBuilder {
public RegisterEventNotificationTemplateBuilder(String notificationTemplateSystemName, PushNotificationParams pushNotificationParams) {
super(PushNotificationData.class, "eventnotification_eventnotificationtemplate", "register");
params.add("notificationTemplateSystemName", notificationTemplateSystemName);
params.add("pushNotificationParams", pushNotificationParams);
}
public void notificationTemplateSystemName(String multirequestToken) {
params.add("notificationTemplateSystemName", multirequestToken);
}
}
/**
* Register to a queue from which event messages will be provided according to
given template. Queue will be created if not already exists
*
* @param notificationTemplateSystemName Existing push notification template system name
* @param pushNotificationParams
*/
public static RegisterEventNotificationTemplateBuilder register(String notificationTemplateSystemName, PushNotificationParams pushNotificationParams) {
return new RegisterEventNotificationTemplateBuilder(notificationTemplateSystemName, pushNotificationParams);
}
public static class SendCommandEventNotificationTemplateBuilder extends NullRequestBuilder {
public SendCommandEventNotificationTemplateBuilder(String notificationTemplateSystemName, PushNotificationParams pushNotificationParams, PushNotificationCommandType command) {
super("eventnotification_eventnotificationtemplate", "sendCommand");
params.add("notificationTemplateSystemName", notificationTemplateSystemName);
params.add("pushNotificationParams", pushNotificationParams);
params.add("command", command);
}
public void notificationTemplateSystemName(String multirequestToken) {
params.add("notificationTemplateSystemName", multirequestToken);
}
public void command(String multirequestToken) {
params.add("command", multirequestToken);
}
}
/**
* Clear queue messages
*
* @param notificationTemplateSystemName Existing push notification template system name
* @param pushNotificationParams
* @param command Command to be sent to push server
*/
public static SendCommandEventNotificationTemplateBuilder sendCommand(String notificationTemplateSystemName, PushNotificationParams pushNotificationParams, PushNotificationCommandType command) {
return new SendCommandEventNotificationTemplateBuilder(notificationTemplateSystemName, pushNotificationParams, command);
}
public static class UpdateEventNotificationTemplateBuilder extends RequestBuilder {
public UpdateEventNotificationTemplateBuilder(int id, EventNotificationTemplate eventNotificationTemplate) {
super(EventNotificationTemplate.class, "eventnotification_eventnotificationtemplate", "update");
params.add("id", id);
params.add("eventNotificationTemplate", eventNotificationTemplate);
}
public void id(String multirequestToken) {
params.add("id", multirequestToken);
}
}
/**
* Update an existing event notification template object
*
* @param id
* @param eventNotificationTemplate
*/
public static UpdateEventNotificationTemplateBuilder update(int id, EventNotificationTemplate eventNotificationTemplate) {
return new UpdateEventNotificationTemplateBuilder(id, eventNotificationTemplate);
}
public static class UpdateStatusEventNotificationTemplateBuilder extends RequestBuilder {
public UpdateStatusEventNotificationTemplateBuilder(int id, EventNotificationTemplateStatus status) {
super(EventNotificationTemplate.class, "eventnotification_eventnotificationtemplate", "updateStatus");
params.add("id", id);
params.add("status", status);
}
public void id(String multirequestToken) {
params.add("id", multirequestToken);
}
public void status(String multirequestToken) {
params.add("status", multirequestToken);
}
}
/**
* Update event notification template status by id
*
* @param id
* @param status
*/
public static UpdateStatusEventNotificationTemplateBuilder updateStatus(int id, EventNotificationTemplateStatus status) {
return new UpdateStatusEventNotificationTemplateBuilder(id, status);
}
}