cc.openkit.kitChat.rongcloud.rong.methods

类 User

java.lang.Object

cc.openkit.kitChat.rongcloud.rong.methods.User

public class User
extends java.lang.Object

构造器概要

构造器

构造器和说明
User(java.lang.String appKey, java.lang.String appSecret)

方法概要

限定符和类型	方法和说明
CodeSuccessResult	addBlacklist(java.lang.String userId, java.lang.String blackUserId) 添加用户到黑名单方法（每秒钟限 100 次）
CodeSuccessResult	block(java.lang.String userId, java.lang.Integer minute) 封禁用户方法（每秒钟限 100 次）
CheckOnlineResult	checkOnline(java.lang.String userId) 检查用户在线状态 方法
TokenResult	getToken(java.lang.String userId, java.lang.String name, java.lang.String portraitUri) 获取 Token 方法
QueryBlacklistUserResult	queryBlacklist(java.lang.String userId) 获取某用户的黑名单列表方法（每秒钟限 100 次）
QueryBlockUserResult	queryBlock() 获取被封禁用户方法（每秒钟限 100 次）
CodeSuccessResult	refresh(java.lang.String userId, java.lang.String name, java.lang.String portraitUri) 刷新用户信息方法
CodeSuccessResult	removeBlacklist(java.lang.String userId, java.lang.String blackUserId) 从黑名单中移除用户方法（每秒钟限 100 次）
CodeSuccessResult	unBlock(java.lang.String userId) 解除用户封禁方法（每秒钟限 100 次）

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

User

public User(java.lang.String appKey,
            java.lang.String appSecret)

方法详细资料

getToken

public TokenResult getToken(java.lang.String userId,
                            java.lang.String name,
                            java.lang.String portraitUri)
                     throws java.lang.Exception

获取 Token 方法

参数:

userId:用户 - Id，最大长度 64 字节.是用户在 App 中的唯一标识码，必须保证在同一个 App 内不重复，重复的用户 Id 将被当作是同一用户。（必传）

name:用户名称，最大长度 - 128 字节.用来在 Push 推送时显示用户的名称.用户名称，最大长度 128 字节.用来在 Push 推送时显示用户的名称。（必传）

portraitUri:用户头像 - URI，最大长度 1024 字节.用来在 Push 推送时显示用户的头像。（必传）

返回:

TokenResult

抛出:

java.lang.Exception

refresh

public CodeSuccessResult refresh(java.lang.String userId,
                                 java.lang.String name,
                                 java.lang.String portraitUri)
                          throws java.lang.Exception

刷新用户信息方法

参数:

userId:用户 - Id，最大长度 64 字节.是用户在 App 中的唯一标识码，必须保证在同一个 App 内不重复，重复的用户 Id 将被当作是同一用户。（必传）

name:用户名称，最大长度 - 128 字节。用来在 Push 推送时，显示用户的名称，刷新用户名称后 5 分钟内生效。（可选，提供即刷新，不提供忽略）

portraitUri:用户头像 - URI，最大长度 1024 字节。用来在 Push 推送时显示。（可选，提供即刷新，不提供忽略）

返回:

CodeSuccessResult

抛出:

java.lang.Exception

checkOnline

public CheckOnlineResult checkOnline(java.lang.String userId)
                              throws java.lang.Exception

检查用户在线状态 方法

参数:

userId:用户 - Id，最大长度 64 字节。是用户在 App 中的唯一标识码，必须保证在同一个 App 内不重复，重复的用户 Id 将被当作是同一用户。（必传）

返回:

CheckOnlineResult

抛出:

java.lang.Exception

block

public CodeSuccessResult block(java.lang.String userId,
                               java.lang.Integer minute)
                        throws java.lang.Exception

封禁用户方法（每秒钟限 100 次）

参数:

userId:用户 - Id。（必传）

minute:封禁时长,单位为分钟，最大值为43200分钟。（必传） -

返回:

CodeSuccessResult

抛出:

java.lang.Exception

unBlock

public CodeSuccessResult unBlock(java.lang.String userId)
                          throws java.lang.Exception

解除用户封禁方法（每秒钟限 100 次）

参数:

userId:用户 - Id。（必传）

返回:

CodeSuccessResult

抛出:

java.lang.Exception

queryBlock

public QueryBlockUserResult queryBlock()
                                throws java.lang.Exception

获取被封禁用户方法（每秒钟限 100 次）

返回:

QueryBlockUserResult

抛出:

java.lang.Exception

addBlacklist

public CodeSuccessResult addBlacklist(java.lang.String userId,
                                      java.lang.String blackUserId)
                               throws java.lang.Exception

添加用户到黑名单方法（每秒钟限 100 次）

参数:

userId:用户 - Id。（必传）

blackUserId:被加到黑名单的用户Id。（必传） -

返回:

CodeSuccessResult

抛出:

java.lang.Exception

queryBlacklist

public QueryBlacklistUserResult queryBlacklist(java.lang.String userId)
                                        throws java.lang.Exception

获取某用户的黑名单列表方法（每秒钟限 100 次）

参数:

userId:用户 - Id。（必传）

返回:

QueryBlacklistUserResult

抛出:

java.lang.Exception

removeBlacklist

public CodeSuccessResult removeBlacklist(java.lang.String userId,
                                         java.lang.String blackUserId)
                                  throws java.lang.Exception

从黑名单中移除用户方法（每秒钟限 100 次）

参数:

userId:用户 - Id。（必传）

blackUserId:被移除的用户Id。（必传） -

返回:

CodeSuccessResult

抛出:

java.lang.Exception