org.mozilla.geckoview

Class GeckoSession.PermissionDelegate.ContentPermission

Object

org.mozilla.geckoview.GeckoSession.PermissionDelegate.ContentPermission

Enclosing interface:

GeckoSession.PermissionDelegate

public static class GeckoSession.PermissionDelegate.ContentPermission
extends Object

Represents a content permission -- including the type of permission, the present value of the permission, the URL the permission pertains to, and other information.

Field Summary

Fields

Modifier and Type	Field and Description
String	contextId The context ID associated with the permission if any.
int	permission The type of this permission; one of PERMISSION_*.
boolean	privateMode A boolean indicating whether this content permission is associated with private browsing.
String	thirdPartyOrigin The third party origin associated with the request; currently only used for storage access permission.
String	uri The URI associated with this content permission.
int	value The value of the permission; one of VALUE_.
static int	VALUE_ALLOW The corresponding permission is currently set to allow.
static int	VALUE_DENY The corresponding permission is currently set to deny.
static int	VALUE_PROMPT The corresponding permission is currently set to default/prompt behavior.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ContentPermission()

Method Summary

Modifier and Type	Method and Description
static GeckoSession.PermissionDelegate.ContentPermission	fromJson(JSONObject perm) Converts a JSONObject to a ContentPermission -- should only be used on the output of toJson().
JSONObject	toJson() Converts a ContentPermission to a JSONObject that can be converted back to a ContentPermission by fromJson(JSONObject).

Methods inherited from class Object

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

Field Detail

VALUE_PROMPT

public static final int VALUE_PROMPT

The corresponding permission is currently set to default/prompt behavior.

See Also:

Constant Field Values

VALUE_DENY

public static final int VALUE_DENY

The corresponding permission is currently set to deny.

See Also:

Constant Field Values

VALUE_ALLOW

public static final int VALUE_ALLOW

The corresponding permission is currently set to allow.

See Also:

Constant Field Values

uri

@NonNull
public final String uri

The URI associated with this content permission.

thirdPartyOrigin

@Nullable
public final String thirdPartyOrigin

The third party origin associated with the request; currently only used for storage access permission.

privateMode

public final boolean privateMode

A boolean indicating whether this content permission is associated with private browsing.

permission

public final int permission

The type of this permission; one of PERMISSION_*.

value

public final int value

The value of the permission; one of VALUE_.

contextId

@Nullable
public final String contextId

The context ID associated with the permission if any.

See Also:

GeckoSessionSettings.Builder.contextId(java.lang.String)

Constructor Detail

ContentPermission

protected ContentPermission()

Method Detail

fromJson

@AnyThread
 @Nullable
public static GeckoSession.PermissionDelegate.ContentPermission fromJson(@NonNull
                                                                                               JSONObject perm)

Converts a JSONObject to a ContentPermission -- should only be used on the output of toJson().

Parameters:

perm - A JSONObject representing a ContentPermission, output by toJson().

Returns:

The corresponding ContentPermission.

toJson

@AnyThread
 @NonNull
public JSONObject toJson()
                                       throws JSONException

Converts a ContentPermission to a JSONObject that can be converted back to a ContentPermission by fromJson(JSONObject).

Returns:

A JSONObject representing this ContentPermission. Modifying any of the fields may result in undefined behavior when converted back to a ContentPermission and used.

Throws:

JSONException - if the conversion fails for any reason.