ONGChangePinDelegate Protocol Reference
Conforms to | NSObject |
---|---|
Declared in | ONGChangePinDelegate.h |
Overview
Protocol describing interface for objects implementing methods required to complete change PIN action. All invocations are performed on the main queue.
– userClient:didReceivePinChallenge:
required method
Method called when change PIN action requires authentication with PIN code to continue.
- (void)userClient:(ONGUserClient *)userClient didReceivePinChallenge:(ONGPinChallenge *)challenge
Parameters
userClient |
user client performing authentication for change PIN action |
---|---|
challenge |
pin challenge used to complete authentication for change PIN action |
Declared In
ONGChangePinDelegate.h
– userClient:didReceiveCreatePinChallenge:
required method
Method called when change PIN action requires new PIN code to continue. New PIN must be compliant with PIN policy defined by the token server.
- (void)userClient:(ONGUserClient *)userClient didReceiveCreatePinChallenge:(ONGCreatePinChallenge *)challenge
Parameters
userClient |
user client performing change PIN action |
---|---|
challenge |
pin challenge used to complete change PIN action |
Declared In
ONGChangePinDelegate.h
– userClient:didStartPinChangeForUser:
Method called when change PIN action is started.
- (void)userClient:(ONGUserClient *)userClient didStartPinChangeForUser:(ONGUserProfile *)userProfile
Parameters
userClient |
user client performing change PIN action |
---|---|
userProfile |
user profile for which change PIN action is performed |
Declared In
ONGChangePinDelegate.h
– userClient:didChangePinForUser:
Method called when change PIN action is completed with success.
- (void)userClient:(ONGUserClient *)userClient didChangePinForUser:(ONGUserProfile *)userProfile
Parameters
userClient |
user client performing change PIN action |
---|---|
userProfile |
user profile for which change PIN action succeeded |
Declared In
ONGChangePinDelegate.h
– userClient:didFailToChangePinForUser:error:
Method called when change PIN action failed with an error.
- (void)userClient:(ONGUserClient *)userClient didFailToChangePinForUser:(ONGUserProfile *)userProfile error:(NSError *)error
Parameters
userClient |
user client performing change PIN action |
---|---|
userProfile |
user profile for which change PIN action failed |
error |
error describing cause of an error |
Discussion
The returned error will be either within the ONGGenericErrorDomain, ONGChangePinErrorDomain.
Declared In
ONGChangePinDelegate.h