ONGAuthenticationDelegate Protocol Reference

Conforms to NSObject
Declared in ONGAuthenticationDelegate.h

Overview

Protocol describing interface for objects implementing methods required to complete authentication. All invocations are performed on the main queue.

– userClient:didReceivePinChallenge: required method

Method called when authentication action requires PIN code to continue.

- (void)userClient:(ONGUserClient *)userClient didReceivePinChallenge:(ONGPinChallenge *)challenge

Parameters

userClient

user client performing authentication
challenge

pin challenge used to complete authentication

Declared In

ONGAuthenticationDelegate.h

– userClient:didReceiveFingerprintChallenge:

Method called when authentication action requires TouchID to continue. Its called before asking user for fingerprint. If its not implemented SDK will continue automatically.

- (void)userClient:(ONGUserClient *)userClient didReceiveFingerprintChallenge:(ONGFingerprintChallenge *)challenge

Parameters

userClient

user client performing authentication
challenge

fingerprint challenge used to complete authentication

Declared In

ONGAuthenticationDelegate.h

– userClient:didReceiveBiometricChallenge:

Method called when authentication action requires TouchID or FaceID to continue. Its called before asking user for fingerprint or face. If its not implemented SDK will continue automatically.

- (void)userClient:(ONGUserClient *)userClient didReceiveBiometricChallenge:(ONGBiometricChallenge *)challenge

Parameters

userClient

user client performing authentication
challenge

biometric challenge used to complete authentication

Declared In

ONGAuthenticationDelegate.h

– userClient:didReceiveCustomAuthFinishAuthenticationChallenge:

Method called when authentication action requires Custom Authenticator data to continue.

- (void)userClient:(ONGUserClient *)userClient didReceiveCustomAuthFinishAuthenticationChallenge:(ONGCustomAuthFinishAuthenticationChallenge *)challenge

Parameters

userClient

user client performing authentication
challenge

Custom Authenticator challenge used to complete authenticator

Declared In

ONGAuthenticationDelegate.h

– userClient:didStartAuthenticationForUser:

Method called when authentication action is started.

- (void)userClient:(ONGUserClient *)userClient didStartAuthenticationForUser:(ONGUserProfile *)userProfile

Parameters

userClient

user client performing authentication
userProfile

currently authenticated user profile

Declared In

ONGAuthenticationDelegate.h

– userClient:didAuthenticateUser:info:

Method called when authentication action is completed with success.

- (void)userClient:(ONGUserClient *)userClient didAuthenticateUser:(ONGUserProfile *)userProfile info:(nullable ONGCustomInfo *)customAuthInfo

Parameters

userClient

user client performing authentication
userProfile

successfully authenticated user profile
customAuthInfo

custom authenticator info about response from extension engine

Declared In

ONGAuthenticationDelegate.h

– userClient:didFailToAuthenticateUser:error:

Method called when authentication action failed with error.

- (void)userClient:(ONGUserClient *)userClient didFailToAuthenticateUser:(ONGUserProfile *)userProfile error:(NSError *)error

Parameters

userClient

user client performing authentication
userProfile

user profile for which authentication failed
error

error describing cause of an error. This error might include the ONGCustomInfo object into userInfo under the ONGCustomAuthInfoKey.

Discussion

The returned error will be either within the ONGGenericErrorDomain, ONGAuthenticationErrorDomain.

Declared In

ONGAuthenticationDelegate.h