(DOCSP-34476) Add cancellationToken parameter to Session.wait methods [Dart/Flutter]

[krollins-mdb]

Pull Request Info

Jira ticket: https://jira.mongodb.org/browse/DOCSP-34476
Staged link: Manage a Sync Session: Added example for using cancellationToken.

Reminder Checklist

Before merging your PR, make sure to check a few things.

• Did you tag pages appropriately?
  • genre
  • meta.keywords
  • meta.description
• Describe your PR's changes in the Release Notes section
• Create a Jira ticket for related docs-app-services work, if any

Release Notes

• Flutter SDK
  • Sync/Manage A Sync Session: Add cancellationToken parameter to Session.wait methods.

Review Guidelines

REVIEWING.md

Animal Wearing a Hat

[github-actions]

Readability for Commit Hash: 37551dc

You can see any previous Readability scores (if they exist) by looking
at the comment's history.

Readability scores for changed documents:

• source/sdk/flutter/sync/manage-sync-session: Grade Level: 9.8, Reading Ease: 43.69

For Grade Level, aim for 8 or below.

For Reading Ease scores, aim for 60 or above:

Score	Difficulty
90-100	Very Easy
80-89	Easy
70-79	Fairly Easy
60-69	Medium
50-59	Fairly Hard
30-49	Hard
0-29	Very Hard

For help improving readability, try Hemingway App.

[dacharyc]

Overall, this LGTM. I do wonder if we should show this example with a TimeoutCancellationToken since I imagine that's probably the most common use case. But if folks follow the API reference link, they'll see that it's an option. I don't feel strongly so I'll let you decide if that makes sense or if you just want to wrap this up.

[krollins-mdb]

Hmm. I do think an example with TimeoutCancellationToken would be better, but I also think "good enough" works for now.

If we have the time and resources to polish the Dart/Flutter docs in the future, I'd like to see this concept addressed in more depth.

[docs-builder-bot]

✨ Staging URL: https://preview-mongodbmongodb.gatsbyjs.io/realm/master/

🪵 Logs

• job log: e12dc2951587915efddb47955805ea54c1022fb2