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

Show more of this group Show more artifacts with this name
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

There is a newer version: 19.3.0

Show newest version

// ===================================================================================================
//                           _  __     _ _
//                          | |/ /__ _| | |_ _  _ _ _ __ _
//                          | ' .
//
// @ignore
// ===================================================================================================
package com.kaltura.client.services;

import com.kaltura.client.types.CaptionParams;
import com.kaltura.client.types.CaptionParamsFilter;
import com.kaltura.client.types.FilterPager;
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.
 */

/**
 * Add & Manage Caption Params
 * 
 * @param captionParams 
 * @param id 
 * @param id 
 * @param filter 
 * @param pager 
 * @param id 
 * @param captionParams 
 */
public class CaptionParamsService {
	
	public static class AddCaptionParamsBuilder extends RequestBuilder {
		
		public AddCaptionParamsBuilder(CaptionParams captionParams) {
			super(CaptionParams.class, "caption_captionparams", "add");
			params.add("captionParams", captionParams);
		}
	}

	/**
	 * Add new Caption Params
	 * 
	 * @param captionParams 
	 */
    public static AddCaptionParamsBuilder add(CaptionParams captionParams)  {
		return new AddCaptionParamsBuilder(captionParams);
	}
	
	public static class DeleteCaptionParamsBuilder extends NullRequestBuilder {
		
		public DeleteCaptionParamsBuilder(int id) {
			super("caption_captionparams", "delete");
			params.add("id", id);
		}
		
		public void id(String multirequestToken) {
			params.add("id", multirequestToken);
		}
	}

	/**
	 * Delete Caption Params by ID
	 * 
	 * @param id 
	 */
    public static DeleteCaptionParamsBuilder delete(int id)  {
		return new DeleteCaptionParamsBuilder(id);
	}
	
	public static class GetCaptionParamsBuilder extends RequestBuilder {
		
		public GetCaptionParamsBuilder(int id) {
			super(CaptionParams.class, "caption_captionparams", "get");
			params.add("id", id);
		}
		
		public void id(String multirequestToken) {
			params.add("id", multirequestToken);
		}
	}

	/**
	 * Get Caption Params by ID
	 * 
	 * @param id 
	 */
    public static GetCaptionParamsBuilder get(int id)  {
		return new GetCaptionParamsBuilder(id);
	}
	
	public static class ListCaptionParamsBuilder extends ListResponseRequestBuilder {
		
		public ListCaptionParamsBuilder(CaptionParamsFilter filter, FilterPager pager) {
			super(CaptionParams.class, "caption_captionparams", "list");
			params.add("filter", filter);
			params.add("pager", pager);
		}
	}

	public static ListCaptionParamsBuilder list()  {
		return list(null);
	}

	public static ListCaptionParamsBuilder list(CaptionParamsFilter filter)  {
		return list(filter, null);
	}

	/**
	 * List Caption Params by filter with paging support (By default - all system
	  default params will be listed too)
	 * 
	 * @param filter 
	 * @param pager 
	 */
    public static ListCaptionParamsBuilder list(CaptionParamsFilter filter, FilterPager pager)  {
		return new ListCaptionParamsBuilder(filter, pager);
	}
	
	public static class UpdateCaptionParamsBuilder extends RequestBuilder {
		
		public UpdateCaptionParamsBuilder(int id, CaptionParams captionParams) {
			super(CaptionParams.class, "caption_captionparams", "update");
			params.add("id", id);
			params.add("captionParams", captionParams);
		}
		
		public void id(String multirequestToken) {
			params.add("id", multirequestToken);
		}
	}

	/**
	 * Update Caption Params by ID
	 * 
	 * @param id 
	 * @param captionParams 
	 */
    public static UpdateCaptionParamsBuilder update(int id, CaptionParams captionParams)  {
		return new UpdateCaptionParamsBuilder(id, captionParams);
	}
}