ChatClient (kefu-sdk 1.1.9 API)

java.lang.Object
- com.hyphenate.chat.ChatClient

public final class ChatClient
extends java.lang.Object

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface ChatClient.ConnectionListener

static class ChatClient.Options
初始化Option类

Nested Classes
Modifier and Type	Class and Description
`static interface`	`ChatClient.ConnectionListener`
`static class`	`ChatClient.Options` 初始化Option类

Field Summary

Fields
Modifier and Type Field and Description

static boolean multiChannel

static java.lang.String TAG

Fields
Modifier and Type	Field and Description
`static boolean`	`multiChannel`
`static java.lang.String`	`TAG`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`java.lang.String`	`accessToken()` 获取登录token
`void`	`addConnectionListener(ChatClient.ConnectionListener listener)` 增加消息监听
`boolean`	`addEmojiconInfo(java.lang.String tenantId, java.lang.String iconsJson, java.lang.String packagesJson)` sdk外请勿调用
`java.lang.String`	`appKey()` 获取appkey
`CallManager`	`callManager()` 获取音视频管理类
`void`	`changeAppKey(java.lang.String appKey)` 动态修改appkey,只能未登录状态修改,否则会抛出异常
`void`	`changeTenantId(java.lang.String newTenantId)` 修改租户id
`ChatManager`	`chatManager()` 获取聊天管理类
`void`	`createAccount(java.lang.String userName, java.lang.String password, Callback callback)` Deprecated.
`java.lang.String`	`currentUserName()` 获取当前用户名
`boolean`	`deleteEmojiconInfo(java.lang.String tenantId)` sdk外请勿调用
`EmojiconManager`	`emojiconManager()` 获取emojicon管理类
`java.lang.String`	`getAccessToken()` Deprecated.
`java.lang.String`	`getAppKey()` Deprecated.
`ChatManager`	`getChat()` Deprecated.
`java.lang.String`	`getCurrentUserName()` Deprecated.
`java.lang.String`	`getEmojiconInfoIconsJson(java.lang.String tenantId)` sdk外请勿调用
`java.lang.String`	`getEmojiconInfoPackagesJson(java.lang.String tenantId)` sdk外请勿调用
`java.lang.String`	`getIMSDKVersion()` Deprecated.
`static ChatClient`	`getInstance()`
`java.lang.String`	`getKefuServerAddress()` Deprecated.
`java.lang.String`	`getSDKVersion()` Deprecated.
`java.lang.String`	`getTenantId()` Deprecated.
`java.lang.String`	`iMSdkVersion()` 获取IM sdk版本号
`boolean`	`init(android.content.Context context, ChatClient.Options options)` 初始化
`boolean`	`isConnected()` Deprecated.
`boolean`	`isLoggedInBefore()` 检测是否账号已经登录建议在每次登录前都加上,意思是登录过不用再次请求登录.
`java.lang.String`	`kefuRestServer()` 获取服务器地址
`TicketManager`	`leaveMsgManager()` 获取留言管理类
`void`	`login(java.lang.String userName, java.lang.String password, Callback callback)` 访客登录
`void`	`loginWithToken(java.lang.String userName, java.lang.String token, Callback callback)` 访客token登录
`void`	`logout(boolean unbindToken, Callback callback)` 退出方法退出后将无法接收客服发来消息
`void`	`register(java.lang.String userName, java.lang.String password, Callback callback)` 注册账号
`void`	`removeConnectionListener(ChatClient.ConnectionListener listener)` 移除消息监听
`java.lang.String`	`sdkVersion()` 获取sdk版本号
`void`	`sendFCMTokenToServer(java.lang.String token)` Firebase令牌同步到环信服务器
`void`	`sendHMSPushTokenToServer(java.lang.String appid, java.lang.String token)` 传递appid和token到环信服务器
`void`	`setDebugMode(boolean paramBoolean)` Deprecated.
`boolean`	`setPushNickname(java.lang.String userNick)` 为iOS的apns显示昵称而不是ID 同步方法,需要在线程中调用
`void`	`setTenantId(java.lang.String newTenantId)` Deprecated.
`java.lang.String`	`tenantId()` 获取租户id
`boolean`	`updateNickToServer(java.lang.String userNick)` Deprecated.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - TAG
```
public static final java.lang.String TAG
```
    See Also:
    
    Constant Field Values
  - multiChannel
```
public static boolean multiChannel
```
- Method Detail
  - getInstance
```
public static ChatClient getInstance()
```
  - getKefuServerAddress
