Firebase.Invites.Invite

Data structure used to construct and send an invite.

Summary

See also:FirebaseInvites.SendInviteAsync()

Inheritance

Inherits from: SystemIDisposable

Constructors and Destructors

Invite()
Initialize the invite.

Properties

AndroidMinimumVersionCode
int
Optional minimum version of the android app installed on the receiving device.
AndroidPlatformClientId
string
The client ID for your app for the Android platform (don't set this for your current platform).
CallToActionText
string
Text shown on the email invitation button for the user to accept the invitation.
CustomImageUrl
System.Uri
An optional URL for an image to include in the invitation.
DeepLinkUrl
System.Uri
An optional deep link that will be sent with the invitation.
DescriptionText
string
The app description text for email invitations.
EmailContentHtml
string
The full HTML content of the invitation that will be sent.
EmailSubjectText
string
The subject text for an HTML e-mail.
GoogleAnalyticsTrackingId
string
The optional Google Analytics Tracking id.
IOSPlatformClientId
string
The client ID for your app for the iOS platform (don't set this for your current platform).
MessageText
string
The text of the invitation message.
ReferralParameters
global::System.Collections.Generic.IDictionary< string, string >
Optional additional referral parameters, which is passed to the invite URL as a key/value pair.
TitleText
string
The title text for the Invites UI window.

Public static attributes

MaxCallToActionTextLength = 20
readonly uint
Maximum length for the call to action button.
MaxDescriptionTextLength = 1000
readonly uint
Maximum length for the app description.
MaxEmailHtmlContentLength = 512000
readonly uint
Maximum length for an HTML invitation message.
MaxMessageLength = 100
readonly uint
Maximum length for an invitation message.
MinCallToActionTextLength = 2
readonly uint
Minimum length for the call to action button.

Public functions

Dispose()
void

Properties

AndroidMinimumVersionCode

int AndroidMinimumVersionCode

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

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

AndroidPlatformClientId

string AndroidPlatformClientId

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.

CallToActionText

string CallToActionText

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 MaxCallToActionTextLength characters, and must be no shorter than MinCallToActionTextLength characters.

CustomImageUrl

System.Uri CustomImageUrl

An optional URL for an image to include in the invitation.

If you don't specify this, your invite will have no deep link. If you specify null, you can remove any previously-set deep link.

DeepLinkUrl

System.Uri DeepLinkUrl

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

If you don't specify this, your invite will have no deep link. If you specify null, you can remove any previously-set deep link.

DescriptionText

string DescriptionText

The app description text for email invitations.

Note:The length of this text must not exceed MaxDescriptionTextLength 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.

EmailContentHtml

string EmailContentHtml

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 MaxEmailContentHtmlLength characters.

EmailSubjectText

string EmailSubjectText

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.

GoogleAnalyticsTrackingId

string GoogleAnalyticsTrackingId

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.

IOSPlatformClientId

string IOSPlatformClientId

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.

MessageText

string MessageText

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 MaxMessageLength 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.

ReferralParameters

global::System.Collections.Generic.IDictionary< string, string > ReferralParameters

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.

TitleText

string TitleText

The title text for the Invites UI window.

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

Public static attributes

MaxCallToActionTextLength

readonly uint MaxCallToActionTextLength = 20

Maximum length for the call to action button.

See also: Invite.CallToActionText

MaxDescriptionTextLength

readonly uint MaxDescriptionTextLength = 1000

Maximum length for the app description.

See also: Invite.DescriptionText

MaxEmailHtmlContentLength

readonly uint MaxEmailHtmlContentLength = 512000

Maximum length for an HTML invitation message.

See also: Invite.EmailContentHtml

MaxMessageLength

readonly uint MaxMessageLength = 100

Maximum length for an invitation message.

See also:Invite.MessageText.

MinCallToActionTextLength

readonly uint MinCallToActionTextLength = 2

Minimum length for the call to action button.

See also: Invite.CallToActionText

Public functions

Dispose

void Dispose()

Invite

 Invite()

Initialize the invite.

Send feedback about...

Need help? Visit our support page.