程序包 com.easemob.im.api

类 PresenceApi

java.lang.Object
com.easemob.im.api.PresenceApi
public class PresenceApi extends Object

  • 构造器详细资料

    • PresenceApi

      public PresenceApi()

    • PresenceApi

      public PresenceApi(ApiClient apiClient)

  • 方法详细资料

    • getApiClient

      public ApiClient getApiClient()

    • setApiClient

      public void setApiClient(ApiClient apiClient)

    • getHostIndex

      public int getHostIndex()

    • setHostIndex

      public void setHostIndex(int hostIndex)

    • getCustomBaseUrl

      public String getCustomBaseUrl()

    • setCustomBaseUrl

      public void setCustomBaseUrl(String customBaseUrl)

    • getGroupOnlineMemberCountCall

      public okhttp3.Call getGroupOnlineMemberCountCall(String groupId, Integer queryType, ApiCallback _callback) throws ApiException
      Build call for getGroupOnlineMemberCount
      参数:
      groupId - 群组 ID (required)
      queryType - 查询类型，查询群组的在线成员数量，传 1 即可 (required)
      _callback - Callback for upload/download progress
      返回:
      Call to execute
      抛出:
      ApiException - If fail to serialize the request body object http.response.details

    • getGroupOnlineMemberCount

      public EMGetGroupOnlineMemberCountResult getGroupOnlineMemberCount(String groupId, Integer queryType) throws ApiException
      查询单个群组的在线成员数量 你可以查询单个群组的在线成员数量。如需使用该 API，需要联系环信商务开通。这里的在线状态指用户的 app 与服务器成功建立连接，不包括用户的自定义在线状态，如忙碌、马上回来等。文档介绍：https://docs-im-beta.easemob.com/document/server-side/presence.html#%E6%9F%A5%E8%AF%A2%E5%8D%95%E4%B8%AA%E7%BE%A4%E7%BB%84%E7%9A%84%E5%9C%A8%E7%BA%BF%E6%88%90%E5%91%98%E6%95%B0%E9%87%8F
      参数:
      groupId - 群组 ID (required)
      queryType - 查询类型，查询群组的在线成员数量，传 1 即可 (required)
      返回:
      EMGetGroupOnlineMemberCountResult
      抛出:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body http.response.details

    • getGroupOnlineMemberCountWithHttpInfo

      public ApiResponse<EMGetGroupOnlineMemberCountResult> getGroupOnlineMemberCountWithHttpInfo(String groupId, Integer queryType) throws ApiException
      查询单个群组的在线成员数量 你可以查询单个群组的在线成员数量。如需使用该 API，需要联系环信商务开通。这里的在线状态指用户的 app 与服务器成功建立连接，不包括用户的自定义在线状态，如忙碌、马上回来等。文档介绍：https://docs-im-beta.easemob.com/document/server-side/presence.html#%E6%9F%A5%E8%AF%A2%E5%8D%95%E4%B8%AA%E7%BE%A4%E7%BB%84%E7%9A%84%E5%9C%A8%E7%BA%BF%E6%88%90%E5%91%98%E6%95%B0%E9%87%8F
      参数:
      groupId - 群组 ID (required)
      queryType - 查询类型，查询群组的在线成员数量，传 1 即可 (required)
      返回:
      ApiResponse<EMGetGroupOnlineMemberCountResult>
      抛出:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body http.response.details

    • getGroupOnlineMemberCountAsync

      public okhttp3.Call getGroupOnlineMemberCountAsync(String groupId, Integer queryType, ApiCallback<EMGetGroupOnlineMemberCountResult> _callback) throws ApiException
      查询单个群组的在线成员数量 (asynchronously) 你可以查询单个群组的在线成员数量。如需使用该 API，需要联系环信商务开通。这里的在线状态指用户的 app 与服务器成功建立连接，不包括用户的自定义在线状态，如忙碌、马上回来等。文档介绍：https://docs-im-beta.easemob.com/document/server-side/presence.html#%E6%9F%A5%E8%AF%A2%E5%8D%95%E4%B8%AA%E7%BE%A4%E7%BB%84%E7%9A%84%E5%9C%A8%E7%BA%BF%E6%88%90%E5%91%98%E6%95%B0%E9%87%8F
      参数:
      groupId - 群组 ID (required)
      queryType - 查询类型，查询群组的在线成员数量，传 1 即可 (required)
      _callback - The callback to be executed when the API call finishes
      返回:
      The request call
      抛出:
      ApiException - If fail to process the API call, e.g. serializing the request body object http.response.details

    • getMultipleUserPresenceStatusCall

      public okhttp3.Call getMultipleUserPresenceStatusCall(String username, EMGetMultipleUsersPresenceStatus emGetMultipleUsersPresenceStatus, ApiCallback _callback) throws ApiException
      Build call for getMultipleUserPresenceStatus
      参数:
      username - (required)
      emGetMultipleUsersPresenceStatus - (optional)
      _callback - Callback for upload/download progress
      返回:
      Call to execute
      抛出:
      ApiException - If fail to serialize the request body object http.response.details

    • getMultipleUserPresenceStatus

      public EMGetMultipleUsersPresenceStatusResult getMultipleUserPresenceStatus(String username, EMGetMultipleUsersPresenceStatus emGetMultipleUsersPresenceStatus) throws ApiException
      批量获取在线状态信息 你一次可获取多个用户的在线状态信息。文档介绍：https://docs-im-beta.easemob.com/document/server-side/presence.html#%E6%89%B9%E9%87%8F%E8%8E%B7%E5%8F%96%E5%9C%A8%E7%BA%BF%E7%8A%B6%E6%80%81%E4%BF%A1%E6%81%AF
      参数:
      username - (required)
      emGetMultipleUsersPresenceStatus - (optional)
      返回:
      EMGetMultipleUsersPresenceStatusResult
      抛出:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body http.response.details

    • getMultipleUserPresenceStatusWithHttpInfo

      public ApiResponse<EMGetMultipleUsersPresenceStatusResult> getMultipleUserPresenceStatusWithHttpInfo(String username, EMGetMultipleUsersPresenceStatus emGetMultipleUsersPresenceStatus) throws ApiException
      批量获取在线状态信息 你一次可获取多个用户的在线状态信息。文档介绍：https://docs-im-beta.easemob.com/document/server-side/presence.html#%E6%89%B9%E9%87%8F%E8%8E%B7%E5%8F%96%E5%9C%A8%E7%BA%BF%E7%8A%B6%E6%80%81%E4%BF%A1%E6%81%AF
      参数:
      username - (required)
      emGetMultipleUsersPresenceStatus - (optional)
      返回:
      ApiResponse<EMGetMultipleUsersPresenceStatusResult>
      抛出:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body http.response.details

    • getMultipleUserPresenceStatusAsync

      public okhttp3.Call getMultipleUserPresenceStatusAsync(String username, EMGetMultipleUsersPresenceStatus emGetMultipleUsersPresenceStatus, ApiCallback<EMGetMultipleUsersPresenceStatusResult> _callback) throws ApiException
      批量获取在线状态信息 (asynchronously) 你一次可获取多个用户的在线状态信息。文档介绍：https://docs-im-beta.easemob.com/document/server-side/presence.html#%E6%89%B9%E9%87%8F%E8%8E%B7%E5%8F%96%E5%9C%A8%E7%BA%BF%E7%8A%B6%E6%80%81%E4%BF%A1%E6%81%AF
      参数:
      username - (required)
      emGetMultipleUsersPresenceStatus - (optional)
      _callback - The callback to be executed when the API call finishes
      返回:
      The request call
      抛出:
      ApiException - If fail to process the API call, e.g. serializing the request body object http.response.details

    • getUserSubscriptionListCall

      public okhttp3.Call getUserSubscriptionListCall(String username, Integer pageNum, Integer pageSize, ApiCallback _callback) throws ApiException
      Build call for getUserSubscriptionList
      参数:
      username - (required)
      pageNum - 要查询的页码。该参数的值须大于等于 1。若不传，默认值为 1 (optional)
      pageSize - 每页显示的订阅用户数量。取值范围为 [1,500]，若不传默认值为 1 (optional)
      _callback - Callback for upload/download progress
      返回:
      Call to execute
      抛出:
      ApiException - If fail to serialize the request body object http.response.details

    • getUserSubscriptionList

      public EMGetUserSubscriptionListResult getUserSubscriptionList(String username, Integer pageNum, Integer pageSize) throws ApiException
      查询订阅列表 查询当前用户已订阅在线状态的用户列表。文档介绍：https://docs-im-beta.easemob.com/document/server-side/presence.html#%E6%9F%A5%E8%AF%A2%E8%AE%A2%E9%98%85%E5%88%97%E8%A1%A8
      参数:
      username - (required)
      pageNum - 要查询的页码。该参数的值须大于等于 1。若不传，默认值为 1 (optional)
      pageSize - 每页显示的订阅用户数量。取值范围为 [1,500]，若不传默认值为 1 (optional)
      返回:
      EMGetUserSubscriptionListResult
      抛出:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body http.response.details

    • getUserSubscriptionListWithHttpInfo

      public ApiResponse<EMGetUserSubscriptionListResult> getUserSubscriptionListWithHttpInfo(String username, Integer pageNum, Integer pageSize) throws ApiException
      查询订阅列表 查询当前用户已订阅在线状态的用户列表。文档介绍：https://docs-im-beta.easemob.com/document/server-side/presence.html#%E6%9F%A5%E8%AF%A2%E8%AE%A2%E9%98%85%E5%88%97%E8%A1%A8
      参数:
      username - (required)
      pageNum - 要查询的页码。该参数的值须大于等于 1。若不传，默认值为 1 (optional)
      pageSize - 每页显示的订阅用户数量。取值范围为 [1,500]，若不传默认值为 1 (optional)
      返回:
      ApiResponse<EMGetUserSubscriptionListResult>
      抛出:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body http.response.details

    • getUserSubscriptionListAsync

      public okhttp3.Call getUserSubscriptionListAsync(String username, Integer pageNum, Integer pageSize, ApiCallback<EMGetUserSubscriptionListResult> _callback) throws ApiException
      查询订阅列表 (asynchronously) 查询当前用户已订阅在线状态的用户列表。文档介绍：https://docs-im-beta.easemob.com/document/server-side/presence.html#%E6%9F%A5%E8%AF%A2%E8%AE%A2%E9%98%85%E5%88%97%E8%A1%A8
      参数:
      username - (required)
      pageNum - 要查询的页码。该参数的值须大于等于 1。若不传，默认值为 1 (optional)
      pageSize - 每页显示的订阅用户数量。取值范围为 [1,500]，若不传默认值为 1 (optional)
      _callback - The callback to be executed when the API call finishes
      返回:
      The request call
      抛出:
      ApiException - If fail to process the API call, e.g. serializing the request body object http.response.details

    • setUserPresenceStatusCall

      public okhttp3.Call setUserPresenceStatusCall(String username, String resource, String status, EMSetUserPresenceStatus emSetUserPresenceStatus, ApiCallback _callback) throws ApiException
      Build call for setUserPresenceStatus
      参数:
      username - (required)
      resource - 要设置用户在哪个设备的在线状态信息，即传入服务器分配给每个设备资源的唯一标识符，格式为 {device type}_{resource ID}，其中设备类型 device type 可以是 android、ios 或 web，资源 ID resource ID 由 SDK 分配。例如，android_123423453246 (required)
      status - 用户的在线状态： - 0：离线； - 1：在线； - 其它数字字符串：自定义在线状态 (required)
      emSetUserPresenceStatus - (optional)
      _callback - Callback for upload/download progress
      返回:
      Call to execute
      抛出:
      ApiException - If fail to serialize the request body object http.response.details

    • setUserPresenceStatus

      public EMSetUserPresenceStatusResult setUserPresenceStatus(String username, String resource, String status, EMSetUserPresenceStatus emSetUserPresenceStatus) throws ApiException
      设置用户在线状态信息 可以设置用户在指定设备的在线状态信息。文档介绍：https://docs-im-beta.easemob.com/document/server-side/presence.html#%E8%AE%BE%E7%BD%AE%E7%94%A8%E6%88%B7%E5%9C%A8%E7%BA%BF%E7%8A%B6%E6%80%81%E4%BF%A1%E6%81%AF
      参数:
      username - (required)
      resource - 要设置用户在哪个设备的在线状态信息，即传入服务器分配给每个设备资源的唯一标识符，格式为 {device type}_{resource ID}，其中设备类型 device type 可以是 android、ios 或 web，资源 ID resource ID 由 SDK 分配。例如，android_123423453246 (required)
      status - 用户的在线状态： - 0：离线； - 1：在线； - 其它数字字符串：自定义在线状态 (required)
      emSetUserPresenceStatus - (optional)
      返回:
      EMSetUserPresenceStatusResult
      抛出:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body http.response.details

    • setUserPresenceStatusWithHttpInfo

      public ApiResponse<EMSetUserPresenceStatusResult> setUserPresenceStatusWithHttpInfo(String username, String resource, String status, EMSetUserPresenceStatus emSetUserPresenceStatus) throws ApiException
      设置用户在线状态信息 可以设置用户在指定设备的在线状态信息。文档介绍：https://docs-im-beta.easemob.com/document/server-side/presence.html#%E8%AE%BE%E7%BD%AE%E7%94%A8%E6%88%B7%E5%9C%A8%E7%BA%BF%E7%8A%B6%E6%80%81%E4%BF%A1%E6%81%AF
      参数:
      username - (required)
      resource - 要设置用户在哪个设备的在线状态信息，即传入服务器分配给每个设备资源的唯一标识符，格式为 {device type}_{resource ID}，其中设备类型 device type 可以是 android、ios 或 web，资源 ID resource ID 由 SDK 分配。例如，android_123423453246 (required)
      status - 用户的在线状态： - 0：离线； - 1：在线； - 其它数字字符串：自定义在线状态 (required)
      emSetUserPresenceStatus - (optional)
      返回:
      ApiResponse<EMSetUserPresenceStatusResult>
      抛出:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body http.response.details

    • setUserPresenceStatusAsync

      public okhttp3.Call setUserPresenceStatusAsync(String username, String resource, String status, EMSetUserPresenceStatus emSetUserPresenceStatus, ApiCallback<EMSetUserPresenceStatusResult> _callback) throws ApiException
      设置用户在线状态信息 (asynchronously) 可以设置用户在指定设备的在线状态信息。文档介绍：https://docs-im-beta.easemob.com/document/server-side/presence.html#%E8%AE%BE%E7%BD%AE%E7%94%A8%E6%88%B7%E5%9C%A8%E7%BA%BF%E7%8A%B6%E6%80%81%E4%BF%A1%E6%81%AF
      参数:
      username - (required)
      resource - 要设置用户在哪个设备的在线状态信息，即传入服务器分配给每个设备资源的唯一标识符，格式为 {device type}_{resource ID}，其中设备类型 device type 可以是 android、ios 或 web，资源 ID resource ID 由 SDK 分配。例如，android_123423453246 (required)
      status - 用户的在线状态： - 0：离线； - 1：在线； - 其它数字字符串：自定义在线状态 (required)
      emSetUserPresenceStatus - (optional)
      _callback - The callback to be executed when the API call finishes
      返回:
      The request call
      抛出:
      ApiException - If fail to process the API call, e.g. serializing the request body object http.response.details

    • subscribeMultipleUsersPresenceStatusCall

      public okhttp3.Call subscribeMultipleUsersPresenceStatusCall(String username, String expiry, EMSubscribeMultipleUsersPresenceStatus emSubscribeMultipleUsersPresenceStatus, ApiCallback _callback) throws ApiException
      Build call for subscribeMultipleUsersPresenceStatus
      参数:
      username - (required)
      expiry - 订阅时长，单位为秒，最大值为 2,592,000，即 30 天 (required)
      emSubscribeMultipleUsersPresenceStatus - (optional)
      _callback - Callback for upload/download progress
      返回:
      Call to execute
      抛出:
      ApiException - If fail to serialize the request body object http.response.details

    • subscribeMultipleUsersPresenceStatus

      public EMSubscribeMultipleUsersPresenceStatusResult subscribeMultipleUsersPresenceStatus(String username, String expiry, EMSubscribeMultipleUsersPresenceStatus emSubscribeMultipleUsersPresenceStatus) throws ApiException
      批量订阅在线状态 一次可订阅多个用户的在线状态。文档介绍：https://docs-im-beta.easemob.com/document/server-side/presence.html#%E6%89%B9%E9%87%8F%E8%AE%A2%E9%98%85%E5%9C%A8%E7%BA%BF%E7%8A%B6%E6%80%81
      参数:
      username - (required)
      expiry - 订阅时长，单位为秒，最大值为 2,592,000，即 30 天 (required)
      emSubscribeMultipleUsersPresenceStatus - (optional)
      返回:
      EMSubscribeMultipleUsersPresenceStatusResult
      抛出:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body http.response.details

    • subscribeMultipleUsersPresenceStatusWithHttpInfo

      public ApiResponse<EMSubscribeMultipleUsersPresenceStatusResult> subscribeMultipleUsersPresenceStatusWithHttpInfo(String username, String expiry, EMSubscribeMultipleUsersPresenceStatus emSubscribeMultipleUsersPresenceStatus) throws ApiException
      批量订阅在线状态 一次可订阅多个用户的在线状态。文档介绍：https://docs-im-beta.easemob.com/document/server-side/presence.html#%E6%89%B9%E9%87%8F%E8%AE%A2%E9%98%85%E5%9C%A8%E7%BA%BF%E7%8A%B6%E6%80%81
      参数:
      username - (required)
      expiry - 订阅时长，单位为秒，最大值为 2,592,000，即 30 天 (required)
      emSubscribeMultipleUsersPresenceStatus - (optional)
      返回:
      ApiResponse<EMSubscribeMultipleUsersPresenceStatusResult>
      抛出:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body http.response.details

    • subscribeMultipleUsersPresenceStatusAsync

      public okhttp3.Call subscribeMultipleUsersPresenceStatusAsync(String username, String expiry, EMSubscribeMultipleUsersPresenceStatus emSubscribeMultipleUsersPresenceStatus, ApiCallback<EMSubscribeMultipleUsersPresenceStatusResult> _callback) throws ApiException
      批量订阅在线状态 (asynchronously) 一次可订阅多个用户的在线状态。文档介绍：https://docs-im-beta.easemob.com/document/server-side/presence.html#%E6%89%B9%E9%87%8F%E8%AE%A2%E9%98%85%E5%9C%A8%E7%BA%BF%E7%8A%B6%E6%80%81
      参数:
      username - (required)
      expiry - 订阅时长，单位为秒，最大值为 2,592,000，即 30 天 (required)
      emSubscribeMultipleUsersPresenceStatus - (optional)
      _callback - The callback to be executed when the API call finishes
      返回:
      The request call
      抛出:
      ApiException - If fail to process the API call, e.g. serializing the request body object http.response.details

    • unsubscribeMultipleUsersPresenceStatusCall

      public okhttp3.Call unsubscribeMultipleUsersPresenceStatusCall(String username, List<String> requestBody, ApiCallback _callback) throws ApiException
      Build call for unsubscribeMultipleUsersPresenceStatus
      参数:
      username - (required)
      requestBody - (optional)
      _callback - Callback for upload/download progress
      返回:
      Call to execute
      抛出:
      ApiException - If fail to serialize the request body object http.response.details

    • unsubscribeMultipleUsersPresenceStatus

      public EMUnsubscribeMultipleUsersPresenceStatusResult unsubscribeMultipleUsersPresenceStatus(String username, List<String> requestBody) throws ApiException
      取消订阅多个用户的在线状态 取消订阅多个用户的在线状态。文档介绍：https://docs-im-beta.easemob.com/document/server-side/presence.html#%E5%8F%96%E6%B6%88%E8%AE%A2%E9%98%85%E5%A4%9A%E4%B8%AA%E7%94%A8%E6%88%B7%E7%9A%84%E5%9C%A8%E7%BA%BF%E7%8A%B6%E6%80%81
      参数:
      username - (required)
      requestBody - (optional)
      返回:
      EMUnsubscribeMultipleUsersPresenceStatusResult
      抛出:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body http.response.details

    • unsubscribeMultipleUsersPresenceStatusWithHttpInfo

      public ApiResponse<EMUnsubscribeMultipleUsersPresenceStatusResult> unsubscribeMultipleUsersPresenceStatusWithHttpInfo(String username, List<String> requestBody) throws ApiException
      取消订阅多个用户的在线状态 取消订阅多个用户的在线状态。文档介绍：https://docs-im-beta.easemob.com/document/server-side/presence.html#%E5%8F%96%E6%B6%88%E8%AE%A2%E9%98%85%E5%A4%9A%E4%B8%AA%E7%94%A8%E6%88%B7%E7%9A%84%E5%9C%A8%E7%BA%BF%E7%8A%B6%E6%80%81
      参数:
      username - (required)
      requestBody - (optional)
      返回:
      ApiResponse<EMUnsubscribeMultipleUsersPresenceStatusResult>
      抛出:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body http.response.details

    • unsubscribeMultipleUsersPresenceStatusAsync

      public okhttp3.Call unsubscribeMultipleUsersPresenceStatusAsync(String username, List<String> requestBody, ApiCallback<EMUnsubscribeMultipleUsersPresenceStatusResult> _callback) throws ApiException
      取消订阅多个用户的在线状态 (asynchronously) 取消订阅多个用户的在线状态。文档介绍：https://docs-im-beta.easemob.com/document/server-side/presence.html#%E5%8F%96%E6%B6%88%E8%AE%A2%E9%98%85%E5%A4%9A%E4%B8%AA%E7%94%A8%E6%88%B7%E7%9A%84%E5%9C%A8%E7%BA%BF%E7%8A%B6%E6%80%81
      参数:
      username - (required)
      requestBody - (optional)
      _callback - The callback to be executed when the API call finishes
      返回:
      The request call
      抛出:
      ApiException - If fail to process the API call, e.g. serializing the request body object http.response.details