乐虎游戏|乐虎国际登录|欢迎你

集成环信客服功能

日期:2020-04-05编辑作者:计算机资讯

我自己在集成环信的移动客服的时候,发现很多东西报错,出现了非常多的麻烦,后来一步一步解决了,文章主要讲我自己遇到的一些问题

在上一篇文章中我们了解了环信客户互动云的功能,以及集成SDK前需要做的配置工作,接下来我们正式进入项目集成阶段,集成流程摘自环信CEC iOS SDK集成,本文对环信文档做了更加详细的说明,以及一些未指明错误的处理办法,如有不当之处,请各位大神指正.
文末会附上GitHub的demo地址

项目需要集成环信客服系统,这两天的摸爬滚打和客服沟通后整理一篇文章,以作备份

首先导入下载的SDK

一、集成

提示 : 请按照以下5步全部操作完毕后再编译,中间步骤执行中如果编译报错了不用管,继续往下执行即可

环信的客服真的真的真的很赞。

图片 1

1.新建项目

首先我们先新建自己的项目,名称起为HuanxinKefu

详细集成步骤如下:

增加相关的依赖库

2.向Build Settings → Linking → Other Linker Flags 中增加-ObjC(注意区分大小写)。

SDK方面

图片 2

3.复制所需SDK文件夹
  • 打开项目目录,新建一个文件夹HXService,从商城Demo中找HelpDeskUI文件夹,找到后复制进HXService文件夹

    图片 3

    导入HelpDeskUI.png

  • 新建一个文件夹HXFramework,然后将HelpDesk.framework、HyphenateLite.framework(不包含实时语音功能)放在HXFramework文件夹中

    图片 4

    导入环信客户互动云SDK.png

1.先把 移动客服:商城”demo源码和HelpDeskUI(iOS) 下载下来,该SDK基于IM SDK 3.x,如同时使用环信IM功能(非音视频),需使用此文档中的初始化、登录、登出操作,不需要添加IM的SDK,其IMSDK-API正常使用。

SDK 不支持 bitcode,在 Build Settings → Build Options → Enable Bitcode 中设置 NO。

4.导入SDK
  • 将HXService文件夹拖进项目中,勾选 Copy items if needed 和 Create groups,此时不要慌着编译,报错也没事,先不管,继续往下操作

    图片 5

    导入HelpDeskUI.png

注意点 : Xcode 9.0的bug,把文件拖进项目后,这些文件的.m不能自动添加到Compile Source中,导致找不到文件等错误,需要手动添加.m到Compile Source,特别麻烦
解决方案 : 升级Xcode 9.1或9.2

  • 导入SDK,选中项目--General--Embedded Binaries--添加HelpDesk.framework和HyphenateLite.framework

    图片 6

    导入SDK.png

2.打开下载好的demo,架构如下图

在工程info.plist文件中 增加隐私权限

5.在项目中新建一个文件夹HXChat,将商城Demo中的下图中蓝色标注文件或文件夹全部复制进HXChat

HFileViewController : 查看聊天文件控制器(不是发送文件的)
HDChatViewController : 聊天界面控制器(最主要的控制器)
AppDelegate+HelpDesk : 初始化环信SDK,APNs,登录,退出操作,多设备登录功能等
SCLoginManger : 环信SDK管理者(单例)
SVProgressHUD : 蒙版/HUD
LocalDefine : 一些常量的宏定义

图片 7

所需文件.png

Privacy - Photo Library Usage Description 需要访问您的相册

7.在pch文件或全局.h文件中添加如下代码:
//以下两段代码选用一个就好

//包含实时音视频的这样添加
#ifdef __OBJC__
#import <HelpDesk/HelpDesk.h>
#import "HelpDeskUI.h"
#import "SVProgressHUD.h"
#import "LocalDefine.h"
#import "UIImageView+WebCache.h"
#import "UIButton+WebCache.h"
#import "其他头文件"
#endif

//不包含实时音视频的这样添加
#ifdef __OBJC__
#import <HelpDeskLite/HelpDeskLite.h>
#import "HelpDeskUI.h"
#import "SVProgressHUD.h"
#import "LocalDefine.h"
#import "UIImageView+WebCache.h"
#import "UIButton+WebCache.h"
#import "其他头文件"
#endif

注意点:如果你的pch文件中已经导入了其他头文件,务必将其他头文件也写在#ifdef __OBJC__ 和 #endif 之间,不然会报错,因为SDK中包含的有C文件

图片 8

Privacy - Microphone Usage Description 需要访问您的麦克风

8.需要修改的细节
  • AppDelegate+HelpDesk.m 文件中注释掉Bugly(如果你需要bugly,在商城demo的Frameworks文件夹中找到Bugly.framework并拖进项目,此步则可以不用执行)
//#import <Bugly/Bugly.h>
//[Bugly startWithAppId:@"b336efe49a"];
  • AppDelegate+HelpDesk.m 文件中,导入该头文件
#import "SCLoginManager.h"
  • HDChatViewController中需要注释掉以下代码:
