Package com.yoti.api.client.docs.session.create

Class SdkConfig.Builder

java.lang.Object
com.yoti.api.client.docs.session.create.SdkConfig.Builder
Enclosing class:
SdkConfig
public static class SdkConfig.Builder extends Object
Builder to assist in the creation of SdkConfig.

  • Method Details

    • withAllowsCamera

      public SdkConfig.Builder withAllowsCamera()
      Sets the allowed capture method to "CAMERA"
      Returns:
      the builder

    • withAllowsCameraAndUpload

      public SdkConfig.Builder withAllowsCameraAndUpload()
      Sets the allowed capture method to "CAMERA_AND_UPLOAD"
      Returns:
      the builder

    • withAllowedCaptureMethods

      public SdkConfig.Builder withAllowedCaptureMethods(String allowedCaptureMethods)
      Sets the allowed capture method
      Parameters:
      allowedCaptureMethods - the allowed capture method
      Returns:
      the builder

    • withPrimaryColour

      public SdkConfig.Builder withPrimaryColour(String primaryColour)
      Sets the primary colour to be used by the web/native client
      Parameters:
      primaryColour - the primary colour, hexadecimal value e.g. #ff0000
      Returns:
      the builder

    • withSecondaryColour

      public SdkConfig.Builder withSecondaryColour(String secondaryColour)
      Sets the secondary colour to be used by the web/native client (used on the button)
      Parameters:
      secondaryColour - the secondary colour, hexadecimal value e.g. #ff0000
      Returns:
      the builder

    • withFontColour

      public SdkConfig.Builder withFontColour(String fontColour)
      Sets the font colour to be used by the web/native client (used on the button)
      Parameters:
      fontColour - the font colour
      Returns:
      the builder

    • withLocale

      public SdkConfig.Builder withLocale(String locale)
      Sets the language locale used by the web/native client
      Parameters:
      locale - the locale, e.g. "en"
      Returns:
      the builder

    • withPresetIssuingCountry

      public SdkConfig.Builder withPresetIssuingCountry(String presetIssuingCountry)
      Sets the preset issuing country used by the web/native client
      Parameters:
      presetIssuingCountry - the preset issuing country, 3 letter ISO code e.g. GBR
      Returns:
      the builder

    • withSuccessUrl

      public SdkConfig.Builder withSuccessUrl(String successUrl)
      Sets the success URL for the redirect that follows the web/native client uploading documents successfully
      Parameters:
      successUrl - the success URL
      Returns:
      the builder

    • withErrorUrl

      public SdkConfig.Builder withErrorUrl(String errorUrl)
      Sets the error URL for the redirect that follows the web/native client uploading documents unsuccessfully
      Parameters:
      errorUrl - the error URL
      Returns:
      the builder

    • withPrivacyPolicyUrl

      public SdkConfig.Builder withPrivacyPolicyUrl(String privacyPolicyUrl)
      Sets the privacy policy URL
      Parameters:
      privacyPolicyUrl - the privacy policy URL
      Returns:
      the builder

    • withAllowHandoff

      public SdkConfig.Builder withAllowHandoff(boolean allowHandoff)
      Sets if the user is allowed to perform mobile handoff
      Parameters:
      allowHandoff - if mobile handoff is allowed
      Returns:
      the builder

    • withAttemptsConfiguration

      public SdkConfig.Builder withAttemptsConfiguration(AttemptsConfiguration attemptsConfiguration)
      Sets the AttemptsConfiguration for the session
      Parameters:
      attemptsConfiguration - the configuration for retries
      Returns:
      the builder

    • build

      public SdkConfig build()
      Builds the SdkConfig using the values supplied to the builder
      Returns:
      the SdkConfig