Function: makeDynamicSyncTable()

makeDynamicSyncTable<K, L, ParamDefsT, SchemaT, ContextT, PermissionsContextT>(__namedParameters): DynamicSyncTableDef<K, L, ParamDefsT, any, ContextT, PermissionsContextT>

Defined in: api.ts:2776

Creates a dynamic sync table definition.

Example

coda.makeDynamicSyncTable({
  name: "MySyncTable",
  getName: async function(context) => {
    const response = await context.fetcher.fetch({method: "GET", url: context.sync.dynamicUrl});
    return response.body.name;
  },
  getName: async function(context) => {
    const response = await context.fetcher.fetch({method: "GET", url: context.sync.dynamicUrl});
    return response.body.browserLink;
  },
  ...
});

Type Parameters

Type Parameter
K extends string
L extends string
ParamDefsT extends ParamDefs
SchemaT extends ObjectSchemaDefinition<K, L>
ContextT extends SyncExecutionContext<any, any, any>
PermissionsContextT extends SyncPassthroughData

Parameters

Parameter	Type
__namedParameters	{ connectionRequirement?: ConnectionRequirement; defaultAddDynamicColumns?: boolean; description?: string; displayName?: string; entityName?: string; formula: FormulaOptions<ParamDefsT, SyncFormulaDef<K, L, ParamDefsT, any, ContextT, PermissionsContextT>>; getDisplayUrl: MetadataFormulaDef<ContextT>; getName: MetadataFormulaDef<ContextT>; getSchema: MetadataFormulaDef<ContextT>; identityName: string; listDynamicUrls?: MetadataFormulaDef<ExecutionContext, LegacyDefaultMetadataReturnType>; name: string; placeholderSchema?: SchemaT; propertyOptions?: PropertyOptionsMetadataFunction<any>; searchDynamicUrls?: MetadataFormulaDef<ExecutionContext, LegacyDefaultMetadataReturnType>; }
__namedParameters.connectionRequirement?	ConnectionRequirement
__namedParameters.defaultAddDynamicColumns?	boolean
__namedParameters.description?	string
__namedParameters.displayName?	string
__namedParameters.entityName?	string
__namedParameters.formula	FormulaOptions<ParamDefsT, SyncFormulaDef<K, L, ParamDefsT, any, ContextT, PermissionsContextT>>
__namedParameters.getDisplayUrl	MetadataFormulaDef<ContextT>
__namedParameters.getName	MetadataFormulaDef<ContextT>
__namedParameters.getSchema	MetadataFormulaDef<ContextT>
__namedParameters.identityName	string
__namedParameters.listDynamicUrls?	MetadataFormulaDef<ExecutionContext, LegacyDefaultMetadataReturnType>
__namedParameters.name	string
__namedParameters.placeholderSchema?	SchemaT
__namedParameters.propertyOptions?	PropertyOptionsMetadataFunction<any>
__namedParameters.searchDynamicUrls?	MetadataFormulaDef<ExecutionContext, LegacyDefaultMetadataReturnType>

Returns

DynamicSyncTableDef<K, L, ParamDefsT, any, ContextT, PermissionsContextT>