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

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

import com.kaltura.client.types.FilterPager;
import com.kaltura.client.types.Recording;
import com.kaltura.client.types.RecordingFilter;
import com.kaltura.client.utils.request.ListResponseRequestBuilder;
import com.kaltura.client.utils.request.RequestBuilder;

/**
 * This class was generated using clients-generator\exec.php
 * against an XML schema provided by Kaltura.
 * 
 * MANUAL CHANGES TO THIS CLASS WILL BE OVERWRITTEN.
 */

public class RecordingService {
	
	public static class AddRecordingBuilder extends RequestBuilder {
		
		public AddRecordingBuilder(Recording recording) {
			super(Recording.class, "recording", "add");
			params.add("recording", recording);
		}
	}

	/**
	 * Issue a record request for a program
	 * 
	 * @param recording Recording Object
	 */
    public static AddRecordingBuilder add(Recording recording)  {
		return new AddRecordingBuilder(recording);
	}
	
	public static class CancelRecordingBuilder extends RequestBuilder {
		
		public CancelRecordingBuilder(long id) {
			super(Recording.class, "recording", "cancel");
			params.add("id", id);
		}
		
		public void id(String multirequestToken) {
			params.add("id", multirequestToken);
		}
	}

	/**
	 * Cancel a previously requested recording. Cancel recording can be called for
	  recording in status Scheduled or Recording Only
	 * 
	 * @param id Recording identifier
	 */
    public static CancelRecordingBuilder cancel(long id)  {
		return new CancelRecordingBuilder(id);
	}
	
	public static class DeleteRecordingBuilder extends RequestBuilder {
		
		public DeleteRecordingBuilder(long id) {
			super(Recording.class, "recording", "delete");
			params.add("id", id);
		}
		
		public void id(String multirequestToken) {
			params.add("id", multirequestToken);
		}
	}

	/**
	 * Delete one or more user recording(s). Delete recording can be called only for
	  recordings in status Recorded
	 * 
	 * @param id Recording identifier
	 */
    public static DeleteRecordingBuilder delete(long id)  {
		return new DeleteRecordingBuilder(id);
	}
	
	public static class GetRecordingBuilder extends RequestBuilder {
		
		public GetRecordingBuilder(long id) {
			super(Recording.class, "recording", "get");
			params.add("id", id);
		}
		
		public void id(String multirequestToken) {
			params.add("id", multirequestToken);
		}
	}

	/**
	 * Returns recording object by internal identifier
	 * 
	 * @param id Recording identifier
	 */
    public static GetRecordingBuilder get(long id)  {
		return new GetRecordingBuilder(id);
	}
	
	public static class ListRecordingBuilder extends ListResponseRequestBuilder {
		
		public ListRecordingBuilder(RecordingFilter filter, FilterPager pager) {
			super(Recording.class, "recording", "list");
			params.add("filter", filter);
			params.add("pager", pager);
		}
	}

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

	public static ListRecordingBuilder list(RecordingFilter filter)  {
		return list(filter, null);
	}

	/**
	 * Return a list of recordings for the household with optional filter by status and
	  KSQL.
	 * 
	 * @param filter Filter parameters for filtering out the result
	 * @param pager Page size and index
	 */
    public static ListRecordingBuilder list(RecordingFilter filter, FilterPager pager)  {
		return new ListRecordingBuilder(filter, pager);
	}
	
	public static class ProtectRecordingBuilder extends RequestBuilder {
		
		public ProtectRecordingBuilder(long id) {
			super(Recording.class, "recording", "protect");
			params.add("id", id);
		}
		
		public void id(String multirequestToken) {
			params.add("id", multirequestToken);
		}
	}

	/**
	 * Protects an existing recording from the cleanup process for the defined
	  protection period
	 * 
	 * @param id Recording identifier
	 */
    public static ProtectRecordingBuilder protect(long id)  {
		return new ProtectRecordingBuilder(id);
	}
}