类
interface	ClientReason

interface	ClientState

interface	ConfigKey

interface	CreateExtra

Public 成员函数
abstract void	setDisplayName (String displayName)

abstract String	getDisplayName ()

abstract void	setForeground (boolean foreground)

abstract String	getUserId ()

abstract int	getState ()

abstract boolean	login (String userId, String password)

abstract boolean	login (String userId, String password, JCClientLoginParam clientLoginParam)

abstract boolean	logout ()

abstract void	setAppkey (String appkey)

abstract boolean	setConfig (@ConfigKey String key, String value)

abstract String	getConfig (@ConfigKey String key)

abstract int	sendOnlineMessage (String message, String userId)

静态 Public 成员函数
static JCClient	create (Context context, String appKey, JCClientCallback callback, Map< String, String > extraParams)

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_STATE_CANNOT_LOGIN = 2

static final int	REASON_TIMEOUT = 3

static final int	REASON_NETWORK = 4

static final int	REASON_APPKEY = 5

static final int	REASON_AUTH = 6

static final int	REASON_NOUSER = 7

static final int	REASON_SERVER_LOGOUT = 8

static final int	REASON_INVALID_PARAM = 97

static final int	REASON_CALL_FUNCTION_ERROR = 98

static final int	REASON_NOT_LOGINED = 99

static final int	REASON_OTHER = 100

static final String	CONFIG_KEY_SERVER_ADDRESS = "config_key_server_address"

static final String	CONFIG_KEY_DEVICE_ID = "config_key_device_id"

static final String	CONFIG_KEY_HTTPS_PROXY = "config_key_https_proxy"

static final String	CREATE_EXTRA_SDK_INFO_DIR = "create_extra_sdk_info_dir"

static final String	CREATE_EXTRA_IS_NEED_LOAD_LIBRARY = "create_extra_is_need_load_Library"

static final String	CREATE_EXTRA_SDK_LOG_DIR = "create_extra_sdk_log_dir"

Protected 成员函数
abstract void	destroyObj ()

abstract Context	getContext ()

abstract void	addCallback (JCClientCallback callback)

abstract void	removeCallback (JCClientCallback callback)

详细描述

用于初始化sdk以及登录 Juphoon Cloud 平台

成员函数说明

◆ addCallback()

abstract void com.juphoon.cloud.JCClient.addCallback ( JCClientCallback callback )

abstractprotected

添加回调

参数

callback JCClientCallback 接口对象

◆ create()

static JCClient com.juphoon.cloud.JCClient.create	(	Context	context,
		String	appKey,
		JCClientCallback	callback,
		Map< String, String >	extraParams
	)

static

创建 JCClient 实例

JCClient 的所有接口函数，如无特殊说明，都建议在主线程调用

注解

请确保在调用其他 API 前先调用该方法创建并初始化 JCClient 对象
调用此方法创建 JCClient 对象后，期间没有调用过 destroy 方法销毁对象，然后又重复调用此方法，会直接返回第一次创建的 JCClient 对象

参数

context	上下文句柄
appKey	用户从 Juphoon Cloud 平台上创建应用获取的 AppKey 字符串，详见获取 appKey
callback	JCClientCallback 对象，用于回调相关通知
extraParams	额外参数，没有则填null。传 null 则使用默认值

返回: JCClient 对象

异常

context、appKey、JCClientCallback 任意参数传空就会抛出异常

参见: CreateExtra

◆ destroy()

static void com.juphoon.cloud.JCClient.destroy ( )

static

销毁 JCClient 对象

注解: 此方法为异步调用，所以在调用此方法后不能马上调用 create 方法重新创建 JCClient 对象

◆ destroyObj()

abstract void com.juphoon.cloud.JCClient.destroyObj ( )

abstractprotected

销毁对象

◆ getConfig()

abstract String com.juphoon.cloud.JCClient.getConfig ( @ConfigKey String key )

abstract

获取配置相关参数

参数

key 参数关键字

返回: 成功返回字符串类型的相应参数关键字的具体值, 失败返回 NULL

参见: JCClient.ConfigKey

◆ getContext()

abstract Context com.juphoon.cloud.JCClient.getContext ( )

abstractprotected

获得上下文

