Class ConfigurationBuilder`Abstract`

A builder for Configuration.

Hierarchy

ConfigurationBuilder

Index

Methods

baseUrl registrationRequestPath registrationResponsePath authenticationRequestPath authenticationResponsePath deregistrationRequestPath dispatchTargetResourcePath deviceResourcePath authenticationMaxRetries authenticationRetryIntervalInSeconds networkTimeoutInSeconds userInteractionTimeoutInSeconds facetId build

Methods

`Abstract` baseUrl

baseUrl(baseUrl): ConfigurationBuilder
Sets the base URL.

IMPORTANT
Providing the base URL is required.
Parameters
- baseUrl: string
  
  the base URL.
Returns ConfigurationBuilder
a builder.

`Abstract` registrationRequestPath

registrationRequestPath(registrationRequestPath): ConfigurationBuilder
Sets the registration request URL path.

If not provided, /uaf/1.1/request/registration/ will be used.
Parameters
- registrationRequestPath: string
  
  the registration request path URL.
Returns ConfigurationBuilder
a builder.

`Abstract` registrationResponsePath

registrationResponsePath(registrationResponsePath): ConfigurationBuilder
Sets the registration response path URL.

If not provided, /uaf/1.1/registration/ will be used.
Parameters
- registrationResponsePath: string
  
  the registration response path URL.
Returns ConfigurationBuilder
a builder.

`Abstract` authenticationRequestPath

authenticationRequestPath(authenticationRequestPath): ConfigurationBuilder
Sets the authentication request path URL.

If not provided, /uaf/1.1/request/authentication/ will be used.
Parameters
- authenticationRequestPath: string
  
  the authentication request path URL.
Returns ConfigurationBuilder
a builder.

`Abstract` authenticationResponsePath

authenticationResponsePath(authenticationResponsePath): ConfigurationBuilder
Sets the authentication response path URL.

If not provided, /uaf/1.1/authentication/ will be used.
Parameters
- authenticationResponsePath: string
  
  the authentication response path URL.
Returns ConfigurationBuilder
a builder.

`Abstract` deregistrationRequestPath

deregistrationRequestPath(deregistrationRequestPath): ConfigurationBuilder
Sets the deregistration path URL.

If not provided, /uaf/1.1/request/deregistration/ will be used.
Parameters
- deregistrationRequestPath: string
  
  the deregistration path URL.
Returns ConfigurationBuilder
a builder.

`Abstract` dispatchTargetResourcePath

dispatchTargetResourcePath(dispatchTargetResourcePath): ConfigurationBuilder
Sets the dispatch target resource path URL.

If not provided, /token/dispatch/targets/ will be used.
Parameters
- dispatchTargetResourcePath: string
  
  the dispatch target resource path URL.
Returns ConfigurationBuilder
a builder.

`Abstract` deviceResourcePath

deviceResourcePath(deviceResourcePath): ConfigurationBuilder
The device managing resource URL path.

If not provided, /devices/ will be used.
Parameters
- deviceResourcePath: string
  
  the device managing resource path URL.
Returns ConfigurationBuilder
a builder.

`Abstract` authenticationMaxRetries

authenticationMaxRetries(authenticationMaxRetries): ConfigurationBuilder
Sets the maximum number of retries for authentication.

If not provided, 3 will be used.
Parameters
- authenticationMaxRetries: number
  
  the maximum number of retries for authentication.
Returns ConfigurationBuilder
a builder.

`Abstract` authenticationRetryIntervalInSeconds

authenticationRetryIntervalInSeconds(authenticationRetryIntervalInSeconds): ConfigurationBuilder
Sets the time interval for authentication in seconds.

If not provided, 1 second will be used.
Parameters
- authenticationRetryIntervalInSeconds: number
  
  the time interval for authentication.
Returns ConfigurationBuilder
a builder.

`Abstract` networkTimeoutInSeconds

networkTimeoutInSeconds(networkTimeoutInSeconds): ConfigurationBuilder
Sets the time interval for network timeouts in seconds.

If not provided, 60 seconds will be used.
Parameters
- networkTimeoutInSeconds: number
  
  the network timeout.
Returns ConfigurationBuilder
a builder.

`Abstract` userInteractionTimeoutInSeconds

userInteractionTimeoutInSeconds(userInteractionTimeoutInSeconds): ConfigurationBuilder
Sets the maximum time that the SDK will wait during user interaction to receive the user input.

If not provided, 4 minutes (240 seconds) will be used.
Parameters
- userInteractionTimeoutInSeconds: number
  
  the user interaction timeout in seconds.
Returns ConfigurationBuilder
a builder.

`Abstract` facetId

facetId(facetId): ConfigurationBuilder
Sets the facet ID.

IMPORTANT
This property is Android specific and will be ignored by iOS native plugin.
Parameters
- facetId: string
  
  the facet ID.
Returns ConfigurationBuilder
a builder.

`Abstract` build

build(): Configuration
Creates a Configuration.

Returns Configuration
a Configuration.

Generated using TypeDoc