ChangeRoomPasswordStateRequest Class Reference

#import <ChangeRoomPasswordStateRequest.h>

Inherits BaseRequest.

Instance Methods
(id)	- initWithRoom:newPass:

Class Methods
(id)	+ requestWithRoom:newPass:

Protected Attributes
id< Room >	_room
NSString *	_newPass

Detailed Description

Changes the password of a Room at runtime.

The request not only changes the password of a Room but also its "password state", which indicates if a Room is password protected or not. This request will fail if the User sending the request is not the owner of the Room.

Moderators and Administrator can override this constraint.

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

Method Documentation

requestWithRoom:newPass:

+ (id) requestWithRoom:		(id<Room>)	room
newPass:		(NSString *)	newPass

Parameters

room	the Room
newPass	the new password (null or empty string means no password)

See also

[ISFSEvents onRoomPasswordStateChange:]

[ISFSEvents onRoomPasswordStateChangeError

ChangeRoomNameRequest

ChangeRoomPasswordStateRequest