Interface: DynamicSyncTableOptions<K, L, ParamDefsT, SchemaT>¶
Options provided when defining a dynamic sync table.
Type parameters¶
| Name | Type |
|---|---|
K |
extends string |
L |
extends string |
ParamDefsT |
extends ParamDefs |
SchemaT |
extends ObjectSchemaDefinition<K, L> |
Properties¶
connectionRequirement¶
• Optional connectionRequirement: ConnectionRequirement
A ConnectionRequirement that will be used for all formulas contained within this sync table (including autocomplete formulas).
Defined in¶
description¶
• Optional description: string
The description of the dynamic sync table. This is shown to users in the Coda UI when listing what build blocks are contained within this pack. This should describe what the dynamic sync table does in a more detailed language.
Defined in¶
entityName¶
• Optional entityName: string
A label for the kind of entities that you are syncing. This label is used in a doc to identify
the column in this table that contains the synced data. If you don't provide an entityName, the value
of identity.name from your schema will be used instead, so in most cases you don't need to provide this.
Defined in¶
formula¶
• formula: SyncFormulaDef<K, L, ParamDefsT, SchemaT>
The definition of the formula that implements this sync. This is a Coda packs formula
that returns an array of objects fitting the given schema and optionally a Continuation.
(The SyncFormulaDef.name is redundant and should be the same as the name parameter here.
These will eventually be consolidated.)
Defined in¶
getDisplayUrl¶
• getDisplayUrl: MetadataFormulaDef
A formula that that returns a browser-friendly url representing the
resource being synced. The Coda UI links to this url as the source
of the table data. This is typically a browser-friendly form of the
dynamicUrl, which is typically an API url.
Defined in¶
getName¶
• getName: MetadataFormulaDef
A formula that returns the name of this table.
Defined in¶
getSchema¶
• getSchema: MetadataFormulaDef
A formula that returns the schema for this table.
Defined in¶
listDynamicUrls¶
• Optional listDynamicUrls: MetadataFormulaDef
A formula that returns a list of available dynamic urls that can be used to create an instance of this dynamic sync table.
Defined in¶
name¶
• name: string
The name of the dynamic sync table. This is shown to users in the Coda UI
when listing what build blocks are contained within this pack.
This should describe the category of entities being synced. The actual
table name once added to the doc will be dynamic, it will be whatever value
is returned by the getName formula.