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 *)challengeParameters
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 *)challengeParameters
userClient |
user client performing authentication |
|---|---|
challenge |
fingerprint challenge used to complete authentication |
Declared In
ONGAuthenticationDelegate.h
– userClient:didReceiveFIDOChallenge:
Method called when authentication action requires FIDO authentication to continue. Its called before asking user for authentication using FIDO. If its not implemented SDK will continue automatically.
- (void)userClient:(ONGUserClient *)userClient didReceiveFIDOChallenge:(ONGFIDOChallenge *)challengeParameters
userClient |
user client performing authentication |
|---|---|
challenge |
FIDO challenge used to complete authentication |
Declared In
ONGAuthenticationDelegate.h
– userClient:didStartAuthenticationForUser:
Method called when authentication action is started.
- (void)userClient:(ONGUserClient *)userClient didStartAuthenticationForUser:(ONGUserProfile *)userProfileParameters
userClient |
user client performing authentication |
|---|---|
userProfile |
currently authenticated user profile |
Declared In
ONGAuthenticationDelegate.h
– userClient:didAuthenticateUser:
Method called when authentication action is completed with success.
- (void)userClient:(ONGUserClient *)userClient didAuthenticateUser:(ONGUserProfile *)userProfileParameters
userClient |
user client performing authentication |
|---|---|
userProfile |
successfully authenticated user profile |
Declared In
ONGAuthenticationDelegate.h
– userClient:didFailToAuthenticateUser:error:
Method called when authentication action failed with error.
- (void)userClient:(ONGUserClient *)userClient didFailToAuthenticateUser:(ONGUserProfile *)userProfile error:(NSError *)errorParameters
userClient |
user client performing authentication |
|---|---|
userProfile |
user profile for which authentication failed |
error |
error describing cause of an error |
Discussion
The returned error will be either within the ONGGenericErrorDomain, ONGAuthenticationErrorDomain.
Declared In
ONGAuthenticationDelegate.h