Skip to content
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

Merged
merged 1 commit into from
Feb 29, 2024
Merged

Doc for in app prompts #2077

merged 1 commit into from
Feb 29, 2024

Conversation

kul3r4
Copy link
Collaborator

@kul3r4 kul3r4 commented Feb 28, 2024

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 📋

  • Add explicit visibility modifier and explicit return types for public declarations
  • Run spotless check
  • Run tests
  • Update metalava's signature text files

Copy link
Member

@luizgrp luizgrp left a 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.

docs/datalayer-helpers-guide.md Show resolved Hide resolved
docs/datalayer-sample.md Outdated Show resolved Hide resolved

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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
on the phone
on the phone.

docs/datalayer.md Outdated Show resolved Hide resolved
docs/datalayer.md Show resolved Hide resolved
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.
Copy link
Member

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?

Copy link
Collaborator Author

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.

Copy link
Member

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

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

@kul3r4 kul3r4 merged commit 565a1e6 into google:main Feb 29, 2024
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants