Package com.kaltura.client.services

Class GroupService

java.lang.Object

com.kaltura.client.services.GroupService

public class GroupService
extends Object

This class was generated using generate.php against an XML schema provided by Kaltura. MANUAL CHANGES TO THIS CLASS WILL BE OVERWRITTEN.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GroupService.AddGroupBuilder
static class	GroupService.CloneGroupBuilder
static class	GroupService.DeleteGroupBuilder
static class	GroupService.GetGroupBuilder
static class	GroupService.ListGroupBuilder
static class	GroupService.UpdateGroupBuilder

Constructor Summary

Constructors

Constructor	Description
GroupService()

Method Summary

Modifier and Type	Method	Description
static GroupService.AddGroupBuilder	add(Group group)	Adds a new group (user of type group).
static GroupService.CloneGroupBuilder	clone(String originalGroupId, String newGroupId)
static GroupService.CloneGroupBuilder	clone(String originalGroupId, String newGroupId, String newGroupName)	clone the group (groupId), and set group id with the neeGroupName.
static GroupService.DeleteGroupBuilder	delete(String groupId)	Delete group by ID
static GroupService.GetGroupBuilder	get(String groupId)	Retrieves a group object for a specified group ID.
static GroupService.ListGroupBuilder	list()
static GroupService.ListGroupBuilder	list(GroupFilter filter)
static GroupService.ListGroupBuilder	list(GroupFilter filter, FilterPager pager)	Lists group objects that are associated with an account.
static GroupService.UpdateGroupBuilder	update(String groupId, Group group)	Update group by ID

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GroupService

public GroupService()

Method Detail

add

public static GroupService.AddGroupBuilder add(Group group)

Adds a new group (user of type group).

Parameters:

group - a new group

clone

public static GroupService.CloneGroupBuilder clone(String originalGroupId,
                                                   String newGroupId)

clone

public static GroupService.CloneGroupBuilder clone(String originalGroupId,
                                                   String newGroupId,
                                                   String newGroupName)

clone the group (groupId), and set group id with the neeGroupName.

Parameters:

originalGroupId - The unique identifier in the partner's system

newGroupId - The unique identifier in the partner's system

newGroupName - The name of the new cloned group

delete

public static GroupService.DeleteGroupBuilder delete(String groupId)

Delete group by ID

Parameters:

groupId - The unique identifier in the partner's system

get

public static GroupService.GetGroupBuilder get(String groupId)

Retrieves a group object for a specified group ID.

Parameters:

groupId - The unique identifier in the partner's system

list

public static GroupService.ListGroupBuilder list()

list

public static GroupService.ListGroupBuilder list(GroupFilter filter)

list

public static GroupService.ListGroupBuilder list(GroupFilter filter,
                                                 FilterPager pager)

Lists group objects that are associated with an account. Blocked users are listed unless you use a filter to exclude them. Deleted users are not listed unless you use a filter to include them.

Parameters:

filter -

pager - A limit for the number of records to display on a page

update

public static GroupService.UpdateGroupBuilder update(String groupId,
                                                     Group group)

Update group by ID

Parameters:

groupId - The unique identifier in the partner's system

group - Id The unique identifier in the partner's system