InviteUsersRequest

Sends a generic Invitation to a list of Users.


Invitations can be used for different purposes, such as requesting Users to join a game or visit a specific Room, asking the permission to add them as Buddies, etc. Invited Users receive the Invitation through the SFSEvent.INVITATION event, dispatched to the client: they can accept or refuse it by means of the InvitationReplyRequest, which must be sent before the Invitation expires.

Constructor

new InviteUsersRequest(invitedUsers, secondsForReply, parametersopt)

Creates a new instance of the InviteUsersRequest class.
Pass the instance to the SmartFox#send method to validate and execute the request.
Parameters:
NameTypeAttributesDefaultDescription
invitedUsersArray.<SFSUser> | Array.<SFSBuddy>A list of objects representing the Users or Buddies to send the Invitation to.
secondsForReplynumberThe number of seconds before the Invitation expires (recommended range: 15 to 40 seconds).
parametersSFSObject<optional>
nullAn object containing custom parameters with additional Invitation details.