com.kaltura.client.services.KalturaEventNotificationTemplateService Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of kalturaClient 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
The newest version!
// ===================================================================================================
//                           _  __     _ _
//                          | |/ /__ _| | |_ _  _ _ _ __ _
//                          | ' .
//
// @ignore
// ===================================================================================================
package com.kaltura.client.services;

import com.kaltura.client.KalturaClient;
import com.kaltura.client.KalturaServiceBase;
import com.kaltura.client.types.*;
import org.w3c.dom.Element;
import com.kaltura.client.utils.ParseUtils;
import com.kaltura.client.KalturaParams;
import com.kaltura.client.KalturaApiException;
import com.kaltura.client.enums.*;

/**
 * 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    */
@SuppressWarnings("serial")
public class KalturaEventNotificationTemplateService extends KalturaServiceBase {
    public KalturaEventNotificationTemplateService(KalturaClient client) {
        this.kalturaClient = client;
    }

	/**  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.     */
    public KalturaEventNotificationTemplate add(KalturaEventNotificationTemplate eventNotificationTemplate) throws KalturaApiException {
        KalturaParams kparams = new KalturaParams();
        kparams.add("eventNotificationTemplate", eventNotificationTemplate);
        this.kalturaClient.queueServiceCall("eventnotification_eventnotificationtemplate", "add", kparams, KalturaEventNotificationTemplate.class);
        if (this.kalturaClient.isMultiRequest())
            return null;
        Element resultXmlElement = this.kalturaClient.doQueue();
        return ParseUtils.parseObject(KalturaEventNotificationTemplate.class, resultXmlElement);
    }

