com.kaltura.client.services.ReminderService 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.FilterPager;
import com.kaltura.client.types.Reminder;
import com.kaltura.client.types.ReminderFilter;
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 ReminderService {
	
	public static class AddReminderBuilder extends RequestBuilder {
		
		public AddReminderBuilder(Reminder reminder) {
			super(Reminder.class, "reminder", "add");
			params.add("reminder", reminder);
		}
	}

	/**
	 * Add a new future reminder
	 * 
	 * @param reminder The reminder to be added.
	 */
    public static AddReminderBuilder add(Reminder reminder)  {
		return new AddReminderBuilder(reminder);
	}
	
	public static class DeleteReminderBuilder extends RequestBuilder {
		
		public DeleteReminderBuilder(long id) {
			super(Boolean.class, "reminder", "delete");
			params.add("id", id);
		}
		
		public void id(String multirequestToken) {
			params.add("id", multirequestToken);
		}
	}

	/**
	 * Delete a reminder. Reminder cannot be delete while being sent.
	 * 
	 * @param id Id of the reminder.
	 */
    public static DeleteReminderBuilder delete(long id)  {
		return new DeleteReminderBuilder(id);
	}
	
	public static class ListReminderBuilder extends ListResponseRequestBuilder {
		
		public ListReminderBuilder(ReminderFilter filter, FilterPager pager) {
			super(Reminder.class, "reminder", "list");
			params.add("filter", filter);
			params.add("pager", pager);
		}
	}

	public static ListReminderBuilder list(ReminderFilter filter)  {
		return list(filter, null);
	}

	/**
	 * Return a list of reminders with optional filter by KSQL.
	 * 
	 * @param filter Filter object
	 * @param pager Paging the request
	 */
    public static ListReminderBuilder list(ReminderFilter filter, FilterPager pager)  {
		return new ListReminderBuilder(filter, pager);
	}
}