更新记录

1.1.0(2021-07-28)

初版发布


平台兼容性

插件介绍

  • 为了方便开发者快速接入,百城推送推出了适用于 UNIAPP 开发的IOS、Android、H5、微信小程序、支付宝小程序、百度小程序、字节跳动小程序、QQ小程序、360小程序、快应用等项目的 UniappSDK

插件特色

  • 零储存:平台不会储存您的任何推送消息,我们专注于提供通讯能力
  • 安全可靠:一线服务商提供安全、可靠的计算和数据处理能力
  • 自主开放:自定义数据包,轻松实现文字、表情、图片、位置、语音等功能
  • 平台兼容:平台基于WebSocket,支持所有WebSocket的语言和客户端
  • 多端同步:同一账号,多端登录时,信息自动同步,方便您快速高效沟通
  • 快速高效:程序仅需对接服务端授权接口,大大降低您的学习和开发成本

交流沟通

加群交流QQ群:1078718987

官方网站

引入SDK

可以通过在 main.js 中引入,然后挂载到 Vue.prototype 上,示例如下:

import XBCIM from 'plugins/xbcim_sdk_1.0.0.min.js'
Vue.prototype.$xbcim = XBCIM

初始化SDK

this.$xbcim.init(token)

1、参数 token 为连接授权码,需要通过平台注册账号的 appKey 等参数进行获取,具体方法请参考 获取授权码
2、参数可以直接传递 token 字符串,也可以传入 json 格式,如 { token: token }。
3、初始化时,默认就会创建WebSocket链接。

监听初始化成功

this.$xbcim.onsuccess(callback)

callback回调,可以在里面进行初始化成功后的其他逻辑操作。

监听错误

this.$xbcim.(callback)

1、 会监听初始化失败、token 校验等错误回调。
2、callback回调,可以在里面进行连接成功后的其他逻辑操作。

监听连接是否断开

this.$xbcim.(callback)

callback回调,可以在里面进行连接断开后的其他逻辑操作。

手动断开连接

this.$xbcim.close(callback)

callback回调,可以在里面进行连接断开后的其他逻辑操作。

重新连接

this.$xbcim.reconnect(callback)

发送单聊

this.$xbcim.sendSingle(data)

data 为要发送的消息数据,其具体参数及含义如下:

参数 说明
type 消息类型,默认文本,支持其他自定义消息类型
source 消息发送者ID
target 消息接收者ID
content 消息内容,字符串
extra 额外数据,支持任意格式

创建(加入)群聊

this.$xbcim.addGroup(data)

data 为JSON格式,其具体参数及含义如下:

参数 说明
target 群ID
extra 成员ID,数组格式,需要注意的是:如果群为新群时,需要将自己的ID也加入到成员里面

退出群聊

this.$xbcim.quitGroup(data)

data 为JSON格式,其具体参数及含义如下:

参数 说明
target 群ID

删除群聊

this.$xbcim.delGroup(data)

data 为JSON格式,其具体参数及含义如下:

参数 说明
target 群ID

发送群聊

this.$xbcim.sendGroup(data)

data 为要发送的消息数据,其具体参数及含义如下:

参数 说明
type 消息类型,默认文本,支持其他自定义消息类型
source 消息发送者ID
target 群ID
content 消息内容,字符串
extra 额外数据,支持任意格式

接收消息

this.$xbcim.(callback)

callback 回调,回调会返回接收到的消息数据。

隐私、权限声明

1. 本插件需要申请的系统权限列表:

2. 本插件采集的数据、发送的服务器地址、以及数据用途说明:

3. 本插件是否包含广告,如包含需详细说明广告表达方式、展示频率:

许可协议

MIT协议

暂无用户评论。

使用中有什么不明白的地方,就向插件作者提问吧~ 我要提问