devsite/tools/jazzy/templates

FirebaseAuth Framework Reference

ActionCodeURL

@objc(FIRActionCodeURL)
open class ActionCodeURL : NSObject

This class will allow developers to easily extract information about out of band links.

  • Returns the API key from the link. nil, if not provided.

    Declaration

    Swift

    @objc(APIKey)
public let apiKey: String?

  • Returns the mode of oob action.

    The property will be of ActionCodeOperation type. It will return .unknown if no oob action is provided.

    Declaration

    Swift

    @objc
public let operation: ActionCodeOperation

  • Returns the email action code from the link. nil, if not provided.

    Declaration

    Swift

    @objc
public let code: String?

  • Returns the continue URL from the link. nil, if not provided.

    Declaration

    Swift

    @objc
public let continueURL: URL?

  • Returns the language code from the link. nil, if not provided.

    Declaration

    Swift

    @objc
public let languageCode: String?

  • Construct an ActionCodeURL from an out of band link (e.g. email link).

    Declaration

    Swift

    @objc(actionCodeURLWithLink:)
public init?(link: String)

    Parameters

    link

    The oob link string used to construct the action code URL.

    Return Value

    The ActionCodeURL object constructed based on the oob link provided.