[interactive_media_ads] Updates README with a usage section and fix some interface docs
#6988
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
bparrishMines
commented
Jun 25, 2024
There was a problem hiding this comment.
Convenience link to see preview: https://github.com/bparrishMines/packages/blob/ima_readme/packages/interactive_media_ads/README.md
bparrishMines
changed the title
README with a usage section and fix some interface docs
stuartmorgan
approved these changes
Jun 27, 2024
|
|
||
| 1. Add Android Required Permissions | ||
|
|
||
| If building on Android, add the user permissions required by the IMA SDK for requesting ads in |
There was a problem hiding this comment.
If you are going to use a bulleted list for the headings, I would make all of the content part of the list (by indenting everything in this entire section by two spaces), so that the content of each section isn't offset further left than its heading.
Alternatively, you could do ### 1. Add Android Required Permissions, etc.
| @@ -7,7 +7,7 @@ import 'package:flutter/cupertino.dart'; | |||
| import 'platform_interface/platform_ad_display_container.dart'; | |||
| import 'platform_interface/platform_interface.dart'; | |||
|
|
|||
| /// Handles playing ads after they've been received from the server. | |||
| /// A `Widget` for displaying loaded ads. | |||
| @@ -92,6 +93,10 @@ class AdsLoader { | |||
| } | |||
|
|
|||
| /// Requests ads from a server. | |||
| /// | |||
| /// Note that ads cannot be request until the `AdDisplayContainer` has been | |||
There was a problem hiding this comment.
Just "Ads cannot be [...]", per Flutter style guide, per https://github.com/flutter/flutter/blob/master/docs/contributing/Style-guide-for-Flutter-repo.md#avoid-empty-prose
| @@ -92,6 +93,10 @@ class AdsLoader { | |||
| } | |||
|
|
|||
| /// Requests ads from a server. | |||
| /// | |||
| /// Note that ads cannot be request until the `AdDisplayContainer` has been | |||
bparrishMines
added
the
autosubmit
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/flutter
that referenced
this pull request
Jun 27, 2024
… and fix some interface docs (flutter/packages#6988)
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/flutter
that referenced
this pull request
Jun 27, 2024
… and fix some interface docs (flutter/packages#6988)
engine-flutter-autoroll
added a commit
to engine-flutter-autoroll/flutter
that referenced
this pull request
Jun 28, 2024
… and fix some interface docs (flutter/packages#6988)
auto-submit bot
pushed a commit
to flutter/flutter
that referenced
this pull request
Jun 28, 2024
flutter/packages@03f5f6d...412ec46 2024-06-28 49699333+dependabot[bot]@users.noreply.github.com Bump github/codeql-action from 3.25.6 to 3.25.10 (flutter/packages#6924) 2024-06-27 [email protected] [video_player] Exposes VideoPlayerWebOptions. (flutter/packages#6990) 2024-06-27 [email protected] [ci] Add Wasm compilation to all_packages web app. (flutter/packages#6981) 2024-06-27 [email protected] [interactive_media_ads] Updates `README` with a usage section and fix some interface docs (flutter/packages#6988) 2024-06-27 [email protected] [tools] Fix vm test requirement (flutter/packages#6995) 2024-06-27 [email protected] Update `web_benchmarks` package to properly support wasm. (flutter/packages#6970) 2024-06-27 [email protected] [pigeon] Implement equals for Java data classes (flutter/packages#6992) 2024-06-25 [email protected] Final refactor of `video_player_android` before `SurfaceProducer#setCallback`. (flutter/packages#6982) 2024-06-25 [email protected] [pigeon] Update testing and docs (flutter/packages#6984) 2024-06-25 [email protected] [various] Update flutter.dev links to more reliable destinations (flutter/packages#6963) 2024-06-25 [email protected] [interactive_media_ads] Adds initial Android implementation (flutter/packages#6733) 2024-06-25 [email protected] Roll Flutter from 6c06abb to e726eb4 (51 revisions) (flutter/packages#6987) If this roll has caused a breakage, revert this CL and stop the roller using the controls here: https://autoroll.skia.org/r/flutter-packages-flutter-autoroll Please CC [email protected],[email protected] on the revert to ensure that a human is aware of the problem. To file a bug in Flutter: https://github.com/flutter/flutter/issues/new/choose To report a problem with the AutoRoller itself, please file a bug: https://issues.skia.org/issues/new?component=1389291&template=1850622 Documentation for the AutoRoller is here: https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md
11 tasks
victorsanni
pushed a commit
to victorsanni/flutter
that referenced
this pull request
Jul 8, 2024
flutter/packages@03f5f6d...412ec46 2024-06-28 49699333+dependabot[bot]@users.noreply.github.com Bump github/codeql-action from 3.25.6 to 3.25.10 (flutter/packages#6924) 2024-06-27 [email protected] [video_player] Exposes VideoPlayerWebOptions. (flutter/packages#6990) 2024-06-27 [email protected] [ci] Add Wasm compilation to all_packages web app. (flutter/packages#6981) 2024-06-27 [email protected] [interactive_media_ads] Updates `README` with a usage section and fix some interface docs (flutter/packages#6988) 2024-06-27 [email protected] [tools] Fix vm test requirement (flutter/packages#6995) 2024-06-27 [email protected] Update `web_benchmarks` package to properly support wasm. (flutter/packages#6970) 2024-06-27 [email protected] [pigeon] Implement equals for Java data classes (flutter/packages#6992) 2024-06-25 [email protected] Final refactor of `video_player_android` before `SurfaceProducer#setCallback`. (flutter/packages#6982) 2024-06-25 [email protected] [pigeon] Update testing and docs (flutter/packages#6984) 2024-06-25 [email protected] [various] Update flutter.dev links to more reliable destinations (flutter/packages#6963) 2024-06-25 [email protected] [interactive_media_ads] Adds initial Android implementation (flutter/packages#6733) 2024-06-25 [email protected] Roll Flutter from 6c06abb to e726eb4 (51 revisions) (flutter/packages#6987) If this roll has caused a breakage, revert this CL and stop the roller using the controls here: https://autoroll.skia.org/r/flutter-packages-flutter-autoroll Please CC [email protected],[email protected] on the revert to ensure that a human is aware of the problem. To file a bug in Flutter: https://github.com/flutter/flutter/issues/new/choose To report a problem with the AutoRoller itself, please file a bug: https://issues.skia.org/issues/new?component=1389291&template=1850622 Documentation for the AutoRoller is here: https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Part of flutter/flutter#134228
Pre-launch Checklist
dart format.)[shared_preferences]pubspec.yamlwith an appropriate new version according to the pub versioning philosophy, or this PR is exempt from version changes.CHANGELOG.mdto add a description of the change, following repository CHANGELOG style, or this PR is exempt from CHANGELOG changes.///).If you need help, consider asking for advice on the #hackers-new channel on Discord.