    public KalturaEventNotificationTemplate clone(int id) throws KalturaApiException {
        return this.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.     */
    public KalturaEventNotificationTemplate clone(int id, KalturaEventNotificationTemplate eventNotificationTemplate) throws KalturaApiException {
        KalturaParams kparams = new KalturaParams();
        kparams.add("id", id);
        kparams.add("eventNotificationTemplate", eventNotificationTemplate);
        this.kalturaClient.queueServiceCall("eventnotification_eventnotificationtemplate", "clone", kparams, KalturaEventNotificationTemplate.class);
        if (this.kalturaClient.isMultiRequest())
            return null;
        Element resultXmlElement = this.kalturaClient.doQueue();
        return ParseUtils.parseObject(KalturaEventNotificationTemplate.class, resultXmlElement);
    }

	/**  Retrieve an event notification template object by id     */
    public KalturaEventNotificationTemplate get(int id) throws KalturaApiException {
        KalturaParams kparams = new KalturaParams();
        kparams.add("id", id);
        this.kalturaClient.queueServiceCall("eventnotification_eventnotificationtemplate", "get", kparams, KalturaEventNotificationTemplate.class);
        if (this.kalturaClient.isMultiRequest())
            return null;
        Element resultXmlElement = this.kalturaClient.doQueue();
        return ParseUtils.parseObject(KalturaEventNotificationTemplate.class, resultXmlElement);
    }

	/**  Update an existing event notification template object     */
    public KalturaEventNotificationTemplate update(int id, KalturaEventNotificationTemplate eventNotificationTemplate) throws KalturaApiException {
        KalturaParams kparams = new KalturaParams();
        kparams.add("id", id);
        kparams.add("eventNotificationTemplate", eventNotificationTemplate);
        this.kalturaClient.queueServiceCall("eventnotification_eventnotificationtemplate", "update", kparams, KalturaEventNotificationTemplate.class);
        if (this.kalturaClient.isMultiRequest())
            return null;
        Element resultXmlElement = this.kalturaClient.doQueue();
        return ParseUtils.parseObject(KalturaEventNotificationTemplate.class, resultXmlElement);
    }

	/**  Update event notification template status by id     */
    public KalturaEventNotificationTemplate updateStatus(int id, KalturaEventNotificationTemplateStatus status) throws KalturaApiException {
        KalturaParams kparams = new KalturaParams();
        kparams.add("id", id);
        kparams.add("status", status);
        this.kalturaClient.queueServiceCall("eventnotification_eventnotificationtemplate", "updateStatus", kparams, KalturaEventNotificationTemplate.class);
        if (this.kalturaClient.isMultiRequest())
            return null;
        Element resultXmlElement = this.kalturaClient.doQueue();
        return ParseUtils.parseObject(KalturaEventNotificationTemplate.class, resultXmlElement);
    }

	/**  Delete an event notification template object     */
    public void delete(int id) throws KalturaApiException {
        KalturaParams kparams = new KalturaParams();
        kparams.add("id", id);
        this.kalturaClient.queueServiceCall("eventnotification_eventnotificationtemplate", "delete", kparams);
        if (this.kalturaClient.isMultiRequest())
            return ;
        this.kalturaClient.doQueue();
    }

    public KalturaEventNotificationTemplateListResponse list() throws KalturaApiException {
        return this.list(null);
    }

    public KalturaEventNotificationTemplateListResponse list(KalturaEventNotificationTemplateFilter filter) throws KalturaApiException {
        return this.list(filter, null);
    }

	/**  list event notification template objects     */
    public KalturaEventNotificationTemplateListResponse list(KalturaEventNotificationTemplateFilter filter, KalturaFilterPager pager) throws KalturaApiException {
        KalturaParams kparams = new KalturaParams();
        kparams.add("filter", filter);
        kparams.add("pager", pager);
        this.kalturaClient.queueServiceCall("eventnotification_eventnotificationtemplate", "list", kparams, KalturaEventNotificationTemplateListResponse.class);
        if (this.kalturaClient.isMultiRequest())
            return null;
        Element resultXmlElement = this.kalturaClient.doQueue();
        return ParseUtils.parseObject(KalturaEventNotificationTemplateListResponse.class, resultXmlElement);
    }

    public KalturaEventNotificationTemplateListResponse listByPartner() throws KalturaApiException {
        return this.listByPartner(null);
    }

    public KalturaEventNotificationTemplateListResponse listByPartner(KalturaPartnerFilter filter) throws KalturaApiException {
        return this.listByPartner(filter, null);
    }

    public KalturaEventNotificationTemplateListResponse listByPartner(KalturaPartnerFilter filter, KalturaFilterPager pager) throws KalturaApiException {
        KalturaParams kparams = new KalturaParams();
        kparams.add("filter", filter);
        kparams.add("pager", pager);
        this.kalturaClient.queueServiceCall("eventnotification_eventnotificationtemplate", "listByPartner", kparams, KalturaEventNotificationTemplateListResponse.class);
        if (this.kalturaClient.isMultiRequest())
            return null;
        Element resultXmlElement = this.kalturaClient.doQueue();
        return ParseUtils.parseObject(KalturaEventNotificationTemplateListResponse.class, resultXmlElement);
    }

	/**  Dispatch event notification object by id     */
    public int dispatch(int id, KalturaEventNotificationScope scope) throws KalturaApiException {
        KalturaParams kparams = new KalturaParams();
        kparams.add("id", id);
        kparams.add("scope", scope);
        this.kalturaClient.queueServiceCall("eventnotification_eventnotificationtemplate", "dispatch", kparams);
        if (this.kalturaClient.isMultiRequest())
            return 0;
        Element resultXmlElement = this.kalturaClient.doQueue();
        String resultText = resultXmlElement.getTextContent();
        return ParseUtils.parseInt(resultText);
    }

    public KalturaEventNotificationTemplateListResponse listTemplates() throws KalturaApiException {
        return this.listTemplates(null);
    }

    public KalturaEventNotificationTemplateListResponse listTemplates(KalturaEventNotificationTemplateFilter filter) throws KalturaApiException {
        return this.listTemplates(filter, null);
    }

	/**  Action lists the template partner event notification templates.     */
    public KalturaEventNotificationTemplateListResponse listTemplates(KalturaEventNotificationTemplateFilter filter, KalturaFilterPager pager) throws KalturaApiException {
        KalturaParams kparams = new KalturaParams();
        kparams.add("filter", filter);
        kparams.add("pager", pager);
        this.kalturaClient.queueServiceCall("eventnotification_eventnotificationtemplate", "listTemplates", kparams, KalturaEventNotificationTemplateListResponse.class);
        if (this.kalturaClient.isMultiRequest())
            return null;
        Element resultXmlElement = this.kalturaClient.doQueue();
        return ParseUtils.parseObject(KalturaEventNotificationTemplateListResponse.class, resultXmlElement);
    }
}