com.kaltura.client.services.GroupUserService 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.BulkUpload;
import com.kaltura.client.types.FilterPager;
import com.kaltura.client.types.GroupUser;
import com.kaltura.client.types.GroupUserFilter;
import com.kaltura.client.utils.request.ListResponseRequestBuilder;
import com.kaltura.client.utils.request.NullRequestBuilder;
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.
 */

/**
 * Add & Manage GroupUser
 * 
 * @param groupUser 
 * @param userId 
 * @param groupId 
 * @param filter 
 * @param pager 
 * @param userId 
 * @param groupIds 
 * @param removeFromExistingGroups 
 * @param createNewGroups 
 * @param groupUserId 
 * @param groupUser Id
 */
public class GroupUserService {
	
	public static class AddGroupUserBuilder extends RequestBuilder {
		
		public AddGroupUserBuilder(GroupUser groupUser) {
			super(GroupUser.class, "groupuser", "add");
			params.add("groupUser", groupUser);
		}
	}

	/**
	 * Add new GroupUser
	 * 
	 * @param groupUser 
	 */
    public static AddGroupUserBuilder add(GroupUser groupUser)  {
		return new AddGroupUserBuilder(groupUser);
	}
	
	public static class DeleteGroupUserBuilder extends NullRequestBuilder {
		
		public DeleteGroupUserBuilder(String userId, String groupId) {
			super("groupuser", "delete");
			params.add("userId", userId);
			params.add("groupId", groupId);
		}
		
		public void userId(String multirequestToken) {
			params.add("userId", multirequestToken);
		}
		
		public void groupId(String multirequestToken) {
			params.add("groupId", multirequestToken);
		}
	}

	/**
	 * delete by userId and groupId
	 * 
	 * @param userId 
	 * @param groupId 
	 */
    public static DeleteGroupUserBuilder delete(String userId, String groupId)  {
		return new DeleteGroupUserBuilder(userId, groupId);
	}
	
	public static class ListGroupUserBuilder extends ListResponseRequestBuilder {
		
		public ListGroupUserBuilder(GroupUserFilter filter, FilterPager pager) {
			super(GroupUser.class, "groupuser", "list");
			params.add("filter", filter);
			params.add("pager", pager);
		}
	}

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

	public static ListGroupUserBuilder list(GroupUserFilter filter)  {
		return list(filter, null);
	}

	/**
	 * List all GroupUsers
	 * 
	 * @param filter 
	 * @param pager 
	 */
    public static ListGroupUserBuilder list(GroupUserFilter filter, FilterPager pager)  {
		return new ListGroupUserBuilder(filter, pager);
	}
	
	public static class SyncGroupUserBuilder extends RequestBuilder {
		
		public SyncGroupUserBuilder(String userId, String groupIds, boolean removeFromExistingGroups, boolean createNewGroups) {
			super(BulkUpload.class, "groupuser", "sync");
			params.add("userId", userId);
			params.add("groupIds", groupIds);
			params.add("removeFromExistingGroups", removeFromExistingGroups);
			params.add("createNewGroups", createNewGroups);
		}
		
		public void userId(String multirequestToken) {
			params.add("userId", multirequestToken);
		}
		
		public void groupIds(String multirequestToken) {
			params.add("groupIds", multirequestToken);
		}
		
		public void removeFromExistingGroups(String multirequestToken) {
			params.add("removeFromExistingGroups", multirequestToken);
		}
		
		public void createNewGroups(String multirequestToken) {
			params.add("createNewGroups", multirequestToken);
		}
	}

	public static SyncGroupUserBuilder sync(String userId, String groupIds)  {
		return sync(userId, groupIds, true);
	}

	public static SyncGroupUserBuilder sync(String userId, String groupIds, boolean removeFromExistingGroups)  {
		return sync(userId, groupIds, removeFromExistingGroups, true);
	}

	/**
	 * sync by userId and groupIds
	 * 
	 * @param userId 
	 * @param groupIds 
	 * @param removeFromExistingGroups 
	 * @param createNewGroups 
	 */
    public static SyncGroupUserBuilder sync(String userId, String groupIds, boolean removeFromExistingGroups, boolean createNewGroups)  {
		return new SyncGroupUserBuilder(userId, groupIds, removeFromExistingGroups, createNewGroups);
	}
	
	public static class UpdateGroupUserBuilder extends RequestBuilder {
		
		public UpdateGroupUserBuilder(String groupUserId, GroupUser groupUser) {
			super(GroupUser.class, "groupuser", "update");
			params.add("groupUserId", groupUserId);
			params.add("groupUser", groupUser);
		}
		
		public void groupUserId(String multirequestToken) {
			params.add("groupUserId", multirequestToken);
		}
	}

	/**
	 * update GroupUser
	 * 
	 * @param groupUserId 
	 * @param groupUser Id
	 */
    public static UpdateGroupUserBuilder update(String groupUserId, GroupUser groupUser)  {
		return new UpdateGroupUserBuilder(groupUserId, groupUser);
	}
}