即时交谈

创建即时交谈接口

KF5SDKConfig.INSTANCE.startKF5ChatActivity(MainActivity.this);
参数名称类名是否必填说明
contextContext当前上下文

注意:传入的参数为当前活动的Activity或者为ApplicationContext,最好为当前活动的Activity。

Chat相关Activity与xml布局

参数名称UI说明
KF5ChatActivityactivity_chat.xml即时交谈
MessageAdaptermessage_item_with_text_left.xml接收文本消息
message_item_with_text_right.xml发送文本消息
message_item_with_voice_left.xml接收语音消息
message_item_with_voice_right.xml发送语音消息
message_item_with_date.xml显示系统时间
message_item_with_system.xml显示系统消息
message_item_with_image_left.xml接收图片
message_item_with_image_right.xml发送图片

注:当需要修改各个视图下组件的属性,修改与之对应的布局文件。

方法说明

注:以下
requestQueue 初始化方法:KF5Volley.newRequestQueue(activity);
Httprequest 初始化方法:HttpRequest.getInstance()。

初始化IM用户的相关信息请求

HttpRequest.sendInitIMUserRequest(Context context ,Map<String, String> map , KF5RequestQueue requestQueue ,
        HttpRequestCallBack callBack)
参数名称类型说明
contextContext上下文
mapMap<String,String>需要POST的内容
requestQueueKF5RequestQueue管理请求队列
callbackHttpRequestCallBack请求结果回调

ChatActivitParamsConfig

说明:即时交谈的参数管理类,直接采用构造函数实例化即可。

参数名称类型说明
userParamsString自定义用户信息

注:该参数为json数组格式,例如{"value":"男生","name":"性别"},保存该对象的方法 KF5SDKActivityParamsManager.setChatParamsConfig(paramsConfig)。

交谈界面UI设置

ChatActivityUIConfig

说明:即时交谈UI管理类,直接采用构造函数实例化即可。

参数名称类型说明
tvTitleVisibleBoolean头部标题是否可见,默认为true
tvTicketVisibleBoolean头部右侧工单是否可见,默认为true
tvTicketTextString头部右侧工单按钮内容
showPopwindowBoolean头部右侧工单按钮点击是否显示popwindow,默认为true
ratDialogTitleString请求服务评价对话框的title
ratTipContentIfRatingSuccessString评价成功时提示的内容
showContentWhenChatEndString会话结束时title显示的内容
showContentWhenConnectErrorString连接错误时title显示的内容
showContentWhenConnectingString正在连接时title显示的内容
showContentWhenGetAgentString分配客服时显示的title
showContentWhenNoAgentOnlineString没有客服在线时title显示的内容
showDialogIfNoAgentOnlineBoolean是否显示对话框当没有客服在线的时候
titleForDialogIfNoAgentOnlineString没有客服在线时,弹出的对话框显示的title
userDefinedRatingDialogCallBackUserDefinedRatingDialogCallBack-
kf5ChatActivityTopRightBtnCallBackKf5ChatActivityTopRightBtnCallBack-
noAgentOnlineDialogCallBackNoAgentOnlineDialogCallBack-

注:

UserDefinedRatingDialogCallBack: 设置IM中自定义请求评价的回调接口,设置了该接口,开发者可以自定义请求评价的UI,同时可以通过接口通知IM中用户选择的评价是满意与不满意.

kf5ChatActivityTopRightBtnCallBack: KF5ChatActivity中右上角按钮自定义点击事件的回调接口,默认为空,如果需要设置该回调接口起效,首先设置setShowPopwindow(boolean)为false;当设置PopWindow不可显示时:如果回调接口为空,则默认跳转到LookFeedBackActivity.

NoAgentOnlineDialogCallBack: 当没有客服在线同时需要显示提示对话框时,点击对话框确定按钮的回调事件,默认为空,当不设置该回调事件时,默认跳转到FeedBackActivity界面.

保存该对象的方法 KF5SDKActivityUIManager.setChatActivityUIConfig(chatActivityUIConfig)。

交谈界面适配器UI管理类

ChatAdapterUIConfig
参数名称类型说明
linkActionDownTextColorint设置IM适配器中接收到的消息中超链接按下的背景颜色
msgComeLinkTextColorint设置IM适配器中接收到消息中超链接的字体颜色
msgComeTextColorint设置IM适配器中接收到消息中显示文本内容的字体颜色
msgSendLinkTextColorint设置IM适配器中发送消息中超链接的字体颜色
msgSendTextColorint设置IM适配器中发送的消息中显示文本内容的字体颜色
tvContentTextSizeint设置IM适配器中消息内容为文本时字体大小

注:保存该对象的方法KF5SDKActivityUIManager.setChatAdapterUIConfig(chatAdapterUIConfig);

聊天用户自定义信息管理类

ChatActivitParamsConfig
参数名称类型说明
userParamsString用户自定义字段内容

注:保存该对象的方法为 KF5SDKActivityParamsManager.setChatParamsConfig(ChatActivitParamsConfig chatParamsConfig)。