chrome.webviewTag

Properties

• since

  number optional

  Clear data accumulated on or after this date, represented in milliseconds since the epoch (accessible via the getTime method of the JavaScript Date object). If absent, defaults to 0 (which would remove all browsing data).

Properties

• appcache

  boolean optional

  Websites' appcaches.

• cache

  boolean optional

  Since Chrome 44.

  Since Chrome 43.
  The browser's cache. Note: when removing data, this clears the entire cache; it is not limited to the range you specify.

• cookies

  boolean optional

  The partition's cookies.

• fileSystems

  boolean optional

  Websites' filesystems.

• indexedDB

  boolean optional

  Websites' IndexedDB data.

• localStorage

  boolean optional

  Websites' local storage data.

• persistentCookies

  boolean optional

  Since Chrome 58.

  The partition's persistent cookies.

• sessionCookies

  boolean optional

  Since Chrome 58.

  The partition's session cookies.

• webSQL

  boolean optional

  Websites' WebSQL data.

Properties

• all_frames

  boolean optional

  If all_frames is true, this implies that the JavaScript or CSS should be injected into all frames of current page. By default, all_frames is false and the JavaScript or CSS is only injected into the top frame.

• css

  InjectionItems optional

  The CSS code or a list of CSS files to be injected into matching pages. These are injected in the order they appear, before any DOM is constructed or displayed for the page.

• exclude_globs

  string[] optional

  Applied after matches to exclude URLs that match this glob. Intended to emulate the @exclude Greasemonkey keyword.

• exclude_matches

  string[] optional

  Excludes pages that this content script would otherwise be injected into.

• include_globs

  string[] optional

  Applied after matches to include only those URLs that also match this glob. Intended to emulate the @include Greasemonkey keyword.

• js

  InjectionItems optional

  The JavaScript code or a list of JavaScript files to be injected into matching pages. These are injected in the order they appear.

• match_about_blank

  boolean optional

  Whether to insert the content script on about:blank and about:srcdoc. Content scripts will only be injected on pages when their inherit URL is matched by one of the declared patterns in the matches field. The inherit URL is the URL of the document that created the frame or window. Content scripts cannot be inserted in sandboxed frames.

• matches

  string[]

  Specifies which pages this content script will be injected into.

• name

  string

  The name of the content script to inject.

• run_at

  contentScripts.RunAt optional

  The soonest that the JavaScript or CSS will be injected into the tab. Defaults to "document_idle".

Properties

• postMessage

  function

  Posts a message to the embedded web content as long as the embedded content is displaying a page from the target origin. This method is available once the page has completed loading. Listen for the contentload event and then call the method.

  The guest will be able to send replies to the embedder by posting message to event.source on the message event it receives.

  This API is identical to the HTML5 postMessage API for communication between web pages. The embedder may listen for replies by adding a message event listener to its own frame.

  The postMessage function looks like this:

  postMessage(message: any, targetOrigin: string) => {...}

  • message

    any

    Message object to send to the guest.

  • targetOrigin

    string

    Specifies what the origin of the guest window must be for the event to be dispatched.

Properties

• checked

  boolean optional

  The initial state of a checkbox or radio item: true for selected and false for unselected. Only one radio item can be selected at a time in a given group of radio items.

• contexts

  ContextType[] optional

  List of contexts this menu item will appear in. Defaults to ['page'] if not specified.

• documentUrlPatterns

  string[] optional

  Lets you restrict the item to apply only to documents whose URL matches one of the given patterns. (This applies to frames as well.) For details on the format of a pattern, see Match Patterns.

• enabled

  boolean optional

  Whether this context menu item is enabled or disabled. Defaults to true.

• id

  string optional

  The unique ID to assign to this item. Mandatory for event pages. Cannot be the same as another ID for this extension.

• onclick

  function optional

  A function that will be called back when the menu item is clicked.

  The onclick function looks like this:

  onclick(info: object) => {...}

  • info

    object
• parentId

  enum optional

  The ID of a parent menu item; this makes the item a child of a previously added item.

• targetUrlPatterns

  string[] optional

  Similar to documentUrlPatterns, but lets you filter based on the src attribute of img/audio/video tags and the href of anchor tags.

