NIMSDK-AOS  9.16.0
Public 属性 | 所有成员列表
com.netease.nimlib.sdk.StatusBarNotificationConfig类 参考

SDK提供状态栏提醒的配置 更多...

类 com.netease.nimlib.sdk.StatusBarNotificationConfig 继承关系图:

Public 属性

int notificationSmallIconId
 状态栏提醒的小图标的资源ID。
如果不提供,使用app的icon 更多...
 
boolean ring = true
 是否需要响铃提醒。
默认为true 更多...
 
String notificationSound
 响铃提醒的声音资源,如果不提供,使用系统默认提示音。 更多...
 
boolean vibrate = true
 是否需要振动提醒。
默认为true 更多...
 
int ledARGB = -1
 呼吸灯的颜色 The color of the led. 更多...
 
int ledOnMs = -1
 呼吸灯亮时的持续时间(毫秒) The number of milliseconds for the LED to be on while it's flashing. 更多...
 
int ledOffMs = -1
 呼吸灯熄灭时的持续时间(毫秒) The number of milliseconds for the LED to be off while it's flashing. 更多...
 
boolean hideContent = false
 不显示消息详情开关, 同时也不再显示消息发送者昵称
默认为false 更多...
 
boolean downTimeToggle = false
 免打扰设置开关。默认为关闭。 更多...
 
String downTimeBegin
 免打扰的开始时间, 格式为HH:mm(24小时制)。 更多...
 
String downTimeEnd
 免打扰的结束时间, 格式为HH:mm(24小时制)。
如果结束时间小于开始时间,免打扰时间为开始时间-24:00-结束时间。 更多...
 
boolean downTimeEnableNotification = true
 免打扰期间,是否显示通知,默认为显示 更多...
 
Class<? extends Activity > notificationEntrance
 通知栏提醒的响应intent的activity类型。
可以为null。如果未提供,将使用包的launcher的入口intent的activity。 更多...
 
boolean titleOnlyShowAppName = false
 通知栏提醒的标题是否只显示应用名。默认是 false,当有一个会话发来消息时,显示会话名;当有多个会话发来时,显示应用名。 修改为true,那么无论一个还是多个会话发来消息,标题均显示应用名。 应用名称请在AndroidManifest的application节点下设置android:label。 更多...
 
boolean notificationFolded = true
 该字段已废弃 更多...
 
NotificationFoldStyle notificationFoldStyle = NotificationFoldStyle.ALL
 消息通知栏的折叠类型,不配置时,以notificationFolded的值为准, 如果为null,表示默认所有折叠 更多...
 
int notificationColor
 消息通知栏颜色,将应用到 NotificationCompat.Builder 的 setColor 方法 对Android 5.0 以后机型会影响到smallIcon 更多...
 
boolean showBadge = true
 是否APP图标显示未读数(红点) 仅针对Android 8.0+有效 更多...
 
String customTitleWhenTeamNameEmpty
 如果群名称为null 或者空串,则使用customTitleWhenTeamNameEmpty 作为通知栏title 更多...
 
NotificationExtraTypeEnum notificationExtraType = NotificationExtraTypeEnum.MESSAGE
 点击通知栏传递的extra类型 更多...
 
StatusBarNotificationFilter notificationFilter = null
 弹StatusBarNotification之前,SDK通过改接口询问App,根据App返回结果决定是否弹出通知 为空等同于返回DEFAULT 更多...
 
NimPermissionRequester postNotificationsRequester = null
 Android13 弹出通知之前,SDK通过改接口向App请求权限Manifest.permission#POST_NOTIFICATIONS,根据权限赋予结果决定是否弹出通知 更多...
 

详细描述

SDK提供状态栏提醒的配置

在文件 StatusBarNotificationConfig.java12 行定义.

类成员变量说明

◆ customTitleWhenTeamNameEmpty

String com.netease.nimlib.sdk.StatusBarNotificationConfig.customTitleWhenTeamNameEmpty

如果群名称为null 或者空串,则使用customTitleWhenTeamNameEmpty 作为通知栏title

在文件 StatusBarNotificationConfig.java130 行定义.

◆ downTimeBegin

String com.netease.nimlib.sdk.StatusBarNotificationConfig.downTimeBegin

免打扰的开始时间, 格式为HH:mm(24小时制)。

在文件 StatusBarNotificationConfig.java74 行定义.

◆ downTimeEnableNotification

boolean com.netease.nimlib.sdk.StatusBarNotificationConfig.downTimeEnableNotification = true

免打扰期间,是否显示通知,默认为显示

在文件 StatusBarNotificationConfig.java86 行定义.

◆ downTimeEnd

String com.netease.nimlib.sdk.StatusBarNotificationConfig.downTimeEnd

免打扰的结束时间, 格式为HH:mm(24小时制)。
如果结束时间小于开始时间,免打扰时间为开始时间-24:00-结束时间。

在文件 StatusBarNotificationConfig.java81 行定义.

◆ downTimeToggle

boolean com.netease.nimlib.sdk.StatusBarNotificationConfig.downTimeToggle = false

免打扰设置开关。默认为关闭。

在文件 StatusBarNotificationConfig.java68 行定义.

◆ hideContent

