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

#include <RemoteTransactionDelegate.h>

Inherits <NSObject>.

Public Types

enum  RemoteTransactionSuccessSessionState { RemoteTransactionSuccessSessionStateAccepted , RemoteTransactionSuccessSessionStateRefused }
 
enum  RemoteTransactionSessionOutdatedReason { RemoteTransactionSessionExpired , RemoteTransactionSessionAccepted , RemoteTransactionSessionRefused , RemoteTransactionSessionUnknown }
 

Instance Methods

(void) - onRemoteTransactionForOrchestrationUser:dataToDisplay:caller:
 
(void) - onRemoteTransactionStepCompleteWithCommand:
 
(void) - onRemoteTransactionSuccessWithState:
 
(void) - onRemoteTransactionSessionOutdated:
 
(void) - onRemoteTransactionAborted
 
(void) - onRemoteTransactionPasswordError:
 

Detailed Description

The RemoteTransactionDelegate interface defines the specific elements required for the integrator to interact during the Remote Transaction Validation flow.

This flow is initiated by the server; it is started by a call to OrchestrationProtocol#execute:(NSString *) with the command provided by the server.

A RemoteTransactionDelegate object should be provided to the Orchestrator object (See OrchestrationProtocol#setRemoteTransactionDelegate(RemoteTransactionDelegate)) in order to receive feedback during the remote transaction validation process.

Member Enumeration Documentation

◆ RemoteTransactionSessionOutdatedReason

The RemoteTransactionSessionOutdatedReason lists possible reasons for a session to be outdated.

Enumerator
RemoteTransactionSessionExpired 
RemoteTransactionSessionAccepted 
RemoteTransactionSessionRefused 
RemoteTransactionSessionUnknown 

◆ RemoteTransactionSuccessSessionState

The RemoteTransactionSuccessSessionState lists possible session states after a remote transaction success.

Enumerator
RemoteTransactionSuccessSessionStateAccepted 
RemoteTransactionSuccessSessionStateRefused 

Method Documentation

◆ onRemoteTransactionAborted

- (void) onRemoteTransactionAborted

Called upon remote transaction validation abortion

◆ onRemoteTransactionForOrchestrationUser:dataToDisplay:caller:

- (void) onRemoteTransactionForOrchestrationUser: (OrchestrationUser *) user
dataToDisplay: (NSString *) dataToDisplay
caller: (id< RemoteTransactionDisplayDataCallerDelegate >) caller 

Called when the Orchestration SDK needs the RemoteTransactionDelegate object to display data to the user for approval.

Parameters
dataToDisplaythe data to display
callera RemoteTransactionDisplayDataCallerDelegate object to use upon user's response
userthe user currently being authenticated

◆ onRemoteTransactionPasswordError:

- (void) onRemoteTransactionPasswordError: (PasswordError *) error

Called when an error occurred during the remote transaction process

Parameters
errorpassword error

◆ onRemoteTransactionSessionOutdated:

- (void) onRemoteTransactionSessionOutdated: (RemoteTransactionSessionOutdatedReason) reason

Called upon remote transaction session outdated

◆ onRemoteTransactionStepCompleteWithCommand:

- (void) onRemoteTransactionStepCompleteWithCommand: (NSString *) command

Called when a step of the remote transaction validation process is complete. The provided orchestration command is to be sent to the server.

Parameters
commandan orchestration command that must be sent to the server

◆ onRemoteTransactionSuccessWithState:

- (void) onRemoteTransactionSuccessWithState: (RemoteTransactionSuccessSessionState) state

Called upon remote transaction validation success

Parameters
statethe end state of the session.

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