• title

  string optional

  The text to be displayed in the item; this is required unless type is 'separator'. When the context is 'selection', you can use %s within the string to show the selected text. For example, if this parameter's value is "Translate '%s' to Pig Latin" and the user selects the word "cool", the context menu item for the selection is "Translate 'cool' to Pig Latin".

• type

  contextMenus.ItemType optional

  The type of menu item. Defaults to 'normal' if not specified.

Properties

• checked

  boolean optional

  The state of a checkbox or radio item: true for selected and false for unselected. Only one radio item can be selected at a time in a given group of radio items.

• contexts

  ContextType[] optional

  List of contexts this menu item will appear in.

• documentUrlPatterns

  string[] optional

  Lets you restrict the item to apply only to documents whose URL matches one of the given patterns. (This applies to frames as well.) For details on the format of a pattern, see Match Patterns.

• enabled

  boolean optional

  Whether this context menu item is enabled or disabled.

• onclick

  function optional

  A function that will be called back when the menu item is clicked.

  The onclick function looks like this:

  onclick(info: object) => {...}

  • info

    object
• parentId

  enum optional

  The ID of a parent menu item; this makes the item a child of a previously added item. Note: You cannot change an item to be a child of one of its own descendants.

• targetUrlPatterns

  string[] optional

  Similar to documentUrlPatterns, but lets you filter based on the src attribute of img/audio/video tags and the href of anchor tags.

• title

  string optional

  The text to be displayed in the item

• type

  contextMenus.ItemType optional

  The type of menu item.

Properties

• onShow

  events.Event<function>

  Fired before showing a context menu on this webview. Can be used to disable this context menu by calling event.preventDefault().

  Add a listener like this:

  onShow.addListener(listener)

  • listener

    function

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

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

    • event

      object
      • preventDefault

        function

        Call this to prevent showing the context menu.

        The preventDefault function looks like this:

        preventDefault() => {...}
• create

  function

  Creates a new context menu item. Note that if an error occurs during creation, you may not find out until the creation callback fires (the details will be in runtime.lastError).

  The create function looks like this:

  create(createProperties: ContextMenuCreateProperties, callback: function): enum => {...}

  • createProperties

    ContextMenuCreateProperties

    The properties used to create the item

  • callback

    function

    Called when the item has been created in the browser. If there were any problems creating the item, details will be available in runtime.lastError.

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

    () => {...}
  • returns

    enum

    The ID of the newly created item.

• remove

  function

  Removes a context menu item.

  The remove function looks like this:

  remove(menuItemId: enum, callback: function) => {...}

  • menuItemId

    enum

    The ID of the context menu item to remove.

  • callback

    function

    Called when the context menu has been removed.

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

    () => {...}
• removeAll

  function

  Removes all context menu items added to this webview.

  The removeAll function looks like this:

  removeAll(callback: function) => {...}

  • callback

    function

    Called when removal is complete.

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

    () => {...}
• update

  function

  Updates a previously created context menu item.

  The update function looks like this:

  update(id: enum, updateProperties: ContextMenuUpdateProperties, callback: function) => {...}

  • id

    enum

    The ID of the item to update.

  • updateProperties

    ContextMenuUpdateProperties

    The properties to update. Accepts the same values as the create function.

  • callback

    function

    Called when the context menu has been updated.

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

    () => {...}

Properties

• cancel

  function

  Reject the dialog. Equivalent to clicking Cancel in a confirm or prompt dialog.

  The cancel function looks like this:

  cancel() => {...}
• ok

  function

  Accept the dialog. Equivalent to clicking OK in an alert, confirm, or prompt dialog.

  The ok function looks like this:

  ok(response: string) => {...}

  • response

    string

    The response string to provide to the guest when accepting a prompt dialog.

Properties

• requestMethod

  string

  The HTTP request type (e.g. GET) associated with the download request.

• url

  string

  The requested download URL.

• allow

  function

  Allow the permission request.

  The allow function looks like this:

  allow() => {...}
• deny

  function

  Deny the permission request. This is the default behavior if allow is not called.

  The deny function looks like this:

  deny() => {...}

