browserSettings.imageAnimationBehavior.rst

≡ imageAnimationBehavior Setting

• Permissions
• Examples
• Functions
• Events
• Types

imageAnimationBehavior Setting

Hint

The browserSettings.imageAnimationBehavior API is inherited from Firefox, and its primary documentation is maintained by Mozilla at MDN. Thunderbird implements only the subset of functions, events, and types listed here. The MDN pages may provide further details and examples, but they may also reference features that are not supported in Thunderbird.

Controls the behaviour of image animation in the browser. This setting's value is of type ImageAnimationBehavior, defaulting to normal.

.. rst-class:: api-main-section

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.

.. api-member::
   :name: :permission:`browserSettings`
   :refid: browser-settings-image-animation-behavior-permission-browser-settings
   :refname: browserSettings

   Read and modify browser settings.

.. rst-class:: api-permission-info

Note

The permission browserSettings is required to use messenger.browserSettings.imageAnimationBehavior.*.

.. rst-class:: api-main-section

Examples

To read the imageAnimationBehavior setting:

let { value } = await messenger.browserSettings.imageAnimationBehavior.get({});

To update the imageAnimationBehavior setting:

await messenger.browserSettings.imageAnimationBehavior.set({ value: <newValue> });

To clear the imageAnimationBehavior setting and restore the default value:

await messenger.browserSettings.imageAnimationBehavior.clear({});

.. rst-class:: api-main-section

Functions

clear(details)

.. api-section-annotation-hack::

Clears the setting, restoring any default value.

.. api-header::
   :label: Parameters

   .. _browser^settings.image^animation^behavior.clear.details:

   .. api-member::
      :name: ``details``
      :refid: browser-settings-image-animation-behavior-clear-details
      :refname: details
      :type: (object)

      Which setting to clear.

      .. _browser^settings.image^animation^behavior.clear.details.scope:

      .. api-member::
         :name: [``scope``]
         :refid: browser-settings-image-animation-behavior-clear-details-scope
         :refname: scope
         :type: (:ref:`browser^settings.image^animation^behavior.^setting^scope`, optional)

         Where to clear the setting (default: regular).

.. api-header::
   :label: Required permissions

   - :permission:`browserSettings`

get(details)

.. api-section-annotation-hack::

Gets the value of a setting.

.. api-header::
   :label: Parameters

   .. _browser^settings.image^animation^behavior.get.details:

   .. api-member::
      :name: ``details``
      :refid: browser-settings-image-animation-behavior-get-details
      :refname: details
      :type: (object)

      Which setting to consider.

      .. _browser^settings.image^animation^behavior.get.details.incognito:

      .. api-member::
         :name: [``incognito``]
         :refid: browser-settings-image-animation-behavior-get-details-incognito
         :refname: incognito
         :type: (boolean, optional)

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

.. api-header::
   :label: Return type (`Promise`_)

   .. _browser^settings.image^animation^behavior.get.returns:

   .. api-member::
      :refid: browser-settings-image-animation-behavior-get-returns
      :refname: _returns
      :type: object

      Details of the currently effective value.

      .. _browser^settings.image^animation^behavior.get.returns.level^of^control:

      .. api-member::
         :name: ``levelOfControl``
         :refid: browser-settings-image-animation-behavior-get-returns-level-of-control
         :refname: levelOfControl
         :type: (:ref:`browser^settings.image^animation^behavior.^level^of^control`)

         The level of control of the setting.

      .. _browser^settings.image^animation^behavior.get.returns.value:

      .. api-member::
         :name: ``value``
         :refid: browser-settings-image-animation-behavior-get-returns-value
         :refname: value
         :type: (any)

         The value of the setting.

      .. _browser^settings.image^animation^behavior.get.returns.incognito^specific:

      .. api-member::
         :name: [``incognitoSpecific``]
         :refid: browser-settings-image-animation-behavior-get-returns-incognito-specific
         :refname: incognitoSpecific
         :type: (boolean, optional)

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

   .. _Promise: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise

.. api-header::
   :label: Required permissions

   - :permission:`browserSettings`

set(details)

.. api-section-annotation-hack::

Sets the value of a setting.

.. api-header::
   :label: Parameters

   .. _browser^settings.image^animation^behavior.set.details:

   .. api-member::
      :name: ``details``
      :refid: browser-settings-image-animation-behavior-set-details
      :refname: details
      :type: (object)

      Which setting to change.

      .. _browser^settings.image^animation^behavior.set.details.value:

      .. api-member::
         :name: ``value``
         :refid: browser-settings-image-animation-behavior-set-details-value
         :refname: value
         :type: (any)

         The value of the setting.  Note that every setting has a specific value type, which is described together with the setting. An extension should *not* set a value of a different type.

      .. _browser^settings.image^animation^behavior.set.details.scope:

      .. api-member::
         :name: [``scope``]
         :refid: browser-settings-image-animation-behavior-set-details-scope
         :refname: scope
         :type: (:ref:`browser^settings.image^animation^behavior.^setting^scope`, optional)

         Where to set the setting (default: regular).