返回: 返回 Context 对象

◆ getDisplayName()

abstract String com.juphoon.cloud.JCClient.getDisplayName ( )

abstract

获取自己的昵称

返回: 自己的昵称

◆ getState()

abstract int com.juphoon.cloud.JCClient.getState ( )

abstract

当前状态

返回

当前状态

STATE_NOT_INIT : 未初始化
STATE_IDLE : 未登录
STATE_LOGINING : 登录中
STATE_LOGINED : 登录成功
STATE_LOGOUTING : 登出中

◆ getUserId()

abstract String com.juphoon.cloud.JCClient.getUserId ( )

abstract

获得用户标识

返回的用户标识就是用户在调用 login 方法时传入的 userId 参数，需要注意的是只有用户状态为登录中或已登录才能获取到值，其他状态将返回 null

返回: 用户标识

◆ login() [1/2]

abstract boolean com.juphoon.cloud.JCClient.login	(	String	userId,
		String	password
	)

abstract

登录 Juphoon Cloud 平台

只有登录成功后才能进行平台上的各种业务

参数

userId	用户名，长度在 64 字节以内的字符串。以下为支持的字符集范围（共 66 个字符）： 26 个小写英文字母 a-z 26 个大写英文字母 A-Z 10 个数字 0-9 '+'，'-'，'_'，'.'。另外 '-'，'_'，'.' 这三个字符不能处于用户名的第一位
password	密码，不能为 null 或 ""，长度不能超过 128 字符

返回

调用是否成功

true：正常执行调用流程，登录结果通过 onLogin 通知
false：调用失败，不会收到 onLogin 通知

◆ login() [2/2]

abstract boolean com.juphoon.cloud.JCClient.login	(	String	userId,
		String	password,
		JCClientLoginParam	clientLoginParam
	)

abstract

登录 Juphoon Cloud 平台只有登录成功后才能进行平台上的各种业务

参数

userId	用户名，长度在 64 字节以内的字符串。以下为支持的字符集范围（共 66 个字符）： 26 个小写英文字母 a-z 26 个大写英文字母 A-Z 10 个数字 0-9 '+'，'-'，'_'，'.'。另外 '-'，'_'，'.' 这三个字符不能处于用户名的第一位
password	密码，不能为 null 或 ""，长度不能超过 128 字符
clientLoginParam	登录校验参数，传 null 则按默认值。一般不需要设置，如需设置请询问客服

返回: 返回 true 表示正常执行调用流程，false 表示调用异常，异常错误通过 JCClientCallback 通知

◆ logout()

abstract boolean com.juphoon.cloud.JCClient.logout ( )

abstract

登出 Juphoon Cloud 平台

登出后不能进行平台上的各种业务

返回

调用是否成功

true：正常执行调用流程，登出结果通过 onLogout 通知
false：调用失败，不会收到 onLogout 通知

◆ removeCallback()

abstract void com.juphoon.cloud.JCClient.removeCallback ( JCClientCallback callback )

abstractprotected

删除回调

参数

callback JCClientCallback 接口对象

◆ sendOnlineMessage()

abstract int com.juphoon.cloud.JCClient.sendOnlineMessage	(	String	message,
		String	userId
	)

abstract

发送在线消息

参数

message	消息内容
userId	用户 id

返回: 成功返回整型的相应的消息 id，收到 JCClientCallback::onOnlineMessageSendResult 的通知失败返回 -1 不会收到 JCClientCallback::onOnlineMessageSendResult 的通知

◆ setAppkey()

abstract void com.juphoon.cloud.JCClient.setAppkey ( String appkey )

abstract

设置appkey

参数

appkey 设置appkey

◆ setConfig()

abstract boolean com.juphoon.cloud.JCClient.setConfig	(	@ConfigKey String	key,
		String	value
	)

abstract

设置配置相关参数

CONFIG_KEY_SERVER_ADDRESS , CONFIG_KEY_HTTPS_PROXY 均需要在 login 之前调用

参数

key	参数关键字
value	参数具体值

返回

设置是否成功

true：设置成功
false：设置失败

参见: JCClient.ConfigKey

◆ setDisplayName()

abstract void com.juphoon.cloud.JCClient.setDisplayName ( String displayName )

