chrome_ext library

A library to expose the Chrome ext APIs.

Classes

AbortRequestedOptions
Options for the onAbortRequested event.
AccountInfo
Action
Information about an action for an entry.
ActionsCallback
AddRequestCookie
Adds a cookie to the request or overrides a cookie, in case another cookie of the same name exists already. Note that it is preferred to use the Cookies API because this is computationally less expensive.
AddRequestCookieInstanceType
AddResponseCookie
Adds a cookie to the response or overrides a cookie, in case another cookie of the same name exists already. Note that it is preferred to use the Cookies API because this is computationally less expensive.
AddResponseCookieInstanceType
AddResponseHeader
Adds the response header to the response of this web request. As multiple response headers may share the same name, you need to first remove and then add a new response header in order to replace one.
AddResponseHeaderInstanceType
AddWatcherRequestedOptions
Options for the onAddWatcherRequested event.
Alarm
AlarmCreateInfo
todo(mpcomplete): rename to CreateInfo when http://crbug.com/123073 is fixed.
ArrayBuffer
AuthCredentialsWebRequest
AuthenticationResult
Argument to finishAuthentication indicating the result of the captive portal authentication attempt.
BlockingResponse
Returns value for event handlers that have the 'blocking' extraInfoSpec applied. Allows the event handler to modify network requests.
BookmarksMoveParams
BookmarksOnChangedEvent
Fired when a bookmark or folder changes. Note: Currently, only title and url changes trigger this.
BookmarksOnMovedEvent
Fired when a bookmark or folder is moved to a different parent folder.
BookmarksOnRemovedEvent
Fired when a bookmark or folder is removed. When a folder is removed recursively, a single notification is fired for the folder, and none for its contents.
BookmarksUpdateParams
BookmarkTreeNode
A node (either a bookmark or a folder) in the bookmark tree. Child nodes are ordered within their parent folder.
BookmarkTreeNodeUnmodifiable
Indicates the reason why this node is unmodifiable. The managed value indicates that this node was configured by the system administrator. Omitted if the node can be modified by the user and the extension (default).
BooleanDelta
Bounds
BrowserActionGetBadgeBackgroundColorParams
BrowserActionGetBadgeTextParams
BrowserActionGetPopupParams
BrowserActionGetTitleParams
BrowserActionImageDataType
Pixel data for an image. Must be an ImageData object (for example, from a canvas element).
BrowserActionSetBadgeBackgroundColorParams
BrowserActionSetBadgeTextParams
BrowserActionSetIconParams
BrowserActionSetPopupParams
BrowserActionSetTitleParams
Button
A button created by the extension.
Cache
The Cache object contains information about the size and utilization of a cache used by the browser.
CallbackStyle
CameraContentSetting
CancelRequest
Declarative event action that cancels a network request.
CancelRequestInstanceType
CapabilitiesCallback
CaptureInfo
CaptureOptions
Whether we are requesting tab video and/or audio and the MediaTrackConstraints that should be set for these streams.
CertificateInfo
CertificatesCallback
ChallengerWebRequest
Change
Information about a change happened to an entry within the observed directory (including the entry itself).
ChangeType
Type of a change detected on the observed directory.
ChromeAlarms
ChromeApi
A common super class for the Chrome APIs.
ChromeBookmarks
ChromeBrowserAction
ChromeBrowsingData
ChromeCertificateProvider
ChromeCommands
ChromeContentSettings
ChromeContextMenus
ChromeCookies
ChromeDebugger
ChromeDeclarativeContent
ChromeDeclarativeWebRequest
ChromeDesktopCapture
ChromeDevtools
ChromeDevtoolsInspectedWindow
Use the chrome.devtools.inspectedWindow API to interact with the inspected window: obtain the tab ID for the inspected page, evaluate the code in the context of the inspected window, reload the page, or obtain the list of resources within the page.
ChromeDevtoolsNetwork
Use the chrome.devtools.network API to retrieve the information about network requests displayed by the Developer Tools in the Network panel.
ChromeDevtoolsPanels
Use the chrome.devtools.panels API to integrate your extension into Developer Tools window UI: create your own panels, access existing panels, and add sidebars.
ChromeDocumentScan
ChromeDownloads
ChromeEnterprise
ChromeEnterpriseDeviceAttributes
Use the chrome.enterprise.deviceAttributes API to read device attributes. Note: This API is only available to extensions force-installed by enterprise policy.
ChromeEnterprisePlatformKeys
Use the chrome.enterprise.platformKeys API to generate hardware-backed keys and to install certificates for these keys. The certificates will be managed by the platform and can be used for TLS authentication, network access or by other extension through $(ref:platformKeys chrome.platformKeys).
ChromeEnum
The abstract superclass of Chrome enums.
ChromeEvent
An object which allows the addition and removal of listeners for a Chrome event.
ChromeEvents
ChromeExtension
ChromeExtensionTypes
ChromeFileBrowserHandler
ChromeFileSystemProvider
ChromeFontSettings
ChromeGcm
ChromeHistory
ChromeI18N
ChromeIdentity
ChromeIdle
ChromeInput
ChromeInputIme
Use the chrome.input.ime API to implement a custom IME for Chrome OS. This allows your extension to handle keystrokes, set the composition, and manage the candidate window.
ChromeInstanceID
ChromeLocation
ChromeManagement
ChromeNetworking
ChromeNetworkingConfig
Use the networking.config API to authenticate to captive portals.
ChromeNotifications
ChromeObject
The abstract superclass of objects that can hold JsObject proxies.
ChromeOmnibox
ChromePageAction
ChromePageCapture
ChromePermissions
ChromePlatformKeys
ChromePower
ChromePrinterProvider
ChromePrivacy
ChromeProcesses
ChromeProxy
ChromeRuntime
ChromeSessions
ChromeSetting
An interface that allows access to a Chrome browser setting. See accessibilityFeatures for an example.
ChromeSettingScope
The scope of the ChromeSetting. One of
ChromeSignedInDevices
ChromeStorage
ChromeSystem
ChromeSystemCpu
Use the system.cpu API to query CPU metadata.
ChromeSystemDisplay
Use the system.display API to query display metadata.
ChromeSystemMemory
The chrome.system.memory API.
ChromeSystemNetwork
Use the chrome.system.network API.
ChromeSystemStorage
Use the chrome.system.storage API to query storage device information and be notified when a removable storage device is attached and detached.
ChromeTabCapture
ChromeTabs
ChromeTopSites
ChromeTts
ChromeTtsEngine
ChromeTypes
ChromeVpnProvider
ChromeWallpaper
ChromeWebNavigation
ChromeWebRequest
ChromeWindows
ClientCertificateRequest
Analogous to TLS1.1's CertificateRequest. See http://tools.ietf.org/html/rfc4346#section-7.4.4 .
ClientCertificateType
CloseFileRequestedOptions
Options for the onCloseFileRequested event.
ColorArray
Command
CommonActionId
List of common actions. "SHARE" is for sharing files with others. "SAVE_FOR_OFFLINE" for pinning (saving for offline access). "OFFLINE_NOT_NECESSARY" for notifying that the file doesn't need to be stored for offline access anymore. Used by onGetActionsRequested and onExecuteActionRequested.
ConfigureRequestedOptions
Options for the onConfigureRequested event.
ContentSetting
ContentSettingsClearParams
ContentSettingsGetParams
ContentSettingsSetParams
ContextMenusCreateParams
ContextMenusUpdateParams
ContextType
The different contexts a menu can appear in. Specifying 'all' is equivalent to the combination of all other contexts except for 'launcher'. The 'launcher' context is only supported by apps and is used to add menu items to the context menu that appears when clicking on the app icon in the launcher/taskbar/dock/etc. Different platforms might put limitations on what is actually supported in a launcher context menu.
Represents information about an HTTP cookie.
CookiesContentSetting
CookiesGetAllParams
CookiesGetParams
CookiesRemoveParams
CookiesSetParams
CookieStore
Represents a cookie store in the browser. An incognito mode window, for instance, uses a separate cookie store from a non-incognito window.
Coordinates
Coordinates part of the Location object.
CopyEntryRequestedOptions
Options for the onCopyEntryRequested event.
CpuInfo
CpuTime
Counters for assessing CPU utilization. Each field is monotonically increasing while the processor is powered on. Values are in milliseconds.
CreateDetails
Object passed to the create() function.
CreateDirectoryRequestedOptions
Options for the onCreateDirectoryRequested event.
CreateFileRequestedOptions
Options for the onCreateFileRequested event.
CreateType
Specifies what type of browser window to create. 'panel' is deprecated and only available to existing whitelisted extensions on Chrome OS.
CreateWindowOptions
The options to create an IME window
CSSOrigin
The origin of injected CSS.
DangerType
file
The download's filename is suspicious.
url
The download's URL is known to be malicious.
content
The downloaded file is known to be malicious.
uncommon
The download's URL is not commonly downloaded and could be dangerous.
host
The download came from a host known to distribute malicious binaries and is likely dangerous.
unwanted
The download is potentially unwanted or unsafe. E.g. it could make changes to browser or computer settings.
safe
The download presents no known danger to the user's computer.
accepted
The user has accepted the dangerous download.
DataTypeSet
A set of data types. Missing data types are interpreted as false.
Date
Debuggee
Debuggee identifier. Either tabId or extensionId must be specified
DeclarativeContentImageDataType
See https://developer.mozilla.org/en-US/docs/Web/API/ImageData.
DefaultSuggestResult
A suggest result.
DeleteEntryRequestedOptions
Options for the onDeleteEntryRequested event.
DescriptionStyleType
The style type.
DesktopCaptureSourceType
Enum used to define set of desktop media sources used in chooseDesktopMedia().
DetachReason
Connection termination reason.
Device
DeviceCallback
DeviceInfo
DeviceType
DevtoolsInspectedWindowEvalParams
DevtoolsInspectedWindowReloadParams
DisplayLayout
DisplayMode
DisplayProperties
DisplayUnitInfo
DoubleDelta
DownloadDelta
Encapsulates a change in a DownloadItem.
DownloadItem
The state of the process of downloading a file.
DownloadOptions
DownloadQuery
EditRequestCookie
Edits one or more cookies of request. Note that it is preferred to use the Cookies API because this is computationally less expensive.
EditRequestCookieInstanceType
EditResponseCookie
Edits one or more cookies of response. Note that it is preferred to use the Cookies API because this is computationally less expensive.
EditResponseCookieInstanceType
EjectDeviceResultCode
ElementsPanel
Represents the Elements panel.
EntriesCallback
EntryMetadata
Represents metadata of a file or a directory.
EvalResult
The return type for eval.
EventType
ExecuteActionRequestedOptions
Options for the onExecuteActionRequested event.
ExtensionDisabledReason
A reason the item is disabled.
ExtensionGetViewsParams
ExtensionInfo
Information about an installed extension, app, or theme.
ExtensionInstallType
How the extension was installed. One of
admin: The extension was installed because of an administrative policy,
development: The extension was loaded unpacked in developer mode,
normal: The extension was installed normally via a .crx file,
sideload: The extension was installed by other software on the machine,
other: The extension was installed by other means.
ExtensionPanel
Represents a panel created by extension.
ExtensionSidebarPane
A sidebar created by the extension.
ExtensionType
The type of this extension, app, or theme.
FileBrowserHandlerSelectFileParams
FileDataCallback
FileHandlerExecuteEventDetails
Event details payload for fileBrowserHandler.onExecute event.
FilenameConflictAction
uniquify
To avoid duplication, the `filename` is changed to include a counter before the filename extension.
overwrite
The existing file will be overwritten with the new file.
prompt
The user will be prompted with a file chooser dialog.
FilenameSuggestion
FileSystemInfo
Represents a mounted file system.
Filter
FilterResponseCookie
A filter of a cookie in HTTP Responses.
FontName
Represents a font name.
FontSettingsClearDefaultFixedFontSizeParams
FontSettingsClearDefaultFontSizeParams
FontSettingsClearFontParams
FontSettingsClearMinimumFontSizeParams
FontSettingsGetDefaultFixedFontSizeParams
FontSettingsGetDefaultFontSizeParams
FontSettingsGetFontParams
FontSettingsGetMinimumFontSizeParams
FontSettingsSetDefaultFixedFontSizeParams
FontSettingsSetDefaultFontSizeParams
FontSettingsSetFontParams
FontSettingsSetMinimumFontSizeParams
FormDataItem
Contains data passed within form data. For urlencoded form it is stored as string if data is utf-8 string and as ArrayBuffer otherwise. For form-data it is ArrayBuffer. If form-data represents uploading file, it is string with filename, if the filename is provided.
FullscreenContentSetting
GcmSendParams
GenericFamily
A CSS generic font family.
GetActionsRequestedOptions
Options for the onGetActionsRequested event.
GetFileIconOptions
GetInfoFlags
GetKeyPairResult
The return type for getKeyPair.
GetMetadataRequestedOptions
Options for the onGetMetadataRequested event.
GetRequestContentResult
The return type for getContent.
GetResourceContentResult
The return type for getContent.
Hash
HeaderFilter
Filters request headers for various criteria. Multiple criteria are evaluated as a conjunction.
HeaderNameValuePair
HistoryAddUrlParams
HistoryDeleteRangeParams
HistoryDeleteUrlParams
HistoryGetVisitsParams
HistoryItem
An object encapsulating one result of a history query.
HistorySearchParams
HistoryTransitionType
The transition type for this visit from its referrer.
HttpHeaders
An array of HTTP headers. Each header is represented as a dictionary containing the keys name and either value or binaryValue.
HttpMethod
IconInfo
Information about an icon belonging to an extension, app, or theme.
IdleState
IgnoreRules
Masks all rules that match the specified criteria.
IgnoreRulesInstanceType
ImageDetails
Details about the format and quality of an image.
ImageFormat
The format of an image.
ImagesContentSetting
InjectDetails
Details of the script or CSS to inject. Either the code or the file property must be set, but both may not be set at the same time.
InputContext
Describes an input Context
InputContextType
Type of value this text field edits, (Text, Number, URL, etc)
InputImeClearCompositionParams
InputImeCommitTextParams
InputImeDeleteSurroundingTextParams
InputImeSendKeyEventsParams
InputImeSetCandidatesParams
InputImeSetCandidateWindowPropertiesParams
InputImeSetCompositionParams
InputImeSetCursorPositionParams
InputImeSetMenuItemsParams
InputImeUpdateMenuItemsParams
InputWindowType
The IME window types.
Insets
InstanceIDDeleteTokenParams
InstanceIDGetTokenParams
InterruptReason
InvalidTokenDetails
IPHandlingPolicy
The IP handling policy of WebRTC.
ItemType
The type of menu item.
JavascriptContentSetting
KeyboardEvent
See http://www.w3.org/TR/DOM-Level-3-Events/#events-KeyboardEvent
KeyboardEventType
LanguageCode
An ISO language code such as en or fr. For a complete list of languages supported by this method, see kLanguageInfoTable. For an unknown language, und will be returned, which means that percentage of the text is unknown to CLD
LastErrorExtension
LastErrorRuntime
LaunchType
These are all possible app launch types.
LayoutPosition
Layout position, i.e. edge of parent that the display is attached to.
Level
LevelOfControl
One of
not_controllable: cannot be controlled by any extension
controlled_by_other_extensions: controlled by extensions with higher precedence
controllable_by_this_extension: can be controlled by this extension
controlled_by_this_extension: controlled by this extension
LocalMediaStream
LocalStorageArea
Location
Parameter of onLocationUpdate event's listener.
LocationContentSetting
ManagementUninstallParams
ManagementUninstallSelfParams
Match
MediaStreamConstraint
MediaTrackConstraints for the media streams that will be passed to WebRTC. See section on MediaTrackConstraints: http://dev.w3.org/2011/webrtc/editor/getusermedia.html
MemoryInfo
A menu item used by an input method to interact with the user from the language menu.
The type of menu item. Radio buttons between separators are considered grouped.
MessageSender
An object containing information about the script context that sent a message or request.
MetadataCallback
MicrophoneContentSetting
MirrorMode
Mirror mode, i.e. different ways of how a display is mirrored to other displays.
MirrorModeInfo
Mode
MostVisitedURL
An object encapsulating a most visited URL, such as the URLs on the new tab page.
MountOptions
Options for the mount method.
MouseButton
Which mouse buttons was clicked.
MouselockContentSetting
MoveEntryRequestedOptions
Options for the onMoveEntryRequested event.
MultipleAutomaticDownloadsContentSetting
MutedInfo
Tab muted state and the reason for the last state change.
MutedInfoReason
An event that caused a muted state change.
NetworkInfo
A dictionary identifying filtered networks. One of GUID, SSID or HexSSID must be set. BSSID and Security are ignored when filtering networks.
NetworkInterface
NetworkPrivacy
NetworkType
Indicator for the type of network used in NetworkInfo.
NotificationBitmap
NotificationButton
NotificationItem
NotificationOptions
NotificationsContentSetting
NotifyOptions
Options for the notify method.
OnAbortRequestedEvent
OnActivateEvent
This event is sent when an IME is activated. It signals that the IME will be receiving onKeyPress events.
OnActiveChangedEvent
Fires when the selected tab in a window changes. Note that the tab's URL may not be set at the time this event fired, but you can listen to tabs.onUpdated events to be notified when a URL is set.
OnAddWatcherRequestedEvent
OnAttachedEvent
Fired when a tab is attached to a window, for example because it was moved between windows.
OnAuthRequiredEvent
Fired when an authentication failure is received. The listener has three options: it can provide authentication credentials, it can cancel the request and display the error page, or it can take no action on the challenge. If bad user credentials are provided, this may be called multiple times for the same request. Note, only one of 'blocking' or 'asyncBlocking' modes must be specified in the extraInfoSpec parameter.
OnAuthRequiredOptions
OnBeforeRedirectOptions
OnBeforeRequestOptions
OnBeforeSendHeadersOptions
OnButtonClickedEvent
OnCandidateClickedEvent
This event is sent if this extension owns the active IME.
OnChangedCause
The underlying reason behind the cookie's change. If a cookie was inserted, or removed via an explicit call to "chrome.cookies.remove", "cause" will be "explicit". If a cookie was automatically removed due to expiry, "cause" will be "expired". If a cookie was removed due to being overwritten with an already-expired expiration date, "cause" will be set to "expired_overwrite". If a cookie was automatically removed due to garbage collection, "cause" will be "evicted". If a cookie was automatically removed due to a "set" call that overwrote it, "cause" will be "overwrite". Plan your response accordingly.
OnChildrenReorderedEvent
Fired when the children of a folder have changed their order due to the order being sorted in the UI. This is not called as a result of a move().
OnClosedEvent
OnCloseFileRequestedEvent
OnCompletedOptions
OnConfigCreatedEvent
OnConfigureRequestedEvent
OnCopyEntryRequestedEvent
OnCreatedEvent
Fired when a bookmark or folder is created.
OnCreateDirectoryRequestedEvent
OnCreateFileRequestedEvent
OnDeleteEntryRequestedEvent
OnDetachedEvent
Fired when a tab is detached from a window, for example because it is being moved between windows.
OnDetachEvent
Fired when browser terminates debugging session for the tab. This happens when either the tab is being closed or Chrome DevTools is being invoked for the attached tab.
OnDeterminingFilenameEvent
OnEventEvent
Fired whenever debugging target issues instrumentation event.
OnExecuteActionRequestedEvent
OnExecuteEvent
Fired when file system action is executed from ChromeOS file browser.
OnExitedEvent
Fired each time a process is terminated, providing the type of exit.
OnGetActionsRequestedEvent
OnGetCapabilityRequestedEvent
OnGetMetadataRequestedEvent
OnGetUsbPrinterInfoRequestedEvent
OnHeadersReceivedOptions
OnInputChangedEvent
User has changed what is typed into the omnibox.
OnInputEnteredDisposition
The window disposition for the omnibox query. This is the recommended context to display results. For example, if the omnibox command is to navigate to a certain URL, a disposition of 'newForegroundTab' means the navigation should take place in a new selected tab.
OnInputEnteredEvent
User has accepted what is typed into the omnibox.
OnInstalledReason
The reason that this event is being dispatched.
OnKeyEventEvent
Fired when a key event is sent from the operating system. The event will be sent to the extension if this extension owns the active IME.
OnMenuItemActivatedEvent
Called when the user selects a menu item
OnMessageEvent
Fired when a message is sent from either an extension process (by runtime.sendMessage) or a content script (by tabs.sendMessage).
OnMessageExternalEvent
Fired when a message is sent from another extension/app (by runtime.sendMessage). Cannot be used in a content script.
OnMountRequestedEvent
OnMoveEntryRequestedEvent
OnOpenFileRequestedEvent
OnPlatformMessageEvent
OnPrintRequestedEvent
OnReadDirectoryRequestedEvent
OnReadFileRequestedEvent
OnRemoveWatcherRequestedEvent
OnReplacedEvent
Fired when a tab is replaced with another tab due to prerendering or instant.
OnRequestEvent
Fired when a request is sent from either an extension process or a content script.
OnRequestExternalEvent
Fired when a request is sent from another extension.
OnResourceContentCommittedEvent
Fired when a new revision of the resource is committed (e.g. user saves an edited version of the resource in the Developer Tools).
OnResponseStartedOptions
OnRestartRequiredReason
The reason that the event is being dispatched. 'app_update' is used when the restart is needed because the application is updated to a newer version. 'os_update' is used when the restart is needed because the browser/OS is updated to a newer version. 'periodic' is used when the system runs for more than the permitted uptime set in the enterprise policy.
OnSelectionChangedEvent
Fires when the selected tab in a window changes.
OnSendHeadersOptions
OnSignDigestRequestedEvent
OnSignInChangedEvent
OnSpeakEvent
Called when the user makes a call to tts.speak() and one of the voices from this extension's manifest is the first to match the options object.
OnSurroundingTextChangedEvent
Called when the editable string around caret is changed or when the caret position is moved. The text length is limited to 100 characters for each back and forth direction.
OnTruncateRequestedEvent
OnUIEventEvent
OnUnmountRequestedEvent
OnUpdatedEvent
Fired when a tab is updated.
OnWriteFileRequestedEvent
OpenedFile
Represents an opened file.
OpenFileMode
Mode of opening a file. Used by onOpenFileRequested.
OpenFileRequestedOptions
Options for the onOpenFileRequested event.
OriginTypesBrowsingData
OS
PacScript
An object holding proxy auto-config information. Exactly one of the fields should be non-empty.
PageActionGetPopupParams
PageActionGetTitleParams
PageActionSetIconParams
PageActionSetPopupParams
PageActionSetTitleParams
PageCaptureSaveAsMHTMLParams
PageStateMatcher
Matches the state of a web page by various criteria.
PageStateMatcherInstanceType
Parameters
A parameters class for the VPN interface.
PermissionLevel
Permissions
PinRequestErrorType
The types of errors that can be presented to the user through the requestPin function.
PinRequestType
The type of code being requested by the extension with requestPin function.
PinResponseDetails
PlatformArch
The machine's processor architecture.
PlatformInfo
An object containing information about the current platform.
PlatformMessage
The enum is used by the platform to notify the client of the VPN session status.
PlatformNaclArch
The native client architecture. This may be different from arch on some platforms.
PlatformOs
The operating system chrome is running on.
PluginsContentSetting
Point
PopupsContentSetting
Port
An object which allows two way communication with other pages. See Long-lived connections for more information.
PpapiBrokerContentSetting
PrintCallback
PrinterInfo
Printer description for onGetPrintersRequested event.
PrinterInfoCallback
PrintError
Error codes returned in response to onPrintRequested event.
PrintersCallback
PrintJob
Printing request parameters. Passed to onPrintRequested event.
Process
An object containing information about one of the browser's processes.
ProcessorInfo
ProfileUserInfo
PropertiesInputIme
ProviderError
Error codes used by providing extensions in response to requests as well as in case of errors when calling methods of the API. For success, "OK" must be used.
ProviderErrorCallback
ProviderSuccessCallback
ProxyConfig
An object encapsulating a complete proxy configuration.
ProxyRules
An object encapsulating the set of proxy rules for all protocols. Use either 'singleProxy' or (a subset of) 'proxyForHttp', 'proxyForHttps', 'proxyForFtp' and 'fallbackProxy'.
ProxyServer
An object encapsulating a single proxy server's specification.
ReadDirectoryRequestedOptions
Options for the onReadDirectoryRequested event.
ReadFileRequestedOptions
Options for the onReadFileRequested event.
RedirectByRegEx
Redirects a request by applying a regular expression on the URL. The regular expressions use the RE2 syntax.
RedirectByRegExInstanceType
RedirectRequest
Declarative event action that redirects a network request.
RedirectRequestInstanceType
RedirectToEmptyDocument
Declarative event action that redirects a network request to an empty document.
RedirectToEmptyDocumentInstanceType
RedirectToTransparentImage
Declarative event action that redirects a network request to a transparent image.
RedirectToTransparentImageInstanceType
RemovalOptions
Options that determine exactly what data will be removed.
RemoveRequestCookie
Removes one or more cookies of request. Note that it is preferred to use the Cookies API because this is computationally less expensive.
RemoveRequestCookieInstanceType
RemoveRequestHeader
Removes the request header of the specified name. Do not use SetRequestHeader and RemoveRequestHeader with the same header name on the same request. Each request header name occurs only once in each request.
RemoveRequestHeaderInstanceType
RemoveResponseCookie
Removes one or more cookies of response. Note that it is preferred to use the Cookies API because this is computationally less expensive.
RemoveResponseCookieInstanceType
RemoveResponseHeader
Removes all response headers of the specified names and values.
RemoveResponseHeaderInstanceType
RemoveWatcherRequestedOptions
Options for the onRemoveWatcherRequested event.
Request
Represents a network request for a document resource (script, image and so on). See HAR Specification for reference.
RequestBodyWebRequest
RequestContentScript
Declarative event action that injects a content script. WARNING: This action is still experimental and is not supported on stable builds of Chrome.
RequestContentScriptInstanceType
RequestCookie
A filter or specification of a cookie in HTTP Requests.
RequestFilter
An object describing filters to apply to webRequest events.
RequestMatcher
Matches network events by various criteria.
RequestMatcherInstanceType
RequestPinCallback
RequestPinDetails
RequestUpdateCheckResult
The return type for requestUpdateCheck.
RequestUpdateCheckStatus
Result of the update check.
Resource
A resource within the inspected page, such as a document, a script, or an image.
ResourceIdentifier
The only content type using resource identifiers is contentSettings.plugins. For more information, see Resource Identifiers.
ResourceType
ResponseCookie
A specification of a cookie in HTTP Responses.
Rule
Description of a declarative rule for handling events.
RunAt
The soonest that the JavaScript or CSS will be injected into the tab.
RuntimeConnectParams
RuntimeSendMessageParams
SameSiteStatus
A cookie's 'SameSite' state (https://tools.ietf.org/html/draft-west-first-party-cookies). 'no_restriction' corresponds to a cookie set without a 'SameSite' attribute, 'lax' to 'SameSite=Lax', and 'strict' to 'SameSite=Strict'.
ScanOptions
ScanResults
Scheme
Scope
The scope of the ContentSetting. One of
regular: setting for regular profile (which is inherited by the incognito profile if not overridden elsewhere),
incognito_session_only: setting for incognito profile that can only be set during an incognito session and is deleted when the incognito session ends (overrides regular settings).
ScreenType
The screen type under which the IME is activated.
ScriptCode
An ISO 15924 script code. The default, or global, script is represented by script code "Zyyy".
SelectDetails
SendMessageToExtension
Triggers the declarativeWebRequest.onMessage event.
SendMessageToExtensionInstanceType
ServicesPrivacy
Session
SetIcon
Declarative event action that sets the n-dip square icon for the extension's $(ref:pageAction page action) or $(ref:browserAction browser action) while the corresponding conditions are met. This action can be used without host permissions, but the extension must have page or browser action.Exactly one of imageData or path must be specified. Both are dictionaries mapping a number of pixels to an image representation. The image representation in imageData is anImageData object, for example from a <canvas> element, while the image representation in path is the path to an image file relative to the extension's manifest. If scale screen pixels fit into a device-independent pixel, the scale * n icon will be used. If that scale is missing, another image will be resized to the needed size.
SetIconInstanceType
SetRequestHeader
Sets the request header of the specified name to the specified value. If a header with the specified name did not exist before, a new one is created. Header name comparison is always case-insensitive. Each request header name occurs only once in each request.
SetRequestHeaderInstanceType
ShowPageAction
Declarative event action that shows the extension's $(ref:pageAction page action) while the corresponding conditions are met. This action can be used without host permissions, but the extension must have a page action. If the extension takes the activeTab permission, a click on the page action will grant access to the active tab.
ShowPageActionInstanceType
SignCallback
SignRequest
SourcesPanel
Represents the Sources panel.
Stage
State
in_progress
The download is currently receiving data from the server.
interrupted
An error broke the connection with the file host.
complete
The download completed successfully.
StopPinRequestCallback
StopPinRequestDetails
StorageArea
StorageAvailableCapacityInfo
StorageChange
StorageOnChangedEvent
Fired when one or more items change.
StorageUnitInfo
StorageUnitType
StringDelta
SubtleCrypto
SuggestFilenameCallback
SuggestResult
A suggest result.
SyncStorageArea
Tab
TabCaptureState
TabsConnectParams
TabsCreateParams
TabsHighlightParams
TabsMoveParams
TabsOnMovedEvent
Fired when a tab is moved within a window. Only one move event is fired, representing the tab the user directly moved. Move events are not fired for the other tabs that must move in response. This event is not fired when a tab is moved between windows. For that, see tabs.onDetached.
TabsOnRemovedEvent
Fired when a tab is closed.
TabsQueryParams
TabsReloadParams
TabsSendMessageParams
TabStatus
Whether the tabs have completed loading.
TabsUpdateParams
TabsWindowType
The type of window.
TargetInfo
Debug target information
TargetInfoType
Target type.
TemplateType
Token
TokenDetails
TouchCalibrationPair
TouchCalibrationPairQuad
TransitionQualifier
TransitionType
Cause of the navigation. The same transition types as defined in the history API are used. These are the same transition types as defined in the history API except with "start_page" in place of "auto_toplevel" (for backwards compatibility).
TruncateRequestedOptions
Options for the onTruncateRequested event.
TtsEvent
An event from the TTS engine to communicate the status of an utterance.
TtsSpeakParams
TtsVoice
A description of a voice available for speech synthesis.
TypesClearParams
TypesGetParams
TypesLevelOfControl
One of
TypesSetParams
UIEvent
The enum is used by the platform to indicate the event that triggered onUIEvent.
UnderlineStyle
The type of the underline to modify this segment.
UnmountOptions
Options for the unmount method.
UnmountRequestedOptions
Options for the onUnmountRequested event.
UploadData
Contains data uploaded in a URL request.
UrlFilter
Filters URLs for various criteria. See event filtering. All criteria are case sensitive.
UsageInputIme
VerificationDetails
VerificationResult
ViewType
The type of extension view.
VisitItem
An object encapsulating one visit to a URL.
VoiceGender
VpnConnectionState
The enum is used by the VPN client to inform the platform of its current state. This helps provide meaningful messages to the user.
WallpaperLayout
The supported wallpaper layouts.
WallpaperSetWallpaperParams
Watcher
Represents a watcher.
WatchLocationRequestInfo
Parameter of watchLocation call.
WebAuthFlowDetails
WebNavigationGetAllFramesParams
WebNavigationGetFrameParams
WebsitesPrivacy
Window
WindowPosition
Where to display the candidate window. If set to 'cursor', the window follows the cursor. If set to 'composition', the window is locked to the beginning of the composition.
WindowsCreateParams
WindowsGetAllParams
WindowsGetCurrentParams
WindowsGetLastFocusedParams
WindowsGetParams
WindowState
The state of this browser window. Under some circumstances a Window may not be assigned state property, for example when querying closed windows from the sessions API.
WindowsUpdateParams
WindowWindowType
The type of browser window this is. Under some circumstances a Window may not be assigned type property, for example when querying closed windows from the sessions API.
WriteFileRequestedOptions
Options for the onWriteFileRequested event.
ZoomSettings
Defines how zoom changes in a tab are handled and at what scope.
ZoomSettingsMode
Defines how zoom changes are handled, i.e. which entity is responsible for the actual scaling of the page; defaults to automatic.
ZoomSettingsScope
Defines whether zoom changes will persist for the page's origin, or only take effect in this tab; defaults to per-origin when in automatic mode, and per-tab otherwise.

