chrome.runtime

Properties

• frameId

  number optional

  The frame that opened the connection. 0 for top-level frames, positive for child frames. This will only be set when tab is set.

• id

  string optional

  The ID of the extension or app that opened the connection, if any.

• nativeApplication

  string optional

  The name of the native application that opened the connection, if any.

• origin

  string optional

  The origin of the page or frame that opened the connection. It can vary from the url property (e.g., about:blank) or can be opaque (e.g., sandboxed iframes). This is useful for identifying if the origin can be trusted if we can't immediately tell from the URL.

• tab

  tabs.Tab optional

  The tabs.Tab which opened the connection, if any. This property will only be present when the connection was opened from a tab (including content scripts), and only if the receiver is an extension, not an app.

• tlsChannelId

  string optional

  The TLS channel ID of the page or frame that opened the connection, if requested by the extension or app, and if available.

• url

  string optional

  The URL of the page or frame that opened the connection. If the sender is in an iframe, it will be iframe's URL not the URL of the page which hosts it.

Properties

• arch

  PlatformArch

  The machine's processor architecture.

• nacl_arch

  PlatformNaclArch

  The native client architecture. This may be different from arch on some platforms.

• os

  PlatformOs

  The operating system chrome is running on.

Properties

• disconnect

  function

  Immediately disconnect the port. Calling disconnect() on an already-disconnected port has no effect. When a port is disconnected, no new events will be dispatched to this port.

  The disconnect function looks like this:

  disconnect() => {...}
• name

  string

  The name of the port, as specified in the call to connect.

• onDisconnect

  events.Event<function>

  Fired when the port is disconnected from the other end(s). lastError may be set if the port was disconnected by an error. If the port is closed via disconnect, then this event is only fired on the other end. This event is fired at most once (see also Port lifetime). The first and only parameter to the event handler is this disconnected port.

  Add a listener like this:

  onDisconnect.addListener(listener)

  • listener

    function

    The listener parameter should be a function that looks like this:

    () => {...}
• onMessage

  events.Event<function>

  This event is fired when postMessage is called by the other end of the port. The first parameter is the message, the second parameter is the port that received the message.

  Add a listener like this:

  onMessage.addListener(listener)

  • listener

    function

    The listener parameter should be a function that looks like this:

    () => {...}
• postMessage

  function

  Send a message to the other end of the port. If the port is disconnected, an error is thrown.

  The postMessage function looks like this:

  postMessage(message: any) => {...}

  • message

    any

    The message to send. This object should be JSON-ifiable.

• sender

  MessageSender optional

  This property will only be present on ports passed to onConnect / onConnectExternal / onConnectNative listeners.

Enum

Enum

Enum

Enum

Enum

Enum

Type

Properties

• message

  string optional

  Details about the error which occurred.

Parameters

• extensionId

  string

  The ID of the extension or app to connect to. If omitted, a connection will be attempted with your own extension. Required if sending messages from a web page for web messaging.

• connectInfo

  object
  • includeTlsChannelId

    boolean optional

    Whether the TLS channel ID will be passed into onConnectExternal for processes that are listening for the connection event.

  • name

    string optional

    Will be passed into onConnect for processes that are listening for the connection event.

Returns

• returns

  Port

  Port through which messages can be sent and received. The port's onDisconnect event is fired if the extension/app does not exist.

Parameters

• application

  string

  The name of the registered application to connect to.

Returns

• returns

  Port

  Port through which messages can be sent and received with the application

Parameters

• callback

  function

  The callback parameter should be a function that looks like this:

  (backgroundPage: Window) => {...}

  • backgroundPage

    Window

    The JavaScript 'window' object for the background page.

Returns

• returns

  object

  The manifest details.

Parameters

• callback

  function

  The callback parameter should be a function that looks like this:

  (directoryEntry: DirectoryEntry) => {...}

  • directoryEntry

    DirectoryEntry

Parameters

• callback

  function

  Called with results

  The callback parameter should be a function that looks like this:

  (platformInfo: PlatformInfo) => {...}

  • platformInfo

    PlatformInfo

Parameters

• path

  string

  A path to a resource within an app/extension expressed relative to its install directory.

Returns

• returns

  string

  The fully-qualified URL to the resource.

Parameters

