In version 4.0.0 of the Firebase iOS SDK for Swift, we included changes to follow the naming conventions in the Swift API Design Guidelines . To fix any errors or warnings you might receive when you update your app's version of the Firebase iOS SDK, follow the steps in this migration guide.
Changes in the new version
The following changes have been made to the Swift SDK across all Firebase products:
- Removing the
FIRprefix across names for all constants, protocols, classes, enums, and type definitions. - Renaming
FIRApptoFirebaseApp. - Renaming
FIROptionstoFirebaseOptions.
For a full list of the changes, see the detailed list of changes section .
Resolve errors
The best way to resolve errors resulting from these changes is to use the Fix-it dialog in Xcode.
- When you open your updated project in your Xcode workspace, errors resulting from the naming changes appear in the issue navigator .
- Click the error and resolve it with the suggestion in the Fix-it dialog .
Resolve naming conflicts
To resolve naming conflicts, use the namespace provided by the module. For
example, in the case of FIRUser
, which is now User
, you may want to
differentiate between your User
class/struct and the Firebase User
class.
@import Firebase ... var firebaseUser : Firebase . User ?
Detailed list of changes
Analytics
FIRAnalytics
logEvent(withName:parameters:)
logEvent(_:parameters:)
FIRAnalytics.logEvent(withName: "com.myapp.appStart", parameters: nil)
Analytics.logEvent("com.myapp.appStart", parameters: nil)
setUserPropertyString(_:forName:)
setUserProperty(_:forName:)
FIRAnalytics.setUserPropertyString("mechanic", forName: "job")
Analytics.setUserProperty("mechanic", forName: "job")
FIRAnalytics
Analytics
FIRAnalyticsEventAddPaymentInfo
AnalyticsEventAddPaymentInfo
FIRAnalyticsEventAddToCart
AnalyticsEventAddToCart
FIRAnalyticsEventAddToWishlist
AnalyticsEventAddToWishlist
FIRAnalyticsEventAppOpen
AnalyticsEventAppOpen
FIRAnalyticsEventBeginCheckout
AnalyticsEventBeginCheckout
FIRAnalyticsEventCampaignDetails
AnalyticsEventCampaignDetails
FIRAnalyticsEventCheckoutProgress
AnalyticsEventCheckoutProgress
FIRAnalyticsEventEarnVirtualCurrency
AnalyticsEventEarnVirtualCurrency
FIRAnalyticsEventEcommercePurchase
AnalyticsEventEcommercePurchase
FIRAnalyticsEventGenerateLead
AnalyticsEventGenerateLead
FIRAnalyticsEventJoinGroup
AnalyticsEventJoinGroup
FIRAnalyticsEventLevelUp
AnalyticsEventLevelUp
FIRAnalyticsEventLogin
AnalyticsEventLogin
FIRAnalyticsEventPostScore
AnalyticsEventPostScore
FIRAnalyticsEventPresentOffer
AnalyticsEventPresentOffer
FIRAnalyticsEventPurchaseRefund
AnalyticsEventPurchaseRefund
FIRAnalyticsEventRemoveFromCart
AnalyticsEventRemoveFromCart
FIRAnalyticsEventSearch
AnalyticsEventSearch
FIRAnalyticsEventSelectContent
AnalyticsEventSelectContent
FIRAnalyticsEventSetCheckoutOption
AnalyticsEventSetCheckoutOption
FIRAnalyticsEventShare
AnalyticsEventShare
FIRAnalyticsEventSignUp
AnalyticsEventSignUp
FIRAnalyticsEventSpendVirtualCurrency
AnalyticsEventSpendVirtualCurrency
FIRAnalyticsEventTutorialBegin
AnalyticsEventTutorialBegin
FIRAnalyticsEventTutorialComplete
AnalyticsEventTutorialComplete
FIRAnalyticsEventUnlockAchievement
AnalyticsEventUnlockAchievement
FIRAnalyticsEventViewItem
AnalyticsEventViewItem
FIRAnalyticsEventViewItemList
AnalyticsEventViewItemList
FIRAnalyticsEventViewSearchResults
AnalyticsEventViewSearchResults
FIRAnalyticsParameterAchievementID
AnalyticsParameterAchievementID
FIRAnalyticsParameterAdNetworkClickID
AnalyticsParameterAdNetworkClickID
FIRAnalyticsParameterAffiliation
AnalyticsParameterAffiliation
FIRAnalyticsParameterCampaign
AnalyticsParameterCampaign
FIRAnalyticsParameterCharacter
AnalyticsParameterCharacter
FIRAnalyticsParameterCheckoutStep
AnalyticsParameterCheckoutStep
FIRAnalyticsParameterCheckoutOption
AnalyticsParameterCheckoutOption
FIRAnalyticsParameterContent
AnalyticsParameterContent
FIRAnalyticsParameterContentType
AnalyticsParameterContentType
FIRAnalyticsParameterCoupon
AnalyticsParameterCoupon
FIRAnalyticsParameterCreativeName
AnalyticsParameterCreativeName
FIRAnalyticsParameterCreativeSlot
AnalyticsParameterCreativeSlot
FIRAnalyticsParameterCurrency
AnalyticsParameterCurrency
FIRAnalyticsParameterDestination
AnalyticsParameterDestination
FIRAnalyticsParameterEndDate
AnalyticsParameterEndDate
FIRAnalyticsParameterFlightNumber
AnalyticsParameterFlightNumber
FIRAnalyticsParameterGroupID
AnalyticsParameterGroupID
FIRAnalyticsParameterIndex
AnalyticsParameterIndex
FIRAnalyticsParameterItemBrand
AnalyticsParameterItemBrand
FIRAnalyticsParameterItemCategory
AnalyticsParameterItemCategory
FIRAnalyticsParameterItemID
AnalyticsParameterItemID
FIRAnalyticsParameterItemLocationID
AnalyticsParameterItemLocationID
FIRAnalyticsParameterItemName
AnalyticsParameterItemName
FIRAnalyticsParameterItemList
AnalyticsParameterItemList
FIRAnalyticsParameterItemVariant
AnalyticsParameterItemVariant
FIRAnalyticsParameterLevel
AnalyticsParameterLevel
FIRAnalyticsParameterLocation
AnalyticsParameterLocation
FIRAnalyticsParameterMedium
AnalyticsParameterMedium
FIRAnalyticsParameterNumberOfNights
AnalyticsParameterNumberOfNights
FIRAnalyticsParameterNumberOfPassengers
AnalyticsParameterNumberOfPassengers
FIRAnalyticsParameterNumberOfRooms
AnalyticsParameterNumberOfRooms
FIRAnalyticsParameterOrigin
AnalyticsParameterOrigin
FIRAnalyticsParameterPrice
AnalyticsParameterPrice
FIRAnalyticsParameterQuantity
AnalyticsParameterQuantity
FIRAnalyticsParameterScore
AnalyticsParameterScore
FIRAnalyticsParameterSearchTerm
AnalyticsParameterSearchTerm
FIRAnalyticsParameterShipping
AnalyticsParameterShipping
FIRAnalyticsParameterSignUpMethod
AnalyticsParameterSignUpMethod
FIRAnalyticsParameterSource
AnalyticsParameterSource
FIRAnalyticsParameterStartDate
AnalyticsParameterStartDate
FIRAnalyticsParameterTax
AnalyticsParameterTax
FIRAnalyticsParameterTerm
AnalyticsParameterTerm
FIRAnalyticsParameterTransactionID
AnalyticsParameterTransactionID
FIRAnalyticsParameterTravelClass
AnalyticsParameterTravelClass
FIRAnalyticsParameterValue
AnalyticsParameterValue
FIRAnalyticsParameterVirtualCurrencyName
AnalyticsParameterVirtualCurrencyName
FIRAnalyticsUserPropertySignUpMethod
AnalyticsUserPropertySignUpMethod
Auth
FIRAuth.h
init?(app:)
auth(app:)
let auth = FIRAuth(app: myApp)
let auth = Auth.auth(app: myApp)
FIRUser.h
updateEmail(_:completion:)
updateEmail(to:completion:)
user . updateEmail ( "firebase_rox42@gmail.com" ) { error in // Check for error }
user . updateEmail ( to : "firebase_rox42@gmail.com" ) { error in // Check for error }
updatePassword(_:completion:)
updatePassword(to:completion:)
user.updatePassword("hunter2") { error in
// Check for error
}
user.updatePassword(to: "hunter2") { error in
// Check for error
}
profileChangeRequest()
createProfileChangeRequest()
let request = user.profileChangeRequest()
let request = user.createProfileChangeRequest()
getTokenWithCompletion(_:)
getToken(completion:)
user.getTokenWithCompletion() { token, error in
// Handle token or error here
}
user.getToken() { token, error in
// Handle token or error here
}
FIRAdditionalUserInfo
AdditionalUserInfo
FIRActionCodeInfo
ActionCodeInfo
FIRAuth
Auth
FIRAuthCredential
AuthCredential
FIRAuthDataResult
AuthDataResult
FIRAuthErrors
AuthErrors
FIRSecureTokenService
SecureTokenService
FIRUser
User
FIRUserProfileChangeRequest
UserProfileChangeRequest
FIRUserInfo
UserInfo
FIREmailAuthProvider
EmailAuthProvider
FIRFacebookAuthProvider
FacebookAuthProvider
FIRGitHubAuthProvider
GitHubAuthProvider
FIRGoogleAuthProvider
GoogleAuthProvider
FIROAuthProvider
OAuthProvider
FIRTwitterAuthProvider
TwitterAuthProvider
FIRAuthErrorDomain
AuthErrorDomain
FIRAuthErrorNameKey
AuthErrorNameKey
FIREmailAuthProviderID
EmailAuthProviderID
FIRFacebookAuthProviderID
FacebookAuthProviderID
FIRGitHubAuthProviderID
GitHubAuthProviderID
FIRGoogleAuthProviderID
GoogleAuthProviderID
FIRTwitterAuthProviderID
TwitterAuthProviderID
FIRAuthStateDidChange
AuthStateDidChange
FIRAuthStateDidChangeListenerHandle
AuthStateDidChangeListenerHandle
FIRAuthStateDidChangeListenerBlock
AuthStateDidChangeListenerBlock
FIRAuthDataResultCallback
AuthDataResultCallback
FIRAuthResultCallback
AuthResultCallback
FIRProviderQueryCallback
ProviderQueryCallback
FIRSendPasswordResetCallback
SendPasswordResetCallback
FIRConfirmPasswordResetCallback
ConfirmPasswordResetCallback
FIRVerifyPasswordResetCodeCallback
VerifyPasswordResetCodeCallback
FIRApplyActionCodeCallback
ApplyActionCodeCallback
FIRVerificationResultCallback
VerificationResultCallback
FIRActionDataKey
ActionDataKey
FIRActionCodeOperation
ActionCodeOperation
FIRAuthErrorCode
AuthErrorCode
Core
FIRAnalyticsConfiguration.sharedInstance()
AnalyticsConfiguration.shared()
FIRApp.configure(withName:options:)
FirebaseApp.configure(name:options:)
FIRApp.configure(withName: "myCustomApp", options: customOptions)
FirebaseApp.configure(name: "myCustomApp", options: customOptions)
FIRApp.defaultApp()
FirebaseApp.app()
FIRApp.init?(named:)
FirebaseApp.app(name:)
let app = FIRApp(named: "myCustomApp")
let app = FirebaseApp.app(name: "myCustomApp")
FIRApp.allApps()
FirebaseApp.allApps
for app in FIRApp.allApps() {
print("App name: \(app.name)")
}
for app in FirebaseApp.allApps {
print("App name: \(app.name)")
}
FIRConfiguration.sharedInstance()
FirebaseConfiguration.shared()
FIROptions.default()
FirebaseOptions.defaultOptions()
GCMSenderID
gcmSenderID
FIRAnalyticsConfiguration
AnalyticsConfiguration
FIRApp
FirebaseApp
FIRConfiguration
FirebaseConfiguration
FIROptions
FirebaseOptions
FIRAppVoidBoolCallback
FirebaseAppVoidBoolCallback
FIRLoggerLevel
FirebaseLoggerLevel
Crash
FIRCrashMessage(_:)
FirebaseCrashMessage(_:)
Database
persistenceEnabled
isPersistenceEnabled
FIRDataSnapshot
DataSnapshot
FIRDatabase
Database
FIRDatabaseQuery
DatabaseQuery
FIRDatabaseReference
DatabaseReference
FIRMutableData
MutableData
FIRServerValue
ServerValue
FIRTransactionResult
TransactionResult
FIRDatabaseHandle
DatabaseHandle
FIRDataEventType
DataEventType
Dynamic Links
// FIRDynamicLinks.h
dynamicLink(fromUniversalLinkURL:)
dynamicLink(fromUniversalLink:)
FIRDynamicLink
DynamicLink
FIRDLRetrievalDelegate
DLRetrievalDelegate
FIRDynamicLinks
DynamicLinks
FIRDynamicLinkGoogleAnalyticsParameters
DynamicLinkGoogleAnalyticsParameters
FIRDynamicLinkIOSParameters
DynamicLinkIOSParameters
FIRDynamicLinkItunesConnectAnalyticsParameters
DynamicLinkItunesConnectAnalyticsParameters
FIRDynamicLinkAndroidParameters
DynamicLinkAndroidParameters
FIRDynamicLinkSocialMetaTagParameters
DynamicLinkSocialMetaTagParameters
FIRDynamicLinkNavigationInfoParameters
DynamicLinkNavigationInfoParameters
FIRDynamicLinkComponentsOptions
DynamicLinkComponentsOptions
FIRDynamicLinkComponents
DynamicLinkComponents
FIRDynamicLinkResolverHandler
DynamicLinkResolverHandler
FIRDynamicLinkUniversalLinkHandler
DynamicLinkUniversalLinkHandler
FIRDynamicLinkShortenerCompletion
DynamicLinkShortenerCompletion
FIRDynamicLinkMatchConfidence
DynamicLinkMatchConfidence
FIRDLRequiredMatchConfidence
DLRequiredMatchConfidence
FIRDLRetrieveResult
DLRetrieveResult
FIRShortDynamicLinkPathLength
ShortDynamicLinkPathLength
Instance ID
FIRInstanceID.h
getWithHandler()
getIDWithHandler()
FIRInstanceID.instanceID().get { identity, error in
// Check identity and error
}
instanceID.instanceID().getID { identity, error in
// Check identity and error
}
deleteWithHandler()
deleteIDWithHandler()
FIRInstanceID.instanceID().delete { error in
// Check error
}
instanceID.instanceID().deleteID { error in
// Check error
}
FIRInstanceID
InstanceID
FIRInstanceIDScopeFirebaseMessaging
InstanceIDScopeFirebaseMessaging
FIRInstanceIDTokenRefresh
InstanceIDTokenRefresh
FIRInstanceIDTokenHandler
InstanceIDTokenHandler
FIRInstanceIDDeleteTokenHandler
InstanceIDDeleteTokenHandler
FIRInstanceIDHandler
InstanceIDHandler
FIRInstanceIDDeleteHandler
InstanceIDDeleteHandler
FIRInstanceIDError
InstanceIDError
FIRInstanceIDAPNSTokenType
InstanceIDAPNSTokenType
Invites
FIRInvites
Invites
FIRInvitesTargetApplication
InvitesTargetApplication
FIRReceivedInvite
ReceivedInvite
FIRInvitesErrorDomain
InvitesErrorDomain
FIRInvitesErrorCode
InvitesErrorCode
FIRReceivedInviteMatchType
ReceivedInviteMatchType
FIRInviteBuilder
InviteBuilder
FIRInviteDelegate
InviteDelegate
Messaging
connect(completion:)
connect(handler:)
FIRMessagingMessageInfo
MessagingMessageInfo
FIRMessagingRemoteMessage
MessagingRemoteMessage
FIRMessaging
Messaging
FIRMessagingSendSuccess
MessagingSendSuccess
FIRMessagingSendError
MessagingSendError
FIRMessagingMessagesDeleted
MessagingMessagesDeleted
FIRMessagingConnectionStateChanged
MessagingConnectionStateChanged
FIRMessagingRegistrationTokenRefreshed
MessagingRegistrationTokenRefreshed
FIRMessagingFCMTokenFetchCompletion
MessagingFCMTokenFetchCompletion
FIRMessagingDeleteFCMTokenCompletion
MessagingDeleteFCMTokenCompletion
FIRMessagingError
MessagingError
FIRMessagingMessageStatus
MessagingMessageStatus
FIRMessagingAPNSTokenType
MessagingAPNSTokenType
FIRMessagingDelegate
MessagingDelegate
Remote Config
setDefaultsFromPlistFileName(_:)
setDefaults(fromPlist:)
setDefaultsFromPlistFileName(_:namespace)
setDefaults(fromPlist:namespace)
FIRRemoteConfigValue
RemoteConfigValue
FIRRemoteConfigSettings
RemoteConfigSettings
FIRRemoteConfig
RemoteConfig
FIRNamespaceGoogleMobilePlatform
NamespaceGoogleMobilePlatform
FIRRemoteConfigThrottledEndTimeInSecondsKey
RemoteConfigThrottledEndTimeInSecondsKey
FIRRemoteConfigErrorDomain
RemoteConfigErrorDomain
FIRRemoteConfigFetchCompletion
RemoteConfigFetchCompletion
FIRRemoteConfigFetchStatus
RemoteConfigFetchStatus
FIRRemoteConfigError
RemoteConfigError
FIRRemoteConfigSource
RemoteConfigSource
Storage
put(_:)
putData(_:)
put(_:metadata:)
putData(_:metadata:)
put(_:metadata:completion:)
putData(_:metadata:completion:)
putFile(_:)
putFile(from:)
putFile(_:metadata:)
putFile(from:metadata:)
putFile(_:metadata:completion:)
putFile(from:metadata:completion:)
data(withMaxSize:completion:)
getData(maxSize:completion:)
metadata(completion:)
getMetadata(completion:)
update(_:completion:)
updateMetadata(_:completion:)
FIRStorage
Storage
FIRStorageDownloadTask
StorageDownloadTask
FIRStorageMetadata
StorageMetadata
FIRStorageObservableTask
StorageObservableTask
FIRStorageReference
StorageReference
FIRStorageTask
StorageTask
FIRStorageTaskSnapshot
StorageTaskSnapshot
FIRStorageUploadTask
StorageUploadTask
FIRStorageErrorDomain
StorageErrorDomain
FIRStorageTaskStatus
StorageTaskStatus
FIRStorageErrorCode
StorageErrorCode
FIRStorageTaskManagement
StorageTaskManagement
FIRStorageHandle
StorageHandle
FIRStorageVoidDataError
StorageVoidDataError
FIRStorageVoidError
StorageVoidError
FIRStorageVoidMetadata
StorageVoidMetadata
FIRStorageVoidMetadataError
StorageVoidMetadataError
FIRStorageVoidSnapshot
StorageVoidSnapshot
FIRStorageVoidURLError
StorageVoidURLError

