uni.getClipboardData(options) @getclipboarddata

展示全部

# uni.getClipboardData(options)

获得系统剪贴板的内容 GitCode GitHub

# getClipboardData 兼容性

Web	微信小程序	Android	iOS	HarmonyOS
4.0	4.41	4.71	4.71	4.61

# 参数

名称

类型

必填

默认值

兼容性

描述

options

GetClipboardDataOptions

是

名称

类型

必备

默认值

兼容性

描述

success

(result: GetClipboardDataSuccess) => void

否

成功返回的回调函数

fail

(result: IClipBoardError) => void

否

失败的回调函数

complete

(result: any) => void

否

结束的回调函数（调用成功、失败都会执行）

# GetClipboardDataSuccess 的属性值

名称

类型

必备

默认值

兼容性

描述

data

string

是

剪贴板的内容

# IClipBoardError 的属性值

名称	类型	必备	默认值	兼容性	描述
errCode	number	是	-	-	-
errSubject	string	是	-	-	统一错误主题（模块）名称
data	any	否	-	-	错误信息中包含的数据
cause	Error	否	-	-	源错误信息，可以包含多个错误，详见SourceError
errMsg	string	是	-	-	-

注意

App（除 HarmonyOS）平台暂未内置，见插件市场
读取剪贴板，在一些新的Android设备上，被列为单独的权限，如没有相关权限，则无法读取剪贴板。
在鸿蒙上，读取剪贴板是一个高敏感权限，较难申请，参考鸿蒙文档

# 参见

# uni.setClipboardData(options)

设置系统剪贴板的内容 GitCode GitHub

# setClipboardData 兼容性

Web	微信小程序	Android	iOS	HarmonyOS
4.0	4.41	4.71	4.71	4.61

# 参数

名称

类型

必填

默认值

兼容性

描述

options

SetClipboardDataOptions

是

名称

类型

必备

默认值

兼容性

描述

data

string

是

需要设置的内容

showToast

boolean

否

是否弹出提示，默认弹出提示

success

(result: SetClipboardDataSuccess) => void

否

成功返回的回调函数

fail

(result: IClipBoardError) => void

否

失败的回调函数

complete

(result: any) => void

否

结束的回调函数（调用成功、失败都会执行）

# IClipBoardError 的属性值

名称	类型	必备	默认值	兼容性	描述
errCode	number	是	-	-	-
errSubject	string	是	-	-	统一错误主题（模块）名称
data	any	否	-	-	错误信息中包含的数据
cause	Error	否	-	-	源错误信息，可以包含多个错误，详见SourceError
errMsg	string	是	-	-	-

# 参见

# 示例

hello uni-app x

Template

Script

<template>
  <view>
    <page-head :title="title"></page-head>
    <view class="uni-padding-wrap">
      <view class="uni-title">请输入剪贴板内容</view>
      <view class="uni-list">
        <view class="uni-list-cell">
          <input class="uni-input" type="text" placeholder="请输入剪贴板内容" :value="data" @input="dataChange" />
        </view>
      </view>
      <view class="uni-btn-v">
        <button type="primary" @click="setClipboard">存储数据</button>
        <button @tap="getClipboard">读取数据</button>
      </view>
    </view>
  </view>
</template>


<style>
</style>