Files
firebase-ios-sdk/FirebaseAuth/Sources/Backend/FIRAuthRequestConfiguration.h
T
Rosalyn Tan c7f80c14c2 Add app ID header to Firebase Auth (#9046)
* Add user agent and heartbeat headers to Firebase Auth.

* Add app ID header.

* Fix unit tests.

* Remove user agent and heartbeat headers, as backend support is not yet ready.

* Fix typo.

* Update changelog.
2021-12-08 15:10:16 -08:00

65 lines
2.1 KiB
Objective-C

/*
* Copyright 2017 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>
#import "FirebaseAuth/Sources/Backend/FIRAuthRPCRequest.h"
NS_ASSUME_NONNULL_BEGIN
/** @class FIRAuthRequestConfiguration
@brief Defines configurations to be added to a request to Firebase Auth's backend.
*/
@interface FIRAuthRequestConfiguration : NSObject
/** @property APIKey
@brief The Firebase Auth API key used in the request.
*/
@property(nonatomic, copy, readonly) NSString *APIKey;
/** @property appID
@brief The Firebase appID used in the request.
*/
@property(nonatomic, copy, readonly) NSString *appID;
/** @property LanguageCode
@brief The language code used in the request.
*/
@property(nonatomic, copy, nullable) NSString *languageCode;
/** @property additionalFrameworkMarker
@brief Additional framework marker that will be added as part of the header of every request.
*/
@property(nonatomic, copy, nullable) NSString *additionalFrameworkMarker;
/** @property emulatorHostAndPort
@brief If set, the local emulator host and port to point to instead of the remote backend.
*/
@property(nonatomic, copy, nullable) NSString *emulatorHostAndPort;
- (instancetype)init NS_UNAVAILABLE;
/** @fn initWithAPIKey:appID:
@brief Designated initializer.
@param APIKey The API key to be used in the request.
@param appID The Firebase app ID to be passed in the request header.
*/
- (nullable instancetype)initWithAPIKey:(NSString *)APIKey
appID:(NSString *)appID NS_DESIGNATED_INITIALIZER;
@end
NS_ASSUME_NONNULL_END