RtmClient 类

import ArRTM from "ar-rtm-sdk";
/**
 * 创建 RTM 客户端实例
 * @params appId: 项目的 App ID。必须是 ASCII 编码，长度为 32 个字符。(类型：string)
 */
const client = ArRTM.createInstance(appId);

login(options: loginOptions): Promise<void>

/**
 * 用户登录 anyRTC RTM 系统
 * @params options: 参数详见上方
 */
client.login({ token: "undefined", uid: "userID" })
    .then(() => { })
    .catch((err) => { });

logout(): Promise<void>

/**
 * 退出登录，退出后自动断开连接和销毁回调监听 (必须先登录)
 */
client.logout()
    .then(() => { })
    .catch((err) => { });

sendMessageToPeer(
    message: RtmMessage,
    peerId: string,
    options?: SendMessageOption): Promise<PeerMessageSendResult>

/**
 * 本地用户（发送者）向指定用户（接收者）发送点对点消息或点对点的离线消息  sendMessageToPeer
 * @params PeerId: 远端用户的 uid
 */
client.sendMessageToPeer(
    { text: "要发送的文字消息" }, // 一个 RtmMessage 实例。  
    "PeerId",
).then({ hasPeerReceived } => {
    if (hasPeerReceived) {
        // 你的代码：远端用户收到消息事件。  
    } else {
        // 你的代码：服务器已收到消息，对端未收到消息。  
    }
}).catch((err) => {
// 你的代码：点对点消息发送失败。 
});

queryPeersBySubscriptionOption(option: PeerSubscriptionOption): Promise<string[]>

/**
 * 获取某特定内容被订阅的用户列表回调 queryPeersBySubscriptionOption
 * @params option: 订阅类型
 */
client.queryPeersBySubscriptionOption("ONLINE_STATUS")
    .then((peerSubscriptionOption) => { })
    .catch((err) => { });

queryPeersOnlineStatus(peerIds: string[]): Promise<PeersOnlineStatusResult>

/**
 * 查询指定用户的在线状态。
 * @params peerIds: 用户 ID 列表。用户 ID 个数不能超过 256 (类型：array)
 */
client.queryPeersOnlineStatus(['123456', '55555'])
    .then((peersOnlineStatusResult) => { })
    .catch((err) => { });

subscribePeersOnlineStatus(peerIds: string[]): Promise<void>

...
/**
 * 订阅指定单个或多个用户的在线状态。
 * @params peerIds: 订阅用户的用户 ID 阵列 (类型：array)
 */
client.subscribePeersOnlineStatus(['123456', '55555'])
    .then(() => { })
    .catch((err) => { });

unsubscribePeersOnlineStatus(peerIds: string[]): Promise<void>

/**
 * 退订指定单个或多个用户的在线状态。
 * @params peerIds: 被退订用户的用户 ID 阵列 (类型：array)
 */
client.unsubscribePeersOnlineStatus(['123456', '55555'])
    .then(() => { })
    .catch((err) => { });

setLocalUserAttributes(attributes: AttributesMap): Promise<void>

/**
 * 全量设置本地用户的属性。
 * @params attributes: 新的属性 (类型：object)
 */
client.setLocalUserAttributes({
    userName: '开发小王子',
    age: 1024,
})
    .then(() => { })
    .catch((err) => { });

addOrUpdateLocalUserAttributes(attributes: AttributesMap): Promise<void>

/**
 * 添加或更新本地用户的属性。
 * @params attributes: 待增加或更新的属性列表 (类型：object)
 */
client.addOrUpdateLocalUserAttributes({
    userName: '开发最强王者',
    age: 1024,
})
    .then(() => { })
    .catch((err) => { });

deleteLocalUserAttributesByKeys(attributeKeys: string[]): Promise<void>

/**
 * 删除本地用户的指定属性。
 * @params attributeKeys: 属性名列表 (类型：array)
 */
client.deleteLocalUserAttributesByKeys(['age'])
    .then(() => { })
    .catch((err) => { });

clearLocalUserAttributes(): Promise<void>

/**
 * 清空本地用户的所有属性。
 */
client.clearLocalUserAttributes()
    .then(() => { })
    .catch((err) => { });

getUserAttributes(userId: string): Promise<AttributesMap>

/**
 * 获取指定用户的全部属性。
 * @params userId: 指定用户的用户 ID。(类型：string)
 */
client.getUserAttributes('123456')
    .then((attributesMap) => { })
    .catch((err) => { });

getUserAttributesByKeys(userId: string, attributeKeys: string[]): Promise<AttributesMap>

