Package ch.nevis.auth.fido.uaf.sdk.dispatcher

Interface DispatchContext.MobileSdkOutOfBandPayloadBuilder

Enclosing interface:
DispatchContext
public static interface DispatchContext.MobileSdkOutOfBandPayloadBuilder
An object that can be used to build an out-of-band payload that can be consumed by the Nevis Mobile Authentication SDK.

  • Method Details

    • redeemUrl

      DispatchContext.MobileSdkOutOfBandPayloadBuilder redeemUrl(URI redeemUrl)
      The redeem URL that must be included in the out-of-band payload. This is required by the Nevis Mobile Authentication SDK to know which is the URL that must be used to redeem the token.

      In the case of the out-of-the box dispatchers of nevisFIDO, this is obtained from the nevisfido.yml file by implementing the Configurable interface.

      Providing the redeem URL is required.

      Parameters:
      redeemUrl - the redeem URL.
      Returns:
      a MobileSdkOutOfBandPayloadBuilder

    • data

      DispatchContext.MobileSdkOutOfBandPayloadBuilder data(@Nullable String data)
      The additional data that can be included as part of the out-of-band payload. This data can be retrieved by the client using the SDK through OutOfBandPayload.datajava swift objc flutter react native.

      Providing this data is optional.

      Parameters:
      data - the additional data to be included in the out-of-band payload.
      Returns:
      a MobileSdkOutOfBandPayloadBuilder

    • build

      String build() throws DispatchException
      Builds the out-of-band payload, which is a JSON String. This out-of-band payload must be transmitted (for instance through a push notification) to the client, and the client can use it as described in the Mobile Authentication SDK documentation.
      Returns:
      the out-of-band payload that must be dispatched.
      Throws:
      DispatchException - if there is a problem generating the out-of-band payload