cdts/xdts-ios 3/Pods/GYSDK/GeYanSdk.framework/Headers/GyAuthViewModel.h

//
//  GyAuthViewModel.h
//  GySdkLib
//
//  Created by lzy on 2019/7/19.
//  Copyright © 2019 getui. All rights reserved.
//

#import <UIKit/UIKit.h>
#import "GyAuthPrivacyItem.h"

NS_ASSUME_NONNULL_BEGIN

/**
 * @abstract 授权登录页面自定义视图，customAreaView为授权页面的view，如，可将三方登录添加到授权登录页面
 */
typedef void(^OLCustomUIHandler)(UIView *customAreaView);

/**
 * @abstract 1、若授权页面只支持竖屏，只设置竖屏方向偏移；
             2、若授权页面只支持横屏，只设置横屏方向偏移；
             3、若授权页面支持旋转自动切换横竖屏，则同时设置竖屏方向和横屏方向偏移
             4、弹窗模式，同以上1、2、3
             5、size默认都可以不用设置，会根据字体大小自适应
             6、x轴方向偏移量有两个值可以设置，portraitCenterXOffset为控件的x轴中点到弹窗x轴中点的距离，portraitLeftXOffset为控件的左边缘到屏幕左边缘的距离，两者选其一即可
 */
typedef struct OLRect {
    /**
     竖屏时
     导航栏隐藏时，为控件顶部到状态栏的距离；导航栏显示时，为控件顶部到导航栏底部的距离
     弹窗时
     为控件顶部到弹窗顶部的距离
     */
    CGFloat portraitTopYOffset;

    /**
     竖屏时
     控件的x轴中点到屏幕x轴中点的距离，默认为0
     弹窗时
     控件的x轴中点到弹窗x轴中点的距离，默认为0
     */
    CGFloat portraitCenterXOffset;

    /**
     竖屏时
     控件的左边缘到屏幕左边缘的距离，默认为0
     弹窗时
     控件的左边缘到屏幕左边缘的距离，默认为0

     portraitLeftXOffset与portraitCenterXOffset设置一个即可，portraitLeftXOffset优先级大于portraitCenterXOffset，
     设置此属性时，portraitCenterXOffset属性失效
     */
    CGFloat portraitLeftXOffset;

    /**
     横屏时
     导航栏隐藏时，为控件顶部到屏幕顶部的距离；导航栏显示时，为控件顶部到导航栏底部的距离
     弹窗时
     为控件顶部到弹窗顶部的距离
     */
    CGFloat landscapeTopYOffset;

    /**
     横屏时
     控件的x轴中点到屏幕x轴中点的距离，默认为0
     弹窗时
     控件的x轴中点到弹窗x轴中点的距离，默认为0
     */
    CGFloat landscapeCenterXOffset;

    /**
     横屏时
     控件的左边缘到屏幕左边缘的距离，默认为0
     弹窗时
     控件的左边缘到屏幕左边缘的距离，默认为0

     landscapeLeftXOffset与landscapeCenterXOffset设置一个即可，landscapeLeftXOffset优先级大于landscapeCenterXOffset，
     设置此属性时，landscapeCenterXOffset属性失效
     */
    CGFloat landscapeLeftXOffset;

    /**
     控件大小，只有宽度、高度同时大于0，设置的size才会生效，否则为控件默认的size
     */
    CGSize size;
} OLRect;

/**
 * @abstract 弹窗模式时支持的动画类型
 */
typedef NS_ENUM(NSInteger, OLAuthPopupAnimationStyle) {
    OLAuthPopupAnimationStyleCoverVertical = 0,
    OLAuthPopupAnimationStyleFlipHorizontal,
    OLAuthPopupAnimationStyleCrossDissolve,
    OLAuthPopupAnimationStyleCustom
};

/**
 * 授权页自定义Loading，会在点击登录按钮之后触发
 * containerView为loading的全屏蒙版view
 * 请自行在containerView添加自定义loading
 * 设置block后，默认loading将无效
 */
typedef void(^OLLoadingViewBlock)(UIView *containerView);

/**
 * 停止授权页自定义Loading，会在调用[GeyanSDK stopLoading]时触发
 * containerView为loading的全屏蒙版view
 */
typedef void(^OLStopLoadingViewBlock)(UIView *containerView);

/**
 * 授权页面视图生命周期回调
 * @param viewLifeCycle 值为viewDidLoad、viewWillAppear、viewWillDisappear、viewDidAppear、viewDidDisappear
 * @param animated 是否有动画
 */
