GcmListenerService.onMessageReceived not called

[void99]

Maybe not a proper place to post (not a demo issue), but could not find answer elsewhere: when sending both "data" and "notification" keys as payload notification is displayed but onMessageReceived method is not called. The method is properly called when "notification" key is removed from payload. What could be the cause?

[alibitek]

Indeed, this seems to be the case. I've tested with a payload as follows:

send_queue.append({'to': REGISTRATION_ID,
                   'message_id': random_id(),
                   "notification" : {
                      "body" : "Hello from Server! What's going?",
                      "title" : "Hello from Server!",
                      "icon" : "@drawable/ic_school_white_48dp",
                      "sound": "default",
                      "color": "#03A9F4"
                    },
                   'data': { 'message': "Hello" } })

The notification is displayed by the system, but the onMessageReceived(String from, Bundle data) method of the GcmListenerService implemention doesn't get called

In AndroidManifest.xml MyGcmListenerService is defined as follows:

 <!-- [START gcm_listener] -->
        <service
            android:name="com.company.myapp.service.MyGcmListenerService"
            android:exported="false" >
            <intent-filter>
                <action android:name="com.google.android.c2dm.intent.RECEIVE" />
            </intent-filter>
        </service>
        <!-- [END gcm_listener] -->

The server reference payload docs (https://developers.google.com/cloud-messaging/server#payload) says:
The app server can send a message including both notifications and data payloads. In such cases, GCM handles displaying the notification payload and the client app handles the data payload.

The "the client app handles the data payload" part doesn't work.
If I remove the notification key from the payload the method on the receiver is called.

[alibitek]

@void99

I think I found what's "the problem"

From https://developers.google.com/cloud-messaging/server#notifications_and_data_messages
"GCM will display the notification part on the client app’s behalf. When optional data is provided, it is sent to the client app once user clicks on the notification and opens the client app.
[...] On Android, data payload can be retrieved in the Intent used to launch your activity."

So, the data is passed in the intent used to launch the activity, once the user clicks on the notification.
This means you need to do the following:

• Add a click_action to the notification key you send from the server:
  e.g.

send_queue.append({'to': REGISTRATION_ID,
                   'message_id': random_id(),
                   "notification" : {
                      "body" : "Hello from Server! What is going on? Seems to work!!!",
                      "title" : "Hello from Server!",
                      "icon" : "@drawable/ic_school_white_48dp",
                      "sound": "default",
                      "color": "#03A9F4",
                      "click_action": "OPEN_MAIN_ACTIVITY"
                    },
                   'data': { 'message': "Hello" } })

See the reference for notification payload at: https://developers.google.com/cloud-messaging/server-ref#notification-payload-support

• In AndroidManifest.xml add an intent filter on the activity you want to be opened once the user clicks on the notification, with the same action name you used on the "click_action" key on the server side
  e.g.

         <activity
            android:name=".ui.MainActivity"
            android:label="@string/title_activity_main" >
            <intent-filter>
                <action android:name="OPEN_MAIN_ACTIVITY" />
                <category android:name="android.intent.category.DEFAULT" />
            </intent-filter>
        </activity>

• Get the data from the intent on your onCreate() method or on onNewIntent() if you've set the launchMode to singleTop for the activity you want to launch when the notification is clicked.
  e.g.

@Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);

        Intent intent = getIntent();

        if (intent.hasExtra(Constants.KEY_MESSAGE_TXT)) {
            String message = intent.getStringExtra(Constants.KEY_MESSAGE_TXT);
            Log.d(TAG, message);
        }
}

I've tested this and can confirm that it works. (using XMPP connection)

[void99]

Thanks for Your explanation. But imo the implementation is kind of awkward. If the user dismisses the notification, the data will never be passed to application. Or am i missing something?

[alibitek]

Yes, that's the downside of letting the system handle the notification.

[ZakTaccardi]

So what if I want the iOS app to use the notification payload, and the android app to use the data payload for displaying the notification? Seems like I am SoL.

Also, the notification icon is very limiting. On Lollipop, you cannot use a complex icon because it is automatically forced into a single color (makes the icon all white in my case. This doesn't seem right.

[joelSimpson]

I'm currently experiencing a consistent InternalServerError when trying to push a payload with the notification tag. I need this for my iOS app to display a banner notification when the app is in the background.

[StephenStrickland]

+1 having similar issues as well.

[afjackman]

@void99 Why is this closed? This problem pretty much makes it impossible to route iOS and Android traffic together through GCM if you want any processing to occur.

@joelSimpson and @StephenStrickland Make sure both body & title are set in the notification field. iOS doesn't use the title tag but it's required in order to send and may be the reason for this issue you're both having.

EDIT: Unfortunately, I'm now seeing the InternalServerError again. The above suggestion doesn't fix the problem.

[wildseansy]

Having the same problem as @ZakTaccardi trying to use Lollipop and support the same iOS notification body. This seems like it was overlooked.