clipBoard

Method
Constant

set

get

setListener

removeListener

概述

clipBoard原生插件封装剪切板的相关功能，可实现向剪切版复制、读取字符串相关操作。

set

设置剪切板内容

set({params}, callback(ret, err))

params

value：

类型：字符串
默认值：无
描述：要复制到剪切板的字符串，可为空，若为空则清空剪切板

callback(ret, err)

ret：

类型：JSON 对象

内部字段：

{
    status://操作成功状态值
}

err：

类型：JSON 对象

内部字段：

{
    msg: ""    //错误描述
}

示例代码

var clipBoard = api.require('clipBoard');
clipBoard.set({
    value: 'test'
}, function(ret, err) {
    if (ret) {
        api.alert({
            msg: JSON.stringify(ret)
        })
    } else {
        api.alert({
            msg: JSON.stringify(err)
        })
    }
});

补充说明

往剪切板复制数据

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

get

获取剪切板中的数据

get(callback(ret, err))

callback(ret, err)

ret：

类型：JSON 对象

内部字段：

{
    value:		//从剪切板获取的字符串
    type:		//数据类型，取值范围见数据类型
}

示例代码

var clipBoard = api.require('clipBoard');
clipBoard.get(function(ret, err) {
    if (ret) {
        api.alert({
            msg: JSON.stringify(ret)
        })
    } else {
        api.alert({
            msg: JSON.stringify(err)
        })
    }
});

补充说明

从剪切板获取值

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

setListener

设置剪切板监听

setListener(callback(ret, err))

callback(ret, err)

ret：

类型：JSON 对象

内部字段：

{
    value：//从剪切板获取的字符串
    type：//数据类型，取值范围见数据类型
}

示例代码

var clipBoard = api.require('clipBoard');
clipBoard.setListener(function(ret, err) {
    if (ret) {
        api.alert({
            msg: JSON.stringify(ret)
        })
    } else {
        api.alert({
            msg: JSON.stringify(err)
        })
    }
});

补充说明

剪切板数据发生变化则触发此函数回调

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

removeListener

移除剪切板监听

removeListener()

示例代码

var clipBoard = api.require('clipBoard');
clipBoard.removeListener();

补充说明

无

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

数据类型

从剪切板获取的字符串的类型。字符串类型

取值范围

email //邮箱地址
phone //手机号码
url //网址
licence_plate_number //车牌号
ip_address //IP地址
string //普通字符串

是否仍需要帮助？请保持联络！

最后更新于 2024/11/18