yxsConversation

来自于：APICloud 官方立即使用

navibarShow setPowerOn setPowerOff cancelPowerOn cancelPowerOff setSysTime screenshot flashControl lockControl

模块概述

yxsConversation 模块封装永兴盛平板通讯协议

模块接口

navibarShow

导航栏隐藏显示控制

navibarShow({params}, callback(ret))

params

show：

• 类型：布尔类型
• 描述：（可选项）是否显示导航栏
• 默认值：true

callback(ret)

ret：

• 类型：JSON 对象
• 内部字段：

{
    status:,                       //布尔类型，接口是否调用正常
}

err：

• 类型：JSON 对象
• 内部字段：

{
    msg: ‘’,           //字符串类型；错误信息
}

示例代码

var yxsConversation = api.require('yxsConversation');
yxsConversation.navibarShow({
    show:false,
}, function(ret, err) {
    if (ret) {
        alert(JSON.stringify(ret));
    } else {
        alert(JSON.stringify(err));
    }
});

可用性

Android系统

可提供的1.0.0及更高版本

setPowerOn

设置开机时间

setPowerOn({params}, callback(ret))

params

date：

• 类型：字符串类型
• 描述：开机时间，格式yyyy-MM-dd HH:mm:ss

callback(ret)

ret：

• 类型：JSON 对象
• 内部字段：

{
    status:,                       //布尔类型，接口是否调用正常
}

err：

• 类型：JSON 对象
• 内部字段：

{
    msg: ‘’,           //字符串类型；错误信息
}

示例代码

var yxsConversation = api.require('yxsConversation');
yxsConversation.setPowerOn({
    date:‘’,
}, function(ret, err) {
    if (ret) {
        alert(JSON.stringify(ret));
    } else {
        alert(JSON.stringify(err));
    }
});

可用性

Android系统

可提供的1.0.0及更高版本

setPowerOff

设置关机时间

setPowerOff({params}, callback(ret))

params

date：

• 类型：字符串类型
• 描述：关机时间，格式yyyy-MM-dd HH:mm:ss

callback(ret)

ret：

• 类型：JSON 对象
• 内部字段：

{
    status:,                       //布尔类型，接口是否调用正常
}

err：

• 类型：JSON 对象
• 内部字段：

{
    msg: ‘’,           //字符串类型；错误信息
}

示例代码

var yxsConversation = api.require('yxsConversation');
yxsConversation.setPowerOff({
    date:‘’,
}, function(ret, err) {
    if (ret) {
        alert(JSON.stringify(ret));
    } else {
        alert(JSON.stringify(err));
    }
});

可用性

Android系统

可提供的1.0.0及更高版本

cancelPowerOn

取消开机时间

cancelPowerOn({params}, callback(ret))

params

callback(ret)

ret：

• 类型：JSON 对象
• 内部字段：

{
    status:,                       //布尔类型，接口是否调用正常
}

err：

• 类型：JSON 对象
• 内部字段：

{
    msg: ‘’,           //字符串类型；错误信息
}

示例代码

var yxsConversation = api.require('yxsConversation');
yxsConversation.cancelPowerOn({
}, function(ret, err) {
    if (ret) {
        alert(JSON.stringify(ret));
    } else {
        alert(JSON.stringify(err));
    }
});

可用性

Android系统

可提供的1.0.0及更高版本

cancelPowerOff

取消关机时间

cancelPowerOff({params}, callback(ret))

params

callback(ret)

ret：

• 类型：JSON 对象
• 内部字段：

{
    status:,                       //布尔类型，接口是否调用正常
}

err：

• 类型：JSON 对象
• 内部字段：

{
    msg: ‘’,           //字符串类型；错误信息
}

示例代码

var yxsConversation = api.require('yxsConversation');
yxsConversation.cancelPowerOff({
}, function(ret, err) {
    if (ret) {
        alert(JSON.stringify(ret));
    } else {
        alert(JSON.stringify(err));
    }
});

