类的静态方法定义见 QChatInterfaceStatic
| 方法 | 功能描述 |
|---|---|
| QChatInterfaceStatic.getInstance | 单例模式获取实例 |
| QChatInterfaceStatic.setAdapters | 设置适配器 |
下面是QChatInterfaceStatic.getInstance的初始化参数。这里只例举部分参数，完整初始化参数见 QChatInitializeOptions，以及QChatOtherOptions
注意，初始化有两个参数，调用方式为: QChat.getInstance(param1, param2)。param1 为 QChatInitializeOptions, param2 为 QChatOtherOptions
// 0.11.0 版开始支持单例模式获取实例, 在此之前通过 new 创建实例
const qchat = QChat.getInstance(
/**
* param1: QChatInitializeOptions
*/
{
appkey: '{{YOUR_APP_KEY}}',
token: '{{YOUR_TOKEN}}',
account: '{{YOUR_ACCOUNT}}',
linkAddresses: ['{{YOUR_ADDRESSES}}'],
debugLevel: 'debug'
},
/**
* param2: QChatOtherOptions
*/
{
/**
* 存储模块初始化设置
*/
cloudStorageConfig: {
/**
* NOS上传地址（分片）
*/
chunkUploadHost: 'https://www.example.com'
}
}
)
提供最为基础的初始化参数。该参数的完整属性列表请参考QChatInitializeOptions
| 属性 | 功能描述 |
|---|---|
| QChatInitializeOptions.appkey | 应用 appkey |
| QChatInitializeOptions.account | IM 账户 |
| QChatInitializeOptions.token | IM 账户 token |
| QChatInitializeOptions.authType | token 的认证模式 |
| QChatInitializeOptions.debugLevel | 日志分级 |
| QChatInitializeOptions.linkAddresses | 连接地址列表 |
提供一些扩展初始化参数。该参数的完整属性列表请参考QChatOtherOptions。
| 属性 | 功能描述 |
|---|---|
| QChatOtherOptions.cloudStorageConfig | cloud storage 模块配置 |
| QChatOtherOptions.QChatMedia | QChatMedia 模块配置 |
调用qchat.on(eventName),监听 qchat 事件，注册事件相关的回调函数。下面是一些回调事件的定义，完整 API 请参见QChatEventInterface
| 事件名称 | 功能描述 |
|---|---|
| QChatEventInterface.logined | 初始化成功登陆 |
| QChatEventInterface.kicked | 被踢下线 |
| QChatEventInterface.willReconnect | 开始自动重连 |
| QChatEventInterface.disconnect | 连接断开 |
| QChatEventInterface.multiSpotLogin | 多端登陆通知 |
| QChatEventInterface.connectChannel | rtc 房间连接成功 |
| QChatEventInterface.qchatMediaDisconnect | 断开 rtc 房间连接 |
| 事件名称 | 功能描述 |
|---|---|
| QChatEventInterface.message | 收到消息 |
| QChatEventInterface.messageUpdate | 收到消息更新 |
| QChatEventInterface.serverUnreadInfo | 收到服务器总消息未读通知 |
| QChatEventInterface.unreadInfos | 多个频道收到消息未读通知 |
| 事件名称 | 功能描述 |
|---|---|
| QChatEventInterface.connectChannel | rtc 房间连接成功 |
| QChatEventInterface.qchatMediaDisconnect | 断开 rtc 房间连接 |
| QChatEventInterface.memberAudioMuteChanged | 成员音频状态回调 |
| QChatEventInterface.memberJoinRTCChannel | 成员进入 RTC 频道 |
| QChatEventInterface.memberLeaveRTCChannel | 成员离开 RTC 频道 |
| QChatEventInterface.memberScreenShareStateChanged | 成员屏幕共享状态回调 |
| QChatEventInterface.memberVideoMuteChanged | 成员视频状态回调 |
| QChatEventInterface.RTCChannelError | RTC 频道错误 |
| QChatEventInterface.onRtcAudioVolumeIndication | 提示房间内谁正在说话及说话者瞬时音量 |
| 事件名称 | 功能描述 |
|---|---|
| QChatEventInterface.recvTypingEvent | 收到“正在输入”事件 |
| QChatEventInterface.syncSystemNotifications | 同步阶段-收到未读的离线系统通知 |
| QChatEventInterface.systemNotification | 收到系统通知更新 |
qchat 连接管理相关函数。调用方式为qchat.login, qchat.destroy等
该属性和方法直接挂载在 QChat 实例上。
| 方法/属性 | 功能描述 |
|---|---|
| QChatInterface.status | 实例状态 |
| QChatInterface.login | 建立长连接，并且登录 |
| QChatInterface.logout | 断开连接。 |
| QChatInterface.destroy | 销毁实例 |
| QChatInterface.kickOtherClients | 踢出当前用户从其它端登录上来的连接 |
挂载了频道相关接口，如增上改查频道。调用示例qchat.qchatChannel.createChannel。完整的 API 请参见 QChatChannelServiceInterface
挂载了消息相关接口，如发送消息。调用示例qchat.qchatMsg.sendMessage。完整的 API 请参见 QChatMsgServiceInterface
挂载了身份组和权限相关的接口。调用示例qchat.qchatRole.createServerRole。完整的 API 请参见 QChatRoleServiceInterface
挂载了 Server 相关的接口。调用示例qchat.qchatServer.createServer。完整的 API 请参见 QChatServerServiceInterface
挂载了 media 相关的接口。调用示例qchat.qchatMedia.initQChatMedia。完整的 API 请参见 QChatMediaServiceInterface
挂载了文件上传逻辑。调用示例: qchat.cloudStorage.uploadFile。完整的 API 请参见 CloudStorageServiceInterface
| 方法 | 功能描述 |
|---|---|
| CloudStorageServiceInterface.uploadFile | 上传文件 |
| CloudStorageServiceInterface.getOriginUrl | 短链转长链 |
| CloudStorageServiceInterface.getFileToken | 获取文件鉴权的 token |