accessKeys

Types

#AccessKeyDefinition

Contains the access key character and all relevant attributes from the element it belongs to

Properties:

access_key

string

The access key itself, without modifiers

tagname

string

The tagname of the access key element

title

string

The title attribute of the access key element

href

string

The href attribute of the access key element

value

string

The value attribute of the access key element

textContent

string

The textContent of the access key element

id

string

The id attribute of the access key element

Methods

#getAccessKeysForPage

Get a list of all access keys defined on this page

Parameters:

tabId

integer

⚠ NO DESCRIPTION PROVIDED

#action

Find the element corresponding to an access key and fire the access key action

Parameters:

tabId

integer

⚠ NO DESCRIPTION PROVIDED

id

string

Element ID to be used for lookup

autoUpdate

Types

#UpdateOperationStatusEnum

ENUM

⚠ NO DESCRIPTION PROVIDED

noUpdate

didAbortWithError

didFindValidUpdate

willDownloadUpdate

didDownloadUpdate

willInstallUpdateOnQuit

updaterDidRelaunchApplication

#UpdateOperationStatus

A structure describing the status of an update operation if any.

Properties:

status

UpdateOperationStatusEnum

⚠ NO DESCRIPTION PROVIDED

version

string

⚠ NO DESCRIPTION PROVIDED

releaseNotesUrl

string

⚠ NO DESCRIPTION PROVIDED

Listeners

#onDidFindValidUpdate

Fired when a valid update is found.

Parameters:

releaseNotesUrl

string

URL of the release notes of the update.

version

string

The version of the update or an empty string if not known

#onUpdaterDidNotFindUpdate

Fired if checkForUpdates did not find an update.

#onWillDownloadUpdate

Fired when an update will be downloaded.

Parameters:

version

string

The version of the update or an empty string if not known

#onDidDownloadUpdate

Fired when an update has been downloaded.

Parameters:

version

string

The version of the update or an empty string if not known

#onWillInstallUpdateOnQuit

Fired when an update will be installed on restart or quit.

Parameters:

version

string

The version that will be installed on quit or an empty string if not known

#onNeedRestartToReloadCodecs

Fired when an update to FFMPEG codecs happened while the application was running, and restart is needed to reload them

#onUpdaterWillRelaunchApplication

Fired just before the updater restarts the application.

#onUpdaterDidRelaunchApplication

Fired when an application has been restarted due to an update.

#onDidAbortWithError

Fired when an update fails.

Parameters:

description

string

Description of the error.

reason

string

The reason for the error.

#onUpdateFinished

Signal sent when update completed without installation. Currently, only sent by macOS for exit on silent error.

Methods

#checkForUpdates

Check for Vivaldi browser updates.

Parameters:

withUi

boolean

Indicates whether we want the auto-update ui to appear.

#isUpdateNotifierEnabled

Checks whether the update notifier is set to run on startup.

#enableUpdateNotifier

Sets the update notifier to run on startup and launches it.

#disableUpdateNotifier

Removes the update notifier from autorun and attempts to terminate it.

#installUpdateAndRestart

Installs update & restart. Should be called after an onWillInstallUpdateOnQuit event has occurred.

#getAutoInstallUpdates

Checks whether we automatically install updates

#setAutoInstallUpdates

Change automatically install updates setting

Parameters:

autoinstall

boolean

Indicates whether we want to automatically install updates.

#getLastCheckTime

Get the date & time we last checked for an update. Returns milliseconds since epoch.

#getUpdateStatus

Get a status of an update operation if any

#hasAutoUpdates

Return true if automatic updates are supported.

#needsCodecRestart

Return true if restart is needed due to codec update.

bookmarksPrivate

Types

#FolderIds

Ids for a set of folders.

Properties:

bookmarks

string

⚠ NO DESCRIPTION PROVIDED

mobile

string

⚠ NO DESCRIPTION PROVIDED

trash

string

⚠ NO DESCRIPTION PROVIDED

#SpeedDialInfo

Object passed to the updateSpeedDialsForWindowsJumplist function.

Properties:

title

string

⚠ NO DESCRIPTION PROVIDED

url

string

⚠ NO DESCRIPTION PROVIDED

#BookmarkTreeNode

Copied from bookmarks.json

Properties:

id

string

The unique identifier for the node. IDs are unique within the current profile, and they remain valid even after the browser is restarted.

parentId

(optional)

string

The id of the parent folder. Omitted for the root node.

index

(optional)

integer

The 0-based position of this node within its parent folder.

url

(optional)

string

The URL navigated to when a user clicks the bookmark. Omitted for folders.

title

string

The text displayed for the node.

nickname

string

The nickname for the node. Vivaldi extended property

description

string

The description text for the node. Vivaldi extended property

thumbnail

string

chrome://thumb/ pointing to the stored url of the thumbnail

partner

string

Partner id for the node. Vivaldi extended property

speeddial

boolean

Boolean variable, stating if a folder is a speeddial folder

themeColor

string

The theme color from the website, to use as the background of the speed dials thumbnail, if no other thumbnail is available

bookmarkbar

boolean

Boolean variable, stating if a folder is a bookmark bar folder

trash

boolean

true if this is the trash folder. Read only.

dateAdded

(optional)

number

When this node was created, in milliseconds since the epoch (new Date(dateAdded)).

dateGroupModified

(optional)

number

When the contents of this folder last changed, in milliseconds since the epoch.

faviconUrl

(optional)

string

If present this url should be used to retrive a favicon.

children

(optional)

An ordered list of children of this node.

Array of:

• BookmarkTreeNode

Listeners

#onFaviconChanged

Fired when a favicon changes.

Parameters:

id

string

Bookmark id

favicon_url

string

The favicon's url

#onMetaInfoChanged

Fired when meta info changes.

Parameters:

id

string

Bookmark id

changeInfo

object

⚠ NO DESCRIPTION PROVIDED

Object Properties:

nickname

(optional)

string

⚠ NO DESCRIPTION PROVIDED

description

(optional)

string

⚠ NO DESCRIPTION PROVIDED

thumbnail

(optional)

string

⚠ NO DESCRIPTION PROVIDED

speeddial

(optional)

boolean

⚠ NO DESCRIPTION PROVIDED

bookmarkbar

(optional)

boolean

⚠ NO DESCRIPTION PROVIDED

themeColor

(optional)

string

⚠ NO DESCRIPTION PROVIDED

Methods

#updateSpeedDialsForWindowsJumplist

Update the speed dial list in Windows 7+ jumplist.

Parameters:

speedDials

⚠ NO DESCRIPTION PROVIDED

Array of:

• SpeedDialInfo

#emptyTrash

Empty the bookmarks trash folder.

#updatePartners

Update default bookmarks

#isCustomThumbnail

Check if the bookmark has a custom thumbnail from a local file or resource.

Parameters:

bookmarkId

string

the id of the bookmark

#getFolderIds

Returns ids of top level folders.

#export

Exports bookmarks to a Chrome html bookmark file

Parameters:

windowId

integer

The file selector will be modal to this window.

bookmarkContextMenu

Types

#Rect

Position and size of element in menu bar.

Properties:

x

integer

Left position of item that opens menu, screen coordinates.

y

integer

Top position of item that opens menu, screen coordinates.

width

integer

Width of item that opens menu.

height

integer

Height of item that opens menu.

#FolderEntry

⚠ NO DESCRIPTION PROVIDED

Properties:

id

string

Bookmark folder id.

offset

integer

Offset into folder.

folderGroup

boolean

When true, sorted content will have folders first or last in list.

rect

Rect

⚠ NO DESCRIPTION PROVIDED

#SortOrder

ENUM

Defines how to sort container items.

ascending

descending

#SortField

ENUM

Defines what element to use as sort key

title

url

nickname

description

dateAdded

#Edge

ENUM

Defines position of menu items added in chrome code wrt bookmark items.

above

below

off

#Icons

Icons

Icons encoded as base64

Array of:

• string

Listeners

#onOpen

Fires before menu opens.

Parameters:

id

string

Menu id, same as the bookmark folder to be shown.

#onClose

Fires before menu closes.

Methods

#show

Shows a context menu.

Parameters:

properties

object

⚠ NO DESCRIPTION PROVIDED

Object Properties:

windowId

integer

⚠ NO DESCRIPTION PROVIDED

siblings

List of menu entries.

Array of:

• FolderEntry

id

string

Bookmark folder id. Must match an id in the sibling list.

edge

(optional)

Edge

Where to place extra menu items

sortField

(optional)

SortField

⚠ NO DESCRIPTION PROVIDED

sortOrder

(optional)

SortOrder

⚠ NO DESCRIPTION PROVIDED

icons

Icons

Default and folder icons.

extensionActionUtils

Types

#ActionType

ENUM

browser- or pageAction.

browser

page

#ExtensionType

ENUM

Regular extension- or componentAction. Component actions will go through ToolbarActionViewController

extensionAction

componentAction

#MenuType

ENUM

What type of menu item.

normal

checkbox

radio

separator

#GlobalErrorType

ENUM

Type of global error. Disabled because of permission increase, or installed by third-party.

installed

upgrade

#MenuItem

Menu item representing a single menu item.

Properties:

name

string

The name of the item as shown in the menu.

id

string

The id for the item.

enabled

boolean

Is the item enabled.

visible

boolean

Is the item visible.

checked

boolean

Is the item checked.

menuType

MenuType

⚠ NO DESCRIPTION PROVIDED

submenu

(optional)

Sub menu items if the extension supplies a custom menu.

Array of:

• MenuItem

#SidePanelInfo

Side Panel description (if exists).

Properties:

url

string

Side Panel URL.

activeUrl

string

Side Panel URL.

#SidePanelOptions

⚠ NO DESCRIPTION PROVIDED

Properties:

tabId

(optional)

integer

