A B C D E G H I K L N O P R S T U V

A

addRole(IRoomRole) - Method in interface com.sap.ip.collaboration.room.api.IUserRoles

Assign the user to a new role.

addRoles(IRoomRole[]) - Method in interface com.sap.ip.collaboration.room.api.IUserRoles

Assign multiple roles to the user.

addRoomParameter(IRoomParameterValue) - Method in interface com.sap.ip.collaboration.room.api.IRoom

Set a parameter to the room.

addRoomParameter(IRoomParameterValue) - Method in interface com.sap.ip.collaboration.room.api.IRoomInfo

Add a room parameter

addRoomParameter(String, String, String, boolean) - Method in interface com.sap.ip.collaboration.room.api.IRoomInfo

Add a room parameter

addRoomParameters(IRoomParameterValue[]) - Method in interface com.sap.ip.collaboration.room.api.IRoomInfo

Add multiple room parameters

addUserRole(String, IRoomRole) - Method in interface com.sap.ip.collaboration.room.api.IRoomUsers

Assign a new role to a user.

addUserRoles(IRoomUsers) - Method in interface com.sap.ip.collaboration.room.api.IRoomUsers

addUserRoles(String, IRoomRole[]) - Method in interface com.sap.ip.collaboration.room.api.IRoomUsers

Assign multiple roles to a user.

addUserToRole(String, IRoomRole) - Method in interface com.sap.ip.collaboration.room.api.IRoomInfo

Assign an additional room role to a specific user

addUserToRoles(String, IRoomRole[]) - Method in interface com.sap.ip.collaboration.room.api.IRoomInfo

Assign multiple additional room roles to a specific user

B

BAD_USER_ID - Static variable in class com.sap.ip.collaboration.room.api.RoomCreationValidationErrors

C

CATEGORIES_MISSING - Static variable in class com.sap.ip.collaboration.room.api.RoomCreationValidationErrors

containsUser(String) - Method in interface com.sap.ip.collaboration.room.api.IRoomUsers

Check if a user is contained

createRoom(IRoomInfo, boolean) - Method in interface com.sap.ip.collaboration.room.api.IRooms

Create a new room To create a new room you first have to call getRoomCreationInfo(), fill the info object with properties and then call the createRoom(IRoomInfo) method.

createRoomPartInstance(String, String, IRoleMapping[], IRoomParameterValue[], IParameterMapping[]) - Method in interface com.sap.ip.collaboration.room.api.IRoom

Create a new room part instance from a room part template and attach it to the room

createRoomRole(String, String) - Method in interface com.sap.ip.collaboration.room.api.IRooms

Creates a new instance of IRoomRole

createRoomUsersObject() - Method in interface com.sap.ip.collaboration.room.api.IRooms

Get an empty instance of IRoomUsers.

D

deleteAllRoomParameters() - Method in interface com.sap.ip.collaboration.room.api.IRoomInfo

Delete all room parameters

deleteAllUsers() - Method in interface com.sap.ip.collaboration.room.api.IRoomUsers

Remove all users from all roles in this snapshot

deleteRoom(String) - Method in interface com.sap.ip.collaboration.room.api.IRooms

Delete the room with the given id

deleteUser(String) - Method in interface com.sap.ip.collaboration.room.api.IRoomUsers

Remove a specific user from all roles in this snapshot

deleteUserRoles(String) - Method in interface com.sap.ip.collaboration.room.api.IRoomUsers

Same as deleteUser(String): Remove a specific user from all roles in this snapshot

deregisterUserFromCommunity(String) - Method in interface com.sap.ip.collaboration.room.api.IRoom

Unsubscribe a user from a community.

DESC_MISSING - Static variable in class com.sap.ip.collaboration.room.api.RoomCreationValidationErrors

DTN_ITEM_POS_BOTTOM - Static variable in interface com.sap.ip.collaboration.room.api.IRoom

This value can be used as a parameter of method setPosition(String, int) to move a room part to the bottom of the DTN

