Interface: PropertyOptionsExecutionContext¶
core.PropertyOptionsExecutionContext
Sub-class of SyncExecutionContext that is passed to the options function of
mutable sync tables for properties with options enabled.
Hierarchy¶
↳ PropertyOptionsExecutionContext
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.
Inherited from¶
Defined in¶
fetcher¶
• Readonly fetcher: Fetcher
The Fetcher used for making HTTP requests.
Inherited from¶
Defined in¶
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.
Inherited from¶
SyncExecutionContext.invocationLocation
Defined in¶
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 Custom for naming template parameters that will be replaced by the fetcher in secure way.
Inherited from¶
SyncExecutionContext.invocationToken
Defined in¶
propertyName¶
• Readonly propertyName: string
Which property is being edited.
Defined in¶
propertySchema¶
• Readonly propertySchema: Object
Schema of the property being edited. See Schema.
Defined in¶
propertyValues¶
• Readonly propertyValues: Object
Current values of other properties from the same row. Non-required properties may be missing if the doc owner elected not to sync them, or if they have a type that's not yet supported for options context. Properties referencing other sync tables may be missing some or all of their sub-properties if the reference is broken because the other table is not added to the doc or hasn't synced the referenced row.
Index signature¶
▪ [propertyValues: string]: any
Defined in¶
search¶
• Readonly search: string
What the user typed. For example, they may have type "Ja" while searching for a user named "Jane".
Defined in¶
sync¶
• Readonly sync: Sync
Information about state of the current sync.
Inherited from¶
Defined in¶
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.
Inherited from¶
SyncExecutionContext.temporaryBlobStorage
Defined in¶
timezone¶
• Readonly timezone: string
The timezone of the doc from which this formula was invoked.