```
@Deprecated
public java.lang.String getKefuServerAddress()
```
    Deprecated.
    
    获取服务器地址
    
    Returns:
    
    服务器地址
    
    See Also:
    
    kefuRestServer()
  - kefuRestServer
```
public java.lang.String kefuRestServer()
```
    获取服务器地址
    
    Returns:
    
    服务器地址
  - init
```
public boolean init(android.content.Context context,
                    ChatClient.Options options)
```
    初始化
    
    Parameters:
    
    context - appContext
    
    options - 初始化选项
    
    Returns:
    
    是否成功
  - addEmojiconInfo
```
public boolean addEmojiconInfo(java.lang.String tenantId,
                               java.lang.String iconsJson,
                               java.lang.String packagesJson)
```
    sdk外请勿调用
  - deleteEmojiconInfo
```
public boolean deleteEmojiconInfo(java.lang.String tenantId)
```
    sdk外请勿调用
  - getEmojiconInfoIconsJson
```
public java.lang.String getEmojiconInfoIconsJson(java.lang.String tenantId)
```
    sdk外请勿调用
  - getEmojiconInfoPackagesJson
```
public java.lang.String getEmojiconInfoPackagesJson(java.lang.String tenantId)
```
    sdk外请勿调用
  - login
```
public void login(java.lang.String userName,
                  java.lang.String password,
                  Callback callback)
```
    访客登录
    
    Parameters:
    
    userName - 用户名
    
    password - 密码
    
    callback - 回调
  - loginWithToken
```
public void loginWithToken(java.lang.String userName,
                           java.lang.String token,
                           Callback callback)
```
    访客token登录
    
    Parameters:
    
    userName - 用户名
    
    token - 令牌
    
    callback - 回调
  - logout
```
public void logout(boolean unbindToken,
                   Callback callback)
```
    退出方法退出后将无法接收客服发来消息
    
    Parameters:
    
    callback - 回调
  - isLoggedInBefore
```
public boolean isLoggedInBefore()
```
    检测是否账号已经登录建议在每次登录前都加上,意思是登录过不用再次请求登录.
    
    Returns:
    
    已经登录过返回true, 未登录返回false
  - sendFCMTokenToServer
```
public void sendFCMTokenToServer(java.lang.String token)
```
    Firebase令牌同步到环信服务器
    
    Parameters:
    
    token - FCM 令牌
  - isConnected
```
@Deprecated
public boolean isConnected()
```
    Deprecated.
    
    检测服务器和当前用户是否连通区别于:方法 isLoggedIn,因为此方法可能已经登录过,只是当前没网,SDK会自动登录不需要再次调用login方法.
    
    Returns:
    
    服务器和当前账号正常连接返回 true, 当前连接已断开返回false
    
    See Also:
    
    isLoggedInBefore()
  - setPushNickname
```
public boolean setPushNickname(java.lang.String userNick)
```
    为iOS的apns显示昵称而不是ID 同步方法,需要在线程中调用
    
    Parameters:
    
    userNick - 昵称
  - updateNickToServer
```
@Deprecated
public boolean updateNickToServer(java.lang.String userNick)
```
    Deprecated.
    
    为iOS的apns显示昵称而不是ID 同步方法,需要在线程中调用
    
    Parameters:
    
    userNick - 昵称
    
    Returns:
    
    是否成功
    
    See Also:
    
    setPushNickname(String)
  - register
```
public void register(java.lang.String userName,
                     java.lang.String password,
                     Callback callback)
```
    注册账号
    
    Parameters:
    
    userName - 用户名
    
    password - 密码
    
    callback - 回调
  - createAccount
```
@Deprecated
public void createAccount(java.lang.String userName,
                                      java.lang.String password,
                                      Callback callback)
```
    Deprecated.
    
    注册账号
    
    Parameters:
    
    userName - 用户名
    
    password - 密码
    
    callback - 回调
    
    See Also:
    
    register(String, String, Callback)
  - getChat
```
@Deprecated
public ChatManager getChat()
```
    Deprecated.
    
    instead of chatManger
    
    Returns:
    
    音视频管理类
    
    See Also:
    
    chatManager()
  - callManager
```
public CallManager callManager()
```
    获取音视频管理类
    
    Returns:
    
    音视频管理类
  - chatManager
```
public ChatManager chatManager()
```
    获取聊天管理类
    
    Returns:
    
    聊天管理类
  - leaveMsgManager
```
public TicketManager leaveMsgManager()
```
    获取留言管理类
    
    Returns:
    
    留言管理类
  - emojiconManager
```
public EmojiconManager emojiconManager()
```
    获取emojicon管理类
    
    Returns:
    
    emojicon管理类
  - currentUserName
