Class Invite

java.lang.Object
com.codename1.analytics.invite.Invite
public final class Invite extends Object

An invite that has been minted and is ready to share. Immutable; create one with Invites.create(InviteRequest).

getUrl() is the link to send. It is usable the moment Invites.create(InviteRequest) returns, including with no network at all, so the share sheet never waits on a server.

  • Method Details

    • getCode

      public String getCode()

      The opaque invite code. This identifies the invite and authorizes nothing, so it is safe to print, log or show to the user.

      Returns

      the code, never null

    • getUrl

      public String getUrl()

      The link to share.

      Returns

      an absolute https url, never null

    • getCampaign

      public String getCampaign()

      The campaign this invite belongs to, or null.

      Returns

      the campaign

    • getChannel

      public String getChannel()

      The channel this invite was minted for, or null.

      Returns

      the channel

    • getPayload

      public String getPayload()

      The application defined payload carried to the invited device, or null.

      Returns

      the payload

    • getCreatedTimestamp

      public long getCreatedTimestamp()

      When this invite was minted, in milliseconds since the epoch.

      Returns

      the creation time

    • toString

      public String toString()
      Description copied from class: Object
      Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method. The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of: getClass().getName() + '@' + Integer.toHexString(hashCode())
      Overrides:
      toString in class Object