NotificationSlot

java.lang.Object
- ohos.event.notification.NotificationSlot

所有已实现的接口:

Sequenceable
```
public final class NotificationSlot
extends Object
implements Sequenceable
```
Defines a public notification theme, which is a collection of features including notification tone, vibration, lock screen display, and level. You can associate this class with an application, so that all notifications released by the application have the features of the notification theme.
An application can be associated with one or more NotificationSlot instances.

从以下版本开始:

1

SystemCapability

SystemCapability.Notification#ANS

嵌套类概要
- 从接口继承的嵌套类/接口 ohos.utils.Sequenceable
  Sequenceable.Producer<T>

字段概要

字段
限定符和类型	字段	说明
`static int`	`LEVEL_DEFAULT`	Indicates that the notification function is enabled and notification icons are displayed in the status bar, with no banner but with a prompt tone.
`static int`	`LEVEL_HIGH`	Indicates that the notification function is enabled and notification icons are displayed in the status bar, with a banner and a prompt tone.
`static int`	`LEVEL_LOW`	Indicates that the notification function is enabled and notification icons are displayed in the status bar, with no banner or prompt tone.
`static int`	`LEVEL_MIN`	Indicates that the notification function is enabled but notification icons are not displayed in the status bar, with no banner or prompt tone.
`static int`	`LEVEL_NONE`	Indicates that the notification function is disabled.
`static int`	`LEVEL_UNDEFINED`	Indicates that the user does not define an level.
`static Sequenceable.Producer<NotificationSlot>`	`PRODUCER`	Creates a `NotificationSlot` instance from a `Parcel`.

构造器概要

构造器
构造器	说明
`NotificationSlot(String id, String name, int level)`	A constructor used to initialize the ID, name, and level of a `NotificationSlot` object.

方法概要

所有方法实例方法具体方法
限定符和类型	方法	说明
`boolean`	`canEnableLight()`	Obtains whether the notification light is enabled in a `NotificationSlot` object, which is set by `setEnableLight(boolean)`.
`boolean`	`canVibrate()`	Obtains the vibration status of a `NotificationSlot` object, which is set by `setEnableVibration(boolean)`.
`void`	`enableBadge(boolean isShowBadge)`	Sets whether to display application icon badges (digits or dots in the corner of the application icon) on the home screen after a notification is received.
`void`	`enableBypassDnd(boolean bypassDnd)`	Sets whether to bypass Do not disturb (DND) mode in the system.
`String`	`getDescription()`	Obtains the description of a `NotificationSlot` object, which is set by `setDescription(java.lang.String)`.
`String`	`getId()`	Obtains the ID of a `NotificationSlot` object.
`int`	`getLedLightColor()`	Obtains the color of the notification light in a `NotificationSlot` object, which is set by `setLedLightColor(int)`.
`int`	`getLevel()`	Obtains the level of a `NotificationSlot` object, which is set by `setLevel(int)`.
`int`	`getLockscreenVisibleness()`	Obtains the notification display effect of a `NotificationSlot` object on the lock screen, which is set by `setLockscreenVisibleness(int)`.
`String`	`getName()`	Obtains the name of a `NotificationSlot` object.
`String`	`getSlotGroup()`	Obtains the ID of the `NotificationSlotGroup` object to which this `NotificationSlot` object belongs, which is set by `setSlotGroup(java.lang.String)`.
`Uri`	`getSound()`	Obtains the prompt tone of a `NotificationSlot` object, which is set by `setSound(ohos.utils.net.Uri)`.
`long[]`	`getVibrationStyle()`	Obtains the vibration style of notifications in this `NotificationSlot`.
`boolean`	`isEnableBypassDnd()`	Obtains whether DND mode is bypassed for a `NotificationSlot` object, which is set by `enableBypassDnd(boolean)`.
`boolean`	`isShowBadge()`	Obtains the application icon badge status of a `NotificationSlot` object, which is set by `enableBadge(boolean)`.
`boolean`	`marshalling(Parcel out)`	Marshals a `NotificationSlot` object into a `Parcel`.
`void`	`setDescription(String description)`	Sets the description for a `NotificationSlot` object.
`void`	`setEnableLight(boolean isLightEnabled)`	Specifies whether to enable the notification light when a notification is received on the device, provided that this device has a notification light.
`void`	`setEnableVibration(boolean vibration)`	Sets whether to enable vibration when a notification is received.
`void`	`setLedLightColor(int color)`	Sets the color of the notification light to flash when a notification is received on the device, provided that this device has a notification light and `setEnableLight(boolean)` is called with the value `true`.
`void`	`setLevel(int level)`	Sets the level of a `NotificationSlot` object.
`void`	`setLockscreenVisibleness(int visibleness)`	Sets whether and how to display notifications on the lock screen.
`void`	`setName(String name)`	Sets the name of a `NotificationSlot` object.
`void`	`setSlotGroup(String groupId)`	Binds a `NotificationSlot` object to a specified `NotificationSlotGroup`.
`void`	`setSound(Uri sound)`	Sets a prompt tone for a `NotificationSlot` object, which will be played after a notification is received.
`void`	`setVibrationStyle(long[] vibrationValues)`	Sets the vibration style for notifications in this `NotificationSlot`.
`String`	`toString()`	Returns a string representation of the object.
`boolean`	`unmarshalling(Parcel in)`	Unmarshals a `NotificationSlot` object from a `Parcel`.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

从接口继承的方法 ohos.utils.Sequenceable
hasFileDescriptor

- 字段详细资料
  - LEVEL_DEFAULT
```
public static final int LEVEL_DEFAULT
```
    Indicates that the notification function is enabled and notification icons are displayed in the status bar, with no banner but with a prompt tone.
    
    从以下版本开始:
    
    1
    
    另请参阅:
    
    常量字段值
  - LEVEL_HIGH
```
public static final int LEVEL_HIGH
```
    Indicates that the notification function is enabled and notification icons are displayed in the status bar, with a banner and a prompt tone.
    
    从以下版本开始:
    
    1
    
    另请参阅:
    
    常量字段值
  - LEVEL_LOW
```
public static final int LEVEL_LOW
```
    Indicates that the notification function is enabled and notification icons are displayed in the status bar, with no banner or prompt tone.
    
    从以下版本开始:
    
    1
    
    另请参阅:
    
    常量字段值
  - LEVEL_MIN
```
public static final int LEVEL_MIN
```
    Indicates that the notification function is enabled but notification icons are not displayed in the status bar, with no banner or prompt tone.
    
    从以下版本开始:
    
    1
    
    另请参阅:
    
    常量字段值
  - LEVEL_NONE
```
public static final int LEVEL_NONE
```
    Indicates that the notification function is disabled.
    
    从以下版本开始:
    
    1
    
    另请参阅:
    
    常量字段值
  - LEVEL_UNDEFINED
```
public static final int LEVEL_UNDEFINED
```
    Indicates that the user does not define an level.
    This is a reserved constant. Do not associate it with any notification.
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    常量字段值
  - PRODUCER
```
public static final Sequenceable.Producer<NotificationSlot> PRODUCER
```
    Creates a NotificationSlot instance from a Parcel.
    
    从以下版本开始:
    
    4
- 构造器详细资料
  - NotificationSlot
```
public NotificationSlot(String id,
                        String name,
                        int level)
```
    A constructor used to initialize the ID, name, and level of a NotificationSlot object.
    
    参数:
    
    id - Specifies the ID of the NotificationSlot object. The ID must be unique and its length must not exceed 1000 characters (the excessive part is automatically truncated).
    
    name - Specifies the name of the NotificationSlot object. The name must be visible to users and its length must not exceed 1000 characters (the excessive part is automatically truncated).
    
    level - Specifies the level of the NotificationSlot object, which determines the notification display effect. The value can be LEVEL_NONE, LEVEL_MIN, LEVEL_LOW, LEVEL_DEFAULT, or LEVEL_HIGH.
    
    从以下版本开始:
    
    1
- 方法详细资料
  - setLevel
```
public void setLevel(int level)
```
    Sets the level of a NotificationSlot object.
    setLevel(int level) must be set before the NotificationHelper#addNotificationSlot(NotificationSlot) method is called. Otherwise, the settings will not take effect.
    
    参数:
    
    level - Specifies the level of the NotificationSlot object, which determines the notification display effect. The value can be LEVEL_NONE, LEVEL_MIN, LEVEL_LOW, LEVEL_DEFAULT, or LEVEL_HIGH.
    
    从以下版本开始:
    
    1
  - setName
```
public void setName(String name)
```
    Sets the name of a NotificationSlot object.
    The setting of setName(String) is effective regardless of whether a NotificationSlot object has been created by NotificationHelper#addNotificationSlot(NotificationSlot).
    
    参数:
    
    name - Specifies the name of the NotificationSlot object. The name is visible to users, and its length must not exceed 1000 characters (the excessive part is automatically truncated).
    
    从以下版本开始:
    
    1
  - setDescription
```
public void setDescription(String description)
```
    Sets the description for a NotificationSlot object.
    The setting of setDescription(String) is effective regardless of whether a NotificationSlot object has been created by NotificationHelper#addNotificationSlot(NotificationSlot).
    
    参数:
    
    description - Describes the NotificationSlot object. The description is visible to users and its length must not exceed 1000 characters (the excessive part is automatically truncated).
    
    从以下版本开始:
    
    1
  - enableBadge
```
public void enableBadge(boolean isShowBadge)
```
    Sets whether to display application icon badges (digits or dots in the corner of the application icon) on the home screen after a notification is received.
    enableBadge(boolean) must be set before the NotificationHelper#addNotificationSlot(NotificationSlot) method is called. Otherwise, the settings will not take effect.
    
    参数:
    
    isShowBadge - Specifies whether to display the application icon badge. If the value is true, the application icon badge is enabled; if the value is false, the application icon badge is disabled.
    
    从以下版本开始:
    
    1
  - enableBypassDnd
```
public void enableBypassDnd(boolean bypassDnd)
```
    Sets whether to bypass Do not disturb (DND) mode in the system.
    The setting of enableBypassDnd(boolean) takes effect only when the Allow interruptions function is enabled for an application in system notification settings.
    
    参数:
    
    bypassDnd - Specifies whether to bypass DND mode for an application. If the value is true, DND mode is bypassed; if the value is false, DND mode is not bypassed.
    
    从以下版本开始:
    
    1
  - setEnableVibration
```
public void setEnableVibration(boolean vibration)
```
    Sets whether to enable vibration when a notification is received.
    setEnableVibration(boolean) must be set before the NotificationHelper#addNotificationSlot(NotificationSlot) method is called. Otherwise, the settings will not take effect.
    
    参数:
    
    vibration - Indicates whether to enable vibration when a notification is received. If the value is true, vibration is enabled; if the value is false, vibration is disabled.
    
    从以下版本开始:
    
    1
  - setLockscreenVisibleness
```
public void setLockscreenVisibleness(int visibleness)
```
    Sets whether and how to display notifications on the lock screen.
    This method specifies different effects for displaying notifications on the lock screen in order to protect user privacy.
    The setting takes effect only when the lock screen notifications function is enabled for an application in system notification settings.
    
    参数:
    
    visibleness - Specifies the notification display effect on the lock screen, which can be set to NotificationRequest#VISIBLENESS_TYPE_PUBLIC, NotificationRequest#VISIBLENESS_TYPE_PRIVATE, or NotificationRequest#VISIBLENESS_TYPE_SECRET.
    
    从以下版本开始:
    
    1
  - setSound
```
public void setSound(Uri sound)
```
    Sets a prompt tone for a NotificationSlot object, which will be played after a notification is received.
    setSound(Uri) must be set before the NotificationHelper#addNotificationSlot(NotificationSlot) method is called. Otherwise, the settings will not take effect.
    
    参数:
    
    sound - Specifies the path for the prompt tone.
    
    从以下版本开始:
    
    1
  - setEnableLight
```
public void setEnableLight(boolean isLightEnabled)
```
    Specifies whether to enable the notification light when a notification is received on the device, provided that this device has a notification light.
    setEnableLight(boolean) must be set before the NotificationHelper#addNotificationSlot(NotificationSlot) method is called. Otherwise, the settings will not take effect.
    
    参数:
    
    isLightEnabled - Specifies whether to enable the pulse notification light. The value true indicates to enable the notification light, and the value false indicates not to enable it.
    
    从以下版本开始:
    
    1
  - setLedLightColor
```
public void setLedLightColor(int color)
```
    Sets the color of the notification light to flash when a notification is received on the device, provided that this device has a notification light and setEnableLight(boolean) is called with the value true.
    setLedLightColor(int) must be set before the NotificationHelper#addNotificationSlot(NotificationSlot) method is called. Otherwise, the settings will not take effect.
    
    参数:
    
    color - Indicates the color of the notification light.
    
    从以下版本开始:
    
    1
  - setSlotGroup
```
public void setSlotGroup(String groupId)
```
    Binds a NotificationSlot object to a specified NotificationSlotGroup.
    setSlotGroup(String) must be called before the NotificationHelper#addNotificationSlot(NotificationSlot) method is called. Otherwise, this method will not take effect.
    
    参数:
    
    groupId - Indicates the ID of the NotificationSlotGroup object to bind, which must have been created by calling NotificationHelper#addNotificationSlotGroup(NotificationSlotGroup).
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    NotificationSlotGroup
  - getId
```
public String getId()
```
    Obtains the ID of a NotificationSlot object.
    
    返回:
    
    Returns the ID of the NotificationSlot object, which is set by NotificationSlot(java.lang.String,java.lang.String,int).
    
    从以下版本开始:
    
    1
  - getName
```
public String getName()
```
    Obtains the name of a NotificationSlot object.
    
    返回:
    
    Returns the name of the NotificationSlot object, which is set by setName(java.lang.String).
    
    从以下版本开始:
    
    1
  - getDescription
```
public String getDescription()
```
    Obtains the description of a NotificationSlot object, which is set by setDescription(java.lang.String).
    
    返回:
    
    Returns the description of the NotificationSlot object.
    
    从以下版本开始:
    
    1
  - getLevel
```
public int getLevel()
```
    Obtains the level of a NotificationSlot object, which is set by setLevel(int).
    
    返回:
    
    Returns the level of the NotificationSlot object.
    
    从以下版本开始:
    
    1
  - isShowBadge
```
public boolean isShowBadge()
```
    Obtains the application icon badge status of a NotificationSlot object, which is set by enableBadge(boolean).
    
    返回:
    
    Returns true if the application icon badge is enabled; returns false otherwise.
    
    从以下版本开始:
    
    1
  - isEnableBypassDnd
```
public boolean isEnableBypassDnd()
```
    Obtains whether DND mode is bypassed for a NotificationSlot object, which is set by enableBypassDnd(boolean).
    
    返回:
    
    Returns true if DND mode is bypassed; returns false otherwise.
    
    从以下版本开始:
    
    1
  - canVibrate
```
public boolean canVibrate()
```
    Obtains the vibration status of a NotificationSlot object, which is set by setEnableVibration(boolean).
    
    返回:
    
    Returns true if vibration is enabled; returns false otherwise.
    
    从以下版本开始:
    
    1
  - getLockscreenVisibleness
```
public int getLockscreenVisibleness()
```
    Obtains the notification display effect of a NotificationSlot object on the lock screen, which is set by setLockscreenVisibleness(int).
    
    返回:
    
    Returns the notification display effect of the NotificationSlot object on the lock screen.
    
    从以下版本开始:
    
    1
  - getSound
```
public Uri getSound()
```
    Obtains the prompt tone of a NotificationSlot object, which is set by setSound(ohos.utils.net.Uri).
    
    返回:
    
    Returns the prompt tone of the NotificationSlot object.
    
    从以下版本开始:
    
    1
  - canEnableLight
```
public boolean canEnableLight()
```
    Obtains whether the notification light is enabled in a NotificationSlot object, which is set by setEnableLight(boolean).
    
    返回:
    
    Returns true if the notification light is enabled; returns false otherwise.
    
    从以下版本开始:
    
    1
  - getLedLightColor
```
public int getLedLightColor()
```
    Obtains the color of the notification light in a NotificationSlot object, which is set by setLedLightColor(int).
    
    返回:
    
    Returns the color of the notification light.
    
    从以下版本开始:
    
    1
  - getSlotGroup
```
public String getSlotGroup()
```
    Obtains the ID of the NotificationSlotGroup object to which this NotificationSlot object belongs, which is set by setSlotGroup(java.lang.String).
    
    返回:
    
    Returns the ID of the NotificationSlotGroup to which this NotificationSlot object belongs.
    
    从以下版本开始:
    
    3
  - setVibrationStyle
```
public void setVibrationStyle(long[] vibrationValues)
```
    Sets the vibration style for notifications in this NotificationSlot.
    If an empty array or null is passed to this method, the system then calls setEnableVibration(boolean) with the input parameter set to false. If a valid value is passed to this method, the system calls setEnableVibration(boolean) with the input parameter set to true. This method takes effect only before NotificationHelper#addNotificationSlot(NotificationSlot) is called.
    
    参数:
    
    vibrationValues - Indicates the vibration style to set.
    
    从以下版本开始:
    
    4
  - getVibrationStyle
```
public long[] getVibrationStyle()
```
    Obtains the vibration style of notifications in this NotificationSlot.
    
    返回:
    
    Returns the vibration style of this NotificationSlot.
    
    从以下版本开始:
    
    4
  - marshalling
```
public boolean marshalling(Parcel out)
```
    Marshals a NotificationSlot object into a Parcel.
    A process can call the unmarshalling(ohos.utils.Parcel) method to unmarshal a NotificationSlot object from a Parcel to implement inter-process communication (IPC).
    
    指定者:
    
    marshalling 在接口中 Sequenceable
    
    参数:
    
    out - Indicates the Parcel object for marshalling.
    
    返回:
    
    Returns true if the marshalling is successful; returns false otherwise.
    
    从以下版本开始:
    
    1
  - unmarshalling
```
public boolean unmarshalling(Parcel in)
```
    Unmarshals a NotificationSlot object from a Parcel.
    
    指定者:
    
    unmarshalling 在接口中 Sequenceable
    
    参数:
    
    in - Indicates the Parcel object for unmarshalling.
    
    返回:
    
    Returns true if the unmarshalling is successful; returns false otherwise.
    
    从以下版本开始:
    
    1
  - toString
```
public String toString()
```
    从类复制的说明: Object
    Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.
    The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:
    getClass().getName() + '@' + Integer.toHexString(hashCode())
    覆盖:
    
    toString 在类中 Object
    
    返回:
    
    a string representation of the object.
    
    从以下版本开始:
    
    4

类 NotificationSlot

嵌套类概要

从接口继承的嵌套类/接口 ohos.utils.Sequenceable

字段概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

从接口继承的方法 ohos.utils.Sequenceable

字段详细资料

LEVEL_DEFAULT

LEVEL_HIGH

LEVEL_LOW

LEVEL_MIN

LEVEL_NONE

LEVEL_UNDEFINED

PRODUCER

构造器详细资料

NotificationSlot

方法详细资料

setLevel

setName

setDescription

enableBadge

enableBypassDnd

setEnableVibration

setLockscreenVisibleness

setSound

setEnableLight

setLedLightColor

setSlotGroup

getId

getName

getDescription

getLevel

isShowBadge

isEnableBypassDnd

canVibrate

getLockscreenVisibleness

getSound

canEnableLight

getLedLightColor

getSlotGroup

setVibrationStyle

getVibrationStyle

marshalling

unmarshalling

toString