boolean com.netease.nimlib.sdk.StatusBarNotificationConfig.hideContent = false

不显示消息详情开关, 同时也不再显示消息发送者昵称
默认为false

在文件 StatusBarNotificationConfig.java62 行定义.

◆ ledARGB

int com.netease.nimlib.sdk.StatusBarNotificationConfig.ledARGB = -1

呼吸灯的颜色 The color of the led.

The hardware will do its best approximation. 建议尽量使用绿色、蓝色、红色等基本颜色,不要去用混合色。

在文件 StatusBarNotificationConfig.java42 行定义.

◆ ledOffMs

int com.netease.nimlib.sdk.StatusBarNotificationConfig.ledOffMs = -1

呼吸灯熄灭时的持续时间(毫秒) The number of milliseconds for the LED to be off while it's flashing.

The hardware will do its best approximation.

在文件 StatusBarNotificationConfig.java56 行定义.

◆ ledOnMs

int com.netease.nimlib.sdk.StatusBarNotificationConfig.ledOnMs = -1

呼吸灯亮时的持续时间(毫秒) The number of milliseconds for the LED to be on while it's flashing.

The hardware will do its best approximation.

在文件 StatusBarNotificationConfig.java49 行定义.

◆ notificationColor

int com.netease.nimlib.sdk.StatusBarNotificationConfig.notificationColor

消息通知栏颜色,将应用到 NotificationCompat.Builder 的 setColor 方法 对Android 5.0 以后机型会影响到smallIcon

在文件 StatusBarNotificationConfig.java119 行定义.

◆ notificationEntrance

Class<? extends Activity> com.netease.nimlib.sdk.StatusBarNotificationConfig.notificationEntrance

通知栏提醒的响应intent的activity类型。
可以为null。如果未提供,将使用包的launcher的入口intent的activity。

在文件 StatusBarNotificationConfig.java93 行定义.

◆ notificationExtraType

NotificationExtraTypeEnum com.netease.nimlib.sdk.StatusBarNotificationConfig.notificationExtraType = NotificationExtraTypeEnum.MESSAGE

点击通知栏传递的extra类型

在文件 StatusBarNotificationConfig.java135 行定义.

◆ notificationFilter

StatusBarNotificationFilter com.netease.nimlib.sdk.StatusBarNotificationConfig.notificationFilter = null

弹StatusBarNotification之前,SDK通过改接口询问App,根据App返回结果决定是否弹出通知 为空等同于返回DEFAULT

在文件 StatusBarNotificationConfig.java141 行定义.

◆ notificationFolded

boolean com.netease.nimlib.sdk.StatusBarNotificationConfig.notificationFolded = true

该字段已废弃

参见
NotificationFoldStyle

在文件 StatusBarNotificationConfig.java108 行定义.

◆ notificationFoldStyle

NotificationFoldStyle com.netease.nimlib.sdk.StatusBarNotificationConfig.notificationFoldStyle = NotificationFoldStyle.ALL

消息通知栏的折叠类型,不配置时,以notificationFolded的值为准, 如果为null,表示默认所有折叠

在文件 StatusBarNotificationConfig.java113 行定义.

◆ notificationSmallIconId

int com.netease.nimlib.sdk.StatusBarNotificationConfig.notificationSmallIconId

状态栏提醒的小图标的资源ID。
如果不提供,使用app的icon

在文件 StatusBarNotificationConfig.java18 行定义.

◆ notificationSound

String com.netease.nimlib.sdk.StatusBarNotificationConfig.notificationSound

响铃提醒的声音资源,如果不提供,使用系统默认提示音。

在文件 StatusBarNotificationConfig.java29 行定义.

◆ postNotificationsRequester

NimPermissionRequester com.netease.nimlib.sdk.StatusBarNotificationConfig.postNotificationsRequester = null

Android13 弹出通知之前,SDK通过改接口向App请求权限Manifest.permission#POST_NOTIFICATIONS,根据权限赋予结果决定是否弹出通知

在文件 StatusBarNotificationConfig.java145 行定义.

◆ ring

boolean com.netease.nimlib.sdk.StatusBarNotificationConfig.ring = true

是否需要响铃提醒。
默认为true

在文件 StatusBarNotificationConfig.java24 行定义.

◆ showBadge

boolean com.netease.nimlib.sdk.StatusBarNotificationConfig.showBadge = true

是否APP图标显示未读数(红点) 仅针对Android 8.0+有效

在文件 StatusBarNotificationConfig.java125 行定义.

◆ titleOnlyShowAppName

boolean com.netease.nimlib.sdk.StatusBarNotificationConfig.titleOnlyShowAppName = false

通知栏提醒的标题是否只显示应用名。默认是 false,当有一个会话发来消息时,显示会话名;当有多个会话发来时,显示应用名。 修改为true,那么无论一个还是多个会话发来消息,标题均显示应用名。 应用名称请在AndroidManifest的application节点下设置android:label。

在文件 StatusBarNotificationConfig.java100 行定义.

◆ vibrate

boolean com.netease.nimlib.sdk.StatusBarNotificationConfig.vibrate = true

是否需要振动提醒。
默认为true

在文件 StatusBarNotificationConfig.java35 行定义.


该类的文档由以下文件生成: