com.kaltura.client.services.BookmarkService 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.Bookmark;
import com.kaltura.client.types.BookmarkFilter;
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 BookmarkService {
	
	public static class AddBookmarkBuilder extends RequestBuilder {
		
		public AddBookmarkBuilder(Bookmark bookmark) {
			super(Boolean.class, "bookmark", "add");
			params.add("bookmark", bookmark);
		}
	}

	/**
	 * Report player position and action for the user on the watched asset. Player
	  position is used to later allow resume watching.
	 * 
	 * @param bookmark Bookmark details
	 */
    public static AddBookmarkBuilder add(Bookmark bookmark)  {
		return new AddBookmarkBuilder(bookmark);
	}
	
	public static class ListBookmarkBuilder extends ListResponseRequestBuilder {
		
		public ListBookmarkBuilder(BookmarkFilter filter) {
			super(Bookmark.class, "bookmark", "list");
			params.add("filter", filter);
		}
	}

	/**
	 * Returns player position record/s for the requested asset and the requesting
	  user.               If default user makes the request – player position
	  records are provided for all of the users in the household.              If
	  non-default user makes the request - player position records are provided for
	  the requesting user and the default user of the household.
	 * 
	 * @param filter Filter option for the last position
	 */
    public static ListBookmarkBuilder list(BookmarkFilter filter)  {
		return new ListBookmarkBuilder(filter);
	}
}