VerIDSessionSettings

@objc
public class VerIDSessionSettings : NSObject, Codable

Settings common to registration, authentication and liveness detection sessions

  • True to show a guide to the user before the session begins

    Deprecated in 3.2

    Declaration

    Swift

    @available(*, deprecated: 3.2)
@objc
public var showGuide: Bool

  • True to show the result of the session to the user

    Declaration

    Swift

    @objc
public var showResult: Bool

  • Number of successful results the session must collect before it finishes

    Declaration

    Swift

    @objc
public var numberOfResultsToCollect: Int

  • Time the user has to complete the session

    Declaration

    Swift

    @objc
public var expiryTime: TimeInterval

  • Set this to record a video of the session

    Declaration

    Swift

    @objc
public var videoURL: URL?

  • How many times can the user retry before the session returns a failure

    Declaration

    Swift

    @objc
public var maxRetryCount: Int

  • Include face templates in the returned result

    Declaration

    Swift

    @objc
public var includeFaceTemplatesInResult: Bool

  • Set to true to enable spoken prompts

    Declaration

    Swift

    @objc
public var speakPrompts: Bool

  • Constructor

    Declaration

    Swift

    @objc
public init(expiryTime: TimeInterval = 30.0, numberOfResultsToCollect: Int = 1)

    Parameters

    expiryTime

    Time the user has to complete the session
    numberOfResultsToCollect

    Number of successful results the session must collect before it finishes

  • Declaration

    Swift

    required public init(from decoder: Decoder) throws

  • Declaration

    Swift

    public func encode(to encoder: Encoder) throws