GeolocationPermissions

public class GeolocationPermissions
extends Object

java.lang.Object
   ↳ android.webkit.GeolocationPermissions

This class is used to manage permissions for the WebView's Geolocation JavaScript API. Geolocation permissions are applied to an origin, which consists of the host, scheme and port of a URI. In order for web content to use the Geolocation API, permission must be granted for that content's origin. This class stores Geolocation permissions. An origin's permission state can be either allowed or denied. This class uses Strings to represent an origin. When an origin attempts to use the Geolocation API, but no permission state is currently set for that origin, WebChromeClient.onGeolocationPermissionsShowPrompt() is called. This allows the permission state to be set for that origin. The methods of this class can be used to modify and interrogate the stored Geolocation permissions at any time.

Summary

Nested classes

interface GeolocationPermissions.Callback

A callback interface used by the host application to set the Geolocation permission state for an origin. 

Public methods

void allow(String origin)

Allows the specified origin to use the Geolocation API.

void clear(String origin)

Clears the Geolocation permission state for the specified origin.

void clearAll()

Clears the Geolocation permission state for all origins.

void getAllowed(String origin, ValueCallback<Boolean> callback)

Gets the Geolocation permission state for the specified origin.

static GeolocationPermissions getInstance()

Gets the singleton instance of this class.

void getOrigins(ValueCallback<Set<String>> callback)

Gets the set of origins for which Geolocation permissions are stored.

Inherited methods

Public methods

allow

Added in API level 7 
public void allow (String origin)

Allows the specified origin to use the Geolocation API.

Parameters
origin String: the origin for which Geolocation API use is allowed

clear

Added in API level 7 
public void clear (String origin)

Clears the Geolocation permission state for the specified origin.

Parameters
origin String: the origin for which Geolocation permissions are cleared

clearAll

Added in API level 7 
public void clearAll ()

Clears the Geolocation permission state for all origins.

getAllowed

Added in API level 7 
public void getAllowed (String origin, 
                ValueCallback<Boolean> callback)

Gets the Geolocation permission state for the specified origin.

Parameters
origin String: the origin for which Geolocation permission is requested
callback ValueCallback: a ValueCallback to receive the result of this request. This object's onReceiveValue() method will be invoked asynchronously with a boolean indicating whether or not the origin can use the Geolocation API.

getInstance

Added in API level 7 
public static GeolocationPermissions getInstance ()

Gets the singleton instance of this class. This method cannot be called before the application instantiates a WebView instance.

Returns
GeolocationPermissions the singleton GeolocationPermissions instance

getOrigins

Added in API level 7 
public void getOrigins (ValueCallback<Set<String>> callback)

Gets the set of origins for which Geolocation permissions are stored.

Parameters
callback ValueCallback: a ValueCallback to receive the result of this request. This object's onReceiveValue() method will be invoked asynchronously with a set of Strings containing the origins for which Geolocation permissions are stored.