Package com.onfido

Class Onfido.Builder

  • Enclosing class:
    Onfido
    public static final class Onfido.Builder
extends Object
    The Builder for the Onfido object.

    • Field Detail

      • apiToken

        public String apiToken
        The Api token.

      • apiUrl

        public String apiUrl
        The Api url.

    • Method Detail

      • build

        public Onfido build()
        Builds the Onfido object instance.
        Returns:
        the Onfido

      • apiToken

        public Onfido.Builder apiToken​(String apiToken)
        Api token attribute.
        Parameters:
        apiToken - the api token
        Returns:
        the builder

      • clientInterceptor

        @Deprecated
public Onfido.Builder clientInterceptor​(okhttp3.Interceptor interceptor)
        Deprecated.
        Use clientInterceptors(List) instead.
        Interceptor attribute.
        Parameters:
        interceptor - the HTTP interceptor
        Returns:
        the builder

      • clientInterceptors

        public Onfido.Builder clientInterceptors​(List<okhttp3.Interceptor> interceptors)
        Interceptors attribute.
        Parameters:
        interceptors - the HTTP interceptors that will be used to configure the HttpClient
        Returns:
        the builder

      • clientReadTimeout

        public Onfido.Builder clientReadTimeout​(java.time.Duration readTimeout)
        The read timeout duration that will be used to configure the HttpClient
        Parameters:
        readTimeout - the readTimeout
        Returns:
        the builder

      • clientProxy

        public Onfido.Builder clientProxy​(Proxy proxy)
        The proxy that will be used to configure the HttpClient with
        Parameters:
        proxy - the proxy
        Returns:
        the proxy

      • regionEU

        public Onfido.Builder regionEU()
        Sets the object to use the EU region base URL.
        Returns:
        the builder

      • regionUS

        public Onfido.Builder regionUS()
        Sets the object to use the US region base URL.
        Returns:
        the builder

      • regionCA

        public Onfido.Builder regionCA()
        Sets the object to use the Canada region base URL.
        Returns:
        the builder

      • unknownApiUrl

        public Onfido.Builder unknownApiUrl​(String url)
        Sets the object to use the specified URL for the api. Used for testing.
        Parameters:
        url - the url
        Returns:
        the builder

      • sslSocketFactory

        public Onfido.Builder sslSocketFactory​(SSLSocketFactory sslSocketFactory,
                                       X509TrustManager x509TrustManager)
        The ssl socket factory and the X509 trust manager that will be used to configure the HttpClient
        Parameters:
        sslSocketFactory - the ssl socket factory
        x509TrustManager - the X509 trust manager - a system one will be used on a null value
        Returns:
        the builder