If specified, the side panel options will only apply to the tab with this id. If omitted, these options set the default behavior (used for any tab that doesn't have specific settings). Note: if the same path is set for this tabId and the default tabId, then the panel for this tabId will be a different instance than the panel for the default tabId.

path

(optional)

string

The path to the side panel HTML file to use. This must be a local resource within the extension package.

extensionId

(optional)

string

The path to the side panel HTML file to use. This must be a local resource within the extension package.

resourceUrl

(optional)

string

The path to the side panel HTML file to use. This must be a local resource within the extension package.

enabled

(optional)

boolean

Whether the side panel should be enabled. This is optional. The default value is true.

#ExtensionInfo

Extension action per tab id.

Properties:

tabId

integer

tab id, or kDefaultTabId(-1) if the information should be used for all tabs.

id

string

The unique extension identifier.

badgeTooltip

(optional)

string

Tooltip for the button.

badgeText

(optional)

string

Badgetext, typically room for four chars.

badgeIcon

(optional)

string

data-url for the current icon.

badgeTextColor

(optional)

string

Text color for the badge text, currently unused.

badgeBackgroundColor

(optional)

string

Background color for the badge text.

enabled

(optional)

boolean

Whether the extension is enabled or not.

actionType

(optional)

ActionType

The type of the extensionAction, either pageaction or browseraction.

visible

(optional)

boolean

Visibility of the action button, defaults to true.

allowInIncognito

(optional)

boolean

Whether the action is available in incognito windows or not.

extensionType

(optional)

ExtensionType

The type of the extensionAction, either pageaction or browseraction. Defaults to |extensionAction|.

name

string

Name of extension.

homepage

(optional)

string

Homepage of extension.

optionspage

(optional)

string

Address of extension options page.

optionsInNewTab

(optional)

boolean

false if the options page should be opened embedded, true if it opens in a new tab.

keyboardShortcut

(optional)

string

Keyboard shortcut to toggle this extension.

sidePanel

(optional)

SidePanelInfo

contains sidepanel URL.

#ExtensionInstallError

Extension error.

Properties:

id

string

The unique extension identifier.

name

string

Extension name.

errorType

(optional)

GlobalErrorType

The type of the extensionAction, either pageaction or browseraction. Defaults to |extensionAction|.

commandId

integer

Int id to lookup an error on action.

Listeners

#onAdded

Fired when an extension has been loaded.

Parameters:

extension

ExtensionInfo

⚠ NO DESCRIPTION PROVIDED

#onRemoved

Fired when an extension has been unloaded.

Parameters:

extension

ExtensionInfo

⚠ NO DESCRIPTION PROVIDED

#onUpdated

Fired when an extensionAction is changed.

Parameters:

extension

ExtensionInfo

⚠ NO DESCRIPTION PROVIDED

#onClearAllValuesForTab

Fired on ExtensionAction::ClearAllValuesForTab().

Parameters:

extensionId

string

⚠ NO DESCRIPTION PROVIDED

tabId

number

⚠ NO DESCRIPTION PROVIDED

#onCommandAdded

Fired when a keyboard shortcut is added to an extension.

Parameters:

extensionId

string

⚠ NO DESCRIPTION PROVIDED

shortcut

string

⚠ NO DESCRIPTION PROVIDED

#onCommandRemoved

Fired when a keyboard shortcut is removed from an extension.

Parameters:

extensionId

string

⚠ NO DESCRIPTION PROVIDED

shortcut

string

⚠ NO DESCRIPTION PROVIDED

#onExtensionDisabledInstallErrorAdded

Fired when an extensionerror is created. Can be of various kinds of GlobalErrors

Parameters:

error

ExtensionInstallError

⚠ NO DESCRIPTION PROVIDED

#onExtensionDisabledInstallErrorRemoved

Fired when an extensionerror is handled or removed. Can be of various kinds of GlobalErrors.

Parameters:

error

ExtensionInstallError

⚠ NO DESCRIPTION PROVIDED

#onSidePanelOptionChanged

Fired when side panel opetion changed

Parameters:

extendionId

string

The unique extension identifier.

options

SidePanelOptions

⚠ NO DESCRIPTION PROVIDED

#onSidePanelActionRequested

Fired when side panel action requested

Parameters:

extendionId

string

The unique extension identifier.

Action

string

The unique action identifier.

Methods

#getToolbarExtensions

#executeExtensionAction

execute browserAction or pageAction for extension

Parameters:

extensionId

string

windowId

integer

id of the application window.

#removeExtension

Removes a specified extension.

Parameters:

extensionId

string

The id for the extension we want to remove.

windowId

integer

id of the application window. Used to find the Browser object.

#showExtensionOptions

Shows options for the given extension

Parameters:

extensionId

string

The id for the extension we want to remove.

windowId

integer

id of the application window. Used to find the Browser object.

#getExtensionMenu

Gets the context menu for the given extension

Parameters:

extensionId

string

The id for the extension we want to get the menu for.

#executeMenuAction

Execute menu action for extension.

Parameters:

extensionId

string

windowId

integer

id of the application window.

menuId

string

id of the menu item.

#showGlobalError

Show the dialog for an extension install error.

Parameters:

commandId

integer

The id for the error.

windowId

integer

id of the application window. Used to find the Browser object.

#triggerGlobalErrors

Loop through any pending global extension errors and fire events for the ui.

calendar

Types

#AccountType

ENUM

The account type. Maps to int in db: 0: Local. 1: Vivaldi.net calendar. 2: Google Calendar. 3: CalDAV. 4: Read only iCal.

local

vivaldi

google

caldav

ical

fastmail

#RecurrenceException

A object describing how an instance of event recurrence is changed.

Properties:

exception_id

(optional)

string

The id of the exception.

cancelled

(optional)

boolean

If a certain instance of recurring event is cancelled.

date

(optional)

number

The date of a recurring event that an exception should be added to. In milliseconds since the epoch.

exception_event_id

(optional)

string

The id of the event that serves as exception to the event in a recurrence series.

parent_event_id

(optional)

string

The id of the event that is parent to all the others events in the recurrence series.

#CreateNotificationRow

An object describing notification to be created during event creation.

Properties:

name

string

Name of the notification.

when

number

When this notification should fire. In milliseconds since the epoch.

#CreateInviteRow

An object describing invite to be created during event creation.

Properties:

name

string

Name of the invite.

address

string

The invite address.

partstat

string

The participation status for the event invite.

#SupportedCalendarComponents

An object describing supported calendar component set.

Properties:

vevent

boolean

Does the calendar support vevent.

vtodo

boolean

Does the calendar support vtodo.

vjournal

boolean

Does the calendar support vjournal.

#Notification

An object describing notification.

Properties:

id

string

The unique identifier for the notification. IDs are unique within the current profile, and they remain valid even after the browser is restarted.

event_id

(optional)

string

The event id this notification applies to.

name

string

Name of the notification.

description

(optional)

string

The description of the notification.

when

number

When this notification should fire. In milliseconds since the epoch.

period

(optional)

number

If not null, when the notification will fire. In milliseconds since the epoch.

delay

(optional)

integer

The notification will fire after delay minutes from now. Can not be used together with when.

#Invite

Object describing event invite.

Properties:

id

string

The id of the invite.

event_id

string

The id of the event that this invite applies to.

name

(optional)

string

The name of the contact to send the invite to.

address

string

The address of the contact to send the invite to.

sent

(optional)

boolean

States if the event invite has been sent or not.

partstat

(optional)

string

The participation status for the event invite.

#CalendarEvent

A calendar event. An event belongs to a single Calendar.

Properties:

id

string

The unique identifier for the event. IDs are unique within the current profile, and they remain valid even after the browser is restarted.

calendarId

string

The calendar id of the event.

alarmId

(optional)

string

The alarm id of the event.

title

string

Title of event.

description

(optional)

string

The event description.

start

(optional)

number

When this event starts, in milliseconds since the epoch.

end

(optional)

number

When this event ends, in milliseconds since the epoch.

allDay

(optional)

boolean

All day event.

is_recurring

(optional)

boolean

Is this a recurring event.

location

(optional)

string

The location of the event.

url

(optional)

string

The url of the event.

etag

(optional)

string

The CalDAV etag id of the event.

href

(optional)

string

The CalDAV href id of the event.

uid

(optional)

string

The event uid.

eventTypeId

(optional)

string

The event type id.

task

(optional)

boolean

Whether this event is a task. Tasks can be marked as completed.

complete

(optional)

boolean

If this event is a task type you can mark it as complete.

trash

(optional)

boolean

Is this event trashed.

trash_time

(optional)

number

When this event was trashed, in milliseconds since the epoch.

sequence

(optional)

integer

iCal sequence field according to: https://tools.ietf.org/html/rfc5545#section-3.8.7.4.

ical

(optional)

string

The original ical message.

rrule

(optional)

string

The recurring rule. In iCalendar format.

recurrenceExceptions

(optional)

List of recurrence exceptions. Either cancelled instances or moved.

Array of:

• RecurrenceException

notifications

(optional)

List of notifications.

Array of:

• Notification

organizer

(optional)

string

The organizer of the event.

invites

(optional)

List of invites.

Array of:

• Invite

timezone

(optional)

string

The timezone of the event.

priority

(optional)

integer

Priority of event or task. Must be in the range [0..9]. 0 is equivalent of no priority.

status

(optional)

string

The overall status or confirmation for the event or todo.

percentage_complete

(optional)

integer

The percent completion of a todo to the organizer.

categories

(optional)

string

Event or todo categories. A comma separated list.

component_class

(optional)

string

Access classification for a event or todo.

attachment

(optional)

string

Document object for a event or todo.

completed

(optional)

number

The date and time that a todo was actually completed.

syncPending

(optional)

boolean

Does this event have any pending sync changes.

deletePending

(optional)

boolean

Should the event be deleted locally once server deletion is completed.

end_recurring

(optional)

number

When this event ends re-occurring. In milliseconds since the epoch.

#CreateDetails

Object passed to the create() function.

Properties:

title

string

⚠ NO DESCRIPTION PROVIDED

description

(optional)

string

⚠ NO DESCRIPTION PROVIDED

start

(optional)

number

When this event shoud starts, in milliseconds since the epoch.

end

(optional)

number

When this event should ends, in milliseconds since the epoch.

allDay

(optional)

boolean

Is this a all day event.

is_recurring

(optional)

boolean

Is this a recurring event.

location

(optional)

string

The location of the event.

url

(optional)

string

The url of the event.

calendarId

string

The calendar id of the event.

etag

(optional)

string

The CalDAV etag id of the event.

href

(optional)

string

The CalDAV href id of the event.

uid

(optional)

string

The event uid.

task

(optional)

boolean

Whether this event is a task. Tasks can be marked as completed.

complete

(optional)

boolean

If this event is a task type you can mark it as complete.

sequence

(optional)

integer

iCal sequence field according to: https://tools.ietf.org/html/rfc5545#section-3.8.7.4.

ical

(optional)

string

The original ical message.

rrule

(optional)

string

The recurring rule. In iCalendar format.

eventTypeId

(optional)

string

The event type id of the event.

organizer

(optional)

string

The organizer of the event.

recurrenceExceptions

(optional)

List of recurrence exceptions.

Array of:

• RecurrenceException

notifications

(optional)

List of notifications to create.

Array of:

• CreateNotificationRow

invites

(optional)

List of invites to create.

Array of:

• CreateInviteRow

timezone

(optional)

string

The timezone of the event to create.

is_template

boolean

Is the event a template or not.

priority

(optional)

integer

Priority of event or task. Must be in the range [0..9]. 0 is equivalent of no priority.

status

(optional)

string

The overall status or confirmation for the event or todo.

percentage_complete

(optional)

integer

The percent completion of a todo to the organizer.

categories

(optional)

string

Event or todo categories. A comma separated list.

component_class

(optional)

string

Access classification for a event or todo.

attachment

(optional)

string

Document object for a event or todo.

completed

(optional)

number

The date and time that a todo was actually completed.

syncPending

(optional)

boolean

Does this event have any pending sync changes.

deletePending

(optional)

boolean

Should the event be deleted locally once server deletion is completed.

end_recurring

(optional)

number

When this event ends re-occurring. In milliseconds since the epoch.

#EventType

A event type.

Properties:

id

string

The unique identifier for the event type. IDs are unique within the current profile, and they remain valid even after the browser is restarted.

name

string

The event type name.

color

(optional)

string

The color of the event type.

iconindex

(optional)

integer

The event type icon index.

#CreateEventType

Object passed to the typeCreate() function.

Properties:

name

string

⚠ NO DESCRIPTION PROVIDED

color

(optional)

string

The color of the event type.

iconindex

(optional)

integer

The event type iconindex.

#CreateEventsResults

Object stating how many events were created successfully and how many creations resulted in errors.

Properties:

created_count

integer

Number of events created.

failed_count

integer

Number of failed event creation attempts.

#CreateCalendarDetails

Object passed to the createCalendar() function.

Properties:

accountId

string

The id of the account the calendar belongs to.

name

string

The name of the calendar to be created.

description

(optional)

string

The description of the calendar to be created.

orderindex

(optional)

integer

The UI order of the calendar.

iconindex

(optional)

integer

The iconindex of the calendar.

color

(optional)

string

The color of the calendar.

hidden

(optional)

boolean

If this calendar should be visible.

active

(optional)

boolean

If this CalDAV calendar should be polled.

lastChecked

(optional)

number

When this calendar last checked for updates. In milliseconds since the epoch.

timezone

(optional)

string

The timezone of the calendar.

ctag

(optional)

string

The ctag field of the CalDAV calendar.

supportedCalendarComponent

SupportedCalendarComponents

⚠ NO DESCRIPTION PROVIDED

#Calendar

Calendar that owns events.

Properties:

id

string

The unique identifier for the calendar. IDs are unique within the current profile, and they remain valid even after the browser is restarted.

accountId

string

The id of the account the calendar belongs to.

name

string

The name of the calendar.

description

(optional)

string

The calendar description.

orderindex

(optional)

integer

The UI order of the calendar.

color

(optional)

string

The UI color of the calendar.

hidden

(optional)

boolean

States if the calendar is hidden in the UI.

active

(optional)

boolean

States if a CalDAV calendar should be polled.

iconindex

(optional)

integer

Icon index of the calendar.

ctag

(optional)

string

The ctag field of the CalDAV calendar.

lastChecked

(optional)

number

When this calendar last checked for updates. In milliseconds since the epoch.

timezone

(optional)

string

The timezone of the calendar.

supportedCalendarComponent

SupportedCalendarComponents

⚠ NO DESCRIPTION PROVIDED

#updateCalendar

Object to update calendar.

Properties:

accountId

(optional)

string

The id of the account the calendar belongs to.

name

(optional)

string

The name of the calendar.

description

(optional)

string

The calendar description.

orderindex

(optional)

integer

The UI order of the calendar.

color

(optional)

string

The UI color of the calendar.

hidden

(optional)

boolean

States if the calendar is hidden in the UI.

active

(optional)

boolean

States if a CalDAV calendar should be polled.

iconindex

(optional)

integer

Icon index of the calendar.

ctag

(optional)

string

The ctag field of the CalDAV calendar.

lastChecked

(optional)

number

When this calendar last checked for updates. In milliseconds since the epoch.

timezone

(optional)

string

The timezone of the calendar.

supportedCalendarComponent

(optional)

SupportedCalendarComponents

⚠ NO DESCRIPTION PROVIDED

#updatedAccount

Object to update calendar.

Properties:

name

(optional)

string

⚠ NO DESCRIPTION PROVIDED

username

(optional)

string

⚠ NO DESCRIPTION PROVIDED

url

(optional)

string

The updated url of the account.

account_type

(optional)

AccountType

The type of account.

interval

(optional)

integer

The interval how often this account should poll. In seconds.

#createdAccount

Object to create calendar.

Properties:

name

string

⚠ NO DESCRIPTION PROVIDED

username

string

⚠ NO DESCRIPTION PROVIDED

url

string

The url of the account to create.

account_type

(optional)

AccountType

The type of account.

interval

(optional)

integer

The interval how often this account should poll. In seconds.

#Account

An object describing calendar account.

Properties:

id

string

The unique identifier for the account. IDs are unique within the current profile, and they remain valid even after the browser is restarted.

name

string

Name of the account.

username

string

The username of the account.

url

string

The base url of the account.

account_type

(optional)

AccountType

The type of account.

interval

(optional)

integer

The interval how often this account should poll. In seconds.

#EventTemplate

A event template object.

Properties:

id

string

The unique identifier for the event template.

name

string

The name of the event template.

ical

string

The ical of the event template.

Listeners

#onIcsFileOpened

Called when the user opens a downloaded ics file

Parameters:

filePath

string

⚠ NO DESCRIPTION PROVIDED

#onWebcalUrlOpened

Called when the user opens a webcal link

Parameters:

url

string

⚠ NO DESCRIPTION PROVIDED

#onMailtoOpened

Called when the user opens a mailto link

Parameters:

mailto

string

⚠ NO DESCRIPTION PROVIDED

#onEventCreated

Fired when a event is created.

Parameters:

createdEvent

CalendarEvent

The created event.

#onNotificationChanged

Fired when notification is created, updated or deleted.

Parameters:

changedNotification

Notification

The created, changed or updated notification.

#onCalendarDataChanged

Fired when the calendar datamodel should be reloaded.

Methods

#getAllEvents

Retrieves all events in calendar.

#getAllEventTypes

Retrieves all event types.

#getAllNotifications

Retrieves all notifications.

#eventCreate

Creates a event in the specified calendar.

Parameters:

event

CreateDetails

⚠ NO DESCRIPTION PROVIDED

#eventsCreate

Creates multiple events.

Parameters:

eventsList

⚠ NO DESCRIPTION PROVIDED

Array of:

• CreateDetailsMinimum items: 1

#deleteEvent

Deletes an event.

Parameters:

id

string

⚠ NO DESCRIPTION PROVIDED

#deleteEventException

Deletes an recurring event exception.

Parameters:

exception_id

string

The id of the exception to delete.

#updateRecurrenceException

Updates the recurrence exception of an event. Specify only the properties that you want to change. Unspecified properties will be left unchanged.

Parameters:

recurrenceId

string

⚠ NO DESCRIPTION PROVIDED

changes

object

⚠ NO DESCRIPTION PROVIDED

Object Properties:

cancelled

(optional)

boolean

If a certain instance of recurring event is cancelled.

date

(optional)

number

The date of a recurring event that an exception should be added to. In milliseconds since the epoch.

exception_event_id

(optional)

string

The id of the event that serves as exception to the event in a recurrence series.

parent_event_id

(optional)

string

The id of the event that is parent to all the others events in the recurrence series.

#updateEvent

Updates the properties of an event. Specify only the properties that you want to change. Unspecified properties will be left unchanged.

Parameters:

id

string

⚠ NO DESCRIPTION PROVIDED

changes

object

⚠ NO DESCRIPTION PROVIDED

Object Properties:

calendarId

(optional)

string

The updated calendar id of event.

alarmId

(optional)

string

The updated alarm id of event.

title

(optional)

string

The updated title of event.

description

(optional)

string

The updated description of event.

start

(optional)

number

When this event shoud starts, in milliseconds since the epoch.

end

(optional)

number

Updated time when this event should end, in milliseconds since the epoch.

allDay

(optional)

boolean

Is this all day event.

location

(optional)

string

The location of the event.

is_recurring

(optional)

boolean

Is this a recurring event.

url

(optional)

string

The url of the event.

etag

(optional)

string

The CalDAV.etag of the event.

href

(optional)

string

The href id of the event.

uid

(optional)

string

The event uid.

eventTypeId

(optional)

string

The event type id.

task

(optional)

boolean

Whether this event is a task. Tasks can be marked as completed.

complete

(optional)

boolean

If this event is a task type you can mark it as complete.

trash

(optional)

boolean

Is this event trashed.

sequence

(optional)

integer

iCal sequence field according to: https://tools.ietf.org/html/rfc5545#section-3.8.7.4.

ical

(optional)

string

The original ical message.

rrule

(optional)

string

The recurring rule. In iCalendar format.

organizer

(optional)

string

The organizer of the event.

timezone

(optional)

string

The timezone of the event.

priority

(optional)

integer

Priority of event or task. Must be in the range [0..9]. 0 is equivalent of no priority.

status

(optional)

string

The overall status or confirmation for the event or todo.

percentage_complete

(optional)

integer

The percent completion of a todo to the Organizer.

categories

(optional)

string

Event or todo categories. A comma separated list.

component_class

(optional)

string

Access classification for a event or todo.

attachment

(optional)

string

Access classification for a event or todo.

completed

(optional)

number

The date and time that a todo was actually completed.

syncPending

(optional)

boolean

Does this event have any pending sync changes.

deletePending

(optional)

boolean

Should the event be deleted locally once server deletion is completed.

end_recurring

(optional)

number

When this event ends re-occurring. In milliseconds since the epoch.

#create

Creates a calendar.

Parameters:

calendar

CreateCalendarDetails

⚠ NO DESCRIPTION PROVIDED

#getAll

Returns all calendars.

#delete

Deletes a calendar, with all its events and event exceptions.

Parameters:

id

string

The id of the calendar to be deleted.

#update

Updates the properties of an calendar. Specify only the properties that you want to change. Unspecified properties will be left unchanged.

Parameters:

id

string

⚠ NO DESCRIPTION PROVIDED

changes

updateCalendar

⚠ NO DESCRIPTION PROVIDED

#eventTypeCreate

Creates a event type.

Parameters:

event_type

CreateEventType

⚠ NO DESCRIPTION PROVIDED

#eventTypeUpdate

Updates the properties of an event type. Specify only the properties that you want to change. Unspecified properties will be left unchanged.

Parameters:

id

string

⚠ NO DESCRIPTION PROVIDED

changes

object

⚠ NO DESCRIPTION PROVIDED

Object Properties:

name

(optional)

string

⚠ NO DESCRIPTION PROVIDED

color

(optional)

string

The updated color of the event type.

iconindex

(optional)

integer

The iconindex of the event type.

#deleteEventType

Deletes an event type.

Parameters:

id

string

⚠ NO DESCRIPTION PROVIDED

#createEventException

Creates an exception to event instance in recurring series.

Parameters:

parent_event_id

string

The parent id of the event in the recurrence series.

exception_event_id

(optional)

string

The id of the event that serves as exception to the event in a recurrence series.

cancelled

boolean

Cancel this instance of recurring event.

date

(optional)

number

When the exception should happen. In milliseconds since the epoch.

#createNotification

Creates a notification.

Parameters:

createNotification

object

⚠ NO DESCRIPTION PROVIDED

Object Properties:

event_id

(optional)

string

The event id of the event to create the notification for.

name

string

The name of the notification.

description

(optional)

string

The description of the notification.

when

number

When the notification should fire. In milliseconds since the epoch.

period

(optional)

number

If not null, when the notification will fire. In milliseconds since the epoch.

delay

(optional)

integer

The notification will fire after delay minutes from now. Can not be used together with when.

#updateNotification

Updates the properties of a notification. Specify only the properties that you want to change. Unspecified properties will be left unchanged.

Parameters:

id

string

The id of the notification to update.

changes

object

⚠ NO DESCRIPTION PROVIDED

Object Properties:

name

(optional)

string

The name of the notification.

description

(optional)

string

The description of the notification.

when

(optional)

number

When the notification should fire. In milliseconds since the epoch.

period

(optional)

number

If not null, when the notification will fire. In milliseconds since the epoch.

delay

(optional)

integer

The notification will fire after delay minutes from now. Can not be used together with when.

#deleteNotification

Deletes a notification.

Parameters:

id

string

⚠ NO DESCRIPTION PROVIDED

#createInvite

Creates an invite for event.

Parameters:

createInvite

object

⚠ NO DESCRIPTION PROVIDED

Object Properties:

event_id

string

The event id of the event to create the invite for.

address

string

The email address to send the invite to.

name

string

The name of the persion to send the invite to.

partstat

(optional)

string

The participation status for the event invite

sent

(optional)

boolean

Has the invite been sent.

#deleteInvite

Deletes an invite.

Parameters:

id

string

The invite id to delete.

#updateInvite

Updates an invite for event.

Parameters:

updateInvite

object

⚠ NO DESCRIPTION PROVIDED

Object Properties:

id

string

The id of the invite to update.

address

(optional)

string

The email address to send the invite to.

name

(optional)

string

The name of the persion to send the invite to.

partstat

(optional)

string

The participation status for the event invite.

sent

(optional)

boolean

Has the invite been sent.

#getAllAccounts

Retrieves all calendar accounts.

#createAccount

Creates an account.

Parameters:

toCreate

createdAccount

⚠ NO DESCRIPTION PROVIDED

#updateAccount

Updates the properties of an account. Specify only the properties that you want to change. Unspecified properties will be left unchanged.

Parameters:

id

string

⚠ NO DESCRIPTION PROVIDED

changes

updatedAccount

⚠ NO DESCRIPTION PROVIDED

#deleteAccount

Deletes an account and its calendars, events, recurring_exceptions, notifications etc

Parameters:

id

string

The account id to be deleted

#createEventTemplate

Creates an event template.

Parameters:

name

string

The event template name.

ical

string

The event template ical.

#getAllEventTemplates

Retrieves all event templates.

#updateEventTemplate

Updates the properties of an event template. Specify only the properties that you want to change. Unspecified properties will be left unchanged.

Parameters:

id

string

The id of the event template to update.

changes

object

⚠ NO DESCRIPTION PROVIDED

Object Properties:

name

(optional)

string

The updated name of the event template.

ical

(optional)

string

The updated ical of the event template.

#getParentExceptionId

Returns the parent event id of a exception event id.

Parameters:

exception_event_id

string

The id of the event exception to return the parent event id for.

#deleteEventTemplate

Deletes an event template.

Parameters:

id

string

The id of the event template to delete.

contacts

Types

#ContactPropertyName

ENUM

Property types for adding, updating and removing postal address and phonenumbers for contacts.

postalAddress

phoneNumber

#EmailAddress

An email address object

Properties:

id

string

The unique identifier for the email address. IDs are unique within the current profile, and they remain valid even after the browser is restarted.

emailAddress

(optional)

string

The email address of the contact.

type

(optional)

string

The type of email address. WORK, HOME etc

favorite

(optional)

boolean

Is this email address favorite for user.

obsolete

(optional)

boolean

Is this email address obsolete. If true it should not show up in autocomplete when composing email

#Phonenumber

A phonenumber object

Properties:

id

string

The unique identifier for the phonenumber. IDs are unique within the current profile, and they remain valid even after the browser is restarted.

phoneNumber

(optional)

string

The phonenumber.

type

(optional)

string

The type of phonenumber. WORK, HOME etc

#PostalAddress

A postal address object

Properties:

id

string

The unique identifier for the postal address. IDs are unique within the current profile, and they remain valid even after the browser is restarted.

postalAddress

(optional)

string

The postal address.

type

(optional)

string

The type of postal address. WORK, HOME etc

#Contact

A contact object

Properties:

id

string

The unique identifier for the contact. IDs are unique within the current profile, and they remain valid even after the browser is restarted.

name

(optional)

string

The name id of the contact.

birthday

(optional)

number

The birthday of the contact.

note

(optional)

string

A note for the contact.

emailAddresses

⚠ NO DESCRIPTION PROVIDED

Array of:

• EmailAddress

phoneNumbers

⚠ NO DESCRIPTION PROVIDED

Array of:

• Phonenumber

postalAddresses

⚠ NO DESCRIPTION PROVIDED

Array of:

• PostalAddress

avatarUrl

(optional)

string

A url for the contact avatar url.

separator

boolean

Is this contact a dummy separator.

generatedFromSentMail

boolean

Is this contact generated by sent mail.

trusted

(optional)

boolean

Can this contact load external content

#CreateUpdateDetails

Object passed to the create and update contact function.

Properties:

name

(optional)

string

The name of the contact.

birthday

(optional)

number

The birthday of the contact. In milliseconds since epoch

note

(optional)

string

The note for the contact.

generatedFromSentMail

(optional)

boolean

Was this contact generated by sent mail.

avatarUrl

(optional)

string

A url for the contact avatar url.

separator

(optional)

boolean

Is this contact a dummy separator.

trusted

(optional)

boolean

Can this contact load external content

#AddPropertyDetails

Object passed to the addPropertyItem() function.

Properties:

propertyName

ContactPropertyName

The type to add (postal address, phone).

contactId

string

The id of the contact.

propertyValue

string

The email address or phonenumber of the contact.

type

string

The type of email address. Example: WORK, HOME. Note type=INTERNET is default.

asDefault

(optional)

boolean

Should the email address be default for the contact

#EmailAddressAddUpdate

Object passed to the addPropertyItem() function.

Properties:

contactId

string

The id of the contact.

emailAddress

(optional)

string

The email address of the contact.

type

(optional)

string

The type of email address. WORK, HOME etc

favorite

(optional)

boolean

Is this email address favorite for user.

obsolete

(optional)

boolean

Is this email address obsolete. If true it should not show up in autocomplete when composing email

#RemovePropertyDetails

Object passed to the removeProperty() function.

Properties:

propertyName

ContactPropertyName

The property name to remove (postal address, phone).

contactId

string

The id of the contact.

propertyId

string

The email address of the contact.

#UpdatePropertyDetails

Object passed to the updateProperty() function.

Properties:

propertyName

ContactPropertyName

The property name to be updated (address, phone).

contactId

string

The id of the contact.

propertyId

string

The id of the property to be updated.

propertyValue

string

The email address or phonenumber value to update for the given contact.

type

string

The type of address, phone. WORK, HOME etc

#CreateManyContactsResults

Object stating how many contacts were created successfully and how many creations resulted in errors

Properties:

created_count

(optional)

integer

Number of contacts created

failed_count

(optional)

integer

Number of failed contacts creation attempts

Listeners

#onContactCreated

Fired when a contact is created.

Parameters:

createdContact

Contact

The created contact

#onContactRemoved

Fired when contact is deleted.

Parameters:

removedContact

Contact

The deleted contact

#onContactChanged

Fired when contact is updated.

Parameters:

changedContact

Contact

The changed contact

Methods

#getAll

Retrieves all contacts

#getAllEmailAddresses

Retrieves all email addresses for all contacts

#create

Creates a contact.

Parameters:

contact

CreateUpdateDetails

⚠ NO DESCRIPTION PROVIDED

#createMany

Creates / imports multiple contacts.

Parameters:

contactList

⚠ NO DESCRIPTION PROVIDED

Array of:

• CreateUpdateDetailsMinimum items: 1

#update

Updates the properties of a contact. Specify only the properties that you want to change. Unspecified properties will be left unchanged.

Parameters:

id

string

The contact id to be updated

changes

CreateUpdateDetails

⚠ NO DESCRIPTION PROVIDED

#delete

Deletes a contact.

Parameters:

id

string

⚠ NO DESCRIPTION PROVIDED

#addPropertyItem

Adds a property to a contact.

Parameters:

propertyToAdd

AddPropertyDetails

⚠ NO DESCRIPTION PROVIDED

#addEmailAddress

Adds an email address to a contact.

Parameters:

emailToAdd

EmailAddressAddUpdate

Object holding the fields for the email address to create

#updateEmailAddress

Updates an email address for a contact.

Parameters:

emailAddressId

string

The id of email address to update

emailToUpdate

EmailAddressAddUpdate

Object holding the fields for the email address to update

#removeEmailAddress

Removes an email address for a contact.

Parameters:

removeEmail

object

An object specifying properties to remove email address.

Object Properties:

contactId

string

The contact id of which email address to remove.

emailAddressId

string

The id of email address to remove

#updatePropertyItem

Updates a property for a contact.

Parameters:

propertyToUpdate

UpdatePropertyDetails

⚠ NO DESCRIPTION PROVIDED

#removePropertyItem

Removes a property from a contact.

Parameters:

propertyToRemove

RemovePropertyDetails

⚠ NO DESCRIPTION PROVIDED

#readThunderbirdContacts

Read thunderbird contacts from db files.

Parameters:

path

string

Profile Path to thunderbird directory, containing: abook.sqlite and history.sqlite files.

contentBlocking

Types

#RuleGroup

ENUM

Used to specify whether a specific operation should apply to tracking blocking or adblocking.

tracking

ad_blocking

#ExceptionList

ENUM

Used to inform whether the exception list used in a rule group is a list of exemptions or a list for which process is enabled

process_list

exempt_list

#FetchResult

ENUM

The result of a fetch operation on a rule source.

success: Fetch completed successfully.

download_failed: For an online source, failed to download using the provided URL.

file_not_found: For a local source, the file provided didn't seem to exist.

file_read_error: For a local source, the file provided couldn't be read.

file_unsupported: The rules file is of an invalid format or doesn't contain any valid rule.

failed_saving_parsed_rules: The rules were fetched and compiled properly, but the result couldn't be saved to the profile.

unknown: No fetching attempt has completed yet.

#RulesInfo

Information about the rules themselves and more detailed parsing results

Properties:

valid_rules

integer

The number of entries in the file that resulted in a rule being compiled.

unsupported_rules

integer

The number of entries in the file that resolved to valid rules that either didn't make sense or are not supported at this time.

invalid_rules

integer

The number of entries in the file that resolved to valid rules that could not be parsed to a rule or were explicitly against the spec.

#AdBlockMetadata

Information extracted from the adblock file comments. If the user added a malicous source, these could be anything. Handle with care.

Properties:

homepage

string

URL pointing to the original website for this list.

title

string

List name.

expires

integer

How often the list is refreshed, in hours.

license

string

URL pointing to licensing info for the list.

version

integer

Version number of the list.

#RuleSourceSettings

Parameters used when parsing the rules list. Can only be modified when the source is disabled

Properties:

allow_abp_snippets

boolean

If false, any present abp snippet rules will be ignored.

naked_hostname_is_pure_host

boolean

If true, any rule that looks like just a host name will be converted to match only the host part of the url.

use_whole_document_allow

boolean

If true, any allow rule using the document type will cause all resources loaded by matching documents to be allowed (ABP beahvior).

#RuleSource

Information about a loaded rule source, including its fetching status and metadata retrieved when extracting rules from it

Properties:

source_url

string

For an online source, this is the url that was provided when setting it up.

source_file

string

For an local source, this is the file that was provided when setting it up.

is_from_url

boolean

indicates whether the rule source is online or local, and which of the source_url and source_file fields is valid

settings

RuleSourceSettings

See RuleSourceSettings.

id

integer

⚠ NO DESCRIPTION PROVIDED

rules_list_checksum

string

Checksum of the compiled rule file derived from this source. This will be the empty string if the rule source has never been fetched succesfully.

unsafe_adblock_metadata

AdBlockMetadata

⚠ NO DESCRIPTION PROVIDED

last_update

number

The last time the source was successfully fetched and the corresponding rules updated. Represented in milliseconds since the epoch.

next_fetch

number

The next time a fetching and updating from the rule source will be attempted. Represented in milliseconds since the epoch.

is_fetching

boolean

Whether fetching of the rule source is in progress

last_fetch_result

FetchResult

The result of the last fetch attempt

rules_info

RulesInfo

⚠ NO DESCRIPTION PROVIDED

removable

boolean

⚠ NO DESCRIPTION PROVIDED

loaded

boolean

⚠ NO DESCRIPTION PROVIDED

#BlockedCounter

How often requests relating to a domain were blocked

Properties:

domain

string

⚠ NO DESCRIPTION PROVIDED

blocked_count

integer

⚠ NO DESCRIPTION PROVIDED

#BlockedUrlsInfo

Information about a blocked URL

Properties:

url

string

⚠ NO DESCRIPTION PROVIDED

blocked_count

integer

⚠ NO DESCRIPTION PROVIDED

#TrackerInfo

Information for a given tracker

Properties:

source_id

integer

The id of the rule source from which this info was obtained.

info

any

⚠ NO DESCRIPTION PROVIDED

#BlockedTrackersInfo

Information about a blocked tracker

Properties:

domain

string

⚠ NO DESCRIPTION PROVIDED

blocked_urls

blocked urls that belong to this tracker

Array of:

• BlockedUrlsInfo

tracker_info

⚠ NO DESCRIPTION PROVIDED

Array of:

• TrackerInfo

blocked_count

integer

⚠ NO DESCRIPTION PROVIDED

#TabBlockedUrlsInfo

Information about urls that got blocked, per tab

Properties:

tab_id

integer

⚠ NO DESCRIPTION PROVIDED

total_blocked_count

integer

⚠ NO DESCRIPTION PROVIDED

blocked_trackers_info

blocked urls that belong to a known tracker, alongside with tracker information.

Array of:

• BlockedTrackersInfo

blocked_urls_info

blocked urls for which there is no tracker information.

Array of:

• BlockedUrlsInfo

#AdAttributionDomain

Information about which domain ad attribution is enabled for, if any, for a given tab

Properties:

tab_id

integer

⚠ NO DESCRIPTION PROVIDED

domain

string

⚠ NO DESCRIPTION PROVIDED

active

boolean

True if the tab is currently on the ad attribution domain, causing ad attribution to be enabled.

#AllowedAdAttributionTrackers

Information about which trackers have been allowed for ad attribution, per tab

Properties:

tab_id

integer

⚠ NO DESCRIPTION PROVIDED

tracker_urls

⚠ NO DESCRIPTION PROVIDED

Array of:

• string

Listeners

#onRuleSourceAdded

Fired when a known rule source has been added

Parameters:

rule_source

RuleSource

⚠ NO DESCRIPTION PROVIDED

rule_group

RuleGroup

⚠ NO DESCRIPTION PROVIDED

#onRuleSourceUpdated

The properties of a rule source have been updated, either because a fetch started or completed.

Parameters:

rule_source

RuleSource

⚠ NO DESCRIPTION PROVIDED

rule_group

RuleGroup

⚠ NO DESCRIPTION PROVIDED

#onRuleSourceEnabled

Fired when a known rule source has been enabled

Parameters:

source_id

integer

⚠ NO DESCRIPTION PROVIDED

rule_group

RuleGroup

⚠ NO DESCRIPTION PROVIDED

#onRuleSourceDisabled

Fired when a known rule source has been disabled

Parameters:

source_id

integer

⚠ NO DESCRIPTION PROVIDED

rule_group

RuleGroup

⚠ NO DESCRIPTION PROVIDED

#onRuleSourceRemoved

Fired when a known rule source has been removed

Parameters:

source_id

integer

⚠ NO DESCRIPTION PROVIDED

rule_group

RuleGroup

⚠ NO DESCRIPTION PROVIDED

#onStateChanged

Fired when a group has been enabled/disabled or when an exception state has changed.

Parameters:

rule_group

RuleGroup

⚠ NO DESCRIPTION PROVIDED

#onExceptionsChanged

Fired when the list of exceptions has changed.

Parameters:

rule_group

RuleGroup

⚠ NO DESCRIPTION PROVIDED

exception_list

ExceptionList

⚠ NO DESCRIPTION PROVIDED

#onUrlsBlocked

Fired when urls have been blocked by either the ad-blocker or the tracker-blocker. This is fired at most once per second.

Parameters:

rule_group

RuleGroup

⚠ NO DESCRIPTION PROVIDED

tab_ids

⚠ NO DESCRIPTION PROVIDED

Array of:

• integer

#onAdAttributionDomainChanged

Fires when the eTLD+s on which ad attribution is active changes or if the tab is navigated away from that domain.

Parameters:

tab_id

integer

⚠ NO DESCRIPTION PROVIDED

#onAdAttributionTrackersAllowed

Fired when trackers have been allowed on some tabs, as a result of ad attribution.

Parameters:

tab_ids

⚠ NO DESCRIPTION PROVIDED

Array of:

• integer

Methods

#setRuleGroupEnabled

Changes whether a particular type of blocking is in effect.

Parameters:

rule_group

RuleGroup

⚠ NO DESCRIPTION PROVIDED

enabled

boolean

⚠ NO DESCRIPTION PROVIDED

#isRuleGroupEnabled

Checks whether a specific type of blocking is in effect.

Parameters:

rule_group

RuleGroup

⚠ NO DESCRIPTION PROVIDED

#addKnownSourceFromURL

Adds an online rule source. Newly added sources are automatically enabled.

Parameters:

rule_group

RuleGroup

⚠ NO DESCRIPTION PROVIDED

url

string

⚠ NO DESCRIPTION PROVIDED

source_settings

(optional)

RuleSourceSettings

⚠ NO DESCRIPTION PROVIDED

#addKnownSourceFromFile

Adds an local rule source. Newly added sources are automatically enabled.

Parameters:

rule_group

RuleGroup

⚠ NO DESCRIPTION PROVIDED

file

string

⚠ NO DESCRIPTION PROVIDED

source_settings

(optional)

RuleSourceSettings

⚠ NO DESCRIPTION PROVIDED

#setKnownSourceSettings

Changes the settings used when parsing the rules

Parameters:

rule_group

RuleGroup

⚠ NO DESCRIPTION PROVIDED

source_id

integer

⚠ NO DESCRIPTION PROVIDED

source_settings

RuleSourceSettings

⚠ NO DESCRIPTION PROVIDED

#enableSource

Enables and loads a known rule source

Parameters:

rule_group

RuleGroup

⚠ NO DESCRIPTION PROVIDED

source_id

integer

⚠ NO DESCRIPTION PROVIDED

#disableSource

Disables and unloads a known rule source

Parameters:

rule_group

RuleGroup

⚠ NO DESCRIPTION PROVIDED

source_id

integer

⚠ NO DESCRIPTION PROVIDED

#fetchSourceNow

Forces fetching of a loaded rule source. Does nothing if a fetch is already in progress

Parameters:

rule_group

RuleGroup

⚠ NO DESCRIPTION PROVIDED

source_id

integer

⚠ NO DESCRIPTION PROVIDED

#deleteKnownSource

Remove a known rule source. The source will be disabled before removal.

Parameters:

rule_group

RuleGroup

⚠ NO DESCRIPTION PROVIDED

source_id

integer

⚠ NO DESCRIPTION PROVIDED

#resetPresetSources

Re-adds all preset sources that were removed by the user.

Parameters:

rule_group

RuleGroup

⚠ NO DESCRIPTION PROVIDED

#getRuleSource

Gets detailed information about a known rule source

Parameters:

rule_group

RuleGroup

⚠ NO DESCRIPTION PROVIDED

source_id

integer

⚠ NO DESCRIPTION PROVIDED

#getRuleSources

Gets detailed information about all known rule sources. Loaded sources will have extra information.

Parameters:

rule_group

RuleGroup

⚠ NO DESCRIPTION PROVIDED

#setActiveExceptionsList

Sets whether a rule group should use a list of exempted domains or a list of domains to which it applies.

Parameters:

rule_group

RuleGroup

⚠ NO DESCRIPTION PROVIDED

state

ExceptionList

⚠ NO DESCRIPTION PROVIDED

#getActiveExceptionsList

Checks whether a rule group is using a list of exempted domains or a list of domains to which it applies

Parameters:

rule_group

RuleGroup

⚠ NO DESCRIPTION PROVIDED

#addExceptionForDomain

Adds an item to the exception list

Parameters:

rule_group

RuleGroup

⚠ NO DESCRIPTION PROVIDED

exception_list

ExceptionList

⚠ NO DESCRIPTION PROVIDED

domain

string

⚠ NO DESCRIPTION PROVIDED

#removeExceptionForDomain

Removes an item from the exception list

Parameters:

rule_group

RuleGroup

⚠ NO DESCRIPTION PROVIDED

exception_list

ExceptionList

⚠ NO DESCRIPTION PROVIDED

domain

string

⚠ NO DESCRIPTION PROVIDED

#removeAllExceptions

Removes all domains from the exception list

Parameters:

rule_group

RuleGroup

⚠ NO DESCRIPTION PROVIDED

exception_list

ExceptionList

⚠ NO DESCRIPTION PROVIDED

#getExceptions

Retrieves all domains from the exeption list

Parameters:

rule_group

RuleGroup

⚠ NO DESCRIPTION PROVIDED

exception_list

ExceptionList

⚠ NO DESCRIPTION PROVIDED

#getAllExceptionLists

Retrieves all the exception lists

#getBlockedUrlsInfo

Retrieves information about which URLs have been blocked from loading in a given tab

Parameters:

rule_group

RuleGroup

⚠ NO DESCRIPTION PROVIDED

tab_ids

A list of tabs for which to retrieve blocked urls information.

Array of:

• integer

#getBlockedCounters

Retrieves the amount of requests blocked since the last time the counters got reset.

#clearBlockedCounters

Resets the counters used for getBlockedCounters

#isExemptOfFiltering

Returns whether a page URL will be exempt from filtering by a given rule group, based on the active exception list.

Parameters:

rule_group

RuleGroup

⚠ NO DESCRIPTION PROVIDED

url

string

⚠ NO DESCRIPTION PROVIDED

#getAdAttributionDomain

Gets the eTLD+1 for which ad attribution is currently active on the given tabs, if any.

Parameters:

tab_ids

A list of tabs for which to retrieve the ad attribution stats.

Array of:

• integer

#getAdAttributionAllowedTrackers

Gets the allowed ad attribution trackers for the given tabs, if any.

Parameters:

tab_ids

A list of tabs for which to retrieve allowed ad attribution trackers.

Array of:

• integer

contextMenu

Types

#Rect

Position and size of item that opens menu

Properties:

x

number

Left position of item that opens menu, screen coordinates.

y

number

Top position of item that opens menu, screen coordinates.

width

number

Width of item that opens menu.

height

number

Height of item that opens menu.

#Origin

ENUM

Menu location with respect to rectangle. With pointer the size and height is ignored.

pointer

topLeft

bottomLeft

topRight

bottomRight

#ItemType

ENUM

What kind of item.

command

checkbox

radio

folder

#Icons

Icons

Icons encoded as base64.

Array of:

• string

#ContainerMode

ENUM

Defines container layouts.

inline

folder

#ContainerContent

ENUM

Defines functionality to set up on the C++ side. One or more menu items may be created.

extensions

imageinprofile

linkinprofile

linktohighlight

notes

pwa

linkinpwa

sendlinktodevices

sendpagetodevices

sendimagetodevices

spellcheck

spellcheckoptions

speech

#Item

One menu item.

Properties:

name

string

Text in item.

id

integer

The unique id of item.

type

ItemType

The kind of menu element

action

(optional)

string

Action to execute. This is used for actions that needs to execute in C++. The value must be well defined

radiogroup

(optional)

integer

The radiobutton group this item belongs to.

checked

(optional)

boolean

true if the checkbox is checked, otherwise false. Only applies for type='checkbox'.

enabled

(optional)

boolean

true if the item is enabled.

url

(optional)

string

Url that can be used to determine a corresponding icon.

shortcut

(optional)

string

A shortcut displayed next to the name. No binding is added.

showshortcut

(optional)

boolean

Controls if a shortcut shall be shown. Needed for elements where shortcut is set up in C++ code

persistent

(optional)

boolean

If true the menu item will remain open after menu item is clicked with mouse.

icons

(optional)

Icons

Icon in PNG format encoded as base64.

#Container

Container to expand

Properties:

id

integer

The unique id of item.

name

string

Text in item when mode is folder

content

ContainerContent

Specifies an element to expand in C++ to one or more elements. How it is expanded is implementation specific.

mode

ContainerMode

Container content format

icons

(optional)

Icons

Icon in PNG format encoded as base64.

#Separator

One separator

Properties:

label

(optional)

string

Text in item.

#Element

One element in menu. All optional, but one and only one of 'item', 'separator' or 'container' should be set. 'children' is only considered when 'item' is set.

Properties:

item

(optional)

Item

⚠ NO DESCRIPTION PROVIDED

container

(optional)

Container

⚠ NO DESCRIPTION PROVIDED

separator

(optional)

Separator

⚠ NO DESCRIPTION PROVIDED

children

(optional)

Child menu items.

Array of:

• Element

#DocumentType

ENUM

The kind of document menu.

page

link

image

selection

#TextfieldType

ENUM

Defines the type of textfield

addressfield

searchfield

regular

document

#DocumentSupport

⚠ NO DESCRIPTION PROVIDED

Properties:

copy

boolean

For elements outside editor

audio

boolean

⚠ NO DESCRIPTION PROVIDED

canvas

boolean

⚠ NO DESCRIPTION PROVIDED

editoptions

boolean

⚠ NO DESCRIPTION PROVIDED

emoji

boolean

⚠ NO DESCRIPTION PROVIDED

extensions

boolean

⚠ NO DESCRIPTION PROVIDED

highlight

boolean

⚠ NO DESCRIPTION PROVIDED

pictureinpicture

boolean

⚠ NO DESCRIPTION PROVIDED

password

boolean

⚠ NO DESCRIPTION PROVIDED

passwordgeneration

boolean

⚠ NO DESCRIPTION PROVIDED

passwordshowall

boolean

⚠ NO DESCRIPTION PROVIDED

paste

boolean

⚠ NO DESCRIPTION PROVIDED

plugin

boolean

⚠ NO DESCRIPTION PROVIDED

qrcode

boolean

⚠ NO DESCRIPTION PROVIDED

sendtodevices

boolean

⚠ NO DESCRIPTION PROVIDED

video

boolean

⚠ NO DESCRIPTION PROVIDED

#DocumentArea

⚠ NO DESCRIPTION PROVIDED

Properties:

devtools

boolean

⚠ NO DESCRIPTION PROVIDED

editor

boolean

⚠ NO DESCRIPTION PROVIDED

image

boolean

⚠ NO DESCRIPTION PROVIDED

frame

boolean

⚠ NO DESCRIPTION PROVIDED

webpanel

boolean

⚠ NO DESCRIPTION PROVIDED

#DocumentParams

Properties of the document that requests a menu

Properties:

linkurl

string

⚠ NO DESCRIPTION PROVIDED

linktitle

string

⚠ NO DESCRIPTION PROVIDED

pageurl

string

⚠ NO DESCRIPTION PROVIDED

pagetitle

string

⚠ NO DESCRIPTION PROVIDED

srcurl

string

⚠ NO DESCRIPTION PROVIDED

selection

string

⚠ NO DESCRIPTION PROVIDED

printableselection

string

⚠ NO DESCRIPTION PROVIDED

selectionurl

string

⚠ NO DESCRIPTION PROVIDED

keywordurl

string

⚠ NO DESCRIPTION PROVIDED

isdevtools

boolean

⚠ NO DESCRIPTION PROVIDED

iseditable

boolean

⚠ NO DESCRIPTION PROVIDED

isimage

boolean

⚠ NO DESCRIPTION PROVIDED

isframe

boolean

⚠ NO DESCRIPTION PROVIDED

ismailcontent

boolean

⚠ NO DESCRIPTION PROVIDED

iswebpanel

boolean

⚠ NO DESCRIPTION PROVIDED

ismailto

boolean

⚠ NO DESCRIPTION PROVIDED

iswebpagewidget

boolean

⚠ NO DESCRIPTION PROVIDED

support

DocumentSupport

⚠ NO DESCRIPTION PROVIDED

textfield

(optional)

TextfieldType

⚠ NO DESCRIPTION PROVIDED

Listeners

#onDocumentMenu

Fires when a document menu is requested.

Parameters:

window

integer

id of window where command occurred.

document

integer

id of the document requesting this menu.

state

DocumentParams

Document data for the given type of menu.

Methods

#show

Shows a new context menu.

Parameters:

properties

object

⚠ NO DESCRIPTION PROVIDED

Object Properties:

children

⚠ NO DESCRIPTION PROVIDED

Array of:

• Element

documentId

integer

⚠ NO DESCRIPTION PROVIDED

icons

Icons

Default and folder icons.

forceViews

boolean

⚠ NO DESCRIPTION PROVIDED

origin

Origin

⚠ NO DESCRIPTION PROVIDED

rect

Rect

⚠ NO DESCRIPTION PROVIDED

windowId

integer

⚠ NO DESCRIPTION PROVIDED

devtoolsPrivate

Types

#DevtoolResizingStrategy

Object containing size and state for the inspected web contents. The devtools itself always uses the full size.

Properties:

inspectedLeft

integer

Left coordinate of inspected web contents.

inspectedTop

integer

Top coordinate of inspected web contents.

inspectedWidth

integer

Width of inspected web contents.

inspectedHeight

integer

Height of inspected web contents.

hideInspectedContents

boolean

false to hide the inspected contents, otherwise true.

#DevtoolsWindowParams

Object containing size and state for the undocked devtools window.

Properties:

left

integer

Left coordinate of window.

top

integer

Top coordinate of window.

right

integer

Right coordinate of window.

bottom

integer

Bottom coordinate of window.

maximized

boolean

Should window be maximized.

alwaysOnTop

boolean

Should window be always on top.

#PanelType

ENUM

Whether to open the the element panel (inspect mode), console panel, or the default.

console: Open devtool with the Console panel selected

inspect: Open devtools with the Elements panel selected

default: Open devtools with the default panel selected

Listeners

#onDockingStateChanged

Fired when devtools changed its docking state.

Parameters:

tabId

integer

The tab id of the tab changing its devtools docking state.

dockingState

string

The new devtools docking state. Possible values are right, bottom or undocked.

#onDockingSizesChanged

Fired when devtools changed its sizes. Use |getDockingStateSizes| to read the new sizes.

Parameters:

tabId

integer

The tab id of the tab changing its devtools docking state.

#onClosed

Fired when docked devtools closed.

Parameters:

tabId

integer

The tab id of the tab changing its devtools docking state.

#onDevtoolsUndocked

Fired when devtools wants to undock and we might need to open a window for it.

Parameters:

tabId

integer

The tab id of the tab we are debugging.

showWindow

boolean

Show the initial window. May be false in which case the user likely just re-selected inspect on an existing web page.

params

DevtoolsWindowParams

⚠ NO DESCRIPTION PROVIDED

#onActivateWindow

Fired when devtools wants to activate the given undocked devtools window.

Parameters:

tabId

integer

The tab id of the tab we are debugging.

Methods

#getDockingStateSizes

Used to request the size and state of the inspected webview.

Parameters:

tabId

integer

The tab id of the tab changing its devtools docking state.

#closeDevtools

Explicitly close the open devtools instance for the given tabId or windowId.

Parameters:

tabId

integer

The tab id of the tab to close devtools for.

windowId

(optional)

integer

The window id (not app window id) of the window to close all open devtools for.

#toggleDevtools

Toggle developer tools.

Parameters:

windowId

integer

The window id for the browserwindow we want to toggle devtools for.

panelType

PanelType

⚠ NO DESCRIPTION PROVIDED

editcommand

Methods

#execute

⚠ NO DESCRIPTION PROVIDED

Parameters:

command

string

The command to be executed.

windowId

integer

⚠ NO DESCRIPTION PROVIDED

historyPrivate

Types

#TransitionType

ENUM

The transition type for this visit from its referrer.

link

typed

auto_bookmark

auto_subframe

manual_subframe

generated

auto_toplevel

form_submit

reload

keyword

keyword_generated

#TypedHistoryItem

An object containing informations of one typed history entry

Properties:

url

string

The URL navigated to by a user.

title

string

The title of the page when it was last loaded.

terms

string

The terms that the user searched for.

visitCount

integer

The number of times the user has navigated to this page.

#DetailedHistoryItem

An object encapsulating one result of a top url history query.

Properties:

id

string

The unique identifier for the item.

url

string

The URL navigated to by a user.

title

string

The title of the page when it was last loaded.

lastVisitTime

(optional)

number

When this page was last loaded, represented in milliseconds since the epoch.

visitCount

integer

The number of times the user has navigated to this page.

typedCount

(optional)

integer

The number of times the user has navigated to this page by typing in the address.

isBookmarked

boolean

States if the URL is bookmarked.

score

integer

The relavancy score given to the URL.

#HistoryPrivateItem

An object encapsulating one result of a history query. Properties marked with 'Used for statistics' can be removed if we make a new API function for stats.

Properties:

id

string

The unique identifier for the item.

url

string

The URL navigated to by a user.

address

string

Used for statistics. The address of the page navigated to by a user.

title

string

The title of the page when it was last loaded.

visitTime

number

When this page was visited, represented in milliseconds since the epoch.

transitionType

TransitionType

Used for statistics. The transition type for this visit from its referrer.

dateKey

string

Date string of the visit. Format: YYYY-MM-DD

#TopUrlItem

An object encapsulating one result of a top url history query.

Properties:

date

string

The date of the visit for the top url

url

string

The url visited

numberOfVisit

(optional)

integer

The visit count of the url.

Listeners

#onVisitModified

Fired when one or more URLs are removed from the history service. When all visits have been removed the URL is purged from history.

Parameters:

modified

object

⚠ NO DESCRIPTION PROVIDED

Object Properties:

urls

(optional)

⚠ NO DESCRIPTION PROVIDED

Array of:

• string

Methods

#deleteVisits

Deletes all visits of the given URL for a certain period.

Parameters:

details

object

⚠ NO DESCRIPTION PROVIDED

Object Properties:

url

string

The URL to remove.

time

number

The visit time of the item to remove, represented in milliseconds since the epoch. IMPORTANT: This must be the exact visit time, to the microsecond. If it is truncated, then the deletion will not be synced.

#getTopUrlsPerDay

Retrives top url per day. Sorted by number of visits within the day

Parameters:

maxTopUrlResults

number

The number of top urls to return per day.

#visitSearch

Retrives all visits. Sorted by visit time descending.

Parameters:

query

object

⚠ NO DESCRIPTION PROVIDED

Object Properties:

startTime

(optional)

number

Limit results to those visited after this date, represented in milliseconds since the epoch. If not specified, this defaults to 24 hours in the past.

endTime

(optional)

number

Limit results to those visited before this date, represented in milliseconds since the epoch.

#getTypedHistory

Retrieves a list of items used to populate the typed URL results of the address bar

Parameters:

query

string

A piece of text that the results should contain

maxResults

integer

The maximum number of items to return

#getDetailedHistory

Parameters:

query

string

A piece of text that the results should contain

maxResults

integer

The maximum number of items to return

#updateTopSites

Requests an update for top sites

importData

Types

#import_types

ENUM

⚠ NO DESCRIPTION PROVIDED

internet_explorer

firefox

safari

bookmarks_file

opera

chrome

chromium

vivaldi

yandex

opera_opium_beta

opera_opium_dev

brave

edge

edge_chromium

thunderbird

opera_opium

arc

opera_gx

unknown

#UserProfileItem

UserProfileItem. Contains info for userprofile

Properties:

profileDisplayName

string

The profile display name.

profileName

string

The profile name.

profilePath

(optional)

string

The profile path, if it is different than parent profile.

index

(optional)

integer

The user profile index, if it is different than parent profile.

#ProfileItem

ProfileItem.

Properties:

import_type

import_types

The type of import profile item

name

string

Import item name.

index

integer

The profile item index.

history

boolean

Does profile support history.

favorites

boolean

Does profile support favorites.

passwords

boolean

Does profile support passwords.

supportsMasterPassword

boolean

Does profile support a master password to decode passwords.

speeddial

boolean

Does profile support Speed Dial.

notes

boolean

Does profile support notes.

email

boolean

Does profile support email.

contacts

boolean

Does profile support contacts.

extensions

boolean

Does profile support extensions import.

hasDefaultInstall

boolean

Is a default installation detected.

detectedProfilePath

string

Is the path on disk to the detected profile.

requiresInteractiveImport

boolean

Does the profile require interactive (file/directory picker dialog) selection by the user.

requiresAccessPermission

boolean

Does the profile require explicit access permission to the profile folder/file.

suggestedProfilePath

string

Suggested default profile path for profile selection dialog.

dialogType

string

What type of dialog should be used for interactive import. Possible values are 'file' or 'folder'.

mailPath

string

The path on disk to the detected mail profile

UserProfiles

⚠ NO DESCRIPTION PROVIDED

Array of:

• UserProfileItem

Listeners

#onImportStarted

Fired when a import session has started.

#onImportEnded

Fired when a import session has ended.

Parameters:

error_count

integer

Number of data types that failed to import.

#onImportItemStarted

Fired when a import session for a data type has started.

Parameters:

item

string

Name of data type.

#onImportItemEnded

Fired when a import session for a data type has ended.

Parameters:

item

string

Name of data type.

#onImportItemFailed

Fired when a import session for a data type has failed.

Parameters:

item

string

Name of data type.

error

string

Error message that can be shown to the user.

Methods

#getProfiles

Retrieves import data profiles.

#startImport

Start import process.

Parameters:

profileIndex

integer

Index of the profile we want to import. This is a null based index of results from getProfiles.

askUserForFileLocation

boolean

Show file dialog to user.

profileName

string

Name of profile.

typesToImport

object

⚠ NO DESCRIPTION PROVIDED

Object Properties:

history

boolean

⚠ NO DESCRIPTION PROVIDED

favorites

boolean

⚠ NO DESCRIPTION PROVIDED

passwords

boolean

⚠ NO DESCRIPTION PROVIDED

speeddial

boolean

⚠ NO DESCRIPTION PROVIDED

notes

boolean

⚠ NO DESCRIPTION PROVIDED

extensions

boolean

⚠ NO DESCRIPTION PROVIDED

masterPassword

(optional)

string

⚠ NO DESCRIPTION PROVIDED

importPath

(optional)

string

⚠ NO DESCRIPTION PROVIDED

#openThunderbirdMailbox

Opens Thunderbird mailbox from disk and seek to seekPosition. If called with already opened file it only seeks to seekPosition. If called with a new path it closes the current file and opens the new one.

Parameters:

path

string

Path to mailbox.

seekPosition

(optional)

string

Seek to this position after opening, serialized as a string because V8's integer type is too small for large mbox files.

#closeThunderbirdMailbox

Closes currently open thunderbird mailbox, if any

#readMessageFromThunderbirdMailbox

Read one message from currently open Thunderbird mailbox.

infobars

Types

#ButtonAction

ENUM

⚠ NO DESCRIPTION PROVIDED

accept

cancel

link

dismiss

#InfobarButton

Button to be shown in the infobar.

Properties:

text

string

Text to be shown in the button.

action

ButtonAction

The action to be performed when clicking this button.

prominent

boolean

This is the prominent button and should receive styling accordingly.

#Infobar

Object passed to the onInfobarCreated event.

Properties:

tabId

integer

The tabId this infobar is associated with.

identifier

integer

The identifier used to identify this infobar. It is only unique in combination with |tabId|.

messageText

string

The message text to be shown in the infobar.

buttons

⚠ NO DESCRIPTION PROVIDED

Array of:

• InfobarButton

linkText

string

The text associated with a link to be shown in the infobar.

Listeners

#onInfobarCreated

Fired when a infobar has been created and should be shown.

Parameters:

params

Infobar

Information about the infobar.

#onInfobarRemoved

Fired when a infobar has been removed and should no longer be visible.

Parameters:

tabId

integer

The tabId this infobar is associated with.

identifier

integer

The identifier used to identify this infobar. It is only unique in combination with |tabId|.

Methods

#sendButtonAction

Send the action defined on the clicked button.

Parameters:

tabId

integer

The tabId this infobar is associated with.

identifier

integer

The identifier used to identify this infobar. It is only unique in combination with |tabId|.

action

string

The click action for this button. This must be the same as defined in the |InfoBarButton| type for this button.

mailPrivate

Types

#message

Message object. Used to create message in full text database table.

Properties:

searchListId

integer

⚠ NO DESCRIPTION PROVIDED

subject

string

The message subject.

body

string

The message body.

to

string

The message to address .

cc

string

The message cc address .

from

string

The message from address .

replyTo

string

The message reply address .

#migration

Migration object. Returns search db version and if migration of search db is needed.

Properties:

dbVersion

integer

The mail search db version.

migrationNeeded

boolean

If database migration is needed.

Listeners

#onUpgradeProgress

Reports import progress.

Parameters:

progress

integer

Number of rows upgraded.

total

integer

Total number of rows to be upgraded.

msg

string

Message to be printed out.

#onDeleteMessagesProgress

Reports progress when deleting messages.

Parameters:

delete_progress_count

integer

Number of messages deleted.

Methods

#getFilePaths

Returns array of file paths under a given directory.

Parameters:

path

string

The root folder from where to build up the file paths.

#getFullPath

Given a file entry, return full path of the file

Parameters:

filesystem

string

The file entry to be looked up

path

string

The path

#getMailFilePaths

Returns array of file paths under the default profile /Mail directory.

#writeTextToMessageFile

Saves a mail to disk. The root folder location is the profile directory of the current running instance /Mail

Parameters:

paths

String array that is used to create a folder structure, starting at user default profile /Mail The function returns error if empty

Array of:

• string

fileName

string

The file name to be created/saved/overridden.

raw

string

The raw mail content.

append

(optional)

boolean

Whether to append to file instead of write.

#writeBufferToMessageFile

Saves a mail to disk. The root folder location is the profile directory of the current running instance /Mail

Parameters:

paths

String array that is used to create a folder structure, starting at user default profile /Mail The function returns error if empty

Array of:

• string

fileName

string

The file name to be created/saved/overridden.

raw

binary

The raw mail content as arrayBuffer

append

(optional)

boolean

Whether to append to file instead of write.

#deleteMessageFile

Deletes a file. The root folder location is the profile directory of the current running instance /Mail

Parameters:

paths

String array that is used to build path to the file. Starting at user default profile/Mail.

Array of:

• string

fileName

string

The file name to be deleted. With ending.

#renameMessageFile

Renames a file. The root folder location is the profile directory of the current running instance /Mail

Parameters:

paths

String array that is used to build path to the file. Starting at user default profile/Mail.

Array of:

• string

fileName

string

The file name to be renamed.

newFileName

string

The new name for the file.

#readFileToBuffer

Reads the contents of a file. Returns the content as arrayBuffer

Parameters:

fileName

string

Absoloute path to the file to be read.

#readMessageFileToBuffer

Reads a mail. The root folder location is the profile directory of the current running instance /Mail

Parameters:

paths

String array that is used to build path to the file. Starting at user default profile/Mail.

Array of:

• string

fileName

string

The file name to be read.

#messageFileExists

Check if file exists.Returns true if the file exists.

Parameters:

paths

String array that is used to build path to the file. Starting at user default profile/Mail.

Array of:

• string

fileName

string

The file name to be checked.

#readFileToText

Reads a file. Returns the file content as text.

Parameters:

path

string

Absoulout path to the file to be read.

#getFileDirectory

Returns the user mail data directory and verfies that the directory exists.

Parameters:

hashedAccountId

string

First 6 characters from the MD5 hash of the accountId. Appended to the end of the default mail data directory

#createFileDirectory

Creates the user mail data directory.

Parameters:

hashedAccountId

string

First 6 characters from the MD5 hash of the accountId. Appended to the end of the default mail data directory

#createMessages

Creates messages for full text search.

Parameters:

messages

⚠ NO DESCRIPTION PROVIDED

Array of:

• message

#deleteMessages

Deletes messages from full text search.

Parameters:

messages

⚠ NO DESCRIPTION PROVIDED

Array of:

• integer

#updateMessage

Updates a message. All properties needs to be specified both new and previous ones.

Parameters:

message

message

⚠ NO DESCRIPTION PROVIDED

#searchMessages

Searches messages with certain query.

Parameters:

searchValue

string

The value to search for

#matchMessage

Does search value match certain message.

Parameters:

searchListId

integer

The searchListId of the message to be checked.

searchValue

string

The value to search for

#getDBVersion

Returns SQLite database version for MailDB.

#startMigration

Migrates the full text database index to contentless. Track progress in the listener: onUpgradeProgress. This can be slow.

#deleteMailSearchDB

Deletes MailSearchDB and MaildSearchDB-journal file. Re-creates the files afterwards. This action cannot be reverted.

menubar

Types

#Mode

ENUM

What part menubar to manipulate

all

update

tabs

#Edge

ENUM

Defines position of menu items added in chrome code wrt container items.

above

below

off

#ItemType

ENUM

What kind of item.

command

checkbox

radio

folder

container

separator

#MenuItem

One menu item.

Properties:

name

string

Text in item.

action

string

Action to execute.

id

integer

The unique id of item.

items

(optional)

Child menu items.

Array of:

• MenuItem

visible

(optional)

boolean

Whether this menu item is visible or not. Defaults to true.

type

(optional)

ItemType

'normal' or 'checkbox'. Defaults to 'normal'.

checked

(optional)

boolean

true if the checkbox is checked, otherwise false. Only applies for type='checkbox'.

enabled

(optional)

boolean

false if the item should appear as grayed out. Assumed true if not set.

withNoWindow

boolean

true if the item should remain normal when no windows are open. If false the item will be grayed out.

emphasized

(optional)

boolean

true if the item should appear in an emphasized style (typically bold).

shortcut

(optional)

string

String which illustrates a shortcut. The presence of a string will not execute menu action.

url

(optional)

string

Url that can be used to determine a corresponding icon.

parameter

(optional)

string

Parameter to command. Sent back unaltered.

index

(optional)

integer

Index in menu list. Can only be used insert into an existing list.

edge

(optional)

Edge

Where to place extra menu items

icon

(optional)

string

Icon in PNG format encoded as base64.

Listeners

#onActivated

Fired when a main menu item is activated.

Parameters:

window

integer

id of window where command occurred.

action

string

Action to execute.

parameter

string

Free format parameter to 'command'. Can be empty.

Methods

#getHasWindows

Returns true if there is one or more windows present in any profile.

#setup

Setup application's main menu.

Parameters:

items

Menu items with string label.

Array of:

• MenuItem

menubarMenu

Types

#ContainerType

ENUM

Defines content of a container.

bookmarks

history

#SortOrder

ENUM

Defines how to sort container items.

ascending

descending

#SortField

ENUM

Defines what element to use as sort key.

title

url

nickname

description

dateAdded

#Edge

ENUM

Defines position of menu items added in chrome code wrt container items.

above

below

off

#ItemType

ENUM

What kind of item.

command

checkbox

radio

folder

#Rect

Position and size of element in menu bar.

Properties:

x

integer

Left position of item that opens menu, screen coordinates.

y

integer

Top position of item that opens menu, screen coordinates.

width

integer

Width of item that opens menu.

height

integer

Height of item that opens menu.

#Icons

Icons

Icons encoded as base64.

Array of:

• string

#Item

One menu item.

Properties:

id

integer

The unique id of item.

name

string

Text in item.

type

ItemType

Defaults to 'normal'.

selected

(optional)

boolean

Whether item is initially selected. Default to false.

enabled

(optional)

boolean

Whether item is enabled or not (grayed out) . Defaults to true.

visible

(optional)

boolean

Whether item is visible or not. Defaults to true.

checked

(optional)

boolean

true if the checkbox is checked. Ignored unless type is 'checkbox' or 'radiobutton'.

radiogroup

(optional)

integer

The radiobutton group this item belongs to. Must be present for a radio button.

persistent

(optional)

boolean

If true the menu item will remain open after menu item is clicked with mouse.

shortcut

(optional)

string

Shortcut to be displayed next to label.

url

(optional)

string

Url that can be used to determine a corresponding icon.

icons

(optional)

Icons

Icons for light and dark menus. There must be two icons and the last shall be for menus with a dark background.

#Separator

One separator

Properties:

label

(optional)

string

Text in item.

#Container

A collection of items set up and expanded from chrome.

Properties:

id

string

Parent id of data to display.

type

ContainerType

What kind of data to expand in this container.

offset

integer

Offset into folder/parent data.

groupFolders

boolean

If sorted, this flag will group any subfolders together.

edge

Edge

Where to place extra menu items

sortField

(optional)

SortField

Sort key for elements.

sortOrder

(optional)

SortOrder

Sort order for elements.

#Element

One element in menu. All optional, but one and only one of 'item', 'separator' or 'container' should be set. 'children' is only considered when 'item' is set.

Properties:

item

(optional)

Item

⚠ NO DESCRIPTION PROVIDED

separator

(optional)

Separator

⚠ NO DESCRIPTION PROVIDED

container

(optional)

Container

⚠ NO DESCRIPTION PROVIDED

children

(optional)

Child menu items.

Array of:

• Element

#Menu

One menu with origin rect and a list if children.

Properties:

id

integer

⚠ NO DESCRIPTION PROVIDED

rect

Rect

⚠ NO DESCRIPTION PROVIDED

children

⚠ NO DESCRIPTION PROVIDED

Array of:

• Element

#EventState

Describes keyboard modifiers and mouse button state.

Properties:

ctrl

boolean

true if the Ctrl key is pressed when activating the menu.

shift

boolean

true if the Shift key is pressed when activating the menu.

alt

boolean

true if the Alt key is pressed when activating the menu.

command

boolean

true if the Command key (Mac) is pressed when activating the menu.

left

boolean

true if the left mouse button activated the menu.

right

boolean

true if the right mouse button activated the menu.

center

boolean

true if the center mouse button activated the menu.

#Disposition

ENUM

Defines where a bookmark should be opened.

setting

current

new-tab

new-window

new-private-window

#BookmarkCommand

ENUM

Defines a non-navigation bookmark action.

edit

addactivetab

addfolder

addbookmark

addseparator

cut

copy

paste

#BookmarkAction

Passed with bookmark activation

Properties:

id

string

⚠ NO DESCRIPTION PROVIDED

command

BookmarkCommand

If set, disposition and background is ignored.

disposition

Disposition

⚠ NO DESCRIPTION PROVIDED

background

boolean

Extends disposition with a background option.

state

EventState

⚠ NO DESCRIPTION PROVIDED

#Action

Passed with menu activation.

Properties:

id

integer

Command id.

state

EventState

⚠ NO DESCRIPTION PROVIDED

Listeners

#onOpen

Fires before menu opens.

Parameters:

id

integer

Menu id of the menu that opens.

#onClose

Fires before menu closes.

#onAction

Fired when menu item is activated.

Parameters:

action

Action

What action to execute.

#onOpenBookmark

Fired when bookmark menu item is activated.

Parameters:

windowId

integer

Window where action occurs.

action

BookmarkAction

⚠ NO DESCRIPTION PROVIDED

#onBookmarkAction

Fired when bookmark command is activated.

Parameters:

windowId

integer

Window where action occurs.

action

BookmarkAction

⚠ NO DESCRIPTION PROVIDED

#onHover

Fired when a menu item with a url is highlighted.

Parameters:

windowId

integer

Window where hover occurs.

url

string

Url in menu item.

#onError

Fired if an error condtion occurs that can not be routed with a callback.

Parameters:

text

string

Error message for logging purposes.

Methods

#show

Shows a context menu.

Parameters:

properties

object

⚠ NO DESCRIPTION PROVIDED

Object Properties:

windowId

integer

⚠ NO DESCRIPTION PROVIDED

id

integer

Id of the menu in the 'siblings' list to open.

siblings

List of menu entries.

Array of:

• Menu

icons

Icons

Default and folder icons.

#getMaxId

Returns the maximium id (elements) a menu can use.

menuContent

Types

#NodeType

ENUM

Defines supported nodes

menu

command

checkbox

radio

folder

separator

container

#Role

ENUM

Defines menu type.

horizontal

vertical

mac

context

#ContainerMode

ENUM

Defines container layouts.

inline

folder

#ContainerEdge

ENUM

Defines on what edge of a container additional items can be added.

above

below

off

#MenuTreeNode

A node (folder or menu entry) in the menu tree. Child nodes are ordered within their parent folder.

Properties:

id

string

Unique identifier.

type

NodeType

The kind of node.

action

string

A command or a menu identifier. It does not have to be unique. Can be empty for separators.

custom

(optional)

boolean

When true, the item has been added by the user.

title

(optional)

string

Node title. If not present the title is determined using the action.

showshortcut

(optional)

boolean

Show shortcut string.

radiogroup

(optional)

string

Mandatory for radio elements.

containermode

(optional)

ContainerMode

Mandatory for container elements.

containeredge

(optional)

ContainerEdge

Mandatory for container elements.

parameter

(optional)

string

Free form parameter. Format varies with action.

children

(optional)

An ordered list of children of this node.

Array of:

• MenuTreeNode

Listeners

#onChanged

Fires when the content of a menu has changed.

Parameters:

menu

string

Menu resource name.

id

string

Unique identifier for menu.

role

Role

Describes the role of menu.

selectId

string

If non-negative this id can be used to set selected element.

items

⚠ NO DESCRIPTION PROVIDED

Array of:

• MenuTreeNode

Methods

#get

Retrieves content of a menu.

Parameters:

menu

string

Menu resource name.

#move

Moves one or more items within a menu.

Parameters:

menu

string

Menu resource name.

ids

⚠ NO DESCRIPTION PROVIDED

Array of:

• string

parentId

string

⚠ NO DESCRIPTION PROVIDED

index

integer

⚠ NO DESCRIPTION PROVIDED

#create

Add one or more items within a menu.

Parameters:

menu

string

Menu resource name.

parentId

string

⚠ NO DESCRIPTION PROVIDED

index

integer

Where to add elements. A negative value means at end.

items

⚠ NO DESCRIPTION PROVIDED

Array of:

• MenuTreeNode

#remove

Deletes one or more items within a menu.

Parameters:

menu

string

Menu resource name.

ids

⚠ NO DESCRIPTION PROVIDED

Array of:

• string

#removeAction

Deletes one or more actions from all models

Parameters:

actions

⚠ NO DESCRIPTION PROVIDED

Array of:

• string

#update

Updates the properties of a node.

Parameters:

menu

string

Menu resource name.

id

string

⚠ NO DESCRIPTION PROVIDED

changes

object

⚠ NO DESCRIPTION PROVIDED

Object Properties:

title

(optional)

string

⚠ NO DESCRIPTION PROVIDED

parameter

(optional)

string

⚠ NO DESCRIPTION PROVIDED

showshortcut

(optional)

boolean

⚠ NO DESCRIPTION PROVIDED

containerMode

(optional)

ContainerMode

⚠ NO DESCRIPTION PROVIDED

containerEdge

(optional)

ContainerEdge

⚠ NO DESCRIPTION PROVIDED

#reset

Restores default content within a menu or in a submenu of that menu.

Parameters:

menu

string

Menu resource name.

isContext

boolean

⚠ NO DESCRIPTION PROVIDED

ids

(optional)

⚠ NO DESCRIPTION PROVIDED

Array of:

• string

mousegestures

notes

Types

#NodeType

ENUM

The kind of the node.

note: A regular note. May have attachments as children.

separator: A separator

attachment: An attachment. Content is the attachment checksum.

folder: A folder. May have notes and separators as children.

main: The main notes folder.

other: The other notes folder.

trash: The trash.

#NoteTreeNode

A node (either a note-entry or a folder) in the notes tree. Child nodes are ordered within their parent folder.

Properties:

id

string

The unique identifier for the node. IDs are unique within the current profile, and they remain valid even after the browser is restarted.

parentId

(optional)

string

The id of the parent folder. Omitted for the root node.

index

(optional)

integer

The 0-based position of this node within its parent folder. Omitted for the root node.

title

string

Title/subject of note.

content

(optional)

string

The content of the note. Omitted for separators and folders. For attachments, this contains the attachment checksum.

url

(optional)

string

A URL associated with the note. Omitted for separators and folders.

dateAdded

(optional)

number

When this node was created, in milliseconds since the epoch (new Date(dateAdded)).

dateModified

(optional)

number

When this node was last modified, in milliseconds since the epoch (new Date(dateModified)).

children

(optional)

An ordered list of children of this node. Only present for folders

Array of:

• NoteTreeNode

type

NodeType

Which kind of node this is.

#CreateDetails

Object passed to the create() function.

Properties:

parentId

(optional)

string

Defaults to the root folder.

index

(optional)

integer

⚠ NO DESCRIPTION PROVIDED

type

NodeType

⚠ NO DESCRIPTION PROVIDED

title

(optional)

string

⚠ NO DESCRIPTION PROVIDED

url

(optional)

string

⚠ NO DESCRIPTION PROVIDED

content

(optional)

string

The content of the node. For attachments, this is either a known attachment checksum copied from another attachment or a new base64-encoded attachment content

date

(optional)

number

A timestamp of the node's creation.

lastmod

(optional)

number

A timestamp of the node's last modification date.

Listeners

#onCreated

Fired when a bookmark or folder is created.

Parameters:

id

string

⚠ NO DESCRIPTION PROVIDED

note

NoteTreeNode

⚠ NO DESCRIPTION PROVIDED

#onRemoved

Fired when a note or folder is removed. When a folder is removed recursively, a single notification is fired for the folder, and none for its contents.

Parameters:

id

string

⚠ NO DESCRIPTION PROVIDED

removeInfo

object

⚠ NO DESCRIPTION PROVIDED

Object Properties:

parentId

string

⚠ NO DESCRIPTION PROVIDED

index

integer

⚠ NO DESCRIPTION PROVIDED

#onChanged

Fired when a note or folder changes.

Parameters:

id

string

⚠ NO DESCRIPTION PROVIDED

noteAfterChange

object

⚠ NO DESCRIPTION PROVIDED

Object Properties:

title

string

⚠ NO DESCRIPTION PROVIDED

content

(optional)

string

⚠ NO DESCRIPTION PROVIDED

url

(optional)

string

⚠ NO DESCRIPTION PROVIDED

dateModified

(optional)

number

⚠ NO DESCRIPTION PROVIDED

#onMoved

Fired when a note or folder is moved.

Parameters:

id

string

The id of the moved note

moveInfo

object

⚠ NO DESCRIPTION PROVIDED

Object Properties:

parentId

string

The id of the parent folder

index

integer

The index inside the parent folder

oldParentId

string

Previous parent id

oldIndex

integer

Previous index inside the parent folder

#onImportBegan

Fired when a notes import session is begun. Expensive observers should ignore onCreated updates until onImportEnded is fired. Observers should still handle other notifications immediately.

#onImportEnded

Fired when a notes import session is ended.

Methods

#get

Retrieves the specified NoteTreeNode(s).

Parameters:

idOrIdList (overloaded)

string

⚠ NO DESCRIPTION PROVIDED

idOrIdList (overloaded)

⚠ NO DESCRIPTION PROVIDED

Array of:

• string
• int64Minimum items: 1

#getTree

Retrieves the entire Notes hierarchy.

#create

Creates a bookmark or folder under the specified parentId.

Parameters:

note

CreateDetails

⚠ NO DESCRIPTION PROVIDED

#update

Updates the properties of a note or folder. Specify only the properties that you want to change; unspecified properties will be left unchanged. Note: Currently, only 'title' and 'url' are supported.

Parameters:

id

string

⚠ NO DESCRIPTION PROVIDED

changes

object

⚠ NO DESCRIPTION PROVIDED

Object Properties:

title

(optional)

string

⚠ NO DESCRIPTION PROVIDED

content

(optional)

string

⚠ NO DESCRIPTION PROVIDED

url

(optional)

string

⚠ NO DESCRIPTION PROVIDED

#remove

Removes a note or an empty folder.

Parameters:

id

string

⚠ NO DESCRIPTION PROVIDED

#search

Parameters:

query

string

A string of words matched agains note contents.

#move

Moves the specified node to the provided location.

Parameters:

id

string

The id to be moved

destination

object

Object describing the target location

Object Properties:

parentId

(optional)

string

Id of target folder

index

(optional)

integer

The index inside the target folder

#emptyTrash

Empty the notes trash folder.

#beginImport

Signal that import has been started.

#endImport

Signal that import has been finished.

pageActions

Types

#ScriptOverride

ENUM

Whether a script should be always enabled or disabled.

no_override

enabled

disabled

#OverridenScript

Used to report that a script is always enabled or disabled

Properties:

script

string

⚠ NO DESCRIPTION PROVIDED

override

ScriptOverride

⚠ NO DESCRIPTION PROVIDED

Listeners

#onScriptsChanged

Fired when new scripts have been found in a page action directory or when some scripts were modified or deleted

#onOverridesChanged

Fired when something (usually a call to setScriptOverrideForTab) caused script overrides to change

Parameters:

tab_id

integer

⚠ NO DESCRIPTION PROVIDED

Methods

#getScripts

Returns the full path to all known page action scripts.

#setScriptOverrideForTab

Permanently enables or disables a script for a given tab, or cancels the override

Parameters:

script

string

⚠ NO DESCRIPTION PROVIDED

tab_id

integer

⚠ NO DESCRIPTION PROVIDED

override

ScriptOverride

⚠ NO DESCRIPTION PROVIDED

#getScriptOverridesForTab

Get which scripts have been permanently enabled or disabled for a given tab

Parameters:

tab_id

integer

⚠ NO DESCRIPTION PROVIDED

pipPrivate

Listeners

#onVideoElementCreated

Fired when a video element has been created.

Parameters:

tabId

integer

Tab id for the video element created event.

prefs

Types

#PreferenceValue

Preference with its new desired value.

Properties:

path

string

The preference path

value

(optional)

any

Preference value. None indicate to use the default.

#TranslateLanguageSettings

Current settings active for the given language pair or just the source language.

Properties:

isLanguagePairOnAlwaysTranslateList

boolean

Is the given language pair on the always translate list.

isLanguageInNeverTranslateList

boolean

Is the given language source language on the never translate list.

isSiteOnNeverTranslateList

boolean

Is the given site on the never translate list.

shouldShowAlwaysTranslateShortcut

boolean

Should show always translate shortcut for this language.

shouldShowNeverTranslateShortcut

boolean

Should show never translate shortcut for this language.

Listeners

#onChanged

Fired when a preference value has changed.

Parameters:

newValue

PreferenceValue

Information about the changed preference.

Methods

#get

Get a specific named preference value.

Parameters:

path

string

The preference path

#set

Set a specific preference.

Parameters:

newValue

PreferenceValue

⚠ NO DESCRIPTION PROVIDED

#getForCache

Get all preferences to be cached on the JS side with one call. Only changes to these will be reported by onChanged. The result type is optimized for bulk transfer of over 450 values

Parameters:

paths

Which preferences are needed

Array of:

• string

#setLanguagePairToAlwaysTranslate

Translate: Add or remove a pair of languages to the preference for automatic translation.

Parameters:

tabId

integer

The tab id used to look up the translate manager stored in the WebContents data. Not used for anything else.

enable

boolean

true to add the language pair to the list, false to remove it from the list.

original_language

string

Original language to translate from.

target_language

string

Target language to translate to.

#setLanguageToNeverTranslate

Translate: Add or remove a pair of languages to the preference for never doing automatic translation.

Parameters:

tabId

integer

The tab id used to look up the translate manager stored in the WebContents data. Not used for anything else.

block

boolean

true to add the language to the blocked list, false to remove it from the list.

original_language

string

Original language to never translate from.

target_language

string

Target language to never translate to.

#setSiteToNeverTranslate

Translate: Add or remove a site to the preference for never doing automatic translation.

Parameters:

tabId

integer

The tab id used to look up the translate manager stored in the WebContents data and the site to block.

block

boolean

true to add the language to the blocked list, false to remove it from the list.

original_language

string

Original language to never translate from.

target_language

string

Target language to never translate to.

#getTranslateSettings

Translate: Get settings for the given language pair.

Parameters:

tabId

integer

The tab id used to look up the translate manager stored in the WebContents data. Not used for anything else.

original_language

string

Original language to never translate from.

target_language

string

Target language to never translate to.

#setTranslationDeclined

Translate: Translation dialog was closed without being used, record that fact.

Parameters:

tabId

integer

The tab id used to look up the translate manager stored in the WebContents data. Not used for anything else.

explicitly_closed

boolean

true if the dialog was closed explicitly (from close button), otherwise false if it was closed from clicking outside it or similar.

original_language

string

Original language of the page.

target_language

string

Target language selected.

#resetTranslationPrefs

Translate: Resets the translation preferences to defaults.

api['name']

⚠ WARNING! Failed to get info as type not provided

readingListPrivate

Types

#ReadingListEntry

Object passed to the update and returned in the get function.

Properties:

url

string

The url of the entry. This is also the unique key.

title

string

The title of the entry.

read

boolean

Has entry been read.

lastUpdate

number

Last updated in micro seconds since Jan 1st 1970.

Listeners

#onModelChanged

Fired when the reading list data model has changed.

Methods

#add

Add a new entry to the reading list.

Parameters:

url

string

The url of the entry. This is also the unique key. Only http/https urls are supported.

title

string

The title of the entry.

#remove

Remove an entry from the reading list.

Parameters:

url

string

The url of the entry.

#getAll

Returns all reading list entries.

#setReadStatus

Sets the read status on a url.

Parameters:

url

string

url to set read status on.

read

boolean

true for read, false for unread.

runtimePrivate

Types

#FeatureFlagInfo

Object returned from the getAllFeatureFlags function.

Properties:

name

string

Name of this feature flag. This is the key used to look up the name.

friendlyName

string

This is the normalized name of this feature flag suitable to be showed to the user.

description

string

Description of this feature flag.

value

boolean

The current value for this flag (true or false).

locked

boolean

Locked from being changed. If true, it cannot be changed as it's locked from command line.

#UserProfile

Object returned from the getUserProfiles function.

Properties:

name

string

Name of this user profile. For a guest profile, this should be ignored and translated string used instead.

active

boolean

true if this is the active profile, otherwise false.

path

string

Path of this user profile. This is used when opening and deleting profiles as it's unique.

image

string

base64 encoded data url with the image to use for this profile. Empty for Guest profile.

imageIndex

integer

The index into our array of default images this user is using. Corrensponds to |UserProfileImage| index value. Not valid for guest profiles.

guest

boolean

true if this is the guest profile, otherwise false.

customAvatar

string

Link to a HTTP-loadble custom avatar, if available.

#UserProfileImage

Object returned from the |getUserProfileImages|.