wxWork

概述

企业微信简介

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

wxWork 插件概述

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

插件使用攻略

使用之前须从企业微信申请开发者账号并创建应用,获取 appid、schema、agentId。

企业微信申请地址企业微信

使用此插件之前建议先配置 config.xml 文件,配置完毕,需通过云端编译生效,配置方法如下:

  • 名称:wxWork
  • 参数:android_appId、ios_appId
  • 配置示例:
  <feature name="wxWork">
    <param name="android_schema" value="wwauth223ffe5d2fce7a87000002"/>
    <param name="android_appId" value="ww223ffe5d2fce7a87"/>
    <param name="android_agentId" value="1000002"/>
    <param name="ios_schema" value="wwauth223ffe5d2fce7a87000002"/>
    <param name="ios_appId" value="ww223ffe5d2fce7a87"/>
    <param name="ios_agentId" value="1000002"/>
    <param name="urlScheme" value="wwauth223ffe5d2fce7a87000002"/>
  </feature>
  • 字段描述:

    android_schema:安卓平台应用schema。 android_appId:安卓平台应用appid。 android_agentId:安卓平台应用agentId。

    ios_schema:苹果平台应用schema。 ios_appId:苹果平台应用appid。 ios_agentId:苹果平台应用agentId。 urlScheme:与ios_schema相同

插件接口

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 = api.require('wxWork');
wxWork.registerApp({
    userId:"1",
},function(ret, err) {
    if (ret.status) {
        alert("sdk 初始化成功");
    } else {
        alert('sdk 初始化失败');
    }
});

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

isAppInstalled

判断是否安装企业微信

isAppInstalled()

params

callback(ret, err)

示例代码


var wxWork = api.require('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 = api.require('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 = api.require('wxWork');
wxWork.shareText({
    content:"分享文本内容",
}, function(ret, err) {

});

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

shareFile

分享文件

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

params

filename:

  • 类型:字符串
  • 描述:(必填)文件名称。

path:

  • 类型:字符串
  • 描述:(必填)文件内容(暂时只支持:fs:// widget://)。

callback(ret, err)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    status: true, //初始化状态
    code: 0, //状态码
    type: 'onSuccess', //事件类型 
    msg: "onSuccess",//描述
    result:{ //其他结果数据
        
    }
}

示例代码

var wxWork = api.require('wxWork');
wxWork.shareFile({
    filename:"",
    path:""
}, function(ret, err) {

});

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

shareImage

分享图片

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

params

filename:

  • 类型:字符串
  • 描述:(必填)文件名称。

path:

  • 类型:字符串
  • 描述:(必填)文件内容(暂时只支持:fs:// widget://)。

callback(ret, err)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    status: true, //初始化状态
    code: 0, //状态码
    type: 'onSuccess', //事件类型 
    msg: "onSuccess",//描述
    result:{ //其他结果数据
        
    }
}

示例代码

var wxWork = api.require('wxWork');
wxWork.shareImage({
    filename:"",
    path:""
}, function(ret, err) {

});

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

shareVideo

分享视频

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

params

filename:

  • 类型:字符串
  • 描述:(必填)文件名称。

path:

  • 类型:字符串
  • 描述:(必填)文件内容(暂时只支持:fs:// widget://)。

callback(ret, err)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    status: true, //初始化状态
    code: 0, //状态码
    type: 'onSuccess', //事件类型 
    msg: "onSuccess",//描述
    result:{ //其他结果数据
        
    }
}

示例代码

var wxWork = api.require('wxWork');
wxWork.shareVideo({
    filename:"",
    path:""
}, function(ret, err) {

});

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

shareLink

分享链接

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

params

title:

  • 类型:字符串
  • 描述:(必填)标题。

desc

  • 类型:字符串
  • 描述:(可选项)描述

url

  • 类型:字符串
  • 描述:(可选项)链接地址

path:

  • 类型:字符串
  • 描述:(必填)文件内容(暂时只支持:fs:// widget://)。

callback(ret, err)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    status: true, //初始化状态
    code: 0, //状态码
    type: 'onSuccess', //事件类型 
    msg: "onSuccess",//描述
    result:{ //其他结果数据
        
    }
}

示例代码

var wxWork = api.require('wxWork');
wxWork.shareLink({
    title:"",
    desc:"",
    url:"",
    path:""
}, function(ret, err) {

});

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

shareMiniProgram

分享小程序

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

params

userName:

  • 类型:字符串
  • 描述:(必填)小程序原始ID。

title:

  • 类型:字符串
  • 描述:(必填)标题。

desc

  • 类型:字符串
  • 描述:(可选项)描述

image:

  • 类型:字符串
  • 描述:(必填)图片路径(暂时只支持:fs:// widget://)。

path:

  • 类型:字符串
  • 描述:(必填)小程序页面路径。

callback(ret, err)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    status: true, //初始化状态
    code: 0, //状态码
    type: 'onSuccess', //事件类型 
    msg: "onSuccess",//描述
    result:{ //其他结果数据
        
    }
}

示例代码

var wxWork = api.require('wxWork');
wxWork.shareMiniProgram({
    userName:"",
    title:"",
    desc:"",
    image:"",
    path:""
}, function(ret, err) {

});

可用性

iOS系统,Android系统

可提供的1.0.0及更高版本

是否仍需要帮助? 请保持联络!
最后更新于 2024/05/31