Skip to content

Interface: LinkSchema

core.LinkSchema

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.

Hierarchy

  • BaseStringSchema<Url>

LinkSchema

Properties

codaType

codaType: Url

Instructs Coda to render this value as a hyperlink.

Overrides

BaseStringSchema.codaType

Defined in

schema.ts:507


description

Optional description: string

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

Defined in

schema.ts:210


display

Optional display: LinkDisplayType

How the URL should be displayed in the UI.

Defined in

schema.ts:509


force

Optional force: boolean

Whether to force client embedding (only for LinkDisplayType.Embed) - for example, if user login required.

Defined in

schema.ts:511


type

type: String

Identifies this schema as a string.

Inherited from

BaseStringSchema.type

Defined in

schema.ts:668