更新记录

1.0.1（2023-12-11）

--更新文档说明

平台兼容性

原生插件通用使用流程：

1. 购买插件，选择该插件绑定的项目。
2. 在HBuilderX里找到项目，在manifest的app原生插件配置中勾选模块，如需要填写参数则参考插件作者的文档添加。
3. 根据插件作者的提供的文档开发代码，在代码中引用插件，调用插件功能。
4. 打包自定义基座，选择插件，得到自定义基座，然后运行时选择自定义基座，进行log输出测试。
5. 开发完毕后正式云打包

付费原生插件目前不支持离线打包。
Android 离线打包原生插件另见文档 https://nativesupport.dcloud.net.cn/NativePlugin/offline_package/android
iOS 离线打包原生插件另见文档 https://nativesupport.dcloud.net.cn/NativePlugin/offline_package/ios

注意事项：使用HBuilderX2.7.14以下版本，如果同一插件且同一appid下购买并绑定了多个包名，提交云打包界面提示包名绑定不一致时，需要在HBuilderX项目中manifest.json->“App原生插件配置”->”云端插件“列表中删除该插件重新选择

/ Title: saner-wxwork Description: 企业微信授权登录+分享 /

概述

企业微信简介

企业微信分别提供了IOS与Android sdk，企业可在自建的app引入sdk，从而可使用企业微信账号登录app，并且在app中分享消息到企业微信。

wxWork 插件概述

本插件封装了企业微信的原生 SDK，集成了企业微信授权登录、分享等。

插件接口

registerApp

注册/初始化sdk

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

params

appId:

• 类型：字符串
• 描述：（可选项）企业ID。

agentId:

• 类型：字符串
• 描述：（可选项）应用ID。

schema:

• 类型：字符串
• 描述：（可选项）schema。

callback(ret, err)

ret：

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

{
    status: true, //初始化状态
    code: 0, //状态码
    type: 'onSuccess', //事件类型 
    msg: "onSuccess",//描述
    result:{ //其他结果数据

    }
}

示例代码

var wxWork = uni.requireNativePlugin('saner-wxWork');
wxWork.registerApp({
    appId:"",
    agentId:"",
    schema:"",
},function(ret, err) {
    if (ret.status) {
        alert("sdk 初始化成功");
    } else {
        alert('sdk 初始化失败');
    }
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

isAppInstalled

判断是否安装企业微信

isAppInstalled()

params

无

callback(ret, err)

无

示例代码

var wxWork = uni.requireNativePlugin('saner-wxWork');
var status = wxWork.isAppInstalled();

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

auth

授权登录

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

params

state：

• 类型：字符串
• 描述：（选填）自定义参数。

callback(ret, err)

ret：

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

{
    status: true, //初始化状态
    code: 0, //状态码
    type: 'onSuccess', //事件类型 
    msg: "onSuccess",//描述
    result:{ //其他结果数据

    }
}

示例代码

var wxWork = uni.requireNativePlugin('saner-wxWork');
wxWork.auth({
    state:"qiye-work",
}, function(ret, err) {

});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

shareText

分享文本

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

params

content：

• 类型：字符串
• 描述：（必填）分享内容。

callback(ret, err)

ret：

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

{
    status: true, //初始化状态
    code: 0, //状态码
    type: 'onSuccess', //事件类型 
    msg: "onSuccess",//描述
    result:{ //其他结果数据

    }
}

示例代码

var wxWork = uni.requireNativePlugin('saner-wxWork');
wxWork.shareText({
    content:"分享文本内容",
}, function(ret, err) {

});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

shareFile

分享文件

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

params

filename：

• 类型：字符串
• 描述：（必填）文件名称。

path：

• 类型：字符串
• 描述：（必填）文件内容。

callback(ret, err)

ret：

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

{
    status: true, //初始化状态
    code: 0, //状态码
    type: 'onSuccess', //事件类型 
    msg: "onSuccess",//描述
    result:{ //其他结果数据

    }
}

示例代码

var wxWork = uni.requireNativePlugin('saner-wxWork');
var path = plus.io.convertLocalFileSystemURL("_www/static/xxxx");
wxWork.shareFile({
    filename:"",
    path:path
}, function(ret, err) {

});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

shareImage

分享图片

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

params

filename：

• 类型：字符串
• 描述：（必填）文件名称。

path：

• 类型：字符串
• 描述：（必填）文件内容。

callback(ret, err)

ret：

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

{
    status: true, //初始化状态
    code: 0, //状态码
    type: 'onSuccess', //事件类型 
    msg: "onSuccess",//描述
    result:{ //其他结果数据

    }
}

示例代码

var wxWork = uni.requireNativePlugin('saner-wxWork');
var path = plus.io.convertLocalFileSystemURL("_www/static/xxxx");
wxWork.shareImage({
    filename:"",
    path:path
}, function(ret, err) {

});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

shareVideo

分享视频

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

params

filename：

• 类型：字符串
• 描述：（必填）文件名称。

path：

• 类型：字符串
• 描述：（必填）文件内容。

callback(ret, err)

ret：

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

{
    status: true, //初始化状态
    code: 0, //状态码
    type: 'onSuccess', //事件类型 
    msg: "onSuccess",//描述
    result:{ //其他结果数据

    }
}

示例代码

var wxWork = uni.requireNativePlugin('saner-wxWork');
var path = plus.io.convertLocalFileSystemURL("_www/static/xxxx");
wxWork.shareVideo({
    filename:"",
    path:path
}, function(ret, err) {

});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

shareLink

分享链接

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

params

title：

• 类型：字符串
• 描述：（必填）标题。

desc

• 类型：字符串

• 描述：（可选项）描述

  url

  • 类型：字符串
  • 描述：（可选项）链接地址

path：

• 类型：字符串
• 描述：（必填）文件内容

callback(ret, err)

ret：

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

{
    status: true, //初始化状态
    code: 0, //状态码
    type: 'onSuccess', //事件类型 
    msg: "onSuccess",//描述
    result:{ //其他结果数据

    }
}

示例代码

var wxWork = uni.requireNativePlugin('saner-wxWork');
var path = plus.io.convertLocalFileSystemURL("_www/static/xxxx");
wxWork.shareLink({
    title:"",
    desc:"",
    url:"",
    path:path
}, function(ret, err) {

});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

shareMiniProgram

分享小程序

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

params

userName：

• 类型：字符串
• 描述：（必填）小程序原始ID。

title：

• 类型：字符串
• 描述：（必填）标题。

desc

• 类型：字符串
• 描述：（可选项）描述

image：

• 类型：字符串
• 描述：（必填）图片路径

path：

• 类型：字符串
• 描述：（必填）小程序页面路径。

callback(ret, err)

ret：

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

{
    status: true, //初始化状态
    code: 0, //状态码
    type: 'onSuccess', //事件类型 
    msg: "onSuccess",//描述
    result:{ //其他结果数据

    }
}

示例代码

var wxWork = uni.requireNativePlugin('saner-wxWork');
var image = plus.io.convertLocalFileSystemURL("_www/static/xxxx");
wxWork.shareMiniProgram({
    userName:"",
    title:"",
    desc:"",
    image:image，
    path:""
}, function(ret, err) {

});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本