# Interface: LinkSchema

Defined in: [schema.ts:598](https://github.com/coda/packs-sdk/blob/b2b4c9dba5ca748bdbb94481cc13b5ca3c328ef6/schema.ts#L598)

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`](../../enumerations/ValueHintType/#url)>

## Properties

### codaType

> **codaType**: [`Url`](../../enumerations/ValueHintType/#url)

Defined in: [schema.ts:600](https://github.com/coda/packs-sdk/blob/b2b4c9dba5ca748bdbb94481cc13b5ca3c328ef6/schema.ts#L600)

Instructs Coda to render this value as a hyperlink.

#### Overrides

`BaseStringSchema.codaType`

______________________________________________________________________

### description?

> `optional` **description**: `string`

Defined in: [schema.ts:285](https://github.com/coda/packs-sdk/blob/b2b4c9dba5ca748bdbb94481cc13b5ca3c328ef6/schema.ts#L285)

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?

> `optional` **display**: [`LinkDisplayType`](../../enumerations/LinkDisplayType/)

Defined in: [schema.ts:602](https://github.com/coda/packs-sdk/blob/b2b4c9dba5ca748bdbb94481cc13b5ca3c328ef6/schema.ts#L602)

How the URL should be displayed in the UI.

______________________________________________________________________

### force?

> `optional` **force**: `boolean`

Defined in: [schema.ts:604](https://github.com/coda/packs-sdk/blob/b2b4c9dba5ca748bdbb94481cc13b5ca3c328ef6/schema.ts#L604)

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

______________________________________________________________________

### type

> **type**: [`String`](../../enumerations/ValueType/#string)

Defined in: [schema.ts:807](https://github.com/coda/packs-sdk/blob/b2b4c9dba5ca748bdbb94481cc13b5ca3c328ef6/schema.ts#L807)

Identifies this schema as a string.

#### Inherited from

`BaseStringSchema.type`