SFSInvitation

Represents an Invitation received by the client.


An Invitation is sent through the InviteUsersRequest and it is received as an SFSEvent.INVITATION event. Clients can reply to an Invitation using the InvitationReplyRequest.

Members

(readonly) id :number

Identifier of the Invitation.

The id is generated by the server when the Invitation is sent.

Type:
  • number

(readonly) invitee :SFSUser

Object representing the User which received the Invitation.
Type:

(readonly) inviter :SFSUser

Object representing the User which sent the Invitation.
Type:

(readonly) params :SFSObject

SFSObject containing a custom set of parameters attached to the Invitation.

This object usually stores Invitation details, like a message to the invited User and any other relevant data.

(readonly) secondsForAnswer :number

Number of seconds available to the invited User to reply to the Invitation, after which the Invitation expires.
Type:
  • number