Skip to content

Latest commit

 

History

History
70 lines (57 loc) · 2.91 KB

README.md

File metadata and controls

70 lines (57 loc) · 2.91 KB
Raw

Parse SDK Android FCM

FCM support for Parse Android apps

Setup

Installation

After including JitPack:

dependencies {
    implementation "com.github.parse-community.Parse-SDK-Android:parse:latest.version.here"
    implementation "com.github.parse-community.Parse-SDK-Android:fcm:latest.version.here"
}

Then, follow Google's docs for setting up an Firebase app. Although the steps are different for setting up FCM with Parse, it is also a good idea to read over the Firebase FCM Setup.

You will then need to register some things in your manifest, specifically:

<service
    android:name="com.parse.fcm.ParseFirebaseInstanceIdService"
    android:exported="true">
    <intent-filter>
        <action android:name="com.google.firebase.INSTANCE_ID_EVENT" />
    </intent-filter>
</service>

Additional, you will register:

<service
    android:name="com.parse.fcm.ParseFirebaseMessagingService"
    <intent-filter>
        <action android:name="com.google.firebase.MESSAGING_EVENT"/>
    </intent-filter>
</service>

After these services are registered in the Manifest, you then need to register your push broadcast receiver:

<receiver
    android:name="com.parse.ParsePushBroadcastReceiver"
    android:exported="false">
    <intent-filter>
        <action android:name="com.parse.push.intent.RECEIVE" />
        <action android:name="com.parse.push.intent.DELETE" />
        <action android:name="com.parse.push.intent.OPEN" />
    </intent-filter>
</receiver>

After this, you are all set. Adding the parse-fcm-android package will include a ParseFirebaseJobService in the AndroidManifest.xml file that will register for a FCM token when the app starts. You should see ParseFCM: FCM registration success messages assuming you have enabled logging:

Parse.setLogLevel(Parse.LOG_LEVEL_DEBUG);

Custom Notifications

If you need to customize the notification that is sent out from a push, you can do so easily by extending ParsePushBroadcastReceiver with your own class and registering it instead in the Manifest.

Instance ID Service

If you need to store the FCM token elsewhere outside of Parse, you can create your own implementation of the FirebaseInstanceIdService, just make sure you are either extending ParseFirebaseInstanceIdService or are calling ParseFCM.register(getApplicationContext()); in the onTokenRefresh method.

License

Copyright (c) 2015-present, Parse, LLC.
All rights reserved.

This source code is licensed under the BSD-style license found in the
LICENSE file in the root directory of this source tree. An additional grant
of patent rights can be found in the PATENTS file in the same directory.