Properties

• url

  string

  The URL of the frame requesting access to local file system.

• allow

  function

  Allow the permission request.

  The allow function looks like this:

  allow() => {...}
• deny

  function

  Deny the permission request.

  The deny function looks like this:

  deny() => {...}

Properties

• activeMatchOrdinal

  number

  The ordinal number of the current match.

• canceled

  boolean

  Indicates whether this find request was canceled.

• numberOfMatches

  number

  The number of times searchText was matched on the page.

• selectionRect

  SelectionRect

  Describes a rectangle around the active match in screen coordinates.

Properties

• backward

  boolean optional

  Flag to find matches in reverse order. The default value is false.

• matchCase

  boolean optional

  Flag to match with case-sensitivity. The default value is false.

Properties

• origin

  string

  The origin of the frame inside the webview that initiated the fullscreen request.

• allow

  function

  Allow the permission request.

  The allow function looks like this:

  allow() => {...}
• deny

  function

  Deny the permission request.

  The deny function looks like this:

  deny() => {...}

Properties

• url

  string

  The URL of the frame requesting access to geolocation data.

• allow

  function

  Allow the permission request.

  The allow function looks like this:

  allow() => {...}
• deny

  function

  Deny the permission request. This is the default behavior if allow is not called.

  The deny function looks like this:

  deny() => {...}

Properties

• code

  string optional

  JavaScript or CSS code to inject.
  
  Warning:
  Be careful using the code parameter. Incorrect use of it may open your app to cross site scripting attacks.

• file

  string optional

  JavaScript or CSS file to inject.

Properties

• code

  string optional

  JavaScript code or CSS to be injected into matching pages.

• files

  string[] optional

  The list of JavaScript or CSS files to be injected into matching pages. These are injected in the order they appear in this array.

Properties

• identifier

  string

  The plugin's identifier string.

• name

  string

  The plugin's display name.

• allow

  function

  Allow the permission request. This is the default behavior if deny is not called..

  The allow function looks like this:

  allow() => {...}
• deny

  function

  Deny the permission request.

  The deny function looks like this:

  deny() => {...}

Properties

• url

  string

  The URL of the frame requesting access to user media.

• allow

  function

  Allow the permission request.

  The allow function looks like this:

  allow() => {...}
• deny

  function

  Deny the permission request. This is the default behavior if allow is not called.

  The deny function looks like this:

  deny() => {...}

Properties

• attach

  function

  Attach the requested target page to an existing webview element.

  The attach function looks like this:

  attach(webview: object) => {...}

  • webview

    object

    The webview element to which the target page should be attached.

• discard

  function

  Cancel the new window request.

  The discard function looks like this:

  discard() => {...}

Properties

• lastUnlockedBySelf

  boolean

  Whether or not the requesting frame was the most recent client to hold pointer lock.

• url

  string

  The URL of the frame requesting pointer lock.

• userGesture

  boolean

  Whether or not pointer lock was requested as a result of a user input gesture.

• allow

  function

  Allow the permission request.

  The allow function looks like this:

  allow() => {...}
• deny

  function

  Deny the permission request. This is the default behavior if allow is not called.

  The deny function looks like this:

  deny() => {...}

Properties

• height

  number

  Height of the rectangle.

• left

  number

  Distance from the left edge of the screen to the left edge of the rectangle.

• top

  number

  Distance from the top edge of the screen to the top edge of the rectangle.

• width

  number

  Width of the rectangle.

Enum

Enum

Type

Type

Type

Parameters

• contentScriptList

  ContentScriptDetails[]

  Details of the content scripts to add.

Parameters

• callback

  function

  Since Chrome 44.

  Called after the navigation has either failed or completed successfully.

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

  (success: boolean) => {...}

  • success

    boolean

    Indicates whether the navigation was successful.

Returns

• returns

  boolean

Returns

• returns

  boolean

Parameters

• options

  extensionTypes.ImageDetails optional
• callback

  function

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

  (dataUrl: string) => {...}

  • dataUrl

    string

    A data URL which encodes an image of the visible area of the captured tab. May be assigned to the 'src' property of an HTML Image element for display.

