public static final class InviteRequest.Builder

  1. Object
  2. InviteRequest.Builder
Builds an InviteRequest.

Methods

public InviteRequest.Builder campaign(String campaign)Groups this invite with others for reporting, for example a seasonal push.
public InviteRequest.Builder channel(String channel)How the invite is being sent, for example sms or whatsapp.
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.
public InviteRequest.Builder title(String title)The headline on the preview card the link shows in a messaging application.
public InviteRequest.Builder description(String description)The body text on the preview card.
public InviteRequest.Builder imageUrl(String url)The image on the preview card, as an absolute address.
public InviteRequest.Builder param(String key, String value)Adds a custom parameter carried to the invited device.
public InviteRequest build()Validates and builds the request.

Inherited methods

From Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait, clone

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 String
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 String
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 String
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 String
the title

Returns

this builder

description

public InviteRequest.Builder description(String description)
The body text on the preview card.

Parameters

description String
the description

Returns

this builder

imageUrl

public InviteRequest.Builder imageUrl(String url)
The image on the preview card, as an absolute address.

Parameters

url String
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 String
the parameter name
value String
the parameter value, or null to remove it

Returns

this builder

build

public InviteRequest build()
Validates and builds the request.

Returns

the immutable request