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

Go to download

Show more of this group Show more artifacts with this name
Show all versions of KalturaOttApiClient Show documentation

KalturaOttApiClient is a library of Java classes that can be used to interact with the Kaltura OTT REST API. More information about the REST API can be found at https://ott.developer.kaltura.com/ Many of the Java classes in this library are auto-generated from a schema that defines the objects that are used to interact with the API.

There is a newer version: 5.1.2.17630

Show newest version

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

import com.kaltura.client.types.Favorite;
import com.kaltura.client.types.FavoriteFilter;
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 FavoriteService {
	
	public static class AddFavoriteBuilder extends RequestBuilder {
		
		public AddFavoriteBuilder(Favorite favorite) {
			super(Favorite.class, "favorite", "add");
			params.add("favorite", favorite);
		}
	}

	/**
	 * Add media to user&#39;s favorite list
	 * 
	 * @param favorite Favorite details.
	 */
    public static AddFavoriteBuilder add(Favorite favorite)  {
		return new AddFavoriteBuilder(favorite);
	}
	
	public static class DeleteFavoriteBuilder extends RequestBuilder {
		
		public DeleteFavoriteBuilder(int id) {
			super(Boolean.class, "favorite", "delete");
			params.add("id", id);
		}
		
		public void id(String multirequestToken) {
			params.add("id", multirequestToken);
		}
	}

	/**
	 * Remove media from user&#39;s favorite list
	 * 
	 * @param id Media identifier
	 */
    public static DeleteFavoriteBuilder delete(int id)  {
		return new DeleteFavoriteBuilder(id);
	}
	
	public static class ListFavoriteBuilder extends ListResponseRequestBuilder {
		
		public ListFavoriteBuilder(FavoriteFilter filter) {
			super(Favorite.class, "favorite", "list");
			params.add("filter", filter);
		}
	}

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

	/**
	 * Retrieving users&#39; favorites
	 * 
	 * @param filter Request filter
	 */
    public static ListFavoriteBuilder list(FavoriteFilter filter)  {
		return new ListFavoriteBuilder(filter);
	}
}