FIRInviteBuilder

@protocol FIRInviteBuilder <NSObject>

The protocol to configure the invite dialog.

  • Sets the delegate object that will receive callbacks after the invite dialog closes.

    Declaration

    Swift

    func setInviteDelegate(_ inviteDelegate: FIRInviteDelegate)

    Objective-C

    - (void)setInviteDelegate:(nonnull id<FIRInviteDelegate>)inviteDelegate;
  • Sets the title of the navigation bar of the invite dialog.

    Declaration

    Swift

    func setTitle(_ title: String)

    Objective-C

    - (void)setTitle:(nonnull NSString *)title;
  • 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.

    Declaration

    Swift

    func setMessage(_ message: String)

    Objective-C

    - (void)setMessage:(nonnull NSString *)message;
  • Sets the deepLink for the invitation. |deepLink| is an identifier that your app defines for use across all supported platforms. It will be passed with the invitation to the receiver. You can use it to present customized view when the user receives an invitation in your app.

    Declaration

    Swift

    func setDeepLink(_ deepLink: String)

    Objective-C

    - (void)setDeepLink:(nonnull NSString *)deepLink;
  • A user may send invites from iOS to users on other platforms, for e.g., users on Android. Sets |FIRInvitesTargetApplication| to specify the non-iOS application that must be installed or opened when a user acts on an invite on that platform.

    Declaration

    Swift

    func setOtherPlatformsTargetApplication(_ targetApplication: FIRInvitesTargetApplication)

    Objective-C

    - (void)setOtherPlatformsTargetApplication:
        (nonnull FIRInvitesTargetApplication *)targetApplication;
  • Sets the app description displayed in email invitations. Maximum length is 1000 characters.

    Declaration

    Swift

    func setDescription(_ description: String)

    Objective-C

    - (void)setDescription:(nonnull NSString *)description;
  • Sets an image for invitations. 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.

    Declaration

    Swift

    func setCustomImage(_ imageURI: String)

    Objective-C

    - (void)setCustomImage:(nonnull NSString *)imageURI;
  • 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.

    Declaration

    Swift

    func setCallToActionText(_ callToActionText: String)

    Objective-C

    - (void)setCallToActionText:(nonnull NSString *)callToActionText;
  • 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. Note that the version code should not be zero.

    Declaration

    Swift

    func setAndroidMinimumVersionCode(_ versionCode: Int)

    Objective-C

    - (void)setAndroidMinimumVersionCode:(NSInteger)versionCode;
  • Opens the invite dialog.

    Declaration

    Swift

    func open()

    Objective-C

    - (void)open;