剪贴板

需要设置权限

getClipboardText在使用之前，需要先设置剪贴板权限。请先查看权限设置指南。

---

1. 获取剪贴板文本

SDK 函数： getClipboardText

这是一个读取保存在剪贴板中的文本的函数。

签名

function getClipboardText(): Promise<string>;

返回值

• Promise<string>

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

权限方法

• getClipboardText.getPermission

  返回剪贴板读取权限的当前状态。 allowed · denied · notDetermined · osPermissionDenied 之一。
• getClipboardText.openPermissionDialog

  显示重新请求剪贴板读取权限的对话框。如果允许， allowed，拒绝时 denied则返回。

错误

当权限被拒绝时 GetClipboardTextPermissionError会发生。 error instanceof GetClipboardTextPermissionError即可确认。

class GetClipboardTextPermissionError extends PermissionError {
  constructor();
}

示例

Web（JS）

import { getClipboardText, GetClipboardTextPermissionError } from '@apps-in-toss/web-framework';

async function handleGetClipboardText() {
  try {
    const clipboardText = await getClipboardText();
    console.log('剪贴板文本:', clipboardText || '剪贴板中没有文本。');
  } catch (error) {
    if (error instanceof GetClipboardTextPermissionError) {
      console.log('没有剪贴板读取权限');
    }
  }
}

Web（React）

import { getClipboardText, GetClipboardTextPermissionError } from '@apps-in-toss/web-framework';
import { useState } from 'react';

function PasteButton() {
  const [text, setText] = useState('');

  const handlePress = async () => {
    try {
      const clipboardText = await getClipboardText();
      setText(clipboardText || '剪贴板中没有文本。');
    } catch (error) {
      if (error instanceof GetClipboardTextPermissionError) {
        // 没有剪贴板读取权限
      }
    }
  };

  return (
    <div>
      <span>{text}</span>
      <input type="button" value="粘贴" onClick={handlePress} />
      <input
        type="button"
        value="检查权限"
        onClick={async () => {
          const permission = await getClipboardText.getPermission();
          alert(permission);
        }}
      />
      <input
        type="button"
        value="请求权限"
        onClick={async () => {
          const permission = await getClipboardText.openPermissionDialog();
          alert(permission);
        }}
      />

  );
}

React Native

import { getClipboardText, GetClipboardTextPermissionError } from '@apps-in-toss/framework';
import { useState } from 'react';
import { Alert, Button, Text, View } from 'react-native';

function PasteButton() {
  const [text, setText] = useState('');

  const handlePress = async () => {
    try {
      const clipboardText = await getClipboardText();
      setText(clipboardText || '剪贴板中没有文本。');
    } catch (error) {
      if (error instanceof GetClipboardTextPermissionError) {
        // 没有剪贴板读取权限
      }
    }
  };

  return (
    <View>
      <Text>{text}</Text>
      <Button title="粘贴" onPress={handlePress} />
      <Button
        title="检查权限"
        onPress={async () => {
          const permission = await getClipboardText.getPermission();
          Alert.alert(permission);
        }}
      />
      <Button
        title="请求权限"
        onPress={async () => {
          const permission = await getClipboardText.openPermissionDialog();
          Alert.alert(permission);
        }}
      />
    </View>
  );
}

---

2. 复制剪贴板文本

SDK 函数： setClipboardText

这是一个将文本复制到剪贴板的函数。用户可以将其粘贴到其他地方。

签名

function setClipboardText(text: string): Promise<void>;

参数

• text · 必填 · string

  这是要复制到剪贴板的文本。

权限方法

• setClipboardText.getPermission

  返回剪贴板写入权限的当前状态。 allowed · denied · notDetermined · osPermissionDenied 之一。
• setClipboardText.openPermissionDialog

  显示重新请求剪贴板写入权限的对话框。如果允许， allowed，拒绝时 denied则返回。

错误

当权限被拒绝时 SetClipboardTextPermissionError会发生。 error instanceof SetClipboardTextPermissionError即可确认。

class SetClipboardTextPermissionError extends PermissionError {
  constructor();
}

示例

Web（JS）

import { setClipboardText, SetClipboardTextPermissionError } from '@apps-in-toss/web-framework';

async function handleSetClipboardText() {
  try {
    await setClipboardText('要复制的文本');
    console.log('文本已复制！');
  } catch (error) {
    if (error instanceof SetClipboardTextPermissionError) {
      console.log('没有剪贴板写入权限');
    }
  }
}

Web（React）

import { setClipboardText, SetClipboardTextPermissionError } from '@apps-in-toss/web-framework';

function CopyButton() {
  const handleCopy = async () => {
    try {
      await setClipboardText('要复制的文本');
      console.log('文本已复制！');
    } catch (error) {
      if (error instanceof SetClipboardTextPermissionError) {
        // 没有剪贴板写入权限
      }
    }
  };

  return (
    <>
      <input type="button" value="复制" onClick={handleCopy} />
      <input
        type="button"
        value="检查权限"
        onClick={async () => {
          const permission = await setClipboardText.getPermission();
          alert(permission);
        }}
      />
      <input
        type="button"
        value="请求权限"
        onClick={async () => {
          const permission = await setClipboardText.openPermissionDialog();
          alert(permission);
        }}
      />
    </>
  );
}

React Native

import { setClipboardText, SetClipboardTextPermissionError } from '@apps-in-toss/framework';
import { Alert, Button } from 'react-native';

function CopyButton() {
  const handleCopy = async () => {
    try {
      await setClipboardText('要复制的文本');
      console.log('文本已复制！');
    } catch (error) {
      if (error instanceof SetClipboardTextPermissionError) {
        // 没有剪贴板写入权限
      }
    }
  };

  return (
    <>
      <Button title="复制" onPress={handleCopy} />
      <Button
        title="检查权限"
        onPress={async () => {
          const permission = await setClipboardText.getPermission();
          Alert.alert(permission);
        }}
      />
      <Button
        title="请求权限"
        onPress={async () => {
          const permission = await setClipboardText.openPermissionDialog();
          Alert.alert(permission);
        }}
      />
    </>
  );
}