This holds all the contextual information about a give data action.
Constructors
new DataConnectorActionContext()
new DataConnectorActionContext(
packageId,
packageVersion,
userCredential,
dataConnectorName,
installationId,
documentCollections,
updateFilterType,
timezone): DataConnectorActionContext
Parameters
Parameter | Type | Description |
---|---|---|
packageId | string | The package ID of the extension that triggered this action |
packageVersion | string | The version of the extension that triggered this action |
userCredential | string | The authorized OAuth2 credential that Lucid has for the 3rd party this extension works with |
dataConnectorName | string | The data connector name from manifest.json that triggered this action |
installationId | undefined | string | The installation id of the extension/user that triggered this action |
documentCollections | object | Set of items this document is tracking as a Record<CollectionId, ItemPrimaryKey[]> |
updateFilterType | DataUpdateFilterType | Update filter type for this document |
timezone | undefined | null | string | User timezone to ensure we properly account for any offsets |
Returns
Properties
dataConnectorName
dataConnectorName: string;
The data connector name from manifest.json that triggered this action
documentCollections
documentCollections: object;
Set of items this document is tracking as a Record<CollectionId, ItemPrimaryKey[]>
Index signature
[collectionId
: CollectionId
]: ItemPrimaryKey
[]
installationId
installationId: undefined | string;
The installation id of the extension/user that triggered this action
packageId
readonly packageId: string;
The package ID of the extension that triggered this action
packageVersion
packageVersion: string;
The version of the extension that triggered this action
timezone
timezone: undefined | null | string;
User timezone to ensure we properly account for any offsets
updateFilterType
updateFilterType: DataUpdateFilterType;
Update filter type for this document
userCredential
userCredential: string;
The authorized OAuth2 credential that Lucid has for the 3rd party this extension works with