> For the complete documentation index, see [llms.txt](https://developers-apps-in-toss.toss.im/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developers-apps-in-toss.toss.im/documentation/api-and-sdk-zh/sdk/domains-api/clipboard/clipboard.gettext.md).

# Clipboard.getText

> 函数式 API `getClipboardText`也可以这样使用同样的功能。

### 功能说明

获取保存在剪贴板中的文本。如果剪贴板中没有文本，则返回空字符串。

如果没有剪贴板读取权限， `GetClipboardTextPermissionError`会发生。 `Clipboard.getText.getPermission()`来确认权限状态，并且 `Clipboard.getText.openPermissionDialog()`可以重新请求权限。

### 类型

```ts
Clipboard.getText(): Promise<string>;
```

**Params**

无

**Response**

返回保存在剪贴板中的文本。如果没有文本，则为空字符串。

### 错误

错误会以类的形式抛出 — `error instanceof GetClipboardTextPermissionError`来识别。该类可在 `@apps-in-toss/web-framework`中导入。

| 错误类                               | 说明                                                                 |
| --------------------------------- | ------------------------------------------------------------------ |
| `GetClipboardTextPermissionError` | 这是剪贴板读取权限被拒绝的情况。 `Clipboard.getText.openPermissionDialog()`可以重新请求。 |

### 示例代码

#### JavaScript

```js
import {
  Clipboard,
  GetClipboardTextPermissionError,
} from "@apps-in-toss/web-framework";

try {
  const text = await Clipboard.getText();
  console.log(text);
} catch (error) {
  if (error instanceof GetClipboardTextPermissionError) {
    console.warn("没有剪贴板读取权限。");
    return;
  }
  console.error(error);
}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://developers-apps-in-toss.toss.im/documentation/api-and-sdk-zh/sdk/domains-api/clipboard/clipboard.gettext.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `build a script that syncs our docs to a CMS` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.