IPAuthenticationSession

public class IPAuthenticationSession : Decodable, Encodable

Represents the status of an IAMPASS session. The status property can be used to verify the state of the session. The refreshStatus method should be called to update the session status.

  • Undocumented

    Declaration

    Swift

    public var status: SessionStatus

  • Undocumented

    Declaration

    Swift

    public let reason: String?

  • Undocumented

    Declaration

    Swift

    public var isInProgress: Bool { get }

  • Undocumented

    Declaration

    Swift

    public var didFail: Bool { get }

  • Undocumented

    Declaration

    Swift

    public var isAuthenticated: Bool { get }

  • Declaration

    Swift

    required public init(from decoder: Decoder) throws

  • Declaration

    Swift

    public func encode(to encoder: Encoder) throws

  • This method will call the IAMPASS server to get the status of this session. This method should be called periodically to check whether the session has been closed remotely. Do not rely soley on the status property.

    Declaration

    Swift

    public func refreshStatus(success: @escaping (_ status: SessionStatus) -> Void, failure: @escaping (_ error: Error?) -> Void)

  • This method will call the IAMPASS server to end this session.

    Declaration

    Swift

    public func endSession(success: @escaping () -> Void, failure: @escaping (_ error: Error?) -> Void)