//第17行导入头文件,注释掉
//#import "HDLeaveMsgViewController.h"

//第77行的留言方法注释掉
// 留言
/*
- (void)moreViewLeaveMessageAction:(HDChatBarMoreView *)moreView
{
    [self stopAudioPlayingWithChangeCategory:YES];
    HDLeaveMsgViewController *leaveMsgVC = [[HDLeaveMsgViewController alloc] init];
    [self.navigationController pushViewController:leaveMsgVC animated:YES];
}
*/

//第211行,跳转留言控制器的方法注释掉
/*
- (void)didPressedLeaveMsgButton {
    HDLeaveMsgViewController *leaveMsgVC = [[HDLeaveMsgViewController alloc] init];
    [self.navigationController pushViewController:leaveMsgVC animated:YES];
}
*/

将HelpDeskDynamicSDK和HelpDeskUI两个文件夹,在Finder中复制到自己的项目的适当路径中(这个地方有个坑,稍后下午详细说明),然后拖拽到项目时选择 Create groups

Privacy - Camera Usage Description 需要访问您的摄像机

5.文件重复duplicate报错注意点

如果导入SDK后,编译,报文件重复duplicate的错,那是因为环信HelpDeskUI中的第三方库与你项目中已集成的第三方库重复,所以直接删掉HelpDeskUI--3rdparty中对应的库即可

图片 9

HelpDeskUI中的第三方库.png

3.选中当前的TARGET,向 General → Embedded Binaries 中添加以上两个依赖库。Linked Frameworks and Libraries 中会自动增加。

图片 10

6.此时编译,Success编译成功--文件结构如下

图片 11

最终文件浏览.png

图片 12

在pch文件或全局.h文件中添加如下代码

二、相关配置

4.Build Phases ---> Link Binary With Libraries 中添加依赖库

#ifdef__OBJC__

1.SDK 暂时不支持bitcode,在Build Settings →Enable Bitcode 改为NO。

图片 13

image.png

图片 14

#import"helpdesk_sdk.h"

2.去除大量多余的警告,在Build Settings →documentation comments 改为NO

图片 15

去除大量多余警告.png

    如下图:

#import"HelpDeskUI.h"

3.在工程info.plist文件中,增加隐私权限:

Privacy - Photo Library Usage Description 需要访问您的相册
Privacy - Microphone Usage Description 需要访问您的麦克风
Privacy - Camera Usage Description 需要访问您的摄像机

图片 16

权限配置.png

图片 17

#endif

三、使用

5.Build Settings ---> Linking ---> Other Linker Flags 中增加 -ObjC。

这个时候要记得将#ifdef__OBJC__和#endif将导入的类全包围如图

1.初始化
  • 在AppDelegate.m文件中的导入头文件
#import "AppDelegate+HelpDesk.h"
#import "ViewController.h" //初始界面,登录/注册界面
  • 在AppDelegate.m的- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions 方法中调用
   //1.创建窗口
    self.window = [[UIWindow alloc]initWithFrame:[UIScreen mainScreen].bounds];
    //2.初始化环信
    [self easemobApplication:application didFinishLaunchingWithOptions:launchOptions];
    //3.添加自定义小表情
    [[HDEmotionEscape sharedInstance] setEaseEmotionEscapePattern:@"\[[^\[\]]{1,3}\]"];
    [[HDEmotionEscape sharedInstance] setEaseEmotionEscapeDictionary:[HDConvertToCommonEmoticonsHelper emotionsDictionary]];

    //4.设置根控制器
    UIStoryboard *story = [UIStoryboard storyboardWithName:@"Main" bundle:nil];
    ViewController *vc = [story instantiateViewControllerWithIdentifier:@"story"];
    UINavigationController *nav = [[UINavigationController alloc]initWithRootViewController:vc];
    self.window.rootViewController = nav;

    //5.显示窗口
    [self.window makeKeyAndVisible];

    return YES;
  • 在初始界面ViewController中进行登录注册
    首先导入头文件
#import "HDChatViewController.h"
#import "SCLoginManager.h"

然后实现注册方法

//注册
- (void)regHuanXin{
    HError *error = [[HChatClient sharedClient] registerWithUsername:self.username.text password:self.password.text];

    if (!error) {
        NSLog(@"注册成功");
    }else{
        NSLog(@"注册失败:%@",error.errorDescription);
    }
}

实现登录方法,判断登录成功,则跳转到聊天控制器HDChatViewController

//登录方法
- (void)loginHuanXin{
    HChatClient *client = [HChatClient sharedClient];
    if (client.isLoggedInBefore != YES) {
        HError *error = [client loginWithUsername:self.username.text password:self.password.text];
        if (!error) {
            NSLog(@"登录成功");
            [self joinChat];
        } else {
            NSLog(@"登录失败");
        }
    }else{
        [self joinChat];
    }
}

//跳转到聊天控制器(重点)
- (void)joinChat{
    SCLoginManager *sc = [SCLoginManager shareLoginManager];
    HDChatViewController *chatVC = [[HDChatViewController alloc] initWithConversationChatter:sc.cname]; // 获取地址:kefu.easemob.com,“管理员模式 > 渠道管理 > 手机APP”页面的关联的“IM服务号”
    [self.navigationController pushViewController:chatVC animated:YES];
}
  • 退出登录方法
