public class NotificationCompat
extends Object
java.lang.Object | |
↳ | android.support.v4.app.NotificationCompat |
Known Direct Subclasses |
Helper用于访问API级别4之后以向后兼容的方式引入的 Notification
功能。
Nested classes |
|
---|---|
class |
NotificationCompat.Action 结构来封装可作为此通知的一部分显示的命名操作。 |
class |
NotificationCompat.BigPictureStyle 帮助程序类用于生成包含大图像附件的大幅面通知。 |
class |
NotificationCompat.BigTextStyle 用于生成包含大量文本的大格式通知的助手类。 |
class |
NotificationCompat.Builder 生成器类为 |
class |
NotificationCompat.CarExtender
Helper类将Android Auto扩展添加到通知。 |
interface |
NotificationCompat.Extender |
class |
NotificationCompat.InboxStyle Helper类用于生成包含(最多5个)字符串列表的大型通知。 |
class |
NotificationCompat.MessagingStyle Helper类用于生成包含多个不同类型的多个来回消息的大格式通知。 |
class |
NotificationCompat.Style 可以将丰富的通知样式应用于 |
class |
NotificationCompat.WearableExtender 助手类为通知添加可穿戴扩展。 |
Public constructors |
|
---|---|
NotificationCompat() |
Public methods |
|
---|---|
static NotificationCompat.Action |
getAction(Notification notif, int actionIndex) 以向后兼容的方式对此通知采取行动。 |
static int |
getActionCount(Notification notif) 以向后兼容的方式获取此通知中的操作数量。 |
static String |
getCategory(Notification notif) 以向后兼容的方式获取此通知的类别。 |
static Bundle |
getExtras(Notification notif) 以向后兼容的方式从通知中获取 |
static String |
getGroup(Notification notif) 获取用于将此通知分组到群集或堆栈中的密钥,以及支持此类呈现的设备上的其他通知。 |
static boolean |
getLocalOnly(Notification notif) 获取此通知是否仅与当前设备相关。 |
static String |
getSortKey(Notification notif) 获取一个排序关键字,可以从同一个包中的其他通知中排列此通知。 |
static boolean |
isGroupSummary(Notification notif) 获取此通知是否是一组通知的组摘要。 |
Inherited methods |
|
---|---|
From class java.lang.Object
|
String CATEGORY_RECOMMENDATION
通知类别:针对单一事物的特定及时推荐。 例如,新闻应用可能希望推荐一个它认为用户将要接下来要阅读的新闻报道。
常数值:“推荐”
int COLOR_DEFAULT
color
值等于0(也称为 Color.TRANSPARENT
),告诉系统不要使用任何特殊颜色修饰此通知,而是在呈现此通知时使用默认颜色。
常量值:0(0x00000000)
int DEFAULT_ALL
使用所有默认值(如果适用)。
常量值:-1(0xffffffff)
int DEFAULT_LIGHTS
使用默认通知灯。 这将忽略FLAG_SHOW_LIGHTS
位,并使用setLights(int, int, int)
设置值。
也可以看看:
常量值:4(0x00000004)
int DEFAULT_SOUND
使用默认通知声音。 这将忽略使用setSound(Uri)
设置的任何声音
嘈杂的通知更有可能在某些平台上作为单挑通知呈现。
也可以看看:
常数值:1(0x00000001)
int DEFAULT_VIBRATE
使用默认通知振动。 这将忽略使用setVibrate(long[])
任何振动组。 使用手机振动需要VIBRATE
权限。
振动通知更有可能在某些平台上作为单挑通知呈现。
也可以看看:
常量值:2(0x00000002)
String EXTRA_BACKGROUND_IMAGE_URI
通知额外键: content URI
指向选定通知时可以在后台显示的图像。 URI必须指向适合传入BitmapFactory.decodeStream
的图像流; 所有其他内容类型将被忽略。 用于此目的的内容提供者URI不需要读取图像数据的权限。
常量值:“android.backgroundImageUri”
String EXTRA_BIG_TEXT
通知附加键:这是 NotificationCompat.BigTextStyle
通知的大格式中显示的较长文本,提供给 bigText(CharSequence)
。
常量值:“android.bigText”
String EXTRA_COMPACT_ACTIONS
通知额外密钥:提供给(例如) setShowActionsInCompactView(int)
的紧凑视图中要显示的操作索引。
常量值:“android.compactActions”
String EXTRA_CONVERSATION_TITLE
通知密钥: String
将显示为由 NotificationCompat.MessagingStyle
表示的对话的标题
常量值:“android.conversationTitle”
String EXTRA_INFO_TEXT
通知额外密钥:这是提供给 setContentInfo(CharSequence)
附加文本。
常量值:“android.infoText”
String EXTRA_LARGE_ICON
通知额外密钥:当显示通知有效负载时,这是一个位图,而不是小图标,提供给 setLargeIcon(android.graphics.Bitmap)
。
常量值:“android.largeIcon”
String EXTRA_LARGE_ICON_BIG
通知额外密钥:当通知以展开形式显示时,这是一个要使用的位图,而不是 setLargeIcon(android.graphics.Bitmap)
的位图,提供给 bigLargeIcon(android.graphics.Bitmap)
。
常量值:“android.largeIcon.big”
String EXTRA_MEDIA_SESSION
通知关键:一个 MediaSession.Token
与相关 Notification.MediaStyle
通知。
常量值:“android.mediaSession”
String EXTRA_MESSAGES
通知密钥: Bundle
对象的数组,代表 NotificationCompat.MessagingStyle
通知的 NotificationCompat.MessagingStyle.Message
对象。
常量值:“android.messages”
String EXTRA_PEOPLE
通知额外密钥:包含此通知相关人员的字符串数组,每个数据都提供给 addPerson(String)
。
常量值:“android.people”
String EXTRA_PICTURE
通知额外密钥:这是一个位图,显示在 NotificationCompat.BigPictureStyle
扩展通知中,提供给 bigPicture(android.graphics.Bitmap)
。
常量值:“android.picture”
String EXTRA_PROGRESS
通知额外密钥:这是提供给 setProgress(int, int, boolean)
的进度值。
常量值:“android.progress”
String EXTRA_PROGRESS_INDETERMINATE
通知附加键:进度条是否不确定,提供给 setProgress(int, int, boolean)
。
常量值:“android.progressIndeterminate”
String EXTRA_PROGRESS_MAX
通知额外密钥:这是提供给 setProgress(int, int, boolean)
的最大值。
常量值:“android.progressMax”
String EXTRA_REMOTE_INPUT_HISTORY
通知额外密钥:这是远程输入历史记录,提供给setRemoteInputHistory(CharSequence[])
。 应用程序可以通过setRemoteInputHistory(CharSequence[])
填写最新的输入,这些输入是通过本通知的RemoteInput
发送的,并且一旦它不再相关(例如,一旦对方已响应,聊天通知)就会清除它。 此密钥的额外属性是CharSequence []类型,并且包含0索引处的最新条目,1索引处的最近第二条目,等等。
常量值:“android.remoteInputHistory”
String EXTRA_SELF_DISPLAY_NAME
通知密钥:显示用户发送的所有消息的用户名,包括直接回复 NotificationCompat.MessagingStyle
通知。
常量值:“android.selfDisplayName”
String EXTRA_SHOW_CHRONOMETER
通知额外密钥:是否应将使用 setWhen(long)
设置的when字段显示为提供给 setUsesChronometer(boolean)
的 Chronometer
计时器(具体为 Chronometer
)而不是时间戳。
常量值:“android.showChronometer”
String EXTRA_SHOW_WHEN
通知额外密钥:是否应该显示使用 setWhen(long)
设置的时间字段,如提供给 setShowWhen(boolean)
。
常量值:“android.showWhen”
String EXTRA_SMALL_ICON
通知额外密钥:这是通知的主要小图标的资源ID,提供给 setSmallIcon(int)
。
常量值:“android.icon”
String EXTRA_SUB_TEXT
通知额外密钥:这是提供给 setSubText(CharSequence)
的第三行文本。
常量值:“android.subText”
String EXTRA_SUMMARY_TEXT
通知额外关键字:这是一行概要信息,旨在与提供给(例如) setSummaryText(CharSequence)
扩展通知一起显示。
常量值:“android.summaryText”
String EXTRA_TEMPLATE
通知额外密钥:表示用于创建此通知的特定 Notification.Style
的名称的字符串。
常量值:“android.template”
String EXTRA_TEXT_LINES
通知额外密钥:要在 NotificationCompat.InboxStyle
显示的CharSequences数组扩展通知,其中每个都提供给 addLine(CharSequence)
。
常量值:“android.textLines”
String EXTRA_TITLE
通知额外密钥:这是提供给 setContentTitle(CharSequence)
的通知的标题。
常量值:“android.title”
String EXTRA_TITLE_BIG
通知额外密钥:这是以展开形式显示时通知的标题,例如提供给 setBigContentTitle(CharSequence)
。
常量值:“android.title.big”
int FLAG_AUTO_CANCEL
如果通知在用户点击时应该取消,则在通知标志字段中设置位。
常量值:16(0x00000010)
int FLAG_FOREGROUND_SERVICE
如果此通知表示当前正在运行的服务,则在通知标志字段中设置位。 这通常由startForeground(int, Notification)
为您设置。
常量值:64(0x00000040)
int FLAG_GROUP_SUMMARY
如果此通知是一组通知的组摘要,则在通知标志字段中设置位。 分组通知可以显示在支持这种呈现的设备上的群集或堆栈中。 需要使用setGroup(String)
来设置组密钥。
常量值:512(0x00000200)
int FLAG_HIGH_PRIORITY
这个常数已被弃用。
使用setPriority(int)
具有正值。
指示高优先级通知的过时标志; 改用优先权字段。
常量值:128(0x00000080)
int FLAG_INSISTENT
如果音频将被重复,直到通知被取消或通知窗口打开,则在通知标志字段中设置位。
常量值:4(0x00000004)
int FLAG_LOCAL_ONLY
如果此通知仅与当前设备相关,则在通知标志字段中设置位,并且不建议它桥接到其他设备。
常量值:256(0x00000100)
int FLAG_NO_CLEAR
如果在用户单击“全部清除”按钮时不应取消通知,则在通知标志字段中设置位。
常量值:32(0x00000020)
int FLAG_ONGOING_EVENT
如果此通知引用正在进行的某些事件(如电话呼叫),则在通知标志字段中设置位。 如果此通知是针对某个特定时间点发生的事件(例如未接电话),则不应设置。
常量值:2(0x00000002)
int FLAG_ONLY_ALERT_ONCE
如果通知声音,振动和滚动条只应在通知尚未显示时播放,则在通知标志字段中设置位。
常量值:8(0x00000008)
int FLAG_SHOW_LIGHTS
当此通知的LED应该打开时,在通知标志字段中设置的位。
常数值:1(0x00000001)
int PRIORITY_DEFAULT
默认通知优先级为setPriority(int)
。 如果您的应用程序未优先处理自己的通知,请将此值用于所有通知。
常量值:0(0x00000000)
int PRIORITY_HIGH
更高的通知优先级为setPriority(int)
,用于更重要的通知或警报。 与您的应用PRIORITY_DEFAULT
项目相比,用户界面可能会选择将这些项目PRIORITY_DEFAULT
或放在通知列表中的不同位置。
常数值:1(0x00000001)
int PRIORITY_LOW
对于不太重要的项目,通知优先级为setPriority(int)
。 与您的应用的PRIORITY_DEFAULT
项目相比,用户界面可以选择显示较小的项目,或列表中不同的位置。
常量值:-1(0xffffffff)
int PRIORITY_MIN
setPriority(int)
最低通知优先级; 除特殊情况外,这些项目可能不会显示给用户,例如详细的通知日志。
常量值:-2(0xfffffffe)
int STREAM_DEFAULT
使用此常量作为audioStreamType的值来请求使用通知的默认流类型。 目前默认流类型是STREAM_NOTIFICATION
。
常量值:-1(0xffffffff)
int VISIBILITY_PRIVATE
通知可见性:在所有锁屏上显示此通知,但隐藏安全锁屏上的敏感或隐私信息。
也可以看看:
常量值:0(0x00000000)
int VISIBILITY_SECRET
通知可见性:请勿在安全锁屏上显示此通知的任何部分。
也可以看看:
常量值:-1(0xffffffff)
NotificationCompat ()
NotificationCompat.Action getAction (Notification notif, int actionIndex)
以向后兼容的方式对此通知采取行动。 JellyBean(API级别16)向前支持操作。
Parameters | |
---|---|
notif |
Notification : The notification to inspect. |
actionIndex |
int : The index of the action to retrieve. |
Returns | |
---|---|
NotificationCompat.Action |
int getActionCount (Notification notif)
以向后兼容的方式获取此通知中的操作数量。 JellyBean(API级别16)向前支持操作。
Parameters | |
---|---|
notif |
Notification
|
Returns | |
---|---|
int |
String getCategory (Notification notif)
以向后兼容的方式获取此通知的类别。
Parameters | |
---|---|
notif |
Notification : The notification to inspect. |
Returns | |
---|---|
String |
Bundle getExtras (Notification notif)
以向后兼容的方式从通知中获取extras
字段。 JellyBean(API等级16)向前支持Extras字段。 这个函数将在旧的api级别上返回null。
Parameters | |
---|---|
notif |
Notification
|
Returns | |
---|---|
Bundle |
String getGroup (Notification notif)
获取用于将此通知分组到群集或堆栈中的密钥,以及支持此类呈现的设备上的其他通知。
Parameters | |
---|---|
notif |
Notification
|
Returns | |
---|---|
String |
boolean getLocalOnly (Notification notif)
获取此通知是否仅与当前设备相关。
有些通知可以桥接到其他设备进行远程显示。 如果此提示已设置,建议不要桥接此通知。
Parameters | |
---|---|
notif |
Notification
|
Returns | |
---|---|
boolean |
String getSortKey (Notification notif)
获取一个排序关键字,可以从同一个包中的其他通知中排列此通知。 如果已经应用了外部排序并且应用程序想要保留这一点,这可能很有用。 通知将按照字典顺序使用此值进行排序,但除了提供排序键之外,提供不同的优先级可能会导致忽略此值。
此排序关键字也可用于订购通知组的成员。 见setGroup(String)
。
Parameters | |
---|---|
notif |
Notification
|
Returns | |
---|---|
String |
也可以看看:
boolean isGroupSummary (Notification notif)
获取此通知是否是一组通知的组摘要。 分组通知可以显示在支持这种呈现的设备上的群集或堆栈中。 需要使用setGroup(String)
来设置组密钥。
Parameters | |
---|---|
notif |
Notification
|
Returns | |
---|---|
boolean |
Whether this notification is a group summary. |