Package com.kaltura.client.services

Class UserRoleService

java.lang.Object

com.kaltura.client.services.UserRoleService

public class UserRoleService
extends Object

UserRole service lets you create and manage user roles

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	UserRoleService.AddUserRoleBuilder
static class	UserRoleService.CloneUserRoleBuilder
static class	UserRoleService.DeleteUserRoleBuilder
static class	UserRoleService.GetUserRoleBuilder
static class	UserRoleService.ListUserRoleBuilder
static class	UserRoleService.UpdateUserRoleBuilder

Constructor Summary

Constructors

Constructor	Description
UserRoleService()

Method Summary

Modifier and Type	Method	Description
static UserRoleService.AddUserRoleBuilder	add(UserRole userRole)	Adds a new user role object to the account.
static UserRoleService.CloneUserRoleBuilder	clone(int userRoleId)	Creates a new user role object that is a duplicate of an existing role.
static UserRoleService.DeleteUserRoleBuilder	delete(int userRoleId)	Deletes an existing user role object.
static UserRoleService.GetUserRoleBuilder	get(int userRoleId)	Retrieves a user role object using its ID.
static UserRoleService.ListUserRoleBuilder	list()
static UserRoleService.ListUserRoleBuilder	list(UserRoleFilter filter)
static UserRoleService.ListUserRoleBuilder	list(UserRoleFilter filter, FilterPager pager)	Lists user role objects that are associated with an account.
static UserRoleService.UpdateUserRoleBuilder	update(int userRoleId, UserRole userRole)	Updates an existing user role object.

Methods inherited from class java.lang.Object

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

Constructor Detail

UserRoleService

public UserRoleService()

Method Detail

add

public static UserRoleService.AddUserRoleBuilder add(UserRole userRole)

Adds a new user role object to the account.

Parameters:

userRole - A new role

clone

public static UserRoleService.CloneUserRoleBuilder clone(int userRoleId)

Creates a new user role object that is a duplicate of an existing role.

Parameters:

userRoleId - The user role's unique identifier

delete

public static UserRoleService.DeleteUserRoleBuilder delete(int userRoleId)

Deletes an existing user role object.

Parameters:

userRoleId - The user role's unique identifier

get

public static UserRoleService.GetUserRoleBuilder get(int userRoleId)

Retrieves a user role object using its ID.

Parameters:

userRoleId - The user role's unique identifier

list

public static UserRoleService.ListUserRoleBuilder list()

list

public static UserRoleService.ListUserRoleBuilder list(UserRoleFilter filter)

list

public static UserRoleService.ListUserRoleBuilder list(UserRoleFilter filter,
                                                       FilterPager pager)

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

Parameters:

filter - A filter used to exclude specific types of user roles

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

update

public static UserRoleService.UpdateUserRoleBuilder update(int userRoleId,
                                                           UserRole userRole)

Updates an existing user role object.

Parameters:

userRoleId - The user role's unique identifier

userRole - Id The user role's unique identifier