OutOfBandOperation class Null safety

The operation managing an OutOfBandPayload.

An OutOfBandPayload can be provided through different means:

  • a push notification,
  • a QR code or
  • an application link.

This operation will process the payload, decrypt it if needed and send it to the server. If the payload is successfully handled by the server, then the SDK will identify whether the operation associated with the payload is a registration or an authentication. Depending on that the onRegistration or the onAuthentication will be invoked.

Usage example:

  [...]
  Future<void> authenticateUsingOutOfBandPayload({
    required MobileAuthenticationClient client,
    required OutOfBandPayload payload,
  }) async {
    await client.operations.outOfBandOperation
      .payload(payload)
      .onRegistration((registration) {
        // handle registration
      })
      .onAuthentication((authentication) {
        // handle authentication
      })
      .onError((error) {
        // handle out-of-band error
      })
      .execute();
  }
  [...]
Inheritance

Constructors

OutOfBandOperation()

Properties

hashCode → int
The hash code for this object.
read-onlyinherited
runtimeType → Type
A representation of the runtime type of the object.
read-onlyinherited

Methods

execute() → Future<void>
Executes the operation asynchronously.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed.
inherited
onAuthentication(dynamic onAuthentication(OutOfBandAuthentication)) → OutOfBandOperation
Specifies the object that will handle the OutOfBandAuthentication object associated with the out-of-band payload.
onError(dynamic onError(OutOfBandOperationError)) → OutOfBandOperation
Specifies the object that will be invoked if there was an error handling the OutOfBandPayload: the payload could not be decrypted, the server could not be reached, the server returned an error, etc. The specified object will receive an OutOfBandOperationError.
onRegistration(dynamic onRegistration(OutOfBandRegistration)) → OutOfBandOperation
Specifies the object that will handle the OutOfBandRegistration object associated with the out-of-band payload.
payload(OutOfBandPayload payload) → OutOfBandOperation
Specifies the out-of-band payload to be handled.
requestHeaders(RequestHeaders requestHeaders) → OutOfBandOperation
Specifies the additional request headers that must be included in the HTTP requests sent by the operation.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited