com.kaltura.client.services.WidgetService 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.Widget;
import com.kaltura.client.types.WidgetFilter;
import com.kaltura.client.utils.request.ListResponseRequestBuilder;
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.
 */

/**
 * widget service for full widget management
 * 
 * @param widget 
 * @param widget 
 * @param id 
 * @param filter 
 * @param pager 
 * @param id 
 * @param widget 
 */
public class WidgetService {
	
	public static class AddWidgetBuilder extends RequestBuilder {
		
		public AddWidgetBuilder(Widget widget) {
			super(Widget.class, "widget", "add");
			params.add("widget", widget);
		}
	}

	/**
	 * Add new widget, can be attached to entry or kshow   SourceWidget is ignored.
	 * 
	 * @param widget 
	 */
    public static AddWidgetBuilder add(Widget widget)  {
		return new AddWidgetBuilder(widget);
	}
	
	public static class CloneWidgetBuilder extends RequestBuilder {
		
		public CloneWidgetBuilder(Widget widget) {
			super(Widget.class, "widget", "clone");
			params.add("widget", widget);
		}
	}

	/**
	 * Add widget based on existing widget.   Must provide valid sourceWidgetId
	 * 
	 * @param widget 
	 */
    public static CloneWidgetBuilder clone(Widget widget)  {
		return new CloneWidgetBuilder(widget);
	}
	
	public static class GetWidgetBuilder extends RequestBuilder {
		
		public GetWidgetBuilder(String id) {
			super(Widget.class, "widget", "get");
			params.add("id", id);
		}
		
		public void id(String multirequestToken) {
			params.add("id", multirequestToken);
		}
	}

	/**
	 * Get widget by id
	 * 
	 * @param id 
	 */
    public static GetWidgetBuilder get(String id)  {
		return new GetWidgetBuilder(id);
	}
	
	public static class ListWidgetBuilder extends ListResponseRequestBuilder {
		
		public ListWidgetBuilder(WidgetFilter filter, FilterPager pager) {
			super(Widget.class, "widget", "list");
			params.add("filter", filter);
			params.add("pager", pager);
		}
	}

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

	public static ListWidgetBuilder list(WidgetFilter filter)  {
		return list(filter, null);
	}

	/**
	 * Retrieve a list of available widget depends on the filter given
	 * 
	 * @param filter 
	 * @param pager 
	 */
    public static ListWidgetBuilder list(WidgetFilter filter, FilterPager pager)  {
		return new ListWidgetBuilder(filter, pager);
	}
	
	public static class UpdateWidgetBuilder extends RequestBuilder {
		
		public UpdateWidgetBuilder(String id, Widget widget) {
			super(Widget.class, "widget", "update");
			params.add("id", id);
			params.add("widget", widget);
		}
		
		public void id(String multirequestToken) {
			params.add("id", multirequestToken);
		}
	}

	/**
	 * Update exisiting widget
	 * 
	 * @param id 
	 * @param widget 
	 */
    public static UpdateWidgetBuilder update(String id, Widget widget)  {
		return new UpdateWidgetBuilder(id, widget);
	}
}