业务
设置内容到粘贴板
使用说明
| 客户端 | Android | iOS | PC |
|---|---|---|---|
| 支持说明 | 支持 | 支持 | / |
const params = {
text:'text'
};
window.ksoxz_sdk.setClipboard({params});参数说明
| 参数 | 类型 | 描述 | 备注 |
|---|---|---|---|
| text | string | 文本 | / |
分享
使用说明
| 客户端 | Android | iOS | PC |
|---|---|---|---|
| 支持说明 | 支持 | 支持 | 支持 |
const params = {
type: 'webPage',
content: {
title: '金山软件欢迎你加入',
url: 'https://www.kingsoft.com/',
text: '描述内容xxx',
image: 'https://bkimg.cdn.bcebos.com/pic/810a19d8bc3eb1352ac7091eac1ea8d3fd1f4416?x-bce-process=image/watermark,image_d2F0ZXIvYmFpa2UxMTY=,g_7,xp_5,yp_5/format,f_auto'
}
};
window.ksoxz_sdk.shareMessage({params, onSuccess, onError});参数说明
| 参数 | 类型 | 描述 | 是否必须 | 备注 |
|---|---|---|---|---|
| type | string | 分享类型 | 是 | / |
| content | object | 分享内容 | 是 | / |
| channelType | string[] | 分享平台 | 否 | 4.25新增 不填默认分享至协作平台 目前支持填入[wx] |
| channelObject | object | 需要分享的JSON数据 | 否 | 4.25 新增 分享至第三方平台时需要填充的数据，填写方法详见参考 |
type
| 类型 | 描述 | 备注 |
|---|---|---|
| text | 纯文本消息 | / |
| markdown | Markdown | / |
| webPage | 链接分享 | / |
| miniProgram | 小程序 | 4.25新增 目前只支持分享去微信平台 |
content 类型
Text:
| 参数 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
| text | string | 是 | 分享描述文本 |
Markdown:
| 参数 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
| text | string | 是 | 分享描述文本 |
WebPage:
| 参数 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
| url | string | 是 | 分享的 url |
| title | string | 是 | 分享标题 |
| image | string | 否 | 分享配图 url，缺省使用 app 图标 |
| text | string | 否 | 分享描述文本 |
channelObject 类型
text:
| 参数 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
| channelObject | object | 否 | 例子：详见下方示例代码（参考） |
miniProgram:
| 参数 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
| channelObject | object | 否 | 例子：详见下方示例代码（参考） 注意: 如果使用前端转换工具将图片转成base64编码时，可能会在base64编码开头携带图片格式信息(例如:data:image/png;base64,)。对于这种情况，需要在为image参数赋值时去掉图片格式信息。 |
WebPage:
| 参数 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
| channelObject | object | 否 | 例子：详见下方示例代码（参考） 注意: 如果使用前端转换工具将图片转成base64编码时，可能会在base64编码开头携带图片格式信息(例如:data:image/png;base64,)。对于这种情况，需要在为image参数赋值时去掉图片格式信息。 |
示例代码（参考）
| channelObject 类型 | 示例代码 |
|---|---|
| text | json |
| WebPage | json thumbImage 为分享的图片的 Base64 编码。 |
| miniProgram | json thumbImage 为分享的图片的 Base64 编码。 |
返回结果
| 参数 | 类型 | 描述 | 备注 |
|---|---|---|---|
| users | Array<user> | 用户集合 | user 返回的字段见下表 |
| failList | Array<user> | 发送失败用户集合 | user 返回的字段见下表 |
user：
| 参数 | 类型 | 描述 | 备注 |
|---|---|---|---|
| avatar | string | 头像地址 | / |
| name | string | 名字 | / |
| userid | number | 用户 id | / |
| chatid | number | 会话 id | / |
| mtype | mumber | 成员类型 | company: 0, // 企业成员 team: 1, // 团队成员 collaborators: 2, // 协作者 contacts: 3, // 我的联系人 recent: 4, // 最近联系人 groupMembers: 5, // 分组成员 dept: 6, // 企业部门，部门当做一种特殊的成员 |
扫码
使用说明
| 客户端 | Android | iOS | PC |
|---|---|---|---|
| 支持说明 | 支持 | 支持 | / |
const params = {
needResult:1
}
window.ksoxz_sdk.scan({onSuccess, onError});参数说明
| 参数 | 类型 | 是否必须 | 描述 | 备注 |
|---|---|---|---|---|
| needResult | number | 是 | 是否需要回传扫码结果 | 1:需要,由调用者处理扫码结果 0:不需要,由原生处理扫码结果 |
| scanType | string[] | 否 | 扫码类型 | 扫码类型： barCode：一维码 qrCode：QrCode 码 datamatrix: Data Matrix 码 pdf417: PDF417 码 支持传入多个类型 默认值：["barCode","qrCode","datamatrix","pdf417"] |
| barCodeInput | boolean | 否 | 是否支持手动输入条形码 | true：支持 false：不支持 默认值：false |
| onlyFromCamera | boolean | 否 | 是否只能从相机扫码，不允许从相册选择图片 | true：只允许相机扫码 false：允许从相册扫码 默认值：false |
返回结果
| 参数 | 类型 | 是否必须 | 描述 | 备注 |
|---|---|---|---|---|
| text | string | 是 | 二维码包含的文本内容 | / |
| scanType | string | 否 | 识别到的图形码的类型 | 一维码： CODE_39，CODE_93，CODE_128，EAN_8，EAN_13，ITF，UPC_E 二维码： QR_CODE，DATA_MATRIX，PDF_417 其它： USER_INPUT |
获取应用信息
使用说明
| 客户端 | Android | iOS | PC |
|---|---|---|---|
| 支持说明 | 支持 | 支持 | 支持 |
window.ksoxz_sdk.getWebAppInfo({ onSuccess, onError});返回结果
| 参数 | 类型 | 是否必须 | 描述 | 备注 |
|---|---|---|---|---|
| icon | string | 是 | 应用的 icon | / |
| name | string | 是 | 名称 | / |
| appId | string | 是 | 应用 id | / |
| desc | string | 是 | 描述 | 有描述则返回描述，没有则为空 |
获取用户信息
使用说明
| 客户端 | Android | iOS | PC |
|---|---|---|---|
| 支持说明 | 支持 | 支持 | 支持 |
window.ksoxz_sdk.getUserInfo({ onSuccess, onError});返回结果
| 参数 | 类型 | 描述 | 备注 |
|---|---|---|---|
| userInfo | object | 用户信息 | / |
| ∟ name | string | 用户名 | / |
| ∟ avatar | string | 用户头像 | / |
| ∟ phone | string | 电话 | / |
| ∟ corpId | string | 企业ID | / |
| ∟ corpUserId | string | 企业用户ID | / |
| ∟ userId | string | WPS用户ID | / |
| ∟ xzUserId | string | 协作用户ID | / |
| ∟ thirdUnionId | string | 通过通讯录接口同步的第三方企业用户id | / |
错误码
| errno | msg | 含义 |
|---|---|---|
| 1002005 | User not granted webApp userInfo permission | 用户未授予网页应用用户信息权限 |
| 1043001 | Network connection failed | 网络连接失败 |
| 1043102 | Server api error | 服务端接口错误 |
启动摇一摇
使用说明
| 客户端 | Android | iOS | PC |
|---|---|---|---|
| 支持说明 | 支持 | 支持 | / |
const params = {
sensitivity:'3.5',
frequency: '50',
callbackInterval: '3000',
};
window.ksoxz_sdk.accelerometerWatchShake({param, onSuccess, onError});参数说明
| 参数 | 类型 | 是否必须 | 描述 | 备注 |
|---|---|---|---|---|
| sensitivity | number | 是 | 振动幅度（m/s²），加速度变化超过这个值后触发 shake。 | 推荐值：3.5 |
| frequency | number | 是 | 采样间隔(毫秒)，指每隔多长时间对加速度进行一次采样， 然后对比前后变化，判断是否触发 shake。 | 最大值取决于设备，建议该值不超过 80 |
| callbackInterval | number | 是 | 两次『摇一摇』的时间间隔(毫秒)。触发『摇一摇』后，在该时间间隔内，不再触发摇一摇 | \ |
停止摇一摇
使用说明
| 客户端 | Android | iOS | PC |
|---|---|---|---|
| 支持说明 | 支持 | 支持 | / |
window.ksoxz_sdk.accelerometerClearShake();