// // JVERIFICATIONService.h // JVerification // // Created by andy on 2018/9/11. // Copyright © 2018年 hxhg. All rights reserved. // #import #import #define JVER_VERSION_NUMBER 2.7.3 /** JVLayoutConstraint 布局参照item - JVLayoutItemNone: 不参照任何item。可用来直接设置width、height - JVLayoutItemLogo: 参照logo视图 - JVLayoutItemNumber: 参照号码栏 - JVLayoutItemSlogan: 参照标语栏 - JVLayoutItemLogin: 参照登录按钮 - JVLayoutItemCheck: 参照隐私选择框 - JVLayoutItemPrivacy: 参照隐私栏 - JVLayoutItemSuper: 参照父视图 */ typedef NS_ENUM(NSUInteger, JVLayoutItem) { JVLayoutItemNone = 1, JVLayoutItemLogo, JVLayoutItemNumber, JVLayoutItemSlogan, JVLayoutItemLogin, JVLayoutItemCheck, JVLayoutItemPrivacy, JVLayoutItemSuper }; /** 设置隐私Label的垂直对齐方式 */ typedef NS_ENUM(NSInteger,JVVerAlignment){ JVVerAlignmentTop = 0,//default JVVerAlignmentMiddle, JVVerAlignmentBottom }; @interface JVLayoutConstraint : NSObject /** 授权页布局类，使用Autolayout处理。用法参考系统类NSLayoutConstraint 以及示例demo。 */ @property (nonatomic, assign) NSLayoutAttribute firstAttribute; @property (nonatomic, assign) NSLayoutAttribute secondAttribute; @property (nonatomic, assign) NSLayoutRelation relation; @property (nonatomic, assign) JVLayoutItem item; @property (nonatomic, assign) CGFloat multiplier; @property (nonatomic, assign) CGFloat constant; /** 相对父视图的布局约束 @param attr1 约束类型 @param relation 与参照视图之间的约束关系 @param item 参照item @param attr2 参照item约束类型 @param multiplier 乘数 @param c 常量 @return JVLayoutConstraint布局对象 */ +(instancetype _Nullable )constraintWithAttribute:(NSLayoutAttribute)attr1 relatedBy:(NSLayoutRelation)relation toItem:(JVLayoutItem)item attribute:(NSLayoutAttribute)attr2 multiplier:(CGFloat)multiplier constant:(CGFloat)c; @end @interface JVUIConfig : NSObject /** 授权页面的各个控件的Y轴默认值都是以375*667屏幕为基准 系数 ： 当前屏幕高度/667 1、当设置Y轴并有效时 偏移量OffsetY属于相对导航栏的绝对Y值 2、（负数且超出当前屏幕无效）为保证各个屏幕适配,请自行设置好Y轴在屏幕上的比例（推荐:当前屏幕高度/667） */ /*----------------------------------------授权页面-----------------------------------*/ //MARK:导航栏************* /**导航栏颜色*/ @property (nonatomic,strong) UIColor *navColor; /**授权页navigation bar style，已废弃。建议使用preferredStatusBarStyle控制状态栏。preferredStatusBarStyle默认为UIStatusBarStyleDefault,当barStyle的效果和preferredStatusBarStyle冲突时，barStyle的效果会失效。 */ @property (nonatomic,assign) UIBarStyle barStyle DEPRECATED_MSG_ATTRIBUTE("Please use preferredStatusBarStyle"); /**授权页 preferred status bar style，取代barStyle参数 */ @property (nonatomic,assign) UIStatusBarStyle preferredStatusBarStyle; /**协议页 preferred status bar style，取代barStyle参数 */ @property (nonatomic,assign) UIStatusBarStyle agreementPreferredStatusBarStyle; /**导航栏标题*/ @property (nonatomic,copy) NSAttributedString *navText; /**导航栏默认返回按钮隐藏，默认不隐藏*/ @property (nonatomic,assign) BOOL navReturnHidden; /**导航返回按钮图标*/ @property (nonatomic,strong) UIImage *navReturnImg; /*导航栏返回按钮图片缩进,默认为UIEdgeInsetsZero*/ @property (nonatomic,assign) UIEdgeInsets navReturnImageEdgeInsets; /**导航栏右侧自定义控件*/ @property (nonatomic,strong) UIBarButtonItem *navControl; /**是否隐藏导航栏（适配全屏图片）*/ @property (nonatomic,assign) BOOL navCustom; /**导航栏是否透明，默认不透明。此参数和navBarBackGroundImage冲突，应避免同时使用*/ @property (nonatomic,assign) BOOL navTransparent; /**导航栏背景图片.此参数和navTransparent冲突，应避免同时使用*/ @property (nonatomic,strong) UIImage *navBarBackGroundImage; /**导航栏分割线是否隐藏，默认隐藏*/ @property (nonatomic,assign) BOOL navDividingLineHidden; /**竖屏情况下，是否隐藏状态栏。默认NO 在项目的Info.plist文件里设置UIViewControllerBasedStatusBarAppearance为YES 注意：弹窗模式下无效，是否隐藏由外部控制器控制*/ @property (nonatomic,assign) BOOL prefersStatusBarHidden; //MARK:图片设置************ /**授权界面背景图片*/ @property (nonatomic,strong) UIImage *authPageBackgroundImage; /**授权界面背景gif资源路径，与authPageBackgroundImage属性不可生效*/ @property (nonatomic,copy) NSString *authPageGifImagePath; /**LOGO图片*/ @property (nonatomic,strong) UIImage *logoImg; /**LOGO图片宽度*/ @property (nonatomic,assign) CGFloat logoWidth DEPRECATED_MSG_ATTRIBUTE("Please use logoConstraints"); /**LOGO图片高度*/ @property (nonatomic,assign) CGFloat logoHeight DEPRECATED_MSG_ATTRIBUTE("Please use logoConstraints"); /**LOGO图片偏移量*/ @property (nonatomic,assign) CGFloat logoOffsetY DEPRECATED_MSG_ATTRIBUTE("Please use logoConstraints"); /*LOGO图片布局*/ @property (nonatomic, copy) NSArray * logoConstraints; /*LOGO图片 横屏布局，横屏时优先级高于logoConstraints*/ @property (nonatomic, copy) NSArray * logoHorizontalConstraints; /**LOGO图片隐藏*/ @property (nonatomic,assign) BOOL logoHidden; //MARK:登录按钮************ /**登录按钮文本*/ @property (nonatomic,strong) NSString *logBtnText; /**登录按钮字体，默认跟随系统*/ @property (nonatomic,strong) UIFont *logBtnFont; /**登录按钮Y偏移量*/ @property (nonatomic,assign) CGFloat logBtnOffsetY DEPRECATED_MSG_ATTRIBUTE("Please use logBtnConstraints"); /*登录按钮布局*/ @property (nonatomic, copy) NSArray * logBtnConstraints; /*登录按钮 横屏布局，横屏时优先级高于logBtnConstraints*/ @property (nonatomic, copy) NSArray * logBtnHorizontalConstraints; /**登录按钮文本颜色*/ @property (nonatomic,strong) UIColor *logBtnTextColor; /**登录按钮背景图片添加到数组(顺序如下) @[激活状态的图片,失效状态的图片,高亮状态的图片] 注意:当customPrivacyAlertViewBlock不为空，并且隐私栏为选中时，失效状态的图片设置无效 */ @property (nonatomic,copy) NSArray *logBtnImgs; //MARK:号码框设置************ /**手机号码字体颜色*/ @property (nonatomic,strong) UIColor *numberColor; /**手机号码字体大小*/ @property (nonatomic,assign) CGFloat numberSize; /*手机号码字体，优先级高于numberSize*/ @property (nonatomic,strong) UIFont *numberFont; /**号码栏Y偏移量*/ @property (nonatomic,assign) CGFloat numFieldOffsetY DEPRECATED_MSG_ATTRIBUTE("Please use numberConstraints"); /*号码栏布局 宽高自适应，不需要设置*/ @property (nonatomic, copy) NSArray * numberConstraints; /*号码栏 横屏布局,横屏时优先级高于numberConstraints*/ @property (nonatomic, copy) NSArray * numberHorizontalConstraints; //MARK:隐私条款************ /**复选框未选中时图片*/ @property (nonatomic,strong) UIImage *uncheckedImg; /**复选框选中时图片*/ @property (nonatomic,strong) UIImage *checkedImg; /*复选框是否隐藏，默认不隐藏*/ @property (nonatomic,assign) BOOL checkViewHidden; /*复选框布局*/ @property (nonatomic, copy) NSArray * checkViewConstraints; /*复选框 横屏布局，横屏优先级高于checkViewConstraints*/ @property (nonatomic, copy) NSArray * checkViewHorizontalConstraints; /**隐私条款一:数组（务必按顺序） @[条款名称,条款链接] 条款链接， 支持在线文件和NSBundle本地文件， 沙盒中文件仅支持 NSTemporaryDirectory() 路径下文件 */ @property (nonatomic,strong) NSArray *appPrivacyOne; /**隐私条款二:数组（务必按顺序） @[条款名称,条款链接] 条款链接， 支持在线文件和NSBundle本地文件， 沙盒中文件仅支持 NSTemporaryDirectory() 路径下文件 */ @property (nonatomic,strong) NSArray *appPrivacyTwo; /**隐私条款组合:数组 @[privacyComponents,条款名称,条款链接] 条款链接， 支持在线文件和NSBundle本地文件， 沙盒中文件仅支持 NSTemporaryDirectory() 路径下文件 */ @property (nonatomic,strong) NSArray * _Nullable appPrivacys; /**隐私条款名称颜色 @[基础文字颜色,条款颜色] */ @property (nonatomic,strong) NSArray *appPrivacyColor; /**隐私条款文本对齐方式，目前仅支持 left、center*/ @property (nonatomic,assign) NSTextAlignment privacyTextAlignment; /**隐私条款字体大小，默认12*/ @property (nonatomic,assign) CGFloat privacyTextFontSize; /**隐私条款是否显示书名号，默认不显示*/ @property (nonatomic,assign) BOOL privacyShowBookSymbol; /**隐私条款行距，默认跟随系统*/ @property (nonatomic,assign) CGFloat privacyLineSpacing; /**隐私条款Y偏移量(注:此属性为与屏幕底部的距离)*/ @property (nonatomic,assign) CGFloat privacyOffsetY DEPRECATED_MSG_ATTRIBUTE("Please use privacyConstraints"); /**隐私条款拼接文本数组，数组限制4个NSString对象，否则无效 默认文本1为：”登录即同意“，文本2:”和“，文本3：”、“，文本4：”并使用本机号码登录“ 设置后，隐私协议栏文本修改为 文本1 + 运营商默认协议名称 + 文本2 + 开发者协议名称1 + 文本3 + 开发者协议文本2 + 文本4 */ @property (nonatomic,strong) NSArray * privacyComponents; /*隐私条款布局*/ @property (nonatomic, copy) NSArray * privacyConstraints; /*隐私条款 横屏布局，横屏下优先级高于privacyConstraints*/ @property (nonatomic, copy) NSArray * privacyHorizontalConstraints; /**隐私条款check框默认状态 默认:NO */ @property (nonatomic,assign) BOOL privacyState; /*隐私条约Label的垂直对齐方式*/ @property (nonatomic,assign) JVVerAlignment textVerAlignment; /* 当自定义Alert view,当隐私条款未选中时,点击登录按钮时回调 当此参数存在时,未选中隐私条款的情况下，登录按钮可以被点击 block内部参数为自定义Alert view可被添加的控制器，详细用法可参见示例demo 注意：当此参数不为空并且隐私栏为选中的情况下，logBtnImgs失效状态图片设置无效 */ @property (nonatomic,copy) void(^customPrivacyAlertViewBlock)(UIViewController * vc); /// 为隐私文本添加富文本属性，该方法的设置隐私协议富文本属性的优先级最高 /// @param name NSAttributedStringKey /// @param value NSAttributedStringKey 对应的值 /// @param range 对应字符串范围 - (void)addPrivacyTextAttribute:(NSAttributedStringKey)name value: (id)value range:(NSRange)range; /// 设置一键登录页面背景视频 /// @param path 视频路径支持在线url或者本地视频路径 /// @param imageName 视频未准备好播放时的占位图片名称 - (void)setVideoBackgroudResource:(NSString*)path placeHolder:(NSString*)imageName; //MARK:slogan************ /**slogan偏移量Y*/ @property (nonatomic,assign) CGFloat sloganOffsetY DEPRECATED_MSG_ATTRIBUTE("Please use sloganConstraints"); /*slogan布局，宽高自适应不需要设置*/ @property (nonatomic, copy) NSArray * sloganConstraints; /*slogan 横屏布局,横屏下优先级高于sloganConstraints*/ @property (nonatomic, copy) NSArray * sloganHorizontalConstraints; /**slogan文字颜色*/ @property (nonatomic,strong) UIColor *sloganTextColor; /*slogan文字font,默认12*/ @property (nonatomic,strong) UIFont *sloganFont; /*默认loading布局*/ @property (nonatomic, copy) NSArray * loadingConstraints; /*默认loading 横屏布局，横屏下优先级高于loadingConstraints*/ @property (nonatomic, copy) NSArray * loadingHorizontalConstraints; /*自定义loading view,当授权页点击登录按钮时回调 当此参数存在时,默认loading view不会显示,需开发者自行设计loading view block内部参数为自定义loading view可被添加的父视图，详细用法可参见示例demo */ @property (nonatomic,copy) void(^customLoadingViewBlock)(UIView * View); /*弹窗样式设置*/ /*是否弹窗，默认no*/ @property (nonatomic, assign) BOOL showWindow; /*弹框内部背景图片*/ @property (nonatomic, strong) UIImage *windowBackgroundImage; /*弹窗外侧 透明度 0~1.0*/ @property (nonatomic, assign) CGFloat windowBackgroundAlpha; /*弹窗圆角数值*/ @property (nonatomic, assign) CGFloat windowCornerRadius; /*弹窗布局*/ @property (nonatomic, copy) NSArray * windowConstraints; /*弹窗横屏布局，横屏下优先级高于windowConstraints*/ @property (nonatomic, copy) NSArray * windowHorizontalConstraints; /*弹窗close按钮图片 @[普通状态图片，高亮状态图片]*/ @property (nonatomic, copy) NSArray *windowCloseBtnImgs; /*弹窗close按钮布局*/ @property (nonatomic, copy) NSArray * windowCloseBtnConstraints; /*弹窗close按钮 横屏布局,横屏下优先级高于windowCloseBtnConstraints */ @property (nonatomic, copy) NSArray * windowCloseBtnHorizontalConstraints; /*是否使用autoLayout，默认NO。使用JVLayoutConstraint对象布局，需要改成YES*/ @property (nonatomic, assign) BOOL autoLayout; /*是否支持自动旋转 默认YES。 注意: 当授权页为弹框样式时,参数无效，是否旋转由当前视图控制器控制 */ @property (nonatomic,assign) BOOL shouldAutorotate; /*设置进入授权页的屏幕方向。不支持UIInterfaceOrientationPortraitUpsideDown 注意:当授权页为弹框样式时,参数无效，屏幕方向由当前视图控制器控制 */ @property (nonatomic, assign) UIInterfaceOrientation orientation; /**协议页导航栏背景颜色*/ @property (nonatomic, strong) UIColor *agreementNavBackgroundColor; /*授权页点击运营商默认协议，进入协议页时, 协议页自定义导航栏标题*/ @property (nonatomic, strong) NSAttributedString *agreementNavText; /*授权页点击自定义协议1，进入协议页时, 协议页自定义导航栏标题*/ @property (nonatomic, strong) NSAttributedString *firstPrivacyAgreementNavText; /*授权页点击自定义协议2，进入协议页时, 协议页自定义导航栏标题*/ @property (nonatomic, strong) NSAttributedString *secondPrivacyAgreementNavText; /*设置授权页点击隐私协议，进入协议页时, 协议页自定义导航栏标题的字体， 当agreementNavText、secondPrivacyAgreementNavText、 firstPrivacyAgreementNavText存在时不生效 */ @property (nonatomic, strong) UIFont *agreementNavTextFont; /*设置授权页点击隐私协议，进入协议页时, 协议页自定义导航栏标题的颜色， 当agreementNavText、secondPrivacyAgreementNavText、 firstPrivacyAgreementNavText存在时不生效 */ @property (nonatomic, strong) UIColor *agreementNavTextColor; /*协议页导航栏返回按钮图片*/ @property (nonatomic, strong) UIImage *agreementNavReturnImage; /**授权页弹出方式, 弹窗模式下不支持 UIModalTransitionStylePartialCurl*/ @property (nonatomic,assign) UIModalTransitionStyle modalTransitionStyle; /*关闭授权页是否有动画。默认YES,有动画。参数仅作用于以下两种情况： 1、一键登录接口设置登录完成后，自动关闭授权页 2、用户点击授权页关闭按钮，关闭授权页 */ @property (nonatomic, assign) BOOL dismissAnimationFlag; @end DEPRECATED_MSG_ATTRIBUTE("Please use JVUIConfig") @interface JVMobileUIConfig : JVUIConfig @end DEPRECATED_MSG_ATTRIBUTE("Please use JVUIConfig") @interface JVUnicomUIConfig : JVUIConfig @end DEPRECATED_MSG_ATTRIBUTE("Please use JVUIConfig") @interface JVTelecomUIConfig : JVUIConfig @end @interface JVAuthConfig : NSObject /* appKey 必须的,应用唯一的标识. */ @property (nonatomic, copy) NSString *appKey; /* channel 发布渠道. 可选，默认为空*/ @property (nonatomic, copy) NSString *channel; /* advertisingIdentifier 广告标识符（IDFA). 可选，默认为空*/ @property (nonatomic, copy) NSString *advertisingId; /* isProduction 是否生产环境. 如果为开发状态,设置为NO;如果为生产状态,应改为YES.可选，默认为NO */ @property (nonatomic, assign) BOOL isProduction; /* 设置初始化超时时间，单位毫秒，合法范围是(0,30000]，推荐设置为5000-10000,默认值为10000*/ @property(nonatomic, assign) NSTimeInterval timeout; /* authBlock 初始化回调，timeout不设置或无效的情况下，默认10s超时*/ @property (nonatomic, copy) void (^authBlock)(NSDictionary *result); @end @interface JVERIFICATIONService : NSObject + (void)setupWithConfig:(JVAuthConfig *)config; /** 初始化过程是否完成 * 完成YES, 未完成NO */ + (BOOL)isSetupClient; /** 获取手机号校验token @param completion token相关信息。 */ + (void)getToken:(void (^)(NSDictionary *result))completion; /** 获取手机号校验token。和+ (void)getToken:(void (^)(NSDictionary *result))completion;实现的功能一致 @param timeout 超时。单位ms,默认为5000ms。合法范围(0,10000] @param completion token相关信息。 */ + (void)getToken:(NSTimeInterval)timeout completion:(void (^)(NSDictionary *result))completion; /** 授权登录 预取号 @param timeout 超时。单位ms,默认为5000ms。合法范围(0,10000] @param completion 预取号结果 */ + (void)preLogin:(NSTimeInterval)timeout completion:(void (^)(NSDictionary *result))completion; /** 授权登录。完成后自动隐藏授权页。 @param vc 当前控制器 @param completion 登录结果 */ + (void)getAuthorizationWithController:(UIViewController *)vc completion:(void (^)(NSDictionary *result))completion; /** 授权登录 @param vc 当前控制器 @param hide 完成后是否自动隐藏授权页。 @param completion 登录结果 */ + (void)getAuthorizationWithController:(UIViewController *)vc hide:(BOOL)hide completion:(void (^)(NSDictionary *result))completion; /** 授权登录 @param vc 当前控制器 @param hide 完成后是否自动隐藏授权页。 @param completion 登录结果 @parm actionBlock 授权页事件触发回调。 type事件类型，content事件描述。详细见文档 */ + (void)getAuthorizationWithController:(UIViewController *)vc hide:(BOOL)hide completion:(void (^)(NSDictionary *result))completion actionBlock:(void(^)(NSInteger type, NSString *content))actionBlock; /** 授权登录 @param vc 当前控制器 @param hide 完成后是否自动隐藏授权页。 @param animationFlag 拉起授权页时是否需要动画效果，默认YES @param timeout 超时。单位毫秒，合法范围是(0,30000]，默认值为10000。此参数同时作用于拉起授权页超时 ，以及点击授权页登录按钮获取LoginToken超时 @param completion 登录结果 @parm actionBlock 授权页事件触发回调。 type事件类型，content事件描述。详细见文档 */ + (void)getAuthorizationWithController:(UIViewController *)vc hide:(BOOL)hide animated:(BOOL)animationFlag timeout:(NSTimeInterval)timeout completion:(void (^)(NSDictionary *result))completion actionBlock:(void(^)(NSInteger type, NSString *content))actionBlock; /*! * @abstract隐藏登录页。 * 当授权页被拉起以后，可调用此接口隐藏授权页。当一键登录自动隐藏授权页时，不建议调用此接口 */ + (void)dismissLoginController __attribute__((deprecated("JVerification 2.5.2 deprecated, Use +dismissLoginControllerAnimated:completion: instead"))); /** 隐藏登录页.当授权页被拉起以后，可调用此接口隐藏授权页。当一键登录自动隐藏授权页时，不建议调用此接口 @param flag 隐藏时是否需要动画 @param completion 授权页隐藏完成后回调。 */ + (void)dismissLoginControllerAnimated: (BOOL)flag completion: (void (^)(void))completion; /*! * @abstract 设置是否打印sdk产生的Debug级log信息, 默认为NO(不打印log) * * SDK 默认开启的日志级别为: Info. 只显示必要的信息, 不打印调试日志. * * 请在SDK启动后调用本接口，调用本接口可打开日志级别为: Debug, 打印调试日志. * 请在发布产品时改为NO，避免产生不必要的IO */ + (void)setDebug:(BOOL)enable; /*! * @abstract 判断当前手机网络环境是否支持认证 * YES 支持, NO 不支持 */ + (BOOL)checkVerifyEnable; /*! * @abstract 清除预取号缓存 */ + (void)clearPreLoginCache; /** 自定义登录页UI样式参数 @param UIConfig 自定义UI设置。仅使用JVUIConfig类型对象 */ + (void)customUIWithConfig:(JVUIConfig *)UIConfig; /** 自定义登录页UI样式参数 @param UIConfig UIConfig对象实例。仅使用JVUIConfig类型对象 @param customViewsBlk 添加自定义视图block */ + (void)customUIWithConfig:(JVUIConfig *)UIConfig customViews:(void(^)(UIView *customAreaView))customViewsBlk; /** * 获取短信验证码 （最小间隔时间内只能调用一次） * v2.6.0之后新增接口 * @param phoneNumber 手机号码 * @param templateID 短信模板ID 如果为nil，则为默认短信签名ID * @param signID 签名ID 如果为nil，则为默认短信签名id * @param handler block 回调， 成功的时返回的 result 字典包含uuid ,code, msg字段，uuid为此次获取的唯一标识码, 失败时result字段仅返回code ,msg字段 */ + (void)getSMSCode:(NSString *)phoneNumber templateID:(NSString * _Nullable)templateID signID:(NSString * _Nullable)signID completionHandler:(void (^_Nonnull)(NSDictionary * _Nonnull result))handler; /** * 设置前后两次获取验证码的时间间隔 ,默认为30000ms （30s），有效间隔 (0,300000） * v2.6.0之后新增接口 * 在设置间隔时间内只能发送一次获取验证码的请求，SDK 默认是30s * @param intervalTime 时间间隔，单位 ms */ + (void)setGetCodeInternal:(NSTimeInterval)intervalTime; @end