firebase::invites::Invite

Maximum length for the call to action button.

See also: Invite::call_to_action_text

Maximum length for the app description.

See also: Invite::description_text

Maximum length for an HTML invitation message.

See also: email_content_html

Maximum length for an invitation message.

See also:Invite::message_text.

Minimum length for the call to action button.

See also: Invite::call_to_action_text

Optional minimum version of the android app installed on the receiving device.

If you don't specify this, any Android version will be allowed.

The client ID for your app for the Android platform (don't set this for your current platform).

Make sure the client ID you specify here matches the client ID for your project in Google Developer Console for the other platform.

Note:Firebase is smart enough to infer this automatically if your project in Google Developer Console has only one app for each platform.

Text shown on the email invitation button for the user to accept the invitation.

Default text will be used if this is not set.

Note:The length of this text must not exceed kMaxCallToActionTextLength characters, and must be no shorter than kMinCallToActionTextLength characters.

The URL for an image to include in the invitation.

An optional dynamic link that will be sent with the invitation.

If you don't specify this, your invite will have no dynamic link.

The app description text for email invitations.

Note:The length of this text must not exceed kMaxDescriptionTextLength characters.Note:This function is for iOS only. On Android, this setting will be ignored, and your app's description will be automatically populated from its Google Play listing.

The full HTML content of the invitation that will be sent.

This should be properly-formatted UTF8 HTML with no JavaScript. The pattern %APPINVITE_LINK_PLACEHOLDER%% will be replaced with the invitation URL.

This takes precendence over the text functions message_text, call_to_action_text, and custom_image_url. If you want full control over the contents of the invitation, you should use this.

If you use this, you must also set email_subject_text or the HTML content will be ignored.

If you do use these HTML text fields, they will take priority over the standard text fields, if HTML is supported on your platform. You probably still want to set message_text and the other text fields in case your platform doesn't support HTML.

Note:HTML invitation content is only supported on Android.Note:The length of the HTML email content must not exceed kMaxEmailContentHtmlLength characters.

The subject text for an HTML e-mail.

If you use this, you must set email_content_html as well or the HTML content will be ignored.

The optional Google Analytics Tracking id.

The tracking id should be created for the calling application under Google Analytics. The tracking id is recommended so that invitations sent from the calling application are available in Google Analytics.

Note:This field is only supported on Android. On iOS, if you want to track invitations in Google Analytics, you will have to do so manually.

The client ID for your app for the iOS platform (don't set this for your current platform).

Make sure the client ID you specify here matches the client ID for your project in Google Developer Console for the other platform.

Note:Firebase is smart enough to infer this automatically if your project in Google Developer Console has only one app for each platform.

The text of the invitation message.

message_text, custom_image_url, and call_to_action_text comprise the standard text invitation options.

If you use the standard text methods as well as email_content_html and email_subject_text, the HTML methods will take priority if your platform supports them.

The user is able to modify this message before sending the invite.

Note:The length of this message must not exceed kMaxMessageLength characters, so it can fit in an SMS message along with the link.Note:You must set this and title_text or you will not be able to send an invitation.

Optional additional referral parameters, which is passed to the invite URL as a key/value pair.

You can have any number of these.

These key/value pairs will be included in the referral URL as query parameters, so they can be read by the app on the receiving side.

Note:Referral parameters are only supported on Android.

The title text for the Invites UI window.

Note:You must set this and message_text to send invitations.

Initialize the invite.