• callback

  function

  The callback parameter should be a function that looks like this:

  () => {...}

Parameters

• callback

  function

  The callback parameter should be a function that looks like this:

  (status: RequestUpdateCheckStatus, details: object) => {...}

  • status

    RequestUpdateCheckStatus

    Result of the update check.

  • details

    object

    If an update is available, this contains more information about the available update.

    • version

      string

      The version of the available update.

Parameters

• seconds

  number

  Time to wait in seconds before rebooting the device, or -1 to cancel a scheduled reboot.

• callback

  function

  A callback to be invoked when a restart request was successfully rescheduled.

  The callback parameter should be a function that looks like this:

  () => {...}

Parameters

• extensionId

  string optional

  The ID of the extension/app to send the message to. If omitted, the message will be sent to your own extension/app. Required if sending messages from a web page for web messaging.

• message

  any

  The message to send. This message should be a JSON-ifiable object.

• options

  object
  • includeTlsChannelId

    boolean optional

    Whether the TLS channel ID will be passed into onMessageExternal for processes that are listening for the connection event.

• responseCallback

  function

  The responseCallback function looks like this:

  responseCallback(response: any) => {...}

  • response

    any

    The JSON response object sent by the handler of the message. If an error occurs while connecting to the extension, the callback will be called with no arguments and lastError will be set to the error message.

Parameters

• application

  string

  The name of the native messaging host.

• message

  object

  The message that will be passed to the native messaging host.

• responseCallback

  function

  The responseCallback function looks like this:

  responseCallback(response: any) => {...}

  • response

    any

    The response message sent by the native messaging host. If an error occurs while connecting to the native messaging host, the callback will be called with no arguments and lastError will be set to the error message.

Parameters

• url

  string

  URL to be opened after the extension is uninstalled. This URL must have an http: or https: scheme. Set an empty string to not open a new tab upon uninstallation.

• callback

  function

  Called when the uninstall URL is set. If the given URL is invalid, lastError will be set.

  The callback parameter should be a function that looks like this:

  () => {...}

Event

• listener

  function

  Deprecated. Please use onRestartRequired.

  The listener parameter should be a function that looks like this:

  () => {...}

Event

• listener

  function

  The listener parameter should be a function that looks like this:

  (port: Port) => {...}

  • port

    Port

Event

• listener

  function

  The listener parameter should be a function that looks like this:

  (port: Port) => {...}

  • port

    Port

Event

• listener

  function

  The listener parameter should be a function that looks like this:

  (port: Port) => {...}

  • port

    Port

Event

• listener

  function

  The listener parameter should be a function that looks like this:

  (details: object) => {...}

  • details

    object
    • id

      string optional

      Indicates the ID of the imported shared module extension which updated. This is present only if 'reason' is 'shared_module_update'.

    • previousVersion

      string optional

      Indicates the previous version of the extension, which has just been updated. This is present only if 'reason' is 'update'.

    • reason

      OnInstalledReason

      The reason that this event is being dispatched.

Event

• listener

  function

  The listener parameter should be a function that looks like this:

  (message: any, sender: MessageSender, sendResponse: function) => {...}

  • message

    any

    The message sent by the calling script.

  • sender

    MessageSender
  • sendResponse

    function

    The sendResponse function looks like this:

    sendResponse() => {...}

Event

• listener

  function

  The listener parameter should be a function that looks like this:

  (message: any, sender: MessageSender, sendResponse: function) => {...}

  • message

    any

    The message sent by the calling script.

  • sender

    MessageSender
  • sendResponse

    function

    The sendResponse function looks like this:

    sendResponse() => {...}

Event

• listener

  function

  The listener parameter should be a function that looks like this:

  (reason: OnRestartRequiredReason) => {...}

  • reason

    OnRestartRequiredReason

    The reason that the event is being dispatched.

Event

• listener

  function

  The listener parameter should be a function that looks like this:

  () => {...}

Event

• listener

  function

  The listener parameter should be a function that looks like this:

  () => {...}

Event

• listener

  function

  The listener parameter should be a function that looks like this:

  () => {...}

Event

• listener

  function

  The listener parameter should be a function that looks like this:

  (details: object) => {...}

  • details

    object

    The manifest details of the available update.

    • version

      string

      The version number of the available update.