httpsOnlyMode Setting

Allow users to query the mode for ‘HTTPS-Only Mode’. This setting’s value is of type HTTPSOnlyModeOption, defaulting to never.

Permissions

The following permissions influence the behavior of the API. Depending on which permissions are requested, additional methods might be available, or certain data may be included in responses.

Hint

Request permissions only when needed. Unnecessary requests may result in rejection during ATN review.

privacy

privacy

Read and modify privacy settings.

Note

The permission privacy is required to use messenger.privacy.network.httpsOnlyMode.*.

Note

The permission privacy is required to use messenger.privacy.network.httpsOnlyMode.*.

Examples

To read the httpsOnlyMode setting:

let { value } = await messenger.privacy.network.httpsOnlyMode.get({});

Functions

get(details)

Gets the value of a setting.

Parameters

details

details

(object)

Which setting to consider.

incognito

[incognito]

(boolean, optional)

Whether to return the value that applies to the incognito session (default false).

Return type (Promise)

_returns

object

Details of the currently effective value.

levelOfControl

levelOfControl

The level of control of the setting.

value

value

(any)

The value of the setting.

incognitoSpecific

[incognitoSpecific]

(boolean, optional)

Whether the effective value is specific to the incognito session. This property will only be present if the incognito property in the details parameter of get() was true.

Required permissions

  • privacy

Events

onChange

Fired after the setting changes.

Parameters for onChange.addListener(listener)

listener(details)

listener(details)

A function that will be called when this event occurs.

Parameters passed to the listener function

details

details

(object)

levelOfControl

levelOfControl

The level of control of the setting.

value

value

(any)

The value of the setting after the change.

incognitoSpecific

[incognitoSpecific]

(boolean, optional)

Whether the value that has changed is specific to the incognito session. This property will only be present if the user has enabled the extension in incognito mode.

Required permissions

  • privacy

Types

LevelOfControl

One of

  • not_controllable: cannot be controlled by any extension

  • controlled_by_other_extensions: controlled by extensions with higher precedence

  • controllable_by_this_extension: can be controlled by this extension

  • controlled_by_this_extension: controlled by this extension

string

Supported values:

controllable_by_this_extension

controllable_by_this_extension

controlled_by_other_extensions

controlled_by_other_extensions

controlled_by_this_extension

controlled_by_this_extension

not_controllable

not_controllable