一、IM插件的介绍及导入

1.1、IM插件的介绍及结构

1.1.1、插件介绍

1.1.2、插件结构

1.1.3、IM插件主要头文件

1.1.4、需导入第三方库

1.2、集成IM插件

1.2.1、导入IM插件

 

1.2.2、设置工程属性

 

  

 

 

 

1.2.3、适配iOS 10注意事项

 

1.2.4、编译工程

二、插件配置

2.1、服务器配置

  

2.2、IM 代理方法

 [AppModel sharedInstance].appModelDelegate = self;

2.2.1、必须实现的回调方法

2.2.1.1、设置当前登录人信息

 -(NSDictionary*)onGetUserInfo {
 NSMutableDictionary *dic = [NSMutableDictionary dictionary];
 //账号
 [dic setObject:self.accountName forKey:@"account"];
 //手机号
 [dic setObject:self.accountName forKey:@"mobile"];
 //姓名
[dic setObject:self.accountName forKey:@"member_name"];
 //头像路径
[dic setObject: @" " forKey:@"avatar"];
 return dic;
}

2.2.1.2、设置联系人信息

 /*
 @brief 获取联系人信息
 @param id 联系人的信息
 @param type 0:根据account获取，1:根据手机号获取 ，目前只使用0
 */
-(NSDictionary*)getDicWithId:(NSString*)Id withType:(int) type;

-(NSDictionary*)getDicWithId:(NSString*)Id withType:(int) type{
 NSMutableDictionary *dic = [NSMutableDictionary dictionary];
 //账号
 [dic setObject:Id forKey:@"account"];
 //手机号
 [dic setObject:Id forKey:@"mobile"];
 //姓名
[dic setObject:Id forKey:@"member_name"];
 //头像路径
[dic setObject: @" " forKey:@"avatar"];
 return dic;
}

2.2.2、可选实现的回调方法

2.2.2.1、设置选择联系人界面

点击添加按钮场景如下图:

 

 

/*
 @brief 选择联系人界面
 @param exceptData 需要传进选择联系人界面的数据, @"members"：单聊再选人时原有人组成的数
 组，@"msg"：转发的消息，@"groupId"：群聊再选人的groupId
 @param type 根据选人的不同情形选择类型, SelectObjectType在KitBaseHeader.h中
 @return 选择联系人界面
 */
-(UIViewController *)getChooseMembersVCWithExceptData:(NSDictionary *)exceptData WithType:(SelectObjectType)type;

 -(UIViewController *)getChooseMembersVCWithExceptData:(NSDictionary *)exceptData WithType:(SelectObjectType)type {
 IMChooseMembersViewController *chooseMembersVC = [[IMChooseMembersViewController alloc] init];
chooseMembersVC.exceptData = exceptData;
chooseMembersVC.type = type;
 return chooseMembersVC;
} 

2.2.2.2、设置联系人详情界面

 

 /*
 @brief 联系人详情界面
 @param data:联系人账号(字符串类型，联系人的账号)
 @return 详情界面
 */
-(UIViewController *)getContactorInfosVCWithData:(id)data; 

 -(UIViewController *)getContactorInfosVCWithData:(id)data {
 if ([data isKindOfClass:[NSString class]]) {
 IMContactorInfosViewController *contactorInfosVC = [[IMContactorInfosViewController alloc] initWithAccount:(NSString *)data];
 return contactorInfosVC;
 }
 return nil;
}

2.2.2.3、聊天界面“+”号功能列表定制

/*
 @brief 定制聊天界面点击加号后的功能
 @param isGroup:是群组界面还是点对点界面
 @param members:群聊是群成员id，单聊是对方的id
 @param myImagesArr：图片数组 ，myTextArr:标题数组，mySelectorArr:点击事件数组
 @param completion(myImagesArr, myTextArr, mySelectorArr);
 */
- (void) )getChatMoreArrayWithIsGroup:(BOOL)isGroup andMembers:(NSArray *)members completion:(void(^)(NSArray *myImagesArr,NSArray *myTextArr,NSArray *mySelectorArr))completion;

