Skip to content

Interface: ExecutionContext

An object passed to the execute function of every formula invocation with information and utilities for handling the invocation. In particular, this contains the Fetcher, which is used for making HTTP requests.

Hierarchy

  • ExecutionContext

SyncExecutionContext

Properties

endpoint

Optional Readonly endpoint: string

The base endpoint URL for the user's account, only if applicable. See 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.

Defined in

api_types.ts:595


fetcher

Readonly fetcher: Fetcher

The Fetcher used for making HTTP requests.

Defined in

api_types.ts:582


invocationLocation

Readonly invocationLocation: InvocationLocation

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.

Defined in

api_types.ts:600


invocationToken

Readonly invocationToken: string

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

Defined in

api_types.ts:611


sync

Optional Readonly sync: Sync

Information about state of the current sync. Only populated if this is a sync table formula.

Defined in

api_types.ts:615


temporaryBlobStorage

Readonly temporaryBlobStorage: TemporaryBlobStorage

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 TemporaryBlobStorage.

Defined in

api_types.ts:587


timezone

Readonly timezone: string

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

Defined in

api_types.ts:604