[FR] Expose `link` / `link_android` in notifications for deep linking

Open
#1,142 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
45/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Quiet
Tech stack
firebase, java

Research direction

Start by locating the Notification and AndroidNotification classes and the HTTP API payload mapping. Review how existing notification properties are serialized, then determine how link and link_android should map to gcm.n.link and gcm.n.link_android. Done means the officially supported fields produce the required deep-link notification payloads.

Written by the indexing model from the issue text.

Description

needs-triage type: feature request
Problem statement

Deep linking on Android requires the data field in the Intent to be set. As described in this SO post or firebase/firebase-android-sdk#6703, the only way to populate the the field in notifications created automatically by the Firebase Android SDK (when the app is in the background) is by setting the gcm.n.link or gcm.n.link_android keys in data, which have reserved prefixes and are therefore not supposed to be used (although setting them works, at least today).

Originally posted by @lehcar09 in #6703:

Alternatively, we can file a feature request to support the link or link_android field. I’ll get back to you once I hear back from them.

So, this is the FR to officially support these :)

Strawman

A strawman proposal would be to add link properties to the Notification / AndroidNotification classes, which would then be mapped to gcm.n.link / gcm.n.link_android in the JSON payload. Equivalently, in the HTTP API instead of this:

{
  "message": {
    "notification": {
      "title": "Lorem",
      "body": "Ipsum"
    },
    "data": {
      "gcm.n.link": "app://deep/link"
    },
  }
}

It would be this:

{
  "message": {
    "notification": {
      "title": "Lorem",
      "body": "Ipsum",
      "link": "app://deep/link"
    }
  }
}

or this:

{
  "message": {
    "android": {
      "notification": {
        "title": "Lorem",
        "body": "Ipsum",
        "link": "app://deep/link"
      }
    }
  }
}
Alternatives

The workaround suggested here of using setAction doesn't work, because actions needs to be declared in the Android manifest in order to match the intent, which conflicts with dynamically registering deep link targets.

Thanks!

Dominant language
Java
Stars
620
Forks
305
Avg merge
3h 23m
Merged PRs (30d)
1

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from firebase/firebase-admin-java

All issues in firebase/firebase-admin-java

Similar issues

More Java issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.