UserManager Class Reference


                    
                    
                    FaceTemplateArrayCallback

Callback block with an array of face templates and optional error as parameters

Declaration

Swift

public typealias FaceTemplateArrayCallback = ([FaceTemplate], Error?) -> Void


                    
                    
                    ErrorCallback

Callback block with an optional error as parameter

Declaration

Swift

public typealias ErrorCallback = (Error?) -> Void


                    
                    
                    StringArrayCallback

Callback block with an array of strings and optional error as parameters

Declaration

Swift

public typealias StringArrayCallback = ([String], Error?) -> Void


                    
                    
                    NumberCallback

Callback block with a number and optional error as parameters

Declaration

Swift

public typealias NumberCallback = (NSNumber, Error?) -> Void


                    
                    
                    FaceTemplateDictionaryCallback

Callback block with a dictionary of face template arrays keyed by user ids strings and optional error as parameters

Declaration

Swift

public typealias FaceTemplateDictionaryCallback = (UserFaceTemplates, Error?) -> Void


                    
                    
                    UserFaceTemplates

Dictionary of face template arrays keyed by user id strings

Declaration

Swift

public typealias UserFaceTemplates = [String : [FaceTemplate]]


                    
                    
                    assignFaceTemplates(_:to:)

Assign face templates to a user

Note

If a user record with the given identifier does not exist it will be created. If any of the face templates are already assigned to a different user they will be reassigned to the specified user. If any of the face templates is the last remaining template for the user to whom they were previously assigned the user will be deleted. This method replaces the less performant addFaceTemplates(_:to).

Declaration

Swift

@available(*, message: "Introduced in Ver-ID 3.4.0")
@objc
public func assignFaceTemplates(_ faceTemplates: [FaceTemplate], to user: String) throws

Parameters

`faceTemplates`	Array of face templates to assign to the user
`user`	Identifier for the user


                    
                    
                    assignFaceTemplates(_:to:completion:)

Assign face templates to a user

Note

If a user record with the given identifier does not exist it will be created. If any of the face templates are already assigned to a different user they will be reassigned to the specified user. If any of the face templates is the last remaining template for the user to whom they were previously assigned the user will be deleted. This method replaces the less performant addFaceTemplates(_:to).

Declaration

Swift

@available(*, message: "Introduced in Ver-ID 3.4.0")
@objc
public func assignFaceTemplates(_ faceTemplates: [FaceTemplate], to user: String, completion: @escaping ErrorCallback)

Parameters

`faceTemplates`	Array of face templates to assign to the user
`user`	Identifier for the user
`completion`	Block invoked on completion


                    
                    
                    deleteFaceTemplates(_:)

Delete face templates

Note

If the given face templates are the last remaining face templates for a user the user will be deleted.

Declaration

Swift

@available(*, message: "Introduced in Ver-ID 3.4.0")
@objc
public func deleteFaceTemplates(_ faceTemplates: [FaceTemplate]) throws

Parameters


                                faceTemplates

Array of face templates to delete


                    
                    
                    deleteFaceTemplates(_:completion:)

Delete face templates

Note

If the given face templates are the last remaining face templates for a user the user will be deleted.

Declaration

Swift

@available(*, message: "Introduced in Ver-ID 3.4.0")
@objc
public func deleteFaceTemplates(_ faceTemplates: [FaceTemplate], completion: @escaping ErrorCallback)

Parameters


                                faceTemplates

Array of face templates to delete


                    
                    
                    addFaceTemplates(_:to:)

Add face templates to a user identified by a string

Note

If a user record with the given identifier does not exist it will be created. If any of the face templates are already associated with another user they will be duplicated. To avoid this use assignFaceTemplates(_:to) instead.

Declaration

Swift

@available(*, deprecated, message: "Deprecated in Ver-ID 3.4.0")
@objc
public func addFaceTemplates(_ faceTemplates: [FaceTemplate], to user: String) throws

Parameters

`faceTemplates`	Array of face templates to associate with the user
`user`	Identifier for the user


                    
                    
                    addFaceTemplates(_:to:completion:)

Add face templates to a user identified by a string