//退出登录
//如果要更换账号登录,一定要退出登录后再登录
- (IBAction)loginOutAction:(id)sender {
    HError *error = [[HChatClient sharedClient] logout:YES];
    if (error) { //登出出错
        NSLog(@"退出登录出错");
    } else {//登出成功
        NSLog(@"退出登录成功");
    }
}

6.SDK 不支持 bitcode,在 Build Settings ---> Build Options ---> Enable Bitcode 中设置 NO。

图片 18

2.配置环信
  • 找到AppDelegate+HelpDesk.m文件中的initializeCustomerServiceSdk方法,配置推送证书的名称,关于生成推送证书可参考 :
    其中的选项可以关闭/开启打印日志

    图片 19

    image.png

  • 在LocalDefine.h文件中,填写与客户互动云后台关联的信息,与后台建立关联关系

    图片 20

    image.png

  • 至此,基本集成工作已全部完毕,我们打开APP尝试聊天

    首先注册账号

    图片 21

    注册.png

然后点击登录,登录成功跳转到聊天控制器,我们尝试发送一条消息给后台客服  

![](https://upload-images.jianshu.io/upload_images/3244193-8cde1513ed80a8b1.png)

前台发消息.png

图片 22

后台接收到消息.png

至此,我们代码使用过程已经全部写完了,表情和语音信息都可以正常使用,目前只能接收和查看文件,如果想要集成发送文件功能,可以参考http://blog.csdn.net/mengmakies/article/details/64122172

图片 23

这时候你可能会遇到文件包错 找不到pch文件,这时候就要改路径啦,下面是我从一个大神那里找到的方法

3.注意点
  • 远程推送在AppDelegate+HelpDesk中已经集成,本地推送代码可以参考商城Demo
  • 聊天控制器HDChatViewController继承自HelpDeskUI中的HDMessageViewController,HDMessageViewController才是真正的聊天控制器,如果要修改东西,也可以从该控制器中修改
  • 当聊天控制器HDChatViewController没有加载(例如APP刚启动)或已经dealloc,此时是不能接受到后台发的消息的(HDChatViewController有消息监听方法),但是我们使用中往往会有这样的需求,此时,你可以在AppDelegate+HelpDesk(其他不会dealloc的控制器也可以)中也添加消息监听的代理方法,多个接受消息监听的方法互不影响
//添加消息监控,第二个参数是执行代理方法的队列,默认是主队列
[[HChatClient sharedClient].chatManager addDelegate:self delegateQueue:nil];
//移除消息监控
[[HChatClient sharedClient].chatManager removeDelegate:self];

- (void)messagesDidReceive:(NSArray *)aMessages{
     //收到普通消息,格式:<HMessage *>
     //只接收未读消息,每条消息都会调用一次该方法
}
  • 头像和昵称都可以在HelpDeskUI中修改
![](https://upload-images.jianshu.io/upload_images/3244193-f9e876422c8bb75f.png)

修改头像/昵称.png

7.在工程info.plist文件中 增加隐私权限

图片 24

四、总结

1.更多扩展功能可以查看环信文档,如有需要,我可以将功能加在自己的Demo中
2.如果在集成过程中遇到任何问题,请在下方留言~我们共同交流
3.附github的demo地址 : 自己写的demo
下载后只需导入HelpDeskLite.framework,HyphenateLite.framework即可
4.感谢各位的支持~

图片 25

图中是我的项目弄好后的 不要有子目录什么的,直接一个工程名字就可以了前面加上$/

Privacy - Photo Library Usage Description 需要访问您的相册

图片 26

Privacy - Microphone Usage Description 需要访问您的麦克风

还有环信的文件里包含了MBProgressHUD和MJRefresh,如果你的项目里像我一样已经用cocopods导入了这两个第三方,那就要把它的删掉,如图是删掉后的

Privacy - Camera Usage Description 需要访问您的摄像机

本文由乐虎游戏发布于计算机资讯,转载请注明出处:集成环信客服功能

关键词:

iOS开拓:多个方可实时加点的Chart

商厦项目有亟待用到胎儿心率监测,设计的分界面逻辑是内需一个得以表格,可以动态的在下边画上数据。有一些相...

详细>>

IOS TableViewCell嵌套webview

IMG_0521.JPG 我们开发中,在使用UITableView的时候经常会遇到这样的需求:tableview的cell中的内容是动态的。于是我们就在...

详细>>

乐虎国际登录iOS之Pod install VS Pod update

乐虎国际登录,此文为翻译文章,原文网址: 简介 大多数人使用CocoaPods的时候都会想当然的以为podinstall仅仅在第一...

详细>>

iOS 用RunTime重写KVO&lt;附德姆o&gt;

3.在第二步之后,我点击一个button ,push 到另外一个ViewController(TestViewController)里面,然后在TestViewController里面,点击...

详细>>