Interface: PackDefinition¶
Defined in: types.ts:1589
Deprecated¶
use #PackVersionDefinition
The legacy complete definition of a Pack including un-versioned metadata. This should only be used by legacy Coda pack implementations.
Extends¶
Properties¶
category?¶
optionalcategory:PackCategory
Defined in: types.ts:1595
defaultAuthentication?¶
optionaldefaultAuthentication:Authentication
Defined in: types.ts:1515
If specified, the user must provide personal authentication credentials before using the pack.
Inherited from¶
PackVersionDefinition.defaultAuthentication
description¶
description:
string
Defined in: types.ts:1593
exampleImages?¶
optionalexampleImages:string[]
Defined in: types.ts:1597
exampleVideoIds?¶
optionalexampleVideoIds:string[]
Defined in: types.ts:1598
formats?¶
optionalformats:Format[]
Defined in: types.ts:1556
Definitions of this pack's column formats. See Format.
Inherited from¶
formulaNamespace?¶
optionalformulaNamespace:string
Defined in: types.ts:1544
Deprecated¶
Inherited from¶
PackVersionDefinition.formulaNamespace
formulas?¶
optionalformulas:Formula[]
Defined in: types.ts:1552
Definitions of this pack's formulas. See Formula.
Note that button actions are also defined here. Buttons are simply formulas
with isAction: true.
Inherited from¶
PackVersionDefinition.formulas
id¶
id:
number
Defined in: types.ts:1590
isSystem?¶
optionalisSystem:boolean
Defined in: types.ts:1605
Whether this is a pack that will be used by Coda internally and not exposed directly to users.
logoPath¶
logoPath:
string
Defined in: types.ts:1596
minimumFeatureSet?¶
optionalminimumFeatureSet:FeatureSet
Defined in: types.ts:1599
name¶
name:
string
Defined in: types.ts:1591
networkDomains?¶
optionalnetworkDomains:string[]
Defined in: types.ts:1537
Any domain(s) to which this pack makes fetcher requests. The domains this pack connects to must be declared up front here, both to clearly communicate to users what a pack is capable of connecting to, and for security reasons. These network domains are enforced at execution time: any fetcher request to a domain not listed here will be rejected.
Only one network domain is allowed by default. If your pack has needs to connect to multiple domains contact Coda support for approval.
Inherited from¶
PackVersionDefinition.networkDomains
permissionsDescription?¶
optionalpermissionsDescription:string
Defined in: types.ts:1594
quotas?¶
optionalquotas:Partial<{Basic:Quota;Enterprise:Quota;Pro:Quota;Team:Quota; }>
Defined in: types.ts:1600
rateLimits?¶
optionalrateLimits:RateLimits
Defined in: types.ts:1601
shortDescription¶
shortDescription:
string
Defined in: types.ts:1592
syncTables?¶
optionalsyncTables:SyncTable[]
Defined in: types.ts:1560
Definitions of this pack's sync tables. See SyncTable.
Inherited from¶
PackVersionDefinition.syncTables
systemConnectionAuthentication?¶
optionalsystemConnectionAuthentication:SystemAuthentication
Defined in: types.ts:1520
If specified, this pack requires system credentials to be set up via Coda's admin console in order to work when no explicit connection is specified by the user.
Inherited from¶
PackVersionDefinition.systemConnectionAuthentication
version¶
version:
string
Defined in: types.ts:1511
The semantic version of the pack. This must be valid semantic version of the form 1, 1.2, or 1.2.3.
When uploading a pack version, the semantic version must be greater than any previously uploaded version.