/**
 * 获取指定用户指定属性名的属性
 * @params userId:  指定用户的用户 ID。(类型：string)
 * @params attributeKeys: 用户属性名列表。(类型：array)
 */
client.getUserAttributesByKeys('123456', ['userName'])
    .then((attributesMap) => { })
    .catch((err) => { });

createChannel(channelId: string): RtmChannel

/**
 * 创建一个 RtmClient 实例
 * @params channelId: 频道名称。(类型：string)
 */
const rtmChannel = client.createChannel('123456789');

getChannelMemberCount(channelIds: string[]): Promise<ChannelMemberCountResult>

/**
 * 查询单个或多个频道的成员人数。
 * @params channelIds: 指定频道名列表。(类型：array)
 */
client.getChannelMemberCount(['123456789'])
    .then((channelMemberCountResult) => { })
    .catch((err) => { });

setChannelAttributes(channelId: string, attributes: AttributesMap, options?: ChannelAttributeOptions): Promise<void>

/**
 * 全量设置某指定频道的属性。
 * @params channelId: 指定频道的频道 ID (类型：string)
 * @params attributes: 频道属性列表实例 (类型：object)
 * @params options: 频道属性操作选项 (类型：object)
 */
client.setChannelAttributes(channelId, attributes, options)
    .then(() => { })
    .catch((err) => { });

addOrUpdateChannelAttributes(channelId: string, attributes: AttributesMap, options?: ChannelAttributeOptions): Promise<void>

/**
 * 添加或更新某指定频道的属性。
 * @params channelId: 指定频道的 ID (类型：string)
 * @params attributes: 待增加或更新的属性列表 (类型：object)
 * @params options: 频道属性操作选项 (类型：object)
 */
client.addOrUpdateChannelAttributes(channelId, attributes, options)
    .then(() => { })
    .catch((err) => { });

deleteChannelAttributesByKeys(channelId: string, attributeKeys: string[], options?: ChannelAttributeOptions): Promise<void>

/**
 * 删除指定频道的指定属性。
 * @params channelId: 被叫的 uid。(类型：string)
 * @params attributeKeys: 属性名列表 (类型：array)
 * @params options: 频道属性操作选项 (类型：object)
 */
client.deleteChannelAttributesByKeys(channelId, attributeKeys, options)
    .then(() => { })
    .catch((err) => { });

clearChannelAttributes(channelId: string, options?: ChannelAttributeOptions): Promise<void>

/**
 * 清空某指定频道的属性。
 * @params channelId: 指定频道的 ID (类型：string)
 * @params options: 频道属性操作选项 (类型：object)
 */
client.clearChannelAttributes(channelId, options)
    .then(() => { })
    .catch((err) => { });

getChannelAttributes(channelId: string): Promise<ChannelAttributes>

/**
 * 查询某指定频道的全部属性。(无需加入指定频道即可查询该频道的属性)
 * @params channelId: 指定频道的 ID。(类型：string)
 */
client.getChannelAttributes(channelId)
    .then((channelAttributes) => { })
    .catch((err) => { });

getChannelAttributesByKeys(channelId: string, keys: string[]): Promise<ChannelAttributes>

/**
 * 查询某指定频道指定属性名的属性。(无需加入指定频道即可查询该频道的属性)
 * @params channelId: 指定频道的 ID。(类型：string)
 * @params keys: 频道属性名列表。(类型：array)
 */
client.getChannelAttributesByKeys(channelId, keys)
    .then((channelAttributes) => { })
    .catch((err) => { });

createLocalInvitation(calleeId: string): LocalInvitation

/**
 * 创建一个 LocalInvitation 实例
 * @params calleeId: 被叫的 uid。(类型：string)
 */
const localInvitation = client.createLocalInvitation(calleeId);

on(event: string, callback: (...args: any[]) => void): void;

/**
 * 通过绑定 SDK 提供的事件回调进行相关操作监听
 * @params eventName: SDK RTM 客户端提供的事件的名称。(类型：string)
 * @params ...args: 不同的事件，回调参数是不同的。(类型：any[])
 */
client.on("MessageFromPeer", (message, peerId, messageProps) => {

});

renewToken(token: string): Promise<void>

/**
 * 更新当前 Token
 * @params token: 新的 Token (类型：string)
 */
client.renewToken(token)
    .then(() => { })
    .catch((err) => { });

setParameters(params: RtmParameters): void

/**
 * 全量设置本地用户的属性。
 * @params params: 定制功能 (类型：object)
 */
client.setParameters(params);