VerIDSessionResult

@objc
public class VerIDSessionResult : NSObject, Codable

Represents a result of face detection and authentication

  • When the result was collected (time interval since 1970)

    Declaration

    Swift

    @available(*, deprecated: 3.1)
@objc
private(set) public var timestamp: Double

  • The outcome

    Declaration

    Swift

    @objc
internal(set) public var outcome: VerIDSession.Outcome

  • Whether the result is positive true or not false

    Declaration

    Swift

    @available(*, deprecated: 3.1, renamed: "isPositive")
@objc
public var positive: Bool { get }

  • Whether the result is positive true or not false

    Declaration

    Swift

    @objc
public var isPositive: Bool { get }

  • The users identified in the faces in the result

    Declaration

    Swift

    @objc
public var identifiedUsers: [VerIDUser] { get }

  • All faces collected in the session

    Declaration

    Swift

    @objc
public var faces: [VerIDFace] { get }

  • Faces collected in the session that are suitable for face recognition (to be used for authentication or registration)

    Declaration

    Swift

    @objc
public var facesSuitableForRecognition: [VerIDFace] { get }

  • Images collected in the session

    Declaration

    Swift

    @objc
public var images: [URL] { get }

  • Declaration

    Swift

    public required init(from decoder: Decoder) throws

  • Declaration

    Swift

    public func encode(to encoder: Encoder) throws

  • Dictionary of faces and their corresponding image URLs collected in the session

    Declaration

    Swift

    @objc
public func faceImages(withBearing bearing: VerIDBearing) -> [VerIDFace : URL]

    Parameters

    bearing

    Requested face bearing or nil to return all entries regardless of their face bearing

    Return Value

    VerIDFace/URL dictionary

  • Dictionary of faces and their corresponding image URLs collected in the session

    Declaration

    Swift

    @objc
public var faceImages: [VerIDFace : URL] { get }

  • Faces with given bearing collected in the session

    Declaration

    Swift

    @objc
public func faces(withBearing bearing: VerIDBearing) -> [VerIDFace]

    Parameters

    bearing

    Requested face bearing or nil to return all faces regardless of their bearing

    Return Value

    Array of faces

  • URLs of images with the given face bearing collected in the session

    Declaration

    Swift

    @objc
public func imageURLs(withBearing bearing: VerIDBearing) -> [URL]

    Parameters

    bearing

    Requested face bearing or nil to return all images regardless of their face bearing

    Return Value

    Array of image URLs

  • URLs of images collected in the session

    Declaration

    Swift

    @objc
public var imageURLs: [URL] { get }

  • Set of face bearings collected in the session

    Declaration

    Swift

    public var detectedBearings: Set<VerIDBearing> { get }

  • URL of a video of the session. Only collected if the corresponding session settings had videoURL set.

    Declaration

    Swift

    @objc
public var videoURL: URL?