FIROptions Class Reference

#import <FIROptions.h>

Inheritance diagram for FIROptions:

Instance Methods
(instancetype)	- initWithGoogleAppID:bundleID:GCMSenderID:APIKey:clientID:trackingID:androidClientID:databaseURL:storageBucket:deepLinkURLScheme:

Class Methods
(FIROptions *)	+ defaultOptions

Properties
NSString *	APIKey
NSString *	clientID
NSString *	trackingID
NSString *	GCMSenderID
NSString *	androidClientID
NSString *	googleAppID
NSString *	databaseURL
NSString *	deepLinkURLScheme
NSString *	storageBucket

Detailed Description

This class provides constant fields of Google APIs.

Method Documentation

+ (FIROptions *) defaultOptions

Returns the default options.

- (instancetype) initWithGoogleAppID:		(NSString *)	googleAppID
bundleID:		(NSString *)	bundleID
GCMSenderID:		(NSString *)	GCMSenderID
APIKey:		(NSString *)	APIKey
clientID:		(NSString *)	clientID
trackingID:		(NSString *)	trackingID
androidClientID:		(NSString *)	androidClientID
databaseURL:		(NSString *)	databaseURL
storageBucket:		(NSString *)	storageBucket
deepLinkURLScheme:		(NSString *)	deepLinkURLScheme

Initializes a customized instance of FIROptions with keys. googleAppID, bundleID and GCMSenderID are required. Other keys may required for configuring specific services.

Property Documentation

- (NSString*) androidClientID

readnonatomiccopy

The Android client ID used in Google AppInvite when an iOS app has its Android version, for example "12345.apps.googleusercontent.com".

- (NSString*) APIKey

readnonatomiccopy

An iOS API key used for authenticating requests from your app, e.g. "AIzaSyDdVgKwhZl0sTTTLZ7iTmt1r3N2cJLnaDk", used to identify your app to Google servers.

- (NSString*) clientID

readnonatomiccopy

The OAuth2 client ID for iOS application used to authenticate Google users, for example "12345.apps.googleusercontent.com", used for signing in with Google.

- (NSString*) databaseURL

readnonatomiccopy

The database root URL, e.g. "http://abc-xyz-123.firebaseio.com".

- (NSString*) deepLinkURLScheme

readwritenonatomiccopy

The URL scheme used to set up Durable Deep Link service.

- (NSString*) GCMSenderID

readnonatomiccopy

The Project Number from the Google Developer's console, for example "012345678901", used to configure Google Cloud Messaging.

- (NSString*) googleAppID

readnonatomiccopy

The Google App ID that is used to uniquely identify an instance of an app.

- (NSString*) storageBucket

readnonatomiccopy

The Google Cloud Storage bucket name, e.g. "abc-xyz-123.storage.firebase.com".

- (NSString*) trackingID

readnonatomiccopy

The tracking ID for Google Analytics, e.g. "UA-12345678-1", used to configure Google Analytics.

---

The documentation for this class was generated from the following file:

• Frameworks/FirebaseAnalytics.framework/Headers/FIROptions.h