node package manager
Painless code sharing. npm Orgs help your team discover, share, and reuse code. Create a free org »

@beisen/webim

webim 使用文档

安装

bower install webim

引入

require(['webim'], function(beisenWebim) {
    var beisenWebim = new beisenWebim({
        "accid": "5201314",
        "token": "07cb936428503274b9552c54303731d7",
        "tenantId": "100001",
        "appId": "100",
        "appKey": "",
        "resourceFileUrl": ""
        "onError":
    });
    beisenWebim.init();
});

参数说明:
  accid            用户的id,和tita账户ID相同
  token            云信token,用做登录验证
  tenantId         该账户所属的租户id
  appId            应用id(tita 的appId为1)
  appKey           该租户所属的云信应用下的appKey
  resourceFileUrl  资源文件地址(sdk基础类库cdn地址)
  onError          错误处理函数,IM报错时该函数会收到err参数

API:

init:

  webim项目初始化,用户在登陆tita的时候,需要同步调用该方法,用于webim登陆.
  用法:
      beisenWebim.init()
  参数:无
  场景:tita登录时调用

popupPanel

  激活webim操作主面板
    用法:
     beisenWebim.popupPanel()
  参数:无
  场景:右上角webim图标

newChatPanel

  激活webim聊天窗口
     beisenWebim.newChatPanel()
  参数:
      id  : userId
      type :team或者p2p
  参数示例:
      { "id" : "100001", "type" :p2p" }
  场景: 通讯录聊天入口

popupProjectPanel

  激活项目聊天面板
  beisenWebim.popupProjectPanel(data)
  参数示例:
  {
      workId:"123123",      //项目ID
      workTitle:"test",//项目名称
      appId:1          //应用ID
  }
  场景:项目群聊入口

popupTaskPanel

  激活计划聊天面板
  beisenWebim.popupTaskPanel(data)
  参数示例:
  {
      taskId:"123123",      //任务ID
      taskTitle:"test",//任务名称
      appId:1          //应用ID
  }
  场景:任务计划聊天入口

checkLoginStatus

  检查IM登录状态
  beisenWebim.checkLoginStatus()
  参数:无
  返回值:1 表示登录成功   0 表示未登录
  场景:依据登录状态控制入口图标

getPanelState

  检查IM组件面板的展开和关闭状态
  beisenWebim.getPanelState()
  参数:无
  返回值:1 表示展开   0 表示关闭
  场景:依据展开关闭的状态控制IM入口的背景色