- (void)getChatMoreArrayWithIsGroup:(BOOL)isGroup andMembers:(NSArray *)members completion:(void(^)(NSArray *myImagesArr,NSArray *myTextArr,NSArray *mySelectorArr))completion {
 
 NSArray *imagesArr;
 NSArray *textArr;
 NSArray *selectorArr;
 if(isGroup)
 {
 imagesArr = @[@"im_icon_images",@"im_icon_camera",@"file",@"pic_txt",@"position"];
 textArr = @[@"图片",@"小视频",@"发送文件",@"发送图文",@"位置];
 selectorArr = @[@"pictureBtnTap:",@"littleVideoBtnTap:",@"document_collaborationBtnTap:",@"pictureWhithTextBtnTap:",@"locationBtnTap:" ];
 }else
 {
 imagesArr = @[@"im_icon_images",@"im_icon_camera",@"file",@"pic_txt",@"position",@"im_icon_burn"];
 textArr = @[@"图片",@"小视频",@"发送文件",@"发送图文",@"位置",@"阅后即焚"];
 selectorArr = @[@"pictureBtnTap:",@"littleVideoBtnTap:",@"document_collaborationBtnTap:",@"pictureWhithTextBtnTap:",@"locationBtnTap:",@"burnAfterReadBtnTap:"];
 }
 completion(imagesArr,textArr,selectorArr);
}

2.2.2.4、会话列表界面右上角“+”号功能列表定制

/*
 @brief 定制会话列表界面点击右上角加号后的功能
 @param currentVC:当前的会话列表界面
 @param myImagesArr：图片数组 ，myTextArr:标题数组，mySelectorArr:点击事件数组
 @param completion(myImagesArr, myTextArr, mySelectorArr);
 */
- (void)getSessionMoreArrayWithCurrentVc:(UIViewController *)currentVC completion:(void(^)(NSArray *myImagesArr,NSArray *myTextArr,NSArray *mySelectorArr))completion;

 - (void)getSessionMoreArrayWithCurrentVc:(UIViewController *)currentVC completion:(void(^)(NSArray *myImagesArr,NSArray *myTextArr,NSArray *mySelectorArr))completion {
 NSArray *imagesArr = @[@"bomb_box_icon_01.png"];
  NSArray *textArr = @[@"发起群聊""];
 NSArray *selectorArr = @[@"startGroupChat"];
 completion(imagesArr,textArr,selectorArr);
}

2.2.2.5、聊天界面分享图文功能

 /*
 @brief 分享功能，请用户自己定制
 @param str 分享的文字
 @param image 分享的图片
 @param url 资源地址
 */
- (void)shareDataWithTarget:(id)target Text:(NSString *)str Image:(UIImage *)img Url:(NSString *)url;

 - (void)shareDataWithTarget:(id)target Text:(NSString *)str Image:(UIImage *)img Url:(NSString *)url
{
 NSArray *arr = @[
 UMShareToWechatSession,
 UMShareToWechatTimeline,
 ];
 
 [self shareDateWithTarget:target Text:str Image:img Url:url ShareList:arr];
}
 
- (void)shareDateWithTarget:(id)target Text:(NSString *)str Image:(UIImage *)img Url:(NSString *)url ShareList:(NSArray *)list
{
 
 if (!img)
 {
 //type
 [UMSocialData defaultData].extConfig.wxMessageType = UMSocialWXMessageTypeText;
 
 [UMSocialData defaultData].extConfig.wechatSessionData.url = url;
 [UMSocialData defaultData].extConfig.wechatTimelineData.url = url;
 
 [UMSocialSnsService presentSnsIconSheetView:target
 appKey:kUMAppKey
 shareText:str
 shareImage:nil
 shareToSnsNames:list
 delegate:self];
 }
 else
 {
 //注意：微信易信平台图文分享 图片描述不能超过1024字节 所以进行对文字描述的截取
 if ([str length]>1024)
 {
 str = [str substringToIndex:1024];
 }
 if (!url) {
 [UMSocialData defaultData].extConfig.wxMessageType = UMSocialWXMessageTypeImage;
 }else{
 //分享类型的设置 不同类型有差异
 [UMSocialData defaultData].extConfig.wxMessageType = UMSocialWXMessageTypeWeb;
 }
 
 [UMSocialData defaultData].extConfig.wechatSessionData.url = url;
 [UMSocialData defaultData].extConfig.wechatTimelineData.url = url;
 
 [UMSocialSnsService presentSnsIconSheetView:target
  appKey:kUMAppKey
 shareText:str
 shareImage:img
 shareToSnsNames:list
 delegate:self];
 }
}

三、登录IM插件

3.1、登录

3.1.1、强制登录

3.1.2、自动登录

3.1.3、代码示例

 NSMutableDictionary* loginDict = [[NSMutableDictionary alloc] initWithCapacity:10];
 [loginDict setObject:account forKey:@"account"];//账号
 [loginDict setObject:appId forKey:@"App_AppKey"];//App_AppKey对应用户在官网申请的appKey
[loginDict setObject:appToken forKey:@"App_Token"];//App_Token对应用户在官网申请的appToken
 
 [loginDict setObject:[NSNumber numberWithInt:1] forKey:@"mode"];//登录模式，1强制登陆模式，2自动登录模式
 //还可以添加设置一些可选的参数，比如名字、手机号等
 [ [AppModel sharedInstance] loginSDK:loginDict :^(NSError *error) {
 if (error.code == 200) {
 //登录成功
 }
 else if (error.code == 175004) {
 //您的账号在其他设备上登录
 }
 else {
 //登录失败
 }
 }];

3.2、退出登录

3.2.1、主动退出登录

 [[AppModel sharedInstance] logout:^(NSError *error) {
 MBProgressHUD* hud = [MBProgressHUD showHUDAddedTo:self.view animated:YES];
 if (error.code == 200) {
 // 退出成功;
 }else{
 // 退出失败
 }
 }];

3.2.2、被动退出登录

 - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
 //被踢下线
 [[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(beKickedOff) name:@"notificationKickedOff" object:nil];
 return YES;
}
//用户自定义被踢出后执行的方法
- (void)beKickedOff {
}

- (void)application:(UIApplication *)application didRegisterForRemoteNotificationsWithDeviceToken:(NSData *)deviceToken {
 // 将获取到的token传送消给SDK，用于苹果推消息使用
 [[AppModel sharedInstance] application:application didRegisterForRemoteNotificationsWithDeviceToken:deviceToken];
}

四、IM功能接口

4.1、在Chart.h中定义的主调方法

4.1.1、获取会话列表

 /**
 @brief 获取会话列表界面
 @discussion获取会话列表界面
 @return会话列表界面
 */
- (UIViewController *)getSessionViewController; 

 UIViewController *sessionVC = [[Chat sharedInstance] getSessionViewController];
 //如果是模态弹出，请设置导航控制器
 
UINavigationController *nav = [[UINavigationController alloc] initWithRootViewController:sessionVC];
 //设置导航栏左侧按钮调用会话列表界面的“shouldDismissViewController”方法来关闭该界面
 sessionVC.navigationItem.leftBarButtonItem = [[UIBarButtonItem alloc] initWithImage:[UIImage imageNamed:@"title_bar_back"] style:UIBarButtonItemStylePlain target:sessionVC action:@selector(shouldDismissViewController)];
    [self presentViewController:nav animated:YES completion:nil];

  

4.1.2、新建群组开始聊天

 /**
 @brief 新建一个群组开始聊天
 @discussion新建一个群组开始聊天
 @return输入群组成员
 */
- (UIViewController *)startChattingGroup;

 UIViewController *groupChat = [[Chat sharedInstance] startChattingGroup];
 [self.navigationController pushViewController:groupChat animated:YES]; 

4.1.3、获取/新建一个会话

 /**
 @brief 获取聊天界面
 @discussion 根据传入的会话Id获取聊天界面
 @param sessionId聊天对方的会话Id，点对点聊天时是对方的账号，群聊时是groupId
 @return聊天界面
 */
- (UIViewController *)getChatViewControllerWithSessionId:(NSString *)sessionId;

UIViewController *chatVC = [[Chat sharedInstance] getChatViewControllerWithSessionId:weakSelf.otherAccounttextField.text];

4.1.4、发起群聊及转发消息选人后开始聊天

 /*
 @brief 根据选择联系人界面所选择的数据开始聊天
 @param exceptData 传进聊天界面的数据
 @param addData 要添加的群组成员的数组
 @param completion 成功的回调
 @param failed 失败回调
 */
- (void)getChatViewControllerWithexceptData:(NSDictionary *)exceptData withAddDatas:(NSArray *)addData completion:(void(^)(UIViewController *controller))completion failed:(void(^)(NSString *codeStr))failed;

  [[Chat sharedInstance] getChatViewControllerWithexceptData:self.exceptData withAddDatas:@[accountOne, accountTwo] completion:^(UIViewController *controller) {
 [hud hideAnimated:YES];
 if (controller) {
 
 [self.navigationController pushViewController:controller animated:YES];
 }else {
 [self.navigationController popViewControllerAnimated:YES];
 }
 } failed:^(NSString *codeStr) {
    }];

4.1.5、获得未读的消息数目

//未读消息数
- (NSInteger)unreadMessageCount;

 在didFinishLaunchingWithOptions中:
//消息数量通知
 [[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(notificationUpdateIMMesNum:) name:@"notification_update_session_im_message_num" object:nil];
 [[NSNotificationCenter defaultCenter]addObserver:self selector:@selector(notificationUpdateIMMesNum:) name:@"KNotification_DeleteLocalSessionMessage" object:nil];

- (void)notificationUpdateIMMesNum:(NSNotification *)notification
{
 NSInteger num = [[Chat sharedInstance] unreadMessageCount];
 NSLog(@"%ld", (long)num);
}

4.1.6、设置个人信息

 - (void)setPersonInfoWithUserName:(NSString *)userName withUserAcc:(NSString *)userAcc;

4.2、在AppModel.h中定义的方法

4.2.1、获取未读消息数

 /**
 @brief 获取应用未读信息数
 @return 应用未读信息数
 */
- (NSInteger)getAppleBadgeNumberCount;

 NSInteger count = [[AppModel sharedInstance] getAppleBadgeNumberCount];
application.applicationIconBadgeNumber = count; 

4.3、在ChatSetting.h中定义的方法

4.3.1、设置、获取新消息提示开关状态

/*
 @brief 设置开启/关闭新消息提示
 @param status YES:开启，NO:关闭
 */
+(void)setNewMsgNotiVailableStatus:(BOOL)status;
 
/*
 @brief 获取新消息提示开关状态
 @return YES:开启新消息提示，NO:关闭新消息提示
 */
+(BOOL)newMsgNotiVailableStatus;

4.3.2、设置、获取声音提示新消息开关状态

/*
 @brief 设置声音提示新消息开关
 @param status YES:开启声音提示，NO:关闭声音提示
 */
+(void)setMsgSoundVailableStatus:(BOOL)status;
 
/*
 @brief 获取声音提示新消息开关状态
 @return YES:开启声音提示，NO:关闭声音提示
 */
+(BOOL)msgSoundVailableStatus;

4.3.3、设置、获取震动提示新消息开关状态

/*
 @brief 设置震动提示新消息开关
 @param status YES:开启震动提示，NO:关闭震动提示
 */
+(void)setMsgVibrateVailableStatus:(BOOL)status;
 
/*
 @brief 获取震动提示新消息开关状态
 @return YES:开启震动提示，NO:关闭震动提示
 */
+(BOOL)msgVibrateVailableStatus;

4.3.4、设置、获取听筒/扬声器接听语音消息状态

 /*
 @brief 设置听筒/扬声器接听语音消息
 @param status YES:听筒，NO:开启扬声器
 */
+(void)setPlayEarStatus:(BOOL)status;
 
/*
 @brief 获取听筒/扬声器接听语音消息状态
 @return YES:听筒，NO:开启扬声器
 */
+(BOOL)playEarStatus;

4.3.5、清除所有聊天记录

 /*
 @brief 清除所有聊天记录
 */
+(void)deleteAllSessionAndGroupnoticeData:(BOOL)status;

4.3.6、插件UI资源的替换说明

  [[NSUserDefaults standardUserDefaults] setObject:@"default" forKey:@"themeType"];
  [[NSUserDefaults standardUserDefaults] setObject:@"red" forKey:@"themeType"];
  [[NSUserDefaults standardUserDefaults] setObject:@"blue" forKey:@"themeType"];

chating_left_01/chating_left_01_on	接收方的气泡/选中状态	/
chating_right_02/chating_right_02_on	发送方的气泡/选中状态	/
chatView_location_map	位置的图片
default_avatar_01/default_avatar_02@2x	男/女 的默认头像	/
navigation_bar	导航栏的图片
nosession	消息页面没有消息时候的图片
title_bar_add_01	消息页面右上角
title_bar_back	返回上一页的图片
title_bar_detail	个人聊天页面右上角
title_bar_group_details_01	群组聊天右上角
video_button_play_normal	小视频播放按钮
voice_left_01	接收方语音按钮
voice_right_01	发送方语音按钮

4.4、在AppModelDelegate.h中定义的方法

4.4.1、自定义消息列表

-(UITableViewCell *)setSessionCellWithTableView:(UITableView *)tableView Ecsession:(ECSession*)session;

 -(CGFloat)setSessionCellHeightWithSessionArray:(NSArray *)sessionArray;

-(BOOL)isCustomSelectSessionCellWithSession:(ECSession *)session;

4.4.2、自定义聊天界面

 -(NSString *)getCustomCellidentifierWithMsg:(ECMessage *)message;

-(ChatViewCell*)getCustomCellWithOriginalCell:(ChatViewCell *)currentCell msg:(ECMessage *)message;

-(void)customBubbleImageWithCell:(ChatViewCell *)cell  isLongPressed:(BOOL)longPressed;

-(CGFloat)getCustomCellHeightWithMsg:(ECMessage*)message;

-(BOOL)customCellTapWithMsg:(ECMessage *)message

4.4.3、对收到的消息进行自定义处理

  -(BOOL)isCustomHandleMsg:(ECMessage *)message