devsite/tools/jazzy/templates

FirebaseAuth Framework Reference

ActionCodeSettings

@objc(FIRActionCodeSettings)
open class ActionCodeSettings : NSObject

Used to set and retrieve settings related to handling action codes.

  • url

    This URL represents the state/Continue URL in the form of a universal link.

    This URL can should be constructed as a universal link that would either directly open the app where the action code would be handled or continue to the app after the action code is handled by Firebase.

    Declaration

    Swift

    @objc(URL)
open var url: URL?

  • Indicates whether the action code link will open the app directly or after being redirected from a Firebase owned web widget.

    Declaration

    Swift

    @objc
open var handleCodeInApp: Bool

  • The iOS bundle ID, if available. The default value is the current app’s bundle ID.

    Declaration

    Swift

    @objc
open var iOSBundleID: String?

  • The Android package name, if available.

    Declaration

    Swift

    @objc
open var androidPackageName: String?

  • The minimum Android version supported, if available.

    Declaration

    Swift

    @objc
open var androidMinimumVersion: String?

  • Indicates whether the Android app should be installed on a device where it is not available.

    Declaration

    Swift

    @objc
open var androidInstallIfNotAvailable: Bool

  • The Firebase Dynamic Link domain used for out of band code flow.

    Declaration

    Swift

    @objc
open var dynamicLinkDomain: String?

  • Sets the iOS bundle ID.

    Declaration

    Swift

    override public init()

  • Sets the Android package name, the flag to indicate whether or not to install the app, and the minimum Android version supported.

    If installIfNotAvailable is set to true and the link is opened on an android device, it will try to install the app if not already available. Otherwise the web URL is used.

    Declaration

    Swift

    @objc
open func setAndroidPackageName(_ androidPackageName: String,
                                installIfNotAvailable: Bool,
                                minimumVersion: String?)

    Parameters

    androidPackageName

    The Android package name.
    installIfNotAvailable

    Indicates whether or not the app should be installed if not available.
    minimumVersion

    The minimum version of Android supported.

  • Sets the iOS bundle ID.

    Declaration

    Swift

    open func setIOSBundleID(_ bundleID: String)