docs: update permission section in PushNotifications documentation

[ttypic]

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 flutter-permission-handler package for cross-platform support.
  • Added example code for requesting notification permissions.
  • 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.

[coderabbitai]

Walkthrough

The changes enhance the PushNotifications.md documentation by clarifying the use of third-party libraries for managing notification permissions, specifically recommending the flutter-permission-handler package. It includes detailed implementation instructions and an example for requesting permissions. Additionally, a deprecation notice for the built-in iOS notification permissions management is provided, along with a note about future utility functions for simplifying permission handling within the SDK.

Changes

Files	Change Summary
PushNotifications.md	- Added recommendation for flutter-permission-handler for managing notification permissions.
	- Included example code snippet for requesting notification permissions using permission_handler.
	- Added deprecation notice for built-in notification permissions management in iOS.
	- Noted upcoming utility function for notification permissions within the SDK.

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! 🌼

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

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.
  -- Generate unit testing code for this file.
  • 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 generate unit testing code for this file.
  -- @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 generate interesting stats about this repository and render them as a table.
  -- @coderabbitai read src/utils.ts and generate unit testing code.
  -- @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.

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 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.

Tip

Early access features: enabled

We are currently testing the following features in early access:

• OpenAI o1 for code reviews: OpenAI's new o1 model is being tested for code reviews. This model has advanced reasoning capabilities and can provide more nuanced feedback on your code.

Note:

• You can enable or disable early access features from the CodeRabbit UI or by updating the CodeRabbit configuration file.
• • Please join our Discord Community to provide feedback and report issues on the discussion post.

[coderabbitai]

Actionable comments posted: 4

Outside diff range and nitpick comments (3)

PushNotifications.md (3)

192-193: Ensure Consistent Heading Capitalization

The heading "Notification Permissions using permission_handler package" should use Title Case for consistency with the rest of the document. Consider capitalizing "Using" to match the style of other headings.

Apply this diff to correct the heading capitalization:

-#### Notification Permissions using `permission_handler` package
+#### Notification Permissions Using `permission_handler` Package

---

194-194: Remove Extra Space Between Words

There's an extra space between "the" and the [flutter-permission-handler] link. Removing it will improve readability.

Apply this diff:

-However, we recommend using the  [flutter-permission-handler](https://github.com/baseflow/flutter-permission-handler) package due to its reliable cross-platform support for both iOS and Android.
+However, we recommend using the [flutter-permission-handler](https://github.com/baseflow/flutter-permission-handler) package due to its reliable cross-platform support for both iOS and Android.

---

216-216: Ensure Consistent Heading Capitalization

For consistency, capitalize "iOS Only" in the heading.

Apply this diff:

-#### Built-in Notification Permissions Management (iOS only)
+#### Built-in Notification Permissions Management (iOS Only)

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between c6a780f and 76949d8.

Files selected for processing (1)

• PushNotifications.md (2 hunks)

[coderabbitai]

Actionable comments posted: 0

Outside diff range and nitpick comments (1)

PushNotifications.md (1)

Line range hint 229-254: Update documentation to reflect deprecation of Push#requestPermission method

After marking the Push#requestPermission method as deprecated, the documentation should be updated to guide users towards the recommended alternative for handling notification permissions on iOS. Continuing to instruct users to use a deprecated method may cause confusion.

Apply this diff to update the documentation:

-// Create an Ably client to access the push field
-final realtime = ably.Realtime(options: clientOptions);
-final push = realtime.push;
-// Request permission from user on iOS
-bool permissionGranted = await push.requestPermission();
-// Get more information about the notification settings
-if (Platform.isIOS) {
-  final notificationSettings = await realtime.push.getNotificationSettings();
-}
+// Request notification permission
+PermissionStatus status = await Permission.notification.request();
+
+if (status.isGranted) {
+  // Handle permission granted
+} else {
+  // Handle permission denied
+}

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 76949d8 and 718964d.

Files selected for processing (1)

• PushNotifications.md (2 hunks)