runtime

This module provides information about your extension and the environment it's running in.

It also provides messaging APIs enabling you to:

类型

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.

特性

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 extension.

函数

runtime.getBackgroundPage()

Retrieves the Window object for the background page running inside the current extension.

runtime.openOptionsPage()

Opens your extension'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 extension, returns a fully-qualified URL.

runtime.setUninstallURL()

Sets a URL to be visited when the extension is uninstalled.

runtime.reload()

Reloads the extension.

runtime.requestUpdateCheck()

Checks for updates to this extension.

runtime.connect()

Establishes a connection from a content script to the main extension process, or from one extension to a different extension.

runtime.connectNative()

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

runtime.sendMessage()

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

runtime.sendNativeMessage()

Sends a single message from an extension to a native application.

runtime.getPlatformInfo()

Returns information about the current platform.

runtime.getBrowserInfo()

Returns information about the browser in which this extension is installed.

runtime.getPackageDirectoryEntry()

Returns a DirectoryEntry for the package directory.

事件

runtime.onStartup

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

runtime.onInstalled

Fired when the extension is first installed, when the extension 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 extension is unloaded. This gives the extension an opportunity to do some cleanup.

runtime.onSuspendCanceled

Sent after runtime.onSuspend to indicate that the extension won't be unloaded after all.

runtime.onUpdateAvailable

Fired when an update is available, but isn't installed immediately because the extension 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 extension process or a content script.

runtime.onConnectExternal

Fired when a connection is made with another extension.

runtime.onMessage

Fired when a message is sent from either an extension process or a content script.

runtime.onMessageExternal

Fired when a message is sent from another extension. Cannot be used in a content script.

runtime.onRestartRequired

Fired when the device needs to be restarted.

浏览器兼容性

BCD tables only load in the browser

Example extensions

注意: This API is based on Chromium's chrome.runtime API. This documentation is derived from runtime.json in the Chromium code.

Microsoft Edge compatibility data is supplied by Microsoft Corporation and is included here under the Creative Commons Attribution 3.0 United States License.

Found a problem with this page?

最后修改: , 由 MDN 贡献者

  1. 浏览器扩展名
  2. 快速入门
    1. What are extensions?
    2. Your first extension
    3. Your second extension
    4. Anatomy of an extension
    5. Example extensions
    6. What next?
  3. 概念
    1. Using the JavaScript APIs
    2. Content scripts
    3. Match patterns
    4. Working with files
    5. 国际化
    6. Content Security Policy
    7. Native messaging
    8. Differences between API implementations
    9. Chrome incompatibilities
  4. 用户界面
    1. 用户界面
    2. Toolbar button
    3. Address bar button
    4. Sidebars
    5. Context menu items
    6. Options page
    7. Extension pages
    8. Notifications
    9. Address bar suggestions
    10. Developer tools panels
  5. 如何
    1. Intercept HTTP requests
    2. Modify a web page
    3. Insert external content
    4. Share objects with page scripts
    5. Add a button to the toolbar
    6. Implement a settings page
    7. Work with the Tabs API
    8. Work with the Bookmarks API
    9. Work with the Cookies API
    10. Work with contextual identities
    11. Interact with the clipboard
    12. Build a cross-browser extension
  6. Firefox differentiators
  7. JavaScript API
    1. Browser support for JavaScript APIs
    2. alarms
    3. bookmarks
    4. browserAction
    5. browserSettings
    6. browsingData
    7. captivePortal
    8. clipboard
    9. 命令
    10. contentScripts
    11. contextualIdentities
    12. Cookie
    13. devtools
    14. dns
    15. downloads
    16. events
    17. extension
    18. extensionTypes
    19. find
    20. history
    21. i18n
    22. identity
    23. idle
    24. management
    25. menus
    26. notifications
    27. omnibox
    28. pageAction
    29. permissions
    30. pkcs11
    31. privacy
    32. proxy
    33. runtime
      1. 方法
        1. connect()
        2. connectNative()
        3. getBackgroundPage()
        4. getBrowserInfo()
        5. getManifest()
        6. getPackageDirectoryEntry()
        7. getPlatformInfo()
        8. getURL()
        9. openOptionsPage()
        10. reload()
        11. requestUpdateCheck()
        12. sendMessage()
        13. sendNativeMessage()
        14. setUninstallURL()
      2. 特性
        1. id
        2. lastError
      3. 类型
        1. MessageSender
        2. OnInstalledReason
        3. OnRestartRequiredReason
        4. PlatformArch
        5. PlatformInfo
        6. PlatformNaclArch
        7. PlatformOs
        8. Port
        9. RequestUpdateCheckStatus
      4. 事件
        1. onBrowserUpdateAvailable
        2. onConnect
        3. onConnectExternal
        4. onInstalled
        5. onMessage
        6. onMessageExternal
        7. onRestartRequired
        8. onStartup
        9. onSuspend
        10. onSuspendCanceled
        11. onUpdateAvailable
    34. search
    35. sessions
    36. sidebarAction
    37. storage
    38. tabs
    39. theme
    40. topSites
    41. 类型
    42. userScripts
    43. webNavigation
    44. webRequest
    45. windows
  8. Manifest keys
    1. 介绍
    1. 作者
    2. background
    3. browser_action
    4. browser_specific_settings
    5. chrome_settings_overrides
    6. chrome_url_overrides
    7. 命令
    8. content_scripts
    9. content_security_policy
    10. default_locale
    11. description
    12. developer
    13. devtools_page
    14. dictionaries
    15. externally_connectable
    16. homepage_url
    17. icons
    18. incognito
    19. manifest_version
    20. name
    21. offline_enabled
    22. omnibox
    23. optional_permissions
    24. options_page
    25. options_ui
    26. page_action
    27. permissions
    28. protocol_handlers
    29. short_name
    30. sidebar_action
    31. storage
    32. theme
    33. theme_experiment
    34. user_scripts
    35. version
    36. version_name
    37. web_accessible_resources
  9. Extension Workshop
    1. Develop
    2. Publish
    3. Manage
    4. Enterprise
  10. Contact us
  11. Channels
    1. Add-ons blog
    2. Add-ons forum
    3. Add-ons chat