JCSDK Java API Reference for Android
2.5.1
|
被 com.juphoon.cloud.JCClientImpl 继承.
类 | |
class | CreateParam |
class | LoginParam |
Public 成员函数 | |
abstract String | getAppkey () |
abstract void | setDisplayName (@NonNull String displayName) |
abstract String | getDisplayName () |
abstract void | setForeground (boolean foreground) |
abstract String | getUserId () |
abstract int | getState () |
abstract CreateParam | getCreateParam () |
abstract LoginParam | getLoginParam () |
abstract boolean | login (@NonNull String userId, @NonNull String password, @Nullable LoginParam loginParam) |
abstract void | setServerAddress (String serverAddress) |
abstract String | getServerAddress () |
abstract boolean | logout () |
abstract int | sendOnlineMessage (String userId, String content) |
静态 Public 成员函数 | |
static JCClient | create (@NonNull Context context, @NonNull String appKey, @NonNull JCClientCallback callback, @Nullable CreateParam createParam) |
static void | destroy () |
静态 Public 属性 | |
static final int | STATE_NOT_INIT = 0 |
static final int | STATE_IDLE = 1 |
static final int | STATE_LOGINING = 2 |
static final int | STATE_LOGINED = 3 |
static final int | STATE_LOGOUTING = 4 |
static final int | REASON_NONE = 0 |
static final int | REASON_SDK_NOT_INIT = 1 |
static final int | REASON_INVALID_PARAM = 2 |
static final int | REASON_CALL_FUNCTION_ERROR = 3 |
static final int | REASON_TIMEOUT = 5 |
static final int | REASON_NETWORK = 6 |
static final int | REASON_APPKEY = 7 |
static final int | REASON_AUTH = 8 |
static final int | REASON_NOUSER = 9 |
static final int | REASON_SERVER_LOGOUT = 10 |
static final int | REASON_ANOTHER_DEVICE_LOGINED = 11 |
static final int | REASON_LOCAL_REQUEST = 12 |
static final int | REASON_SEND_MESSAGE = 13 |
static final int | REASON_SERVER_BUSY = 14 |
static final int | REASON_SERVER_NOT_REACH = 15 |
static final int | REASON_SERVER_FORBIDDEN = 16 |
static final int | REASON_SERVER_UNAVAILABLE = 17 |
static final int | REASON_DNS_QUERY = 18 |
static final int | REASON_INTERNAL = 19 |
static final int | REASON_NO_RESOURCE = 20 |
static final int | REASON_NO_NONCE = 21 |
static final int | REASON_INVALID_AUTH_CODE = 22 |
static final int | REASON_TOKEN_MISMATCH = 23 |
static final int | REASON_TOKEN_SIZE_INVALID = 24 |
static final int | REASON_TOKEN_SECRET_NOT_FOUND = 25 |
static final int | REASON_TOKEN_ANALYSIS_ERROR = 26 |
static final int | REASON_TOKEN_VERSIGN_APPKEY_ERROR = 27 |
static final int | REASON_TOKEN_ACCOUNTID_MISMATCH = 28 |
static final int | REASON_TOKEN_EXPIRED = 29 |
static final int | REASON_OTHER = 100 |
static final int | LOG_LEVEL_DISABLE = 0 |
static final int | LOG_LEVEL_ERROR = 1 |
static final int | LOG_LEVEL_INFO = 2 |
static final int | LOG_LEVEL_DEBUG = 3 |
用于初始化sdk以及登录 Juphoon Cloud 平台
|
inlinestatic |
创建 JCClient 对象
JCClient 的所有接口函数,如无特殊说明,都建议在主线程调用
context | 上下文句柄 |
appKey | 用户从 Juphoon Cloud 平台上创建应用获取的 AppKey 字符串,详见获取 appKey |
callback | JCClientCallback 对象,用于回调相关通知 |
createParam | 创建参数,详细定义见 CreateParam。传 null 则使用默认值 |
context、appKey、JCClientCallback 任意参数传空就会抛出异常 |
|
inlinestatic |
|
abstract |
|
abstract |
|
abstract |
获取自己的昵称
|
abstract |
是否设置为前台
应用进入前台或进入后台都需要调用此方法进行设置。应用进入后台时调用此方法设置为后台,可以优化数据链路从而减少耗电量
foreground | 是否设置为前台
|
|
abstract |
|
abstract |
获取当前登录状态
|
abstract |
获取创建参数
返回的创建参数就是用户在调用 create 方法时传入的 CreateParam 参数,若用户在调用 create 方法时,CreateParam 传入了 null,则返回默认的 CreateParam 对象
|
abstract |
获取登录参数
返回的登录参数就是用户在调用 login 方法时传入的 LoginParam 参数,若用户在调用 login 方法时, LoginParam 传入了 null,则将返回默认的 LoginParam 对象。
需要注意的是只有用户状态为登录中或已登录时才能获取到值,其他状态将返回 null
|
abstract |
登录 Juphoon Cloud 平台
只有登录成功后才能进行平台上的各种业务
userId | 用户名,长度在 64 字节以内的字符串。以下为支持的字符集范围(共 66 个字符):
|
password | 密码,不能为 null 或 "",长度不能超过 128 字符。免鉴权模式密码可以随意输入,Token 鉴权模式密码需要输入外部生成的 Token |
loginParam | 登录参数,传 null 则按默认值。一般不需要设置,如需设置请询问客服,详细定义见 LoginParam |
|
abstract |
设置登录服务器地址
serverAddress | 登录服务器地址,默认地址为 http:cn.router.justalkcloud.com:8080(国内环境)。如果是海外用户需要设置为 http:intl.router.justalkcloud.com:8080(国际环境) |
|
abstract |
获取登录服务器地址
返回的登录地址就是用户在调用 setServerAddress 方法时传入的 serverAddress 参数,若用户未调用 setServerAddress 方法,将返回默认国内地址 http:cn.router.justalkcloud.com:8080
|
abstract |
|
abstract |
发送在线消息
消息发送结果通过 onOnlineMessageSendResult 通知
userId | 对方的 userId |
content | 要发送的消息内容 |
|
static |
未初始化
|
static |
未登录
|
static |
登录中
|
static |
登录成功
|
static |
登出中
|
static |
不打印日志
|
static |
只打印 error 等级的日志
|
static |
只打印 info 和 error 等级的日志
|
static |
打印所有等级的日志