Files
firebase-ios-sdk/Firebase/InstanceID/FIRInstanceIDTokenOperation.h
T
Maksym MalyhinandChen Liang f62c7ddcec IID: version dependent on FirebaseInstallations (#4533)
* Firebase Installations: Instance ID now uses FIS under the hood. (#3398)

* Fix merge errors

* Use modular import for FIRInstanceID_Private.h

* Use modular imports for FirebaseInstanceID.h (#3509)

* Changes missing during the fix.

* Changes missing during merge.

* Fix header import.

* ./scripts/style.sh

* Fix FCM tests. (#3888)

* Fix IID FCM token check.

* FirebaseInstallation: merge master into FIS integration branch (#4076)

* Fix IID FCM token check.

* Unused constant deleted.

* FCM tests: fix bad merge.

* Remote Config test app: use local IID and FIS. (#4089)

* token request should pass through if token is not fresh (#4104)

* Merge errors fix.

* IID with FIS: send FIS auth token with IID token request (#4152)

* FIRInstanceIDTokenOperation: add FIS auth token to the IID token request.

* IID tests: don't use FIS private headers.

* IID: indication of compatibility with FIS (#4262)

* FIS: IID incompatible version exception.

* FirebaseInstallations.podspec: set preprocessor flags based on env vars.

* FIS Travis: set required env vars

* /scripts/style.sh

* IID: method to indicate FIS usege added.

* FIS: FIRInstantiationTimingEagerInDefaultApp

* FIS: FIRInstantiationTimingAlwaysEager

* IID: make compatibility method static.

* Make -[FIRInstanceID appInstanceID:] safe to be called from any thread (#4482)

* IID: use a cached value of FID for -[FIRInstanceID appInstanceID:]

* TODO comment

* TODO updated

* FirebaseInstallations: prepare IID with FIS dependency for release (#4522)

* Bump FIrebaseInstallations to 1.0.0

* Travis: remove mm/fis-integration-master branch

* Travis: if_changed script updated to reflect IID dependency on FIS.

* Revert "Travis: remove mm/fis-integration-master branch"

This reverts commit 534dff990a.

* Travis: remove mm/fis-integration-master branch (#4526)

* Formatting and spelling.

* Firebase example proj: pod deintegrate

Co-authored-by: Chen Liang <chliang@google.com>
2019-12-20 10:54:11 -05:00

73 lines
2.6 KiB
Objective-C

/*
* Copyright 2019 Google
*
* 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.
*/
#import <Foundation/Foundation.h>
@class FIRInstanceIDCheckinPreferences;
NS_ASSUME_NONNULL_BEGIN
/**
* Represents the action taken on an FCM token.
*/
typedef NS_ENUM(NSInteger, FIRInstanceIDTokenAction) {
FIRInstanceIDTokenActionFetch,
FIRInstanceIDTokenActionDeleteToken,
FIRInstanceIDTokenActionDeleteTokenAndIID,
};
/**
* Represents the possible results of a token operation.
*/
typedef NS_ENUM(NSInteger, FIRInstanceIDTokenOperationResult) {
FIRInstanceIDTokenOperationSucceeded,
FIRInstanceIDTokenOperationError,
FIRInstanceIDTokenOperationCancelled,
};
/**
* Callback to invoke once the HTTP call to FIRMessaging backend for updating
* subscription finishes.
*
* @param result The result of the operation.
* @param token If the action for fetching a token and the request was successful, this will hold
* the value of the token. Otherwise nil.
* @param error The error which occurred while performing the token operation. This will be nil
* in case the operation was successful, or if the operation was cancelled.
*/
typedef void (^FIRInstanceIDTokenOperationCompletion)(FIRInstanceIDTokenOperationResult result,
NSString *_Nullable token,
NSError *_Nullable error);
@interface FIRInstanceIDTokenOperation : NSOperation
@property(nonatomic, readonly) FIRInstanceIDTokenAction action;
@property(nonatomic, readonly, nullable) NSString *authorizedEntity;
@property(nonatomic, readonly, nullable) NSString *scope;
@property(nonatomic, readonly, nullable) NSDictionary<NSString *, NSString *> *options;
@property(nonatomic, readonly, strong) FIRInstanceIDCheckinPreferences *checkinPreferences;
@property(nonatomic, readonly, strong) NSString *instanceID;
@property(nonatomic, readonly) FIRInstanceIDTokenOperationResult result;
- (instancetype)init NS_UNAVAILABLE;
- (void)addCompletionHandler:(FIRInstanceIDTokenOperationCompletion)handler;
@end
NS_ASSUME_NONNULL_END