Maximum length for the invitation button text set in setCallToActionText(CharSequence).

Maximum size for the email html content in bytes for setEmailHtmlContent(String).

Maximum length for the invitation message set in setMessage(CharSequence).

Minimum length for the invitation button text set in setCallToActionText(CharSequence).

App invite invitation builder.

Builds the Intent to start the invitation Activity.

Sets the name of the account to get a list of people for.

Adds query parameters to the play store referral URL when the app needs additional referral parameters for other application component referrals. These parameters are added to the referral URL sent from the play store and are available to be processed by other application components, for example Google Analytics. The parameters are set as name, value pairs that will be set as query parameter name and value on the referral URL.

Example:

            Map<String, String> referralParams = new HashMap<String, String>();
 referralParams.put("paramOne", "1");
 referralParams.put("paramTwo", "2");

 Intent intent = new AppInviteInvitation
     .IntentBuilder("Send Invitations for XYZ app")
     .setAdditionalReferralParameters(referralParams)
     ...
     .build();
 startActivityForResult(intent, REQUEST_INVITE);

 

Sets the minimum version of the android app installed on the receiving device. If this minimum version is not installed then the install flow will be triggered.

Text shown on the email invitation for the user to accept the invitation. Default install text used if not set. This must not be set if setEmailHtmlContent(String) is set or build() will throw an Exception.

Sets an image for invitations. This must not be set if setEmailHtmlContent(String) is set or build() will throw an Exception.

Sets the deep link that is made available to the app when opened from the invitation. This deep link is made available both to a newly installed application and an already installed application. The deep link can be sent to Android and other platforms so should be formatted to support deep links across platforms.

On android, a deep link filter for AppInvite should include an action, category, and data where the data is a uri that matches the deep link. The action must be VIEW and include both category DEFAULT and BROWSABLE as shown in the sample app.

Accessing the deep link in the application after being opened is described in AppInviteReferral.

Sets the HTML-formatted (UTF-8 encoded, no JavaScript) content for invites sent through email. If set, this will be sent instead of the default email. This must be set along with setEmailSubject(String) or build() will throw an Exception. setCustomImage(Uri) and setCallToActionText(CharSequence) must not be set or build() will throw an Exception.

htmlContent must be valid HTML for standard email processing. The pattern %%APPINVITE_LINK_PLACEHOLDER%% should be embedded in your htmlContent and will be replaced with the invitation URL. This url is a link that will launch the app if already installed or take the user to the appropriate app store if not. In both cases the deep link will be available if provided using setDeepLink(Uri). Accessing the deep link in the application after being opened is described in AppInviteReferral.

            Intent intent = new AppInviteInvitation.IntentBuilder("Send Invitations for XYZ app")
     ...
     .setEmailHtmlContent("&lthtml&gt&ltbody&gt"
         + "&lta href=\"%%APPINVITE_LINK_PLACEHOLDER%%\"&gtXYZ Free Trial&lt/a&gt"
         + "&lt/body&gt&lt/html&gt")
     .setEmailSubject("XYZ Offer")
     ...
     .build();

 

Sets the subject for invites sent by email. This must be set along with setEmailHtmlContent(String) or build() will throw an Exception.

Sets the Google Analytics Tracking id. The tracking id should be created for the calling application under Google Analytics. See more about how to get a tracking id . The tracking id is recommended so that invitations sent from the calling application are available in Google Analytics.

Sets the invite message that is sent to all invitees. Must be valid (MAX_MESSAGE_LENGTH bytes or less), including the length of translated and generated messages. The message can be edited by the sender.

Targets another version of your app to receive the invitation from Android. This is needed only when there are multiple client IDs defined in your Google Developer Console project. Setting the target client ID for the invitation ensures that it goes to the correct app.