ChangeRoomCapacityRequest Class Reference
| Inherits from | BaseRequest : NSObject |
| Declared in | ChangeRoomCapacityRequest.h ChangeRoomCapacityRequest.m |
Overview
Changes the capacity of a Room (maxUsers and maxSpectators) at runtime.
This request might fail if the Room was configured not be re-sizable or if the User sending the request is not the owner of the Room. Moderators and Administrator can override this last constraint.
It is possible to “shrink” the Room capacity so that maxUsers < userCount. In this case nothing will happen to the “extra” users. As soon as clients will leave the Room the userCount will get down to the new maxUsers value.
Class Methods
requestWithRoom:newMaxUsers:newMaxSpect:
the Room to resize
+ (id)requestWithRoom:(id<Room>)room newMaxUsers:(NSInteger)newMaxUsers newMaxSpect:(NSInteger)newMaxSpectParameters
- room
the Room to resize
- newMaxUsers
the new maxUsers value (use -1 if don’t want to change the current value)
- newMaxSpect
the new maxSpect value (use -1 if don’t want to change the current value)
See Also
Declared In
ChangeRoomCapacityRequest.h