Interface: ExecutionContext¶

Defined in: api_types.ts:1196

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

Extended by¶

Properties¶

endpoint?¶

readonly optional endpoint: string

Defined in: api_types.ts:1214

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.

fetcher¶

readonly fetcher: Fetcher

Defined in: api_types.ts:1200

The core.Fetcher used for making HTTP requests.

invocationLocation¶

readonly invocationLocation: InvocationLocation

Defined in: api_types.ts:1219

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.

invocationToken¶

readonly invocationToken: string

Defined in: api_types.ts:1230

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.

previousAttemptError?¶

readonly optional previousAttemptError: InvocationError

Defined in: api_types.ts:1254

If this invocation is a retry, this will be populated with information about what went wrong during the previous attempt. If an error occurs while indexing a sync table, it will retried again later. This field is only applicable for sync tables used within Superhuman Go agents.

sync?¶

readonly optional sync: Sync<unknown, unknown, unknown>

Defined in: api_types.ts:1234

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

temporaryBlobStorage¶

readonly temporaryBlobStorage: TemporaryBlobStorage

Defined in: api_types.ts:1205

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.

timezone¶

readonly timezone: string

Defined in: api_types.ts:1223

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