Parameters

• options

  ClearDataOptions

  Options determining which data to clear.

• types

  ClearDataTypeSet

  The types of data to be cleared.

• callback

  function

  Called after the data has been successfully cleared.

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

  () => {...}

Parameters

• details

  InjectDetails

  Details of the script to run.

• callback

  function

  Called after all the JavaScript has been executed.

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

  (result: any[]) => {...}

  • result

    any[]

    The result of the script in every injected frame.

Parameters

• searchText

  string

  The string to find in the page.

• options

  FindOptions

  Options for the find request.

• callback

  function

  Called after all find results have been returned for this find request.

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

  (results: FindCallbackResults) => {...}

  • results

    FindCallbackResults

    Contains all of the results of the find request. results can be omitted if it is not utilized in the callback function body; for example, if the callback is only used to discern when the find request has completed.

Parameters

• callback

  function

  Since Chrome 44.

  Called after the navigation has either failed or completed successfully.

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

  (success: boolean) => {...}

  • success

    boolean

    Indicates whether the navigation was successful.

Parameters

• callback

  function

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

  (audible: boolean) => {...}

  • audible

    boolean

Returns

• returns

  number

Returns

• returns

  string

Parameters

• callback

  function

  Called after the current zoom factor is retrieved.

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

  (zoomFactor: number) => {...}

  • zoomFactor

    number

    The current zoom factor.

Parameters

• callback

  function

  Called with the webview's current zoom mode.

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

  (ZoomMode: ZoomMode) => {...}

  • ZoomMode

    ZoomMode

    The webview's current zoom mode.

Parameters

• relativeIndex

  number

  Relative history index to which the webview should be navigated. For example, a value of 2 will navigate forward 2 history entries if possible; a value of -3 will navigate backward 3 entries.

• callback

  function

  Since Chrome 40.

  Called after the navigation has either failed or completed successfully.

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

  (success: boolean) => {...}

  • success

    boolean

    Indicates whether the navigation was successful.

Parameters

• details

  InjectDetails

  Details of the CSS to insert.

• callback

  function

  Called after the CSS has been inserted.

  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:

  (muted: boolean) => {...}

  • muted

    boolean

Parameters

• callback

  function

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

  (enabled: boolean) => {...}

  • enabled

    boolean

Parameters

• dataUrl

  string

  The data URL to load.

• baseUrl

  string

  The base URL that will be used for relative links.

• virtualUrl

  string

  The URL that will be displayed to the user (in the address bar).

Parameters

• scriptNameList

  string[]

  A list of names of content scripts that will be removed. If the list is empty, all the content scripts added to the webview will be removed.

Parameters

• mute

  boolean

  Mute audio value

Parameters

• enabled

  boolean

  Spatial navigation state value.

Parameters

• userAgent

  string

  The user agent string to use.

Parameters

• zoomFactor

  number

  The new zoom factor.

• callback

  function

  Called after the page has been zoomed.

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

  () => {...}

Parameters

• ZoomMode

  ZoomMode

  Defines how zooming is handled in the webview.

• callback

  function

  Called after the zoom mode has been changed.

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

  () => {...}

Parameters

• action

  enum

  Determines what to do with the active match after the find session has ended. clear will clear the highlighting over the active match; keep will keep the active match highlighted; activate will keep the active match highlighted and simulate a user click on that match. The default action is keep.

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:

  (level: number, message: string, line: number, sourceId: string) => {...}

  • level

    number

    The severity level of the log message. Ranges from -1 to 2. LOG_VERBOSE (console.debug) = -1, LOG_INFO (console.log, console.info) = 0, LOG_WARNING (console.warn) = 1, LOG_ERROR (console.error) = 2.

  • message

    string

    The logged message contents.

  • line

    number

    The line number of the message source.

  • sourceId

    string

    A string identifying the resource which logged the message.

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:

  (messageType: enum, messageText: string, dialog: DialogController) => {...}

  • messageType

    enum

    The type of modal dialog requested by the guest.

  • messageText

    string

    The text the guest attempted to display in the modal dialog.

  • dialog

    DialogController

    An interface that can be used to respond to the guest's modal request.

