SetUserVariablesRequest

Sets one or more User Variables for the User.


When a User Variable is set, the SFSEvent.USER_VARIABLES_UPDATE event is dispatched to all the Users in all the Rooms joined by the client, including itself.

Note that the SFSEvent.USER_VARIABLES_UPDATE event is dispatched to users in a given Room if that Room is configured to allow this event only (see the RoomSettings#permissions parameter).

Constructor

new SetUserVariablesRequest(userVariables)

Creates a new instance of the SetUserVariablesRequest class.
Pass the instance to the SmartFox#send method to validate and execute the request.
Parameters:
NameTypeDescription
userVariablesArray.<SFSUserVariable>A list of objects representing the User Variables to set.