UnbanUsersFromRoomRequest

Removes the banishment of a group of Users (max 10) from a Room where they have been banned before.

The current User must be the owner of the Room, or have administration or moderation privileges, in order to remove the banishment of other Users (see the SFSUser#privilegeId property).

This request allows sending a message to the Users, which is delivered by means of the SFSEvent.MODERATOR_MESSAGE event. If a message is sent, the action is executed after a short delay.

Constructor

new UnbanUsersFromRoomRequest(userNames, room, messageopt)

Creates a new instance of the UnbanUsersFromRoomRequest class.
Pass the instance to the SmartFox#send method to validate and execute the request.
Parameters:
NameTypeAttributesDefaultDescription
userNamesArray.<string>The list of User names to be removed from banishment (max 10).
roomSFSRoomThe object representing the Room where the ban occurred.
messagestring<optional>
nullA custom message to be delivered to the Users before the action is executed.
See
Fires: