語言

Notification 類別

定義

一個類別,代表透過 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
繼承
Notification
屬性
實作

備註

一個類別,代表透過 NotificationManager 向使用者呈現持久通知的方式。 新增了 Notification.Builder,讓建立通知變得更簡單。

關於如何建立通知的指南,請閱讀狀態列通知開發者指南。

Android 參考資料。android.app.Notification

本頁部分內容為基於 Open Source Project 所創建與分享的作品,並依授權條款所描述的使用進行修改。

建構函式

名稱 Description
Notification()

以預設值建構一個通知物件。

Notification(Int32, ICharSequence, Int64)
已淘汰.

此構造器已被棄用。

Notification(Int32, ICharSequence)

建立 Notification 一個物件,具備狀態列圖示所需的資訊,但不使用標準的展開視圖。

Notification(Int32, String, Int64)

此構造器已被棄用。

Notification(Int32, String)

建立 Notification 一個物件,具備狀態列圖示所需的資訊,但不使用標準的展開視圖。

Notification(IntPtr, JniHandleOwnership)

初始化現有 Java 原生介面物件的受管理表示。

Notification(Parcel)

解除包裹通知的扁平化。

欄位

名稱 Description
ActionBridgedNotificationPreferences

一個提供使用者介面,用來調整來自其他裝置的橋接通知偏好設定的活動。

CategoryAlarm

通知類別:鬧鐘或定時器。

CategoryCall

通知類別:來電(語音或視訊)或類似的同步通訊請求。

CategoryEmail

通知類別:非同步大量訊息(電子郵件)。

CategoryError

通知類別:背景操作或認證狀態錯誤。

CategoryEvent

通知類別:行事曆事件。

CategoryLocationSharing

通知類別:暫時分享位置。

CategoryMessage

通知類別:收到的私訊(簡訊、即時訊息等)。

CategoryMissedCall

通知類別:未接來電。

CategoryNavigation

通知類別:地圖逐回合導航。

CategoryProgress

通知類別:長期執行背景作業的進度。

CategoryPromo

通知類別:促銷或廣告。

CategoryRecommendation

通知類別:針對單一事項的具體且及時的建議。

CategoryReminder

通知類別:使用者排程提醒。

CategoryService

通知類別:顯示正在運行的背景服務。

CategorySocial

通知類別:社群網路或分享更新。

CategoryStatus

通知類別:關於裝置或情境狀態的持續資訊。

CategoryStopwatch

通知類別:正在計時。

CategorySystem

通知類別:系統或裝置狀態更新。

CategoryTransport

通知類別:播放媒體傳輸控制。

CategoryVoicemail

通知類別:語音信箱。

CategoryWorkout

通知類別:追蹤使用者的運動。

ColorDefault

特殊值的顏色指示系統不要用任何特殊顏色裝飾此元素(而是使用預設系統顏色)。

ExtraAnswerColor

額外說明:作為通知.CallStyle通知中接聽動作按鈕提示的顏色。

ExtraAnswerIntent

額外說明:當使用者回應 Notification.CallStyle 通知時,所發送的意圖。

ExtraAudioContentsUri

額外說明:本通知的音訊內容。

ExtraBackgroundImageUri

額外說明:平面字串表示,指向可於背景顯示的圖片,當通知被選取時。

ExtraBigText

額外說明:這是以 BigTextStyle.bigText(CharSequence) 提供的 BigTextStyle 通知擴展形式顯示的較長文字。

ExtraCallIsVideo

額外說明:Notification.CallStyle 通知是否適用於接聽後會啟動視訊的通話。

ExtraCallPerson

額外說明:通知。CallStyle 通知中要顯示的來電者。

ExtraCallType

額外說明鍵:由 Notification.CallStyle 通知所代表的通話類型。

ExtraChannelGroupId

INTENT_CATEGORY_NOTIFICATION_PREFERENCES的可選配件。

ExtraChannelId

INTENT_CATEGORY_NOTIFICATION_PREFERENCES的可選配件。

ExtraChronometerCountDown

額外說明:通知中設定的計時器是否應該倒數而非倒數。

ExtraColorized

額外說明:通知是否應該依 Builder.setColorized(boolean) 的規定進行著色。

ExtraCompactActions

額外說明:在 Compact 視圖中顯示的動作索引,如 MediaStyle.setShowActionsInCompactView(int...) 所示。

ExtraConversationTitle

額外說明鍵:一個 CharSequence,作為對話標題,並以 Notification.MessagingStyle 表示

ExtraDeclineColor

額外說明:作為通知.CallStyle通知中拒絕或掛斷按鈕提示的顏色。

ExtraDeclineIntent

額外說明:當使用者拒絕通知.CallStyle通知時,所發送的意圖。

ExtraHangUpIntent

額外鍵:當使用者掛斷 Notification.CallStyle 通知時,所發送的意圖。

ExtraHistoricMessages

額外說明:由 Notification.MessagingStyle.Style 通知提供的歷史 Notification.MessageStyle.Message 組合陣列。

ExtraInfoText

額外說明:這是一小段額外文字,提供給 Builder.setContentInfo(CharSequence)。

ExtraIsGroupConversation

額外說明鍵:Notification.MessagingStyle 通知是否代表群組對話。

ExtraLargeIcon

此常數在 API 等級 26 中被棄用。

ExtraLargeIconBig

額外說明:這是一張位圖,當通知以擴展形式顯示時,應用來取代 Builder.setLargeIcon(android.graphics.Bitmap)所提供的點陣圖,該通知以擴展形式呈現,依據 BigPictureStyle.bigLargeIcon(android.graphics.Bitmap) 提供。

ExtraMediaSession

額外金鑰:與 Notification.MediaStyle 通知相關聯的 MediaSession.Token 。

ExtraMessages

額外說明:由 Notification.MessagingStyle.Style 通知提供的 Notification.MessageStyle.Message 組合陣列。

ExtraMessagingPerson

額外說明鍵:所有用戶發送的訊息(包括直接回覆)要顯示的人物。通知。訊息風格通知。

ExtraNotificationId

INTENT_CATEGORY_NOTIFICATION_PREFERENCES的可選配件。

ExtraNotificationTag

INTENT_CATEGORY_NOTIFICATION_PREFERENCES的可選配件。

ExtraPeople

此常數在 API 等級 28 中被棄用。

ExtraPeopleList

額外說明鍵:包含此通知所關聯人物的 arrayList Person 物件。

ExtraPicture

額外說明:這是一個位圖,會在 BigPictureStyle 擴展通知中顯示,該通知提供給 BigPictureStyle.bigPicture(android.graphics.Bitmap)。

ExtraPictureContentDescription

額外說明:這是來自 BigPictureStyle.bigPicture(Bitmap)提供、提供給 BigPictureStyle.setContentDescription(CharSequence) 的整體畫面內容描述。

ExtraPictureIcon

額外說明:這是一張圖片圖示,需在 BigPictureStyle 擴展通知中顯示,提供給 BigPictureStyle.bigPicture(Icon)。

ExtraPreferSmallIcon

一個布林值,要求通知卡顯示小圖示而非啟動器應用程式圖示。

ExtraProgress

額外說明鍵:這是提供給 Builder.setProgress(int, int, boolean) 的進度值。

ExtraProgressIndeterminate

額外說明:進度條是否不確定,提供給 Builder.setProgress(int, int, boolean)。

ExtraProgressMax

額外數值:這是提供給 Builder.setProgress(int, int, boolean) 的最大值。

ExtraRemoteInputDraft

如果通知中包含未寄出的 RemoteInput 草稿,我們會用這個鍵把草稿加到 contentIntent 的字串。

ExtraRemoteInputHistory

額外說明:這是遠端輸入歷史,依 Builder.setRemoteInputHistory(CharSequence[]) 提供。

ExtraRequestPromotedOngoing

一個類別,代表透過 NotificationManager 向使用者呈現持久通知的方式。

ExtraSelfDisplayName

此常數在 API 等級 28 中被棄用。

ExtraShowBigPictureWhenCollapsed

額外說明鍵:這是一個布林值,表示大畫面將以 BigPictureStyle 通知的摺疊狀態顯示。

ExtraShowChronometer

額外說明:何時是否應該以計時計時器(特別是計時器)顯示,而非提供給 Builder.setUsesChronometer(布林值)的時間戳記。

ExtraShowWhen

額外說明:是否應該顯示何時,依據 Builder.setShowWhen(布林值)提供的資訊。

ExtraSmallIcon

此常數在 API 等級 26 中被棄用。

ExtraSubText

額外說明:這是第三行文字,提供給 Builder.setSubText(CharSequence)。

ExtraSummaryText

額外說明:這是一行摘要資訊,旨在與擴充通知一同顯示,如提供給(例如 BigTextStyle.setSummaryText(CharSequence) 的。

ExtraTemplate

額外說明鍵:代表用來建立此通知的特定通知風格名稱的字串。

ExtraText

額外說明:這是提供給 Builder.setContentText(CharSequence) 的主文字有效載荷。

ExtraTextLines

額外說明:一組可在 InboxStyle 擴展通知中顯示的 CharSequence,每個 CharSequence 都提供給 InboxStyle.addLine(CharSequence)。

ExtraTitle

額外說明:這是通知的標題,提供給 Builder.setContentTitle(CharSequence)。

ExtraTitleBig

額外說明:這是通知的標題,當以擴展形式顯示時,例如:

ExtraVerificationIcon

額外鍵:在 Notification.CallStyle 通知中顯示來電者的驗證狀態圖示。

ExtraVerificationText

額外說明:在 Notification.CallStyle 通知中,作為來電者驗證狀態的文字。

FlagAgentTaskInteractionHideStatusBarIcon
已淘汰.

一個類別,代表透過 NotificationManager 向使用者呈現持久通知的方式。

FlagAgentTaskInteractionHideVisualAlerts
已淘汰.

一個類別,代表透過 NotificationManager 向使用者呈現持久通知的方式。

FlagPromotedOngoing
已淘汰.

如果此通知是推廣的持續通知,系統應該設定的旗標欄位中,會被位元順序 OR化,因為它有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
已淘汰.

這是語意風格的預設值,表示沒有特定的語意。

屬性

名稱 Description
Actions

由 Builder.addAction(int,CharSequence,PendingIntent) 附加的所有動作結構陣列。

AgentInteractionFlags

一個類別,代表透過 NotificationManager 向使用者呈現持久通知的方式。

AllowSystemGeneratedContextualActions

回傳平台是否被應用程式開發者允許為此通知產生情境動作。

AudioAttributes

此欄位在 API 等級 26 中被棄用。

AudioAttributesDefault

audioAttributes 的預設值。

AudioStreamType
已淘汰.

此欄位在 API 等級 21 中被棄用。

BadgeIconType

如果該通知顯示在支援徽章的啟動器中,會回傳應該顯示的圖示。

BigContentView
已淘汰.

大幅版的 contentView,讓通知在展開時有機會顯示更多細節。

Category

這是預先定義的通知類別之一(參見 CATEGORY_* 常數),最能描述這個通知。

ChannelId

回傳此通知所發布的頻道 ID。

Class

回傳此 Object的執行時類別。

(繼承來源 Object)
Color

強調色(如 Color 中的常數一樣的 ARGB 整數)由標準樣式範本在呈現此通知時套用。

ContentIntent

當點擊展開狀態條目時,意圖執行。

ContentView
已淘汰.

那個會代表通知清單的檢視(通知清單會從狀態列拉下)。

ContextualActions

從通知中的動作中回傳出情境性(即因通知內容而建議的)動作。

Creator

用於實例化通知物件的 Parcelable.Creator

Defaults

此欄位在 API 等級 26 中被棄用。

DeleteIntent

當使用者明確拒絕通知時,意圖執行,無論是透過「全部清除」按鈕,或是逐個滑動移除通知。

Extras

本通知還需攜帶額外的語意資料。

Flags
FullScreenIntent

意圖啟動,而不是在狀態欄發布通知。

Group

取得將此通知群組成叢集或堆疊的金鑰,與支援此類顯示的裝置上的通知一同堆疊。

GroupAlertBehavior

回傳群組中哪些類型的通知負責語音提醒使用者。

Handle

底層 Android 實例的帳號。

(繼承來源 Object)
HasImage
HasPromotableCharacteristics

回傳通知是否具備所有符合FLAG_PROMOTED_ONGOING資格的特徵。

HasSummarizedContent

一個類別,代表透過 NotificationManager 向使用者呈現持久通知的方式。

HeadsUpContentView
已淘汰.

中格式版的 contentView,讓通知有機會在 contentView 中新增動作按鈕。

Icon
已淘汰.

此欄位在 API 等級 23 中被棄用。

IconLevel

如果狀態列中的圖示是要有多個等級,你可以設定這個。

IsRequestPromotedOngoing

一個類別,代表透過 NotificationManager 向使用者呈現持久通知的方式。

JniIdentityHashCode

取得由互通執行時指派給此 Java 對等端的身份雜湊碼。

(繼承來源 Object)
JniManagedPeerState

一個類別,代表透過 NotificationManager 向使用者呈現持久通知的方式。

(繼承來源 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

回傳非常短的文字,總結通知中最重要的資訊,若未設定此欄位則為空。

ShortcutId

回傳該通知會優先的 ID(如果有的話)。

SmallIcon

代表這通知的小圖示出現在狀態列中。

SortKey

取得一個排序鍵,能從同一個套件中訂購這個通知和其他通知。

Sound

此欄位在 API 等級 26 中被棄用。

ThresholdClass

提供 Android.App.Notification 的 JNI 綁定基礎設施。

ThresholdType

提供 Android.App.Notification 的 JNI 綁定基礎設施。

TickerText

本文摘要此通知,適用於無障礙服務。

TickerView
已淘汰.

過去,顯示行情條的視圖。

TimeoutAfter

會回傳從發文開始的時長,之後系統應該會取消這個通知,如果還沒取消的話。

Vibrate

此欄位在 API 等級 26 中被棄用。

Visibility

此通知的可見範圍,影響 SystemUI 在不信任的情況下(例如安全鎖定畫面及螢幕分享期間)何時以及如何揭露通知的存在與內容。

When

與此通知相關的時間戳記,以紀元起的毫秒計。

方法

名稱 Description
Clone()

建立並回傳此物件的副本。

Construct(JniObjectReference, JniObjectReferenceOptions)

一個類別,代表透過 NotificationManager 向使用者呈現持久通知的方式。

(繼承來源 JavaObject)
CreateSemanticStyleAnnotation(Int32)

建構一個註解,可用於在某些通知文字欄位中橫跨 Spanned CharSequence 的文字,並可將其轉換為該段落的樣式,以標示語意樣式。

DescribeContents()

描述此 Parcelable 實例的分組表示中包含的特殊物件種類。

Dispose()

釋放該 Java 節點所持有的資源。

(繼承來源 Object)
Dispose(Boolean)

釋放該 Java 節點所持有的資源。

(繼承來源 Object)
DisposeUnlessReferenced()

一個類別,代表透過 NotificationManager 向使用者呈現持久通知的方式。

(繼承來源 JavaObject)
Equals(Object)

一個類別,代表透過 NotificationManager 向使用者呈現持久通知的方式。

(繼承來源 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)
已淘汰.

將場地設定 #contentView 為標準的「最新事件」佈局。

SetLatestEventInfo(Context, String, String, PendingIntent)
已淘汰.

將場地設定 #contentView 為標準的「最新事件」佈局。

SetPeerReference(JniObjectReference, JniObjectReferenceOptions)

一個類別,代表透過 NotificationManager 向使用者呈現持久通知的方式。

(繼承來源 JavaObject)
ToArray<T>()

從這個 Java 陣列包裝器建立一個受管理陣列。

(繼承來源 Object)
ToString()

回傳物件的字串表示。

(繼承來源 Object)
UnregisterFromRuntime()

將此 Java 節點從互通執行時中取消註冊。

(繼承來源 Object)
Wait()

導致目前執行緒等待被喚醒,通常是透過 <em>通知</><em 或 em>中斷</em> 來喚醒。

(繼承來源 Object)
Wait(Int64, Int32)

會讓目前執行緒等待喚醒,通常是透過 <em>通知</><em 或 em>中斷</em>,或是經過一定的真實時間。

(繼承來源 Object)
Wait(Int64)

會讓目前執行緒等待喚醒,通常是透過 <em>通知</><em 或 em>中斷</em>,或是經過一定的真實時間。

(繼承來源 Object)
WriteToParcel(Parcel, ParcelableWriteFlags)

將此通知扁平成一個包裹。

明確介面實作

名稱 Description
IJavaPeerable.Disposed()

一個類別,代表透過 NotificationManager 向使用者呈現持久通知的方式。

(繼承來源 JavaObject)
IJavaPeerable.Finalized()

一個類別,代表透過 NotificationManager 向使用者呈現持久通知的方式。

(繼承來源 JavaObject)
IJavaPeerable.JniObjectReferenceControlBlock

一個類別,代表透過 NotificationManager 向使用者呈現持久通知的方式。

(繼承來源 JavaObject)
IJavaPeerable.SetJniIdentityHashCode(Int32)

一個類別,代表透過 NotificationManager 向使用者呈現持久通知的方式。

(繼承來源 JavaObject)
IJavaPeerable.SetJniManagedPeerState(JniManagedPeerStates)

一個類別,代表透過 NotificationManager 向使用者呈現持久通知的方式。

(繼承來源 JavaObject)
IJavaPeerable.SetPeerReference(JniObjectReference)

一個類別,代表透過 NotificationManager 向使用者呈現持久通知的方式。

(繼承來源 JavaObject)
IJavaPeerable.UnregisterFromRuntime()

一個類別,代表透過 NotificationManager 向使用者呈現持久通知的方式。

擴充方法

名稱 Description
GetJniTypeName(IJavaPeerable)

取得實例 self類型的 JNI 名稱。

JavaAs<TResult>(IJavaPeerable)

試著強制self輸入 TResult,檢查 強制在 Java 端是否有效。

JavaCast<TResult>(IJavaObject)

執行 Android 執行時檢查型別轉換。

JavaCast<TResult>(IJavaObject)

一個類別,代表透過 NotificationManager 向使用者呈現持久通知的方式。

TryJavaCast<TResult>(IJavaPeerable, TResult)

試著強制self輸入 TResult,檢查 強制在 Java 端是否有效。

適用於