xref: /docs/en/application-dev/tools/anm-tool.md (revision e41f4b71)
1e41f4b71Sopenharmony_ci# Advanced Notification Manager
2e41f4b71Sopenharmony_ci
3e41f4b71Sopenharmony_ciThe Advanced Notification Manager enables you to print notifications and set notification parameters. It provides the notification debugging and testing capabilities, for example, printing published notification details, setting the number of notification caches, and enabling the notification functionality.
4e41f4b71Sopenharmony_ci
5e41f4b71Sopenharmony_ci> **NOTE**
6e41f4b71Sopenharmony_ci>
7e41f4b71Sopenharmony_ci> Before using this tool, you must obtain the <!--Del-->[<!--DelEnd-->hdc tool<!--Del-->](../../device-dev/subsystems/subsys-toolchain-hdc-guide.md)<!--DelEnd--> and run the hdc shell command.
8e41f4b71Sopenharmony_ci> 
9e41f4b71Sopenharmony_ci> This tool can be used only in the **eng** edition. If it is used in the **user** edition, the message **error: user version cannot use setting** is reported.
10e41f4b71Sopenharmony_ci
11e41f4b71Sopenharmony_ci
12e41f4b71Sopenharmony_ci## help
13e41f4b71Sopenharmony_ci
14e41f4b71Sopenharmony_ci* **Function**
15e41f4b71Sopenharmony_ci
16e41f4b71Sopenharmony_ci  Prints help information.
17e41f4b71Sopenharmony_ci
18e41f4b71Sopenharmony_ci* **Method**
19e41f4b71Sopenharmony_ci
20e41f4b71Sopenharmony_ci  ```bash
21e41f4b71Sopenharmony_ci  anm help
22e41f4b71Sopenharmony_ci  ```
23e41f4b71Sopenharmony_ci
24e41f4b71Sopenharmony_ci## dump
25e41f4b71Sopenharmony_ci
26e41f4b71Sopenharmony_ci* **Function**
27e41f4b71Sopenharmony_ci
28e41f4b71Sopenharmony_ci  Prints information about notifications.
29e41f4b71Sopenharmony_ci
30e41f4b71Sopenharmony_ci* **Method**
31e41f4b71Sopenharmony_ci
32e41f4b71Sopenharmony_ci  ```bash
33e41f4b71Sopenharmony_ci  anm dump [<options>]
34e41f4b71Sopenharmony_ci  ```
35e41f4b71Sopenharmony_ci
36e41f4b71Sopenharmony_ci  The table below describes the available options.
37e41f4b71Sopenharmony_ci
38e41f4b71Sopenharmony_ci  | Name            | Description                          |
39e41f4b71Sopenharmony_ci  | ---------------- | ---------------------------------- |
40e41f4b71Sopenharmony_ci  | -A/--active      | Information about all active notifications.            |
41e41f4b71Sopenharmony_ci  | -R/--recent      | Information about recent notifications.                |
42e41f4b71Sopenharmony_ci  | -D/--distributed | Information about distributed notifications from other devices.  |
43e41f4b71Sopenharmony_ci  | -b/--bundle      | Bundle name. Optional.|
44e41f4b71Sopenharmony_ci  | -u/--user-id     | User ID. Optional.    |
45e41f4b71Sopenharmony_ci  | -h/--help        | Help information.                          |
46e41f4b71Sopenharmony_ci
47e41f4b71Sopenharmony_ci* **Example**: Print information about active notifications.
48e41f4b71Sopenharmony_ci
49e41f4b71Sopenharmony_ci  ```bash
50e41f4b71Sopenharmony_ci  anm dump -A
51e41f4b71Sopenharmony_ci  ```
52e41f4b71Sopenharmony_ci  ![anm-dump-A](figures/anm-dump-A.png)
53e41f4b71Sopenharmony_ci
54e41f4b71Sopenharmony_ci## Setting
55e41f4b71Sopenharmony_ci
56e41f4b71Sopenharmony_ci* **Function**
57e41f4b71Sopenharmony_ci
58e41f4b71Sopenharmony_ci  Sets notification parameters.
59e41f4b71Sopenharmony_ci* **Method**
60e41f4b71Sopenharmony_ci
61e41f4b71Sopenharmony_ci  ```bash
62e41f4b71Sopenharmony_ci  anm setting [<options>]
63e41f4b71Sopenharmony_ci  ```
64e41f4b71Sopenharmony_ci
65e41f4b71Sopenharmony_ci  The table below describes the available options.
66e41f4b71Sopenharmony_ci
67e41f4b71Sopenharmony_ci  | Name                    | Description                            |
68e41f4b71Sopenharmony_ci  | ------------------------ | ------------------------------------ |
69e41f4b71Sopenharmony_ci  | -c/--recent-count        | Maximum number of recent notifications stored in the memory.|
70e41f4b71Sopenharmony_ci  | -e/--enable-notification | Whether to enable the notification capability.                    |
71e41f4b71Sopenharmony_ci  | -h/--help                | Help information.                            |
72e41f4b71Sopenharmony_ci
73e41f4b71Sopenharmony_ci* **Example**: Set the maximum number of recent notifications stored in the memory to 100.
74e41f4b71Sopenharmony_ci
75e41f4b71Sopenharmony_ci  ```bash
76e41f4b71Sopenharmony_ci  anm setting -c 100
77e41f4b71Sopenharmony_ci  ```
78