#include <RemoteAuthenticationDelegate.h>
Inherits <NSObject>.
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.
◆ 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 | |
◆ onRemoteAuthenticationAborted
- (void) onRemoteAuthenticationAborted |
|
|
|
Called upon remote authentication abortion
◆ onRemoteAuthenticationForOrchestrationUser:dataToDisplay:caller:
◆ onRemoteAuthenticationPasswordError:
- (void) onRemoteAuthenticationPasswordError: |
|
(PasswordError *) | error |
|
Called when an error occurred during the remote authentication process
- Parameters
-
◆ onRemoteAuthenticationSessionOutdated:
Called upon remote authentication session outdated
- Parameters
-
reason | the 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
-
command | an orchestration command that must be sent to the server |
◆ onRemoteAuthenticationSuccessWithState:
Called upon remote authentication success
- Parameters
-
state | the end state of the session. |
The documentation for this protocol was generated from the following file: