Class DataSourceController

The DataSourceController is responsible for all communication regarding data source. Methods inside this controller can be called by window.SDK.dataSource.{method-name}

A data source is a data connector selected to be used in the document. Only one data source can be defined per template, this controller manages this data source.

Hierarchy

DataSourceController

Index

Methods

getDataSource removeDataSource setDataRow setDataSource

Methods

getDataSource

getDataSource(): Promise<EditorResponse<ConnectorInstance>>
Gets the data source.

Returns
the connector object

Returns Promise<EditorResponse<ConnectorInstance>>
- Defined in src/controllers/DataSourceController.ts:45

removeDataSource

removeDataSource(): Promise<EditorResponse<null>>
Removes the data source if defined.

Returns

Returns Promise<EditorResponse<null>>
- Defined in src/controllers/DataSourceController.ts:54

setDataRow

setDataRow(dataRow: DataItem): Promise<EditorResponse<null>>
Maps the data row values to variables by names (data row keys). Variables must exist.

Returns
Parameters
- dataRow: DataItem
  
  DataItem to set
Returns Promise<EditorResponse<null>>
- Defined in src/controllers/DataSourceController.ts:65

setDataSource

setDataSource(connectorId: string): Promise<EditorResponse<null>>
Sets the data source by id.

Returns
Parameters
- connectorId: string
  
  the id of your data connector
Returns Promise<EditorResponse<null>>
- Defined in src/controllers/DataSourceController.ts:36

Generated using TypeDoc