# InputClipboardBinding

`import { InputClipboardBinding } from "destack:input/binding";`

Clipboard binding family.

```ds title="InputClipboardBinding"
export interface InputClipboardBinding {
    hasClipboardText(): Result<boolean, HostError>;
    listClipboardItems(): Result<ClipboardItem[], HostError>;
    readClipboardText(): Result<^string, HostError>;
    readClipboardItemText(itemIndex: uint32, representationIndex: uint32): Result<^string, HostError>;
    readClipboardItemBytes(itemIndex: uint32, representationIndex: uint32): Result<uint8[], HostError>;
    readClipboardItemPath(itemIndex: uint32, representationIndex: uint32): Result<Path, HostError>;
    writeClipboardText(text: &'a readonly string): Result<void, HostError>;
    writeClipboardItems(items: &'a readonly [ClipboardWriteItem]): Result<void, HostError>;
    readClipboardSequence(): Result<uint64, HostError>;
    clearClipboard(): Result<void, HostError>;
}
```

[language/library/src/input/binding/clipboard.ds:100:199](https://github.com/destack-sh/destack/blob/main/language/library/src/input/binding/clipboard.ds#L100-L199)

## Members

### `hasClipboardText(): Result<boolean, HostError>`

Query whether text clipboard payload exists.

### `listClipboardItems(): Result<ClipboardItem[], HostError>`

List clipboard items.

### `readClipboardText(): Result<^string, HostError>`

Read one text clipboard payload.

### `readClipboardItemText(itemIndex: uint32, representationIndex: uint32): Result<^string, HostError>`

Read one clipboard item representation as text.

### `readClipboardItemBytes(itemIndex: uint32, representationIndex: uint32): Result<uint8[], HostError>`

Read one clipboard item representation as bytes.

### `readClipboardItemPath(itemIndex: uint32, representationIndex: uint32): Result<Path, HostError>`

Read one clipboard item representation as a filesystem path.

### `writeClipboardText(text: &'a readonly string): Result<void, HostError>`

Write one text clipboard payload.

### `writeClipboardItems(items: &'a readonly [ClipboardWriteItem]): Result<void, HostError>`

Write clipboard items.

### `readClipboardSequence(): Result<uint64, HostError>`

Read the clipboard sequence number.

### `clearClipboard(): Result<void, HostError>`

Clear clipboard payloads.
