IOS评论库SDK

优质

小牛编辑

139浏览

2023-12-01

概述

评论消息库是用来订阅消息的开发工具包，为开发者提供简单易用的接口，可以很方便地接收和发送消息信息。

阅读对象

本文档面向所有使用该 SDK 的开发人员、测试人员以及对此感兴趣的用户,要求开发者对消息的基本功能有一定的解。

开发准备

设备和系统版本

ios8.0 及以上 iphone5 及以上

安装包说明

lib:消息 SDK 开发包，包含播放器 framework 文件，需要在您的工程中进行引用。

快速开发

开发环境配置

需要准备 iOS 的运行环境(XCode6.0 以上版本，iOS SDK8.0 以上版本)，以及硬件 CPU 支持 ARMv7、ARMv7s 或 ARM64 的 iOS 设备。

sdk 包添加

使用 XCode 创建工程的方法如下:

XCode 创建一个 iOS 应用工程。
将 MuduComment.framework文件拖至项目中
将 SDK 中的头文件 MuduComment.h 包含到工程中。

#import <MuduComment/MuduComment.h>

其次按照下面步骤使用sdk进行开发
获取消息代理对象
订阅频道
监听频道发生的事件并处理

下面以 demo 为例来详细说明上面的这些步骤

1、导入头文件

#import <MuduComment/MuduComment.h>

2、创建评论管理对象，初始化评论对象，传入频道hash id（可从频道详情接口获取到actId)

[[MDCommenter instance] initWithActId:@"频道hashid"];

3、设置登录，使用昵称和头像地址进行登录

[[MDCommenter instance] login:@"用户昵称" avatar:@"用户头像" callback:^(NSString *data, NSError *err) {
    //data：OK
}];

4、注册评论消息回调监听并订阅频道

[[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(MDWebSocketDidClose:) name:kWebSocketDidCloseNote object:nil];
[[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(MDWebSocketDidReceiveMsg:) name:kWebSocketDidReceiveMessageNote object:nil];

//important!! 需订阅成功后才可收到评论
[[MDCommenter instance] subscribe];

notification实现


- (void)MDWebSocketDidClose:(NSNotification *)note 
{
    [[MDCommenter instance] reconnect];
}
- (void)MDWebSocketDidReceiveMsg:(NSNotification *)note
{
    //收到服务端发送过来的消息
    NSString * message = note.object;

    // ......
}

5、发布评论，需要登录后才能发布评论

[[MDCommenter instance] publishMessage:message callback:^(NSString *data, NSError *err) {
    if(err == nil) {
        //data：{"id":xxxx}
        NSLog(@"发送成功");
    } else {
        //发送失败
        NSLog(@"%@", err.description);
    }
}];

6、取消订阅，取消订阅后，评论会无法收到，请在页面退出时调用

[self.commenter unsubscribe];

7、退出页面时调用 [self.commenter close];

接口说明

MDCommenter

评论收发管理对象

下面详细介绍一下成员函数的具体使用:

init初始化

- (void)initWithActId:(NSString*)actId;

功能：根据频道ID创建评论管理对象。

login登录

- (void)login:(NSString*)username avatar:(NSString*)avatarUrl callback:(MDCommenterBlock)callback;

功能：根据用户名头像创建评论用户

subscribe订阅频道

- (void)subscribe;

publishMessage 发布评论

- (void)publishMessage:(NSString*)message callback:(MDCommenterBlock)callback;

功能：发布评论参数：发布的消息

unsubscribe 取消订阅

-(void) unsubscribe;

功能：取消订阅频道备注：取消订阅时，将不会收到评论，但不影响发送评论。

reconnect 重连

- (void)reconnect;

功能：重连功能备注：请在断网时制定策略进行重连操作，不然会收不到评论

close 退出页面

- (void)close;