mirror of
https://github.com/firebase/firebase-ios-sdk
synced 2026-11-10 22:45:59 +05:45
Morgan Chen
835bac1b08
* Update doc comments for release * Remove not-parsed doc tag * Add changelog entry
93 lines
2.9 KiB
Objective-C
93 lines
2.9 KiB
Objective-C
// Copyright 2020 Google LLC
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
@class FIRAppDistributionRelease;
|
|
#import <Foundation/Foundation.h>
|
|
|
|
NS_ASSUME_NONNULL_BEGIN
|
|
|
|
/**
|
|
* The Firebase App Distribution API provides methods to check for update to
|
|
* the app and returns information that enables updating the app.
|
|
*
|
|
* By default, Firebase App Distribution is initialized with `FirebaseApp.configure()`.
|
|
*
|
|
* Note: The App Distribution class cannot be subclassed. If this makes testing difficult,
|
|
* we suggest using a wrapper class or a protocol extension.
|
|
*/
|
|
NS_SWIFT_NAME(AppDistribution)
|
|
@interface FIRAppDistribution : NSObject
|
|
|
|
/// Returns true if the App Distribution tester is signed in.
|
|
@property(nonatomic, readonly) BOOL isTesterSignedIn;
|
|
|
|
/** :nodoc: */
|
|
- (instancetype)init NS_UNAVAILABLE;
|
|
|
|
/**
|
|
* Sign-in the App Distribution tester
|
|
*/
|
|
- (void)signInTesterWithCompletion:(void (^)(NSError *_Nullable error))completion
|
|
NS_SWIFT_NAME(signInTester(completion:));
|
|
|
|
/**
|
|
* Check to see whether a new distribution is available
|
|
*/
|
|
- (void)checkForUpdateWithCompletion:
|
|
(void (^)(FIRAppDistributionRelease *_Nullable release, NSError *_Nullable error))completion
|
|
NS_SWIFT_NAME(checkForUpdate(completion:));
|
|
|
|
/**
|
|
* Sign out App Distribution tester
|
|
*/
|
|
- (void)signOutTester;
|
|
|
|
/**
|
|
* Accesses the singleton App Distribution instance.
|
|
*
|
|
* @return The singleton App Distribution instance.
|
|
*/
|
|
+ (instancetype)appDistribution NS_SWIFT_NAME(appDistribution());
|
|
|
|
@end
|
|
|
|
/// The error domain for codes in the `FIRAppDistributionError` enum.
|
|
FOUNDATION_EXPORT NSString *const FIRAppDistributionErrorDomain
|
|
NS_SWIFT_NAME(AppDistributionErrorDomain);
|
|
|
|
/// The key for finding error details in the `NSError`'s `userInfo`.
|
|
FOUNDATION_EXPORT NSString *const FIRAppDistributionErrorDetailsKey
|
|
NS_SWIFT_NAME(FunctionsErrorDetailsKey);
|
|
|
|
/**
|
|
* Error codes representing sign in or version check failure reasons.
|
|
*/
|
|
typedef NS_ENUM(NSUInteger, FIRAppDistributionError) {
|
|
/// Returned when an unknown error occurred.
|
|
FIRAppDistributionErrorUnknown = 0,
|
|
|
|
/// Returned when App Distribution failed to authenticate the user.
|
|
FIRAppDistributionErrorAuthenticationFailure = 1,
|
|
|
|
/// Returned when sign-in was cancelled.
|
|
FIRAppDistributionErrorAuthenticationCancelled = 2,
|
|
|
|
/// Returned when the network was unavailable to make requests or
|
|
/// the request timed out.
|
|
FIRAppDistributionErrorNetworkFailure = 3,
|
|
|
|
} NS_SWIFT_NAME(AppDistributionError);
|
|
|
|
NS_ASSUME_NONNULL_END
|