typedef void(^OLAuthViewLifeCycleBlock)(NSString *viewLifeCycle, BOOL animated);

/**
 * 点击授权页面授权按钮的回调
 */
typedef void(^OLClickAuthButtonBlock)(void);

/**
 * 未勾选状态时点击登录按钮的回调
 */
typedef BOOL(^OLProtocolHintBlock)(void);

/**
 * 点击授权页面隐私协议前勾选框的回调
 */
typedef void(^OLClickCheckboxBlock)(BOOL isChecked);

/**
 * 点击授权页面弹窗背景的回调
 */
typedef void(^OLTapAuthBackgroundBlock)(void);

/**
 * @abstract 授权页面旋转时的回调，可在该回调中修改自定义视图的frame，以适应新的布局
 */
typedef void(^OLAuthVCTransitionBlock)(CGSize size, id <UIViewControllerTransitionCoordinator> coordinator, UIView *customAreaView);


/**
 * @abstract 进入授权页面的方式，默认为 modal 方式，即 present 到授权页面，从授权页面进入服务条款页面的方式与此保持一致
 */
typedef NS_ENUM(NSInteger, OLPullAuthVCStyle) {
    OLPullAuthVCStyleModal,
    OLPullAuthVCStylePush
};


@interface GyAuthViewModel : NSObject

#pragma mark - Status Bar/状态栏

/**
 状态栏样式。 默认 `UIStatusBarStyleDefault`。
 */
@property(nonatomic, assign) UIStatusBarStyle statusBarStyle;

#pragma mark - Navigation/导航

/**
 授权页导航的标题。默认为空字符串。
 */
@property(nullable, nonatomic, strong) NSAttributedString *naviTitle;

/**
 授权页导航的背景颜色。默认白色。
 */
@property(nullable, nonatomic, strong) UIColor *naviBgColor;

/**
 授权页导航左边的返回按钮的图片。默认黑色系统样式返回图片。
 */
@property(nullable, nonatomic, strong) UIImage *naviBackImage;

/**
 授权页导航右边的自定义控件。
 */
@property(nullable, nonatomic, strong) UIView *naviRightControl;

/**
 导航栏隐藏。默认不隐藏。
 */
@property(nonatomic, assign) BOOL naviHidden;

/**
 返回按钮位置及大小，返回按钮最大size为CGSizeMake(40, 40)。
 */
@property(nonatomic, assign) OLRect backButtonRect;

/**
 返回按钮隐藏。默认不隐藏。
 */
@property(nonatomic, assign) BOOL backButtonHidden;

#pragma mark - Logo/图标

/**
 授权页面上展示的图标。默认为 "applogo" 图标。
 */
@property(nullable, nonatomic, strong) UIImage *appLogo;

/**
 Logo 位置及大小。
 */
@property(nonatomic, assign) OLRect logoRect;

/**
 Logo 图片隐藏。默认不隐藏。
 */
@property(nonatomic, assign) BOOL logoHidden;

/**
 logo圆角，默认为0。
 */
@property(nonatomic, assign) CGFloat logoCornerRadius;

#pragma mark - Phone Number Preview/手机号预览

/**
 * 号码预览文字的颜色。默认黑色。
 */
@property(nullable, nonatomic, strong) UIColor *phoneNumColor;

/**
 * 号码预览文字的字体。默认粗体，24pt。
 */
@property(nullable, nonatomic, strong) UIFont *phoneNumFont;

/**
 * 号码预览 位置及大小，电话号码不支持设置大小，大小根据电话号码文字自适应
 */
@property(nonatomic, assign) OLRect phoneNumRect;

#pragma mark - Switch Button/切换按钮

/**
 * 授权页切换账号按钮的文案。默认为“切换账号”。
 */
@property(nullable, nonatomic, copy) NSString *switchButtonText;

/**
 * 授权页切换账号按钮的颜色。默认蓝色。
 */
@property(nullable, nonatomic, strong) UIColor *switchButtonColor;

/**
 * 授权页切换账号按钮背景颜色。默认为 nil。
 */
@property(nullable, nonatomic, strong) UIColor *switchButtonBackgroundColor;

/**
 * 授权页切换账号的字体。默认字体，15pt。
 */
@property(nullable, nonatomic, strong) UIFont *switchButtonFont;

/**
 * 授权页切换账号按钮 位置及大小。
 */
