Interface: PackDefinition¶
deprecated use #PackVersionDefinition
The legacy complete definition of a Pack including un-versioned metadata. This should only be used by legacy Coda pack implementations.
Hierarchy¶
↳ PackDefinition
Properties¶
category¶
• Optional category: PackCategory
Defined in¶
defaultAuthentication¶
• Optional defaultAuthentication: Authentication
If specified, the user must provide personal authentication credentials before using the pack.
Inherited from¶
PackVersionDefinition.defaultAuthentication
Defined in¶
description¶
• description: string
Defined in¶
enabledConfigName¶
• Optional enabledConfigName: string
Defined in¶
exampleImages¶
• Optional exampleImages: string[]
Defined in¶
exampleVideoIds¶
• Optional exampleVideoIds: string[]
Defined in¶
formats¶
• Optional formats: Format[]
Definitions of this pack's column formats. See Format.
Inherited from¶
Defined in¶
formulaNamespace¶
• Optional formulaNamespace: string
deprecated
Inherited from¶
PackVersionDefinition.formulaNamespace
Defined in¶
formulas¶
• Optional formulas: PackFormulas | (BooleanPackFormula<ParamDefs> | NumericPackFormula<ParamDefs> | StringPackFormula<ParamDefs> | ObjectPackFormula<ParamDefs, ArraySchema<Schema>> | ObjectPackFormula<ParamDefs, Schema>)[]
Definitions of this pack's formulas. See Formula.
Note that button actions are also defind here. Buttons are simply formulas
with isAction: true.
Note also, this should always be an array of Formulas. The PackFormulas object structure is deprecated and will be removed shortly.
Inherited from¶
PackVersionDefinition.formulas
Defined in¶
id¶
• id: number
Defined in¶
isSystem¶
• Optional isSystem: boolean
Whether this is a pack that will be used by Coda internally and not exposed directly to users.
Defined in¶
logoPath¶
• logoPath: string
Defined in¶
minimumFeatureSet¶
• Optional minimumFeatureSet: FeatureSet
Defined in¶
name¶
• name: string
Defined in¶
networkDomains¶
• Optional networkDomains: string[]
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
Defined in¶
permissionsDescription¶
• Optional permissionsDescription: string
Defined in¶
quotas¶
• Optional quotas: Partial<{ Basic: Quota ; Enterprise: Quota ; Pro: Quota ; Team: Quota }>
Defined in¶
rateLimits¶
• Optional rateLimits: RateLimits
Defined in¶
shortDescription¶
• shortDescription: string
Defined in¶
syncTables¶
• Optional syncTables: SyncTable[]
Definitions of this pack's sync tables. See SyncTable.
Inherited from¶
PackVersionDefinition.syncTables
Defined in¶
systemConnectionAuthentication¶
• Optional systemConnectionAuthentication: SystemAuthentication
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
Defined in¶
version¶
• version: string
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.