ONGAuthenticatorRegistrationDelegate Protocol Reference
Conforms to | NSObject |
---|---|
Declared in | ONGAuthenticatorRegistrationDelegate.h |
Overview
Protocol describing interface for objects implementing methods required to register authenticator. All invocations are performed on the main queue.
– userClient:didStartRegisteringAuthenticator:forUser:
Method called when authenticator registration is started.
- (void)userClient:(ONGUserClient *)userClient didStartRegisteringAuthenticator:(ONGAuthenticator *)authenticator forUser:(ONGUserProfile *)userProfile
Parameters
userClient |
user client performing authenticator registration |
---|---|
authenticator |
authenticator being registered |
userProfile |
user profile for which authenticator registration is started |
Declared In
ONGAuthenticatorRegistrationDelegate.h
– userClient:didRegisterAuthenticator:forUser:info:
Method called when authenticator registration is completed with success.
- (void)userClient:(ONGUserClient *)userClient didRegisterAuthenticator:(ONGAuthenticator *)authenticator forUser:(ONGUserProfile *)userProfile info:(ONGCustomInfo *_Nullable)customAuthInfo
Parameters
userClient |
user client performing authenticator registration |
---|---|
authenticator |
registered authenticator |
userProfile |
user profile for which authenticator was registered |
customAuthInfo |
custom authenticator info about response from extension engine |
Declared In
ONGAuthenticatorRegistrationDelegate.h
– userClient:didFailToRegisterAuthenticator:forUser:error:
Method called when authenticator registration failed with an error.
- (void)userClient:(ONGUserClient *)userClient didFailToRegisterAuthenticator:(ONGAuthenticator *)authenticator forUser:(ONGUserProfile *)userProfile error:(NSError *)error
Parameters
userClient |
user client performing authenticator registration |
---|---|
authenticator |
authenticator whose registration failed |
userProfile |
user profile for which authenticator registration 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, ONGAuthenticatorRegistrationErrorDomain or ONGAuthenticationErrorDomain.
Declared In
ONGAuthenticatorRegistrationDelegate.h
– userClient:didReceivePinChallenge:
Method called when authenticator registration requires PIN code to continue.
- (void)userClient:(ONGUserClient *)userClient didReceivePinChallenge:(ONGPinChallenge *)challenge
Parameters
userClient |
user client performing authenticator registration |
---|---|
challenge |
pin challenge used to complete registration |
Declared In
ONGAuthenticatorRegistrationDelegate.h
– userClient:didReceiveCustomAuthFinishRegistrationChallenge:
Method called when custom authenticator registration requires data to continue.
- (void)userClient:(ONGUserClient *)userClient didReceiveCustomAuthFinishRegistrationChallenge:(ONGCustomAuthFinishRegistrationChallenge *)challenge
Parameters
userClient |
user client performing authenticator registration |
---|---|
challenge |
challenge used to complete registration |
Declared In
ONGAuthenticatorRegistrationDelegate.h