类 MetadataApi
java.lang.Object
com.easemob.im.api.MetadataApi
-
构造器概要
构造器 -
方法概要
修饰符和类型方法说明batchCustomGroupMemberAttribute(String groupId, List<EMBatchCustomGroupMemberAttribute> emBatchCustomGroupMemberAttribute) 批量设置群成员自定义属性 批量设置群成员的自定义属性(key-value),例如,在群组中的昵称和头像等。okhttp3.CallbatchCustomGroupMemberAttributeAsync(String groupId, List<EMBatchCustomGroupMemberAttribute> emBatchCustomGroupMemberAttribute, ApiCallback<EMBatchCustomGroupMemberAttributeResult> _callback) 批量设置群成员自定义属性 (asynchronously) 批量设置群成员的自定义属性(key-value),例如,在群组中的昵称和头像等。okhttp3.CallbatchCustomGroupMemberAttributeCall(String groupId, List<EMBatchCustomGroupMemberAttribute> emBatchCustomGroupMemberAttribute, ApiCallback _callback) Build call for batchCustomGroupMemberAttributebatchCustomGroupMemberAttributeWithHttpInfo(String groupId, List<EMBatchCustomGroupMemberAttribute> emBatchCustomGroupMemberAttribute) 批量设置群成员自定义属性 批量设置群成员的自定义属性(key-value),例如,在群组中的昵称和头像等。customGroupMemberAttribute(String groupId, String username, EMCustomGroupMemberAttribute emCustomGroupMemberAttribute) 设置群成员自定义属性 设置群成员自定义属性。okhttp3.CallcustomGroupMemberAttributeAsync(String groupId, String username, EMCustomGroupMemberAttribute emCustomGroupMemberAttribute, ApiCallback<EMCustomGroupMemberAttributeResult> _callback) 设置群成员自定义属性 (asynchronously) 设置群成员自定义属性。okhttp3.CallcustomGroupMemberAttributeCall(String groupId, String username, EMCustomGroupMemberAttribute emCustomGroupMemberAttribute, ApiCallback _callback) Build call for customGroupMemberAttributecustomGroupMemberAttributeWithHttpInfo(String groupId, String username, EMCustomGroupMemberAttribute emCustomGroupMemberAttribute) 设置群成员自定义属性 设置群成员自定义属性。deleteUserMetadata(String username) 删除用户属性 删除单个用户的所有属性。okhttp3.CalldeleteUserMetadataAsync(String username, ApiCallback<EMDeleteUserMetadataResult> _callback) 删除用户属性 (asynchronously) 删除单个用户的所有属性。okhttp3.CalldeleteUserMetadataCall(String username, ApiCallback _callback) Build call for deleteUserMetadatadeleteUserMetadataWithHttpInfo(String username) 删除用户属性 删除单个用户的所有属性。getGroupMemberAllCustomAttribute(String groupId, String username) 获取单个群成员的所有自定义属性 获取单个群成员的所有自定义属性。okhttp3.CallgetGroupMemberAllCustomAttributeAsync(String groupId, String username, ApiCallback<EMGetGroupMemberAllCustomAttributeResult> _callback) 获取单个群成员的所有自定义属性 (asynchronously) 获取单个群成员的所有自定义属性。okhttp3.CallgetGroupMemberAllCustomAttributeCall(String groupId, String username, ApiCallback _callback) Build call for getGroupMemberAllCustomAttributegetGroupMemberAllCustomAttributeWithHttpInfo(String groupId, String username) 获取单个群成员的所有自定义属性 获取单个群成员的所有自定义属性。intgetMultipleGroupMembersAttributes(String groupId, EMGetMultipleGroupMembersAttributes emGetMultipleGroupMembersAttributes) 根据属性 key 获取多个群成员的自定义属性 根据指定的属性 key 获取多个群成员的自定义属性。okhttp3.CallgetMultipleGroupMembersAttributesAsync(String groupId, EMGetMultipleGroupMembersAttributes emGetMultipleGroupMembersAttributes, ApiCallback<EMGetMultipleGroupMembersAttributes> _callback) 根据属性 key 获取多个群成员的自定义属性 (asynchronously) 根据指定的属性 key 获取多个群成员的自定义属性。okhttp3.CallgetMultipleGroupMembersAttributesCall(String groupId, EMGetMultipleGroupMembersAttributes emGetMultipleGroupMembersAttributes, ApiCallback _callback) Build call for getMultipleGroupMembersAttributesgetMultipleGroupMembersAttributesWithHttpInfo(String groupId, EMGetMultipleGroupMembersAttributes emGetMultipleGroupMembersAttributes) 根据属性 key 获取多个群成员的自定义属性 根据指定的属性 key 获取多个群成员的自定义属性。getMultipleUserMetadata(EMGetMultipleUserMetadata emGetMultipleUserMetadata) 批量获取用户属性 根据指定的用户 ID 列表和属性列表,查询用户属性。okhttp3.CallgetMultipleUserMetadataAsync(EMGetMultipleUserMetadata emGetMultipleUserMetadata, ApiCallback<EMGetMultipleUserMetadataResult> _callback) 批量获取用户属性 (asynchronously) 根据指定的用户 ID 列表和属性列表,查询用户属性。okhttp3.CallgetMultipleUserMetadataCall(EMGetMultipleUserMetadata emGetMultipleUserMetadata, ApiCallback _callback) Build call for getMultipleUserMetadatagetMultipleUserMetadataWithHttpInfo(EMGetMultipleUserMetadata emGetMultipleUserMetadata) 批量获取用户属性 根据指定的用户 ID 列表和属性列表,查询用户属性。getUserMetadata(String username) 获取用户属性 获取单个用户的全部用户属性键值对。okhttp3.CallgetUserMetadataAsync(String username, ApiCallback<EMGetUserMetadataResult> _callback) 获取用户属性 (asynchronously) 获取单个用户的全部用户属性键值对。okhttp3.CallgetUserMetadataCall(String username, ApiCallback _callback) Build call for getUserMetadata设置用户属性 取该 app 下所有用户的属性数据大小,单位为字节。okhttp3.Call设置用户属性 (asynchronously) 取该 app 下所有用户的属性数据大小,单位为字节。okhttp3.CallgetUserMetadataCapacityCall(ApiCallback _callback) Build call for getUserMetadataCapacity设置用户属性 取该 app 下所有用户的属性数据大小,单位为字节。getUserMetadataWithHttpInfo(String username) 获取用户属性 获取单个用户的全部用户属性键值对。voidsetApiClient(ApiClient apiClient) voidsetCustomBaseUrl(String customBaseUrl) voidsetHostIndex(int hostIndex) setUserMetadata(String username, Map<String, String> metadata) 设置用户属性 用户属性的内容为一个或多个纯文本键值对,默认单个用户的属性总长度不能超过 2 KB,默认单个 app 下所有用户的属性总长度不能超过 10 GB。okhttp3.CallsetUserMetadataAsync(String username, Map<String, String> metadata, ApiCallback<EMSetUserMetadataResult> _callback) 设置用户属性 (asynchronously) 用户属性的内容为一个或多个纯文本键值对,默认单个用户的属性总长度不能超过 2 KB,默认单个 app 下所有用户的属性总长度不能超过 10 GB。okhttp3.CallsetUserMetadataCall(String username, Map<String, String> metadata, ApiCallback _callback) Build call for setUserMetadatasetUserMetadataWithHttpInfo(String username, Map<String, String> metadata) 设置用户属性 用户属性的内容为一个或多个纯文本键值对,默认单个用户的属性总长度不能超过 2 KB,默认单个 app 下所有用户的属性总长度不能超过 10 GB。
-
构造器详细资料
-
MetadataApi
public MetadataApi() -
MetadataApi
-
-
方法详细资料
-
getApiClient
-
setApiClient
-
getHostIndex
public int getHostIndex() -
setHostIndex
public void setHostIndex(int hostIndex) -
getCustomBaseUrl
-
setCustomBaseUrl
-
batchCustomGroupMemberAttributeCall
public okhttp3.Call batchCustomGroupMemberAttributeCall(String groupId, List<EMBatchCustomGroupMemberAttribute> emBatchCustomGroupMemberAttribute, ApiCallback _callback) throws ApiException Build call for batchCustomGroupMemberAttribute- 参数:
groupId- (required)emBatchCustomGroupMemberAttribute- (optional)_callback- Callback for upload/download progress- 返回:
- Call to execute
- 抛出:
ApiException- If fail to serialize the request body object http.response.details
-
batchCustomGroupMemberAttribute
public EMBatchCustomGroupMemberAttributeResult batchCustomGroupMemberAttribute(String groupId, List<EMBatchCustomGroupMemberAttribute> emBatchCustomGroupMemberAttribute) throws ApiException 批量设置群成员自定义属性 批量设置群成员的自定义属性(key-value),例如,在群组中的昵称和头像等。每次请求最多可为 20 个群成员设置多个属性,而且可对不同群成员设置不同属性。传入相同用户 ID 时,若其属性名称不同,则添加,相同则更新。文档介绍:https://doc.easemob.com/document/server-side/group_member.html#%E6%89%B9%E9%87%8F%E8%AE%BE%E7%BD%AE%E7%BE%A4%E6%88%90%E5%91%98%E8%87%AA%E5%AE%9A%E4%B9%89%E5%B1%9E%E6%80%A7- 参数:
groupId- (required)emBatchCustomGroupMemberAttribute- (optional)- 返回:
- EMBatchCustomGroupMemberAttributeResult
- 抛出:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body http.response.details
-
batchCustomGroupMemberAttributeWithHttpInfo
public ApiResponse<EMBatchCustomGroupMemberAttributeResult> batchCustomGroupMemberAttributeWithHttpInfo(String groupId, List<EMBatchCustomGroupMemberAttribute> emBatchCustomGroupMemberAttribute) throws ApiException 批量设置群成员自定义属性 批量设置群成员的自定义属性(key-value),例如,在群组中的昵称和头像等。每次请求最多可为 20 个群成员设置多个属性,而且可对不同群成员设置不同属性。传入相同用户 ID 时,若其属性名称不同,则添加,相同则更新。文档介绍:https://doc.easemob.com/document/server-side/group_member.html#%E6%89%B9%E9%87%8F%E8%AE%BE%E7%BD%AE%E7%BE%A4%E6%88%90%E5%91%98%E8%87%AA%E5%AE%9A%E4%B9%89%E5%B1%9E%E6%80%A7- 参数:
groupId- (required)emBatchCustomGroupMemberAttribute- (optional)- 返回:
- ApiResponse<EMBatchCustomGroupMemberAttributeResult>
- 抛出:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body http.response.details
-
batchCustomGroupMemberAttributeAsync
public okhttp3.Call batchCustomGroupMemberAttributeAsync(String groupId, List<EMBatchCustomGroupMemberAttribute> emBatchCustomGroupMemberAttribute, ApiCallback<EMBatchCustomGroupMemberAttributeResult> _callback) throws ApiException 批量设置群成员自定义属性 (asynchronously) 批量设置群成员的自定义属性(key-value),例如,在群组中的昵称和头像等。每次请求最多可为 20 个群成员设置多个属性,而且可对不同群成员设置不同属性。传入相同用户 ID 时,若其属性名称不同,则添加,相同则更新。文档介绍:https://doc.easemob.com/document/server-side/group_member.html#%E6%89%B9%E9%87%8F%E8%AE%BE%E7%BD%AE%E7%BE%A4%E6%88%90%E5%91%98%E8%87%AA%E5%AE%9A%E4%B9%89%E5%B1%9E%E6%80%A7- 参数:
groupId- (required)emBatchCustomGroupMemberAttribute- (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
-
customGroupMemberAttributeCall
public okhttp3.Call customGroupMemberAttributeCall(String groupId, String username, EMCustomGroupMemberAttribute emCustomGroupMemberAttribute, ApiCallback _callback) throws ApiException Build call for customGroupMemberAttribute- 参数:
groupId- (required)username- (required)emCustomGroupMemberAttribute- (optional)_callback- Callback for upload/download progress- 返回:
- Call to execute
- 抛出:
ApiException- If fail to serialize the request body object http.response.details
-
customGroupMemberAttribute
public EMCustomGroupMemberAttributeResult customGroupMemberAttribute(String groupId, String username, EMCustomGroupMemberAttribute emCustomGroupMemberAttribute) throws ApiException 设置群成员自定义属性 设置群成员自定义属性。群成员可设置自定义属性(key-value),例如在群组中的昵称和头像等。群主可修改所有群成员的自定义属性,其他群成员只能修改自己的自定义属性。文档介绍:https://docs-im-beta.easemob.com/document/server-side/group.html#%E8%AE%BE%E7%BD%AE%E7%BE%A4%E6%88%90%E5%91%98%E8%87%AA%E5%AE%9A%E4%B9%89%E5%B1%9E%E6%80%A7- 参数:
groupId- (required)username- (required)emCustomGroupMemberAttribute- (optional)- 返回:
- EMCustomGroupMemberAttributeResult
- 抛出:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body http.response.details
-
customGroupMemberAttributeWithHttpInfo
public ApiResponse<EMCustomGroupMemberAttributeResult> customGroupMemberAttributeWithHttpInfo(String groupId, String username, EMCustomGroupMemberAttribute emCustomGroupMemberAttribute) throws ApiException 设置群成员自定义属性 设置群成员自定义属性。群成员可设置自定义属性(key-value),例如在群组中的昵称和头像等。群主可修改所有群成员的自定义属性,其他群成员只能修改自己的自定义属性。文档介绍:https://docs-im-beta.easemob.com/document/server-side/group.html#%E8%AE%BE%E7%BD%AE%E7%BE%A4%E6%88%90%E5%91%98%E8%87%AA%E5%AE%9A%E4%B9%89%E5%B1%9E%E6%80%A7- 参数:
groupId- (required)username- (required)emCustomGroupMemberAttribute- (optional)- 返回:
- ApiResponse<EMCustomGroupMemberAttributeResult>
- 抛出:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body http.response.details
-
customGroupMemberAttributeAsync
public okhttp3.Call customGroupMemberAttributeAsync(String groupId, String username, EMCustomGroupMemberAttribute emCustomGroupMemberAttribute, ApiCallback<EMCustomGroupMemberAttributeResult> _callback) throws ApiException 设置群成员自定义属性 (asynchronously) 设置群成员自定义属性。群成员可设置自定义属性(key-value),例如在群组中的昵称和头像等。群主可修改所有群成员的自定义属性,其他群成员只能修改自己的自定义属性。文档介绍:https://docs-im-beta.easemob.com/document/server-side/group.html#%E8%AE%BE%E7%BD%AE%E7%BE%A4%E6%88%90%E5%91%98%E8%87%AA%E5%AE%9A%E4%B9%89%E5%B1%9E%E6%80%A7- 参数:
groupId- (required)username- (required)emCustomGroupMemberAttribute- (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
-
deleteUserMetadataCall
public okhttp3.Call deleteUserMetadataCall(String username, ApiCallback _callback) throws ApiException Build call for deleteUserMetadata- 参数:
username- (required)_callback- Callback for upload/download progress- 返回:
- Call to execute
- 抛出:
ApiException- If fail to serialize the request body object http.response.details
-
deleteUserMetadata
删除用户属性 删除单个用户的所有属性。如果指定的用户或用户属性不存在(可能已删除),也视为删除成功。文档介绍:https://docs-im-beta.easemob.com/document/server-side/userprofile.html#%E5%88%A0%E9%99%A4%E7%94%A8%E6%88%B7%E5%B1%9E%E6%80%A7- 参数:
username- (required)- 返回:
- EMDeleteUserMetadataResult
- 抛出:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body http.response.details
-
deleteUserMetadataWithHttpInfo
public ApiResponse<EMDeleteUserMetadataResult> deleteUserMetadataWithHttpInfo(String username) throws ApiException 删除用户属性 删除单个用户的所有属性。如果指定的用户或用户属性不存在(可能已删除),也视为删除成功。文档介绍:https://docs-im-beta.easemob.com/document/server-side/userprofile.html#%E5%88%A0%E9%99%A4%E7%94%A8%E6%88%B7%E5%B1%9E%E6%80%A7- 参数:
username- (required)- 返回:
- ApiResponse<EMDeleteUserMetadataResult>
- 抛出:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body http.response.details
-
deleteUserMetadataAsync
public okhttp3.Call deleteUserMetadataAsync(String username, ApiCallback<EMDeleteUserMetadataResult> _callback) throws ApiException 删除用户属性 (asynchronously) 删除单个用户的所有属性。如果指定的用户或用户属性不存在(可能已删除),也视为删除成功。文档介绍:https://docs-im-beta.easemob.com/document/server-side/userprofile.html#%E5%88%A0%E9%99%A4%E7%94%A8%E6%88%B7%E5%B1%9E%E6%80%A7- 参数:
username- (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
-
getGroupMemberAllCustomAttributeCall
public okhttp3.Call getGroupMemberAllCustomAttributeCall(String groupId, String username, ApiCallback _callback) throws ApiException Build call for getGroupMemberAllCustomAttribute- 参数:
groupId- (required)username- (required)_callback- Callback for upload/download progress- 返回:
- Call to execute
- 抛出:
ApiException- If fail to serialize the request body object http.response.details
-
getGroupMemberAllCustomAttribute
public EMGetGroupMemberAllCustomAttributeResult getGroupMemberAllCustomAttribute(String groupId, String username) throws ApiException 获取单个群成员的所有自定义属性 获取单个群成员的所有自定义属性。文档介绍:https://docs-im-beta.easemob.com/document/server-side/group.html#%E8%8E%B7%E5%8F%96%E5%8D%95%E4%B8%AA%E7%BE%A4%E6%88%90%E5%91%98%E7%9A%84%E6%89%80%E6%9C%89%E8%87%AA%E5%AE%9A%E4%B9%89%E5%B1%9E%E6%80%A7- 参数:
groupId- (required)username- (required)- 返回:
- EMGetGroupMemberAllCustomAttributeResult
- 抛出:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body http.response.details
-
getGroupMemberAllCustomAttributeWithHttpInfo
public ApiResponse<EMGetGroupMemberAllCustomAttributeResult> getGroupMemberAllCustomAttributeWithHttpInfo(String groupId, String username) throws ApiException 获取单个群成员的所有自定义属性 获取单个群成员的所有自定义属性。文档介绍:https://docs-im-beta.easemob.com/document/server-side/group.html#%E8%8E%B7%E5%8F%96%E5%8D%95%E4%B8%AA%E7%BE%A4%E6%88%90%E5%91%98%E7%9A%84%E6%89%80%E6%9C%89%E8%87%AA%E5%AE%9A%E4%B9%89%E5%B1%9E%E6%80%A7- 参数:
groupId- (required)username- (required)- 返回:
- ApiResponse<EMGetGroupMemberAllCustomAttributeResult>
- 抛出:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body http.response.details
-
getGroupMemberAllCustomAttributeAsync
public okhttp3.Call getGroupMemberAllCustomAttributeAsync(String groupId, String username, ApiCallback<EMGetGroupMemberAllCustomAttributeResult> _callback) throws ApiException 获取单个群成员的所有自定义属性 (asynchronously) 获取单个群成员的所有自定义属性。文档介绍:https://docs-im-beta.easemob.com/document/server-side/group.html#%E8%8E%B7%E5%8F%96%E5%8D%95%E4%B8%AA%E7%BE%A4%E6%88%90%E5%91%98%E7%9A%84%E6%89%80%E6%9C%89%E8%87%AA%E5%AE%9A%E4%B9%89%E5%B1%9E%E6%80%A7- 参数:
groupId- (required)username- (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
-
getMultipleGroupMembersAttributesCall
public okhttp3.Call getMultipleGroupMembersAttributesCall(String groupId, EMGetMultipleGroupMembersAttributes emGetMultipleGroupMembersAttributes, ApiCallback _callback) throws ApiException Build call for getMultipleGroupMembersAttributes- 参数:
groupId- (required)emGetMultipleGroupMembersAttributes- (optional)_callback- Callback for upload/download progress- 返回:
- Call to execute
- 抛出:
ApiException- If fail to serialize the request body object http.response.details
-
getMultipleGroupMembersAttributes
public EMGetMultipleGroupMembersAttributesResult getMultipleGroupMembersAttributes(String groupId, EMGetMultipleGroupMembersAttributes emGetMultipleGroupMembersAttributes) throws ApiException 根据属性 key 获取多个群成员的自定义属性 根据指定的属性 key 获取多个群成员的自定义属性。每次最多可获取 10 个群成员的自定义属性。文档介绍:https://docs-im-beta.easemob.com/document/server-side/group.html#%E6%A0%B9%E6%8D%AE%E5%B1%9E%E6%80%A7-key-%E8%8E%B7%E5%8F%96%E5%A4%9A%E4%B8%AA%E7%BE%A4%E6%88%90%E5%91%98%E7%9A%84%E8%87%AA%E5%AE%9A%E4%B9%89%E5%B1%9E%E6%80%A7- 参数:
groupId- (required)emGetMultipleGroupMembersAttributes- (optional)- 返回:
- EMGetMultipleGroupMembersAttributes
- 抛出:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body http.response.details
-
getMultipleGroupMembersAttributesWithHttpInfo
public ApiResponse<EMGetMultipleGroupMembersAttributesResult> getMultipleGroupMembersAttributesWithHttpInfo(String groupId, EMGetMultipleGroupMembersAttributes emGetMultipleGroupMembersAttributes) throws ApiException 根据属性 key 获取多个群成员的自定义属性 根据指定的属性 key 获取多个群成员的自定义属性。每次最多可获取 10 个群成员的自定义属性。文档介绍:https://docs-im-beta.easemob.com/document/server-side/group.html#%E6%A0%B9%E6%8D%AE%E5%B1%9E%E6%80%A7-key-%E8%8E%B7%E5%8F%96%E5%A4%9A%E4%B8%AA%E7%BE%A4%E6%88%90%E5%91%98%E7%9A%84%E8%87%AA%E5%AE%9A%E4%B9%89%E5%B1%9E%E6%80%A7- 参数:
groupId- (required)emGetMultipleGroupMembersAttributes- (optional)- 返回:
- ApiResponse<EMGetMultipleGroupMembersAttributesResult>
- 抛出:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body http.response.details
-
getMultipleGroupMembersAttributesAsync
public okhttp3.Call getMultipleGroupMembersAttributesAsync(String groupId, EMGetMultipleGroupMembersAttributes emGetMultipleGroupMembersAttributes, ApiCallback<EMGetMultipleGroupMembersAttributes> _callback) throws ApiException 根据属性 key 获取多个群成员的自定义属性 (asynchronously) 根据指定的属性 key 获取多个群成员的自定义属性。每次最多可获取 10 个群成员的自定义属性。文档介绍:https://docs-im-beta.easemob.com/document/server-side/group.html#%E6%A0%B9%E6%8D%AE%E5%B1%9E%E6%80%A7-key-%E8%8E%B7%E5%8F%96%E5%A4%9A%E4%B8%AA%E7%BE%A4%E6%88%90%E5%91%98%E7%9A%84%E8%87%AA%E5%AE%9A%E4%B9%89%E5%B1%9E%E6%80%A7- 参数:
groupId- (required)emGetMultipleGroupMembersAttributes- (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
-
getUserMetadataCall
Build call for getUserMetadata- 参数:
username- (required)_callback- Callback for upload/download progress- 返回:
- Call to execute
- 抛出:
ApiException- If fail to serialize the request body object http.response.details
-
getUserMetadata
获取用户属性 获取单个用户的全部用户属性键值对。需要在请求中填写 {username},指定获取用户属性的用户 ID。如果指定的用户或用户属性不存在,返回空数据{}。文档介绍:https://docs-im-beta.easemob.com/document/server-side/userprofile.html#%E8%8E%B7%E5%8F%96%E7%94%A8%E6%88%B7%E5%B1%9E%E6%80%A7- 参数:
username- (required)- 返回:
- EMGetUserMetadataResult
- 抛出:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body http.response.details
-
getUserMetadataWithHttpInfo
public ApiResponse<EMGetUserMetadataResult> getUserMetadataWithHttpInfo(String username) throws ApiException 获取用户属性 获取单个用户的全部用户属性键值对。需要在请求中填写 {username},指定获取用户属性的用户 ID。如果指定的用户或用户属性不存在,返回空数据{}。文档介绍:https://docs-im-beta.easemob.com/document/server-side/userprofile.html#%E8%8E%B7%E5%8F%96%E7%94%A8%E6%88%B7%E5%B1%9E%E6%80%A7- 参数:
username- (required)- 返回:
- ApiResponse<EMGetUserMetadataResult>
- 抛出:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body http.response.details
-
getUserMetadataAsync
public okhttp3.Call getUserMetadataAsync(String username, ApiCallback<EMGetUserMetadataResult> _callback) throws ApiException 获取用户属性 (asynchronously) 获取单个用户的全部用户属性键值对。需要在请求中填写 {username},指定获取用户属性的用户 ID。如果指定的用户或用户属性不存在,返回空数据{}。文档介绍:https://docs-im-beta.easemob.com/document/server-side/userprofile.html#%E8%8E%B7%E5%8F%96%E7%94%A8%E6%88%B7%E5%B1%9E%E6%80%A7- 参数:
username- (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
-
getUserMetadataCapacityCall
Build call for getUserMetadataCapacity- 参数:
_callback- Callback for upload/download progress- 返回:
- Call to execute
- 抛出:
ApiException- If fail to serialize the request body object http.response.details
-
getUserMetadataCapacity
设置用户属性 取该 app 下所有用户的属性数据大小,单位为字节。文档介绍:https://docs-im-beta.easemob.com/document/server-side/userprofile.html#%E8%8E%B7%E5%8F%96-app-%E4%B8%8B%E7%94%A8%E6%88%B7%E5%B1%9E%E6%80%A7%E6%80%BB%E5%A4%A7%E5%B0%8F- 返回:
- EMGetUserMetadataCapacityResult
- 抛出:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body http.response.details
-
getUserMetadataCapacityWithHttpInfo
public ApiResponse<EMGetUserMetadataCapacityResult> getUserMetadataCapacityWithHttpInfo() throws ApiException设置用户属性 取该 app 下所有用户的属性数据大小,单位为字节。文档介绍:https://docs-im-beta.easemob.com/document/server-side/userprofile.html#%E8%8E%B7%E5%8F%96-app-%E4%B8%8B%E7%94%A8%E6%88%B7%E5%B1%9E%E6%80%A7%E6%80%BB%E5%A4%A7%E5%B0%8F- 返回:
- ApiResponse<EMGetUserMetadataCapacityResult>
- 抛出:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body http.response.details
-
getUserMetadataCapacityAsync
public okhttp3.Call getUserMetadataCapacityAsync(ApiCallback<EMGetUserMetadataCapacityResult> _callback) throws ApiException 设置用户属性 (asynchronously) 取该 app 下所有用户的属性数据大小,单位为字节。文档介绍:https://docs-im-beta.easemob.com/document/server-side/userprofile.html#%E8%8E%B7%E5%8F%96-app-%E4%B8%8B%E7%94%A8%E6%88%B7%E5%B1%9E%E6%80%A7%E6%80%BB%E5%A4%A7%E5%B0%8F- 参数:
_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
-
setUserMetadataCall
public okhttp3.Call setUserMetadataCall(String username, Map<String, String> metadata, ApiCallback _callback) throws ApiExceptionBuild call for setUserMetadata- 参数:
username- (required)metadata- (required)_callback- Callback for upload/download progress- 返回:
- Call to execute
- 抛出:
ApiException- If fail to serialize the request body object http.response.details
-
setUserMetadata
public EMSetUserMetadataResult setUserMetadata(String username, Map<String, String> metadata) throws ApiException设置用户属性 用户属性的内容为一个或多个纯文本键值对,默认单个用户的属性总长度不能超过 2 KB,默认单个 app 下所有用户的属性总长度不能超过 10 GB。利用该 API,每次只能设置一个用户的用户属性。文档介绍:https://docs-im-beta.easemob.com/document/server-side/userprofile.html#%E8%AE%BE%E7%BD%AE%E7%94%A8%E6%88%B7%E5%B1%9E%E6%80%A7- 参数:
username- (required)metadata- (required)- 返回:
- EMSetUserMetadataResult
- 抛出:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body http.response.details
-
setUserMetadataWithHttpInfo
public ApiResponse<EMSetUserMetadataResult> setUserMetadataWithHttpInfo(String username, Map<String, String> metadata) throws ApiException设置用户属性 用户属性的内容为一个或多个纯文本键值对,默认单个用户的属性总长度不能超过 2 KB,默认单个 app 下所有用户的属性总长度不能超过 10 GB。利用该 API,每次只能设置一个用户的用户属性。文档介绍:https://docs-im-beta.easemob.com/document/server-side/userprofile.html#%E8%AE%BE%E7%BD%AE%E7%94%A8%E6%88%B7%E5%B1%9E%E6%80%A7- 参数:
username- (required)metadata- (required)- 返回:
- ApiResponse<EMSetUserMetadataResult>
- 抛出:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body http.response.details
-
setUserMetadataAsync
public okhttp3.Call setUserMetadataAsync(String username, Map<String, String> metadata, ApiCallback<EMSetUserMetadataResult> _callback) throws ApiException设置用户属性 (asynchronously) 用户属性的内容为一个或多个纯文本键值对,默认单个用户的属性总长度不能超过 2 KB,默认单个 app 下所有用户的属性总长度不能超过 10 GB。利用该 API,每次只能设置一个用户的用户属性。文档介绍:https://docs-im-beta.easemob.com/document/server-side/userprofile.html#%E8%AE%BE%E7%BD%AE%E7%94%A8%E6%88%B7%E5%B1%9E%E6%80%A7- 参数:
username- (required)metadata- (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
-
getMultipleUserMetadataCall
public okhttp3.Call getMultipleUserMetadataCall(@Nullable EMGetMultipleUserMetadata emGetMultipleUserMetadata, ApiCallback _callback) throws ApiException Build call for getMultipleUserMetadata- 参数:
emGetMultipleUserMetadata- (optional)_callback- Callback for upload/download progress- 返回:
- Call to execute
- 抛出:
ApiException- If fail to serialize the request body object http.response.details
-
getMultipleUserMetadata
public EMGetMultipleUserMetadataResult getMultipleUserMetadata(@Nullable EMGetMultipleUserMetadata emGetMultipleUserMetadata) throws ApiException 批量获取用户属性 根据指定的用户 ID 列表和属性列表,查询用户属性。如果指定的用户 ID 或用户属性不存在,返回空数据 {}。 每次最多可获取 100 个用户的属性。文档介绍:https://docs-im-beta.easemob.com/document/server-side/userprofile.html#%E8%8E%B7%E5%8F%96-app-%E4%B8%8B%E7%94%A8%E6%88%B7%E5%B1%9E%E6%80%A7%E6%80%BB%E5%A4%A7%E5%B0%8F- 参数:
emGetMultipleUserMetadata- (optional)- 返回:
- EMGetMultipleUserMetadataResult
- 抛出:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body http.response.details
-
getMultipleUserMetadataWithHttpInfo
public ApiResponse<EMGetMultipleUserMetadataResult> getMultipleUserMetadataWithHttpInfo(@Nullable EMGetMultipleUserMetadata emGetMultipleUserMetadata) throws ApiException 批量获取用户属性 根据指定的用户 ID 列表和属性列表,查询用户属性。如果指定的用户 ID 或用户属性不存在,返回空数据 {}。 每次最多可获取 100 个用户的属性。文档介绍:https://docs-im-beta.easemob.com/document/server-side/userprofile.html#%E8%8E%B7%E5%8F%96-app-%E4%B8%8B%E7%94%A8%E6%88%B7%E5%B1%9E%E6%80%A7%E6%80%BB%E5%A4%A7%E5%B0%8F- 参数:
emGetMultipleUserMetadata- (optional)- 返回:
- ApiResponse<EMGetMultipleUserMetadataResult>
- 抛出:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body http.response.details
-
getMultipleUserMetadataAsync
public okhttp3.Call getMultipleUserMetadataAsync(@Nullable EMGetMultipleUserMetadata emGetMultipleUserMetadata, ApiCallback<EMGetMultipleUserMetadataResult> _callback) throws ApiException 批量获取用户属性 (asynchronously) 根据指定的用户 ID 列表和属性列表,查询用户属性。如果指定的用户 ID 或用户属性不存在,返回空数据 {}。 每次最多可获取 100 个用户的属性。文档介绍:https://docs-im-beta.easemob.com/document/server-side/userprofile.html#%E8%8E%B7%E5%8F%96-app-%E4%B8%8B%E7%94%A8%E6%88%B7%E5%B1%9E%E6%80%A7%E6%80%BB%E5%A4%A7%E5%B0%8F- 参数:
emGetMultipleUserMetadata- (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
-