```
public java.lang.String currentUserName()
```
    获取当前用户名
    
    Returns:
    
    当前用户名
  - getCurrentUserName
```
@Deprecated
public java.lang.String getCurrentUserName()
```
    Deprecated.
    
    获取当前用户名
    
    Returns:
    
    当前用户名
    
    See Also:
    
    currentUserName()
  - changeAppKey
```
public void changeAppKey(java.lang.String appKey)
                  throws com.hyphenate.exceptions.HyphenateException
```
    动态修改appkey,只能未登录状态修改,否则会抛出异常
    
    Parameters:
    
    appKey - 动态修改appkey
    
    Throws:
    
    com.hyphenate.exceptions.HyphenateException
  - changeTenantId
```
public void changeTenantId(java.lang.String newTenantId)
```
    修改租户id
    
    Parameters:
    
    newTenantId - 租户id
  - setTenantId
```
@Deprecated
public void setTenantId(java.lang.String newTenantId)
```
    Deprecated.
    
    修改租户id
    
    Parameters:
    
    newTenantId - 租户id
    
    See Also:
    
    changeTenantId(String)
  - tenantId
```
public java.lang.String tenantId()
```
    获取租户id
    
    Returns:
    
    租户id
  - getTenantId
```
@Deprecated
public java.lang.String getTenantId()
```
    Deprecated.
    
    获取租户id
    
    Returns:
    
    租户id
    
    See Also:
    
    tenantId()
  - accessToken
```
public java.lang.String accessToken()
```
    获取登录token
    
    Returns:
    
    token
  - getAccessToken
```
@Deprecated
public java.lang.String getAccessToken()
```
    Deprecated.
    
    获取登录token
    
    Returns:
    
    token
    
    See Also:
    
    accessToken()
  - sdkVersion
```
public java.lang.String sdkVersion()
```
    获取sdk版本号
    
    Returns:
    
    sdk版本号
  - getSDKVersion
```
@Deprecated
public java.lang.String getSDKVersion()
```
    Deprecated.
    
    获取sdk版本号
    
    Returns:
    
    sdk版本号
    
    See Also:
    
    sdkVersion()
  - iMSdkVersion
```
public java.lang.String iMSdkVersion()
```
    获取IM sdk版本号
    
    Returns:
    
    IM sdk版本号
  - getIMSDKVersion
```
@Deprecated
public java.lang.String getIMSDKVersion()
```
    Deprecated.
    
    获取IM sdk 版本号
    
    Returns:
    
    IM sdk版本号
    
    See Also:
    
    iMSdkVersion()
  - appKey
```
public java.lang.String appKey()
```
    获取appkey
    
    Returns:
    
    appkey
  - getAppKey
```
@Deprecated
public java.lang.String getAppKey()
```
    Deprecated.
    
    获取appkey
    
    Returns:
    
    appkey
    
    See Also:
    
    appKey()
  - setDebugMode
```
@Deprecated
public void setDebugMode(boolean paramBoolean)
```
    Deprecated.
    
    设置debug 模式过期接口，现已经挪入初始化Option
    
    Parameters:
    
    paramBoolean - 是否开启debug模式
  - addConnectionListener
```
public void addConnectionListener(ChatClient.ConnectionListener listener)
```
    增加消息监听
    
    Parameters:
    
    listener - 消息监听
  - removeConnectionListener
```
public void removeConnectionListener(ChatClient.ConnectionListener listener)
```
    移除消息监听
    
    Parameters:
    
    listener - 消息监听
  - sendHMSPushTokenToServer
```
public void sendHMSPushTokenToServer(java.lang.String appid,
                                     java.lang.String token)
```
    传递appid和token到环信服务器
    
    Parameters:
    
    appid -
    
    token -

Class ChatClient

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

TAG

multiChannel

Method Detail

getInstance

getKefuServerAddress

kefuRestServer

init

addEmojiconInfo

deleteEmojiconInfo

getEmojiconInfoIconsJson

getEmojiconInfoPackagesJson

login

loginWithToken

logout

isLoggedInBefore

sendFCMTokenToServer

isConnected

setPushNickname

updateNickToServer

register

createAccount

getChat

callManager

chatManager

leaveMsgManager

emojiconManager

currentUserName

getCurrentUserName

changeAppKey

changeTenantId

setTenantId

tenantId

getTenantId

accessToken

getAccessToken

sdkVersion

getSDKVersion

iMSdkVersion

getIMSDKVersion

appKey

getAppKey

setDebugMode

addConnectionListener

removeConnectionListener

sendHMSPushTokenToServer