可用性

Android系统

可提供的1.0.0及更高版本

setSysTime

设置系统时间

setSysTime({params}, callback(ret))

params

date：

• 类型：字符串类型
• 描述：时间，格式yyyy-MM-dd HH:mm:ss

callback(ret)

ret：

• 类型：JSON 对象
• 内部字段：

{
    status:,                       //布尔类型，接口是否调用正常
}

err：

• 类型：JSON 对象
• 内部字段：

{
    msg: ‘’,           //字符串类型；错误信息
}

示例代码

var yxsConversation = api.require('yxsConversation');
yxsConversation.setSysTime({
    date:‘’,
}, function(ret, err) {
    if (ret) {
        alert(JSON.stringify(ret));
    } else {
        alert(JSON.stringify(err));
    }
});

可用性

Android系统

可提供的1.0.0及更高版本

screenshot

截屏，调用此接口系统会进行截屏，并将照片存放到内置SD卡根目录下/Screenshots文件夹中

screenshot({params}, callback(ret))

params

callback(ret)

ret：

• 类型：JSON 对象
• 内部字段：

{
    status:,                       //布尔类型，接口是否调用正常
}

err：

• 类型：JSON 对象
• 内部字段：

{
    msg: ‘’,           //字符串类型；错误信息
}

示例代码

var yxsConversation = api.require('yxsConversation');
yxsConversation.screenshot({
}, function(ret, err) {
    if (ret) {
        alert(JSON.stringify(ret));
    } else {
        alert(JSON.stringify(err));
    }
});

可用性

Android系统

可提供的1.0.0及更高版本

screenshot

截屏，调用此接口系统会进行截屏，并将照片存放到内置SD卡根目录下/Screenshots文件夹中

screenshot({params}, callback(ret))

params

callback(ret)

ret：

• 类型：JSON 对象
• 内部字段：

{
    status:,                       //布尔类型，接口是否调用正常
}

err：

• 类型：JSON 对象
• 内部字段：

{
    msg: ‘’,           //字符串类型；错误信息
}

示例代码

var yxsConversation = api.require('yxsConversation');
yxsConversation.screenshot({
}, function(ret, err) {
    if (ret) {
        alert(JSON.stringify(ret));
    } else {
        alert(JSON.stringify(err));
    }
});

可用性

Android系统

可提供的1.0.0及更高版本

flashControl

补光灯管理

flashControl({params}, callback(ret))

params

open：

• 类型：布尔类型
• 描述：打开或关闭补光灯
• 默认：true

callback(ret)

ret：

• 类型：JSON 对象
• 内部字段：

{
    status:,                       //布尔类型，接口是否调用正常
}

err：

• 类型：JSON 对象
• 内部字段：

{
    msg: ‘’,           //字符串类型；错误信息
}

示例代码

var yxsConversation = api.require('yxsConversation');
yxsConversation.flashControl({
open:false,
}, function(ret, err) {
    if (ret) {
        alert(JSON.stringify(ret));
    } else {
        alert(JSON.stringify(err));
    }
});

可用性

Android系统

可提供的1.0.0及更高版本

lockControl

开关锁

lockControl({params}, callback(ret))

params

open：

• 类型：布尔类型
• 描述：打开或关闭锁
• 默认：true

callback(ret)

ret：

• 类型：JSON 对象
• 内部字段：

{
    status:,                       //布尔类型，接口是否调用正常
}

err：

• 类型：JSON 对象
• 内部字段：

{
    msg: ‘’,           //字符串类型；错误信息
}

示例代码

var yxsConversation = api.require('yxsConversation');
yxsConversation.lockControl({
open:false,
}, function(ret, err) {
    if (ret) {
        alert(JSON.stringify(ret));
    } else {
        alert(JSON.stringify(err));
    }
});

可用性

Android系统

可提供的1.0.0及更高版本