Class InviteRequest.Builder

java.lang.Object
com.codename1.analytics.invite.InviteRequest.Builder
Enclosing class:
InviteRequest
public static final class InviteRequest.Builder extends Object
Builds an InviteRequest.

  • Method Details

    • campaign

      public InviteRequest.Builder campaign(String campaign)

      Groups this invite with others for reporting, for example a seasonal push. Letters, digits, ., _ and - only.

      Parameters
      • campaign: the campaign name
      Returns

      this builder

    • channel

      public InviteRequest.Builder channel(String channel)

      How the invite is being sent, for example sms or whatsapp. Letters, digits, ., _ and - only.

      Parameters
      • channel: the channel name
      Returns

      this builder

    • payload

      public InviteRequest.Builder payload(String payload)

      An application defined string handed back to the invited device, for example the room or team the friend is being invited to.

      Parameters
      • payload: the payload
      Returns

      this builder

    • title

      public InviteRequest.Builder title(String title)

      The headline on the preview card the link shows in a messaging application.

      Parameters
      • title: the title
      Returns

      this builder

    • description

      public InviteRequest.Builder description(String description)

      The body text on the preview card.

      Parameters
      • description: the description
      Returns

      this builder

    • imageUrl

      public InviteRequest.Builder imageUrl(String url)

      The image on the preview card, as an absolute address.

      Parameters
      • url: the image address
      Returns

      this builder

    • param

      public InviteRequest.Builder param(String key, String value)

      Adds a custom parameter carried to the invited device. A null value removes the key.

      Parameters

      • key: the parameter name

      • value: the parameter value, or null to remove it

      Returns

      this builder

    • build

      public InviteRequest build()

      Validates and builds the request.

      Returns

      the immutable request