Interface: PropertyOptionsExecutionContext¶
Defined in: api_types.ts:1201
Sub-class of SyncExecutionContext that is passed to the options function of
mutable sync tables for properties with options enabled.
Extends¶
Properties¶
endpoint?¶
readonlyoptionalendpoint: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¶
fetcher¶
readonlyfetcher:Fetcher
Defined in: api_types.ts:1108
The core.Fetcher used for making HTTP requests.
Inherited from¶
invocationLocation¶
readonlyinvocationLocation: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¶
SyncExecutionContext.invocationLocation
invocationToken¶
readonlyinvocationToken: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¶
SyncExecutionContext.invocationToken
propertyName¶
readonlypropertyName:string
Defined in: api_types.ts:1205
Which property is being edited.
propertySchema¶
readonlypropertySchema:Schema&ObjectSchemaProperty
Defined in: api_types.ts:1210
Schema of the property being edited. See Schema.
propertyValues¶
readonlypropertyValues:object
Defined in: api_types.ts:1219
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
search¶
readonlysearch:string
Defined in: api_types.ts:1225
What the user typed. For example, they may have type "Ja" while searching for a user named "Jane".
sync¶
readonlysync:Sync<Continuation,Continuation,Continuation>
Defined in: api_types.ts:1179
Information about state of the current sync.
Inherited from¶
temporaryBlobStorage¶
readonlytemporaryBlobStorage: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¶
SyncExecutionContext.temporaryBlobStorage
timezone¶
readonlytimezone:string
Defined in: api_types.ts:1131
The timezone of the doc from which this formula was invoked.