@property(nonatomic, assign) OLRect switchButtonRect;

/**
 * 隐藏切换账号按钮。默认不隐藏。
 */
@property(nonatomic, assign) BOOL switchButtonHidden;

#pragma mark - Authorization Button/认证按钮

/**
 * 授权页认证按钮的背景图片, @[正常状态的背景图片, 不可用状态的背景图片, 高亮状态的背景图片]。默认正常状态为蓝色纯色, 不可用状态的背景图片时为灰色, 高亮状态为灰蓝色。
 */
@property(nullable, nonatomic, strong) NSArray<UIImage *> *authButtonImages;

/**
 * 授权按钮文案。默认白色的"一键登录"。
 */
@property(nullable, nonatomic, strong) NSAttributedString *authButtonTitle;

/**
 * 授权按钮 位置及大小。
 */
@property(nonatomic, assign) OLRect authButtonRect;

/**
 * 授权按钮圆角，默认为5。
 */
@property(nonatomic, assign) CGFloat authButtonCornerRadius;

/**
 * 点击授权页面授权按钮的回调
 */
@property(nullable, nonatomic, copy) OLClickAuthButtonBlock clickAuthButtonBlock;

#pragma mark - Slogan/口号标语

/**
 * Slogan 位置及大小。
 */
@property(nonatomic, assign) OLRect sloganRect;

/**
 * Slogan 文字颜色。默认灰色。
 */
@property(nonatomic, strong) UIColor *sloganTextColor;

/**
 * Slogan字体。默认字体, 12pt。
 */
@property(nonatomic, strong) UIFont *sloganTextFont;

#pragma mark - CheckBox & Privacy Terms/隐私条款勾选框及隐私条款

/**
 * 授权页面上条款勾选框初始状态。默认 YES。
 */
@property(nonatomic, assign) BOOL defaultCheckBoxState;

/**
 * 授权页面上勾选框勾选的图标。默认为蓝色图标。推荐尺寸为12x12。
 */
@property(nullable, nonatomic, strong) UIImage *checkedImage;

/**
 * 授权页面上勾选框未勾选的图标。默认为白色图标。推荐尺寸为12x12。
 */
@property(nullable, nonatomic, strong) UIImage *uncheckedImage;

/**
 * 授权页面上条款勾选框大小。
 */
@property(nonatomic, assign) CGSize checkBoxSize;

/**
 * 隐私条款文字属性。默认条款蓝色高亮, 12pt。
 */
@property(nullable, nonatomic, strong) NSDictionary<NSAttributedStringKey, id> *privacyTermsAttributes;

/**
 * 额外的条款。默认为空。其中默认的隐私条款index为0.
 */
@property(nullable, nonatomic, strong) NSArray<GyAuthPrivacyItem *> *additionalPrivacyTerms;

/**
 * 服务条款普通文字的颜色。默认灰色。
 */
@property(nullable, nonatomic, strong) UIColor *termTextColor;

/**
 * 隐私条款 位置及大小，隐私条款，宽需大于50，高需大于20，才会生效。
 */
@property(nonatomic, assign) OLRect termsRect;

/**
 * 除隐私条款外的其他文案，数组大小必须为4，元素依次为：条款前的文案、条款一和条款二连接符、条款二和条款三连接符，条款后的文案。
 * 默认为@[@"登录即同意", @"和", @"、", @"并使用本机号码登录"]
 */
@property(nullable, nonatomic, copy) NSArray<NSString *> *auxiliaryPrivacyWords;

/**
 * 点击授权页面隐私协议前勾选框的回调
 */
@property(nullable, nonatomic, copy) OLClickCheckboxBlock clickCheckboxBlock;

/**
* 服务条款文案对齐方式，默认为NSTextAlignmentLeft
*/
@property(nonatomic, assign) NSTextAlignment termsAlignment;

/**
 * 点击授权页面隐私协议的回调，设置后所有的点击回调都默认走这里
 * 如果PrivacyItem设置了回调将不会走这里
 */
@property(nullable, nonatomic, copy) OLPrivacyTermItemBlock carrierTermItemBlock;

/**
 * 是否在运营商协议名称上加书名号《》
 * 默认NO
 */
@property(nonatomic, assign) BOOL hasQuotationMarkOnCarrierProtocol;

/**
 * 隐私协议的点击响应属性
 * 默认值：@{
 *            NSUnderlineStyleAttributeName: @NO,
 *            NSForegroundColorAttributeName: UIColor.redColor
 *       }
 */
