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

Go to download

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.FilterPager;
import com.kaltura.client.types.ShortLink;
import com.kaltura.client.types.ShortLinkFilter;
import com.kaltura.client.utils.request.ListResponseRequestBuilder;
import com.kaltura.client.utils.request.RequestBuilder;
import com.kaltura.client.utils.request.ServeRequestBuilder;

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

/**
 * Short link service
 * 
 * @param shortLink 
 * @param id 
 * @param id 
 * @param id 
 * @param proxy proxy the response instead of redirect
 * @param filter 
 * @param pager 
 * @param id 
 * @param shortLink 
 */
public class ShortLinkService {
	
	public static class AddShortLinkBuilder extends RequestBuilder {
		
		public AddShortLinkBuilder(ShortLink shortLink) {
			super(ShortLink.class, "shortlink_shortlink", "add");
			params.add("shortLink", shortLink);
		}
	}

	/**
	 * Allows you to add a short link object
	 * 
	 * @param shortLink 
	 */
    public static AddShortLinkBuilder add(ShortLink shortLink)  {
		return new AddShortLinkBuilder(shortLink);
	}
	
	public static class DeleteShortLinkBuilder extends RequestBuilder {
		
		public DeleteShortLinkBuilder(String id) {
			super(ShortLink.class, "shortlink_shortlink", "delete");
			params.add("id", id);
		}
		
		public void id(String multirequestToken) {
			params.add("id", multirequestToken);
		}
	}

	/**
	 * Mark the short link as deleted
	 * 
	 * @param id 
	 */
    public static DeleteShortLinkBuilder delete(String id)  {
		return new DeleteShortLinkBuilder(id);
	}
	
	public static class GetShortLinkBuilder extends RequestBuilder {
		
		public GetShortLinkBuilder(String id) {
			super(ShortLink.class, "shortlink_shortlink", "get");
			params.add("id", id);
		}
		
		public void id(String multirequestToken) {
			params.add("id", multirequestToken);
		}
	}

	/**
	 * Retrieve an short link object by id
	 * 
	 * @param id 
	 */
    public static GetShortLinkBuilder get(String id)  {
		return new GetShortLinkBuilder(id);
	}
	
	public static class GotoShortLinkBuilder extends ServeRequestBuilder {
		
		public GotoShortLinkBuilder(String id, boolean proxy) {
			super("shortlink_shortlink", "goto");
			params.add("id", id);
			params.add("proxy", proxy);
		}
		
		public void id(String multirequestToken) {
			params.add("id", multirequestToken);
		}
		
		public void proxy(String multirequestToken) {
			params.add("proxy", multirequestToken);
		}
	}

	public static GotoShortLinkBuilder goto_(String id)  {
		return goto_(id, false);
	}

	/**
	 * Serves short link
	 * 
	 * @param id 
	 * @param proxy proxy the response instead of redirect
	 */
    public static GotoShortLinkBuilder goto_(String id, boolean proxy)  {
		return new GotoShortLinkBuilder(id, proxy);
	}
	
	public static class ListShortLinkBuilder extends ListResponseRequestBuilder {
		
		public ListShortLinkBuilder(ShortLinkFilter filter, FilterPager pager) {
			super(ShortLink.class, "shortlink_shortlink", "list");
			params.add("filter", filter);
			params.add("pager", pager);
		}
	}

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

	public static ListShortLinkBuilder list(ShortLinkFilter filter)  {
		return list(filter, null);
	}

	/**
	 * List short link objects by filter and pager
	 * 
	 * @param filter 
	 * @param pager 
	 */
    public static ListShortLinkBuilder list(ShortLinkFilter filter, FilterPager pager)  {
		return new ListShortLinkBuilder(filter, pager);
	}
	
	public static class UpdateShortLinkBuilder extends RequestBuilder {
		
		public UpdateShortLinkBuilder(String id, ShortLink shortLink) {
			super(ShortLink.class, "shortlink_shortlink", "update");
			params.add("id", id);
			params.add("shortLink", shortLink);
		}
		
		public void id(String multirequestToken) {
			params.add("id", multirequestToken);
		}
	}

	/**
	 * Update exisitng short link
	 * 
	 * @param id 
	 * @param shortLink 
	 */
    public static UpdateShortLinkBuilder update(String id, ShortLink shortLink)  {
		return new UpdateShortLinkBuilder(id, shortLink);
	}
}