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

6)IMSDK.setDebugCoreEnable(enable):

  • 用途:是否开启MobileIMSDK-Uniapp端核心算法层的log输入,方便开发者调试 。
  • 参数enable :{boolean} true表示开启log输出,否则不输出,开发者不调用本函数的话系统默认是false(即不输出log) 。
7)IMSDK.setDebugSDKEnable(enable):
  • 用途:是否开启MobileIMSDK-Uniapp端框架层的log输入,方便开发者调试 。
  • 参数enable :{boolean} true表示开启log输出,否则不输出,开发者不调用本函数的话系统默认是false(即不输出log) 。
8)IMSDK.setDebugPingPongEnable(enable):
  • 用途:是否开启MobileIMSDK-Uniapp端框架层的底层网络WebSocket心跳包的log输出,方便开发者调试 。
  • 参数enable :{boolean} true表示开启log输出,否则不输出,开发者不调用本函数的话系统默认是false(即不输出log) 。
  • 注意:必须 setDebugEnable(true) 且 setDebugPingPongEnable(true) 时,心跳log才会真正输出,方便控制 。
  • 返回值:true表示开启log输出,否则不输出,开发者不调用本函数的话系统默认是false(即不输出log) 。
9)IMSDK.loginImpl(varloginInfo, wsUrl):
  • 用途:登陆/连接MobileIMSDK服务器时调用的方法 。
  • 说明 :登陆/连接MobileIMSDK服务器由本函数发起
  • 参数varloginInfo:{PLoginInfo} 必填项,登陆要提交给Websocket服务器的认证信息,不可为空,对象字段定义见:PLoginInfo
  • 参数wsUrl:{string} 必填项:要连接的Websocket服务器地址,不可为空,形如:wss://yousite.NET:3000/websocket 。
10)IMSDK.callback_onIMLog(message, toConsole):
  • 用途:由开发者设置的回调方法:用于debug的log输出 。
  • 推荐用法 :开发者可在此回调中按照自已的意图打印MobileIMSDK微信小程序端框架中的log,方便调试时使用 。
  • 参数1: {String}:必填项,字符串类型,表示log内容 。
  • 参数2: {boolean}:选填项,true表示输出到console,否则默认方式(由开发者设置的回调决定) 。
11)IMSDK.callback_onIMData(p, options):
  • 用途:由开发者设置的回调方法:用于收到聊天消息时在UI上展现出来(事件通知于收到IM消息时) 。
  • 推荐用法:开发者可在此回调中处理收到的各种IM消息 。
  • 参数1: {Protocal}:详情请见“/module/mb_constants.js”下的Protocal类定义) 。
12)IMSDK.callback_onIMAfterLoginSucess():
  • 用途:由开发者设置的回调方法:客户端的登陆请求被服务端成功认证完成后的回调(事件通知于 登陆/认证 成功后) 。
  • 推荐用法 :开发者可在此回调中进行登陆IM服务器成功后的处理 。
13)IMSDK.callback_onIMAfterLoginFailed(isReconnect):
  • 用途:由开发者设置的回调方法:客户端的登陆请求被服务端认证失败后的回调(事件通知于 登陆/认证 失败后) 。
  • 说明 :补充说明:登陆/认证失败的原因可能是用户名、密码等不正确等,但具体逻辑由服务端的 callBack_checkAuthToken回调函数去处理 。
  • 推荐用法:开发者可在此回调中提示用户登陆IM服务器失败 。。
  • 参数1: {boolean}:true表示是掉线重连后的认证失败(在登陆其间可能用户的密码信息等发生了变更),否则表示首次登陆时的认证失败 。
14)IMSDK.callback_onIMReconnectSucess():
  • 用途:由开发者设置的回调方法:掉线重连成功后的回调(事件通知于掉线重连成功后) 。
  • 推荐用法 :开发者可在此回调中处理掉线重连成功后的界面状态更新等,比如设置将界面上的“离线”文字更新成“在线” 。
15)IMSDK.callback_onIMDisconnected():
  • 用途:由开发者设置的回调方法:网络连接已断开时的回调(事件通知于与服务器的网络断开后) 。
  • 推荐用法 :开发者可在此回调中处理掉线时的界面状态更新等,比如设置将界面上的“在线”文字更新成“离线” 。
16)IMSDK.callback_onIMPing():
  • 用途:由开发者设置的回调方法:本地发出心跳包后的回调通知(本回调并非MobileIMSDK-Uniapp端核心逻辑,开发者可以不需要实现!) 。
  • 推荐用法 :开发者可在此回调中处理底层网络的活动情况 。
17)IMSDK.callback_onIMPong():