abstract

设置自己的昵称

以下情况下都会将自己的昵称发送给其他用户：

发起呼叫场景获取对方昵称：getDisplayName
加入会议频道场景获取对方昵称：getDisplayName
访客发送消息时：SendMessage
坐席发送消息时：SendMessage

注解: 每次调用 create 方法初始化 SDK 后都需要重新设置

参数

displayName 要设置的昵称

◆ setForeground()

abstract void com.juphoon.cloud.JCClient.setForeground ( boolean foreground )

abstract

是否设置为前台应用进入前台或进入后台都需要调用此方法进行设置。应用被设置成前台时主动触发，应用被设置为后台时，可以优化数据链路从而减少耗电量

参数

foreground

是否为前台

true: 设置为前台
false: 设置为后台

类成员变量说明

◆ CONFIG_KEY_DEVICE_ID

final String com.juphoon.cloud.JCClient.CONFIG_KEY_DEVICE_ID = "config_key_device_id"

static

设备id

◆ CONFIG_KEY_HTTPS_PROXY

final String com.juphoon.cloud.JCClient.CONFIG_KEY_HTTPS_PROXY = "config_key_https_proxy"

static

https代理, 例如 192.168.1.100:3128

◆ CONFIG_KEY_SERVER_ADDRESS

final String com.juphoon.cloud.JCClient.CONFIG_KEY_SERVER_ADDRESS = "config_key_server_address"

static

服务器地址

◆ CREATE_EXTRA_IS_NEED_LOAD_LIBRARY

final String com.juphoon.cloud.JCClient.CREATE_EXTRA_IS_NEED_LOAD_LIBRARY = "create_extra_is_need_load_Library"

static

设置是否需要自动加载so库默认为"1"，不需要则设置为"0"

◆ CREATE_EXTRA_SDK_INFO_DIR

final String com.juphoon.cloud.JCClient.CREATE_EXTRA_SDK_INFO_DIR = "create_extra_sdk_info_dir"

static

SDK 信息存放目录，包括账号信息，日志信息等, 如果设置 CREATE_EXTRA_SDK_LOG_DIR 则日志不会存放在此目录

◆ CREATE_EXTRA_SDK_LOG_DIR

final String com.juphoon.cloud.JCClient.CREATE_EXTRA_SDK_LOG_DIR = "create_extra_sdk_log_dir"

static

日志目录设置

◆ STATE_IDLE

final int com.juphoon.cloud.JCClient.STATE_IDLE = 1

static

未登录

◆ STATE_LOGINED

final int com.juphoon.cloud.JCClient.STATE_LOGINED = 3

static

登录成功

◆ STATE_LOGINING

final int com.juphoon.cloud.JCClient.STATE_LOGINING = 2

static

登录中

◆ STATE_LOGOUTING

final int com.juphoon.cloud.JCClient.STATE_LOGOUTING = 4

static

登出中

◆ STATE_NOT_INIT

final int com.juphoon.cloud.JCClient.STATE_NOT_INIT = 0

static

未初始化

该类的文档由以下文件生成:

JCClient.java

类

Public 成员函数

静态 Public 成员函数

静态 Public 属性

Protected 成员函数

详细描述

成员函数说明

◆ addCallback()

◆ create()

◆ destroy()

◆ destroyObj()

◆ getConfig()

◆ getContext()

◆ getDisplayName()

◆ getState()

◆ getUserId()

◆ login() [1/2]

◆ login() [2/2]

◆ logout()

◆ removeCallback()

◆ sendOnlineMessage()

◆ setAppkey()

◆ setConfig()

◆ setDisplayName()

◆ setForeground()

类成员变量说明

◆ CONFIG_KEY_DEVICE_ID

◆ CONFIG_KEY_HTTPS_PROXY

◆ CONFIG_KEY_SERVER_ADDRESS

◆ CREATE_EXTRA_IS_NEED_LOAD_LIBRARY

◆ CREATE_EXTRA_SDK_INFO_DIR

◆ CREATE_EXTRA_SDK_LOG_DIR

◆ STATE_IDLE

◆ STATE_LOGINED

◆ STATE_LOGINING

◆ STATE_LOGOUTING

◆ STATE_NOT_INIT