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

#include <RemoteAuthenticationDelegate.h>

Inherits <NSObject>.

Public Types

enum  RemoteAuthenticationSuccessSessionState { RemoteAuthenticationSuccessSessionStateAccepted , RemoteAuthenticationSuccessSessionStateRefused }
 
enum  RemoteAuthenticationSessionReason { RemoteAuthenticationSessionExpired , RemoteAuthenticationSessionAccepted , RemoteAuthenticationSessionRefused , RemoteAuthenticationSessionUnknown }
 

Instance Methods

(void) - onRemoteAuthenticationForOrchestrationUser:dataToDisplay:caller:
 
(void) - onRemoteAuthenticationStepCompleteWithCommand:
 
(void) - onRemoteAuthenticationSuccessWithState:
 
(void) - onRemoteAuthenticationSessionOutdated:
 
(void) - onRemoteAuthenticationAborted
 
(void) - onRemoteAuthenticationPasswordError:
 

Detailed Description

The RemoteAuthenticationDelegate interface defines the specific elements required for the integrator to interact during the Remote Authentication 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 RemoteAuthenticationDelegate object should be provided to the OrchestrationProtocol object (See OrchestrationProtocol#setRemoteAuthenticationDelegate:(id<RemoteAuthenticationDelegate>)) in order to receive feedback during the remote authentication process.

Member Enumeration Documentation

◆ RemoteAuthenticationSessionReason

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

Enumerator
RemoteAuthenticationSessionExpired 
RemoteAuthenticationSessionAccepted 
RemoteAuthenticationSessionRefused 
RemoteAuthenticationSessionUnknown 

◆ RemoteAuthenticationSuccessSessionState

The RemoteAuthenticationSuccessSessionState lists possible session states after a Remote authentication success.

Enumerator
RemoteAuthenticationSuccessSessionStateAccepted 
RemoteAuthenticationSuccessSessionStateRefused 

Method Documentation

◆ onRemoteAuthenticationAborted

- (void) onRemoteAuthenticationAborted

Called upon remote authentication abortion

◆ onRemoteAuthenticationForOrchestrationUser:dataToDisplay:caller:

- (void) onRemoteAuthenticationForOrchestrationUser: (OrchestrationUser *) user
dataToDisplay: (NSString *) dataToDisplay
caller: (id< RemoteAuthenticationDisplayDataCallerDelegate >) caller 

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

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

◆ onRemoteAuthenticationPasswordError:

- (void) onRemoteAuthenticationPasswordError: (PasswordError *) error

Called when an error occurred during the remote authentication process

Parameters
errorpassword error

◆ onRemoteAuthenticationSessionOutdated:

- (void) onRemoteAuthenticationSessionOutdated: (RemoteAuthenticationSessionReason) reason

Called upon remote authentication session outdated

Parameters
reasonthe reason for the session to be outdated

◆ onRemoteAuthenticationStepCompleteWithCommand:

- (void) onRemoteAuthenticationStepCompleteWithCommand: (NSString *) command

Called when a step of the remote authentication 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

◆ onRemoteAuthenticationSuccessWithState:

- (void) onRemoteAuthenticationSuccessWithState: (RemoteAuthenticationSuccessSessionState) state

Called upon remote authentication success

Parameters
statethe end state of the session.

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