Skip to content
This repository has been archived by the owner on Mar 14, 2024. It is now read-only.

Document device sleep and persistence behaviour of alarms API #7776

Merged
merged 4 commits into from
Nov 14, 2023

Conversation

oliverdunk
Copy link
Member

Adds some documentation on more nuanced behaviour in the chrome.alarms API.

The wording here is quite vague but unfortunately I think it's the best we can do at the moment. There are several open issues around the behaviour we are close to resolving but which are still open:

While we could wait for those to be resolved, I think it's important we at least document the current behaviour since this is a heavily used API and the fixes may take time.

Fixes https://github.com/GoogleChromeLabs/Extension-Docs/issues/167

@oliverdunk oliverdunk added the extensions Issues related to extensions documentation. label Nov 9, 2023
@chrome-devrel-infra
Copy link

chrome-devrel-infra bot commented Nov 9, 2023

✅ Preview (static) for commit 29f962f available at https://pr-7776-static-dot-dcc-staging.uc.r.appspot.com/.

The following pages likely changed with this PR:

Copy link
Collaborator

@AmySteam AmySteam left a comment

Choose a reason for hiding this comment

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

Great additions! I made a suggestion that would be good to apply before merging. I'm approving nevertheless to not be a blocker

site/en/docs/extensions/reference/alarms/index.md Outdated Show resolved Hide resolved
Co-authored-by: amysteamdev <37001393+AmySteam@users.noreply.github.com>
@oliverdunk oliverdunk merged commit e0045d7 into main Nov 14, 2023
11 checks passed
@oliverdunk oliverdunk deleted the alarms-clarification branch November 14, 2023 13:46
sebastianbenz pushed a commit to sebastianbenz/developer.chrome.com that referenced this pull request Nov 14, 2023
…Chrome#7776)

* Document device sleep and persistence behaviour of alarms API

* Address feedback

* Add example code

* Update site/en/docs/extensions/reference/alarms/index.md

Co-authored-by: amysteamdev <37001393+AmySteam@users.noreply.github.com>

---------

Co-authored-by: amysteamdev <37001393+AmySteam@users.noreply.github.com>
sebastianbenz pushed a commit to sebastianbenz/developer.chrome.com that referenced this pull request Nov 14, 2023
…Chrome#7776)

* Document device sleep and persistence behaviour of alarms API

* Address feedback

* Add example code

* Update site/en/docs/extensions/reference/alarms/index.md

Co-authored-by: amysteamdev <37001393+AmySteam@users.noreply.github.com>

---------

Co-authored-by: amysteamdev <37001393+AmySteam@users.noreply.github.com>
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
extensions Issues related to extensions documentation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants