• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# NotificationSlot
2<!--Kit: Notification Kit-->
3<!--Subsystem: Notification-->
4<!--Owner: @michael_woo888-->
5<!--Designer: @dongqingran; @wulong158-->
6<!--Tester: @wanghong1997-->
7<!--Adviser: @huipeizi-->
8
9The **NotificationSlot** module provides APIs for defining the notification slot.
10
11> **NOTE**
12>
13> The initial APIs of this module are supported since API version 7. Newly added APIs will be marked with a superscript to indicate their earliest API version.
14
15## NotificationSlot
16
17**System capability**: SystemCapability.Notification.Notification
18
19| Name                | Type                | Read-Only| Optional| Description                  |
20| -------------------- | ---------------------|---- | --- |----------------------|
21| type<sup>(deprecated)</sup> | [notification.SlotType](js-apis-notification.md#slottype) | No| Yes | Notification slot type.<br>This API is deprecated since API version 11. You are advised to use **notificationType** instead.               |
22| notificationType<sup>11+</sup>                 | [notificationManager.SlotType](js-apis-notificationManager.md#slottype) | No| Yes | Notification slot type.               |
23| level<sup>(deprecated)</sup> | [notification.SlotLevel](js-apis-notificationManager.md#slotlevel) | No| Yes | Notification level.<br>This API is deprecated since API version 20. You are advised to use **notificationLevel** instead.|
24| notificationLevel<sup>20+</sup>                 | [notificationManager.SlotLevel](js-apis-notificationManager.md#slotlevel) | No| Yes | Notification level.               |
25| desc                 | string                | No| Yes | Notification slot description.           |
26| badgeFlag            | boolean               | No| Yes | Whether to display the badge.<br> - **true**: Yes.<br> - **false**: No.             |
27| bypassDnd            | boolean               | No| Yes | Whether to bypass DND mode in the system.<br> - **true**: Yes.<br> - **false**: No.      |
28| lockscreenVisibility | number                | No| Yes | Mode for displaying the notification on the lock screen. Not supported currently.      |
29| vibrationEnabled     | boolean               | No| Yes | Whether to enable vibration for the notification.<br> - **true**: Yes.<br> - **false**: No.              |
30| sound                | string                | No| Yes | Name of the custom ringtone file for notifications. This file is stored in the **resources/rawfile** directory and supports formats such as M4A, AAC, MP3, OGG, WAV, FLAC, and AMR.              |
31| lightEnabled         | boolean               | No| Yes | Whether the indicator blinks for the notification.<br> - **true**: Yes.<br> - **false**: No.               |
32| lightColor           | number                | No| Yes | Indicator color of the notification. Not supported currently.              |
33| vibrationValues      | Array\<number\>       | No| Yes | Vibration mode of the notification. Not supported currently.             |
34| enabled<sup>9+</sup> | boolean               | Yes| Yes | Whether the notification is enabled.<br> - **true**: enabled.<br> - **false**: disabled.        |
35