Properties

alarms ChromeAlarms
Accessor for the chrome.alarms namespace.
final
bookmarks ChromeBookmarks
Accessor for the chrome.bookmarks namespace.
final
browserAction ChromeBrowserAction
Accessor for the chrome.browserAction namespace.
final
browsingData ChromeBrowsingData
Accessor for the chrome.browsingData namespace.
final
certificateProvider ChromeCertificateProvider
Accessor for the chrome.certificateProvider namespace.
final
commands ChromeCommands
Accessor for the chrome.commands namespace.
final
contentSettings ChromeContentSettings
Accessor for the chrome.contentSettings namespace.
final
contextMenus ChromeContextMenus
Accessor for the chrome.contextMenus namespace.
final
cookies ChromeCookies
Accessor for the chrome.cookies namespace.
final
debugger ChromeDebugger
Accessor for the chrome.debugger namespace.
final
declarativeContent ChromeDeclarativeContent
Accessor for the chrome.declarativeContent namespace.
final
declarativeWebRequest ChromeDeclarativeWebRequest
Accessor for the chrome.declarativeWebRequest namespace.
final
desktopCapture ChromeDesktopCapture
Accessor for the chrome.desktopCapture namespace.
final
devtools ChromeDevtools
final
documentScan ChromeDocumentScan
Accessor for the chrome.documentScan namespace.
final
downloads ChromeDownloads
Accessor for the chrome.downloads namespace.
final
enterprise ChromeEnterprise
final
events ChromeEvents
Accessor for the chrome.events namespace.
final
extension ChromeExtension
Accessor for the chrome.extension namespace.
final
extensionTypes ChromeExtensionTypes
Accessor for the chrome.extensionTypes namespace.
final
fileBrowserHandler ChromeFileBrowserHandler
Accessor for the chrome.fileBrowserHandler namespace.
final
fileSystemProvider ChromeFileSystemProvider
Accessor for the chrome.fileSystemProvider namespace.
final
fontSettings ChromeFontSettings
Accessor for the chrome.fontSettings namespace.
final
gcm ChromeGcm
Accessor for the chrome.gcm namespace.
final
history ChromeHistory
Accessor for the chrome.history namespace.
final
i18n ChromeI18N
Accessor for the chrome.i18n namespace.
final
identity ChromeIdentity
Accessor for the chrome.identity namespace.
final
idle ChromeIdle
Accessor for the chrome.idle namespace.
final
input ChromeInput
final
instanceID ChromeInstanceID
Accessor for the chrome.instanceID namespace.
final
location ChromeLocation
Accessor for the chrome.location namespace.
final
management ChromeManagement
Accessor for the chrome.management namespace.
final
networking ChromeNetworking
final
notifications ChromeNotifications
Accessor for the chrome.notifications namespace.
final
omnibox ChromeOmnibox
Accessor for the chrome.omnibox namespace.
final
pageAction ChromePageAction
Accessor for the chrome.pageAction namespace.
final
pageCapture ChromePageCapture
Accessor for the chrome.pageCapture namespace.
final
permissions ChromePermissions
Accessor for the chrome.permissions namespace.
final
platformKeys ChromePlatformKeys
Accessor for the chrome.platformKeys namespace.
final
power ChromePower
Accessor for the chrome.power namespace.
final
printerProvider ChromePrinterProvider
Accessor for the chrome.printerProvider namespace.
final
privacy ChromePrivacy
Accessor for the chrome.privacy namespace.
final
processes ChromeProcesses
Accessor for the chrome.processes namespace.
final
proxy ChromeProxy
Accessor for the chrome.proxy namespace.
final
runtime ChromeRuntime
Accessor for the chrome.runtime namespace.
final
sessions ChromeSessions
Accessor for the chrome.sessions namespace.
final
signedInDevices ChromeSignedInDevices
Accessor for the chrome.signedInDevices namespace.
final
storage ChromeStorage
Accessor for the chrome.storage namespace.
final
system ChromeSystem
final
tabCapture ChromeTabCapture
Accessor for the chrome.tabCapture namespace.
final
tabs ChromeTabs
Accessor for the chrome.tabs namespace.
final
topSites ChromeTopSites
Accessor for the chrome.topSites namespace.
final
tts ChromeTts
Accessor for the chrome.tts namespace.
final
ttsEngine ChromeTtsEngine
Accessor for the chrome.ttsEngine namespace.
final
types ChromeTypes
Accessor for the chrome.types namespace.
final
vpnProvider ChromeVpnProvider
Accessor for the chrome.vpnProvider namespace.
final
wallpaper ChromeWallpaper
Accessor for the chrome.wallpaper namespace.
final
webNavigation ChromeWebNavigation
Accessor for the chrome.webNavigation namespace.
final
webRequest ChromeWebRequest
Accessor for the chrome.webRequest namespace.
final
windows ChromeWindows
Accessor for the chrome.windows namespace.
final