Note

If a user record with the given identifier does not exist it will be created. If any of the face templates are already associated with the user they will not be duplicated.

Declaration

Swift

@available(*, deprecated, message: "Deprecated in Ver-ID 3.4.0")
@objc
public func addFaceTemplates(_ faceTemplates: [FaceTemplate], to user: String, completion: @escaping ErrorCallback)

Parameters

`faceTemplates`	Array of face templates to associate with the user
`user`	Identifier for the user
`completion`	Block invoked on completion


                    
                    
                    faceTemplates(for:)

Retrieve user’s face templates

Declaration

Swift

@objc
public func faceTemplates(for user: String) throws -> [FaceTemplate]

Parameters


                                user

Identifier for the user for whom to retrieve templates

Return Value

Array of face templates associated with the user


                    
                    
                    faceTemplates(for:completion:)

Retrieve user’s face templates

Declaration

Swift

@objc
public func faceTemplates(for user: String, completion: @escaping FaceTemplateArrayCallback)

Parameters

`user`	Identifier for the user for whom to retrieve templates
`completion`	Block invoked on completion


                    
                    
                    removeFaceTemplates(_:from:)

Remove face templates from a user

Note

Face templates that are not associated with the user will be ignored. This method is replaced by the better-performing deleteFaceTemplates(_).

Declaration

Swift

@available(*, deprecated: 3.4.0)
@objc
public func removeFaceTemplates(_ faceTemplates: [FaceTemplate], from user: String) throws

Parameters

`faceTemplates`	Face templates to dissassociate from the user
`user`	Identifier for the user from whom the face templates will be removed


                    
                    
                    removeFaceTemplates(_:from:completion:)

Remove face templates from a user

Note

Face templates that are not associated with the user will be ignored. This method is replaced by the better-performing deleteFaceTemplates(_:completion).

Declaration

Swift

@available(*, deprecated: 3.4.0)
@objc
public func removeFaceTemplates(_ faceTemplates: [FaceTemplate], from user: String, completion: @escaping ErrorCallback)

Parameters

`faceTemplates`	Face templates to dissassociate from the user
`user`	Identifier for the user from whom the face templates will be removed
`completion`	Block invoked on completion


                    
                    
                    users()

Retrieve a list of user identifiers who are associated with at least one face template

Declaration

Swift

@objc
public func users() throws -> [String]

Return Value

Array of user identifiers who are associated with at least one face template


                    
                    
                    users(_:)

Retrieve a list of user identifiers who are associated with at least one face template

Declaration

Swift

@objc
public func users(_ completion: @escaping StringArrayCallback)

Parameters


                                completion

Block invoked on completion


                    
                    
                    identifyUsers(in:securityLevel:)

Identify users whose face templates match the given face template

Declaration

Swift

@available(*, message: "Introduced in 3.4.0")
@objc
public func identifyUsers(in faceTemplate: FaceTemplate, securityLevel: VerIDSecurityLevel = .normal) throws -> [String]

Parameters

`faceTemplate`	Face template to which to compare user face templates
`securityLevel`	Security level to use on the authentication

Return Value

Identifiers for users whose faces are similar to the supplied face template.


                    
                    
                    identifyUsers(in:securityLevel:completion:)

Identify users whose face templates match the given face template

Declaration

Swift

@available(*, message: "Introduced in 3.4.0")
@objc
public func identifyUsers(in faceTemplate: FaceTemplate, securityLevel: VerIDSecurityLevel = .normal, completion: @escaping StringArrayCallback)

Parameters

`faceTemplate`	Face template to which to compare user face templates
`securityLevel`	Security level to use on the authentication
`completion`	Block invoked on completion. The block’s string array parameter contains identifiers for users whose faces are similar to the supplied face template.


                    
                    
                    identifyUsers(in:similarityThreshold:)

Identify users whose face templates match the given face template

Declaration

Swift

@available(*, deprecated, message: "Use identifyUsers(in:securityLevel:﹚ instead")
@objc
public func identifyUsers(in faceTemplate: FaceTemplate, similarityThreshold: NSNumber) throws -> [String]

Parameters

