Class IDV

Entry point of the Regula IDV.

Index

Accessors

logLevel sessionRestoreMode instance

Methods

configureWithApiKey configureWithCredentials configureWithToken deinitialize getCurrentSessionId getWorkflows initialize prepareWorkflow sendData setListener startLogin startSession startWorkflow

Accessors

logLevel

set logLevel(value: Set<IdvLogLevel>): void
Default: empty set.
Parameters
- value: Set<IdvLogLevel>
Returns void
- Defined in index.d.ts:41

sessionRestoreMode

set sessionRestoreMode(value: SessionRestoreMode): void
Parameters
- value: SessionRestoreMode
Returns void
- Defined in index.d.ts:38

`Static`instance

get instance(): IDV
The only instance of singleton class IDV.

Returns IDV
- Defined in index.d.ts:33

Methods

configureWithApiKey

configureWithApiKey(
config: ApiKeyConnectionConfig,
): Promise<[boolean, string | null]>
Parameters
- config: ApiKeyConnectionConfig
Returns Promise<[boolean, string | null]>
- Defined in index.d.ts:53

configureWithCredentials

configureWithCredentials(
config: CredentialsConnectionConfig,
): Promise<[boolean, string | null]>
Parameters
- config: CredentialsConnectionConfig
Returns Promise<[boolean, string | null]>
- Defined in index.d.ts:51

configureWithToken

configureWithToken(
config: TokenConnectionConfig,
): Promise<[string[] | null, string | null]>
Parameters
- config: TokenConnectionConfig
Returns Promise<[string[] | null, string | null]>
- Defined in index.d.ts:49

deinitialize

deinitialize(): Promise<[boolean, string | null]>
Returns Promise<[boolean, string | null]>
- Defined in index.d.ts:47

getCurrentSessionId

getCurrentSessionId(): Promise<string | null>
Returns Promise<string | null>
- Defined in index.d.ts:43

getWorkflows

getWorkflows(): Promise<[Workflow[] | null, string | null]>
Returns Promise<[Workflow[] | null, string | null]>
- Defined in index.d.ts:59

initialize

initialize(): Promise<[boolean, string | null]>
Returns Promise<[boolean, string | null]>
- Defined in index.d.ts:45

prepareWorkflow

prepareWorkflow(
config: PrepareWorkflowConfig,
): Promise<[Workflow | null, string | null]>
Parameters
- config: PrepareWorkflowConfig
Returns Promise<[Workflow | null, string | null]>
- Defined in index.d.ts:55

sendData

sendData(config: SendDataConfig): Promise<[boolean, string | null]>
Parameters
- config: SendDataConfig
Returns Promise<[boolean, string | null]>
- Defined in index.d.ts:63

setListener

setListener(options?: IDVListenerOptions): void
Parameters
- Optionaloptions: IDVListenerOptions
Returns void
- Defined in index.d.ts:36

startLogin

startLogin(config: LoginConfig): Promise<[boolean, string | null]>
Parameters
- config: LoginConfig
Returns Promise<[boolean, string | null]>
- Defined in index.d.ts:65

startSession

startSession(
config: StartSessionConfig,
): Promise<[string | null, string | null]>
Parameters
- config: StartSessionConfig
Returns Promise<[string | null, string | null]>
- Defined in index.d.ts:61

startWorkflow

startWorkflow(
config?: StartWorkflowConfig,
): Promise<[WorkflowResult | null, string | null]>
Parameters
- Optionalconfig: StartWorkflowConfig
Returns Promise<[WorkflowResult | null, string | null]>
- Defined in index.d.ts:57