Package | com.myflashlab.air.extensions.firebase.invites |
Class | public class InvitesBuilder |
Inheritance | InvitesBuilder Object |
Property | Defined By | ||
---|---|---|---|
callToAction : String
Text shown on the email invitation for the user to accept the invitation. | InvitesBuilder | ||
emailHtmlContent : String
Sets the app description displayed in email invitations. | InvitesBuilder | ||
emailSubject : String
Sets the subject for invites sent by email. | InvitesBuilder | ||
img : String
Sets an image for invitations. | InvitesBuilder | ||
msg : String
Sets the invite message but it acts a bit differently on iOS/Android:
Android: Sets the invite message that is sent to all invitees. | InvitesBuilder | ||
otherPlatform : int = 0
Targets another version of your app to receive the invitation. | InvitesBuilder | ||
otherPlatformClientId : String
Google generated client Id from the Developer console. | InvitesBuilder | ||
title : String = Firebase Invite ANE Sets the title of the invite dialog. | InvitesBuilder | ||
url : String
Sets the deep link that is made available to the app when opened from the invitation. | InvitesBuilder |
Method | Defined By | ||
---|---|---|---|
Initialize a new object of type InvitesBuilder for configuring your invitation settings. | InvitesBuilder |
callToAction | property |
public var callToAction:String
Text shown on the email invitation for the user to accept the invitation. but it acts a bit differently on iOS/Android:
Android: 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 emailHtmlContent is set.
iOS: Sets the text shown on the email invitation button to install the app. Default install text used if not set. Maximum length is 32 characters.
emailHtmlContent | property |
public var emailHtmlContent:String
Sets the app description displayed in email invitations. but it acts differently on iOS/Android:
Android: 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 emailSubject
. and
callToAction
must not be set.
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
url
. Must be valid (MAX_EMAIL_HTML_CONTENT bytes or less).
iOS: Sets the app description displayed in email invitations. Maximum length is 1000 characters. But it is no longer supported
emailSubject | property |
public var emailSubject:String
Sets the subject for invites sent by email. This must be set along with emailHtmlContent
img | property |
public var img:String
Sets an image for invitations.
Android: This must not be set if emailHtmlContent is set.
iOS: The imageURI is required to be in absolute format. The URI can be either a content URI with extension "jpg" or "png", or a network url with scheme "https".
msg | property |
public var msg:String
Sets the invite message but it acts a bit differently on iOS/Android:
Android: 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.
iOS: Sets the default message to use for the invitation. This is the message that will be sent in the invite, for e.g., via SMS or email. This message must not exceed 100 characters. The message will be modifiable by the user. Maximum length is 100 characters.
otherPlatform | property |
public var otherPlatform:int = 0
Targets another version of your app to receive the invitation. set to Invites.PROJECT_PLATFORM_IOS
and pass
the client id to target iOS version of your app or call Invites.PROJECT_PLATFORM_ANDROID
and pass the
client id of your Android app to target the Android version of your app.
otherPlatformClientId | property |
public var otherPlatformClientId:String
Google generated client Id from the Developer console. You need to specify what platform this client id is linked to by
specifying the otherPlatform
property to either Invites.PROJECT_PLATFORM_IOS
or
Invites.PROJECT_PLATFORM_ANDROID
title | property |
public var title:String = Firebase Invite ANE
Sets the title of the invite dialog.
url | property |
public var url:String
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.
InvitesBuilder | () | Constructor |
public function InvitesBuilder()
Initialize a new object of type InvitesBuilder for configuring your invitation settings. When the object is configured,
you should use the Invites.send
method and pass inthe configured object into it so that the invite dialog
would open. Note that on iOS, the user must have signed in using the Google Signin ANE before the dialog can be opened.