NIMPassThroughManagerProtocol.h

浏览该文件的文档.

//
//  NIMPassThroughManagerProtocol.h
//  NIMLib
//
//  Created by Netease on 2019/12/19.
//  Copyright © 2019 Netease. All rights reserved.
//
 
#import <Foundation/Foundation.h>
 
@class NIMPassThroughHttpData;
@class NIMPassThroughMsgData;
 
NS_ASSUME_NONNULL_BEGIN
 
/**
 *  透传HTTP请求完成的回调block
 *  @param response     透传请求的响应,如果错误则为nil
 *  @param error        错误,如果成功则为nil
 */
typedef void(^NIMPassThroughCompletedBlock)(NIMPassThroughHttpData* __nullable response, NSError * __nullable error);
 
/**
 *  透传服务管理回调
 */
@protocol NIMPassThroughManagerDelegate <NSObject>
 
@optional
 
/**
*  收到透传消息
*
*  @param recvData   收到的透传消息数据
*/
- (void)didReceivedPassThroughMsg:(NIMPassThroughMsgData* __nullable)recvData;
 
@end
 
/**
 *  PassThrough接口
 */
@protocol NIMPassThroughManager  <NSObject>
 
/**
 *   透传HTTP请求到应用服务
 *
 *  @param reqData      透传的Http数据
 *  @param completion   经验操作完成后的回调
 *  @discussion         操作成功后，云信服务器会下发禁言的群通知消息
 */
- (void)passThroughHttpReq:(NIMPassThroughHttpData *)reqData
                completion:(nullable NIMPassThroughCompletedBlock)completion;
 
 
/**
 *  添加透传管理的委托
 *
 *  @param delegate 透传管理委托
 */
- (void)addDelegate:(id<NIMPassThroughManagerDelegate>)delegate;
 
/**
 *  移除透传管理的委托
 *
 *  @param delegate 透传管理委托
 */
- (void)removeDelegate:(id<NIMPassThroughManagerDelegate>)delegate;
 
@end
 
NS_ASSUME_NONNULL_END