圈组是网易云信开发的类 Discord 场景能力模块。在使用圈组的相关能力前，需要先初始化圈组 SDK 并登录圈组。

前提条件

登录圈组前，请确保：

• 已开通和配置圈组功能。
• 已集成圈组 SDK。

实现流程

步骤1：初始化

创建圈组 SDK 实例并初始化。

示例代码：

const qchat = QChat.getInstance(
  // param1: QChatInitializeOptions
  {
    appkey: '{{YOUR_APP_KEY}}',
    token: '{{YOUR_TOKEN}}',
    account: '{{YOUR_ACCOUNT}}',
    linkAddresses: ['{{YOUR_ADDRESSES}}'],
    debugLevel: 'debug'
    // for more infomation please see the definition of QChatInitializeOptions.
  },
  // param2: QChatOtherOptions
  { 
    qchatChannelConfig: {
      autoSubscribe: true
    },
    cloudStorageConfig: {
      chunkUploadHost: 'https://www.example.com'
    }
    // for more infomation please see the definition of QChatOtherOptions.
  }
)

初始化重要参数

注入 AWS s3 实例

jsimport s3 from 'aws-sdk/clients/s3'

const options = {
  appkey: ''
  account: '',
  token: '',
  s3: s3,
};
const qchat = new QChat(options);

aws-sdk 的安装脚本如下。请使用 2.1059.0 版本。

npm install aws-sdk

步骤2：设置监听事件

可在创建实例后设置监听事件。以下为监听“登录完成”事件的示例代码。

js// 初始化-实例设置监听事件
qchat.on('logined', function (loginResult) { console.log(`login done!! ${loginResult}`) })

部分重要事件如下：

jsconst eventList = [
  'logined', 'willReconnect', 'disconnect', 'multiSpotLogin', 'kicked', 'syncdone',
  'message', 'messageUpdate', 'unreadInfo', 'systemNotification', 'systemNotificationUpdate',
]
eventList.forEach((key: any) => {
  qchat.on(key, (res: any) => {
    console.log(`Receive ${key} : `, res);
  });
})

步骤3：登录

调用login方法登录圈组。

// 实例登录
await qchat.login()

登录相关

长连接的建立与断开

SDK 提供了如下 4 个方法维护 SDK 实例与云信服务端之间的长连接。

多端登录与互踢

您可通过云信控制台或者接口对多端登录进行管控。

方式1：通过控制台管控

可在云信控制台配置如下多端登录与互踢策略：

• 只允许一端登录
• 桌面端（PC 与 Web）互踢、移动端（Android 和 iOS ）互踢、桌面端与移动端可同时登录。
• 各端均可以同时登录在线（最多 10 个设备同时在线）

在控制台配置后，可注册kicked事件回调，监听被踢事件。

方式2：通过接口管控

1. 其他设备端注册多端登录事件回调（MultiSpotLogin）。

2. 本端调用kickOtherClients方法，将同时登录圈组的其他设备端踢下线。

   结果：

   其他设备端收到MultiSpotLogin事件。收到该事件回调后，建议其他设备端退出登录并切换到登录界面。

jsconst qchat = new QChatSDK({
  appkey: 'YOUR_APPKEY',
  account: 'YOUR_ACCOUNT_1',
  token: 'YOUR_TOKEN'
})

qchat.on('kicked', function (kickedReason) {
  console.log('Be kicked cause:', kickedReason)
})

await qchat.login()

jsconst qchat = new QChatSDK({
  appkey: 'YOUR_APPKEY',
  account: 'YOUR_ACCOUNT_1',
  token: 'YOUR_TOKEN'
})

qchat.on('multiSpotLogin', (result) => {
  const deviceIds = []
  if (Array.isArray(result)) {
    const ids = result.filter(item => item.online && item.deviceId).map(item => item.deviceId)
    deviceIds = deviceIds.concat(ids)
  } else {
    result.online && deviceIds.push(result.deviceId)
  }

  // 1 秒后踢出 A 设备的自己的账号
  setTimeout(() => {
    const result = await qchat.kickOtherClients({
      deviceIds: deviceIds
    })
    deviceIds = []
    console.log('kick success!!', result)
  }, 1000)
})

await qchat.login()