Presence | Easemob SDK API Reference

Presence contains APIs for presence operations.

Index

Functions

getPresenceStatus

getPresenceStatus(this: Connection, params: { usernames: string[]; error?: any; success?: any }): Promise<AsyncResult<SubscribePresenceResult>>

查询指定用户的当前在线状态。
```
connection.getPresenceStatus({usernames: ['user1','user2']})
```
Parameters
- this: Connection
- params: { usernames: string[]; error?: any; success?: any }
  - usernames: string[]
    
    用户 ID 数组，指定要查询哪些用户的在线状态。
  - error?:function
    - error(error: Common.ErrorEvent): void
    - Parameters
      - error: Common.ErrorEvent
      Returns void
  - success?:function
    - success(res: AsyncResult<SubscribePresenceResult>): void
    - Parameters
      - res: AsyncResult<SubscribePresenceResult>
      Returns void
Returns Promise<AsyncResult<SubscribePresenceResult>>

getSubscribedPresencelist

getSubscribedPresencelist(this: Connection, params: { pageNum: number; pageSize: number; error?: any; success?: any }): Promise<AsyncResult<GetSubscribedPresenceListResult>>

分页查询当前用户订阅了哪些用户的在线状态。
```
connection.getSubscribedPresencelist({usernames: ['user1','user2']})
```
Parameters
- this: Connection
- params: { pageNum: number; pageSize: number; error?: any; success?: any }
  - pageNum: number
    
    当前页码，从 1 开始。
  - pageSize: number
    
    每页显示的订阅用户数量。
  - error?:function
    - error(error: Common.ErrorEvent): void
    - Parameters
      - error: Common.ErrorEvent
      Returns void
  - success?:function
    - success(res: AsyncResult<GetSubscribedPresenceListResult>): void
    - Parameters
      - res: AsyncResult<GetSubscribedPresenceListResult>
      Returns void
Returns Promise<AsyncResult<GetSubscribedPresenceListResult>>

publishPresence

publishPresence(this: Connection, params: { description: string; error?: any; success?: any }): Promise<void>

发布自定义在线状态。
```
connection.publishPresence({description: 'music'})
```
Parameters
- this: Connection
- params: { description: string; error?: any; success?: any }
  - description: string
    
    在线状态扩展描述信息，可以为空。
  - error?:function
    - error(error: Common.ErrorEvent): void
    - Parameters
      - error: Common.ErrorEvent
      Returns void
  - success?:function
    - success(): void
    - Returns void
Returns Promise<void>

subscribePresence

subscribePresence(this: Connection, params: { expiry: number; usernames: string[]; error?: any; success?: any }): Promise<AsyncResult<SubscribePresenceResult>>

订阅指定用户的在线状态。订阅成功后，在线状态变更时订阅者会收到回调通知。
```
connection.subscribePresence({usernames: ['user1','user2'], expiry: 10000})
```
Parameters
- this: Connection
- params: { expiry: number; usernames: string[]; error?: any; success?: any }
  - expiry: number
    
    订阅时长。
  - usernames: string[]
    
    要订阅在线状态的用户 ID 数组。
  - error?:function
    - error(error: Common.ErrorEvent): void
    - Parameters
      - error: Common.ErrorEvent
      Returns void
  - success?:function
    - success(res: AsyncResult<SubscribePresenceResult>): void
    - Parameters
      - res: AsyncResult<SubscribePresenceResult>
      Returns void
Returns Promise<AsyncResult<SubscribePresenceResult>>

unsubscribePresence

unsubscribePresence(this: Connection, params: { usernames: string[]; error?: any; success?: any }): Promise<void>

取消订阅指定用户的在线状态。
```
connection.unsubscribePresence({usernames: ['user1','user2']})
```
Parameters
- this: Connection
- params: { usernames: string[]; error?: any; success?: any }
  - usernames: string[]
    
    要取消订阅在线状态的用户 ID 数组。
  - error?:function
    - error(error: Common.ErrorEvent): void
    - Parameters
      - error: Common.ErrorEvent
      Returns void
  - success?:function
    - success(): void
    - Returns void
Returns Promise<void>

Index

Functions

Functions

getPresenceStatus

Parameters

this: Connection

params: { usernames: string[]; error?: any; success?: any }

usernames: string[]

error?:function

Parameters

error: Common.ErrorEvent

Returns void

success?:function

Parameters

res: AsyncResult<SubscribePresenceResult>

Returns void

Returns Promise<AsyncResult<SubscribePresenceResult>>

getSubscribedPresencelist

Parameters

this: Connection

params: { pageNum: number; pageSize: number; error?: any; success?: any }

pageNum: number

pageSize: number

error?:function

Parameters

error: Common.ErrorEvent

Returns void

success?:function

Parameters

res: AsyncResult<GetSubscribedPresenceListResult>

Returns void

Returns Promise<AsyncResult<GetSubscribedPresenceListResult>>

publishPresence

Parameters

this: Connection

params: { description: string; error?: any; success?: any }

description: string

error?:function

Parameters

error: Common.ErrorEvent

Returns void

success?:function

Returns void

Returns Promise<void>

subscribePresence

Parameters

this: Connection

params: { expiry: number; usernames: string[]; error?: any; success?: any }

expiry: number

usernames: string[]

error?:function

Parameters

error: Common.ErrorEvent

Returns void

success?:function

Parameters

res: AsyncResult<SubscribePresenceResult>

Returns void

Returns Promise<AsyncResult<SubscribePresenceResult>>

unsubscribePresence

Parameters

this: Connection

params: { usernames: string[]; error?: any; success?: any }

usernames: string[]

error?:function

Parameters

error: Common.ErrorEvent

Returns void

success?:function

Returns void

Returns Promise<void>