DTN_ITEM_POS_TOP - Static variable in interface com.sap.ip.collaboration.room.api.IRoom

This value can be used as a parameter of method setPosition(String, int) to move a room part to the top of the DTN

E

existsRoom(String) - Method in interface com.sap.ip.collaboration.room.api.IRooms

Check if a room with certain room id exists

existsRoomTemplate(String) - Method in interface com.sap.ip.collaboration.room.api.IRooms

Check if a room template with a given template name exists

G

getAllInternalParameters() - Method in interface com.sap.ip.collaboration.room.api.IRoom

Get all internal room parameters.

getAllRoomParameterNames() - Method in interface com.sap.ip.collaboration.room.api.IRoom

Get the parameter names of a room

getAllRoomParameters() - Method in interface com.sap.ip.collaboration.room.api.IRoom

Get the parameters of a room

getAllRoomRoleNames() - Method in interface com.sap.ip.collaboration.room.api.IRoom

Get the names of all room roles in the room

getAllRoomRoles() - Method in interface com.sap.ip.collaboration.room.api.IRoom

Get all room roles of a room

getAllRoomsForUser(IUser) - Method in interface com.sap.ip.collaboration.room.api.IRooms

Get an Array containing ALL rooms a specific user is allowed to enter (all rooms in which the user is member of any room role).

getAllRoomUserIds() - Method in interface com.sap.ip.collaboration.room.api.IRoom

Get the ids of all users of this room.

getAllUsers() - Method in interface com.sap.ip.collaboration.room.api.IRoomUsers

Get the ids of all users

getAvailableRoomTemplateNames() - Method in interface com.sap.ip.collaboration.room.api.IRooms

Get a list of available room template names

getAvailableRoomTemplates() - Method in interface com.sap.ip.collaboration.room.api.IRooms

Get a list of available room templates

getCategories() - Method in interface com.sap.ip.collaboration.room.api.IRoom

Get the categories of a room

getCatsConfigPlugin() - Method in interface com.sap.ip.collaboration.room.api.IRoomProps

Get the name of the configuration plugin containing the room categories

getCreationDate() - Method in interface com.sap.ip.collaboration.room.api.IRoom

Get the creation date of a room

getDefaultRoomCategory() - Method in interface com.sap.ip.collaboration.room.api.IRoomCategoryFactory

Get the default room category

getDescription() - Method in interface com.sap.ip.collaboration.room.api.IRoom

Get the description of a room

getErrors() - Static method in class com.sap.ip.collaboration.room.api.RoomCreationValidationErrors

Get a list of all possible errors

getExtensionPoints() - Method in interface com.sap.ip.collaboration.room.api.IRooms

Get a list of all available room extension points

getExtUrlPort() - Method in interface com.sap.ip.collaboration.room.api.IRoomProps

Get the Server Port for external room links

getExtUrlProtocol() - Method in interface com.sap.ip.collaboration.room.api.IRoomProps

