NIMStatusBarNotificationConfig class Null safety

the SDK configuration for status bar reminder

Annotations
  • @JsonSerializable()

Constructors

NIMStatusBarNotificationConfig({bool ring = true, String? notificationSound, bool vibrate = true, int? ledARGB, int? ledOnMs, int? ledOffMs, bool hideContent = false, bool downTimeToggle = false, String? downTimeBegin, String? downTimeEnd, bool downTimeEnableNotification = true, String? notificationEntranceClassName, bool titleOnlyShowAppName = false, NIMNotificationFoldStyle notificationFoldStyle = NIMNotificationFoldStyle.all, int? notificationColor, bool showBadge = true, String? customTitleWhenTeamNameEmpty, NIMNotificationExtraType notificationExtraType = NIMNotificationExtraType.message})
NIMStatusBarNotificationConfig.fromMap(Map<String, dynamic> map)
factory

Properties

customTitleWhenTeamNameEmpty → String?
If the group name is null or empty string, use customTitleWhenTeamNameEmpty for the title on the notification bar.
final
downTimeBegin → String?
Start time of Do Not Disturb in HH:mm (24-hour format).
final
downTimeEnableNotification → bool
Specify whether to display notifications when Do-Not-Disturb is turned on. The default setting is to display
final
downTimeEnd → String?
End time of Do Not Disturb in HH:mm (24-hour format).
If the end time is earlier than the start time, the Do Not Disturb time is in start time-24:00-end time.
final
downTimeToggle → bool
Do Not Disturb setting The default value is false.
final
hashCode → int
The hash code for this object.
read-only, inherited
hideContent → bool
Do not display the message details and the nickname of the message sender
The default value is false.
final
ledARGB → int?
Color of the breathing light Basic colors, such as green, blue, and red, are recommended. Do not use mixed colors.
final
ledOffMs → int?
Duration when the breathing light is off in milliseconds.
final
ledOnMs → int?
Duration when the breathing light is turned on in milliseconds.
final
notificationColor → int?
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.
final
notificationEntranceClassName → String?
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.
final
notificationExtraType → NIMNotificationExtraType
The extra type passed by clicking the notification bar.
@JsonKey(defaultValue: NIMNotificationExtraType.message), final
notificationFoldStyle → NIMNotificationFoldStyle
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.
@JsonKey(defaultValue: NIMNotificationFoldStyle.all), final
notificationSound → String?
The audio resource of the ring alert. If no audio resources are provided, the system default tone will be used.
final
ring → bool
The resource name of the small icon for status bar alerts.
If no icon is provided, use the app icon.
final
runtimeType → Type
A representation of the runtime type of the object.
read-only, inherited
showBadge → bool
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.
final
titleOnlyShowAppName → bool
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 of notifications will display the app name no matter the message is sent from one or more sessions. Set the app name in android:label in AndroidManifest.
final
vibrate → bool
Specify whether to enable vibration for alerts.
The default value is true.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited