Skip to content

[fix]: fixed notification docs expected parameters #2917

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Sep 21, 2024
Merged

[fix]: fixed notification docs expected parameters #2917

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -525,9 +525,9 @@ When a regex is defined then `console.error` output from the adapter is always c
The host supports the __message__ command `getNotifications` to query the stored notifications together with the localized names and descriptions.

The message needs to take the following parameters in the message object:
* scopeFilter - scope of notifications
* categoryFilter - category of notifications
* instanceFilter - instance of notifications
* `scope` - scope of notifications
* `category` - category of notifications
* `instance` - instance of notifications

All three are optional and can be a string or null/undefined if omitted.

Expand All @@ -537,9 +537,9 @@ The host supports the __message__ command `clearNotifications` to clear specific
**Please only clear notifications that really were handled and displayed to the user especially for "system" scope!**

The message needs to take the following parameters in the message object:
* scopeFilter - scope of notifications
* categoryFilter - category of notifications
* instanceFilter - instance of notifications
* `scope` - scope of notifications
* `category` - category of notifications
* `instance` - instance of notifications

All three are optional and can be a string or null/undefined if omitted.

Expand Down