`faceTemplate`	Face template to which to compare user face templates
`similarityThreshold`	alue between `0.0` and `1.0` or `nil` to use a default value of `0.5`

Return Value

Identifiers for users whose face templates’ distance to the given template is greater than the similarity threshold


                    
                    
                    identifyUsers(in:similarityThreshold:completion:)

Identify users whose face templates match the given face template

Declaration

Swift

@available(*, deprecated, message: "Deprecated in 3.4.0, use identifyUsers(in:securityLevel:completion:﹚ instead")
@objc
public func identifyUsers(in faceTemplate: FaceTemplate, similarityThreshold: NSNumber, completion: @escaping StringArrayCallback)

Parameters

`faceTemplate`	Face template to which to compare user face templates
`similarityThreshold`	Value between `0.0` and `1.0` or `nil` to use a default value of `0.5`
`completion`	Block invoked on completion. The block’s string array parameter contains identifiers for users whose face templates’ distance to the given template is greater than the similarity threshold.


                    
                    
                    compareFaceTemplate(_:to:)

Compare a face template to templates of a given user

Declaration

Swift

@objc
public func compareFaceTemplate(_ faceTemplate: FaceTemplate, to user: String) throws -> NSNumber

Parameters

`faceTemplate`	Face template to compare
`user`	User to whose face templates the given face template will be compared to

Return Value

Similarity score ranging from 0.0 (no similarity) to 1.0 (same)


                    
                    
                    compareFaceTemplate(_:to:completion:)

Compare a face template to templates of a given user

Declaration

Swift

@objc
public func compareFaceTemplate(_ faceTemplate: FaceTemplate, to user: String, completion: @escaping NumberCallback)

Parameters

`faceTemplate`	Face template to compare
`user`	User to whose face templates the given face template will be compared to
`completion`	Block invoked on completion. The block’s number parameter is a similarity score ranging from `0.0` (no similarity) to `1.0` (same).


                    
                    
                    removeUser(_:)

Remove user record and its associated face templates

Declaration

Swift

@objc
public func removeUser(_ id: String) throws

Parameters

`id`	User identifier


                    
                    
                    removeUser(_:completion:)

Remove user record and its associated face templates

Declaration

Swift

@objc
public func removeUser(_ id: String, completion: @escaping ErrorCallback)

Parameters

`id`	User identifier
`completion`	Block invoked on completion


                    
                    
                    removeUsers(_:)

Remove user records and their associated face templates

Declaration

Swift

@objc
public func removeUsers(_ ids: [String]) throws

Parameters

ids

User identifiers


                    
                    
                    removeUsers(_:completion:)

Remove user records and their associated face templates

Declaration

Swift

@objc
public func removeUsers(_ ids: [String], completion: @escaping ErrorCallback)

Parameters

`ids`	User identifiers
`completion`	Block to invoke on completion


                    
                    
                    exportFaceTemplates()

Export all face templates

Declaration

Swift

@objc
public func exportFaceTemplates() throws -> UserFaceTemplates

Return Value

Dictionary of face template arrays keyed by user identifiers


                    
                    
                    exportFaceTemplates(_:)

Export all face templates

Declaration

Swift

@objc
public func exportFaceTemplates(_ completion: @escaping FaceTemplateDictionaryCallback)

Parameters


                                completion

Block invoked on completion. The block’s dictionary contains arrays of face templates keyed by user identifiers.


                    
                    
                    importFaceTemplates(_:)

Import face templates

Note

If the user exists templates will be appended to the user record

Declaration

Swift

@objc
public func importFaceTemplates(_ faceTemplates: UserFaceTemplates) throws

Parameters


                                faceTemplates

Dictionary of face template arrays keyed by user identifiers to import


                    
                    
                    importFaceTemplates(_:completion:)

Import face templates

Note

If the user exists templates will be appended to the user record

Declaration

Swift

@objc
public func importFaceTemplates(_ faceTemplates: UserFaceTemplates, completion: @escaping ErrorCallback)

Parameters

`faceTemplates`	Dictionary of face template arrays keyed by user identifiers to import
`completion`	Block invoked on completion