Node

@objc(FRNode)
public class Node : NSObject

Node class is the core abstraction within an authentication tree. Trees are made up of nodes, which may modify the shared state and/or request input from the user via Callbacks. Node is also a representation of each step in the authentication flow, and keeps unique identifier and its state of the authentication flow. Node must be submitted to OpenAM to proceed or finish the authentication flow. Submitting the Node object returns one of following:

  • Result of expected type, if available
  • Another Node object instance to continue on the authentication flow
  • An error, if occurred during the authentication flow

Public properties

  • A list of Callback for the state

    Declaration

    Swift

    @objc
public var callbacks: [Callback]

  • authId for the authentication flow

    Declaration

    Swift

    @objc
public var authId: String

  • Unique UUID String value of initiated AuthService flow

    Declaration

    Swift

    @objc
public var authServiceId: String

  • Stage attribute in Page Node

    Declaration

    Swift

    @objc
public var stage: String?

  • Header attribute in Page Node

    Declaration

    Swift

    @objc
public var pageHeader: String?

  • Description attribute in Page Node

    Declaration

    Swift

    @objc
public var pageDescription: String?

Public methods

  • Submits current Node object with Callback(s) and its given value(s) to OpenAM to proceed on authentication flow.

    Declaration

    Swift

    public func next<T>(completion: @escaping NodeCompletion<T>)

    Parameters

    completion

    NodeCompletion callback which returns the result of Node submission.