IM SDK for HTML5 开发指引

引入js文件：dist/yim.js

典型功能实现方法

js文件加载完成，可以使用yim.debug = true;开启sdk调用日志。

游戏启动的第一时间需要调用初始化接口。

• 相关接口与参数：

  • yim.getInstance, 初始化接口
  • dirtyWordsArray: 脏字过滤数组，如['色情', '赌博']
  • appKey: 用户游戏产品区别于其它游戏产品的标识，可以在游密官网获取
  • eventCallback: 相关事件回调接口对象，如：{onLogin:_loginCallback, onLogout:_logoutCallback}
• 代码示例与详细说明:
  初始化SDK

点击进入游戏按钮时，调用IM SDK登录接口。

• 接口名称: login

• 接口参数:

  • strYouMeID: 由调用者分配，不可为空字符串，只可由字母或数字或下划线组成
  • strPasswd: 这里传入从服务端获取到的token，请参考《游密后台服务接口文档》->添加用户

• 回调方法: eventCallback.onLogin

• 回调参数:
  • YIMErrorcodeOC：错误码，详细描述见错误码定义
  • event: 回调事件
  • code: 状态，同YIMErrorcodeOC
  • message: 相关信息
  • data: {userid: 同strYouMeID}

代码示例与详细说明：
登录接口

进入各个聊天频道

进入游戏后，调用加入房间接口，进入世界、公会、区域等需要进入的聊天频道。 游戏需要为各个聊天频道设置一个唯一的频道ID。

• 接口名称: joinRoom
• 接口参数: strRoomID: 请求加入的频道ID
• 回调方法: eventCallback.onJoinChatRoom
• 回调参数:
  • YIMErrorcodeOC：错误码，详细描述见错误码定义
  • event: 回调事件
  • code: 状态，同YIMErrorcodeOC
  • message: 相关信息
  • data: {roomid: 同strRoomID}

代码示例与详细说明：
加入聊天室

发送文字、表情消息

点击发送按钮，调用发消息接口，将输入框中的内容发送出去 发送出的消息出现在聊天框右侧 表情消息可以将表情信息打包成Json格式发送

• 接口名称: sendTextMessage
• 接口参数:
  • strRecvID: 接收者ID（用户ID或者群ID）
  • chatType: 聊天类型，群聊/私聊
  • strContent: 聊天内容
• 接口返回: strMessageID 消息ID
• 回调方法: eventCallback.onSendMessageStatus
• 回调参数:
  • YIMErrorcodeOC：错误码，详细描述见错误码定义
  • strMessageID: 消息ID

代码示例与详细说明：
发送文本消息

拓展功能： 发送消息时，可以将玩家头像、昵称、角色等级、vip等级等要素打包成json格式发送。

发送语音消息

按住语音按钮时，调用startAudioMessage 松开按钮，调用stopAudioMessage接口，发送消息，成功发送后会回调even.onVoiceMsgSend() 按住过程若需要取消发送，调用cancelAudioMessage取消发送

接口名称: startAudioMessage(recvUid, chatType, function(YIMErrorcodeOC){})
接口参数:

• strRecvID: 接收者ID（用户ID或者群ID）
• chatType: 聊天类型，群聊/私聊
• callback: 回调方法，第一个参数是否允许语音录制，参考错误码

接口名称: cancelAudioMessage(function(YIMErrorcodeOC){})
接口参数: 回调函数，可无

接口名称: stopAudioMessage(callback)
接口参数:

  function(YIMErrorcodeOC, ret){
    //ret.errMsg;
  }

• 语音消息发送回调方法: eventCallback.onVoiceMsgSend
• 回调参数:
  • YIMErrorcodeOC：错误码，详细描述见错误码定义
  • msgInfo: 语音相关详情
  • strMessageID: 消息ID
  • strVoiceID: 语音ID
  • intVoiceTime: 语音时长

初始化消息自动播放队列事件 接口名称: initAutoPlayVoiceQueue(option)
接口参数:

• option: {beginPlay: 开始播放回调, endPlay:结束播放回调}

添加接收的语音消息到自动播放队列 接口名称: addToAutoPlayVoiceQueue(message)
接口参数:

• message: 接收到语音消息的完整结构体，方便回调时消息对应

代码示例与详细说明:
发送语音消息

接收消息

通过OnRecvMessage接口被动接收消息，需要开发者实现

• 接口名称: eventCallback.onRecvMessage

• 接口参数:
  • intMessageType: 消息类型
  • strSenderID: 消息发送者ID
  • strRecvID: 消息接收者ID
  • strMessageID: 消息ID
  • intCreateTime: 消息创建时间
  • chatType: 聊天类型，群聊/私聊
  • strVoiceID: 语音消息VoiceID

代码示例与详细说明：
接收消息

接收语音消息并播放

intMessageType分拣出语音消息（yim.MessageBodyType.MessageBodyType_Voice） 点击语音气泡，调用函数数playAudioMessage播放语音消息 调用stopPlayAudioMessage停止播放语音消息

• 接口名称: playAudioMessage
• 接口参数:
  • strVoiceID: 语音消息ID
  • endCallback: 播放结束回调方法

• 接口名称: stopPlayAudioMessage
• 接口参数:
  • strVoiceID: 停止播放语音ID
  • callback: 结果回调方法，如function(YIMErrorcodeOC){}

更换账号或角色，登出SDK

注销账号时，调用登出接口Logout登出IM系统

• 接口名称: logout
• 接口参数: 无
• 回调方法: eventCallback.onLogout
• 回调参数: YIMErrorcodeOC：错误码，详细描述见错误码定义

离开房间

需要更换房间

• 接口名称: leaveRoom
• 接口参数: strRoomID: 请求离开的频道ID
• 回调方法: eventCallback.onLeaveChatRoom
• 回调参数:
  • YIMErrorcodeOC：错误码，详细描述见错误码定义
  • event: 同 eventCallback.onJoinChatRoom

退出游戏，反初始化SDK

• 接口名称: uninit
• 接口参数: 无

重复登录剔出回调

• 回调方法: eventCallback.onKickOff
• 回调参数: 无

错误码定义

语音接口错误码定义

| 错误码前缀:yim.YIMAudioCode. | 含义| | INVOKE_TOOFAST = 9001 | 接口调用太快，请稍后重试| | WAITFOR_LASTINVOKE = 9002, | 上次调用为结束，请等待| | INVALID_INVOKE = 9003, | 无效的调用| | DUPLICATE_INVOKE = 9004, | 重复调用| | INVOKE_OUTTIME = 9005, | 调用响应超时| | VOICE_TOOSHORT = 9006 | 语音消息太短，不足1秒|