//
//  WindMillSplashAd.h
//  WindSDK
//
//  Created by happyelements on 2018/7/30.
//  Copyright © 2018 Codi. All rights reserved.
//

#import <Foundation/Foundation.h>
#import <UIKit/UIKit.h>
#import "WindMillEnum.h"

@class WindMillAdRequest;
@class WindMillSplashAd;
@class WindMillAdInfo;
@class WindMillAdFilter;

NS_ASSUME_NONNULL_BEGIN

@protocol WindMillSplashAdDelegate <NSObject>

@optional

/// 广告加载成功回调
/// - Parameter splashAd: WindMillSplashAd 实例对象
- (void)onSplashAdDidLoad:(WindMillSplashAd *)splashAd;

/// 广告加载失败回调
/// - Parameters:
///   - splashAd: WindMillSplashAd 实例对象
///   - error: 具体错误信息
-(void)onSplashAdLoadFail:(WindMillSplashAd *)splashAd error:(NSError *_Nullable)error;

/// 广告即将曝光回调
/// - Parameter splashAd: WindMillSplashAd 实例对象
-(void)onSplashAdWillPresentScreen:(WindMillSplashAd *)splashAd;

/// 广告曝光回调
/// - Parameter splashAd: WindMillSplashAd 实例对象
-(void)onSplashAdSuccessPresentScreen:(WindMillSplashAd *)splashAd;

/// 广告展示失败回调
/// - Parameters:
///   - splashAd: WindMillSplashAd 实例对象
///   - error: 具体错误信息
-(void)onSplashAdFailToPresent:(WindMillSplashAd *)splashAd withError:(NSError *_Nullable)error;

/// 广告点击回调
/// - Parameter splashAd: WindMillSplashAd 实例对象
- (void)onSplashAdClicked:(WindMillSplashAd *)splashAd;

/// 广告跳过回调
/// - Parameter splashAd: WindMillSplashAd 实例对象
- (void)onSplashAdSkiped:(WindMillSplashAd *)splashAd;

/// 广告即将关闭回调
/// - Parameter splashAd: WindMillSplashAd 实例对象
- (void)onSplashAdWillClosed:(WindMillSplashAd *)splashAd;

/// 广告关闭回调
/// - Parameter splashAd: WindMillSplashAd 实例对象
- (void)onSplashAdClosed:(WindMillSplashAd *)splashAd;

/// This method is called when splash viewControllr is closed.
/// @Note :  当加载聚合维度广告时，支持该回调的adn有：CSJ
- (void)onSplashAdViewControllerDidClose:(WindMillSplashAd *)splashAd;

/// 广告小窗口点击回调
/// - Parameter splashAd: WindMillSplashAd 实例对象
- (void)onSplashZoomOutViewAdDidClick:(WindMillSplashAd *)splashAd;

/// 广告小窗口关闭回调
/// - Parameter splashAd: WindMillSplashAd 实例对象
- (void)onSplashZoomOutViewAdDidClose:(WindMillSplashAd *)splashAd;

/** 目前仅支持gromore csj gdt
 *  广告即将展示广告详情页回调
 */
- (void)onSplashAdWillPresentFullScreenModal:(WindMillSplashAd *)splashAd;

/** 目前仅支持gromore csj 京媒
 This method is called when another controller has been closed.
 @param interactionType : open appstore in app or open the webpage or view video ad details page.
 @Note :  Mediation dimension does not support this callBack.
 */
- (void)onSplashAdDidCloseOtherControllerWithInteractionType:(WindMillInteractionType)interactionType;

/// 广告播放中加载成功回调
/// - Parameter splashAd: WindMillSplashAd 实例对象
- (void)onSplashAdAdDidAutoLoad:(WindMillSplashAd *)splashAd;

/// 广告播放中加载失败回调
/// - Parameters:
///   - splashAd: WindMillSplashAd 实例对象
///   - error: 具体错误信息
- (void)onSplashAd:(WindMillSplashAd *)splashAd didAutoLoadFailWithError:(NSError *_Nullable)error;


/// 竞价广告源开始竞价回调
/// - Parameter splashAd: WindMillSplashAd 实例对象
///   - splashAd: 开屏信息
///   - adInfo: 广告的相关信息
- (void)splashAd:(WindMillSplashAd *)splashAd didStartBidADSource:(WindMillAdInfo *)adInfo;

/// 竞价广告源竞价成功回调
/// - Parameter splashAd: WindMillSplashAd 实例对象
///   - splashAd: 开屏信息
///   - adInfo: 广告的相关信息
- (void)splashAd:(WindMillSplashAd *)splashAd didFinishBidADSource:(WindMillAdInfo *)adInfo;

/// 竞价广告源竞价失败回调，以及失败原因
/// - Parameters:
///   - splashAd: WindMillSplashAd 实例对象
///   - adInfo: 具体错误信息
- (void)splashAd:(WindMillSplashAd *)splashAd didFailBidADSource:(WindMillAdInfo *)adInfo error:(NSError *_Nullable)error;

