IM

Methods

on(eventName, handler, contextopt)

Example

let onTextMessageReceived = function(event) {
  event.data.forEach(function(message) {
    console.log('im | ' + (message.from || message.nick) + ' : ', message.payload.text);
  });
};
im.on(TWebLive.EVENT.IM_TEXT_MESSAGE_RECEIVED, onTextMessageReceived);

Parameters:

off(eventName, handler, contextopt)

Example

im.off(TWebLive.EVENT.IM_TEXT_MESSAGE_RECEIVED, onTextMessageReceived);

Parameters:

setLogLevel(level)

Example

im.setLogLevel(1);

Parameters:

(async) createRoom(options) → {Promise}

Example

let promise = im.createRoom({
  name: '我的直播间X'
});
promise.then(function(imResponse) { // 创建成功
  console.log(imResponse.data.group.groupID); // 创建的群的 ID
}).catch(function(imError) {
  console.warn('im | createRoom | failed', imError); // 创建群组失败的相关信息
});

Parameters:

Returns:

Type

Promise

enterRoom(roomID) → {Promise}

Example

let promise = im.enterRoom('AV1');
promise.then(function(imResponse) {
  switch (imResponse.data.status) {
    case TWebLive.TYPES.ENTER_ROOM_SUCCESS: // 加入直播间成功
      break;
    case TWebLive.TYPES.ALREADY_IN_ROOM: // 已经在直播间内
      break;
    default:
      break;
  }
}).catch(function(imError){
  console.warn('im | enterRoom | failed', imError); // 加入直播间失败的相关信息
});

Parameters:

Returns:

Type

Promise

(async) exitRoom(roomID) → {Promise}

Example

let promise = im.exitRoom('AV1');
promise.then(function(imResponse) {
  // 退出直播间成功
}).catch(function(imError){
  console.warn('im | exitRoom | failed', imError); // 退出直播间失败的相关信息
});

Parameters:

Returns:

Type

Promise

login(options) → {Promise}

Example

let promise = im.login({userID: 'your userID', userSig: 'your userSig'});
promise.then(function(res) {
  console.log(res.data); // 登录成功
  if (res.data.repeatLogin === true) {
    // 标识账号已登录，本次登录操作为重复登录
    console.log(imResponse.data.errorInfo);
  }
}).catch(function(imError) {
  console.warn('im | login | failed', imError); // 登录失败的相关信息
});

Parameters:

Returns:

Type

Promise

logout() → {Promise}

Example

let promise = im.logout();
promise.then(function(imResponse) {
  console.log(imResponse.data); // 登出成功
}).catch(function(imError) {
  console.warn('im | logout | failed', imError);
});

Returns:

Type

Promise

(async) setMyProfile(options) → {Promise}

Example

// 设置个人昵称和头像
let promise = im.setMyProfile({
  nick: '我的昵称',
  avatar: 'http(s)://url/to/image.jpg'
});
promise.then(function(imResponse) {
  console.log(imResponse.data); // 成功
}).catch(function(imError) {
  console.warn('im | setMyProfile | failed', imError); // 设置资料失败的相关信息
});

Parameters:

Returns:

Type

Promise

getMyProfile() → {Promise}

Example

let promise = im.getMyProfile();
promise.then(function(imResponse) {
  console.log('昵称：', imResponse.data.nick, '头像：', imResponse.data.avatar); // 个人资料 - Profile 实例
}).catch(function(imError) {
  console.warn('im | getMyProfile | failed', imError); // 获取个人资料失败的相关信息
});

Returns:

Type

Promise

(async) sendTextMessage(options) → {Promise}

Example

let promise = im.sendTextMessage({
  roomID: 'AV1',
  priority: TWebLive.TYPES.MSG_PRIORITY_NORMAL,
  text: 'hello from TWebLive'
});
promise.then(function(imResponse) {
  console.log('im | sendTextMessage | OK', imResponse);
}).catch(function(imError) {
  console.log('im | sendTextMessage | failed', imError);
});

Parameters:

Returns:

Type

Promise

(async) sendCustomMessage(options) → {Promise}

Example

let promise = im.sendCustomMessage({
  roomID: 'AV1',
  priority：TWebLive.TYPES.MSG_PRIORITY_LOW, // 低优先级
  data: 'dianzan', // 用于标识该消息是点赞类型的自定义消息
  description: '',
  extension: ''
});
promise.then(function(imResponse) {
  console.log('im | sendCustomMessage | OK', imResponse);
}).catch(function(imError) {
  console.log('im | sendCustomMessage | failed', imError);
});

Parameters:

Returns:

Type

Promise

(async) sendImageMessage(options) → {Promise}

Examples

// Web 端发送图片消息示例1 - 传入 DOM 节点
let promise = im.sendImageMessage({
  roomID: 'AV1',
  priority：TWebLive.TYPES.MSG_PRIORITY_LOW, // 低优先级
  file: document.getElementById('imagePicker'),
  onProgress: function(event) { console.log('file uploading:', event) }
});
promise.then(function(imResponse) {
  console.log('im | sendImageMessage | OK', imResponse);
}).catch(function(imError) {
  // 发送失败
  console.log('im | sendImageMessage | failed', imError);
});

// Web 端发送图片消息示例2- 传入 File 对象
// 先在页面上添加一个 id 为 "testPasteInput" 的消息输入框，如 <input type="text" id="testPasteInput" placeholder="截图后粘贴到输入框中" size="30" />
let file = null;
document.getElementById('testPasteInput').addEventListener('paste', function(e) {
  let clipboardData = e.clipboardData;
  let fileCopy;
  if (clipboardData && clipboardData.files && clipboardData.files.length > 0) {
    file = clipboardData.files[0];
    // 图片消息发送成功后，file 指向的内容可能被浏览器清空，如果接入侧有额外的渲染需求，可以提前复制一份数据
    fileCopy = file.slice();
  }

  if (typeof file === 'undefined') {
    console.warn('file 是 undefined，请检查代码或浏览器兼容性！');
    return;
  }
}

let promise = im.sendImageMessage({
  roomID: 'AV1',
  priority：TWebLive.TYPES.MSG_PRIORITY_LOW, // 低优先级
  file: file,
  onProgress: function(event) { console.log('file uploading:', event) }
});
promise.then(function(imResponse) {
  console.log('im | sendImageMessage | OK', imResponse);
}).catch(function(imError) {
  // 发送失败
  console.log('im | sendImageMessage | failed', imError);
});

Parameters:

Returns:

Type

Promise

(async) stopPush(options) → {Promise}

Example

im.stopPush({
  roomID: 'AV1',
  postscript: '欢迎下次再来呦'
});

// 观众端监听 TWebLive.EVENT.IM_PUSH_STOPPED
let onPushStopped = function(event) {
  console.log('postscript: ', event.data);
};
im.on(TWebLive.EVENT.IM_PUSH_STOPPED, onPushStopped);

Parameters:

Returns:

Type

Promise