Class DataManager

Hierarchy

default
- DataManager

Index

Constructors

constructor

Methods

getFormDefinition searchRecords

Constructors

constructor

new DataManager(options: ConstructorOptions): DataManager

Parameters

options: ConstructorOptions

Returns DataManager

Example

import * as OneBlink from '@oneblink/sdk'
  const options = {
    accessKey: '123455678901ABCDEFGHIJKL',
    secretKey: '123455678901ABCDEFGHIJKL123455678901ABCDEFGHIJKL',
  }
  const dataManager = new OneBlink.DataManager(options)

Methods

getFormDefinition

getFormDefinition(id: number): Promise<FormStoreDefinition>
Submission Data Key Supported

Key must be assigned to the form that submission data is being requested for.

Minimum Role Permission

Submission Data: Read Only
Parameters
- id: number
  The form ID to get the definition for.
Returns Promise<FormStoreDefinition>
Example
```
const { formId, formElements } = await dataManager.getFormDefinition(2)
```

searchRecords

searchRecords(
options: SearchDataManagerRecordsOptions,
): Promise<SearchDataManagerRecordsResponse>
Submission Data Key Supported

Key must be assigned to the form that is being requested.

Minimum Role Permission

Submission Data: Read Only
Parameters
- options: SearchDataManagerRecordsOptions
  The options for the Search Request
Returns Promise<SearchDataManagerRecordsResponse>
Example
```
const { submissions, meta } = await dataManager.searchRecords({
    formId: 1,
  })
  // Use data here...
```

Class DataManager

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns DataManager

Example

Methods

getFormDefinition

Parameters

Returns Promise<FormStoreDefinition>

Example

searchRecords

Parameters

Returns Promise<SearchDataManagerRecordsResponse>

Example

Settings

On This Page