【iOS】环信客户互动云SDK集成+使用攻略(二)

时间  2019-11-08
标签 iOS 客户 互动 sdk 集成 使用 攻略 栏目 iOS 繁體版
原文   原文链接

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

提示 : 请按照如下5步所有操做完毕后再编译,中间步骤执行中若是编译报错了不用管,继续往下执行便可git

1.新建项目

首先咱们先新建本身的项目,名称起为HuanxinKefugithub

2.向Build Settings → Linking → Other Linker Flags 中增长-ObjC（注意区分大小写）。

3.复制所需SDK文件夹

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

    导入HelpDeskUI.png

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

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

4.导入SDK

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

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

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

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

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

所需文件.png

6.在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文件.net

7.须要修改的细节

  • 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];
}
*/
复制代码

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

若是导入SDK后,编译,报文件重复duplicate的错,那是由于环信HelpDeskUI中的第三方库与你项目中已集成的第三方库重复,因此直接删掉HelpDeskUI--3rdparty中对应的库便可3d

HelpDeskUI中的第三方库.png

9.此时编译,Success编译成功--文件结构以下

最终文件浏览.png

2、相关配置

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

image.png

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

去除大量多余警告.png

3.在工程info.plist文件中，增长隐私权限：

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

权限配置.png

3、使用

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(@"退出登陆成功");
    }
}
复制代码

2.配置环信

  • 找到AppDelegate+HelpDesk.m文件中的initializeCustomerServiceSdk方法,配置推送证书的名称,关于生成推送证书可参考 : www.jianshu.com/p/4be583833… 其中的选项能够关闭/开启打印日志

    image.png

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

    image.png

  • 至此,基本集成工做已所有完毕,咱们打开APP尝试聊天 首先注册帐号

    注册.png
    而后点击登陆,登陆成功跳转到聊天控制器,咱们尝试发送一条消息给后台客服
    前台发消息.png

后台接收到消息.png
至此,咱们代码使用过程已经所有写完了,表情和语音信息均可以正常使用,目前只能接收和查看文件,若是想要集成发送文件功能,能够参考http://blog.csdn.net/mengmakies/article/details/64122172 #####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中修改
    修改头像/昵称.png

4、总结

1.更多扩展功能能够查看环信文档,若有须要,我能够将功能加在本身的Demo中

2.若是在集成过程当中遇到任何问题,请在下方留言~咱们共同交流

3.附github的demo地址 : 本身写的demo 下载后只需导入HelpDeskLite.framework,HyphenateLite.framework便可

4.感谢各位的支持~

相关文章
相关标签/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公众号
   欢迎关注本站公众号,获取更多信息
联系我们 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程