Go back to top

vivaldi.sitePermissions Modders API Reference

API for handling per-site permissions in Chrome Extensions.

Types

#PermissionSetting

ENUM

⚠ NO DESCRIPTION PROVIDED

  • allow
  • block
  • ask
  • sessionOnly

    • #Permission

    ⚠ NO DESCRIPTION PROVIDED

    Properties:

    origin
    string

    ⚠ NO DESCRIPTION PROVIDED

    permission
    string

    ⚠ NO DESCRIPTION PROVIDED

    setting
    PermissionSetting

    ⚠ NO DESCRIPTION PROVIDED

    #PermissionOptions

    ⚠ NO DESCRIPTION PROVIDED

    Properties:

    permission
    string

    ⚠ NO DESCRIPTION PROVIDED

    options

    ⚠ NO DESCRIPTION PROVIDED

    Array of:

    • PermissionSetting
    default
    PermissionSetting

    ⚠ NO DESCRIPTION PROVIDED

    #PermissionChangeEvent

    Fired when site permission changes.

    Properties:

    origin
    string

    ⚠ NO DESCRIPTION PROVIDED

    permission
    string

    ⚠ NO DESCRIPTION PROVIDED

    Listeners

    How to use listeners

    Each listener type has the same functions, used for each listener API in the same way:

    .addListener(function callback)

    Adds a function to a listener for an event

    .removeListener(function callback)

    Removes a function to a listener for an event

    .hasListener(function callback)

    Returns a boolean if a function is attached to a listener for an event

    .hasListeners()

    Returns a boolean if a listener has any attached functions

    .dispatch()

    Returns array of promises dispatched to the listener

    #onPermissionChanged

    Fired when a site permission changes.

    Parameters:

    event
    PermissionChangeEvent

    ⚠ NO DESCRIPTION PROVIDED

    Methods

    #getAvailablePermissions

    Returns all available site permissions and their possible settings, including the default.

    #getOverriddenSites

    Returns a list of all sites with overridden permissions.

    #getOverridesForSite

    Returns a list of permission overrides for a specific site.

    Parameters:

    origin
    string

    ⚠ NO DESCRIPTION PROVIDED

    #setSitePermission

    Sets the permission override for a given site.

    Parameters:

    origin
    string

    ⚠ NO DESCRIPTION PROVIDED

    permission
    string

    ⚠ NO DESCRIPTION PROVIDED

    setting
    PermissionSetting

    ⚠ NO DESCRIPTION PROVIDED

    #resetSitePermissions

    Resets all site permissions to default.

    Parameters:

    origin
    string

    ⚠ NO DESCRIPTION PROVIDED