@property(nonatomic, nullable, copy) NSDictionary *activeLinkAttributes;

/**
 * 授权页面上勾选框 未勾选状态时点击登录按钮是否显示 提示弹窗
 * 默认 YES
 */
@property(nonatomic, assign) BOOL showNotCheckProtocolHint;

/*
 * 授权页面上勾选框 未勾选状态时点击登录按钮的提示弹窗  y轴偏移量
 * 默认 0
 */
@property(nonatomic, assign) CGFloat protocolHintOffsetY;

/**
 * 未勾选状态时点击登录按钮的回调
 * 返回YES，提示sdk内置toast
 * 返回NO，用户自定义toast
 */
@property(nullable, nonatomic, copy) OLProtocolHintBlock protocolHintBlock;

#pragma mark - Custom Area/自定义区域

/**
 * 自定义区域视图的处理block
 * @discussion
 * 提供的视图容器使用NSLayoutConstraint与相关的视图进行布局约束。
 * 如果导航栏没有隐藏, 顶部与导航栏底部对齐, 左边与屏幕左边对齐, 右边与屏幕右边对齐, 底部与屏幕底部对齐。
 * 如果导航栏隐藏, 顶部与状态栏底部对齐, 左边与屏幕左边对齐, 右边与屏幕右边对齐, 底部与屏幕底部对齐。
 */
@property(nullable, nonatomic, copy) OLCustomUIHandler customUIHandler;

/**
 * 授权页面旋转时的回调，可在该回调中修改自定义视图的frame，以适应新的布局
 */
@property(nullable, nonatomic, copy) OLAuthVCTransitionBlock authVCTransitionBlock;

#pragma mark - Background Image/授权页面背景图片

/**
 * 授权页背景颜色。默认白色。
 */
@property(nullable, nonatomic, strong) UIColor *backgroundColor;

/**
 * 授权页面背景图片
 */
@property(nullable, nonatomic, strong) UIImage *backgroundImage;


/**
 * 横屏模式授权页面背景图片
 */
@property(nullable, nonatomic, strong) UIImage *landscapeBackgroundImage;

/**
 * 授权页面背景gif.
 */
@property(nullable, nonatomic, strong) NSString *backgroundGifPath;

/**
 * 授权页面背景video.
 */
@property(nullable, nonatomic, strong) NSString *backgroundVideoPath;

/**
 * 是否允许背景GIF 或者 video 循环播放
 * 默认循环播放 YES
 */
@property (nonatomic, assign) BOOL allowGifOrVideoPlayRepeat;

#pragma mark - orientationMask

/**
 * 授权页面支持的横竖屏方向
 */
@property(nonatomic, assign) UIInterfaceOrientationMask supportedInterfaceOrientations;


#pragma mark - Popup

/**
 * 是否为弹窗模式
 */
@property(nonatomic, assign) BOOL isPopup;

/**
 弹窗 位置及大小。弹窗模式时，x轴偏移只支持portraitLeftXOffset和landscapeLeftXOffset。
 */
@property(nonatomic, assign) OLRect popupRect;

/**
 弹窗圆角，默认为6。
 */
@property(nonatomic, assign) CGFloat popupCornerRadius;

/**
 当只需要设置弹窗的部分圆角时，通过popupCornerRadius设置圆角大小，通过popupRectCorners设置需要设置圆角的位置。
 popupRectCorners数组元素不超过四个，超过四个时，只取前四个。比如，要设置左上和右上为圆角，则传值：@[@(UIRectCornerTopLeft), @(UIRectCornerTopRight)]
 */
@property(nonatomic, strong) NSArray<NSNumber *> *popupRectCorners;

/**
 * 弹窗动画类型，当popupAnimationStyle为OLAuthPopupAnimationStyleStyleCustom时，动画为用户自定义，用户需要传一个CATransition对象来设置动画
 */
@property(nonatomic, assign) OLAuthPopupAnimationStyle popupAnimationStyle;

/**
 * 弹窗自定义动画
 */
@property(nonatomic, strong, nullable) CAAnimation *popupTransitionAnimation;

/**
 弹窗关闭按钮图片，弹窗关闭按钮的尺寸跟图片尺寸保持一致。
 弹窗关闭按钮位于弹窗右上角，目前只支持设置其距顶部偏移和距右边偏移。
 */
@property(nullable, nonatomic, strong) UIImage *closePopupImage;

