Pariece McKinney
164 lines
6.4 KiB
Objective-C
164 lines
6.4 KiB
Objective-C
/*
|
|
Copyright (c) 2015, Apple Inc. All rights reserved.
|
|
|
|
Redistribution and use in source and binary forms, with or without modification,
|
|
are permitted provided that the following conditions are met:
|
|
|
|
1. Redistributions of source code must retain the above copyright notice, this
|
|
list of conditions and the following disclaimer.
|
|
|
|
2. Redistributions in binary form must reproduce the above copyright notice,
|
|
this list of conditions and the following disclaimer in the documentation and/or
|
|
other materials provided with the distribution.
|
|
|
|
3. Neither the name of the copyright holder(s) nor the names of any contributors
|
|
may be used to endorse or promote products derived from this software without
|
|
specific prior written permission. No license is granted to the trademarks of
|
|
the copyright holders even if such marks are included in this software.
|
|
|
|
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
|
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
|
|
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
|
|
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
|
|
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
|
|
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
|
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
*/
|
|
|
|
|
|
#import <UIKit/UIKit.h>
|
|
#import <ResearchKit/ORKDefines.h>
|
|
#import <ResearchKitUI/ORKStepViewController.h>
|
|
|
|
|
|
NS_ASSUME_NONNULL_BEGIN
|
|
|
|
/**
|
|
The passcode delegate protocol declares methods which forward the success or failure of passcode modification
|
|
or authentication.
|
|
*/
|
|
ORK_AVAILABLE_DECL
|
|
@protocol ORKPasscodeDelegate <NSObject>
|
|
|
|
@required
|
|
/**
|
|
Notifies the delegate that the user has finished authenticating or editing the passcode.
|
|
|
|
@param viewController The `ORKPasscodeStepViewController` object in which the passcode input is entered.
|
|
*/
|
|
- (void)passcodeViewControllerDidFinishWithSuccess:(UIViewController *)viewController;
|
|
|
|
/**
|
|
Notifies the delegate that the user failed authentication.
|
|
|
|
@param viewController The `ORKPasscodeStepViewController` object in which the passcode input is entered.
|
|
*/
|
|
- (void)passcodeViewControllerDidFailAuthentication:(UIViewController *)viewController;
|
|
|
|
@optional
|
|
|
|
/**
|
|
Notifies the delegate that the user hit the cancel button item. The cancel button is only visible if this method
|
|
is implemented.
|
|
|
|
@param viewController The `ORKPasscodeStepViewController` object in which the passcode input is entered.
|
|
*/
|
|
- (void)passcodeViewControllerDidCancel:(UIViewController *)viewController;
|
|
|
|
/**
|
|
Defaults to Localized "Forgot Passcode?" text
|
|
|
|
@param viewController The `ORKPasscodeStepViewController` object in which the passcode input is entered.
|
|
@return Text to display for the forgot passcode button
|
|
*/
|
|
- (NSString *)passcodeViewControllerTextForForgotPasscode:(UIViewController *)viewController;
|
|
|
|
/**
|
|
Notifies the delegate that forgot passcode button has been tapped.
|
|
|
|
@param viewController The `ORKPasscodeStepViewController` object in which the passcode input is entered.
|
|
*/
|
|
- (void)passcodeViewControllerForgotPasscodeTapped:(UIViewController *)viewController;
|
|
|
|
@end
|
|
|
|
|
|
/**
|
|
An `ORKPasscodeStepViewController` object is the view controller for an `ORKPasscodeStep` object.
|
|
|
|
A passcode view controller can also be instantiated directly for authentication and editing by using one
|
|
of the factory methods below. Each factory method requires a delegate to be implemented.
|
|
*/
|
|
ORK_CLASS_AVAILABLE
|
|
@interface ORKPasscodeViewController : UINavigationController
|
|
|
|
+ (instancetype)new NS_UNAVAILABLE;
|
|
- (instancetype)init NS_UNAVAILABLE;
|
|
|
|
/**
|
|
An authenticaiton passcode view controller allows a user to be authenticated using
|
|
the passcode stored in the keychain.
|
|
|
|
A passcode must already have been created using a passcode step before presenting
|
|
this view controller (see `ORKPasscodeStep`).
|
|
|
|
You must check to see if the passcode is stored in the keychain before presenting
|
|
this view controller. A helper method, `isPasscodeStoredInKeychain`, is provided as
|
|
part of this class.
|
|
|
|
@param text The message displayed to the user.
|
|
@param delegate The delegate for the passcode view controller.
|
|
|
|
@return A passcode authentication view controller.
|
|
*/
|
|
+ (instancetype)passcodeAuthenticationViewControllerWithText:(nullable NSString *)text
|
|
delegate:(id<ORKPasscodeDelegate>)delegate;
|
|
|
|
/**
|
|
An editing passcode view controller allows a user to be authenticated using
|
|
the passcode stored in the keychain and create a new passcode.
|
|
|
|
A passcode must already have been created using a passcode step before presenting
|
|
this view controller (see `ORKPasscodeStep`).
|
|
|
|
You must check to see if the passcode is stored in the keychain before presenting
|
|
this view controller. A helper method, `isPasscodeStoredInKeychain`, is provided as
|
|
part of this class.
|
|
|
|
@param text The message displayed to the user.
|
|
@param delegate The delegate for the passcode view controller.
|
|
@param passcodeType The passcode type for the new passcode.
|
|
|
|
@return A passcode editing view controller.
|
|
*/
|
|
+ (instancetype)passcodeEditingViewControllerWithText:(nullable NSString *)text
|
|
delegate:(id<ORKPasscodeDelegate>)delegate
|
|
passcodeType:(ORKPasscodeType)passcodeType;
|
|
/**
|
|
Returns 'YES' if a passcode is stored in the keychain, otherwise 'NO'.
|
|
*/
|
|
+ (BOOL)isPasscodeStoredInKeychain;
|
|
|
|
/**
|
|
Returns 'YES' if passcode was successfully removed from the keychain, otherwise 'NO'.
|
|
*/
|
|
+ (BOOL)removePasscodeFromKeychain;
|
|
|
|
/**
|
|
This method allows to force the passcode to be a certain value. You only want to use this capability when you're moving your existing users
|
|
from a custom passcode entry mechanism to the one provided by ResearchKit.
|
|
|
|
This method will raise an exception if `passcode` is nil.
|
|
|
|
@param passcode The passcode to store
|
|
@param touchIdEnabled Whether TouchId will be available during passcode entry
|
|
*/
|
|
+ (void)forcePasscode:(NSString *)passcode withTouchIdEnabled:(BOOL)touchIdEnabled;
|
|
|
|
@end
|
|
|
|
NS_ASSUME_NONNULL_END
|