| Package | com.smartfoxserver.v2.entities.invitation |
| Interface | public interface Invitation |
| Implementors | SFSInvitation |
In the SmartFoxServer 2X client API this interface is implemented by the SFSInvitation class. Read the class description for additional informations.
See also
| Property | Defined By | ||
|---|---|---|---|
| id : int
Indicates the id of this invitation. | Invitation | ||
| invitee : User [read-only]
Returns the User object corresponding to the user who received the invitation. | Invitation | ||
| inviter : User [read-only]
Returns the User object corresponding to the user who sent the invitation. | Invitation | ||
| params : ISFSObject [read-only]
Returns an instance of SFSObject containing a custom set of parameters. | Invitation | ||
| secondsForAnswer : int [read-only]
Returns the number of seconds available to the invitee to reply to the invitation, after which the invitation expires. | Invitation | ||
| id | property |
id:intIndicates the id of this invitation. It is generated by the server when the invitation is sent.
NOTE: setting the id property manually has no effect on the server and can disrupt the API functioning.
public function get id():int public function set id(value:int):void| invitee | property |
invitee:User [read-only] Returns the User object corresponding to the user who received the invitation.
public function get invitee():User| inviter | property |
inviter:User [read-only] Returns the User object corresponding to the user who sent the invitation.
public function get inviter():User| params | property |
params:ISFSObject [read-only] Returns an instance of SFSObject containing a custom set of parameters. It usually stores invitation details, like a message to the invitee and any other relevant data.
public function get params():ISFSObject| secondsForAnswer | property |
secondsForAnswer:int [read-only] Returns the number of seconds available to the invitee to reply to the invitation, after which the invitation expires.
public function get secondsForAnswer():int