runtime

该模块提供关于附加组件以及运行环境的信息。

它提供一组消息通信API，允许你：

• 在附加组件的不同模块间通信。
• 和其它的附加组件通信。
• 和native应用通信。

Types

runtime.Port

Represents one end of a connection between two specific contexts, which can be used to exchange messages.

runtime.MessageSender

Contains information about the sender of a message or connection request.

runtime.PlatformOs

Identifies the browser's operating system.

runtime.PlatformArch

Identifies the browser's processor architecture.

runtime.PlatformInfo

Contains information about the platform the browser is running on.

runtime.RequestUpdateCheckStatus

Result of a call to runtime.requestUpdateCheck().

runtime.OnInstalledReason

The reason that the runtime.onInstalled event is being dispatched.

runtime.OnRestartRequiredReason

The reason that the runtime.onRestartRequired event is being dispatched.

Properties

runtime.lastError

This value is set when an asynchronous function has an error condition that it needs to report to its caller.

runtime.id

The ID of the add-on.

Functions

runtime.getBackgroundPage()

Retrieves the Window object for the background page running inside the current add-on.

runtime.openOptionsPage()

Opens your add-ons's options page.

runtime.getManifest()

Gets the complete manifest.json file, serialized as an object.

runtime.getURL()

Given a relative path from the manifest.json to a resource packaged with the add-on, returns a fully-qualified URL.

runtime.setUninstallURL()

Sets a URL to be visited when the add-on is uninstalled.

runtime.reload()

Reloads the add-on.

runtime.requestUpdateCheck()

Checks for updates to this add-on.

runtime.connect()

Establishes a connection from a content script to the main add-on process, or from one add-on to a different add-on.

runtime.connectNative()

Connects the WebExtension to a native application on the user's computer.

runtime.sendMessage()

Sends a single message to event listeners within your add-on or a different add-on. Similar to runtime.connect but only sends a single message, with an optional response.

runtime.sendNativeMessage()

Sends a single message from a WebExtension to a native application.

runtime.getPlatformInfo()

Returns information about the current platform.

runtime.getBrowserInfo()

Returns information about the browser in which this add-on is installed.

runtime.getPackageDirectoryEntry()

Returns a DirectoryEntry for the package directory.

Events

runtime.onStartup

Fired when a profile that has this add-on installed first starts up. This event is not fired when an incognito profile is started.

runtime.onInstalled

Fired when the add-on is first installed, when the add-on is updated to a new version, and when the browser is updated to a new version.

runtime.onSuspend

Sent to the event page just before the add-on is unloaded. This gives the add-on an opportunity to do some cleanup.

runtime.onSuspendCanceled

Sent after runtime.onSuspend to indicate that the add-on won't be unloaded after all.

runtime.onUpdateAvailable

Fired when an update is available, but isn't installed immediately because the add-on is currently running.

runtime.onBrowserUpdateAvailable

Fired when an update for the browser is available, but isn't installed immediately because a browser restart is required.

runtime.onConnect

Fired when a connection is made with either an add-on process or a content script.

runtime.onConnectExternal

Fired when a connection is made with another add-on.

runtime.onMessage

Fired when a message is sent from either an add-on process or a content script.

runtime.onMessageExternal

Fired when a message is sent from another add-on. Cannot be used in a content script.

runtime.onRestartRequired

Fired when the device needs to be restarted.

Browser compatibility

Chrome incompatibilities

None.

Example extensions

• beastify
• cookie-bg-picker
• devtools-panels
• embedded-webextension-bootstrapped
• embedded-webextension-overlay
• embedded-webextension-sdk
• export-helpers
• favourite-colour
• find-across-tabs
• imagify
• menu-demo
• mocha-client-tests
• native-messaging
• notify-link-clicks-i18n
• permissions
• proxy-blocker
• runtime-examples
• store-collected-images
• user-script
• webpack-modules

// Copyright 2015 The Chromium Authors. All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
//    * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//    * Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
//    * Neither the name of Google Inc. nor the names of its
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.