Class ConfigurationAuthCloudBuilder`Abstract`

A simplified builder that can be used to configure an SDK when your application works with the Nevis Authentication Cloud. With this builder, you do not need to provide the relative paths of the endpoints for each operation.

Hierarchy

ConfigurationAuthCloudBuilder

Index

Methods

hostname authenticationMaxRetries authenticationRetryIntervalInSeconds networkTimeoutInSeconds userInteractionTimeoutInSeconds facetId build

Methods

`Abstract` hostname

hostname(hostname): ConfigurationAuthCloudBuilder
Sets the hostname of your Nevis Authentication Cloud.
Parameters
- hostname: string
  
  the of your Nevis Authentication Cloud.
Returns ConfigurationAuthCloudBuilder
a builder.

`Abstract` authenticationMaxRetries

authenticationMaxRetries(authenticationMaxRetries): ConfigurationAuthCloudBuilder
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 ConfigurationAuthCloudBuilder
a builder.

`Abstract` authenticationRetryIntervalInSeconds

authenticationRetryIntervalInSeconds(authenticationRetryIntervalInSeconds): ConfigurationAuthCloudBuilder
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 ConfigurationAuthCloudBuilder
a builder.

`Abstract` networkTimeoutInSeconds

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

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

`Abstract` userInteractionTimeoutInSeconds

userInteractionTimeoutInSeconds(userInteractionTimeoutInSeconds): ConfigurationAuthCloudBuilder
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 ConfigurationAuthCloudBuilder
a builder.

`Abstract` facetId

facetId(facetId): ConfigurationAuthCloudBuilder
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 ConfigurationAuthCloudBuilder
a builder.

`Abstract` build

build(): Configuration
Creates a Configuration.

Returns Configuration
a Configuration.

Generated using TypeDoc