FirebaseCore Framework Reference

FirebaseOptions

class FirebaseOptions : NSObject, NSCopying

This class provides constant fields of Google APIs.

  • Returns the default options. The first time this is called it synchronously reads GoogleService-Info.plist from disk.

    Declaration

    Swift

    class func defaultOptions() -> FirebaseOptions?

  • An API key used for authenticating requests from your Apple app, e.g. The key must begin with “A” and contain exactly 39 alphanumeric characters, used to identify your app to Google servers.

    Declaration

    Swift

    var apiKey: String? { get set }

  • The bundle ID for the application. Defaults to Bundle.main.bundleIdentifier when not set manually or in a plist.

    Declaration

    Swift

    var bundleID: String { get set }

  • The OAuth2 client ID for Apple applications used to authenticate Google users, for example @“12345.apps.googleusercontent.com”, used for signing in with Google.

    Declaration

    Swift

    var clientID: String? { get set }

  • Unused.

    Declaration

    Swift

    var trackingID: String? { get set }

  • The Project Number from the Google Developer’s console, for example @“012345678901”, used to configure Firebase Cloud Messaging.

    Declaration

    Swift

    var gcmSenderID: String { get set }

  • The Project ID from the Firebase console, for example @“abc-xyz-123”.

    Declaration

    Swift

    var projectID: String? { get set }

  • Unused.

    Declaration

    Swift

    var androidClientID: String? { get set }

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

    Declaration

    Swift

    var googleAppID: String { get set }

  • The database root URL, e.g. @“http://abc-xyz-123.firebaseio.com”.

    Declaration

    Swift

    var databaseURL: String? { get set }

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

    Declaration

    Swift

    var deepLinkURLScheme: String? { get set }

  • The Google Cloud Storage bucket name, e.g. @“abc-xyz-123.storage.firebase.com”.

    Declaration

    Swift

    var storageBucket: String? { get set }

  • The App Group identifier to share data between the application and the application extensions. The App Group must be configured in the application and on the Apple Developer Portal. Default value nil.

    Declaration

    Swift

    var appGroupID: String? { get set }

  • Initializes a customized instance of FirebaseOptions from the file at the given plist file path. This will read the file synchronously from disk. For example:

      if let path = Bundle.main.path(forResource:"GoogleServices-Info", ofType:"plist") {
      let options = FirebaseOptions(contentsOfFile: path)
  }

    Note that it is not possible to customize FirebaseOptions for Firebase Analytics which expects a static file named GoogleServices-Info.plist - https://github.com/firebase/firebase-ios-sdk/issues/230. Returns nil if the plist file does not exist or is invalid.

    Declaration

    Swift

    init?(contentsOfFile plistPath: String)

  • Initializes a customized instance of FirebaseOptions with required fields. Use the mutable properties to modify fields for configuring specific services. Note that it is not possible to customize FirebaseOptions for Firebase Analytics which expects a static file named GoogleServices-Info.plist - https://github.com/firebase/firebase-ios-sdk/issues/230.

    Declaration

    Swift

    init(googleAppID: String, gcmSenderID GCMSenderID: String)

  • Unavailable. Please use init(contentsOfFile:) or init(googleAppID:gcmSenderID:) instead.