Options
All
  • Public
  • Public/Protected
  • All
Menu

Module PRESENCE APIS

Index

Functions

Functions

getPresenceStatus

  • getPresenceStatus(params: { usernames: string[]; error?: any; success?: any }): Promise<AsyncResult<PresenceTypes.SubscribePresenceResult>>

  • 查询指定用户的当前在线状态。

    connection.getPresenceStatus({usernames: ['user1','user2']})

    Parameters

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

        用户 ID 数组，指定要查询哪些用户的在线状态。

      • error?:function
        • error(error: ErrorEvent): void

        • Parameters

          • error: ErrorEvent

          Returns void

      • success?:function
        • success(res: AsyncResult<SubscribePresenceResult>): void

        • Parameters

          Returns void

    Returns Promise<AsyncResult<PresenceTypes.SubscribePresenceResult>>

getSubscribedPresenceList

  • getSubscribedPresenceList(params: { pageNum: number; pageSize: number; error?: any; success?: any }): Promise<AsyncResult<PresenceTypes.GetSubscribedPresenceListResult>>

  • 分页查询当前用户订阅了哪些用户的在线状态。

    connection.getSubscribedPresenceList({usernames: ['user1','user2']})

    Parameters

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

        当前页码，从 1 开始。

      • pageSize: number

        每页显示的订阅用户数量。

      • error?:function
        • error(error: ErrorEvent): void

        • Parameters

          • error: ErrorEvent

          Returns void

      • success?:function
        • success(res: AsyncResult<GetSubscribedPresenceListResult>): void

        • Parameters

          Returns void

    Returns Promise<AsyncResult<PresenceTypes.GetSubscribedPresenceListResult>>

publishPresence

  • publishPresence(params: { description: string; error?: any; success?: any }): void | Promise<AsyncResult<PresenceTypes.PublishPresenceResult>>

  • 发布自定义在线状态。

    connection.publishPresence({description: 'music'})

    Parameters

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

        在线状态扩展描述信息，可以为空。

      • error?:function
        • error(error: ErrorEvent): void

        • Parameters

          • error: ErrorEvent

          Returns void

      • success?:function

        • Parameters

          Returns void

    Returns void | Promise<AsyncResult<PresenceTypes.PublishPresenceResult>>

subscribePresence

  • subscribePresence(params: { expiry: number; usernames: string[]; error?: any; success?: any }): Promise<AsyncResult<PresenceTypes.SubscribePresenceResult>>

  • 订阅指定用户的在线状态。订阅成功后，在线状态变更时订阅者会收到回调通知。

    connection.subscribePresence({usernames: ['user1','user2'], expiry: 10000})

    Parameters

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

        订阅时长。

      • usernames: string[]

        要订阅在线状态的用户 ID 数组。

      • error?:function
        • error(error: ErrorEvent): void

        • Parameters

          • error: ErrorEvent

          Returns void

      • success?:function
        • success(res: AsyncResult<SubscribePresenceResult>): void

        • Parameters

          Returns void

    Returns Promise<AsyncResult<PresenceTypes.SubscribePresenceResult>>

unsubscribePresence

  • unsubscribePresence(params: { usernames: string[]; error?: any; success?: any }): Promise<AsyncResult<PresenceTypes.PublishPresenceResult>>

  • 取消订阅指定用户的在线状态。

    connection.unsubscribePresence({usernames: ['user1','user2']})

    Parameters

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

        要取消订阅在线状态的用户 ID 数组。

      • error?:function
        • error(error: ErrorEvent): void

        • Parameters

          • error: ErrorEvent

          Returns void

      • success?:function

        • Parameters

          Returns void

    Returns Promise<AsyncResult<PresenceTypes.PublishPresenceResult>>

Generated using TypeDoc