类 ReactionApi
java.lang.Object
com.easemob.im.api.ReactionApi
-
构造器概要
构造器 -
方法概要
修饰符和类型方法说明deleteReaction(String username, String msgId, String message) 删除 Reaction 删除当前用户追加的 Reaction。okhttp3.CalldeleteReactionAsync(String username, String msgId, String message, ApiCallback<EMDeleteReactionResult> _callback) 删除 Reaction (asynchronously) 删除当前用户追加的 Reaction。okhttp3.CalldeleteReactionCall(String username, String msgId, String message, ApiCallback _callback) Build call for deleteReactiondeleteReactionWithHttpInfo(String username, String msgId, String message) 删除 Reaction 删除当前用户追加的 Reaction。int根据消息 ID 获取 Reaction 该方法根据单聊或群聊中的消息 ID 获取单个或多个消息的 Reaction 信息,包括 Reaction ID、使用的表情 ID、以及使用该 Reaction 的用户 ID 及用户人数。okhttp3.CallgetReactionAsync(String username, List<String> msgIdList, String msgType, String groupId, ApiCallback<EMGetReactionResult> _callback) 根据消息 ID 获取 Reaction (asynchronously) 该方法根据单聊或群聊中的消息 ID 获取单个或多个消息的 Reaction 信息,包括 Reaction ID、使用的表情 ID、以及使用该 Reaction 的用户 ID 及用户人数。okhttp3.CallgetReactionCall(String username, List<String> msgIdList, String msgType, String groupId, ApiCallback _callback) Build call for getReaction根据消息 ID 和表情 ID 获取 Reaction 信息 在单聊或群聊场景中对单条消息创建或追加 Reaction。okhttp3.CallgetReactionDetailAsync(String username, String msgId, String message, Integer limit, String cursor, ApiCallback<EMGetReactionDetailResult> _callback) 根据消息 ID 和表情 ID 获取 Reaction 信息 (asynchronously) 在单聊或群聊场景中对单条消息创建或追加 Reaction。okhttp3.CallgetReactionDetailCall(String username, String msgId, String message, Integer limit, String cursor, ApiCallback _callback) Build call for getReactionDetailgetReactionDetailWithHttpInfo(String username, String msgId, String message, Integer limit, String cursor) 根据消息 ID 和表情 ID 获取 Reaction 信息 在单聊或群聊场景中对单条消息创建或追加 Reaction。根据消息 ID 获取 Reaction 该方法根据单聊或群聊中的消息 ID 获取单个或多个消息的 Reaction 信息,包括 Reaction ID、使用的表情 ID、以及使用该 Reaction 的用户 ID 及用户人数。voidsetApiClient(ApiClient apiClient) voidsetCustomBaseUrl(String customBaseUrl) voidsetHostIndex(int hostIndex) setReaction(String username, EMSetReaction emSetReaction) 创建/追加 Reaction 在单聊或群聊场景中对单条消息创建或追加 Reaction。okhttp3.CallsetReactionAsync(String username, EMSetReaction emSetReaction, ApiCallback<EMSetReactionResult> _callback) 创建/追加 Reaction (asynchronously) 在单聊或群聊场景中对单条消息创建或追加 Reaction。okhttp3.CallsetReactionCall(String username, EMSetReaction emSetReaction, ApiCallback _callback) Build call for setReactionsetReactionWithHttpInfo(String username, EMSetReaction emSetReaction) 创建/追加 Reaction 在单聊或群聊场景中对单条消息创建或追加 Reaction。
-
构造器详细资料
-
ReactionApi
public ReactionApi() -
ReactionApi
-
-
方法详细资料
-
getApiClient
-
setApiClient
-
getHostIndex
public int getHostIndex() -
setHostIndex
public void setHostIndex(int hostIndex) -
getCustomBaseUrl
-
setCustomBaseUrl
-
deleteReactionCall
public okhttp3.Call deleteReactionCall(String username, String msgId, String message, ApiCallback _callback) throws ApiException Build call for deleteReaction- 参数:
username- (required)msgId- 消息 ID (required)message- 表情 ID。长度不可超过 128 个字符。该参数的值必须与客户端一致 (required)_callback- Callback for upload/download progress- 返回:
- Call to execute
- 抛出:
ApiException- If fail to serialize the request body object http.response.details
-
deleteReaction
public EMDeleteReactionResult deleteReaction(String username, String msgId, String message) throws ApiException 删除 Reaction 删除当前用户追加的 Reaction。文档介绍:https://docs-im-beta.easemob.com/document/server-side/reaction.html#%E5%88%A0%E9%99%A4-reaction- 参数:
username- (required)msgId- 消息 ID (required)message- 表情 ID。长度不可超过 128 个字符。该参数的值必须与客户端一致 (required)- 返回:
- EMDeleteReactionResult
- 抛出:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body http.response.details
-
deleteReactionWithHttpInfo
public ApiResponse<EMDeleteReactionResult> deleteReactionWithHttpInfo(String username, String msgId, String message) throws ApiException 删除 Reaction 删除当前用户追加的 Reaction。文档介绍:https://docs-im-beta.easemob.com/document/server-side/reaction.html#%E5%88%A0%E9%99%A4-reaction- 参数:
username- (required)msgId- 消息 ID (required)message- 表情 ID。长度不可超过 128 个字符。该参数的值必须与客户端一致 (required)- 返回:
- ApiResponse<EMDeleteReactionResult>
- 抛出:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body http.response.details
-
deleteReactionAsync
public okhttp3.Call deleteReactionAsync(String username, String msgId, String message, ApiCallback<EMDeleteReactionResult> _callback) throws ApiException 删除 Reaction (asynchronously) 删除当前用户追加的 Reaction。文档介绍:https://docs-im-beta.easemob.com/document/server-side/reaction.html#%E5%88%A0%E9%99%A4-reaction- 参数:
username- (required)msgId- 消息 ID (required)message- 表情 ID。长度不可超过 128 个字符。该参数的值必须与客户端一致 (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
-
getReactionCall
public okhttp3.Call getReactionCall(String username, List<String> msgIdList, String msgType, String groupId, ApiCallback _callback) throws ApiException Build call for getReaction- 参数:
username- (required)msgIdList- 需要查询的消息 ID 列表,最多可传 20 个消息 ID (required)msgType- 消息的会话类型: - chat:单聊; - groupchat:群聊 (required)groupId- 群组 ID。如果 msgType 设置为 groupchat,即拉取群中的 Reaction,必须指定群组 ID (optional)_callback- Callback for upload/download progress- 返回:
- Call to execute
- 抛出:
ApiException- If fail to serialize the request body object http.response.details
-
getReaction
public EMGetReactionResult getReaction(String username, List<String> msgIdList, String msgType, String groupId) throws ApiException 根据消息 ID 获取 Reaction 该方法根据单聊或群聊中的消息 ID 获取单个或多个消息的 Reaction 信息,包括 Reaction ID、使用的表情 ID、以及使用该 Reaction 的用户 ID 及用户人数。获取的 Reaction 的用户列表只展示最早三个添加 Reaction 的用户。文档介绍:https://docs-im-beta.easemob.com/document/server-side/reaction.html#%E6%A0%B9%E6%8D%AE%E6%B6%88%E6%81%AF-id-%E8%8E%B7%E5%8F%96-reaction- 参数:
username- (required)msgIdList- 需要查询的消息 ID 列表,最多可传 20 个消息 ID (required)msgType- 消息的会话类型: - chat:单聊; - groupchat:群聊 (required)groupId- 群组 ID。如果 msgType 设置为 groupchat,即拉取群中的 Reaction,必须指定群组 ID (optional)- 返回:
- EMGetReactionResult
- 抛出:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body http.response.details
-
getReactionWithHttpInfo
public ApiResponse<EMGetReactionResult> getReactionWithHttpInfo(String username, List<String> msgIdList, String msgType, String groupId) throws ApiException 根据消息 ID 获取 Reaction 该方法根据单聊或群聊中的消息 ID 获取单个或多个消息的 Reaction 信息,包括 Reaction ID、使用的表情 ID、以及使用该 Reaction 的用户 ID 及用户人数。获取的 Reaction 的用户列表只展示最早三个添加 Reaction 的用户。文档介绍:https://docs-im-beta.easemob.com/document/server-side/reaction.html#%E6%A0%B9%E6%8D%AE%E6%B6%88%E6%81%AF-id-%E8%8E%B7%E5%8F%96-reaction- 参数:
username- (required)msgIdList- 需要查询的消息 ID 列表,最多可传 20 个消息 ID (required)msgType- 消息的会话类型: - chat:单聊; - groupchat:群聊 (required)groupId- 群组 ID。如果 msgType 设置为 groupchat,即拉取群中的 Reaction,必须指定群组 ID (optional)- 返回:
- ApiResponse<EMGetReactionResult>
- 抛出:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body http.response.details
-
getReactionAsync
public okhttp3.Call getReactionAsync(String username, List<String> msgIdList, String msgType, String groupId, ApiCallback<EMGetReactionResult> _callback) throws ApiException 根据消息 ID 获取 Reaction (asynchronously) 该方法根据单聊或群聊中的消息 ID 获取单个或多个消息的 Reaction 信息,包括 Reaction ID、使用的表情 ID、以及使用该 Reaction 的用户 ID 及用户人数。获取的 Reaction 的用户列表只展示最早三个添加 Reaction 的用户。文档介绍:https://docs-im-beta.easemob.com/document/server-side/reaction.html#%E6%A0%B9%E6%8D%AE%E6%B6%88%E6%81%AF-id-%E8%8E%B7%E5%8F%96-reaction- 参数:
username- (required)msgIdList- 需要查询的消息 ID 列表,最多可传 20 个消息 ID (required)msgType- 消息的会话类型: - chat:单聊; - groupchat:群聊 (required)groupId- 群组 ID。如果 msgType 设置为 groupchat,即拉取群中的 Reaction,必须指定群组 ID (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
-
getReactionDetailCall
public okhttp3.Call getReactionDetailCall(String username, String msgId, String message, Integer limit, String cursor, ApiCallback _callback) throws ApiException Build call for getReactionDetail- 参数:
username- (required)msgId- 消息 ID (required)message- 表情 ID。长度不可超过 128 个字符。该参数的值必须与客户端一致 (required)limit- 每页显示添加 Reaction 的用户数量。取值范围为 [1,50],默认值为 50 (optional)cursor- 查询游标,指定数据查询的起始位置,分页获取时使用 (optional)_callback- Callback for upload/download progress- 返回:
- Call to execute
- 抛出:
ApiException- If fail to serialize the request body object http.response.details
-
getReactionDetail
public EMGetReactionDetailResult getReactionDetail(String username, String msgId, String message, Integer limit, String cursor) throws ApiException 根据消息 ID 和表情 ID 获取 Reaction 信息 在单聊或群聊场景中对单条消息创建或追加 Reaction。创建 Reaction 指对消息添加第一条 Reaction,后续的 Reaction 添加称为追加。文档介绍:https://docs-im-beta.easemob.com/document/server-side/reaction.html#%E5%88%9B%E5%BB%BA-%E8%BF%BD%E5%8A%A0-reaction- 参数:
username- (required)msgId- 消息 ID (required)message- 表情 ID。长度不可超过 128 个字符。该参数的值必须与客户端一致 (required)limit- 每页显示添加 Reaction 的用户数量。取值范围为 [1,50],默认值为 50 (optional)cursor- 查询游标,指定数据查询的起始位置,分页获取时使用 (optional)- 返回:
- EMGetReactionDetailResult
- 抛出:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body http.response.details
-
getReactionDetailWithHttpInfo
public ApiResponse<EMGetReactionDetailResult> getReactionDetailWithHttpInfo(String username, String msgId, String message, Integer limit, String cursor) throws ApiException 根据消息 ID 和表情 ID 获取 Reaction 信息 在单聊或群聊场景中对单条消息创建或追加 Reaction。创建 Reaction 指对消息添加第一条 Reaction,后续的 Reaction 添加称为追加。文档介绍:https://docs-im-beta.easemob.com/document/server-side/reaction.html#%E5%88%9B%E5%BB%BA-%E8%BF%BD%E5%8A%A0-reaction- 参数:
username- (required)msgId- 消息 ID (required)message- 表情 ID。长度不可超过 128 个字符。该参数的值必须与客户端一致 (required)limit- 每页显示添加 Reaction 的用户数量。取值范围为 [1,50],默认值为 50 (optional)cursor- 查询游标,指定数据查询的起始位置,分页获取时使用 (optional)- 返回:
- ApiResponse<EMGetReactionDetailResult>
- 抛出:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body http.response.details
-
getReactionDetailAsync
public okhttp3.Call getReactionDetailAsync(String username, String msgId, String message, Integer limit, String cursor, ApiCallback<EMGetReactionDetailResult> _callback) throws ApiException 根据消息 ID 和表情 ID 获取 Reaction 信息 (asynchronously) 在单聊或群聊场景中对单条消息创建或追加 Reaction。创建 Reaction 指对消息添加第一条 Reaction,后续的 Reaction 添加称为追加。文档介绍:https://docs-im-beta.easemob.com/document/server-side/reaction.html#%E5%88%9B%E5%BB%BA-%E8%BF%BD%E5%8A%A0-reaction- 参数:
username- (required)msgId- 消息 ID (required)message- 表情 ID。长度不可超过 128 个字符。该参数的值必须与客户端一致 (required)limit- 每页显示添加 Reaction 的用户数量。取值范围为 [1,50],默认值为 50 (optional)cursor- 查询游标,指定数据查询的起始位置,分页获取时使用 (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
-
setReactionCall
public okhttp3.Call setReactionCall(String username, EMSetReaction emSetReaction, ApiCallback _callback) throws ApiException Build call for setReaction- 参数:
username- (required)emSetReaction- (optional)_callback- Callback for upload/download progress- 返回:
- Call to execute
- 抛出:
ApiException- If fail to serialize the request body object http.response.details
-
setReaction
public EMSetReactionResult setReaction(String username, EMSetReaction emSetReaction) throws ApiException 创建/追加 Reaction 在单聊或群聊场景中对单条消息创建或追加 Reaction。创建 Reaction 指对消息添加第一条 Reaction,后续的 Reaction 添加称为追加。文档介绍:https://docs-im-beta.easemob.com/document/server-side/reaction.html#%E5%88%9B%E5%BB%BA-%E8%BF%BD%E5%8A%A0-reaction- 参数:
username- (required)emSetReaction- (optional)- 返回:
- EMSetReactionResult
- 抛出:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body http.response.details
-
setReactionWithHttpInfo
public ApiResponse<EMSetReactionResult> setReactionWithHttpInfo(String username, EMSetReaction emSetReaction) throws ApiException 创建/追加 Reaction 在单聊或群聊场景中对单条消息创建或追加 Reaction。创建 Reaction 指对消息添加第一条 Reaction,后续的 Reaction 添加称为追加。文档介绍:https://docs-im-beta.easemob.com/document/server-side/reaction.html#%E5%88%9B%E5%BB%BA-%E8%BF%BD%E5%8A%A0-reaction- 参数:
username- (required)emSetReaction- (optional)- 返回:
- ApiResponse<EMSetReactionResult>
- 抛出:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body http.response.details
-
setReactionAsync
public okhttp3.Call setReactionAsync(String username, EMSetReaction emSetReaction, ApiCallback<EMSetReactionResult> _callback) throws ApiException 创建/追加 Reaction (asynchronously) 在单聊或群聊场景中对单条消息创建或追加 Reaction。创建 Reaction 指对消息添加第一条 Reaction,后续的 Reaction 添加称为追加。文档介绍:https://docs-im-beta.easemob.com/document/server-side/reaction.html#%E5%88%9B%E5%BB%BA-%E8%BF%BD%E5%8A%A0-reaction- 参数:
username- (required)emSetReaction- (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
-