Interface Invitation

  • All Known Implementing Classes:
    SFSInvitation

    public interface Invitation
    The Invitation interface defines all the methods and properties that an object representing an invitation entity exposes.

    In the SmartFoxServer 2X client API this interface is implemented by the SFSInvitation class. Read the class description for additional informations.

    See Also:
    SFSInvitation
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      int getId()
      Indicates the id of this invitation.
      User getInvitee()
      Returns the User object corresponding to the user who received the invitation.
      User getInviter()
      Returns the User object corresponding to the user who sent the invitation.
      com.smartfoxserver.v2.entities.data.ISFSObject getParams()
      Returns an instance of SFSObject containing a custom set of parameters.
      int getSecondsForAnswer()
      Returns the number of seconds available to the invitee to reply to the invitation, after which the invitation expires.
      void setId​(int id)
      * API internal usage only *
    • Method Detail

      • getId

        int getId()
        Indicates 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.

      • setId

        void setId​(int id)
        * API internal usage only *
      • getInviter

        User getInviter()
        Returns the User object corresponding to the user who sent the invitation.
      • getInvitee

        User getInvitee()
        Returns the User object corresponding to the user who received the invitation.
      • getSecondsForAnswer

        int getSecondsForAnswer()
        Returns the number of seconds available to the invitee to reply to the invitation, after which the invitation expires.
      • getParams

        com.smartfoxserver.v2.entities.data.ISFSObject getParams()
        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.