com.sap.ip.collaboration.room.api

Interface IRoomPrincipals

All Superinterfaces:

IRoomPrincipalSets, IRoomUsers

public interface IRoomPrincipals
extends IRoomUsers, IRoomPrincipalSets

Interface describing a snapshot of the current user-role and group-role assignments in a room. It inherits methods from the interfaces IRoomUsers and IRoomPrincipalSets which should not be used directly but only via this interface.

To create a new instance of IRoomPrincipals you may call IRooms.createRoomPrincipalsObject()

To obtain a snapshot of all user-role and group-role assignments in an existing room call IRoom.getRoomPrincipals()

You can modify such an instance of IRoomPrincipals using this API and then put it back into any existing room by calling IRoom.setRoomPrincipals(IRoomPrincipals, boolean). This will apply any changes you did on the IRoomPrincipals object (add new users, change user roles or remove users) to the room.
Note: Adding new users to a room may result in an invitation email to the new users. Removed users may also get a notification email.

Important: All calls to changing methods in this interface will change only the snapshot in memory. No existing room is affected until IRoom.setRoomPrincipals(IRoomPrincipals, boolean) is called.

Method Summary

Methods inherited from interface com.sap.ip.collaboration.room.api.IRoomUsers

addGroupUsersToRole, addGroupUsersToRoles, addUserRole, addUserRoles, addUserRoles, containsUser, deleteAllUsers, deleteUser, deleteUserRoles, getAllUsers, getUserRoles, getUserRolesObject, hasUserRole, removeUserRole

Methods inherited from interface com.sap.ip.collaboration.room.api.IRoomPrincipalSets

addPrincipalSetRole, addPrincipalSetRoles, addPrincipalSetRoles, containsPrincipalSet, containsUser, deleteAllPrincipalSets, deletePrincipalSet, getAllPrincipalSets, getPrincipalSetRoles, getPrincipalSetRolesObject, hasPrincipalSetRole, removePrincipalSetRole