org.mozilla.geckoview

Class WebNotification

Object

org.mozilla.geckoview.WebNotification

public class WebNotification
extends Object

This class represents a single Web Notification. These can be received by connecting a WebNotificationDelegate to GeckoRuntime via GeckoRuntime.setWebNotificationDelegate(WebNotificationDelegate).

Field Summary

Fields

Modifier and Type	Field and Description
String	imageUrl ImageURL contains the URL of an icon to be displayed as part of the notification.
String	lang Lang indicates the notification's language, as specified using a DOMString representing a BCP 47 language tag.
boolean	requireInteraction RequireInteraction indicates whether a notification should remain active until the user clicks or dismisses it, rather than closing automatically.
boolean	silent When set, indicates that no sounds or vibrations should be made.
String	source This is the URL of the page or Service Worker that generated the notification.
String	tag Tag is the ID of the notification.
String	text Text represents the body of the notification.
String	textDirection TextDirection indicates the direction that the language of the text is displayed.
String	title Title is shown at the top of the notification window.
int[]	vibrate A vibration pattern to run with the display of the notification.

Method Summary

Modifier and Type	Method and Description
void	click() This should be called when the user taps or clicks a notification.
void	dismiss() This should be called when the app stops showing the notification.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

title

@Nullable
public final String title

Title is shown at the top of the notification window.

See Also:

Web Notification - title

tag

@NonNull
public final String tag

Tag is the ID of the notification.

See Also:

Web Notification - tag

text

@Nullable
public final String text

Text represents the body of the notification.

See Also:

Web Notification - text

imageUrl

@Nullable
public final String imageUrl

ImageURL contains the URL of an icon to be displayed as part of the notification.

See Also:

Web Notification - icon

textDirection

@Nullable
public final String textDirection

TextDirection indicates the direction that the language of the text is displayed. Possible values are: auto: adopts the browser's language setting behaviour (the default.) ltr: left to right. rtl: right to left.

See Also:

Web Notification - dir

lang

@Nullable
public final String lang

Lang indicates the notification's language, as specified using a DOMString representing a BCP 47 language tag.

See Also:

DOM String, BCP 47, Web Notification - lang

requireInteraction

@NonNull
public final boolean requireInteraction

RequireInteraction indicates whether a notification should remain active until the user clicks or dismisses it, rather than closing automatically.

See Also:

Web Notification - requireInteraction

source

@Nullable
public final String source

This is the URL of the page or Service Worker that generated the notification. Null if this notification was not generated by a Web Page (e.g. from an Extension). TODO: make NonNull once we have Bug 1589693

silent

public final boolean silent

When set, indicates that no sounds or vibrations should be made.

See Also:

Web Notification - silent

vibrate

@NonNull
public final int[] vibrate

A vibration pattern to run with the display of the notification. A vibration pattern can be an array with as few as one member. The values are times in milliseconds where the even indices (0, 2, 4, etc.) indicate how long to vibrate and the odd indices indicate how long to pause. For example, [300, 100, 400] would vibrate 300ms, pause 100ms, then vibrate 400ms.

See Also:

Web Notification - vibrate

Method Detail

click

@UiThread
public void click()

This should be called when the user taps or clicks a notification. Note that this does not automatically dismiss the notification as far as Web Content is concerned. For that, see dismiss().

dismiss

@UiThread
public void dismiss()

This should be called when the app stops showing the notification. This is important, as there may be a limit to the number of active notifications each site can display.