Get the protocol String for external room links (i.e.

getExtUrlServerName() - Method in interface com.sap.ip.collaboration.room.api.IRoomProps

Get the Server Name for external room links

getId() - Method in interface com.sap.ip.collaboration.room.api.IRoom

Get the id of a room

getInitialRoleName() - Method in interface com.sap.ip.collaboration.room.api.IRoom

Get the name of the Initial Role of the room.

getInitialRoomRole() - Method in interface com.sap.ip.collaboration.room.api.IRoom

Get an instance of the initial room role

getInternalParameter(String) - Method in interface com.sap.ip.collaboration.room.api.IRoom

Get a specific internal room parameter

getLastModified() - Method in interface com.sap.ip.collaboration.room.api.IRoom

Get the date of the last modification of a room

getLastVisit(String) - Method in interface com.sap.ip.collaboration.room.api.IRooms

Get the Date when the given room was last visited by any user

getLastVisit(String, String) - Method in interface com.sap.ip.collaboration.room.api.IRooms

Get the Date when the given user visited the given room last time

getLeastVisitedRooms(int, long) - Method in interface com.sap.ip.collaboration.room.api.IRooms

Returns a list of the least visited rooms since the time given by timeStamp, ordered ascendingly by the number of visits.

getMessage() - Method in class com.sap.ip.collaboration.room.api.Exceptions.NoSuchRoomCategoryException

getMostVisitedRooms(int, long) - Method in interface com.sap.ip.collaboration.room.api.IRooms

Returns a list of the most visited rooms since the time given by timeStamp, ordered descendingly by the number of visits.

getName() - Method in interface com.sap.ip.collaboration.room.api.IRoom

Get the name of a room

getName() - Method in interface com.sap.ip.collaboration.room.api.IRoomCategory

Get the name of a the category

getNameSpace() - Method in interface com.sap.ip.collaboration.room.api.IRoomProps

Get the namespace which is used by the room backend system to create RF resources and resource properties

getOwnerId() - Method in interface com.sap.ip.collaboration.room.api.IRoom

Get the owner of a room

getPosition(String) - Method in interface com.sap.ip.collaboration.room.api.IRoom

Get the actual position of a Room Part in the DTN.

getPrivacyType() - Method in interface com.sap.ip.collaboration.room.api.IRoom

Get the privacy type of a room.
Possible privacy types are currently: public (Community, free access), listed (Listed room, invitation upon request), unlisted (Not listed room, access only with invitation)

getPropCategories() - Method in interface com.sap.ip.collaboration.room.api.IRoomProps

Get the name of the room resource property containing the room categories

getPropCreationDate() - Method in interface com.sap.ip.collaboration.room.api.IRoomProps

Get the name of the room resource property containing the room creation date

getPropDesc() - Method in interface com.sap.ip.collaboration.room.api.IRoomProps

Get the name of the room resource property containing the room description

getProperty(String, String) - Method in interface com.sap.ip.collaboration.room.api.IRoom

Get the value of a custom property of the room.

getPropHasPublicRole() - Method in interface com.sap.ip.collaboration.room.api.IRoomProps

Get the name of the room resource property containing the boolean value whether the room has a public room role or not.

getPropHidden() - Method in interface com.sap.ip.collaboration.room.api.IRoomProps

Get the name of the room resource property containing the hidden status of the room

getPropId() - Method in interface com.sap.ip.collaboration.room.api.IRoomProps

Get the name of the room resource property containing the room id

getPropInitialRole() - Method in interface com.sap.ip.collaboration.room.api.IRoomProps

Get the name of the room resource property containing the name of the room role which is used as initial role for new users in the room.

getPropLock() - Method in interface com.sap.ip.collaboration.room.api.IRoomProps

Get the name of the room resource property containing the lock status of the room

getPropName() - Method in interface com.sap.ip.collaboration.room.api.IRoomProps

Get the name of the room resource property containing the room name

getPropOwner() - Method in interface com.sap.ip.collaboration.room.api.IRoomProps

Get the name of the room resource property containing the room owner

getPropOwnerFullAccess() - Method in interface com.sap.ip.collaboration.room.api.IRoomProps

getPropParamDesc() - Method in interface com.sap.ip.collaboration.room.api.IRoomProps

Get the prefix of the name of the room resource properties containing the room parameter descriptions.

getPropParamHidden() - Method in interface com.sap.ip.collaboration.room.api.IRoomProps

getPropParams() - Method in interface com.sap.ip.collaboration.room.api.IRoomProps

Get the name of the room resource property containing the names of the room parameters

getPropParamVal() - Method in interface com.sap.ip.collaboration.room.api.IRoomProps

Get the prefix of the name of the room resource properties containing the room parameter values.

getPropPrivacy() - Method in interface com.sap.ip.collaboration.room.api.IRoomProps

Get the name of the room resource property containing the room privacy

getPropRoleName() - Method in interface com.sap.ip.collaboration.room.api.IRoomProps

Get the name of the room role group property containing the name of the room role

getPropStoreIds() - Method in interface com.sap.ip.collaboration.room.api.IRoomProps

Get the name of the room resource property containing the room store ids

getPropStructureId() - Method in interface com.sap.ip.collaboration.room.api.IRoomProps

Get the name of the room resource property containing the room structure RID

getPropTemplateDesc() - Method in interface com.sap.ip.collaboration.room.api.IRoomProps

Get the name of the room resource property containing the room template description

getPropTemplateName() - Method in interface com.sap.ip.collaboration.room.api.IRoomProps

Get the name of the room resource property containing the room template name

getPropTemplateVersion() - Method in interface com.sap.ip.collaboration.room.api.IRoomProps

getPropVersion() - Method in interface com.sap.ip.collaboration.room.api.IRoomProps

Get the name of the room resource property containing the room version

getRelationManager() - Method in interface com.sap.ip.collaboration.room.api.IRooms

Get an instance of the room relation manager

getResContextAllowedRoomsList() - Method in interface com.sap.ip.collaboration.room.api.IRoomProps

Get the name of the resource context parameter holding the list of rooms the user is allowed to enter

getResContextAllRoomsAllowed() - Method in interface com.sap.ip.collaboration.room.api.IRoomProps

Get the name of the resource context parameter holding the flag whether a user is allowed to enter ALL rooms in the list

getResourceTypeRoom() - Method in interface com.sap.ip.collaboration.room.api.IRoomProps

Get the resource type of the room resources

getResourceTypeTemplate() - Method in interface com.sap.ip.collaboration.room.api.IRoomProps

Get the resource type of the content template resources

getRoles() - Method in interface com.sap.ip.collaboration.room.api.IUserRoles

Get all roles the user is assigned to

getRoom(String) - Method in interface com.sap.ip.collaboration.room.api.IRooms

Get a room instance from a room ID

getRoomAccessURLExternal() - Method in interface com.sap.ip.collaboration.room.api.IRoom

Get an external Access URL for a specific room.

getRoomAccessURLExternal(String) - Method in interface com.sap.ip.collaboration.room.api.IRooms

Get an external Access URL for a specific room.

getRoomAccessURLInternal() - Method in interface com.sap.ip.collaboration.room.api.IRoom

Get the internal representation of an access URL of a room.

getRoomAccessURLInternal(String) - Method in interface com.sap.ip.collaboration.room.api.IRooms

Get an internal Access URL for a specific room.

getRoomCategories() - Method in interface com.sap.ip.collaboration.room.api.IRoomCategoryFactory

Get all existing room categories in the system

getRoomCategory(String) - Method in interface com.sap.ip.collaboration.room.api.IRoomCategoryFactory

Get a specific room category

getRoomCategoryFactory() - Method in interface com.sap.ip.collaboration.room.api.IRooms

Get an instance of the IRoomCategoryFactory.

getRoomCreationInfo() - Method in interface com.sap.ip.collaboration.room.api.IRooms

Get a new instance of IRoomInfo.

getRoomDescription(String) - Method in interface com.sap.ip.collaboration.room.api.IRooms

Get the description of the room with the given room id

getRoomEvents(long, RoomStatusAction[], String[], int) - Method in interface com.sap.ip.collaboration.room.api.IRoom

Retrieve room events for this room according to the specified search criteria.

getRoomEvents(String, long, RoomStatusAction[], String[], int) - Method in interface com.sap.ip.collaboration.room.api.IRooms

Retrieve room events according to the specified search criteria.

getRoomFromRID(String) - Method in interface com.sap.ip.collaboration.room.api.IRooms

Get a room instance from a room RID

getRoomGroups() - Method in interface com.sap.ip.collaboration.room.api.IRoom

Get an instance of IRoomGroups which contains the IDs of all User Management Groups and PrincipalSets related to this room.

getRoomInfo() - Method in interface com.sap.ip.collaboration.room.api.IRoom

Get some information describing a room encapsulated in an independent object.

getRoomName(String) - Method in interface com.sap.ip.collaboration.room.api.IRooms

Get the name of the room with the given room id

getRoomParameter(String) - Method in interface com.sap.ip.collaboration.room.api.IRoom

Get the parameter value of a specific parameter for this room

getRoomParts() - Method in interface com.sap.ip.collaboration.room.api.IRoom

Get all Room Parts contained in this room

getRoomRepositoryPrefix() - Method in interface com.sap.ip.collaboration.room.api.IRoomProps

Get the repository prefix of the repository containing the room resources

getRoomRole(String) - Method in interface com.sap.ip.collaboration.room.api.IRoom

Get a room role instance for a given role name if such a room role exists in the current room

getRoomRolesForUser(String) - Method in interface com.sap.ip.collaboration.room.api.IRoom

Get the room roles for a specific user in this room

getRoomRolesForUser(String, IUser) - Method in interface com.sap.ip.collaboration.room.api.IRooms

Get the room roles for a specific user in a specific room

getRoomRoleUserIds(String) - Method in interface com.sap.ip.collaboration.room.api.IRoom

Get the ids of all users who are member of a specific room role in this room

getRoomsForUser(IUser, boolean) - Method in interface com.sap.ip.collaboration.room.api.IRooms

Get only hidden or unhidden rooms a specific user is allowed to enter.

getRoomStructureRid() - Method in interface com.sap.ip.collaboration.room.api.IRoom

Get the RID of the room structure folder in CM.

getRoomsWithPrivacy(RoomPrivacyType) - Method in interface com.sap.ip.collaboration.room.api.IRooms

Get an Array containing all rooms with a specific privacy (Community, Listed Room, Unlisted Room).

getRoomTemplate(String) - Method in interface com.sap.ip.collaboration.room.api.IRooms

Get a room template instance

getRoomUsage(long, int) - Method in interface com.sap.ip.collaboration.room.api.IRoom

Returns data on the usage of this per user, ordered by the number of visits (most visiting users first).

getRoomUsage(String, long, int) - Method in interface com.sap.ip.collaboration.room.api.IRooms

Returns data on room usage per user, ordered by the number of visits (most visiting users first).

getRoomUsers() - Method in interface com.sap.ip.collaboration.room.api.IRoom

Get all users who are member of any room role in this room.

getServiceUser() - Method in interface com.sap.ip.collaboration.room.api.IRoomProps

Get the name service user used by the room backend system to create/access room resources

getShortText() - Method in class com.sap.ip.collaboration.room.api.RoomCreationValidationErrors

Get the shorttext of the error

getStructureLinkName() - Method in interface com.sap.ip.collaboration.room.api.IRoomProps

Get the name of the room structure links

getStructureRepositoryPrefix() - Method in interface com.sap.ip.collaboration.room.api.IRoomProps

Get the repository prefix of the repository containing the room structure resources

getTemplate() - Method in interface com.sap.ip.collaboration.room.api.IRoom

Get the room template this room is based on

getTemplateDescription() - Method in interface com.sap.ip.collaboration.room.api.IRoom

Get the template description of a room

getTemplateName() - Method in interface com.sap.ip.collaboration.room.api.IRoom

Get the template name of a room.

getUMPrincipleTypeRoomRole() - Method in interface com.sap.ip.collaboration.room.api.IRoomProps

Get the type of the IPrincipleSets for RoomRoles

getUserId() - Method in interface com.sap.ip.collaboration.room.api.IUserRoles

Get the id of the user

getUserRoles(String) - Method in interface com.sap.ip.collaboration.room.api.IRoomUsers

Get all roles a specific user is assigned to

getUserRolesObject(String) - Method in interface com.sap.ip.collaboration.room.api.IRoomUsers

Get a specific user and all assigned roles to the user

getValidationErrors() - Method in interface com.sap.ip.collaboration.room.api.IRoomInfo

Get a list of errors ocurring in the consistency validation check.

getVersion() - Method in interface com.sap.ip.collaboration.room.api.IRoom

Get the technical version number of a room object.

H

hasPublicAccess() - Method in interface com.sap.ip.collaboration.room.api.IRoom

Check if there is a public room role in the room which is mapped to at least one page.

hasRole(IRoomRole) - Method in interface com.sap.ip.collaboration.room.api.IUserRoles

Check if the user is assigned to a specific role

hasRoomRole(String) - Method in interface com.sap.ip.collaboration.room.api.IRoom

Check if a room role with a given role name exists in the room

hasUserRole(String, IRoomRole) - Method in interface com.sap.ip.collaboration.room.api.IRoomUsers

Check if a user is assigned to a specific role

I

INVALID_INITIAL_ROLE - Static variable in class com.sap.ip.collaboration.room.api.RoomCreationValidationErrors

INVALID_USER_ROLE - Static variable in class com.sap.ip.collaboration.room.api.RoomCreationValidationErrors

IRoom - interface com.sap.ip.collaboration.room.api.IRoom.

Public Interface describing a single collaboration room object The Room API contains functionality concerning one single room object whereas the Rooms API provides methods concerning all rooms (searching, creation, instantiation...).

IRoomCategory - interface com.sap.ip.collaboration.room.api.IRoomCategory.

Interface describing a room category.

IRoomCategoryFactory - interface com.sap.ip.collaboration.room.api.IRoomCategoryFactory.

Interface describing the factory for room categories.

IRoomInfo - interface com.sap.ip.collaboration.room.api.IRoomInfo.

Interface describing a snapshot of a collaboration room There are two Interfaces describing a collaboration room: IRoom and this one (IRoomInfo).

IRoomProps - interface com.sap.ip.collaboration.room.api.IRoomProps.

Interface providing technical properties of the room backend system.

IRooms - interface com.sap.ip.collaboration.room.api.IRooms.

Public Interface of the Rooms API The Rooms API provides methods concerning all rooms (searching, creation, instantiation...) whereas the Room API contains functionality concerning one single room object.

IRoomUsers - interface com.sap.ip.collaboration.room.api.IRoomUsers.

Interface describing a snapshot of the current user-role assignments in a room.

isCommunity() - Method in interface com.sap.ip.collaboration.room.api.IRoom

Check if the room is a community

isEmpty() - Method in interface com.sap.ip.collaboration.room.api.IUserRoles

Check if the user is assigned to no roles at all

isHidden() - Method in interface com.sap.ip.collaboration.room.api.IRoom

Check if the room is hidden

isListedRoom() - Method in interface com.sap.ip.collaboration.room.api.IRoom

Check if the room is a listed room

isLocked() - Method in interface com.sap.ip.collaboration.room.api.IRoom

Check if the room is locked

isMember(String) - Method in interface com.sap.ip.collaboration.room.api.IRoom

Tests whether a specific user has access to this room

isPrivacyTypeChangeAllowed() - Method in interface com.sap.ip.collaboration.room.api.IRoom

The room template may define the room privacy type as 'strict' which means that no changes are allowed.

isRoomLocked(String) - Method in interface com.sap.ip.collaboration.room.api.IRooms

Check if a room is locked

isUnlistedRoom() - Method in interface com.sap.ip.collaboration.room.api.IRoom

Check if the room is a unlisted room

IUserRoles - interface com.sap.ip.collaboration.room.api.IUserRoles.

Interface describing the role assignments of a single user.

K

KM_SERVICE_ID - Static variable in interface com.sap.ip.collaboration.room.api.IRooms

The name of the KM Service - for use in other applications

L

lock() - Method in interface com.sap.ip.collaboration.room.api.IRoom

Lock the current collaboration room

N

NAME_MISSING - Static variable in class com.sap.ip.collaboration.room.api.RoomCreationValidationErrors

static final members: instances of RoomCreationValidationErrors representing the different errors.

NO_SUCH_PRIVACY - Static variable in class com.sap.ip.collaboration.room.api.RoomCreationValidationErrors

NO_SUCH_TEMPLATE - Static variable in class com.sap.ip.collaboration.room.api.RoomCreationValidationErrors

NoSuchRoomCategoryException - exception com.sap.ip.collaboration.room.api.Exceptions.NoSuchRoomCategoryException.

NoSuchRoomCategoryException(String) - Constructor for class com.sap.ip.collaboration.room.api.Exceptions.NoSuchRoomCategoryException

O

OWNER_MISSING - Static variable in class com.sap.ip.collaboration.room.api.RoomCreationValidationErrors

OWNER_ROLE_MISSING - Static variable in class com.sap.ip.collaboration.room.api.RoomCreationValidationErrors

P

PORTAL_SERVICE_ID - Static variable in interface com.sap.ip.collaboration.room.api.IRooms

The name of the Portal Service - for use in other applications

printStackTrace() - Method in class com.sap.ip.collaboration.room.api.Exceptions.NoSuchRoomCategoryException

PRIVACY_MISSING - Static variable in class com.sap.ip.collaboration.room.api.RoomCreationValidationErrors

R

registerUserInCommunity(String) - Method in interface com.sap.ip.collaboration.room.api.IRoom

Subscribe a user to a community.

removeAllRoles() - Method in interface com.sap.ip.collaboration.room.api.IUserRoles

Remove all roles from the user

removeAllUsers() - Method in interface com.sap.ip.collaboration.room.api.IRoomInfo

Remove all user from the collaboration room

removeRole(IRoomRole) - Method in interface com.sap.ip.collaboration.room.api.IUserRoles

Remove a specific role from the user

removeRoomPartInstance(String) - Method in interface com.sap.ip.collaboration.room.api.IRoom

Remove a room part instance from the room

removeUser(String) - Method in interface com.sap.ip.collaboration.room.api.IRoomInfo

Remove a user from the collaboration room

removeUserFromAllRoles(String) - Method in interface com.sap.ip.collaboration.room.api.IRoomInfo

Remove a user from all room roles.
This call has the same effect than removing the user from the whole room using the method removeUser(String userId).

removeUserFromRole(String, IRoomRole) - Method in interface com.sap.ip.collaboration.room.api.IRoomInfo

Remove a user from a specific room role

removeUserRole(String, IRoomRole) - Method in interface com.sap.ip.collaboration.room.api.IRoomUsers

Remove a specific role from a user

requestMembership(String) - Method in interface com.sap.ip.collaboration.room.api.IRoom

Request membership for a specific user in a room.

RoomCreationException - class com.sap.ip.collaboration.room.api.Exceptions.RoomCreationException.

Class implementing an exception that occured during room creation.

RoomCreationException(boolean) - Constructor for class com.sap.ip.collaboration.room.api.Exceptions.RoomCreationException

Deprecated.

RoomCreationException(String, boolean) - Constructor for class com.sap.ip.collaboration.room.api.Exceptions.RoomCreationException

constructs a new BaseException.

RoomCreationException(Throwable, boolean) - Constructor for class com.sap.ip.collaboration.room.api.Exceptions.RoomCreationException

Deprecated.

RoomCreationException(Throwable, String, boolean) - Constructor for class com.sap.ip.collaboration.room.api.Exceptions.RoomCreationException

constructs a new BaseException.

RoomCreationValidationErrors - class com.sap.ip.collaboration.room.api.RoomCreationValidationErrors.

Public Class describing the possible error situations at room creation time.

RoomInstantiationException - class com.sap.ip.collaboration.room.api.Exceptions.RoomInstantiationException.

Class implementing an exception that occured during room instantiation.

RoomInstantiationException(boolean) - Constructor for class com.sap.ip.collaboration.room.api.Exceptions.RoomInstantiationException

constructs a new BaseException.

RoomInstantiationException(String, boolean) - Constructor for class com.sap.ip.collaboration.room.api.Exceptions.RoomInstantiationException

constructs a new BaseException.

RoomInstantiationException(Throwable, boolean) - Constructor for class com.sap.ip.collaboration.room.api.Exceptions.RoomInstantiationException

constructs a new BaseException with a causing throwable for exception chaining.

RoomInstantiationException(Throwable, String, boolean) - Constructor for class com.sap.ip.collaboration.room.api.Exceptions.RoomInstantiationException

constructs a new BaseException.

S

setCategories(IRoomCategory[]) - Method in interface com.sap.ip.collaboration.room.api.IRoom

Set the categories of the room.

setCategories(IRoomCategory[]) - Method in interface com.sap.ip.collaboration.room.api.IRoomInfo

Set the categories of the collaboration room You can create new instances of IRoomCategory using the IRoomCategoryFactory which you will get using the method IRooms.getRoomCategoryFactory().

setDescription(String) - Method in interface com.sap.ip.collaboration.room.api.IRoom

Set the description of the room

setDescription(String) - Method in interface com.sap.ip.collaboration.room.api.IRoomInfo

Set the description of the room

setHidden(boolean) - Method in interface com.sap.ip.collaboration.room.api.IRoom

Set the room hide status

setName(String) - Method in interface com.sap.ip.collaboration.room.api.IRoom

Set the name of the room

setName(String) - Method in interface com.sap.ip.collaboration.room.api.IRoomInfo

Set the name of the room

setOwnerId(String) - Method in interface com.sap.ip.collaboration.room.api.IRoom

Set the owner of the room

setOwnerId(String) - Method in interface com.sap.ip.collaboration.room.api.IRoomInfo

Set the owner of the room

setOwnerId(String, boolean) - Method in interface com.sap.ip.collaboration.room.api.IRoom

Deprecated. use setOwnerId(String newOwnerId)

setPosition(String, int) - Method in interface com.sap.ip.collaboration.room.api.IRoom

Set the position of a Room Part in the DTN.

setPrivacy(RoomPrivacyType) - Method in interface com.sap.ip.collaboration.room.api.IRoomInfo

Set the privacy type of the room

setPrivacyType(RoomPrivacyType) - Method in interface com.sap.ip.collaboration.room.api.IRoom

Set the privacy type of the room if changing the privacy type is allowed.

setProperty(String, String, String) - Method in interface com.sap.ip.collaboration.room.api.IRoom

Set a custom property on the room.

setRoomParameters(IRoomParameterValue[]) - Method in interface com.sap.ip.collaboration.room.api.IRoom

Change the values for one or more room parameters.

setRoomUsers(IRoomUsers, boolean) - Method in interface com.sap.ip.collaboration.room.api.IRoom

Assign users to the room.

setTemplateName(String) - Method in interface com.sap.ip.collaboration.room.api.IRoomInfo

Set the template name of the room

STRICT_PRIVACY_VIOLATION - Static variable in class com.sap.ip.collaboration.room.api.RoomCreationValidationErrors

supportsParameterChanges() - Method in interface com.sap.ip.collaboration.room.api.IRoom

Check - depending on the room version - if changing the room parameters is supported or not

supportsRootGroup() - Method in interface com.sap.ip.collaboration.room.api.IRoom

Check - depending on the room version - if a root group containing all room role groups is supported

T

TEMPLATENAME_MISSING - Static variable in class com.sap.ip.collaboration.room.api.RoomCreationValidationErrors

toString() - Method in class com.sap.ip.collaboration.room.api.RoomCreationValidationErrors

toString method -> getShortText()

U

unlock() - Method in interface com.sap.ip.collaboration.room.api.IRoom

Unlock the current room

V

validate() - Method in interface com.sap.ip.collaboration.room.api.IRoomInfo

Validate all entered data.

A B C D E G H I K L N O P R S T U V