/// 广告源开始加载回调
/// - Parameter splashAd: WindMillSplashAd 实例对象
///   - splashAd: 开屏信息
///   - adInfo: 广告的相关信息
- (void)splashAd:(WindMillSplashAd *)splashAd didStartLoadingADSource:(WindMillAdInfo *)adInfo;

/// 广告源广告填充回调
/// - Parameter splashAd: WindMillSplashAd 实例对象
///   - splashAd: 开屏信息
///   - adInfo: 广告的相关信息
- (void)splashAd:(WindMillSplashAd *)splashAd didFinishLoadingADSource:(WindMillAdInfo *)adInfo;

/// 广告源加载失败回调，以及失败原因
/// - Parameters:
///   - splashAd: WindMillSplashAd 实例对象
///   - error: 具体错误信息
- (void)splashAd:(WindMillSplashAd *)splashAd didFailToLoadADSource:(WindMillAdInfo *)adInfo error:(NSError *_Nullable)error;


@end

@interface WindMillSplashAd : NSObject

/// 广告代理对象
@property (nonatomic, weak, nullable) id<WindMillSplashAdDelegate> delegate;

/// 广告位ID
@property (nonatomic,strong, readonly, nonnull) NSString *placementId;

/// 视图控制器
@property (nonatomic, weak) UIViewController *rootViewController;

/// 在广告展示后，描述当前播放广告源信息
@property (nonatomic, strong, readonly, nullable) WindMillAdInfo *adInfo;

/// 自定义分组规则支持单次广告load维度设置
- (void)setLoadCustomGroup:(NSDictionary<NSString *, NSString *> *)customGroupRules;

/// 填充后可调用, 返回广告缓存池内所有信息
- (nullable NSArray<WindMillAdInfo *> *)getCacheAdInfoList;


/// 初始化splash ad对象，当请求和播放分开处理时，使用改构造函数
/// @param request 广告请求对象
/// @param extra 各个平台需要的扩展参数
///     1、kWindMillSplashExtraBottomView: 如果需要品牌区，需要通过改参数设置，类型：UIView
///     2、kWindMillSplashExtraBottomViewSize：bottomViewSize
///     3、kWindMillSplashExtraAdSize: 如果需要品牌区，需要通过改参数设置，类型NSString,字符串格式为NSStringFromCGSize
- (instancetype)initWithRequest:(WindMillAdRequest *)request
                              extra:(NSDictionary * _Nullable)extra;


/**
 * 返回广告是否可展示
 * 对于并行请求，在调用showAdInWindow前时需判断下
 * @return 当广告已经加载完成且未曝光时，为YES，否则为NO
 */
- (BOOL)isAdReady;

/**
 *  广告发起请求并自动展示在Window中
 *  详解：[可选]发起拉取广告请求,并将获取的广告以全屏形式展示在传入的Window参数中
 */
-(void)loadAdAndShow;

/**
 *  广告发起请求并展示在Window中, 同时在屏幕底部设置应用自身的Logo页面或是自定义View
 *  详解：[可选]发起拉取广告请求,并将获取的广告以半屏形式展示在传入的Window的上半部，剩余部分展示传入的bottomView
 *       请注意bottomView需设置好宽高，所占的空间不能过大，并保证广告界面的高度大于360
 *  @param bottomView 自定义底部View，可以在此View中设置应用Logo
 *
 */
-(void)loadAdAndShowWithBottomView:(UIView * _Nullable)bottomView;

/**
 *  广告发起请求并展示在Window中, 同时在屏幕底部设置应用自身的Logo页面
 *  详解：[logo会自动读取应用图标]
 *
 @param title 设置标题
 @param description 设置描述信息
 */
- (void)loadADAndShowWithTitle:(NSString *)title description:(NSString *)description;


/**
 *  发起拉取广告请求，只拉取不展示
 *  详解：广告素材及广告图片拉取成功后会回调onSplashAdDidLoad方法，当拉取失败时会回调onSplashAdLoadFail方法
 */
- (void)loadAd;

/**
 *  拉取瀑布流的接口，开发者可以根据自己的需求，在适当的时机拉取开屏瀑布流，后续请求开屏广告时可以直接使用已缓存瀑布流
 */
- (void)loadWaterfall;

/**
 *  展示广告，调用此方法前需调用isAdValid方法判断广告素材是否有效
 *  详解：广告展示成功时会回调onSplashAdSuccessPresentScreen方法，展示失败时会回调onSplashAdFailToPresent方法
 */
- (void)showAdInWindow:(UIWindow *)window withBottomView:(UIView * _Nullable)bottomView;

/**
 *  广告发起请求并展示在Window中, 同时在屏幕底部设置应用自身的Logo页面
 *  详解：[logo会自动读取应用图标]，请中高度位100，宽度为屏幕宽度
 *
 @param window 容器
 @param title 设置标题
 @param desc 设置描述信息
 */
- (void)showAdInWindow:(UIWindow *)window title:(NSString *)title desc:(NSString *)desc;

// 广告对象级广告源过滤器
- (void)addFilter:(WindMillAdFilter *)filter;

// 移除广告源过滤器 
- (void)removeFilter;

@end

NS_ASSUME_NONNULL_END