.. api-header::
   :label: Required permissions

   - :permission:`browserSettings`

.. rst-class:: api-main-section

Events

onChange

.. api-section-annotation-hack::

Fired after the setting changes.

.. api-header::
   :label: Parameters for onChange.addListener(listener)

   .. _browser^settings.image^animation^behavior.on^change.listener(details):

   .. api-member::
      :name: ``listener(details)``
      :refid: browser-settings-image-animation-behavior-on-change-listener-details
      :refname: listener(details)

      A function that will be called when this event occurs.

.. api-header::
   :label: Parameters passed to the listener function

   .. _browser^settings.image^animation^behavior.on^change.details:

   .. api-member::
      :name: ``details``
      :refid: browser-settings-image-animation-behavior-on-change-details
      :refname: details
      :type: (object)

      .. _browser^settings.image^animation^behavior.on^change.details.level^of^control:

      .. api-member::
         :name: ``levelOfControl``
         :refid: browser-settings-image-animation-behavior-on-change-details-level-of-control
         :refname: levelOfControl
         :type: (:ref:`browser^settings.image^animation^behavior.^level^of^control`)

         The level of control of the setting.

      .. _browser^settings.image^animation^behavior.on^change.details.value:

      .. api-member::
         :name: ``value``
         :refid: browser-settings-image-animation-behavior-on-change-details-value
         :refname: value
         :type: (any)

         The value of the setting after the change.

      .. _browser^settings.image^animation^behavior.on^change.details.incognito^specific:

      .. api-member::
         :name: [``incognitoSpecific``]
         :refid: browser-settings-image-animation-behavior-on-change-details-incognito-specific
         :refname: incognitoSpecific
         :type: (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.

.. api-header::
   :label: Required permissions

   - :permission:`browserSettings`

.. rst-class:: api-main-section

Types

LevelOfControl

.. api-section-annotation-hack::

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

.. api-header::
   :label: `string`

   .. container:: api-member-node

      .. container:: api-member-description-only

         Supported values:

         .. _browser^settings.image^animation^behavior.^level^of^control.controllable_by_this_extension:

         .. api-member::
            :name: :value:`controllable_by_this_extension`
            :refid: browser-settings-image-animation-behavior-level-of-control-controllable-by-this-extension
            :refname: controllable_by_this_extension

         .. _browser^settings.image^animation^behavior.^level^of^control.controlled_by_other_extensions:

         .. api-member::
            :name: :value:`controlled_by_other_extensions`
            :refid: browser-settings-image-animation-behavior-level-of-control-controlled-by-other-extensions
            :refname: controlled_by_other_extensions

         .. _browser^settings.image^animation^behavior.^level^of^control.controlled_by_this_extension:

         .. api-member::
            :name: :value:`controlled_by_this_extension`
            :refid: browser-settings-image-animation-behavior-level-of-control-controlled-by-this-extension
            :refname: controlled_by_this_extension

         .. _browser^settings.image^animation^behavior.^level^of^control.not_controllable:

         .. api-member::
            :name: :value:`not_controllable`
            :refid: browser-settings-image-animation-behavior-level-of-control-not-controllable
            :refname: not_controllable

SettingScope

.. api-section-annotation-hack::

The scope of the Setting. One of

• regular: setting for the regular profile (which is inherited by the incognito profile if not overridden elsewhere),
• regular_only: setting for the regular profile only (not inherited by the incognito profile),
• incognito_persistent: setting for the incognito profile that survives browser restarts (overrides regular preferences),
• incognito_session_only: setting for the incognito profile that can only be set during an incognito session and is deleted when the incognito session ends (overrides regular and incognito_persistent preferences). Only regular is supported by Thunderbird at this time.

.. api-header::
   :label: `string`

   .. container:: api-member-node

      .. container:: api-member-description-only

         Supported values:

         .. _browser^settings.image^animation^behavior.^setting^scope.incognito_persistent:

         .. api-member::
            :name: :value:`incognito_persistent`
            :refid: browser-settings-image-animation-behavior-setting-scope-incognito-persistent
            :refname: incognito_persistent

         .. _browser^settings.image^animation^behavior.^setting^scope.incognito_session_only:

         .. api-member::
            :name: :value:`incognito_session_only`
            :refid: browser-settings-image-animation-behavior-setting-scope-incognito-session-only
            :refname: incognito_session_only

         .. _browser^settings.image^animation^behavior.^setting^scope.regular:

         .. api-member::
            :name: :value:`regular`
            :refid: browser-settings-image-animation-behavior-setting-scope-regular
            :refname: regular

         .. _browser^settings.image^animation^behavior.^setting^scope.regular_only:

         .. api-member::
            :name: :value:`regular_only`
            :refid: browser-settings-image-animation-behavior-setting-scope-regular-only
            :refname: regular_only