DataConnectorActionContext

This holds all the contextual information about a give data action.

---

Constructors

new DataConnectorActionContext()

ts

new DataConnectorActionContext(
   packageId, 
   packageVersion, 
   userCredential, 
   dataConnectorName, 
   installationId, 
   documentCollections, 
   updateFilterType, 
   userId?, 
   accountId?, 
   documentId?, 
   collectionProperties?): 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	DocumentCollections	Set of items this document is tracking as a Record<CollectionId, ItemPrimaryKey[]>
updateFilterType	DataUpdateFilterType	Update filter type for this document
userId?	number	The Lucid user ID that triggered this action
accountId?	number	The Lucid account ID associated with this action
documentId?	string	The Lucid document ID where this action occurred
collectionProperties?	CollectionProperties	Per-collection property snapshot for the document. Empty when the host did not send any. See CollectionProperties.

Returns

DataConnectorActionContext

---

Properties

accountId?

ts

optional accountId: number;

The Lucid account ID associated with this action

---

collectionProperties

ts

collectionProperties: CollectionProperties = {};

Per-collection property snapshot for the document. Empty when the host did not send any. See
CollectionProperties.

---

dataConnectorName

ts

dataConnectorName: string;

The data connector name from manifest.json that triggered this action

---

documentCollections

ts

documentCollections: DocumentCollections;

Set of items this document is tracking as a Record<CollectionId, ItemPrimaryKey[]>

---

documentId?

ts

optional documentId: string;

The Lucid document ID where this action occurred

---

installationId

ts

installationId: undefined | string;

The installation id of the extension/user that triggered this action

---

packageId

ts

readonly packageId: string;

The package ID of the extension that triggered this action

---

packageVersion

ts

packageVersion: string;

The version of the extension that triggered this action

---

updateFilterType

ts

updateFilterType: DataUpdateFilterType;

Update filter type for this document

---

userCredential

ts

userCredential: string;

The authorized OAuth2 credential that Lucid has for the 3rd party this extension works with

---

userId?

ts

optional userId: number;

The Lucid user ID that triggered this action