![]() |
Orchestration SDK 5.10.1
|
#include <OrchestrationProtocol.h>
Inherits <NSObject>.
Instance Methods | |
(void) | - execute: |
(void) | - startActivation: |
(void) | - startNotificationRegistration: |
(void) | - startChangePassword: |
(void) | - startLocalAuthentication: |
(void) | - startLocalTransaction: |
(id< UserManagerProtocol >) | - userManager |
(id< CDDCDataFeederProtocol >) | - cddcDataFeeder |
(NSString *_Nullable) | - cddcMessage:error: |
(void) | - setRemoteAuthenticationDelegate: |
(void) | - setRemoteTransactionDelegate: |
(void) | - setUserAuthenticationDelegate:forUserAuthenticationTypes: |
(void) | - setErrorDelegate: |
(void) | - setWarningDelegate: |
The OrchestrationProtocol
protocol is the entry point of the Orchestration SDK. It allows the execution of orchestration commands providing seamless two-factor authentication.
You can create an orchestrator using the internal class OrchestratorBuilder
. This builder will provide you with the minimal required configuration for the orchestrator.
Subsequent configurations can be done during the lifecycle of the OrchestrationProtocol
object by using the related setters.
In order to provision the SDK with a DIGIPASS instance, a call to startActivation:(ActivationParams*)
must be performed.
In order to provision the SDK with a DIGIPASS instance, a call to startNotificationRegistration:(NotificationRegistrationParams*)
must be performed.
All subsequent orchestration commands transmission shall be done through the execute:(NSString *)
method.
- (id< CDDCDataFeederProtocol >) cddcDataFeeder |
Provides a CDDCDataFeederProtocol
object that allows integrator to set CDDC data values .
CDDCDataFeederProtocol
object - (NSString *_Nullable) cddcMessage: | (CDDCMessageParams *) | cddcMessageParams | |
error: | (NSError **) | error |
Generate a CDDC Message object
cddcMessageParams | CDDCMessageParams object |
error | a NSError raised if there is an error during the process. |
- (void) execute: | (NSString *) | command |
Executes an Orchestration Command provided by the server.
command | the Orchestration Command provided by the server, as an hexadecimal string. |
- (void) setErrorDelegate: | (id< OrchestrationErrorDelegate >) | orchestrationErrorDelegate |
Sets the delegate called when errors happen.
- (void) setRemoteAuthenticationDelegate: | (id< RemoteAuthenticationDelegate >) | remoteAuthenticationDelegate |
Sets the delegate to be notified about remote authentication events.
- (void) setRemoteTransactionDelegate: | (id< RemoteTransactionDelegate >) | remoteTransactionDelegate |
Sets the delegate to be notified about remote transaction validation events.
- (void) setUserAuthenticationDelegate: | (id< UserAuthenticationDelegate >) | userAuthenticationDelegate | |
forUserAuthenticationTypes: | (NSArray< NSNumber * > *) | types |
Sets the UserAuthenticationDelegate
to override the way a user authentication will be displayed.
userAuthenticationDelegate | a UserAuthenticationDelegate object |
types | a list of UserAuthenticationType , the types of user authentication that will be overridden |
- (void) setWarningDelegate: | (id< OrchestrationWarningDelegate >) | orchestrationWarningDelegate |
Sets the delegate called when warnings happen.
- (void) startActivation: | (ActivationParams *) | activationParams |
Starts the activation process.
- (void) startChangePassword: | (ChangePasswordParams *) | changePasswordParams |
Starts change password flow.
- (void) startLocalAuthentication: | (LocalAuthenticationParams *) | localAuthenticationParams |
Starts a local authentication process. This method is used to generate a one-time password using a specified protection type and an optional challenge.
- (void) startLocalTransaction: | (LocalTransactionParams *) | localTransactionParams |
Starts a local transaction process. This method is used to generate a signature from specified data fields and using a specified protection type.
localTransactionParams | a LocalTransactionParams object |
- (void) startNotificationRegistration: | (NotificationRegistrationParams *) | notificationRegistrationParams |
Starts registering for push notifications.
- (id< UserManagerProtocol >) userManager |
Provides a UserManagerProtocol
object that allows manipulation of users and DIGIPASSes.
UserManagerProtocol
object