Interface: LinkSchema¶
Defined in: schema.ts:598
A schema representing a return value or object property that is a hyperlink.
The link can be displayed in the UI in multiple ways, as per the above enumeration.
Extends¶
BaseStringSchema<Url>
Properties¶
codaType¶
codaType:
Url
Defined in: schema.ts:600
Instructs Coda to render this value as a hyperlink.
Overrides¶
BaseStringSchema.codaType
description?¶
optionaldescription:string
Defined in: schema.ts:285
A explanation of this object schema property shown to the user in the UI.
If your pack has an object schema with many properties, it may be useful to explain the purpose or contents of any property that is not self-evident.
Inherited from¶
BaseStringSchema.description
display?¶
optionaldisplay:LinkDisplayType
Defined in: schema.ts:602
How the URL should be displayed in the UI.
force?¶
optionalforce:boolean
Defined in: schema.ts:604
Whether to force client embedding (only for LinkDisplayType.Embed) - for example, if user login required.
type¶
type:
String
Defined in: schema.ts:807
Identifies this schema as a string.
Inherited from¶
BaseStringSchema.type