Notification 类
定义
重要
一些信息与预发行产品相关,相应产品在发行之前可能会进行重大修改。 对于此处提供的信息,Microsoft 不作任何明示或暗示的担保。
一个类,表示如何使用 NotificationManager 向用户显示持久通知。
[Android.Runtime.Register("android/app/Notification", DoNotGenerateAcw=true)]
public class Notification : Java.Lang.Object, Android.OS.IParcelable, IDisposable
[<Android.Runtime.Register("android/app/Notification", DoNotGenerateAcw=true)>]
type Notification = class
inherit Object
interface IParcelable
interface IJavaObject
interface IDisposable
interface IJavaPeerable
- 继承
- 特性
- 实现
注解
一个类,表示如何使用 NotificationManager 向用户显示持久通知。 已添加 Notification.Builder,以便更轻松地构造通知。
有关创建通知的指南,请阅读状态栏通知开发人员指南。
Android 参考。android.app.Notification
本页的某些部分是根据 创建和共享的工作进行的修改,并根据 许可证中所述的条款使用。
构造函数
| 名称 | 说明 |
|---|---|
| Notification() |
构造具有默认值的 Notification 对象。 |
| Notification(Int32, ICharSequence, Int64) |
已过时.
此构造函数已弃用。 |
| Notification(Int32, ICharSequence) |
|
| Notification(Int32, String, Int64) |
此构造函数已弃用。 |
| Notification(Int32, String) |
|
| Notification(IntPtr, JniHandleOwnership) |
初始化现有 Java Native Interface 对象的托管表示形式。 |
| Notification(Parcel) |
取消包裹中的通知。 |
字段
| 名称 | 说明 |
|---|---|
| ActionBridgedNotificationPreferences |
一个活动,它提供用于调整其桥接通知的桥接通知的用户界面,该通知源自另一台设备。 |
| CategoryAlarm |
通知类别:警报或计时器。 |
| CategoryCall |
通知类别:传入呼叫(语音或视频)或类似的同步通信请求。 |
| CategoryEmail |
通知类别:异步批量消息(电子邮件)。 |
| CategoryError |
通知类别:后台操作或身份验证状态错误。 |
| CategoryEvent |
通知类别:日历事件。 |
| CategoryLocationSharing |
通知类别:暂时共享位置。 |
| CategoryMessage |
通知类别:传入直接消息(短信、即时消息等)。 |
| CategoryMissedCall |
通知类别:错过呼叫。 |
| CategoryNavigation |
通知类别:地图逐轮导航。 |
| CategoryProgress |
通知类别:长时间运行的后台操作的进度。 |
| CategoryPromo |
通知类别:促销或广告。 |
| CategoryRecommendation |
通知类别:针对单个内容的特定、及时的建议。 |
| CategoryReminder |
通知类别:用户计划提醒。 |
| CategoryService |
通知类别:指示正在运行的后台服务。 |
| CategorySocial |
通知类别:社交网络或共享更新。 |
| CategoryStatus |
通知类别:有关设备或上下文状态的持续信息。 |
| CategoryStopwatch |
通知类别:运行秒表。 |
| CategorySystem |
通知类别:系统或设备状态更新。 |
| CategoryTransport |
通知类别:用于播放的媒体传输控件。 |
| CategoryVoicemail |
通知类别:语音邮件。 |
| CategoryWorkout |
通知类别:跟踪用户的锻炼。 |
| ColorDefault |
颜色的特殊值指示系统不要用任何特殊颜色修饰此元素(但改用默认系统颜色)。 |
| ExtraAnswerColor |
extras 键:用作 Notification.CallStyle 通知的“应答操作”按钮提示的颜色。 |
| ExtraAnswerIntent |
extras 键:当用户回答 Notification.CallStyle 通知时要发送的意向。 |
| ExtraAudioContentsUri |
附加键:此通知的音频内容。 |
| ExtraBackgroundImageUri |
附加键:指向在选择通知时可在后台显示的图像的内容 URI 的平面字符串表示形式。 |
| ExtraBigText |
extras 键:这是 BigTextStyle 通知的扩展形式中显示的较长文本,如提供给 BigTextStyle.bigText(CharSequence)。 |
| ExtraCallIsVideo |
附加键:Notification.CallStyle 通知是否用于在接听时激活视频的呼叫。 |
| ExtraCallPerson |
extras 键:要显示为呼叫 Notification.CallStyle 通知的人员。 |
| ExtraCallType |
extras 键:Notification.CallStyle 通知表示的调用类型。 |
| ExtraChannelGroupId |
可选附加INTENT_CATEGORY_NOTIFICATION_PREFERENCES。 |
| ExtraChannelId |
可选附加INTENT_CATEGORY_NOTIFICATION_PREFERENCES。 |
| ExtraChronometerCountDown |
额外键:在通知上设置的计时表是否应倒计时,而不是计数。 |
| ExtraColorized |
extras 键:是否应将通知着色为 Builder.setColorized(布尔值)。 |
| ExtraCompactActions |
extras 键:要显示在紧凑视图中的操作的索引,如 (例如) MediaStyle.setShowActionsInCompactView(int...) 提供)。 |
| ExtraConversationTitle |
extras 键:要显示为 Notification.MessagingStyle 表示的对话的标题的 CharSequence |
| ExtraDeclineColor |
附加键:用作 Notification.CallStyle 通知的“拒绝”或“挂起”操作按钮的提示的颜色。 |
| ExtraDeclineIntent |
extras 键:当用户拒绝 Notification.CallStyle 通知时发送的意向。 |
| ExtraHangUpIntent |
extras 键:当用户挂起 Notification.CallStyle 通知时要发送的意向。 |
| ExtraHistoricMessages |
extras 键:Notification.MessagingStyle 通知提供的历史性 Notification.MessagingStyle.Message 捆绑包数组。 |
| ExtraInfoText |
extras 键:这是向 Builder.setContentInfo(CharSequence)提供的一小段附加文本。 |
| ExtraIsGroupConversation |
extras 键:Notification.MessagingStyle 通知是否表示组对话。 |
| ExtraLargeIcon |
API 级别 26 中已弃用此常量。 |
| ExtraLargeIconBig |
extras 键:当通知以扩展形式显示时,这是一个位图,而不是使用 Builder.setLargeIcon(android.graphics.Bitmap)中的位图,如 BigPictureStyle.bigLargeIcon(android.graphics.Bitmap) 提供)。 |
| ExtraMediaSession |
extras 键:与 Notification.MediaStyle 通知关联的 MediaSession.Token。 |
| ExtraMessages |
extras 键:Notification.MessagingStyle.Message 捆绑包的数组,由 Notification.MessagingStyle 通知提供。 |
| ExtraMessagingPerson |
附加键:要为用户发送的所有邮件显示的人员,包括直接答复 Notification.MessagingStyle 通知。 |
| ExtraNotificationId |
可选附加INTENT_CATEGORY_NOTIFICATION_PREFERENCES。 |
| ExtraNotificationTag |
可选附加INTENT_CATEGORY_NOTIFICATION_PREFERENCES。 |
| ExtraPeople |
此常量在 API 级别 28 中已弃用。 |
| ExtraPeopleList |
extras 键:包含此通知与之相关的人员的 Person 对象的 arrayList。 |
| ExtraPicture |
extras 键:这是要显示在 BigPictureStyle 扩展通知中的位图,提供给 BigPictureStyle.bigPicture(android.graphics.Bitmap)。 |
| ExtraPictureContentDescription |
extras 键:这是从 BigPictureStyle.bigPicture(Bitmap)提供的大图片的内容说明,提供给 BigPictureStyle.setContentDescription(CharSequence)。 |
| ExtraPictureIcon |
extras 键:这是要显示在 BigPictureStyle 扩展通知中的图像的图标,提供给 BigPictureStyle.bigPicture(Icon)。 |
| ExtraPreferSmallIcon |
请求通知卡显示小图标而不是启动器应用图标的额外项的布尔值。 |
| ExtraProgress |
extras 键:这是提供给 Builder.setProgress(int,int,boolean)的进度值。 |
| ExtraProgressIndeterminate |
extras 键:进度栏是否不确定,提供给 Builder.setProgress(int,int,boolean)。 |
| ExtraProgressMax |
extras 键:这是提供给 Builder.setProgress(int,int,boolean)的最大值。 |
| ExtraRemoteInputDraft |
如果用户单击该通知时包含 RemoteInput 的未发送草稿,我们将使用此键将草稿作为字符串添加到 contentIntent 中。 |
| ExtraRemoteInputHistory |
extras 键:这是向 Builder.setRemoteInputHistory(CharSequence[])提供的远程输入历史记录。 |
| ExtraRequestPromotedOngoing |
extras 键:如果提供,应包含一个布尔值,指示通知是否请求提升的治疗。 |
| ExtraSelfDisplayName |
此常量在 API 级别 28 中已弃用。 |
| ExtraShowBigPictureWhenCollapsed |
extras 键:这是一个布尔值,指示要以 BigPictureStyle 通知的折叠状态显示大图片。 |
| ExtraShowChronometer |
extras 键:是否应将何时显示为计数计时器(特别是计时计),而不是时间戳,如 Builder.setUsesChronometer(布尔值)。 |
| ExtraShowWhen |
extras 键:是否应按向 Builder.setShowWhen(boolean)提供何时显示。 |
| ExtraSmallIcon |
API 级别 26 中已弃用此常量。 |
| ExtraSubText |
extras 键:这是向 Builder.setSubText(CharSequence)提供的第三行文本。 |
| ExtraSummaryText |
extras 键:这是一行摘要信息,旨在与扩展的通知一起显示,如提供给 (例如) BigTextStyle.setSummaryText(CharSequence)。 |
| ExtraTemplate |
extras 键:一个字符串,表示用于创建此通知的特定 Notification.Style 的名称。 |
| ExtraText |
extras 键:这是主文本有效负载,如 Builder.setContentText(CharSequence)提供)。 |
| ExtraTextLines |
extras 键:用于在 InboxStyle 扩展通知中显示 CharSequences 的数组,其中每个通知都提供给 InboxStyle.addLine(CharSequence)。 |
| ExtraTitle |
extras 键:这是通知的标题,如 Builder.setContentTitle(CharSequence)提供)。 |
| ExtraTitleBig |
extras 键:当以扩展形式显示时,这是通知的标题,例如提供给 BigTextStyle.setBigContentTitle(CharSequence)。 |
| ExtraVerificationIcon |
extras 键:在 Notification.CallStyle 通知上显示为呼叫者的验证状态的图标。 |
| ExtraVerificationText |
附加键:在 Notification.CallStyle 通知上显示为呼叫者的验证状态的文本。 |
| FlagPromotedOngoing |
已过时.
如果此通知是提升的正在进行的通知,则为按位 ORed 进入标志字段,这两者都是因为它具有PromotableCharacteristics(),并且用户尚未禁用此应用的功能。 |
| ForegroundServiceDefault |
已过时.
如果使用 Notification.Builder.setForegroundServiceBehavior(int) 生成了与启动前台服务的通知,则通知的显示通常会在短时间内被禁止显示,以避免对用户造成视觉干扰。 |
| ForegroundServiceDeferred |
已过时.
如果使用 Notification.Builder.setForegroundServiceBehavior(int) 生成了与启动前台服务的通知,则通知的显示通常会在短时间内被禁止显示,以避免对用户造成视觉干扰。 |
| ForegroundServiceImmediate |
已过时.
如果使用 Notification.Builder.setForegroundServiceBehavior(int) 生成了与启动前台服务的通知,则即使默认行为将延迟短时间,通知的显示也会立即显示。 |
| IntentCategoryNotificationPreferences |
一个活动,提供用于调整其包含应用程序的通知首选项的用户界面。 |
| PriorityDefault |
API 级别 26 中已弃用此常量。 |
| PriorityHigh |
API 级别 26 中已弃用此常量。 |
| PriorityLow |
API 级别 26 中已弃用此常量。 |
| PriorityMax |
API 级别 26 中已弃用此常量。 |
| PriorityMin |
API 级别 26 中已弃用此常量。 |
| SemanticStyleCaution |
已过时.
此值用于批注元素,指示语义层次结构上的警告、中等紧迫性、迟缓或另一个“中间”值。 |
| SemanticStyleDanger |
已过时.
此值用于批注元素,指示危险、极端紧迫性或延迟,或语义层次结构上的另一个“极端”值。 |
| SemanticStyleInfo |
已过时.
此值用于批注元素,以指示应从其他内容中脱颖而出但不属于缩放或层次结构的信息。 |
| SemanticStyleSafe |
已过时.
此值用于批注元素,指示语义层次结构上的安全、非紧急性、时间线或其他“温和”值。 |
| SemanticStyleUnspecified |
已过时.
这是语义样式的默认值,表示没有特定的语义。 |
属性
| 名称 | 说明 |
|---|---|
| Actions |
由 Builder.addAction(int,CharSequence,PendingIntent)附加到此通知的所有操作结构的数组。 |
| AllowSystemGeneratedContextualActions |
返回平台是否允许(由应用开发人员)为此通知生成上下文操作。 |
| AudioAttributes |
此字段在 API 级别 26 中已弃用。 |
| AudioAttributesDefault |
audioAttributes 的默认值。 |
| AudioStreamType |
已过时.
此字段在 API 级别 21 中已弃用。 |
| BadgeIconType |
如果在支持错误处理的启动器中显示该通知,则返回应显示该通知的图标。 |
| BigContentView |
已过时.
ContentView 的大型格式版本,使通知有机会在展开时显示更多详细信息。 |
| Category |
预定义通知类别之一(请参阅最能描述此通知的 CATEGORY_* 常量)。 |
| ChannelId |
返回此通知发布到的频道 ID。 |
| Class |
返回此 |
| Color |
主题色(ARGB 整数(如 Color 中的常量)在演示此通知时由标准样式模板应用。 |
| ContentIntent |
单击展开状态项时要执行的意向。 |
| ContentView |
已过时.
将在通知列表中表示此通知的视图(从状态栏拉取)。 |
| ContextualActions |
返回此通知中操作的上下文(即通知内容建议)的操作。 |
| Creator |
用于实例化 Notification 对象的 Parcelable.Creator |
| Defaults |
此字段在 API 级别 26 中已弃用。 |
| DeleteIntent |
当用户通过“全部清除”按钮或逐个轻扫通知时执行该通知的意图。 |
| Extras |
要随此通知一起传递的其他语义数据。 |
| Flags |
获取或设置通知行为标志掩码。 |
| FullScreenIntent |
要启动的意向,而不是将通知发布到状态栏。 |
| Group |
获取用于将此通知分组到支持此类呈现的设备上的其他通知的群集或堆栈中的密钥。 |
| GroupAlertBehavior |
返回组中的通知类型负责通知用户。 |
| Handle |
基础 Android 实例的句柄。 (继承自 Object) |
| HasImage |
检查消息图像附件,或大型图标或背景图像条目是否有其他通知内容。 |
| HasPromotableCharacteristics |
返回通知是否具有使通知符合FLAG_PROMOTED_ONGOING条件的所有特征。 |
| HasSummarizedContent |
返回此通知是否包含计算汇总的文本。 |
| HeadsUpContentView |
已过时.
contentView 的中等格式版本,为通知提供了向 contentView 添加操作按钮的机会。 |
| Icon |
已过时.
此字段在 API 级别 23 中已弃用。 |
| IconLevel |
如果状态栏中的图标具有多个级别,可以设置此级别。 |
| IsRequestPromotedOngoing |
返回此通知是否已请求成为正在升级的通知。 |
| JniIdentityHashCode |
获取互操作运行时分配给此Java对等的标识哈希代码。 (继承自 Object) |
| JniManagedPeerState |
获取运行时上次分配的状态标志。 (继承自 JavaObject) |
| JniPeerMembers |
为 Android.App.Notification 提供 JNI 绑定基础结构。 |
| LargeIcon |
已过时.
此字段在 API 级别 23 中已弃用。 |
| LedARGB |
此字段在 API 级别 26 中已弃用。 |
| LedOffMS |
此字段在 API 级别 26 中已弃用。 |
| LedOnMS |
此字段在 API 级别 26 中已弃用。 |
| LocusId |
获取与此通知关联的 LocusId。 |
| Number |
此通知表示的事件数。 |
| PeerReference |
获取此Java对等方的 JNI 对象引用。 (继承自 Object) |
| Priority |
此字段在 API 级别 26 中已弃用。 |
| PublicVersion |
此通知的替换版本,其内容将显示在不安全的上下文中,例如安全密钥保护器上。 |
| SettingsText |
获取作为托管字符串的通知设置文本。 |
| SettingsTextFormatted |
返回提供给 Builder.setSettingsText(CharSequence)的设置文本。 |
| ShortCriticalText |
返回汇总通知中包含的最关键信息的文本,如果未设置此字段,则返回 null。 |
| ShortcutId |
返回此通知取代的 ID(如果有)。 |
| SmallIcon |
在状态栏中表示此通知的小图标。 |
| SortKey |
获取排序键,该键将此通知排序到同一包中的其他通知中。 |
| Sound |
此字段在 API 级别 26 中已弃用。 |
| ThresholdClass |
为 Android.App.Notification 提供 JNI 绑定基础结构。 |
| ThresholdType |
为 Android.App.Notification 提供 JNI 绑定基础结构。 |
| TickerText |
总结此辅助功能服务通知的文本。 |
| TickerView |
已过时.
以前,显示 tickerText 的视图。 |
| TimeoutAfter |
返回发布后的持续时间,系统应取消此通知(如果尚未取消)。 |
| Vibrate |
此字段在 API 级别 26 中已弃用。 |
| Visibility |
此通知的可见性范围,影响 SystemUI 在不受信任的情况下(即安全锁屏和屏幕共享期间)显示通知的存在和内容的方式和时间。 |
| When |
与此通知相关的时间戳,自纪元以来,以毫秒为单位。 |
方法
| 名称 | 说明 |
|---|---|
| Clone() |
创建并返回此对象的副本。 |
| Construct(JniObjectReference, JniObjectReferenceOptions) |
将此对等方的构造委托给运行时的值管理器。 (继承自 JavaObject) |
| CreateSemanticStyleAnnotation(Int32) |
构造一个批注,该批注可用于跨越某些通知文本字段中的 CharSequence 中的文本,然后可以转换为该文本部分的样式,以指示语义样式。 |
| DescribeContents() |
描述此可包裹实例封送表示形式中包含的特殊对象类型。 |
| Dispose() |
释放此Java对等方持有的资源。 (继承自 Object) |
| Dispose(Boolean) |
释放此Java对等方持有的资源。 (继承自 Object) |
| DisposeUnlessReferenced() |
要求值管理器释放此对等方,除非其映射保留此相同的托管实例。 (继承自 JavaObject) |
| Equals(Object) |
测试另一个托管对等方是否引用同一Java对象。 (继承自 JavaObject) |
| Equals(Object) |
指示其他对象是否“等于”此对象。 (继承自 Object) |
| FindRemoteInputActionPair(Boolean) |
查找并返回远程输入及其相应的操作。 |
| GetBridgedNotificationMetadata() |
返回与源自另一台设备的通知关联的元数据。 |
| GetBubbleMetadata() |
返回用于在现有前台活动的浮动窗口中显示应用内容的气泡元数据。 |
| GetHashCode() |
返回对象的哈希代码值。 (继承自 Object) |
| GetLargeIcon() |
此通知的内容视图中显示的大型图标。 |
| JavaFinalize() |
已过时.
当垃圾回收确定不再引用该对象时,由对象上的垃圾回收器调用。 (继承自 Object) |
| Notify() |
唤醒正在等待此对象的监视器的单个线程。 (继承自 Object) |
| NotifyAll() |
唤醒正在等待此对象的监视器的所有线程。 (继承自 Object) |
| SetHandle(IntPtr, JniHandleOwnership) |
设置 Handle 属性。 (继承自 Object) |
| SetLatestEventInfo(Context, ICharSequence, ICharSequence, PendingIntent) |
已过时.
将 |
| SetLatestEventInfo(Context, String, String, PendingIntent) |
已过时.
将 |
| SetPeerReference(JniObjectReference, JniObjectReferenceOptions) |
在不创建 JNI 引用副本的情况下,将引用值存储在控制块中。 (继承自 JavaObject) |
| ToArray<T>() |
从此Java数组包装器创建托管数组。 (继承自 Object) |
| ToString() |
返回对象的字符串表示形式。 (继承自 Object) |
| UnregisterFromRuntime() |
从互操作运行时取消注册此Java对等。 (继承自 Object) |
| Wait() |
导致当前线程等待,直到它被唤醒,通常是通过 通知 或 中断。 (继承自 Object) |
| Wait(Int64, Int32) |
使当前线程等待直到唤醒,通常是通过 通知 或 中断,或直到经过一定数量的实时。 (继承自 Object) |
| Wait(Int64) |
使当前线程等待直到唤醒,通常是通过 通知 或 中断,或直到经过一定数量的实时。 (继承自 Object) |
| WriteToParcel(Parcel, ParcelableWriteFlags) |
将此通知平展到包裹中。 |
显式接口实现
| 名称 | 说明 |
|---|---|
| IJavaPeerable.Disposed() |
将此对等方标记为已释放,并将 |
| IJavaPeerable.Finalized() |
将此对等方标记为已释放,并将 |
| IJavaPeerable.JniObjectReferenceControlBlock |
获取此对等方使用的本机控制块指针。 (继承自 JavaObject) |
| IJavaPeerable.SetJniIdentityHashCode(Int32) |
存储运行时提供的标识哈希代码。 (继承自 JavaObject) |
| IJavaPeerable.SetJniManagedPeerState(JniManagedPeerStates) |
替换存储的托管对等状态标志。 (继承自 JavaObject) |
| IJavaPeerable.SetPeerReference(JniObjectReference) |
更新对等引用,并在引用无效时释放已释放的对等方控制块。 (继承自 JavaObject) |
| IJavaPeerable.UnregisterFromRuntime() |
从运行时的Java对象查找中删除此实例。 |
扩展方法
| 名称 | 说明 |
|---|---|
| GetJniTypeName(IJavaPeerable) |
获取实例 |
| JavaAs<TResult>(IJavaPeerable) |
尝试强制 |
| JavaCast<TResult>(IJavaObject) |
执行 Android 运行时检查的类型转换。 |
| JavaCast<TResult>(IJavaObject) |
重复使用兼容的托管对等,或获取请求类型的包装器。 |
| TryJavaCast<TResult>(IJavaPeerable, TResult) |
尝试强制 |