new SFSInvitation()

Developers never istantiate an SFSInvitation class: always use the reference to an existing instance provided by the invitation event.

An invitation is sent through the InviteUsersRequest request and it is received as an invitation event. Clients can reply to an invitation using the InvitationReplyRequest request.

See also
InviteUsersRequest
InvitationReplyRequest
SFSEvent.INVITATION

Properties

read-only

id  number

Indicates the id of the invitation. It is generated by the server when the invitation is sent.

read-only

invitee  SFSUser

Returns the SFSUser object corresponding to the user who received the invitation.

read-only

inviter  SFSUser

Returns the SFSUser object corresponding to the user who sent the invitation.

read-only

params  SFSObject

Returns a SFSObject containing a custom set of parameters. It usually stores invitation details, like a message to the invitee and any other relevant data.

read-only

secondsForAnswer  number

Returns the number of seconds available to the invitee to reply to the invitation, after which the invitation expires.