com.kaltura.client.services.HouseholdUserService 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.HouseholdUser;
import com.kaltura.client.types.HouseholdUserFilter;
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 HouseholdUserService {
	
	public static class AddHouseholdUserBuilder extends RequestBuilder {
		
		public AddHouseholdUserBuilder(HouseholdUser householdUser) {
			super(HouseholdUser.class, "householduser", "add");
			params.add("householdUser", householdUser);
		}
	}

	/**
	 * Adds a user to household
	 * 
	 * @param householdUser User details to add
	 */
    public static AddHouseholdUserBuilder add(HouseholdUser householdUser)  {
		return new AddHouseholdUserBuilder(householdUser);
	}
	
	public static class DeleteHouseholdUserBuilder extends RequestBuilder {
		
		public DeleteHouseholdUserBuilder(String id) {
			super(Boolean.class, "householduser", "delete");
			params.add("id", id);
		}
		
		public void id(String multirequestToken) {
			params.add("id", multirequestToken);
		}
	}

	/**
	 * Removes a user from household
	 * 
	 * @param id The identifier of the user to delete
	 */
    public static DeleteHouseholdUserBuilder delete(String id)  {
		return new DeleteHouseholdUserBuilder(id);
	}
	
	public static class ListHouseholdUserBuilder extends ListResponseRequestBuilder {
		
		public ListHouseholdUserBuilder(HouseholdUserFilter filter) {
			super(HouseholdUser.class, "householduser", "list");
			params.add("filter", filter);
		}
	}

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

	/**
	 * Returns the users within the household
	 * 
	 * @param filter Household user filter
	 */
    public static ListHouseholdUserBuilder list(HouseholdUserFilter filter)  {
		return new ListHouseholdUserBuilder(filter);
	}
}