iOS/Pods/FirebaseMessaging/README.md

   1 # Firebase iOS Open Source Development [![Build Status](https://travis-ci.org/firebase/firebase-ios-sdk.svg?branch=master)](https://travis-ci.org/firebase/firebase-ios-sdk)
   2
   3 This repository contains a subset of the Firebase iOS SDK source. It currently
   4 includes FirebaseCore, FirebaseAuth, FirebaseDatabase, FirebaseFirestore,
   5 FirebaseFunctions, FirebaseMessaging and FirebaseStorage.
   6
   7 The repository also includes GoogleUtilities source. The
   8 [GoogleUtilities](GoogleUtilities/README.md) pod is
   9 a set of utilities used by Firebase and other Google products.
  10
  11 Firebase is an app development platform with tools to help you build, grow and
  12 monetize your app. More information about Firebase can be found at
  13 [https://firebase.google.com](https://firebase.google.com).
  14
  15 ## Installation
  16
  17 See the three subsections for details about three different installation methods.
  18 1. [Standard pod install](README.md#standard-pod-install)
  19 1. [Installing from the GitHub repo](README.md#installing-from-github)
  20 1. [Experimental Carthage](README.md#carthage-ios-only)
  21
  22 ### Standard pod install
  23
  24 Go to
  25 [https://firebase.google.com/docs/ios/setup](https://firebase.google.com/docs/ios/setup).
  26
  27 ### Installing from GitHub
  28
  29 For releases starting with 5.0.0, the source for each release is also deployed
  30 to CocoaPods master and available via standard
  31 [CocoaPods Podfile syntax](https://guides.cocoapods.org/syntax/podfile.html#pod).
  32
  33 These instructions can be used to access the Firebase repo at other branches,
  34 tags, or commits.
  35
  36 #### Background
  37
  38 See
  39 [the Podfile Syntax Reference](https://guides.cocoapods.org/syntax/podfile.html#pod)
  40 for instructions and options about overriding pod source locations.
  41
  42 #### Accessing Firebase Source Snapshots
  43
  44 All of the official releases are tagged in this repo and available via CocoaPods. To access a local
  45 source snapshot or unreleased branch, use Podfile directives like the following:
  46
  47 To access FirebaseFirestore via a branch:
  48 ```
  49 pod 'FirebaseCore', :git => 'https://github.com/firebase/firebase-ios-sdk.git', :branch => 'master'
  50 pod 'FirebaseFirestore', :git => 'https://github.com/firebase/firebase-ios-sdk.git', :branch => 'master'
  51 ```
  52
  53 To access FirebaseMessaging via a checked out version of the firebase-ios-sdk repo do:
  54
  55 ```
  56 pod 'FirebaseCore', :path => '/path/to/firebase-ios-sdk'
  57 pod 'FirebaseMessaging', :path => '/path/to/firebase-ios-sdk'
  58 ```
  59
  60 ### Carthage (iOS only)
  61
  62 An experimental Carthage distribution is now available. See
  63 [Carthage](Carthage.md).
  64
  65 ## Development
  66
  67 Follow the subsequent instructions to develop, debug, unit test, run integration
  68 tests, and try out reference samples:
  69
  70 ```
  71 $ git clone git@github.com:firebase/firebase-ios-sdk.git
  72 $ cd firebase-ios-sdk/Example
  73 $ pod update
  74 $ open Firebase.xcworkspace
  75 ```
  76
  77 Firestore and Functions have self contained Xcode projects. See
  78 [Firestore/README.md](Firestore/README.md) and
  79 [Functions/README.md](Functions/README.md).
  80
  81 ### Running Unit Tests
  82
  83 Select a scheme and press Command-u to build a component and run its unit tests.
  84
  85 ### Running Sample Apps
  86 In order to run the sample apps and integration tests, you'll need valid
  87 `GoogleService-Info.plist` files for those samples. The Firebase Xcode project contains dummy plist
  88 files without real values, but can be replaced with real plist files. To get your own
  89 `GoogleService-Info.plist` files:
  90
  91 1. Go to the [Firebase Console](https://console.firebase.google.com/)
  92 2. Create a new Firebase project, if you don't already have one
  93 3. For each sample app you want to test, create a new Firebase app with the sample app's bundle
  94 identifier (e.g. `com.google.Database-Example`)
  95 4. Download the resulting `GoogleService-Info.plist` and replace the appropriate dummy plist file
  96 (e.g. in [Example/Database/App/](Example/Database/App/));
  97
  98 Some sample apps like Firebase Messaging ([Example/Messaging/App](Example/Messaging/App)) require
  99 special Apple capabilities, and you will have to change the sample app to use a unique bundle
 100 identifier that you can control in your own Apple Developer account.
 101
 102 ## Specific Component Instructions
 103 See the sections below for any special instructions for those components.
 104
 105 ### Firebase Auth
 106
 107 If you're doing specific Firebase Auth development, see
 108 [AuthSamples/README.md](AuthSamples/README.md) for instructions about
 109 building and running the FirebaseAuth pod along with various samples and tests.
 110
 111 ### Firebase Database
 112
 113 To run the Database Integration tests, make your database authentication rules
 114 [public](https://firebase.google.com/docs/database/security/quickstart).
 115
 116 ### Firebase Storage
 117
 118 To run the Storage Integration tests, follow the instructions in
 119 [FIRStorageIntegrationTests.m](Example/Storage/Tests/Integration/FIRStorageIntegrationTests.m).
 120
 121 #### Push Notifications
 122
 123 Push notifications can only be delivered to specially provisioned App IDs in the developer portal.
 124 In order to actually test receiving push notifications, you will need to:
 125
 126 1. Change the bundle identifier of the sample app to something you own in your Apple Developer
 127 account, and enable that App ID for push notifications.
 128 2. You'll also need to
 129 [upload your APNs Provider Authentication Key or certificate to the Firebase Console](https://firebase.google.com/docs/cloud-messaging/ios/certs)
 130 at **Project Settings > Cloud Messaging > [Your Firebase App]**.
 131 3. Ensure your iOS device is added to your Apple Developer portal as a test device.
 132
 133 #### iOS Simulator
 134
 135 The iOS Simulator cannot register for remote notifications, and will not receive push notifications.
 136 In order to receive push notifications, you'll have to follow the steps above and run the app on a
 137 physical device.
 138
 139 ## Community Supported Efforts
 140
 141 We've seen an amazing amount of interest and contributions to improve the Firebase SDKs, and we are
 142 very grateful!  We'd like to empower as many developers as we can to be able to use Firebase and
 143 participate in the Firebase community.
 144
 145 ### macOS and tvOS
 146 FirebaseAuth, FirebaseCore, FirebaseDatabase and FirebaseStorage now compile, run unit tests, and
 147 work on macOS and tvOS, thanks to contributions from the community. There are a few tweaks needed,
 148 like ensuring iOS-only, macOS-only, or tvOS-only code is correctly guarded with checks for
 149 `TARGET_OS_IOS`, `TARGET_OS_OSX` and `TARGET_OS_TV`.
 150
 151 For tvOS, checkout the [Sample](Example/tvOSSample).
 152
 153 Keep in mind that macOS and tvOS are not officially supported by Firebase, and this repository is
 154 actively developed primarily for iOS. While we can catch basic unit test issues with Travis, there
 155 may be some changes where the SDK no longer works as expected on macOS or tvOS. If you encounter
 156 this, please [file an issue](https://github.com/firebase/firebase-ios-sdk/issues).
 157
 158 For installation instructions, see [above](README.md#accessing-firebase-source-snapshots).
 159
 160 Note that the Firebase pod is not available for macOS and tvOS. Install a selection of the
 161 `FirebaseAuth`, `FirebaseCore`, `FirebaseDatabase` and `FirebaseStorage` CocoaPods.
 162
 163 ## Roadmap
 164
 165 See [Roadmap](ROADMAP.md) for more about the Firebase iOS SDK Open Source
 166 plans and directions.
 167
 168 ## Contributing
 169
 170 See [Contributing](CONTRIBUTING.md) for more information on contributing to the Firebase
 171 iOS SDK.
 172
 173 ## License
 174
 175 The contents of this repository is licensed under the
 176 [Apache License, version 2.0](http://www.apache.org/licenses/LICENSE-2.0).
 177
 178 Your use of Firebase is governed by the
 179 [Terms of Service for Firebase Services](https://firebase.google.com/terms/).