SFS2X Objective-C API  1.7.13
iOS / macOS / tvOS
ChangeRoomNameRequest Class Reference

#import <ChangeRoomNameRequest.h>

Inherits BaseRequest.

Class Methods

(id) + requestWithRoom:newName:
 

Protected Attributes

id< Room > _room
 
NSString * _newName
 

Detailed Description

Changes the name of a Room at runtime.

This request will fail if the User sending the request is not the creator of the Room.

Moderators and Administrator can override this last constraint.

If the Room was configured so that renaming is not allowed (see the RoomSettings.permissions parameter), the request is ignored and no error is fired.

Method Documentation

◆ requestWithRoom:newName:

+ (id) requestWithRoom: (id<Room>)  room
newName: (NSString *)  newName 
Parameters
roomthe Room to rename
newNamethe new Room name (no duplicates are allowed)
See also
[ISFSEvents onRoomNameChange:]
[ISFSEvents onRoomNameChangeError:]
ChangeRoomCapacityRequest
ChangeRoomPasswordStateRequest