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

Class SessionSpec.Builder

java.lang.Object
com.yoti.api.client.docs.session.create.SessionSpec.Builder
Enclosing class:
SessionSpec
public static class SessionSpec.Builder extends Object

  • Method Details

    • withClientSessionTokenTtl

      public SessionSpec.Builder withClientSessionTokenTtl(Integer clientSessionTokenTtl)
      Sets the client session token TTL (time-to-live)
      Parameters:
      clientSessionTokenTtl - the client session token TTL
      Returns:
      the builder

    • withResourcesTtl

      public SessionSpec.Builder withResourcesTtl(Integer resourcesTtl)
      Sets the resources TTL (time-to-live)
      Parameters:
      resourcesTtl - the resources TTL
      Returns:
      the builder

    • withImportToken

      public SessionSpec.Builder withImportToken(ImportTokenPayload importToken)
      Sets the ImportTokenPayload
      Parameters:
      importToken - the ImportTokenPayload
      Returns:
      the builder

    • withUserTrackingId

      public SessionSpec.Builder withUserTrackingId(String userTrackingId)
      Sets the user tracking ID
      Parameters:
      userTrackingId - the user tracking ID
      Returns:
      the builder

    • withNotifications

      public SessionSpec.Builder withNotifications(NotificationConfig notifications)
      Sets the NotificationConfig
      Parameters:
      notifications - the NotificationConfig
      Returns:
      the builder

    • withRequestedCheck

      public SessionSpec.Builder withRequestedCheck(RequestedCheck<?> requestedCheck)
      Adds a RequestedCheck to the list
      Parameters:
      requestedCheck - the RequestedCheck
      Returns:
      the builder

    • withRequestedTask

      public SessionSpec.Builder withRequestedTask(RequestedTask<?> requestedTask)
      Adds a RequestedTask to the list
      Parameters:
      requestedTask - the RequestedTask
      Returns:
      the builder

    • withSdkConfig

      public SessionSpec.Builder withSdkConfig(SdkConfig sdkConfig)
      Sets the SdkConfig
      Parameters:
      sdkConfig - the SdkConfig
      Returns:
      the builder

    • withRequiredDocument

      public SessionSpec.Builder withRequiredDocument(RequiredDocument requiredDocument)
      Adds a RequiredDocument to the list
      Parameters:
      requiredDocument - the RequiredDocument
      Returns:
      the builder

    • withBlockBiometricConsent

      public SessionSpec.Builder withBlockBiometricConsent(boolean blockBiometricConsent)
      Sets whether to block the collection of biometric consent
      Parameters:
      blockBiometricConsent - block collection of biometric consent
      Returns:
      the builder

    • withIbvOptions

      public SessionSpec.Builder withIbvOptions(IbvOptions ibvOptions)
      Sets the options that define if a session will be required to be performed using In-Branch Verification
      Parameters:
      ibvOptions - the IBV options
      Returns:
      the builder

    • withSessionDeadline

      public SessionSpec.Builder withSessionDeadline(ZonedDateTime sessionDeadline)
      Sets the deadline that the session must be completed by.
      Parameters:
      sessionDeadline - the session deadline
      Returns:
      the builder

    • withIdentityProfile

      public SessionSpec.Builder withIdentityProfile(Map<String,Object> identityProfile)
      Sets the Identity Profile Requirements for the session
      Parameters:
      identityProfile - the Identity Profile
      Returns:
      the Builder

    • withSubject

      public SessionSpec.Builder withSubject(Map<String,Object> subject)
      Sets the subject for which the identity assertion will be performed for the session.
      Parameters:
      subject - the subject
      Returns:
      the Builder

    • withResources

      public SessionSpec.Builder withResources(ResourceCreationContainer resources)
      Sets the resources that should be created, when the session is created.
      Parameters:
      resources - the resources
      Returns:
      the Builder

    • withCreateIdentityProfilePreview

      public SessionSpec.Builder withCreateIdentityProfilePreview(boolean createIdentityProfilePreview)
      Sets whether to create the identity profile preview
      Parameters:
      createIdentityProfilePreview - block collection of biometric consent
      Returns:
      the builder

    • build

      public SessionSpec build()
      Builds the SessionSpec based on the values supplied to the builder
      Returns:
      the built SessionSpec