ably-flutter icon indicating copy to clipboard operation
ably-flutter copied to clipboard

docs: update permission section in `PushNotifications` documentation

Open ttypic opened this issue 1 year ago โ€ข 1 comments

Updated permission section in PushNotifications documentation:

  • added recommendation to use permission_handler package
  • marked old iOS only solution as deprecated
  • add link to the refactoring issue

Summary by CodeRabbit

  • Documentation
    • Enhanced guidance on notification permissions management, recommending the permission_handler Flutter package for cross-platform support.
    • Added example code for requesting notification permissions on both iOS and Android.
    • Included a deprecation notice for the built-in notification permissions management on iOS.
    • Noted upcoming utility function for simplified notification permissions handling within the SDK.

ttypic avatar Sep 18 '24 10:09 ttypic

Walkthrough

The changes expand and restructure the PushNotifications.md documentation to cover notification permissions on both iOS and Android. It recommends the permission_handler Flutter package for cross-platform permission requests, marks the built-in iOS-only permission method as deprecated, and notes a forthcoming SDK utility for unified permission handling.

Changes

Files Change Summary
PushNotifications.md - Expanded notification permissions section to include Android and iOS.
- Recommended permission_handler Flutter package with example code for requesting permissions.
- Deprecated built-in iOS-only notification permission request method with warning and explanation.
- Added note about upcoming SDK utility function for cross-platform notification permission management.

Poem

In the meadow where bunnies play,
Permissions now lead the way! ๐Ÿ‡โœจ
With flutter-permission-handler in sight,
Notifications will work just right.
A hop, a skip, to code we go,
Simplified paths, watch our skills grow! ๐ŸŒผ


๐Ÿ“œ Recent review details

Configuration used: CodeRabbit UI Review profile: CHILL Plan: Pro

๐Ÿ“ฅ Commits

Reviewing files that changed from the base of the PR and between 718964dfef44633999ab087223d1e63b0035577d and 66489ffe808eccb1a3d8d61ec5486f69dfdffa96.

๐Ÿ“’ Files selected for processing (1)
  • PushNotifications.md (2 hunks)
โœ… Files skipped from review due to trivial changes (1)
  • PushNotifications.md
โฐ Context from checks skipped due to timeout of 90000ms (5)
  • GitHub Check: android (29)
  • GitHub Check: android
  • GitHub Check: android (24)
  • GitHub Check: ios (iPhone 15)
  • GitHub Check: ios
โœจ Finishing Touches
๐Ÿงช Generate Unit Tests
  • [ ] Create PR with Unit Tests
  • [ ] Post Copyable Unit Tests in Comment
  • [ ] Commit Unit Tests in branch update-push-docs

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

โค๏ธ Share
๐Ÿชง Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai auto-generate unit tests to generate unit tests for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

coderabbitai[bot] avatar Sep 18 '24 10:09 coderabbitai[bot]