com.kaltura.client.services.AnnouncementService 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.Announcement;
import com.kaltura.client.types.AnnouncementFilter;
import com.kaltura.client.types.FilterPager;
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 AnnouncementService {
	
	public static class AddAnnouncementBuilder extends RequestBuilder {
		
		public AddAnnouncementBuilder(Announcement announcement) {
			super(Announcement.class, "announcement", "add");
			params.add("announcement", announcement);
		}
	}

	/**
	 * Add a new future scheduled system announcement push notification
	 * 
	 * @param announcement The announcement to be added.
	 *             timezone parameter should be taken from the 'name of timezone' from:
	 * https://msdn.microsoft.com/en-us/library/ms912391(v=winembedded.11).aspx
	 *             Recipients values: All, LoggedIn, Guests
	 */
    public static AddAnnouncementBuilder add(Announcement announcement)  {
		return new AddAnnouncementBuilder(announcement);
	}
	
	public static class DeleteAnnouncementBuilder extends RequestBuilder {
		
		public DeleteAnnouncementBuilder(long id) {
			super(Boolean.class, "announcement", "delete");
			params.add("id", id);
		}
		
		public void id(String multirequestToken) {
			params.add("id", multirequestToken);
		}
	}

	/**
	 * Delete an existing announcing. Announcement cannot be delete while being sent.
	 * 
	 * @param id Id of the announcement.
	 */
    public static DeleteAnnouncementBuilder delete(long id)  {
		return new DeleteAnnouncementBuilder(id);
	}
	
	public static class EnableSystemAnnouncementsAnnouncementBuilder extends RequestBuilder {
		
		public EnableSystemAnnouncementsAnnouncementBuilder() {
			super(Boolean.class, "announcement", "enableSystemAnnouncements");
		}
	}

	/**
	 * Enable system announcements
	 */
    public static EnableSystemAnnouncementsAnnouncementBuilder enableSystemAnnouncements()  {
		return new EnableSystemAnnouncementsAnnouncementBuilder();
	}
	
	public static class ListAnnouncementBuilder extends ListResponseRequestBuilder {
		
		public ListAnnouncementBuilder(AnnouncementFilter filter, FilterPager pager) {
			super(Announcement.class, "announcement", "list");
			params.add("filter", filter);
			params.add("pager", pager);
		}
	}

	public static ListAnnouncementBuilder list(AnnouncementFilter filter)  {
		return list(filter, null);
	}

	/**
	 * Lists all announcements in the system.
	 * 
	 * @param filter Filter object
	 * @param pager Paging the request
	 */
    public static ListAnnouncementBuilder list(AnnouncementFilter filter, FilterPager pager)  {
		return new ListAnnouncementBuilder(filter, pager);
	}
	
	public static class UpdateAnnouncementBuilder extends RequestBuilder {
		
		public UpdateAnnouncementBuilder(int announcementId, Announcement announcement) {
			super(Announcement.class, "announcement", "update");
			params.add("announcementId", announcementId);
			params.add("announcement", announcement);
		}
		
		public void announcementId(String multirequestToken) {
			params.add("announcementId", multirequestToken);
		}
	}

	/**
	 * Update an existing future system announcement push notification. Announcement
	  can only be updated only before sending
	 * 
	 * @param announcementId The announcement identifier
	 * @param announcement The announcement to update.
	 *             timezone parameter should be taken from the 'name of timezone' from:
	 * https://msdn.microsoft.com/en-us/library/ms912391(v=winembedded.11).aspx
	 *             Recipients values: All, LoggedIn, Guests
	 */
    public static UpdateAnnouncementBuilder update(int announcementId, Announcement announcement)  {
		return new UpdateAnnouncementBuilder(announcementId, announcement);
	}
	
	public static class UpdateStatusAnnouncementBuilder extends RequestBuilder {
		
		public UpdateStatusAnnouncementBuilder(long id, boolean status) {
			super(Boolean.class, "announcement", "updateStatus");
			params.add("id", id);
			params.add("status", status);
		}
		
		public void id(String multirequestToken) {
			params.add("id", multirequestToken);
		}
		
		public void status(String multirequestToken) {
			params.add("status", multirequestToken);
		}
	}

	/**
	 * Update a system announcement status
	 * 
	 * @param id Id of the announcement.
	 * @param status Status to update to.
	 */
    public static UpdateStatusAnnouncementBuilder updateStatus(long id, boolean status)  {
		return new UpdateStatusAnnouncementBuilder(id, status);
	}
}