/**
 弹窗关闭按钮距弹窗顶部偏移。
 */
@property(nonatomic, strong) NSNumber *closePopupTopOffset;

/**
 弹窗关闭按钮距弹窗右边偏移。
 */
@property(nonatomic, strong) NSNumber *closePopupRightOffset;

/**
 弹窗关闭按钮大小。默认11x22
 */
@property(nonatomic, assign) CGSize closePopupSize;

/**
是否需要通过点击弹窗的背景区域以关闭授权页面。
*/
@property(nonatomic, assign) BOOL canClosePopupFromTapGesture;

/**
* 点击授权页面弹窗背景的回调
*/
@property(nonatomic, copy, nullable) OLTapAuthBackgroundBlock tapAuthBackgroundBlock;

/**
 * 弹窗页遮罩背景
 * 默认半透明遮罩
 */
@property(nonatomic, strong, nullable) UIView *popupMaskView;

#pragma mark - Loading

/**
 * 授权页面，自定义加载进度条，点击登录按钮之后的回调
 */
@property(nonatomic, copy, nullable) OLLoadingViewBlock loadingViewBlock;

/**
 * 授权页面，停止自定义加载进度条，调用[GetanSDK stopLoading]之后的回调
 */
@property(nonatomic, copy, nullable) OLStopLoadingViewBlock stopLoadingViewBlock;

#pragma mark - WebViewController Navigation/服务条款页面导航栏

/**
 * 隐私页面返回按钮隐藏。默认不隐藏。
 */
@property(nonatomic, assign) BOOL webBackBtnHidden;
/**
 * 隐私页面返回按钮。默认黑色系统样式返回图片。
 */
@property(nonatomic, strong) UIImage *webBackBtnImg;

/**
 返回按钮位置及大小，返回按钮最大size为CGSizeMake(40, 40)。
 */
@property(nonatomic, assign) OLRect webBackBtnRect;

/**
 服务条款页面导航栏隐藏。默认不隐藏。
 */
@property(nonatomic, assign) BOOL webNaviHidden;

/**
 服务条款页面导航的标题。默认为"服务条款"，粗体、17pt。
 */
@property(nullable, nonatomic, strong) NSAttributedString *webNaviTitle;

/**
 服务条款页面导航的背景颜色。默认白色。
 */
@property(nullable, nonatomic, strong) UIColor *webNaviBgColor;

#pragma mark - Hint

/**
 未勾选服务条款复选框时，点击登录按钮的提示。默认为"请同意服务条款"。
 */
@property(nullable, nonatomic, copy) NSString *notCheckProtocolHint;

#pragma mark - OLAuthViewLifeCycleBlock

/**
 授权页面视图生命周期回调。
 */
@property(nullable, nonatomic, copy) OLAuthViewLifeCycleBlock viewLifeCycleBlock;

#pragma mark - UIModalPresentationStyle

/**
 present授权页面时的样式，默认为UIModalPresentationFullScreen
 */
@property(nonatomic, assign) UIModalPresentationStyle modalPresentationStyle;

/**
 * present授权页面时的自定义动画
 */
@property(nonatomic, strong, nullable) CAAnimation *modalPresentationAnimation;

/**
 * dismiss授权页面时的自定义动画
 */
@property(nonatomic, strong, nullable) CAAnimation *modalDismissAnimation;

#pragma mark - OLPullAuthVCStyle

/**
 * @abstract 进入授权页面的方式，默认为 modal 方式，即 present 到授权页面，从授权页面进入服务条款页面的方式与此保持一致
 */
@property(nonatomic, assign) OLPullAuthVCStyle pullAuthVCStyle;


/**
 * presentViewController 或者 pushViewController 授权页时， 是否设置动画animated。 默认YES
 */
@property(nonatomic, assign) BOOL pullAnimate;

#pragma mark - UIUserInterfaceStyle

/**
 * @abstract 授权页面 UIUserInterfaceStyle，默认为 UIUserInterfaceStyleLight，即 @(UIUserInterfaceStyleLight)
 *
 * UIUserInterfaceStyle
 * UIUserInterfaceStyleUnspecified - 不指定样式，跟随系统设置进行展示
 * UIUserInterfaceStyleLight       - 明亮
 * UIUserInterfaceStyleDark        - 暗黑 仅对 iOS 13+ 系统有效
 */
@property(nonatomic, strong) NSNumber *userInterfaceStyle;

@end

NS_ASSUME_NONNULL_END