-
Notifications
You must be signed in to change notification settings - Fork 95
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
Doc for in app prompts #2077
Doc for in app prompts #2077
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for improving these!
Left comments but happy to merge and get them addressed in future PRs.
.../watch/src/main/java/com/google/android/horologist/datalayer/watch/WearDataLayerAppHelper.kt
Show resolved
Hide resolved
docs/datalayer-sample.md
Outdated
|
||
The goal of this sample is to show how to use the DataLayer helpers both on phone and watch. | ||
In order to be able to demo all the features, you need to install the sample both on the watch and | ||
on the phone |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
on the phone | |
on the phone. |
Use the `ReEngagePrompt` to build the UI of a prompt to ask the user to install the app on their watch. | ||
|
||
## SignIn prompt | ||
Use the `SignInPrompt` to build the UI of a prompt to ask the user to finish the sign in on the watch. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
there is "shouldDisplayPrompt" for Sign-In and Re-Engage, should them be added to the doc?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
added
The `shouldDisplayPrompt` method is relying on the capability defined in the wear.xml of the Wear app, if the Wear app is installed | ||
but hasn't been updated with the capability definition, this method may still return a `AppHelperNodeStatus` | ||
indicating that the Wear app is not installed. | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
should also add the performAction function
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done
5145a0b
to
2e51286
Compare
WHAT
Adds docs for in app prompts. Code is still evolving so will need a second pass soon after new features are merged.
WHY
It's missing documentation for the in app prompts
HOW
Creates some new doc pages
Checklist 📋