Hinweis: Die Darstellung der Benachrichtigung ist stark abhängig von der Implementierung durch den Gerätehersteller.
Referenz UrsNotification
Hinweis:
Das Ändern einer Eigenschaft oder das Aufrufen einer Funktion zum Ändern einer Benachrichtigung wirkt sich nicht
auf bereits angezeigte Benachrichtigungen aus. Erst der nächste Aufruf einer Create...-Funktion
ändert die Ansicht.
Die Funktionen SetProgress, SetProgressEx,
RemoveProgressBar and RemoveProgressBarEx, die den
Fortschrittsbalken einer Benachrichtigung anpassen, sind hiervon ausgenommen. Sie wirken nur auf bereits erstellte Benachrichtigungen.
Hinweis:
Die Eigenschaften und Parameter Title und Text akzeptieren HTML-Tags. Dies wird in der Beschreibung der einzelnen Elemente
nicht erwähnt. Welche HTML-Tags benutzt werden können, variiert je nach Implementierung des Android-Systems. Hinweise
gibt es bei
Mark
Murphy's Technical Stuff oder
Daniel Lew's Coding Thoughts.
Eigenschaften
- AreNotificationsEnabled
- Ab API Level 24.
Gibt zurück, ob Benachrichtigungen vom aufrufenden Paket nicht blockiert werden. Liefert true für API-Levels < 24. - AreNotificationsPaused
- Ab API Level 29.
Gibt zurück, ob Benachrichtigungen von diesem Paket vorübergehend ausgeblendet sind. Dies könnte geschehen, weil das Paket als störend für den Benutzer markiert wurde oder weil das Paket suspendiert ist. Liefert false für API-Leves < 29. - AutoCancel
- Die Benachrichtigung wird automatisch geschlossen, wenn der Benutzer sie antippt.
- BigPicture
- Ab API Level 16.
Stellt eine Bitmap bereit, die für die BigPicture-Benachrichtigung verwendet werden soll. - CancelOnDestroy
- Die Benachrichtigung wird automatisch geschlossen, wenn die App geschlossen wird.
- Color
- Ab API Level 21.
Legt die Färbung fest. - Colorized
- Ab API Level 26.
Legen fest, ob diese Benachrichtigung eingefärbt werden soll. Wenn diese Option festgelegt ist, wird die mit Color festgelegte Farbe als Hintergrundfarbe für diese Benachrichtigung verwendet. Dies sollte nur für laufende Aufgaben mit hoher Priorität wie Navigation, laufender Anruf oder andere Ereignisse mit ähnlicher Priorität für den Benutzer verwendet werden. - IsInsistent
- Der Ton wird wiederholt, bis die Benachrichtigung abgebrochen oder das Benachrichtigungsfenster geöffnet wird.
- IsOngoingEvent
- Diese Benachrichtigung bezieht sich auf etwas, das gerade ausgeführt wird, z. B. einen Anruf. Der Benutzer kann die Benachrichtigung nicht löschen.
- LargeIcon
- Fügt der Benachrichtigung ein großes Symbol hinzu. In der Plattformvorlage wird dieses Bild entweder rechts neben der Benachrichtigung mit einem Seitenverhältnis von bis zu 16: 9 oder, wenn die Benachrichtigung gruppiert ist, links anstelle des small icon angezeigt.
- NoClear
- Die Benachrichtigung wird nicht gelöscht, wenn der Benutzer auf die Clear All-Schaltfläche klickt.
- NumberID
- Die eindeutige ID dieser Benachrichtigung. Eine neue Benachrichtigung mit derselben NumberID aktualisiert eine vorhandene.
- OnlyAlertOnce
- Sound, Vibration und Ticker werden nur dann abgespielt, wenn die Benachrichtigung noch nicht angezeigt wird.
- SmallIconImage
- Ab API Level 23.
Legt ein kleines Symbol fest, mit dem die Benachrichtigung in der Statusleiste und in der Inhaltsansicht dargestellt wird. - SmallSystemIcon
- Legt eine Symbolressource fest, die zur Darstellung der Benachrichtigung in der Statusleiste verwendet wird.
- Text
- Legt die zweite Textzeile in der Benachrichtigung fest. Der Text kann mit HTML-Tags formatiert werden. Welche HTML-Tags benutzt werden können, variiert je nach Implementierung des Android-Systems. Hinweise gibt es bei Mark Murphy's Technical Stuff oder Daniel Lew's Coding Thoughts.
- Title
- Legt die erste Textzeile in der Benachrichtigung fest. Der Text kann mit HTML-Tags formatiert werden. Welche HTML-Tags benutzt werden können, variiert je nach Implementierung des Android-Systems. Hinweise gibt es bei Mark Murphy's Technical Stuff oder Daniel Lew's Coding Thoughts.
- VersionSDK
- Die aktuell ausgeführte Android SDK-Version.
- UseMediaStyle
- Ab API Level 21.
Es werden Media-Schaltflächen angezeigt (Create a notification with media controls). ActionButtons und BigPicture haben dann keine Auswirkung/Funktion mehr.
Ab API Level 24.
Colorized und Color legen die Hintergrundfarbe der Benachrichtigung fest (DecoratedMediaCustomViewStyle). - When
- Fügt einen Zeitstempel hinzu, der sich auf die Benachrichtigung bezieht (normalerweise die Zeit, zu der das Ereignis aufgetreten ist).
- WhenChronometerCountDown
- Ab API Level 24.
Stellt den Zeitstempel so ein, dass er herunterzählt anstatt hochzählt. - WhenEnabled
- Ab API Level 17.
Legt fest, ob der Zeitstempel in der Inhaltsansicht angezeigt wird. - WhenUsesChronometer
- Ab API Level 16.
Zeigt das Feld Notification.when als Stoppuhr an.
Funktionen
- AddActionButton (Title, UrsIntentObject)
- Ab API Level 16.
Es werden Aktionsschaltflächen hinzugefügt. Bis zu drei Schaltflächen werden unterstützt. Der Text kann mit HTML-Tags formatiert werden. Welche HTML-Tags benutzt werden können, variiert je nach Implementierung des Android-Systems. Hinweise gibt es bei Mark Murphy's Technical Stuff oder Daniel Lew's Coding Thoughts.
Wenn das übergebene Objekt im Parameter UrsIntentObject nicht vom Typ UrsIntent ist, wird die Benachrichtigung nicht angelegt und Screen.ErrorOccurred mit ErrorNumber 17006 ausgelöst.
Wenn der Parameter Title leer ist, wird die Schaltfläche nicht hinzugefügt und das Ereignis Screen.ErrorOccurred wird mit der Fehlernummer 17010 ausgelöst. - AddMediaButton (Title, Icon, ShowInCampactView, UrsIntentObject)
- Ab API Level 21.
Es werden Media-Schaltflächen hinzugefügt. Der Text kann mit HTML-Tags formatiert werden. Welche HTML-Tags benutzt werden können, variiert je nach Implementierung des Android-Systems. Hinweise gibt es bei Mark Murphy's Technical Stuff oder Daniel Lew's Coding Thoughts.
Icon ist der Name einer Asset-Grafikdatei (Rubrik Media beim App Inventor). Auf manchen Geräten werden gibt es eine zusätzliche kompakte Darstellung der Benachrichtigung. ShowInCampactView bestimmt, ob die Schaltfläche auch in der Kompaktdarstellung angezeigt wird.
Wenn das übergebene Objekt im Parameter UrsIntentObject nicht vom Typ UrsIntent ist, wird die Benachrichtigung nicht angelegt und Screen.ErrorOccurred mit ErrorNumber 17006 ausgelöst.
Wenn der Parameter Title leer ist, wird die Schaltfläche nicht hinzugefügt und das Ereignis Screen.ErrorOccurred wird mit der Fehlernummer 17010 ausgelöst.
Wenn der Parameter Icon leer ist, wird die Schaltfläche nicht hinzugefügt und das Ereignis Screen.ErrorOccurred wird mit der Fehlernummer 17011 ausgelöst. - Cancel()
- Löscht die Benachrichtigung.
- Create (UrsChannelObject, UrsIntentObject)
- Erstellt und öffnet eine Benachrichtigung. Identisch mit
UrsAI2NotificationChannel.CreateNotification.
Wenn das übergebene Objekt im Parameter UrsNotificationObject nicht vom Typ UrsNotification ist, wird die Benachrichtigung nicht angelegt und Screen.ErrorOccurred mit ErrorNumber 17005 ausgelöst.
Wenn das übergebene Objekt im Parameter UrsIntentObject nicht vom Typ UrsIntent ist, wird die Benachrichtigung nicht angelegt und Screen.ErrorOccurred mit ErrorNumber 17006 ausgelöst. - RemoveActionButtons ()
- Entfernt die Aktionsschaltflächen aus der Benachrichtigung.
- RemoveMediaButtons ()
- Entfernt die Media-Schaltflächen aus der Benachrichtigung.
- RemoveOnDestroyAction ()
- Entfernt die Benachrichtigung, die angezeigt werden, wenn die App geschlossen wird (siehe SetOnDestroyAction).
- RemoveProgressBar ()
- Entfernt den Fortschrittsbalken aus der Benachrichtigung. Die Benachrichtigung muss mit
UrsNotificationChannel.CreateProgressNotification
erstellt wurden sein.
Wenn die Benachrichtigung noch nicht erstellt wurde, hat die Funktion keine Auswirkungen und es wird das Ereignis Screen.ErrorOccurred mit ErrorNumber 17009 ausgelöst. - RemoveProgressBarEx (Title, Text)
- Entfernt den Fortschrittsbalken aus der Benachrichtigung und ändert die Eigenschaften
Title und Text.
TDie Benachrichtigung muss mit
UrsNotificationChannel.CreateProgressNotification
erstellt wurden sein.
Wenn die Benachrichtigung noch nicht erstellt wurde, hat die Funktion keine Auswirkungen und es wird das Ereignis Screen.ErrorOccurred mit ErrorNumber 17009 ausgelöst. - SetOnDestroyAction (UrsChannelObject, UrsNotificationObject, UrsIntentObject)
- Legt eine Benachrichtigung fest, die angezeigt wird, wenn die App geschlossen wird.
Wenn das übergebene Objekt im Parameter UrsChannelObject nicht vom Typ UrsAI2NotificationChannel ist, wird die Benachrichtigung nicht angelegt und Screen.ErrorOccurred mit ErrorNumber 17001 ausgelöst.
Wenn das übergebene Objekt im Parameter UrsNotificationObject nicht vom Typ UrsNotification ist, wird die Benachrichtigung nicht angelegt und Screen.ErrorOccurred mit ErrorNumber 17005 ausgelöst.
Wenn das übergebene Objekt im Parameter UrsIntentObject nicht vom Typ UrsIntent ist, wird die Benachrichtigung nicht angelegt und Screen.ErrorOccurred mit ErrorNumber 17006 ausgelöst. - SetProgress (CurrentProgress)
- Ab API Level 16.
Legt den Fortschritt fest, den diese Benachrichtigung darstellt. Die Benachrichtigung muss mit UrsNotificationChannel.CreateProgressNotification erstellt wurden sein.
Wenn die Benachrichtigung noch nicht erstellt wurde, hat die Funktion keine Auswirkungen und es wird das Ereignis Screen.ErrorOccurred mit ErrorNumber 17009 ausgelöst. - SetProgressEx (Title, Text, CurrentProgress)
- Ab API Level 16.
Legt den Fortschritt fest, den diese Benachrichtigung darstellt, und aktualisiert die Title- und Text-Eigenschaft. Die Benachrichtigung muss mit UrsNotificationChannel.CreateProgressNotification erstellt wurden sein.
Wenn die Benachrichtigung noch nicht erstellt wurde, hat die Funktion keine Auswirkungen und es wird das Ereignis Screen.ErrorOccurred mit ErrorNumber 17009 ausgelöst.
Ereignisse
- OnClick(IntentID)
- Wenn für das Ereignis der Benachrichtigung oder für eine Aktionsschaltfläche ein UrsIntent mit ActionType Event angegeben ist, wird dieses Ereignis ausgelöst, wenn der Benutzer auf die Benachrichtigung oder die Aktionsschaltfläche tippt.
- UserCanceled()
- Die Benachrichtigung wurde vom Anwender gelöscht.