Event

• listener

  function

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

  (processID: number, reason: enum) => {...}

  • processID

    number

    Chrome's internal ID of the process that exited.

  • reason

    enum

    String indicating the reason for the exit.

Event

• listener

  function

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

  (searchText: string, numberOfMatches: number, activeMatchOrdinal: number, selectionRect: SelectionRect, canceled: boolean, finalUpdate: string) => {...}

  • searchText

    string

    The string that is being searched for in the page.

  • numberOfMatches

    number

    The number of matches found for searchText on the page so far.

  • activeMatchOrdinal

    number

    The ordinal number of the current active match, if it has been found. This will be 0 until then.

  • selectionRect

    SelectionRect

    Describes a rectangle around the active match, if it has been found, in screen coordinates.

  • canceled

    boolean

    Indicates whether the find request was canceled.

  • finalUpdate

    string

    Indicates that all find requests have completed and that no more findupdate events will be fired until more find requests are made.

Event

• listener

  function

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

  (url: string, isTopLevel: boolean, code: number, reason: enum) => {...}

  • url

    string

    Requested URL.

  • isTopLevel

    boolean

    Whether the load was top-level or in a subframe.

  • code

    number

    Since Chrome 44.

    Unique integer ID for the type of abort. Note that this ID is not guaranteed to remain backwards compatible between releases. You must not act based upon this specific integer.

  • reason

    enum

    String indicating what type of abort occurred. This string is not guaranteed to remain backwards compatible between releases. You must not parse and act based upon its content. It is also possible that, in some cases, an error not listed here could be reported.

Event

• listener

  function

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

  (url: string, isTopLevel: boolean) => {...}

  • url

    string

    The URL that committed.

  • isTopLevel

    boolean

    Whether the load is top-level or in a subframe.

Event

• listener

  function

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

  (oldUrl: string, newUrl: string, isTopLevel: boolean) => {...}

  • oldUrl

    string

    The requested URL before the redirect.

  • newUrl

    string

    The new URL after the redirect.

  • isTopLevel

    boolean

    Whether or not the redirect happened at top-level or in a subframe.

Event

• listener

  function

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

  (url: string, isTopLevel: boolean) => {...}

  • url

    string

    Requested URL.

  • isTopLevel

    boolean

    Whether the load is top-level or in a subframe.

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:

  (window: NewWindow, targetUrl: string, initialWidth: number, initialHeight: number, name: string, windowOpenDisposition: enum) => {...}

  • window

    NewWindow

    An interface that can be used to either attach the requested target page to an existing webview element or explicitly discard the request.

  • targetUrl

    string

    The target URL requested for the new window.

  • initialWidth

    number

    The initial width requested for the new window.

  • initialHeight

    number

    The initial height requested for the new window.

  • name

    string

    The requested name of the new window.

  • windowOpenDisposition

    enum

    The requested disposition of the new window.

Event

• listener

  function

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

  (permission: enum, request: object) => {...}

  • permission

    enum

    The type of permission being requested.

  • request

    object

    An object which holds details of the requested permission. Depending on the type of permission requested, this may be a MediaPermissionRequest, GeolocationPermissionRequest, PointerLockPermissionRequest, DownloadPermissionRequest, LoadPluginPermissionRequest, or FullscreenPermissionRequest.

Event

• listener

  function

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

  (processID: number) => {...}

  • processID

    number

    Chrome's internal ID of the process that became responsive.

Event

• listener

  function

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

  (oldWidth: number, oldHeight: number, newWidth: number, newHeight: number) => {...}

  • oldWidth

    number

    Old width of embedded web content.

  • oldHeight

    number

    Old height of embedded web content.

  • newWidth

    number

    New width of embedded web content.

  • newHeight

    number

    New height of embedded web content.

Event

• listener

  function

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

  (processID: number) => {...}

  • processID

    number

    Chrome's internal ID of the process that has become unresponsive.

Event

• listener

  function

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

  (oldZoomFactor: number, newZoomFactor: number) => {...}

  • oldZoomFactor

    number

    The page's previous zoom factor.

  • newZoomFactor

    number

    The new zoom factor that the page was zoomed to.