Orchestration SDK 5.10.1
Loading...
Searching...
No Matches
<OrchestrationProtocol> Protocol Reference

#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:
 

Detailed Description

The OrchestrationProtocol protocol is the entry point of the Orchestration SDK. It allows the execution of orchestration commands providing seamless two-factor authentication.

Creation

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.

Provisioning

In order to provision the SDK with a DIGIPASS instance, a call to startActivation:(ActivationParams*) must be performed.

Notification registration

In order to provision the SDK with a DIGIPASS instance, a call to startNotificationRegistration:(NotificationRegistrationParams*) must be performed.

Commands

All subsequent orchestration commands transmission shall be done through the execute:(NSString *) method.

Method Documentation

◆ cddcDataFeeder

- (id< CDDCDataFeederProtocol >) cddcDataFeeder

Provides a CDDCDataFeederProtocol object that allows integrator to set CDDC data values .

Returns
a CDDCDataFeederProtocol object

◆ cddcMessage:error:

- (NSString *_Nullable) cddcMessage: (CDDCMessageParams *) cddcMessageParams
error: (NSError **) error 

Generate a CDDC Message object

Parameters
cddcMessageParamsCDDCMessageParams object
errora NSError raised if there is an error during the process.
Returns
nil if an error occured, or a string with the CDDC data in clear text or encrypted.

◆ execute:

- (void) execute: (NSString *) command

Executes an Orchestration Command provided by the server.

Parameters
commandthe Orchestration Command provided by the server, as an hexadecimal string.

◆ setErrorDelegate:

- (void) setErrorDelegate: (id< OrchestrationErrorDelegate >) orchestrationErrorDelegate

Sets the delegate called when errors happen.

◆ setRemoteAuthenticationDelegate:

- (void) setRemoteAuthenticationDelegate: (id< RemoteAuthenticationDelegate >) remoteAuthenticationDelegate

Sets the delegate to be notified about remote authentication events.

◆ setRemoteTransactionDelegate:

- (void) setRemoteTransactionDelegate: (id< RemoteTransactionDelegate >) remoteTransactionDelegate

Sets the delegate to be notified about remote transaction validation events.

◆ setUserAuthenticationDelegate:forUserAuthenticationTypes:

- (void) setUserAuthenticationDelegate: (id< UserAuthenticationDelegate >) userAuthenticationDelegate
forUserAuthenticationTypes: (NSArray< NSNumber * > *) types 

Sets the UserAuthenticationDelegate to override the way a user authentication will be displayed.

Parameters
userAuthenticationDelegatea UserAuthenticationDelegate object
typesa list of UserAuthenticationType, the types of user authentication that will be overridden

◆ setWarningDelegate:

- (void) setWarningDelegate: (id< OrchestrationWarningDelegate >) orchestrationWarningDelegate

Sets the delegate called when warnings happen.

◆ startActivation:

- (void) startActivation: (ActivationParams *) activationParams

Starts the activation process.

◆ startChangePassword:

- (void) startChangePassword: (ChangePasswordParams *) changePasswordParams

Starts change password flow.

◆ startLocalAuthentication:

- (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.

◆ startLocalTransaction:

- (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.

Parameters
localTransactionParamsa LocalTransactionParams object

◆ startNotificationRegistration:

- (void) startNotificationRegistration: (NotificationRegistrationParams *) notificationRegistrationParams

Starts registering for push notifications.

◆ userManager

- (id< UserManagerProtocol >) userManager

Provides a UserManagerProtocol object that allows manipulation of users and DIGIPASSes.

Returns
a UserManagerProtocol object

The documentation for this protocol was generated from the following file: