StatusBarNotificationConfig

java.lang.Object
- com.netease.nimlib.sdk.StatusBarNotificationConfig

All Implemented Interfaces:

java.io.Serializable
```
public class StatusBarNotificationConfig
extends java.lang.Object
implements java.io.Serializable
```
SDK configuration for status bar reminder

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`java.lang.String`	`customTitleWhenTeamNameEmpty` If the group name is null or empty string, use customTitleWhenTeamNameEmpty for the title on the notification bar.
`java.lang.String`	`downTimeBegin` Thestart time of Do Not Disturb in HH:mm (24-hour format).
`boolean`	`downTimeEnableNotification` Specify whether to display notifications when Do-Not-Disturb is turned on.
`java.lang.String`	`downTimeEnd` The end time of Do Not Disturb in HH:mm (24-hour format).
`boolean`	`downTimeToggle` Do Not Disturb setting * The default value is false.
`boolean`	`hideContent` Do not display the message details and the nickname of the message sender The default value is false.
`int`	`ledARGB` Color of the breathing light The color of the led.
`int`	`ledOffMs` Duration when the breathing light is off in milliseconds.
`int`	`ledOnMs` Duration when the breathing light is turned on in milliseconds.
`int`	`notificationColor` The color of the notification bar.
`java.lang.Class<? extends Activity>`	`notificationEntrance` The activity type of response intent for alerts on the notification bar.
`NotificationExtraTypeEnum`	`notificationExtraType` The extra type passed by clicking the notification bar.
`StatusBarNotificationFilter`	`notificationFilter` // Before StatusBarNotification pops up, the SDK asks the app using the interface and decides whether to pop up the notification based on the result returned by the app.
`boolean`	`notificationFolded` Deprecated.
`NotificationFoldStyle`	`notificationFoldStyle` The folding type of messages on the notification bar.
`int`	`notificationSmallIconId` The resource ID of the small icon for status bar alerts.
`java.lang.String`	`notificationSound` The audio resource of the ring alert.
`boolean`	`ring` Specify whether to enable a ring for alerts.
`boolean`	`showBadge` Specify whether to display the unread count on the app icon shows (red dots) The setting is only valid for Android 8.0 or later.
`boolean`	`titleOnlyShowAppName` Specify whether to display the app name in the alerts on the notification bar.
`boolean`	`vibrate` Specify whether to enable vibration for alerts.

Constructor Summary

Constructors
Constructor and Description

StatusBarNotificationConfig()

Constructors
Constructor and Description
`StatusBarNotificationConfig()`

Method Summary
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - notificationSmallIconId
```
public int notificationSmallIconId
```
    The resource ID of the small icon for status bar alerts.
    If the ID is not provided, use the app's icon.
  - ring
```
public boolean ring
```
    Specify whether to enable a ring for alerts.
    The default value is true.
  - notificationSound
```
public java.lang.String notificationSound
```
    The audio resource of the ring alert. If no audio resources are provided, the system default tone will be used.
  - vibrate
```
public boolean vibrate
```
    Specify whether to enable vibration for alerts.
    The default value is true.
  - ledARGB
```
public int ledARGB
```
    Color of the breathing light The color of the led. The hardware will do its best approximation. Pure colors, such as green, blue, and red, are recommended. Do not use mixed colors.
  - ledOnMs
```
public int ledOnMs
```
    Duration when the breathing light is turned on in milliseconds. The number of milliseconds when the LED turned on while it's flashing. The hardware will do its best approximation.
  - ledOffMs
```
public int ledOffMs
```
    Duration when the breathing light is off in milliseconds. The number of milliseconds for the LED to be off while it's flashing. The hardware will do its best approximation.
  - hideContent
```
public boolean hideContent
```
    Do not display the message details and the nickname of the message sender
    The default value is false.
  - downTimeToggle
```
public boolean downTimeToggle
```
    Do Not Disturb setting * The default value is false.
  - downTimeBegin
```
public java.lang.String downTimeBegin
```
    Thestart time of Do Not Disturb in HH:mm (24-hour format).
  - downTimeEnd
```
public java.lang.String downTimeEnd
```
    The end time of Do Not Disturb in HH:mm (24-hour format).
    If the end time is less than the start time, the Do Not Disturb time is in start time-24:00-end time.
  - downTimeEnableNotification
```
public boolean downTimeEnableNotification
```
    Specify whether to display notifications when Do-Not-Disturb is turned on. The default setting is to display
  - notificationEntrance
```
public java.lang.Class<? extends Activity> notificationEntrance
```
    The activity type of response intent for alerts on the notification bar.
    The type can be set to null. If the type is unspecified, the activity of the entrance intent in the launcher of used package.
  - titleOnlyShowAppName
```
public boolean titleOnlyShowAppName
```
    Specify whether to display the app name in the alerts on the notification bar. The default setting is false. If a message is sent in a session, the session name is displayed. when messages are sent from multiple sessions, the app name is displayed. If the value is set to true, the title will display the app name no matter the message is sent from one or more sessions. Please set the app name in android:label in AndroidManifest.
  - notificationFolded
```
@Deprecated
public boolean notificationFolded
```
    Deprecated.
    
    This field is obsolete.
    
    See Also:
    
    NotificationFoldStyle
  - notificationFoldStyle
```
public NotificationFoldStyle notificationFoldStyle
```
    The folding type of messages on the notification bar. If the type is unspecified, the value of notificationFolded is used. If the value is null, all messages are folded by default.
  - notificationColor
```
public int notificationColor
```
    The color of the notification bar. The setColor method of NotificationCompat.Builder will be called. SmallIcon will be affected for Android 5.0 or later.
  - showBadge
```
public boolean showBadge
```
    Specify whether to display the unread count on the app icon shows (red dots) The setting is only valid for Android 8.0 or later.
  - customTitleWhenTeamNameEmpty
```
public java.lang.String customTitleWhenTeamNameEmpty
```
    If the group name is null or empty string, use customTitleWhenTeamNameEmpty for the title on the notification bar.
  - notificationExtraType
```
public NotificationExtraTypeEnum notificationExtraType
```
    The extra type passed by clicking the notification bar.
  - notificationFilter
```
public StatusBarNotificationFilter notificationFilter
```
    // Before StatusBarNotification pops up, the SDK asks the app using the interface and decides whether to pop up the notification based on the result returned by the app. An empty return represents DEFAULT.
- Constructor Detail
  - StatusBarNotificationConfig
```
public StatusBarNotificationConfig()
```

Class StatusBarNotificationConfig

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

notificationSmallIconId

ring

notificationSound

vibrate

ledARGB

ledOnMs

ledOffMs

hideContent

downTimeToggle

downTimeBegin

downTimeEnd

downTimeEnableNotification

notificationEntrance

titleOnlyShowAppName

notificationFolded

notificationFoldStyle

notificationColor

showBadge

customTitleWhenTeamNameEmpty

notificationExtraType

notificationFilter

Constructor Detail

StatusBarNotificationConfig