开源即时通讯IM框架MobileIMSDK的Uniapp端开发快速入门

? 相关链接:

  • ① MobileIMSDK-UniApp端的详细介绍
  • ② MobileIMSDK-Uniapp端的开发手册new(* 精编PDF版)
一、理论知识准备您需要对Uniapp和Vue开发有所了解:
  • 1)Uniapp 官方入门教程
  • 2)可能是最好的 uniapp 入门教程
  • 3)Uniapp 官方 Vue 快速入门教程
您需要对WebSocket技术有所了解:
  • 1)新手快速入门:WebSocket 简明教程
  • 2)WebSocket 详解(一):初步认识 WebSocket 技术
  • 3)WebSocket 从入门到精通,半小时就够!
  • 4)从零理解 WebSocket 的通信原理、协议格式、安全性
标准WebSocket协议文档、API手册:
  • 1)WebSocket 的 API 手册
  • 2)WebSocket 的标准文档
Uniapp 的 WebSocket 文档和手册:
  • 1)uniapp 官方文档
二、开发工具准备1)HBuilderX:
开源即时通讯IM框架MobileIMSDK的Uniapp端开发快速入门

文章插图
(JackJiang 使用的版本号如下图所示,为了方便直接引用工程,建议你也使用此版或较新版本)
2)一站式下载地址:HBuilderX官方下载地址点此进入 。
3)HBuilderX效果预览:
开源即时通讯IM框架MobileIMSDK的Uniapp端开发快速入门

文章插图
三、SDK 文件用途说明3.1文件概览
纯 Uniapp 标准 JS API 实现,无任何第 3 方库依赖,更无本地原生代码混编:
MobileIMSDK-Uniapp 端 SDK 本身只是 JS 文件源码的集合,自带的 Demo 代码只是为了方便随时测试 SDK 代码,目的主要是用于演示 SDK 的 API 调用,Demo 代码不属于 SDK 框架的一部分 。
大致的目录说明:
开源即时通讯IM框架MobileIMSDK的Uniapp端开发快速入门

文章插图
3.2详细说明
SDK 各模块/文件作用说明:
开源即时通讯IM框架MobileIMSDK的Uniapp端开发快速入门

文章插图
四、主要 API 接口4.1主要 API 接口概览
所有 SDK 接口均由/mobileimsdk/mobileimsdk-client-sdk.js 提供 。以下是主要 API 接口概览图 。
开源即时通讯IM框架MobileIMSDK的Uniapp端开发快速入门

文章插图
如下图所示:接口设计跟 MobileIMSDK 的APP版一样,均为高内聚和低侵入式的回调方式传入业务层处理逻辑,无需(也不建议)开发者直接修改 sdk 级代码 。
开源即时通讯IM框架MobileIMSDK的Uniapp端开发快速入门

文章插图
4.2主要 API 接口概览
1)IMSDK.isLogined():
  • 用途:是否已经完成过首次登陆 。
  • 说明 :用户一旦从自已的应用中完成登陆IM服务器后,本方法就会一直返回true(直到退出登陆IM) 。
  • 返回值:{boolean},true表示已完成首次成功登陆(即已经成功登陆过IM服务端了,后面掉线时不影响此标识),否则表示尚未连接IM服务器 。
2)IMSDK.isOnline():
  • 用途:是否在线 。
  • 说明 :表示网络连接是否正常 。
  • 返回值:{boolean},true表示网络连接正常,否则表示已掉线,本字段只在this._logined=true时有意义(如果都没有登陆到IM服务器,怎么存在在线或掉线的概念呢) 。
3)IMSDK.getLoginInfo():
  • 用途:返回登陆时提交的登陆信息(用户名、密码/token等) 。
  • 说明 :格式形如:{loginUserId:'',loginToken:''},此返回值的内容由调用登陆函数 loginImpl()时传入的内容决定 。字段定义详见:PLoginInfo
  • 返回值:{boolean},true表示网络连接正常,否则表示已掉线,本字段只在this._logined=true时有意义(如果都没有登陆到IM服务器,怎么存在在线或掉线的概念呢) 。
4)IMSDK.sendData(p, fnSucess, fnFail, fnComplete):
  • 用途:向某人发送一条消息 。
  • 参数p:{Protocal} 要发送的消息协议包对象,Protocal详情请见“/module/mb_constants.js”下的createCommonData函数说明 。
  • 参数fnSuccess :{function} 接口调用成功的回调函数,非必填项
  • 参数fnFail :{function} 接口调用失败的回调函数,非必填项
  • 参数fnComplete :{function} 接口调用结束的回调函数(调用成功、失败都会执行),非必填项
  • 返回值:{int} 0表示成功,否则表示错误码,错码详见“/module/mb_constants.js”下的MBErrorCode对象属性说明 。
5)IMSDK.disconnectSocket():
  • 用途:客户端主动断开客户端socket连接 。
  • 说明 :当开发者登陆IM后,需要退出登陆时,调用本函数就对了,本函数相当于登陆函数 loginImpl()的逆操作 。
【开源即时通讯IM框架MobileIMSDK的Uniapp端开发快速入门】


推荐阅读