StatusBarNotificationConfig.java

浏览该文件的文档.

package com.netease.nimlib.sdk;

import android.app.Activity;
import android.Manifest;
import com.netease.nimlib.sdk.msg.constant.NotificationExtraTypeEnum;

import java.io.Serializable;

/**
 * SDK提供状态栏提醒的配置
 */
public class StatusBarNotificationConfig implements Serializable {

    /**
     * 状态栏提醒的小图标的资源ID。<br>
     * 如果不提供，使用app的icon
     */
    public int notificationSmallIconId;

    /**
     * 是否需要响铃提醒。<br>
     * 默认为true
     */
    public boolean ring = true;

    /**
     * 响铃提醒的声音资源，如果不提供，使用系统默认提示音。
     */
    public String notificationSound;

    /**
     * 是否需要振动提醒。<br>
     * 默认为true
     */
    public boolean vibrate = true;

    /**
     * 呼吸灯的颜色
     * The color of the led.  The hardware will do its best approximation.
     * 建议尽量使用绿色、蓝色、红色等基本颜色，不要去用混合色。
     */
    public int ledARGB = -1;

    /**
     * 呼吸灯亮时的持续时间（毫秒）
     * The number of milliseconds for the LED to be on while it's flashing.
     * The hardware will do its best approximation.
     */
    public int ledOnMs = -1;

    /**
     * 呼吸灯熄灭时的持续时间（毫秒）
     * The number of milliseconds for the LED to be off while it's flashing.
     * The hardware will do its best approximation.
     */
    public int ledOffMs = -1;

    /**
     * 不显示消息详情开关, 同时也不再显示消息发送者昵称<br>
     * 默认为false
     */
    public boolean hideContent = false;


    /**
     * 免打扰设置开关。默认为关闭。
     */
    public boolean downTimeToggle = false;


    /**
     * 免打扰的开始时间, 格式为HH:mm(24小时制)。
     */
    public String downTimeBegin;


    /**
     * 免打扰的结束时间, 格式为HH:mm(24小时制)。<br>
     * 如果结束时间小于开始时间，免打扰时间为开始时间-24:00-结束时间。
     */
    public String downTimeEnd;

    /**
     * 免打扰期间，是否显示通知，默认为显示
     */
    public boolean downTimeEnableNotification = true;


    /**
     * 通知栏提醒的响应intent的activity类型。<br>
     * 可以为null。如果未提供，将使用包的launcher的入口intent的activity。
     */
    public Class<? extends Activity> notificationEntrance;

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

    /**
     * 该字段已废弃
     *
     * @see NotificationFoldStyle
     */
    @Deprecated
    public boolean notificationFolded = true;

    /**
     * 消息通知栏的折叠类型，不配置时，以notificationFolded的值为准, 如果为null，表示默认所有折叠
     */
    public NotificationFoldStyle notificationFoldStyle = NotificationFoldStyle.ALL;

    /**
     * 消息通知栏颜色，将应用到 NotificationCompat.Builder 的 setColor 方法
     * 对Android 5.0 以后机型会影响到smallIcon
     */
    public int notificationColor;

    /**
     * 是否APP图标显示未读数(红点)
     * 仅针对Android 8.0+有效
     */
    public boolean showBadge = true;

    /**
     * 如果群名称为null 或者空串，则使用customTitleWhenTeamNameEmpty 作为通知栏title
     */
    public String customTitleWhenTeamNameEmpty;

    /**
     * 点击通知栏传递的extra类型
     */
    public NotificationExtraTypeEnum notificationExtraType = NotificationExtraTypeEnum.MESSAGE;

    /**
     * 弹StatusBarNotification之前，SDK通过改接口询问App，根据App返回结果决定是否弹出通知
     * 为空等同于返回DEFAULT
     */
    public StatusBarNotificationFilter notificationFilter = null;
    /**
     * Android13 弹出通知之前，SDK通过改接口向App请求权限{@link Manifest.permission#POST_NOTIFICATIONS}，根据权限赋予结果决定是否弹出通知
     */
    public NimPermissionRequester postNotificationsRequester = null;
}