Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Don't set backgroundImageLayout if device is Android 12 or higher #1495

Merged
merged 2 commits into from
Dec 9, 2021

Conversation

emawby
Copy link
Contributor

@emawby emawby commented Dec 7, 2021

Description

One Line Summary

Don't set backgroundImageLayout if device is Android 12 or higher

Details

Documentation for Android Background Images
We currently add the backgroundImageLayout in the addBackgroundImage method of GenerateNotification.java

We are now checking for the device SDK version being less than 31 (s) and returning early if >= 31.

Motivation

Android 12+ changed the "Customizable Area" within notifications. So background images will look different and we recommend creating your own custom layout to handle this. Therefore we have decided to disable background image layouts for devices on Android 12+.

Scope

Notification appearance for Android 12+ devices only.

Testing

Unit testing

OPTIONAL - Explain unit tests added, if not clear in the code.

Manual testing

RECOMMEND - OPTIONAL - Explain what scenarios were tested and the environment.
Example: Tested opening a notification while the app was foregrounded, app build with Android Studio 2020.3 with a fresh install of the OneSignal example app on a Pixel 6 with Android 12.

Affected code checklist

  • Notifications
    • Display
    • Open
    • Push Processing
    • Confirm Deliveries
  • Outcomes
  • Sessions
  • In-App Messaging
  • REST API requests
  • Public API changes

Checklist

Overview

  • I have filled out all REQUIRED sections above
  • PR does one thing
    • If it is hard to explain how any codes changes are related to each other then it most likely needs to be more than one PR
  • Any Public API changes are explained in the PR details and conform to existing APIs

Testing

  • I have included test coverage for these changes, or explained why they are not needed
  • All automated tests pass, or I explained why that is not possible
  • I have personally tested this on my device, or explained why that is not possible

Final pass

  • Code is as readable as possible.
    • Simplify with less code, followed by splitting up code into well named functions and variables, followed by adding comments to the code.
  • I have reviewed this PR myself, ensuring it meets each checklist item
    • WIP (Work In Progress) is ok, but explain what is still in progress and what you would like feedback on. Start the PR title with "WIP" to indicate this.

This change is Reviewable

Copy link
Member

@jkasten2 jkasten2 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

PR looks good to me.

Tests failed but looks to be due to a flaky one, I kicked off another run.

Reviewed 3 of 3 files at r1, all commit messages.
Reviewable status: :shipit: complete! all files reviewed, all discussions resolved (waiting on @emawby)

@emawby emawby merged commit f968db4 into main Dec 9, 2021
@emawby emawby deleted the sunset_background_image_layout branch December 9, 2021 16:39
@jkasten2 jkasten2 mentioned this pull request Jan 7, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants