Class PresenceManager

PresenceManager 负责在线状态发布、订阅、查询与事件处理器管理。

Index

Constructors

Methods

addEventHandler removeEventHandler publishPresence subscribePresence unsubscribePresence getSubscribedPresenceList getPresenceStatus

Constructors

constructor

new PresenceManager(): PresenceManager
Returns PresenceManager

Methods

addEventHandler

addEventHandler(id: EventHandlerId, handlers: PresenceEventHandlerMap): void
注册 Presence 事件处理器，用于接收在线状态变更推送。
Parameters
- id: string
  事件处理器唯一 ID，用于后续移除。
- handlers: PresenceEventHandlerMap
  事件处理器集合，按需实现对应回调。
可监听事件
onPresenceStatusChange
PresenceEventName
Returns void
注册完成后无返回值。
Example: 调用示例（注册在线状态事件）
```
client.presenceManager.addEventHandler('presence-ui', {
  onPresenceStatusChange: (states) => {
    console.log(states);
  },
});
```

removeEventHandler

removeEventHandler(id: string): void
移除 Presence 事件处理器。
Parameters
- id: string
  待移除的事件处理器 ID。
Returns void
移除完成后无返回值。
Example: 调用示例（移除在线状态事件）
```
client.presenceManager.removeEventHandler('presence-ui');
```

publishPresence

publishPresence(params: PublishPresenceParams): Promise<void>
发布当前用户的自定义在线状态，该状态会作为在线状态扩展描述信息保存并下发给订阅者。
Parameters
- params: PublishPresenceParams
  发布参数，包含在线状态扩展描述信息与可选回调。
Returns Promise<void>
成功时 resolve，无返回业务数据。
Example: 调用示例（发布在线状态）
```
await client.presenceManager.publishPresence({
  customStatus: 'busy',
});
```
可能出现的错误码

Code 含义 HTTP 处理建议可重试

1100 发布自定义在线状态时，参数长度超出限制 400 缩短 customStatus 后重试否

Code	含义	HTTP	处理建议	可重试
1100	发布自定义在线状态时，参数长度超出限制	400	缩短 customStatus 后重试	否

subscribePresence

subscribePresence(
params: SubscribePresenceParams,
): Promise<SubscribePresenceResponse>

订阅指定用户的在线状态。订阅成功后，这些用户在线状态变更时会触发 Presence 事件回调。

Parameters

params: SubscribePresenceParams
订阅参数，包含用户列表、订阅时长与可选回调。

Returns Promise<SubscribePresenceResponse>

返回归一化后的在线状态列表。

Example: 调用示例（订阅用户在线状态）

const result = await client.presenceManager.subscribePresence({
  userIds: ['userA'],
  expiry: 3600,
});
console.log(result[0]?.publisher);

可能出现的错误码

Code	含义	HTTP	处理建议	可重试
1101	不能订阅自己的在线状态	400	从订阅列表中移除当前用户	否
1100	参数长度超限	400	减少单次订阅的用户数量	否

unsubscribePresence

unsubscribePresence(params: UnsubscribePresenceParams): Promise<void>
取消订阅指定用户的在线状态，成功后不再接收这些用户的在线状态变更事件。
Parameters
- params: UnsubscribePresenceParams
  取消订阅参数，包含用户列表与可选回调。
Returns Promise<void>
成功时 resolve，无返回业务数据。
Example: 调用示例（取消订阅）
```
await client.presenceManager.unsubscribePresence({
  userIds: ['userA'],
});
```
可能出现的错误码

Code 含义 HTTP 处理建议可重试

1100 参数长度超限 400 减少单次取消订阅的用户数量否

Code	含义	HTTP	处理建议	可重试
1100	参数长度超限	400	减少单次取消订阅的用户数量	否

getSubscribedPresenceList

getSubscribedPresenceList(
params: GetSubscribedPresenceListParams,
): Promise<SubscribedPresenceListResponse>
分页查询当前用户订阅了哪些用户的在线状态。
Parameters
- params: GetSubscribedPresenceListParams
  分页参数，包含页码、每页数量与可选回调。
Returns Promise<SubscribedPresenceListResponse>
返回订阅用户 ID 列表。
Example: 调用示例（分页查询订阅列表）
```
const list = await client.presenceManager.getSubscribedPresenceList({
  pageNum: 1,
  pageSize: 20,
});
console.log(list);
```
可能出现的错误码

Code 含义 HTTP 处理建议可重试

1100 参数长度超限 400 调整 pageNum 或 pageSize 后重试否

Code	含义	HTTP	处理建议	可重试
1100	参数长度超限	400	调整 pageNum 或 pageSize 后重试	否

getPresenceStatus

getPresenceStatus(
params: GetPresenceStatusParams,
): Promise<SubscribePresenceResponse>
查询指定用户的当前在线状态，不会建立订阅关系。
Parameters
- params: GetPresenceStatusParams
  查询参数，包含用户列表与可选回调。
Returns Promise<SubscribePresenceResponse>
返回归一化后的在线状态列表。
Example: 调用示例（查询在线状态）
```
const status = await client.presenceManager.getPresenceStatus({
  userIds: ['userA'],
});
console.log(status[0]?.statusList);
```
可能出现的错误码

Code 含义 HTTP 处理建议可重试

1100 参数长度超限 400 减少单次查询的用户数量否

Class PresenceManager

Index

Constructors

Methods

Constructors

constructor

Returns PresenceManager

Methods

addEventHandler

Parameters

可监听事件

Returns void

Example: 调用示例（注册在线状态事件）

removeEventHandler

Parameters

Returns void

Example: 调用示例（移除在线状态事件）

publishPresence

Parameters

Returns Promise<void>

Example: 调用示例（发布在线状态）

可能出现的错误码

subscribePresence

Parameters

Returns Promise<SubscribePresenceResponse>

Example: 调用示例（订阅用户在线状态）

可能出现的错误码

unsubscribePresence

Parameters

Returns Promise<void>

Example: 调用示例（取消订阅）

可能出现的错误码

getSubscribedPresenceList

Parameters

Returns Promise<SubscribedPresenceListResponse>

Example: 调用示例（分页查询订阅列表）

可能出现的错误码

getPresenceStatus

Parameters

Returns Promise<SubscribePresenceResponse>

Example: 调用示例（查询在线状态）

可能出现的错误码

Settings

On This Page