Skip to content

Interface: SyncExecutionContext<SyncContinuationT, IncrementalCheckpointContinuationT, IncrementalSyncContinuationT>

Defined in: api_types.ts:1171

Sub-class of ExecutionContext that is passed to the execute function of every sync formula invocation. The only different is that the presence of the sync property

Extends

Extended by

Type Parameters

Type Parameter Default type
SyncContinuationT Continuation
IncrementalCheckpointContinuationT SyncContinuationT
IncrementalSyncContinuationT SyncContinuationT

Properties

endpoint?

readonly optional endpoint: string

Defined in: api_types.ts:1122

The base endpoint URL for the user's account, only if applicable. See core.BaseAuthentication.requiresEndpointUrl.

If the API URLs are variable based on the user account, you will need this endpoint to construct URLs to use with the fetcher. Alternatively, you can use relative URLs (e.g. "/api/entity") and Coda will include the endpoint for you automatically.

Inherited from

ExecutionContext.endpoint


fetcher

readonly fetcher: Fetcher

Defined in: api_types.ts:1108

The core.Fetcher used for making HTTP requests.

Inherited from

ExecutionContext.fetcher


invocationLocation

readonly invocationLocation: InvocationLocation

Defined in: api_types.ts:1127

Information about the Coda environment and doc this formula was invoked from. This is mostly for Coda internal use and we do not recommend relying on it.

Inherited from

ExecutionContext.invocationLocation


invocationToken

readonly invocationToken: string

Defined in: api_types.ts:1138

A random token scoped to only this request invocation. This is a unique identifier for the invocation, and in particular used with core.AuthenticationType.Custom for naming template parameters that will be replaced by the fetcher in secure way.

Inherited from

ExecutionContext.invocationToken


sync

readonly sync: Sync<SyncContinuationT, IncrementalCheckpointContinuationT, IncrementalSyncContinuationT>

Defined in: api_types.ts:1179

Information about state of the current sync.

Overrides

ExecutionContext.sync


temporaryBlobStorage

readonly temporaryBlobStorage: TemporaryBlobStorage

Defined in: api_types.ts:1113

A utility to fetch and store files and images that either require the pack user's authentication or are too large to return inline. See core.TemporaryBlobStorage.

Inherited from

ExecutionContext.temporaryBlobStorage


timezone

readonly timezone: string

Defined in: api_types.ts:1131

The timezone of the doc from which this formula was invoked.

Inherited from

ExecutionContext.timezone