diff options
21 files changed, 787 insertions, 1190 deletions
diff --git a/chrome/common/common_resources.grd b/chrome/common/common_resources.grd index e13c7c1..5e90f50 100644 --- a/chrome/common/common_resources.grd +++ b/chrome/common/common_resources.grd @@ -1,6 +1,6 @@ <?xml version="1.0" encoding="UTF-8"?> <!-- This comment is only here because changes to resources are not picked up -without changes to the corresponding grd file. --> +without changes to the corresponding grd file. rw2 --> <grit latest_public_release="0" current_release="1"> <outputs> <output filename="grit/common_resources.h" type="rc_header"> diff --git a/chrome/common/extensions/PRESUBMIT.PY b/chrome/common/extensions/PRESUBMIT.PY new file mode 100755 index 0000000..e443f37 --- /dev/null +++ b/chrome/common/extensions/PRESUBMIT.PY @@ -0,0 +1,62 @@ +#!/usr/bin/python2.4
+# Copyright 2009, Google Inc.
+# 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.
+
+import os
+
+_dependent_dirs = set([
+ "chrome/common/extensions/api",
+ "chrome/common/extensions/docs/build",
+ "chrome/common/extensions/docs/js",
+ "chrome/common/extensions/docs/static",
+ "chrome/common/extensions/docs/template",
+]);
+
+_rebuild_warning = """
+This change modifies file(s) which the extension docs depend on. You must
+rebuild the extension docs.
+
+Build by running the build.py script in chrome/common/extensions/docs/build/.
+
+Be sure to include any modified resulting static files
+(/common/extension/docs/*.html) in your final changelist.
+"""
+
+def CheckChange(input_api, output_api):
+ for f in input_api.AffectedFiles():
+ dir = os.path.dirname(f.LocalPath())
+ if (dir in _dependent_dirs):
+ return [output_api.PresubmitPromptWarning(_rebuild_warning)]
+ return []
+
+def CheckChangeOnUpload(input_api, output_api):
+ return CheckChange(input_api, output_api)
+
+def CheckChangeOnCommit(input_api, output_api):
+ return CheckChange(input_api, output_api)
\ No newline at end of file diff --git a/chrome/common/extensions/api/extension_api.json b/chrome/common/extensions/api/extension_api.json index 2740069..d31291c 100755 --- a/chrome/common/extensions/api/extension_api.json +++ b/chrome/common/extensions/api/extension_api.json @@ -1,740 +1,649 @@ -// Copyright (c) 2009 The Chromium Authors. All rights reserved. -// Use of this source code is governed by a BSD-style license that can be -// found in the LICENSE file. - -/* - * This file defines the extensions api functions, events and types. It is - * json-structured list of api "modules". Each module has - * - * namespace: "<apiname>", // i.e. "windows" which becomes visible to - * // extensions as chrome.windows. - * - * types: [], // a list of json schemas which define "types" - * // that are common to that module. i.e. "Tab" or - * // "BookmarkTreeNode". - * - * functions: [], // a list of json schemas which define the - * // functions in the current module. i.e. - * // chrome.tabs.getCurrent(). - * - * events: [], // a list of json schemas which define the events - * // which this module defines. i.e. - * // chrome.windows.onCreated. - * - * --Functions Schemas-- - * Each function schema is required to have a - * - * name: "<function name>" - * type: "function" - * description: "..." // this appears in the docs. - * parameters: [] - * - * |parameters| is a list of json schemas which define the list of parameters - * this function requires and will be validated against. Each parameter - * should define a "name" property, and "description" property, both of which - * will appear in the docs. The final parameter may be a type: "function" - * which is expected to be the callback for this call. That parameter, should - * itself be named ("name": "callback"), have a "parameters" member that - * is a list of the json schemas that define the types that the callback - * sends. Callback parameters should also have "name" and "description" - * properties. - * - * --Event Schemas-- - * Each event schema is also a type: "function" schema that is named. It's - * structure is the same as the callback functions for module Functions. - * It should have a "name", "description", and a "parameters" describing - * the set of arguments it sends. - * - * --Referenced Types-- - * The "types": [] list may contain a list of types that are common to the - * current api module. Each type should have an "id" member ("id": "Tab"). - * These types can be referenced from a schema with "$ref": "<idName>". - * i.e. - * - * ... - * type: "function", - * parameters: [ - * {$ref: "BookmarkTreeNode", name: "node"} - * ] - * - * WARNING: Do not use these referenced types in module function parameters. - * They are not yet properly validated. They are currently safe to use in - * callback parameters and event parameters. - * - * TODO(rafaelw): Validate callback arguments in debug and unittests - * TODO(rafaelw): Validate event arguments in debug and unittests - * TODO(rafaelw): Support $ref for json_schema validation. - */ [ - /** - * chrome.self - */ { - namespace: "self", - types: [ + "namespace": "self", + "types": [ { - id: "HTMLWindow", - type: "object" + "id": "HTMLWindow", + "type": "object" } ], - functions: [ - { - name: "getViews", - type: "function", - description: "Returns an array of the global JavaScript objects for each of the views running inside the current extension. This includes toolstrips, background pages, and tabs.", - parameters: [], - returns: { - type: "array", - description: "Array of HTMLWindow objects", - items: { $ref: "HTMLWindow" } + "functions": [ + { + "name": "getViews", + "type": "function", + "description": "Returns an array of the global JavaScript objects for each of the views running inside the current extension. This includes toolstrips, background pages, and tabs.", + "parameters": [], + "returns": { + "type": "array", + "description": "Array of HTMLWindow objects", + "items": { "$ref": "HTMLWindow" } } - }, + } ], - events: [] + "events": [] }, - - /** - * chrome.windows - */ { - namespace: "windows", - types: [], - functions: [ + "namespace": "windows", + "types": [], + "functions": [ { - name: "get", - type: "function", - description: "", - parameters: [ - {type: "integer", name: "windowId", minimum: 0}, - {type: "function", name: "callback"} + "name": "get", + "type": "function", + "description": "", + "parameters": [ + {"type": "integer", "name": "windowId", "minimum": 0}, + {"type": "function", "name": "callback"} ] }, { - name: "getCurrent", - type: "function", - description: "", - parameters: [ - {type: "function", name: "callback"} + "name": "getCurrent", + "type": "function", + "description": "", + "parameters": [ + {"type": "function", "name": "callback"} ] }, { - name: "getLastFocused", - type: "function", - description: "", - parameters: [ - {type: "function", name: "callback"} + "name": "getLastFocused", + "type": "function", + "description": "", + "parameters": [ + {"type": "function", "name": "callback"} ] }, { - name: "getAll", - type: "function", - description: "", - parameters: [ - {type: "boolean", name: "populate", optional: true}, - {type: "function", name: "callback"} + "name": "getAll", + "type": "function", + "description": "", + "parameters": [ + {"type": "boolean", "name": "populate", "optional": true}, + {"type": "function", "name": "callback"} ] }, { - name: "create", - type: "function", - description: "", - parameters: [ + "name": "create", + "type": "function", + "description": "", + "parameters": [ { - type: "object", - name: "CreateData", - properties: { - url: {type: "string", optional: true}, - left: {type: "integer", optional: true}, - top: {type: "integer", optional: true}, - width: {type: "integer", minimum: 0, optional: true}, - height: {type: "integer", minimum: 0, optional: true} + "type": "object", + "name": "CreateData", + "properties": { + "url": {"type": "string", "optional": true}, + "left": {"type": "integer", "optional": true}, + "top": {"type": "integer", "optional": true}, + "width": {"type": "integer", "minimum": 0, "optional": true}, + "height": {"type": "integer", "minimum": 0, "optional": true} }, - optional: true + "optional": true }, - {type: "function", name: "callback", optional: true} + {"type": "function", "name": "callback", "optional": true} ] }, { - name: "update", - type: "function", - description: "", - parameters: [ - {type: "integer", name: "windowId", minimum: 0}, + "name": "update", + "type": "function", + "description": "", + "parameters": [ + {"type": "integer", "name": "windowId", "minimum": 0}, { - type: "object", - name: "UpdateInfo", - properties: { - left: {type: "integer", optional: true}, - top: {type: "integer", optional: true}, - width: {type: "integer", minimum: 0, optional: true}, - height: {type: "integer", minimum: 0, optional: true} - }, + "type": "object", + "name": "UpdateInfo", + "properties": { + "left": {"type": "integer", "optional": true}, + "top": {"type": "integer", "optional": true}, + "width": {"type": "integer", "minimum": 0, "optional": true}, + "height": {"type": "integer", "minimum": 0, "optional": true} + } }, - {type: "function", name: "callback", optional: true} + {"type": "function", "name": "callback", "optional": true} ] }, { - name: "remove", - type: "function", - description: "", - parameters: [ - {type: "integer", name: "windowId", minimum: 0}, - {type: "function", name: "callback", optional: true} + "name": "remove", + "type": "function", + "description": "", + "parameters": [ + {"type": "integer", "name": "windowId", "minimum": 0}, + {"type": "function", "name": "callback", "optional": true} ] - }, + } ], - events: [ + "events": [ { - name: "onCreated", - type: "function", - description: "", - parameters: [ - {type: "integer", name: "windowId", minimum: 0} + "name": "onCreated", + "type": "function", + "description": "", + "parameters": [ + {"type": "integer", "name": "windowId", "minimum": 0} ] }, { - name: "onRemoved", - type: "function", - description: "", - parameters: [ - {type: "integer", name: "windowId", minimum: 0} + "name": "onRemoved", + "type": "function", + "description": "", + "parameters": [ + {"type": "integer", "name": "windowId", "minimum": 0} ] }, { - name: "onFocusChanged", - type: "function", - description: "", - parameters: [ - {type: "integer", name: "windowId", minimum: 0} + "name": "onFocusChanged", + "type": "function", + "description": "", + "parameters": [ + {"type": "integer", "name": "windowId", "minimum": 0} ] } ] }, - - /** - * chrome.tabs - */ { - namespace: "tabs", - types: [ - { - id: "Tab", - type: "object", - properties: { - id: {type: "integer", minimum: 0}, - index: {type: "integer", minimum: 0}, - windowId: {type: "integer", minimum: 0}, - selected: {type: "boolean"}, - url: {type: "string"}, - title: {type: "string", optional: true}, - favIconUrl: {type: "string", optional: true} + "namespace": "tabs", + "types": [ + { + "id": "Tab", + "type": "object", + "properties": { + "id": {"type": "integer", "minimum": 0}, + "index": {"type": "integer", "minimum": 0}, + "windowId": {"type": "integer", "minimum": 0}, + "selected": {"type": "boolean"}, + "url": {"type": "string"}, + "title": {"type": "string", "optional": true}, + "favIconUrl": {"type": "string", "optional": true} } }, { - id: "Port", - type: "object", - properties: { - name: {type: "string"}, - onDisconnect: {type: "object"}, - onMessage: {type: "object"} + "id": "Port", + "type": "object", + "properties": { + "name": {"type": "string"}, + "onDisconnect": {"type": "object"}, + "onMessage": {"type": "object"} } } ], - functions: [ + "functions": [ { - name: "get", - type: "function", - description: "", - parameters: [ - {type: "integer", name: "tabId", minimum: 0}, + "name": "get", + "type": "function", + "description": "", + "parameters": [ + {"type": "integer", "name": "tabId", "minimum": 0}, { - type: "function", - name: "callback", - parameters: [ - {name: "tab", $ref: "Tab"} + "type": "function", + "name": "callback", + "parameters": [ + {"name": "tab", "$ref": "Tab"} ] } ] }, { - name: "connect", - type: "function", - description: "", - parameters: [ - {type: "integer", name: "tabId", optional: true, minimum: 0}, - {type: "string", name: "name", optional: true} + "name": "connect", + "type": "function", + "description": "", + "parameters": [ + {"type": "integer", "name": "tabId", "optional": true, "minimum": 0}, + {"type": "string", "name": "name", "optional": true} ], - returns: { - name: "Port", - $ref: "Port" + "returns": { + "name": "Port", + "$ref": "Port" } }, { - name: "getSelected", - type: "function", - description: "", - parameters: [ - {type: "integer", name: "windowId", minimum: 0, optional: true}, + "name": "getSelected", + "type": "function", + "description": "", + "parameters": [ + {"type": "integer", "name": "windowId", "minimum": 0, "optional": true}, { - type: "function", - name: "callback", - parameters: [ - {name: "tab", $ref: "Tab"} + "type": "function", + "name": "callback", + "parameters": [ + {"name": "tab", "$ref": "Tab"} ] } ] }, { - name: "getAllInWindow", - type: "function", - description: "", - parameters: [ - {type: "integer", name: "windowId", minimum: 0, optional: true}, - {type: "function", name: "callback"} + "name": "getAllInWindow", + "type": "function", + "description": "", + "parameters": [ + {"type": "integer", "name": "windowId", "minimum": 0, "optional": true}, + {"type": "function", "name": "callback"} ] }, { - name: "create", - type: "function", - description: "", - parameters: [ + "name": "create", + "type": "function", + "description": "", + "parameters": [ { - type: "object", - name: "CreateProperties", - properties: { - windowId: {type: "integer", minimum: 0, optional: true}, - index: {type: "integer", minimum: 0, optional: true}, - url: {type: "string", optional: true}, - selected: {type: "boolean", optional: true} + "type": "object", + "name": "CreateProperties", + "properties": { + "windowId": {"type": "integer", "minimum": 0, "optional": true}, + "index": {"type": "integer", "minimum": 0, "optional": true}, + "url": {"type": "string", "optional": true}, + "selected": {"type": "boolean", "optional": true} } }, { - type: "function", - name: "callback", - optional: true, - parameters: [ - {name: "tab", $ref: "Tab"} + "type": "function", + "name": "callback", + "optional": true, + "parameters": [ + {"name": "tab", "$ref": "Tab"} ] } ] }, { - name: "update", - type: "function", - description: "", - parameters: [ - {type: "integer", name: "tabId", minimum: 0}, + "name": "update", + "type": "function", + "description": "", + "parameters": [ + {"type": "integer", "name": "tabId", "minimum": 0}, { - type: "object", - name: "UpdateProperties", - properties: { - url: {type: "string", optional: true}, - selected: {type: "boolean", optional: true} + "type": "object", + "name": "UpdateProperties", + "properties": { + "url": {"type": "string", "optional": true}, + "selected": {"type": "boolean", "optional": true} } }, - {type: "function", name: "callback", optional: true, parameters: []} + {"type": "function", "name": "callback", "optional": true, "parameters": []} ] }, { - name: "move", - type: "function", - description: "", - parameters: [ - {type: "integer", name: "tabId", minimum: 0}, + "name": "move", + "type": "function", + "description": "", + "parameters": [ + {"type": "integer", "name": "tabId", "minimum": 0}, { - type: "object", - name: "MoveProperties", - properties: { - windowId: {type: "integer", minimum: 0, optional: true}, - index: {type: "integer", minimum: 0} + "type": "object", + "name": "MoveProperties", + "properties": { + "windowId": {"type": "integer", "minimum": 0, "optional": true}, + "index": {"type": "integer", "minimum": 0} } }, - {type: "function", name: "callback", optional: true, parameters: []} + {"type": "function", "name": "callback", "optional": true, "parameters": []} ] }, { - name: "remove", - type: "function", - description: "", - parameters: [ - {type: "integer", name: "tabId", minimum: 0, optional: true}, - {type: "function", name: "callback", optional: true, parameters: []} + "name": "remove", + "type": "function", + "description": "", + "parameters": [ + {"type": "integer", "name": "tabId", "minimum": 0, "optional": true}, + {"type": "function", "name": "callback", "optional": true, "parameters": []} ] }, { - name: "detectLanguage", - type: "function", - description: "detect language of tab.", - parameters: [ - {type: "integer", name: "tabId", minimum: 0, optional: true}, + "name": "detectLanguage", + "type": "function", + "description": "detect language of tab.", + "parameters": [ + {"type": "integer", "name": "tabId", "minimum": 0, "optional": true}, { - type: "function", - name: "callback", - parameters: [ - {type: "string", name: "language"} + "type": "function", + "name": "callback", + "parameters": [ + {"type": "string", "name": "language"} ] } ] } ], - events: [ + "events": [ { - name: "onCreated", - type: "function", - description: "", - parameters: [ - {$ref: "Tab", name: "tab"} + "name": "onCreated", + "type": "function", + "description": "", + "parameters": [ + {"$ref": "Tab", "name": "tab"} ] }, { - name: "onUpdated", - type: "function", - description: "", - parameters: [ - {type: "integer", name: "tabId", minimum: 0}, + "name": "onUpdated", + "type": "function", + "description": "", + "parameters": [ + {"type": "integer", "name": "tabId", "minimum": 0}, { - type: "object", - name: "ChangedProps", - properties: { - tabId: {type: "integer", name: "tabId", minimum: 0}, - status: {type: "string"}, - url: {type: "string", optional: true} + "type": "object", + "name": "ChangedProps", + "properties": { + "tabId": {"type": "integer", "name": "tabId", "minimum": 0}, + "status": {"type": "string"}, + "url": {"type": "string", "optional": true} } } ] }, { - name: "onMoved", - type: "function", - description: "", - parameters: [ - {type: "integer", name: "tabId", minimum: 0}, + "name": "onMoved", + "type": "function", + "description": "", + "parameters": [ + {"type": "integer", "name": "tabId", "minimum": 0}, { - type: "object", - name: "MoveInfo", - properties: { - windowId: {type: "integer", minimum: 0}, - fromIndex: {type: "integer", minimum: 0}, - toIndex: {type: "integer", minimum: 0} + "type": "object", + "name": "MoveInfo", + "properties": { + "windowId": {"type": "integer", "minimum": 0}, + "fromIndex": {"type": "integer", "minimum": 0}, + "toIndex": {"type": "integer", "minimum": 0} } } ] }, { - name: "onSelectionChanged", - type: "function", - description: "", - parameters: [ - {type: "integer", name: "tabId", minimum: 0}, + "name": "onSelectionChanged", + "type": "function", + "description": "", + "parameters": [ + {"type": "integer", "name": "tabId", "minimum": 0}, { - type: "object", name: "SelectInfo", - properties: { - windowId: {type: "integer", minimum: 0}, + "type": "object", "name": "SelectInfo", + "properties": { + "windowId": {"type": "integer", "minimum": 0} } } ] }, { - name: "onAttached", - type: "function", - description: "", - parameters: [ - {type: "integer", name: "tabId", minimum: 0}, + "name": "onAttached", + "type": "function", + "description": "", + "parameters": [ + {"type": "integer", "name": "tabId", "minimum": 0}, { - type: "object", - name: "AttachInfo", - properties: { - newWindowId: {type: "integer", minimum: 0}, - newPosition: {type: "integer", minimum: 0} + "type": "object", + "name": "AttachInfo", + "properties": { + "newWindowId": {"type": "integer", "minimum": 0}, + "newPosition": {"type": "integer", "minimum": 0} } } ] }, { - name: "onDetached", - type: "function", - description: "", - parameters: [ - {type: "integer", name: "tabId", minimum: 0}, + "name": "onDetached", + "type": "function", + "description": "", + "parameters": [ + {"type": "integer", "name": "tabId", "minimum": 0}, { - type: "object", - name: "DetachInfo", - properties: { - oldWindowId: {type: "integer", minimum: 0}, - oldPosition: {type: "integer", minimum: 0} + "type": "object", + "name": "DetachInfo", + "properties": { + "oldWindowId": {"type": "integer", "minimum": 0}, + "oldPosition": {"type": "integer", "minimum": 0} } } ] }, { - name: "onRemoved", - type: "function", - description: "", - parameters: [ - {type: "integer", name: "tabId", minimum: 0} + "name": "onRemoved", + "type": "function", + "description": "", + "parameters": [ + {"type": "integer", "name": "tabId", "minimum": 0} ] } ] }, - - /** - * chrome.pageActions - */ { - namespace: "pageActions", - types: [], - functions: [ - { - name: "enableForTab", - type: "function", - description: "", - parameters: [ - {type: "string", name: "pageActionId"}, + "namespace": "pageActions", + "types": [], + "functions": [ + { + "name": "enableForTab", + "type": "function", + "description": "", + "parameters": [ + {"type": "string", "name": "pageActionId"}, { - type: "object", - name: "action", - properties: { - tabId: {type: "integer", minimum: 0}, - url: {type: "string"}, - title: {type: "string", optional: true}, - iconId: {type: "integer", minimum: 0, optional: true} + "type": "object", + "name": "action", + "properties": { + "tabId": {"type": "integer", "minimum": 0}, + "url": {"type": "string"}, + "title": {"type": "string", "optional": true}, + "iconId": {"type": "integer", "minimum": 0, "optional": true} }, - optional: false + "optional": false } ] }, { - name: "disableForTab", - type: "function", - description: "", - parameters: [ - {type: "string", name: "pageActionId"}, + "name": "disableForTab", + "type": "function", + "description": "", + "parameters": [ + {"type": "string", "name": "pageActionId"}, { - type: "object", - name: "action", - properties: { - tabId: {type: "integer", minimum: 0}, - url: {type: "string"} + "type": "object", + "name": "action", + "properties": { + "tabId": {"type": "integer", "minimum": 0}, + "url": {"type": "string"} }, - optional: false + "optional": false } ] } ], - events: [ + "events": [ ] }, - - /** - * chrome.bookmarks - */ { - namespace: "bookmarks", - types: [], - functions: [ - { - name: "get", - type: "function", - description: "", - parameters: [ + "namespace": "bookmarks", + "types": [], + "functions": [ + { + "name": "get", + "type": "function", + "description": "", + "parameters": [ { - name: "idOrIdList", - choice : [ - {type: "string"}, - {type: "array", items: {type: "string"}, minItems: 1} + "name": "idOrIdList", + "choice": [ + {"type": "string"}, + {"type": "array", "items": {"type": "string"}, "minItems": 1} ] }, - {type: "function", name: "callback"} + {"type": "function", "name": "callback"} ] }, { - name: "getChildren", - type: "function", - description: "", - parameters: [ - {type: "string", name: "id"}, - {type: "function", name: "callback"} + "name": "getChildren", + "type": "function", + "description": "", + "parameters": [ + {"type": "string", "name": "id"}, + {"type": "function", "name": "callback"} ] }, { - name: "getTree", - type: "function", - description: "", - parameters: [ - {type: "function", name: "callback"} + "name": "getTree", + "type": "function", + "description": "", + "parameters": [ + {"type": "function", "name": "callback"} ] }, { - name: "search", - type: "function", - description: "", - parameters: [ - {type: "string", name: "query"}, - {type: "function", name: "callback"} + "name": "search", + "type": "function", + "description": "", + "parameters": [ + {"type": "string", "name": "query"}, + {"type": "function", "name": "callback"} ] }, { - name: "create", - type: "function", - description: "", - parameters: [ + "name": "create", + "type": "function", + "description": "", + "parameters": [ { - type: "object", - name: "bookmark", - properties: { - parentId: {type: "string"}, - index: {type: "integer", minimum: 0, optional: true}, - title: {type: "string", optional: true}, - url: {type: "string", optional: true}, + "type": "object", + "name": "bookmark", + "properties": { + "parentId": {"type": "string"}, + "index": {"type": "integer", "minimum": 0, "optional": true}, + "title": {"type": "string", "optional": true}, + "url": {"type": "string", "optional": true} } }, - {type: "function", name: "callback", optional: true} + {"type": "function", "name": "callback", "optional": true} ] }, { - name: "move", - type: "function", - description: "", - parameters: [ - {type: "string", name: "id"}, + "name": "move", + "type": "function", + "description": "", + "parameters": [ + {"type": "string", "name": "id"}, { - type: "object", - name: "destination", - properties: { - parentId: {type: "string"}, - index: {type: "integer", minimum: 0, optional: true} + "type": "object", + "name": "destination", + "properties": { + "parentId": {"type": "string"}, + "index": {"type": "integer", "minimum": 0, "optional": true} } }, - {type: "function", name: "callback", optional: true} + {"type": "function", "name": "callback", "optional": true} ] }, { - name: "update", - type: "function", - description: "", - parameters: [ - {type: "string", name: "id"}, + "name": "update", + "type": "function", + "description": "", + "parameters": [ + {"type": "string", "name": "id"}, { - type: "object", - name: "changes", - properties: { - title: {type: "string", optional: true} + "type": "object", + "name": "changes", + "properties": { + "title": {"type": "string", "optional": true} } }, - {type: "function", name: "callback", optional: true} + {"type": "function", "name": "callback", "optional": true} ] }, { - name: "remove", - type: "function", - description: "", - parameters: [ - {type: "string", name: "id"}, - {type: "function", name: "callback", optional: true} + "name": "remove", + "type": "function", + "description": "", + "parameters": [ + {"type": "string", "name": "id"}, + {"type": "function", "name": "callback", "optional": true} ] }, { - name: "removeTree", - type: "function", - description: "", - parameters: [ - {type: "string", name: "id"}, - {type: "function", name: "callback", optional: true} + "name": "removeTree", + "type": "function", + "description": "", + "parameters": [ + {"type": "string", "name": "id"}, + {"type": "function", "name": "callback", "optional": true} ] - }, + } ], - events: [ + "events": [ { - name: "onAdded", - type: "function", - description: "", - parameters: [ - {type: "string", name: "id"}, + "name": "onAdded", + "type": "function", + "description": "", + "parameters": [ + {"type": "string", "name": "id"}, { - type: "object", - name: "bookmark", + "type": "object", + "name": "bookmark" } ] }, { - name: "onRemoved", - type: "function", - description: "", - parameters: [ - {type: "string", name: "id"}, + "name": "onRemoved", + "type": "function", + "description": "", + "parameters": [ + {"type": "string", "name": "id"}, { - type: "object", - name: "RemoveInfo", + "type": "object", + "name": "RemoveInfo" } ] }, { - name: "onChanged", - type: "function", - description: "", - parameters: [ - {type: "string", name: "id"}, + "name": "onChanged", + "type": "function", + "description": "", + "parameters": [ + {"type": "string", "name": "id"}, { - type: "object", - name: "ChangeInfo", + "type": "object", + "name": "ChangeInfo" } ] }, { - name: "onMoved", - type: "function", - description: "", - parameters: [ - {type: "string", name: "id"}, + "name": "onMoved", + "type": "function", + "description": "", + "parameters": [ + {"type": "string", "name": "id"}, { - type: "object", - name: "MoveInfo", + "type": "object", + "name": "MoveInfo" } ] }, { - name: "onChildrenReordered", - type: "function", - description: "", - parameters: [ - {type: "string", name: "id"}, + "name": "onChildrenReordered", + "type": "function", + "description": "", + "parameters": [ + {"type": "string", "name": "id"}, { - type: "object", - name: "childIds", + "type": "object", + "name": "childIds" } ] } ] }, - - /** - * chrome.toolstrip - */ { - namespace: "toolstrip", - types: [], - functions: [ + "namespace": "toolstrip", + "types": [], + "functions": [ { - name: "expand", - type: "function", - description: "", - parameters: [ - {type: "integer", name: "height", minimum: 0}, - {type: "string", name: "url", optional: true}, - {type: "function", name: "callback", optional: true} + "name": "expand", + "type": "function", + "description": "", + "parameters": [ + {"type": "integer", "name": "height", "minimum": 0}, + {"type": "string", "name": "url", "optional": true}, + {"type": "function", "name": "callback", "optional": true} ] }, { - name: "collapse", - type: "function", - description: "", - parameters: [ - {type: "string", name: "url", optional: true}, - {type: "function", name: "callback", optional: true} + "name": "collapse", + "type": "function", + "description": "", + "parameters": [ + {"type": "string", "name": "url", "optional": true}, + {"type": "function", "name": "callback", "optional": true} ] } ], - events: [ - ] + "events": [] } ] diff --git a/chrome/common/extensions/docs/README.txt b/chrome/common/extensions/docs/README.txt new file mode 100755 index 0000000..13681ff --- /dev/null +++ b/chrome/common/extensions/docs/README.txt @@ -0,0 +1,49 @@ +This directory contains the chromium extensions documentation, and the mechanism +by which they are generated. + +-------------------------------------------------------------------------------- +Building + +Changes to the extension docs must be checked into source control. Any changes +to any input sources require the docs to be regenerated. + +To build the extension docs, run the build.py script in the ./build directory. +This will regenerate the docs and report which, if any, files have changed +and need to be included in the changelist that changed the dependent files. + +Note that the build.py script depends on test_shell to run, so in you must be +able to build test_shell to build extension_docs. The build.py script will +look in typically locations for the test_shell executable, but you may set +the path to test_shell explicitly with --test-shell-path. + +-------------------------------------------------------------------------------- +Design + +I. Inputs + +There are two sources of input: + +1) The contents of ../api/extension_api.json +which contains the "IDL" of the the methods, events, and types of the api. This +file is linked as a resource into the chromium binary and then dynamically +bound to chrome.* objects that are exposed to extension contexts. This file +is fed into the api docs template. It contains both name, type information as +well as documentation contained in "description" properties. + +2) The set of ./static/*.html documents. Each of these static html fragments is +inserted into a common template and rendered into ./*.html. + +II. Processing + +The processing of each document page is as follows: + +For each given <page>: +1) A copy of ./page_shell.html is copied to ./<page>.html. +2) This page loads bootstrap.js which inspects the <page> name +3) ./template/api_template.html is loaded and inserted into the body of the page +4) If a ./static/<page>.html exists, it's content is inserted into the main +content column of the api_template.html +5) If the <page> matches an api "module" in extension_api.json, the api is then +fed through the api template within api_template.html +6) The result is writen ontop of the existing /<page>.html. If the new file +differs in content, it is reported as changed by the build.py script. diff --git a/chrome/common/extensions/docs/api_index.html b/chrome/common/extensions/docs/api_index.html index faf8a37..151556f 100755 --- a/chrome/common/extensions/docs/api_index.html +++ b/chrome/common/extensions/docs/api_index.html @@ -1,46 +1 @@ -<!DOCTYPE html> -<!-- This page is a placeholder for generated extensions api doc. Note: - 1) The <head> information in this page is significant, should be uniform - across api docs and should be edited only with knowledge of the - templating mechanism. - 2) The <body> tag *must* retain id="body" - 3) All <body>.innerHTML is genereated as an rendering step. If viewed in a - browser, it will be re-generated from the template, json schema and - authored overview content. - 4) The <body>.innerHTML is also generated by an offline step so that this - page may easily be indexed by search engines. - - TODO(rafaelw): Abstract this into a "pageshell" that becomes the single - version of page template shell and the "instance" pages (bookmarks.html, - etc...) can be generated with a build step. ---> -<!-- <html> must retain id="template --> -<html xmlns="http://www.w3.org/1999/xhtml"> - <!-- <head> data is significant and loads the needed libraries and styles --> - <head> - <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> - <title jscontent="pageTitle">pageTitle</title> - <link href="css/ApiRefStyles.css" rel="stylesheet" type="text/css"> - <script type="text/javascript" - src="../../../third_party/jstemplate/jstemplate_compiled.js"> - </script> - <script type="text/javascript" src="js/api_page_generator.js"></script> - <script> -// Re-render the page if the user-agent is chrome and it is being served as -// a file:/// scheme. This allows both the initial render to static as well -// as dynamic re-rendering for developers/doc-writers working on local changes. -window.onload = function() { - var chrome = navigator.userAgent.indexOf("Chrome") > -1; - var fileScheme = location.protocol == "file:"; - var regenerate = chrome && fileScheme; - //if (regenerate) { - window.renderPage(); - //} -} - </script> - </head> - <!-- <body> content is completely generated. Do not edit, as it will be - and rewritten. --> - <body class="hidden"> - </body> -</html> +<!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc. Note: 1) The <head> information in this page is significant, should be uniform across api docs and should be edited only with knowledge of the templating mechanism. 2) The <body> tag *must* retain id="body" 3) All <body>.innerHTML is genereated as an rendering step. If viewed in a browser, it will be re-generated from the template, json schema and authored overview content. 4) The <body>.innerHTML is also generated by an offline step so that this page may easily be indexed by search engines. TODO(rafaelw): Abstract this into a "pageshell" that becomes the single version of page template shell and the "instance" pages (bookmarks.html, etc...) can be generated with a build step. --><!-- <html> must retain id="template --><html xmlns="http://www.w3.org/1999/xhtml" jstcache="0"><!-- <head> data is significant and loads the needed libraries and styles --><head jstcache="0"> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" jstcache="0"> <title jscontent="pageTitle" jstcache="1">api_index</title> <link href="css/ApiRefStyles.css" rel="stylesheet" type="text/css" jstcache="0"> <script type="text/javascript" src="../../../third_party/jstemplate/jstemplate_compiled.js" jstcache="0"> </script> <script type="text/javascript" src="js/api_page_generator.js" jstcache="0"></script> <script type="text/javascript" src="js/bootstrap.js" jstcache="0"></script> </head><!-- <body> content is completely generated. Do not edit, as it will be and rewritten. --><body class="" jstcache="0"> <div id="container" jstcache="0"> <a name="top" jstcache="0"> </a> <!-- API HEADER --> <div id="pageHeader" jstcache="0"> <!-- BREADCRUMB --> <!-- TODO: Fix these hrefs --> <div id="breadcrumbs" jstcache="0"> <a href="index.html" jstcache="0">Google Chrome Extensions</a> > <a href="reference_index.html" jstcache="0">Reference</a> > <a href="api_index.html" jstcache="0">chrome.* APIs</a> > <span jscontent="namespace" jstcache="2">null</span> </div> <div id="searchbox" jstcache="0"> <form action="http://www.google.com/cse" id="cse-search-box" jstcache="0"> <div jstcache="0"> <input type="hidden" name="cx" value="002967670403910741006:61_cvzfqtno" jstcache="0"> <input type="hidden" name="ie" value="UTF-8" jstcache="0"> <input type="text" name="q" size="31" jstcache="0"> <input type="submit" name="sa" value="Search" jstcache="0"> </div> </form> <script type="text/javascript" src="http://www.google.com/jsapi" jstcache="0"></script> <script type="text/javascript" jstcache="0">google.load("elements", "1", {packages: "transliteration"});</script> <script type="text/javascript" src="http://www.google.com/coop/cse/t13n?form=cse-search-box&t13n_langs=en" jstcache="0"></script> <script type="text/javascript" src="http://www.google.com/coop/cse/brand?form=cse-search-box&lang=en" jstcache="0"></script> </div> <div id="pageTitle" jstcache="0"> <h1 jscontent="h1Header" jstcache="3">api_index</h1> </div> </div> <!-- /pageHeader --> <div id="pageContent" jstcache="0"> <!-- SIDENAV --> <div id="leftNav" jstcache="0"> <ul jstcache="0"> <li jstcache="0"> <a href="overview.html" jstcache="0">Overview</a></li> <li jstcache="0"> <a href="getstarted.html" jstcache="0">Get Started</a></li> <li jstcache="0"> <a href="devguide.html" jstcache="0">Developer's Guide</a></li> <li jstcache="0"> Reference <ul jstcache="0"> <li jstcache="0"> <a href="api_index.html" jstcache="0">Extension APIs</a> <ul jstcache="0"> <li jsselect="apiModules" jstcache="18" jsinstance="0"> <a jscontent="name" jsvalues=".href:module + '.html'" jstcache="25" href="bookmarks.html">Bookmarks</a> </li><li jsselect="apiModules" jstcache="18" jsinstance="1"> <a jscontent="name" jsvalues=".href:module + '.html'" jstcache="25" href="toolstrip.html">Toolstrip</a> </li><li jsselect="apiModules" jstcache="18" jsinstance="2"> <a jscontent="name" jsvalues=".href:module + '.html'" jstcache="25" href="pageActions.html">PageActions</a> </li><li jsselect="apiModules" jstcache="18" jsinstance="3"> <a jscontent="name" jsvalues=".href:module + '.html'" jstcache="25" href="windows.html">Windows</a> </li><li jsselect="apiModules" jstcache="18" jsinstance="4"> <a jscontent="name" jsvalues=".href:module + '.html'" jstcache="25" href="tabs.html">Tabs</a> </li><li jsselect="apiModules" jstcache="18" jsinstance="*5"> <a jscontent="name" jsvalues=".href:module + '.html'" jstcache="25" href="self.html">Self</a> </li> </ul> </li> </ul> </li> </ul> </div> <div id="mainColumn" jstcache="0"> <!-- TABLE OF CONTENTS --> <div id="toc" jsselect="apiDefinition" jstcache="4" style="display: none; "> <p jstcache="0">Contents</p> <ol jstcache="0"> <li jstcache="0"> <a href="#overview" jstcache="0">Description</a> <ol jstcache="0"> <li jstcache="0"><a href="#overview-properties" jstcache="0">Properties</a></li> <li jstcache="0"><a href="#overview-examples" jstcache="0">Examples</a></li> </ol> </li> <li jstcache="0"> <a href="#methods" jstcache="0">Methods</a> <ol jstcache="0"> <li jsselect="functions" jstcache="5"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-anchor" jstcache="19">methodName</a> </li> </ol> </li> <li jstcache="0"> <a href="#events" jstcache="0">Events</a> <ol jstcache="0"> <li jsselect="events" jstcache="6"> <a jscontent="name" jsvalues=".href:'#event-' + name" href="#event-anchor" jstcache="20">eventName</a> </li> </ol> </li> <!-- TODO: What do we do about structs/types? --> <li jstcache="0"> <a href="#structs" jstcache="0">TODO: Structs</a> <ol jstcache="0"> <li jstcache="0"><a href="#struct-BookmarkTreeNode" jstcache="0"></a></li> </ol> </li> </ol> [PENDING: links to all h2s and h3s should go here -- would it be possible to link to overview h3s, as well? if so, how should we create their anchor/id values?] </div> <!-- /TABLE OF CONTENTS --> <!-- STATIC CONTENT PLACEHOLDER --> <div id="static" jstcache="0"><p jstcache="0"> [PENDING: links to reference doc — for example, <a href="chrome-api-index.html" jstcache="0">chrome.* APIs</a> — go here.] </p> <p jstcache="0"> Lorem ipsum dolor sit amet, consectetur adipiscing elit. Fusce sed elit felis. Vestibulum porta mauris eget mi placerat a condimentum leo semper. Ut scelerisque, ipsum in cursus semper, lectus enim molestie ante, a porttitor dolor neque sit amet lorem. Integer dignissim gravida eros ac rhoncus. Curabitur porttitor hendrerit dolor nec aliquam. Ut vulputate ultrices eros eu ultrices. Pellentesque tempor mattis odio in blandit. Proin nulla metus, tristique eget iaculis gravida, varius at leo. Ut dolor mi, auctor et scelerisque vitae, volutpat eleifend magna. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Morbi ut risus nec massa consectetur accumsan sed non est. Fusce ornare eros et felis dignissim convallis. Maecenas condimentum purus eget nisl condimentum vitae ornare diam sollicitudin. Nulla et dictum ante. In lacus odio, dapibus vel faucibus at, posuere id enim. Nulla tincidunt felis id lectus convallis vulputate. Phasellus libero dui, posuere sollicitudin egestas eget, blandit in urna. Sed cursus tellus sed diam hendrerit pulvinar. </p> <p jstcache="0"> Nam tincidunt mollis aliquam. Suspendisse bibendum dignissim dui, ac mollis ligula fringilla sit amet. Pellentesque dapibus lobortis dignissim. Cras eu lorem a ligula imperdiet ultricies. Phasellus ipsum mi, accumsan quis dignissim eu, commodo ut mi. Nulla sagittis aliquet malesuada. Ut lobortis tellus vitae dolor venenatis eu ullamcorper lorem gravida. Quisque non pharetra velit. Maecenas elit risus, ultricies in sagittis eget, facilisis sed neque. Quisque feugiat porta pharetra. Vestibulum lorem magna, pellentesque et mattis sit amet, euismod et dui. </p></div> <!-- API PAGE --> <div class="apiPage" jsselect="apiDefinition" jstcache="4" style="display: none; "> <!-- METHODS --> <div class="apiGroup" id="methods" jstcache="0"> <a name="#methods" jstcache="0"></a> <h2 jstcache="0">Methods</h2> <!-- iterates over all functions --> <div class="apiItem" jsselect="functions" jstcache="5"> <a jsvalues=".name:'method-' + name" jstcache="7"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="8">method name</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="returns.typeName" jstcache="10">void</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="fullName" jstcache="11">chrome.module.methodName</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="12"><span jsdisplay="$index" jstcache="21">, </span><span jscontent="typeName" jstcache="22"></span> <var jstcache="0"><span jscontent="name" jstcache="8"></span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="13">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="14"> A description from the json schema def of the function goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="23"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="15">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="24"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var> <em jstcache="0">(<span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> <!-- CALLBACK --> <div jsdisplay="callbackParameters" jstcache="16"> <h4 jstcache="0">Callback function</h4> <p jstcache="0"> If you specify the <em jstcache="0">callback</em> parameter, it should specify a function that looks like this: </p> <!-- Note: intentionally longer 80 columns --> <pre jstcache="0">function(<span jscontent="callbackSignature" jstcache="29">Type param1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="callbackParameters" jstcache="30"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> </div> </div> <!-- /description --> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> <!-- EVENTS --> <div class="apiGroup" id="events" jstcache="0"> <a name="#events" jstcache="0"></a> <h2 id="events" jstcache="0">Events</h2> <!-- iterates over all events --> <div jsselect="events" class="apiItem" jstcache="6"> <a jsvalues=".name:'event-' + name" jstcache="9"></a> <h3 jscontent="name" jstcache="8">event name</h3> <div class="summary" jstcache="0"> <!-- Note: intentionally longer 80 columns --> <span class="subdued" jstcache="0">chrome.bookmarks.</span><span jscontent="name" jstcache="8">onEvent</span><span class="subdued" jstcache="0">.addListener</span>(function(<span jscontent="callSignature" jstcache="17">Type param1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>); </div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="13">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="14"> A description from the json schema def of the event goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="23"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26">Undocumented.</dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> </div> <!-- /decription --> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> </div> <!-- /apiPage --> </div> <!-- /mainColumn --> </div> <!-- /pageContent --> <div id="pageFooter" --="" jstcache="0"> Copyright 2009 <br jstcache="0"> TBD: copyright/license should be automatically included here </div> <!-- /pageFooter --> </div> <!-- /container --> </body></html>
diff --git a/chrome/common/extensions/docs/bookmarks.html b/chrome/common/extensions/docs/bookmarks.html index faf8a37..bf08320 100755 --- a/chrome/common/extensions/docs/bookmarks.html +++ b/chrome/common/extensions/docs/bookmarks.html @@ -1,46 +1 @@ -<!DOCTYPE html> -<!-- This page is a placeholder for generated extensions api doc. Note: - 1) The <head> information in this page is significant, should be uniform - across api docs and should be edited only with knowledge of the - templating mechanism. - 2) The <body> tag *must* retain id="body" - 3) All <body>.innerHTML is genereated as an rendering step. If viewed in a - browser, it will be re-generated from the template, json schema and - authored overview content. - 4) The <body>.innerHTML is also generated by an offline step so that this - page may easily be indexed by search engines. - - TODO(rafaelw): Abstract this into a "pageshell" that becomes the single - version of page template shell and the "instance" pages (bookmarks.html, - etc...) can be generated with a build step. ---> -<!-- <html> must retain id="template --> -<html xmlns="http://www.w3.org/1999/xhtml"> - <!-- <head> data is significant and loads the needed libraries and styles --> - <head> - <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> - <title jscontent="pageTitle">pageTitle</title> - <link href="css/ApiRefStyles.css" rel="stylesheet" type="text/css"> - <script type="text/javascript" - src="../../../third_party/jstemplate/jstemplate_compiled.js"> - </script> - <script type="text/javascript" src="js/api_page_generator.js"></script> - <script> -// Re-render the page if the user-agent is chrome and it is being served as -// a file:/// scheme. This allows both the initial render to static as well -// as dynamic re-rendering for developers/doc-writers working on local changes. -window.onload = function() { - var chrome = navigator.userAgent.indexOf("Chrome") > -1; - var fileScheme = location.protocol == "file:"; - var regenerate = chrome && fileScheme; - //if (regenerate) { - window.renderPage(); - //} -} - </script> - </head> - <!-- <body> content is completely generated. Do not edit, as it will be - and rewritten. --> - <body class="hidden"> - </body> -</html> +<!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc. Note: 1) The <head> information in this page is significant, should be uniform across api docs and should be edited only with knowledge of the templating mechanism. 2) The <body> tag *must* retain id="body" 3) All <body>.innerHTML is genereated as an rendering step. If viewed in a browser, it will be re-generated from the template, json schema and authored overview content. 4) The <body>.innerHTML is also generated by an offline step so that this page may easily be indexed by search engines. TODO(rafaelw): Abstract this into a "pageshell" that becomes the single version of page template shell and the "instance" pages (bookmarks.html, etc...) can be generated with a build step. --><!-- <html> must retain id="template --><html xmlns="http://www.w3.org/1999/xhtml" jstcache="0"><!-- <head> data is significant and loads the needed libraries and styles --><head jstcache="0"> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" jstcache="0"> <title jscontent="pageTitle" jstcache="1">chrome.bookmarks API Reference</title> <link href="css/ApiRefStyles.css" rel="stylesheet" type="text/css" jstcache="0"> <script type="text/javascript" src="../../../third_party/jstemplate/jstemplate_compiled.js" jstcache="0"> </script> <script type="text/javascript" src="js/api_page_generator.js" jstcache="0"></script> <script type="text/javascript" src="js/bootstrap.js" jstcache="0"></script> </head><!-- <body> content is completely generated. Do not edit, as it will be and rewritten. --><body class="" jstcache="0"> <div id="container" jstcache="0"> <a name="top" jstcache="0"> </a> <!-- API HEADER --> <div id="pageHeader" jstcache="0"> <!-- BREADCRUMB --> <!-- TODO: Fix these hrefs --> <div id="breadcrumbs" jstcache="0"> <a href="index.html" jstcache="0">Google Chrome Extensions</a> > <a href="reference_index.html" jstcache="0">Reference</a> > <a href="api_index.html" jstcache="0">chrome.* APIs</a> > <span jscontent="namespace" jstcache="2">null</span> </div> <div id="searchbox" jstcache="0"> <form action="http://www.google.com/cse" id="cse-search-box" jstcache="0"> <div jstcache="0"> <input type="hidden" name="cx" value="002967670403910741006:61_cvzfqtno" jstcache="0"> <input type="hidden" name="ie" value="UTF-8" jstcache="0"> <input type="text" name="q" size="31" jstcache="0"> <input type="submit" name="sa" value="Search" jstcache="0"> </div> </form> <script type="text/javascript" src="http://www.google.com/jsapi" jstcache="0"></script> <script type="text/javascript" jstcache="0">google.load("elements", "1", {packages: "transliteration"});</script> <script type="text/javascript" src="http://www.google.com/coop/cse/t13n?form=cse-search-box&t13n_langs=en" jstcache="0"></script> <script type="text/javascript" src="http://www.google.com/coop/cse/brand?form=cse-search-box&lang=en" jstcache="0"></script> </div> <div id="pageTitle" jstcache="0"> <h1 jscontent="h1Header" jstcache="3">chrome.bookmarks</h1> </div> </div> <!-- /pageHeader --> <div id="pageContent" jstcache="0"> <!-- SIDENAV --> <div id="leftNav" jstcache="0"> <ul jstcache="0"> <li jstcache="0"> <a href="overview.html" jstcache="0">Overview</a></li> <li jstcache="0"> <a href="getstarted.html" jstcache="0">Get Started</a></li> <li jstcache="0"> <a href="devguide.html" jstcache="0">Developer's Guide</a></li> <li jstcache="0"> Reference <ul jstcache="0"> <li jstcache="0"> <a href="api_index.html" jstcache="0">Extension APIs</a> <ul jstcache="0"> <li jsselect="apiModules" jstcache="18" jsinstance="0"> <a jscontent="name" jsvalues=".href:module + '.html'" jstcache="25" href="bookmarks.html">Bookmarks</a> </li><li jsselect="apiModules" jstcache="18" jsinstance="1"> <a jscontent="name" jsvalues=".href:module + '.html'" jstcache="25" href="toolstrip.html">Toolstrip</a> </li><li jsselect="apiModules" jstcache="18" jsinstance="2"> <a jscontent="name" jsvalues=".href:module + '.html'" jstcache="25" href="pageActions.html">PageActions</a> </li><li jsselect="apiModules" jstcache="18" jsinstance="3"> <a jscontent="name" jsvalues=".href:module + '.html'" jstcache="25" href="windows.html">Windows</a> </li><li jsselect="apiModules" jstcache="18" jsinstance="4"> <a jscontent="name" jsvalues=".href:module + '.html'" jstcache="25" href="tabs.html">Tabs</a> </li><li jsselect="apiModules" jstcache="18" jsinstance="*5"> <a jscontent="name" jsvalues=".href:module + '.html'" jstcache="25" href="self.html">Self</a> </li> </ul> </li> </ul> </li> </ul> </div> <div id="mainColumn" jstcache="0"> <!-- TABLE OF CONTENTS --> <div id="toc" jsselect="apiDefinition" jstcache="4"> <p jstcache="0">Contents</p> <ol jstcache="0"> <li jstcache="0"> <a href="#overview" jstcache="0">Description</a> <ol jstcache="0"> <li jstcache="0"><a href="#overview-properties" jstcache="0">Properties</a></li> <li jstcache="0"><a href="#overview-examples" jstcache="0">Examples</a></li> </ol> </li> <li jstcache="0"> <a href="#methods" jstcache="0">Methods</a> <ol jstcache="0"> <li jsselect="functions" jstcache="5" jsinstance="0"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-get" jstcache="19">get</a> </li><li jsselect="functions" jstcache="5" jsinstance="1"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-getChildren" jstcache="19">getChildren</a> </li><li jsselect="functions" jstcache="5" jsinstance="2"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-getTree" jstcache="19">getTree</a> </li><li jsselect="functions" jstcache="5" jsinstance="3"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-search" jstcache="19">search</a> </li><li jsselect="functions" jstcache="5" jsinstance="4"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-create" jstcache="19">create</a> </li><li jsselect="functions" jstcache="5" jsinstance="5"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-move" jstcache="19">move</a> </li><li jsselect="functions" jstcache="5" jsinstance="6"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-update" jstcache="19">update</a> </li><li jsselect="functions" jstcache="5" jsinstance="7"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-remove" jstcache="19">remove</a> </li><li jsselect="functions" jstcache="5" jsinstance="*8"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-removeTree" jstcache="19">removeTree</a> </li> </ol> </li> <li jstcache="0"> <a href="#events" jstcache="0">Events</a> <ol jstcache="0"> <li jsselect="events" jstcache="6" jsinstance="0"> <a jscontent="name" jsvalues=".href:'#event-' + name" href="#event-onAdded" jstcache="20">onAdded</a> </li><li jsselect="events" jstcache="6" jsinstance="1"> <a jscontent="name" jsvalues=".href:'#event-' + name" href="#event-onRemoved" jstcache="20">onRemoved</a> </li><li jsselect="events" jstcache="6" jsinstance="2"> <a jscontent="name" jsvalues=".href:'#event-' + name" href="#event-onChanged" jstcache="20">onChanged</a> </li><li jsselect="events" jstcache="6" jsinstance="3"> <a jscontent="name" jsvalues=".href:'#event-' + name" href="#event-onMoved" jstcache="20">onMoved</a> </li><li jsselect="events" jstcache="6" jsinstance="*4"> <a jscontent="name" jsvalues=".href:'#event-' + name" href="#event-onChildrenReordered" jstcache="20">onChildrenReordered</a> </li> </ol> </li> <!-- TODO: What do we do about structs/types? --> <li jstcache="0"> <a href="#structs" jstcache="0">TODO: Structs</a> <ol jstcache="0"> <li jstcache="0"><a href="#struct-BookmarkTreeNode" jstcache="0"></a></li> </ol> </li> </ol> [PENDING: links to all h2s and h3s should go here -- would it be possible to link to overview h3s, as well? if so, how should we create their anchor/id values?] </div> <!-- /TABLE OF CONTENTS --> <!-- STATIC CONTENT PLACEHOLDER --> <div id="static" jstcache="0"><!-- BEGIN AUTHORED CONTENT --> <p id="classSummary" jstcache="0"> Use the <code jstcache="0">chrome.bookmarks</code> API to create, organize, and otherwise manipulate bookmarks. </p> <h2 id="description" jstcache="0">Description</h2> <p jstcache="0"> [PENDING: intro goes here...] </p> <p jstcache="0"> <em jstcache="0">Bookmark objects</em> are an important part of the <code jstcache="0">chrome.bookmarks</code> API. Each bookmark object represents either a URL or a group of bookmarks, as you can see in the following figure. </p> <img alt="2 kinds of bookmark objects" width="415" height="123" src="images/bookmarks.png" jstcache="0"> <h3 id="overview-properties" jstcache="0">Properties</h3> <p jstcache="0">Objects that represent bookmarks can have the following properties: </p> <dl jstcache="0"> <dt jstcache="0"> <code jstcache="0">id</code> </dt> <dd jstcache="0"> An integer ID that's unique for each bookmark. Don't save this ID in persistent storage; the ID for a particular bookmark might change the next time the browser is started. </dd> <dt jstcache="0"> <code jstcache="0">title</code> </dt> <dd jstcache="0"> The name of the bookmark. This is the user-visible string that describes the URL or group. </dd> <dt jstcache="0"> <code jstcache="0">parentId </code> <em jstcache="0">(omitted for the root group)</em> </dt> <dd jstcache="0"> The ID of the group that this bookmark is in. </dd> <dt jstcache="0"> <code jstcache="0">index</code> <em jstcache="0">(optional; omitted for the root group)</em> </dt> <dd jstcache="0"> The 0-based integer position of the bookmark within its group. </dd> <dt jstcache="0"> <code jstcache="0">url</code> <em jstcache="0">(omitted for groups)</em> </dt> <dd jstcache="0"> The URL of the page that the bookmark points to. </dd> </dl> <h3 id="overview-examples" jstcache="0">Examples</h3> <p jstcache="0"> The following code creates a bookmark group with the title "Chromium bookmarks". The last argument defines a function to be executed after the folder is created. </p> <pre jstcache="0">chrome.bookmarks.create({'parentId': bookmarkBar.id, 'title': 'Chromium bookmarks'}, function(newFolder) {...}); </pre> <p jstcache="0"> The next snippet creates a bookmark pointing to the Chromium developer doc. Since nothing too bad will happen if creating the bookmark fails, this snippet doesn't bother to define a callback function. </p> <pre jstcache="0">chrome.bookmarks.create({'parentId': chromiumBookmarks.id, 'title': 'dev doc', 'url': 'http://dev.chromium.org'}); </pre> <p jstcache="0"> Say you have bookmark hierarchy that looks like this:</p> <ul jstcache="0"> <li jstcache="0">Bookmarks</li> <ul jstcache="0"> <li jstcache="0">Google</li> <ul jstcache="0"> <li jstcache="0">Apps</li> <ul jstcache="0"> <li jstcache="0">...</li> <li jstcache="0">...</li> <li jstcache="0">...</li> </ul> <li jstcache="0">Google homepage</li> </ul> <li jstcache="0">Example</li> </ul> </ul> <p jstcache="0"> Here's how those bookmarks might be represented with bookmark objects:</p> <img alt="a hierarchy of bookmarks" width="522" height="594" src="images/bookmark-hierarchy.png" jstcache="0"> <p jstcache="0"> Here's some code you could use to create that hierarchy:</p> <pre class="example" jstcache="0">...code goes here... </pre> <div class="exampleLink" jstcache="0"> <a href="http://www.google.com/url?q=http%3A%2F%2Fexample.com&sa=D&sntz=1&usg=AFrqEzd0oeJ1qGwYPoKuq1dTesEchMDLIQ" jstcache="0">Full source code</a> | <a href="http://www.google.com/url?q=http%3A%2F%2Fexample.com&sa=D&sntz=1&usg=AFrqEzd0oeJ1qGwYPoKuq1dTesEchMDLIQ" jstcache="0">Install extension</a> </div> <!-- END exampleLink --> <!-- END AUTHORED CONTENT --> </div> <!-- API PAGE --> <div class="apiPage" jsselect="apiDefinition" jstcache="4"> <!-- METHODS --> <div class="apiGroup" id="methods" jstcache="0"> <a name="#methods" jstcache="0"></a> <h2 jstcache="0">Methods</h2> <!-- iterates over all functions --> <div class="apiItem" jsselect="functions" jstcache="5" jsinstance="0"> <a jsvalues=".name:'method-' + name" jstcache="7" name="method-get"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="8">get</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="returns.typeName" jstcache="10" style="display: none; ">void</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="fullName" jstcache="11">chrome.bookmarks.get</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="12" jsinstance="0" class="null"><span jsdisplay="$index" jstcache="21" style="display: none; ">, </span><span jscontent="typeName" jstcache="22">string or array of string</span> <var jstcache="0"><span jscontent="name" jstcache="8">idOrIdList</span></var></span><span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="12" jsinstance="*1" class="null"><span jsdisplay="$index" jstcache="21">, </span><span jscontent="typeName" jstcache="22">function</span> <var jstcache="0"><span jscontent="name" jstcache="8">callback</span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="13">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="14" style="display: none; "> A description from the json schema def of the function goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="23" jsinstance="0"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">idOrIdList</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31" style="display: none; ">optional </span><span jscontent="typeName" jstcache="22">string or array of string</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28" style="display: none; "> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div><div jsselect="parameters" jstcache="23" jsinstance="*1"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">callback</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31" style="display: none; ">optional </span><span jscontent="typeName" jstcache="22">function</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28" style="display: none; "> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="15" style="display: none; ">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="24" style="display: none; "> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var> <em jstcache="0">(<span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> <!-- CALLBACK --> <div jsdisplay="callbackParameters" jstcache="16" style="display: none; "> <h4 jstcache="0">Callback function</h4> <p jstcache="0"> If you specify the <em jstcache="0">callback</em> parameter, it should specify a function that looks like this: </p> <!-- Note: intentionally longer 80 columns --> <pre jstcache="0">function(<span jscontent="callbackSignature" jstcache="29">Type param1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="callbackParameters" jstcache="30"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> </div> </div> <!-- /description --> </div><div class="apiItem" jsselect="functions" jstcache="5" jsinstance="1"> <a jsvalues=".name:'method-' + name" jstcache="7" name="method-getChildren"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="8">getChildren</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="returns.typeName" jstcache="10" style="display: none; ">void</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="fullName" jstcache="11">chrome.bookmarks.getChildren</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="12" jsinstance="0" class="null"><span jsdisplay="$index" jstcache="21" style="display: none; ">, </span><span jscontent="typeName" jstcache="22">string</span> <var jstcache="0"><span jscontent="name" jstcache="8">id</span></var></span><span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="12" jsinstance="*1" class="null"><span jsdisplay="$index" jstcache="21">, </span><span jscontent="typeName" jstcache="22">function</span> <var jstcache="0"><span jscontent="name" jstcache="8">callback</span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="13">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="14" style="display: none; "> A description from the json schema def of the function goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="23" jsinstance="0"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">id</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31" style="display: none; ">optional </span><span jscontent="typeName" jstcache="22">string</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28" style="display: none; "> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div><div jsselect="parameters" jstcache="23" jsinstance="*1"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">callback</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31" style="display: none; ">optional </span><span jscontent="typeName" jstcache="22">function</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28" style="display: none; "> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="15" style="display: none; ">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="24" style="display: none; "> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var> <em jstcache="0">(<span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> <!-- CALLBACK --> <div jsdisplay="callbackParameters" jstcache="16" style="display: none; "> <h4 jstcache="0">Callback function</h4> <p jstcache="0"> If you specify the <em jstcache="0">callback</em> parameter, it should specify a function that looks like this: </p> <!-- Note: intentionally longer 80 columns --> <pre jstcache="0">function(<span jscontent="callbackSignature" jstcache="29">Type param1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="callbackParameters" jstcache="30"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> </div> </div> <!-- /description --> </div><div class="apiItem" jsselect="functions" jstcache="5" jsinstance="2"> <a jsvalues=".name:'method-' + name" jstcache="7" name="method-getTree"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="8">getTree</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="returns.typeName" jstcache="10" style="display: none; ">void</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="fullName" jstcache="11">chrome.bookmarks.getTree</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="12" jsinstance="*0" class="null"><span jsdisplay="$index" jstcache="21" style="display: none; ">, </span><span jscontent="typeName" jstcache="22">function</span> <var jstcache="0"><span jscontent="name" jstcache="8">callback</span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="13">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="14" style="display: none; "> A description from the json schema def of the function goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="23" jsinstance="*0"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">callback</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31" style="display: none; ">optional </span><span jscontent="typeName" jstcache="22">function</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28" style="display: none; "> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="15" style="display: none; ">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="24" style="display: none; "> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var> <em jstcache="0">(<span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> <!-- CALLBACK --> <div jsdisplay="callbackParameters" jstcache="16" style="display: none; "> <h4 jstcache="0">Callback function</h4> <p jstcache="0"> If you specify the <em jstcache="0">callback</em> parameter, it should specify a function that looks like this: </p> <!-- Note: intentionally longer 80 columns --> <pre jstcache="0">function(<span jscontent="callbackSignature" jstcache="29">Type param1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="callbackParameters" jstcache="30"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> </div> </div> <!-- /description --> </div><div class="apiItem" jsselect="functions" jstcache="5" jsinstance="3"> <a jsvalues=".name:'method-' + name" jstcache="7" name="method-search"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="8">search</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="returns.typeName" jstcache="10" style="display: none; ">void</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="fullName" jstcache="11">chrome.bookmarks.search</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="12" jsinstance="0" class="null"><span jsdisplay="$index" jstcache="21" style="display: none; ">, </span><span jscontent="typeName" jstcache="22">string</span> <var jstcache="0"><span jscontent="name" jstcache="8">query</span></var></span><span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="12" jsinstance="*1" class="null"><span jsdisplay="$index" jstcache="21">, </span><span jscontent="typeName" jstcache="22">function</span> <var jstcache="0"><span jscontent="name" jstcache="8">callback</span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="13">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="14" style="display: none; "> A description from the json schema def of the function goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="23" jsinstance="0"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">query</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31" style="display: none; ">optional </span><span jscontent="typeName" jstcache="22">string</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28" style="display: none; "> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div><div jsselect="parameters" jstcache="23" jsinstance="*1"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">callback</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31" style="display: none; ">optional </span><span jscontent="typeName" jstcache="22">function</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28" style="display: none; "> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="15" style="display: none; ">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="24" style="display: none; "> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var> <em jstcache="0">(<span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> <!-- CALLBACK --> <div jsdisplay="callbackParameters" jstcache="16" style="display: none; "> <h4 jstcache="0">Callback function</h4> <p jstcache="0"> If you specify the <em jstcache="0">callback</em> parameter, it should specify a function that looks like this: </p> <!-- Note: intentionally longer 80 columns --> <pre jstcache="0">function(<span jscontent="callbackSignature" jstcache="29">Type param1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="callbackParameters" jstcache="30"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> </div> </div> <!-- /description --> </div><div class="apiItem" jsselect="functions" jstcache="5" jsinstance="4"> <a jsvalues=".name:'method-' + name" jstcache="7" name="method-create"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="8">create</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="returns.typeName" jstcache="10" style="display: none; ">void</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="fullName" jstcache="11">chrome.bookmarks.create</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="12" jsinstance="0" class="null"><span jsdisplay="$index" jstcache="21" style="display: none; ">, </span><span jscontent="typeName" jstcache="22">object</span> <var jstcache="0"><span jscontent="name" jstcache="8">bookmark</span></var></span><span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="12" jsinstance="*1" class="optional"><span jsdisplay="$index" jstcache="21">, </span><span jscontent="typeName" jstcache="22">function</span> <var jstcache="0"><span jscontent="name" jstcache="8">callback</span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="13">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="14" style="display: none; "> A description from the json schema def of the function goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="23" jsinstance="0"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">bookmark</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31" style="display: none; ">optional </span><span jscontent="typeName" jstcache="22">object</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32" jsinstance="0"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">parentId</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31" style="display: none; ">optional </span><span jscontent="typeName" jstcache="22">string</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> </div><div jsselect="_propertyList" jstcache="32" jsinstance="1"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">index</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">integer</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> </div><div jsselect="_propertyList" jstcache="32" jsinstance="2"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">title</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">string</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> </div><div jsselect="_propertyList" jstcache="32" jsinstance="*3"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">url</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">string</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div><div jsselect="parameters" jstcache="23" jsinstance="*1"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">callback</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">function</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28" style="display: none; "> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="15" style="display: none; ">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="24" style="display: none; "> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var> <em jstcache="0">(<span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> <!-- CALLBACK --> <div jsdisplay="callbackParameters" jstcache="16" style="display: none; "> <h4 jstcache="0">Callback function</h4> <p jstcache="0"> If you specify the <em jstcache="0">callback</em> parameter, it should specify a function that looks like this: </p> <!-- Note: intentionally longer 80 columns --> <pre jstcache="0">function(<span jscontent="callbackSignature" jstcache="29">Type param1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="callbackParameters" jstcache="30"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> </div> </div> <!-- /description --> </div><div class="apiItem" jsselect="functions" jstcache="5" jsinstance="5"> <a jsvalues=".name:'method-' + name" jstcache="7" name="method-move"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="8">move</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="returns.typeName" jstcache="10" style="display: none; ">void</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="fullName" jstcache="11">chrome.bookmarks.move</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="12" jsinstance="0" class="null"><span jsdisplay="$index" jstcache="21" style="display: none; ">, </span><span jscontent="typeName" jstcache="22">string</span> <var jstcache="0"><span jscontent="name" jstcache="8">id</span></var></span><span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="12" jsinstance="1" class="null"><span jsdisplay="$index" jstcache="21">, </span><span jscontent="typeName" jstcache="22">object</span> <var jstcache="0"><span jscontent="name" jstcache="8">destination</span></var></span><span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="12" jsinstance="*2" class="optional"><span jsdisplay="$index" jstcache="21">, </span><span jscontent="typeName" jstcache="22">function</span> <var jstcache="0"><span jscontent="name" jstcache="8">callback</span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="13">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="14" style="display: none; "> A description from the json schema def of the function goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="23" jsinstance="0"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">id</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31" style="display: none; ">optional </span><span jscontent="typeName" jstcache="22">string</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28" style="display: none; "> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div><div jsselect="parameters" jstcache="23" jsinstance="1"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">destination</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31" style="display: none; ">optional </span><span jscontent="typeName" jstcache="22">object</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32" jsinstance="0"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">parentId</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31" style="display: none; ">optional </span><span jscontent="typeName" jstcache="22">string</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> </div><div jsselect="_propertyList" jstcache="32" jsinstance="*1"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">index</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">integer</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div><div jsselect="parameters" jstcache="23" jsinstance="*2"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">callback</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">function</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28" style="display: none; "> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="15" style="display: none; ">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="24" style="display: none; "> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var> <em jstcache="0">(<span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> <!-- CALLBACK --> <div jsdisplay="callbackParameters" jstcache="16" style="display: none; "> <h4 jstcache="0">Callback function</h4> <p jstcache="0"> If you specify the <em jstcache="0">callback</em> parameter, it should specify a function that looks like this: </p> <!-- Note: intentionally longer 80 columns --> <pre jstcache="0">function(<span jscontent="callbackSignature" jstcache="29">Type param1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="callbackParameters" jstcache="30"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> </div> </div> <!-- /description --> </div><div class="apiItem" jsselect="functions" jstcache="5" jsinstance="6"> <a jsvalues=".name:'method-' + name" jstcache="7" name="method-update"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="8">update</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="returns.typeName" jstcache="10" style="display: none; ">void</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="fullName" jstcache="11">chrome.bookmarks.update</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="12" jsinstance="0" class="null"><span jsdisplay="$index" jstcache="21" style="display: none; ">, </span><span jscontent="typeName" jstcache="22">string</span> <var jstcache="0"><span jscontent="name" jstcache="8">id</span></var></span><span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="12" jsinstance="1" class="null"><span jsdisplay="$index" jstcache="21">, </span><span jscontent="typeName" jstcache="22">object</span> <var jstcache="0"><span jscontent="name" jstcache="8">changes</span></var></span><span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="12" jsinstance="*2" class="optional"><span jsdisplay="$index" jstcache="21">, </span><span jscontent="typeName" jstcache="22">function</span> <var jstcache="0"><span jscontent="name" jstcache="8">callback</span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="13">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="14" style="display: none; "> A description from the json schema def of the function goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="23" jsinstance="0"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">id</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31" style="display: none; ">optional </span><span jscontent="typeName" jstcache="22">string</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28" style="display: none; "> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div><div jsselect="parameters" jstcache="23" jsinstance="1"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">changes</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31" style="display: none; ">optional </span><span jscontent="typeName" jstcache="22">object</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32" jsinstance="*0"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">title</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">string</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div><div jsselect="parameters" jstcache="23" jsinstance="*2"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">callback</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">function</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28" style="display: none; "> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="15" style="display: none; ">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="24" style="display: none; "> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var> <em jstcache="0">(<span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> <!-- CALLBACK --> <div jsdisplay="callbackParameters" jstcache="16" style="display: none; "> <h4 jstcache="0">Callback function</h4> <p jstcache="0"> If you specify the <em jstcache="0">callback</em> parameter, it should specify a function that looks like this: </p> <!-- Note: intentionally longer 80 columns --> <pre jstcache="0">function(<span jscontent="callbackSignature" jstcache="29">Type param1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="callbackParameters" jstcache="30"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> </div> </div> <!-- /description --> </div><div class="apiItem" jsselect="functions" jstcache="5" jsinstance="7"> <a jsvalues=".name:'method-' + name" jstcache="7" name="method-remove"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="8">remove</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="returns.typeName" jstcache="10" style="display: none; ">void</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="fullName" jstcache="11">chrome.bookmarks.remove</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="12" jsinstance="0" class="null"><span jsdisplay="$index" jstcache="21" style="display: none; ">, </span><span jscontent="typeName" jstcache="22">string</span> <var jstcache="0"><span jscontent="name" jstcache="8">id</span></var></span><span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="12" jsinstance="*1" class="optional"><span jsdisplay="$index" jstcache="21">, </span><span jscontent="typeName" jstcache="22">function</span> <var jstcache="0"><span jscontent="name" jstcache="8">callback</span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="13">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="14" style="display: none; "> A description from the json schema def of the function goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="23" jsinstance="0"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">id</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31" style="display: none; ">optional </span><span jscontent="typeName" jstcache="22">string</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28" style="display: none; "> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div><div jsselect="parameters" jstcache="23" jsinstance="*1"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">callback</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">function</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28" style="display: none; "> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="15" style="display: none; ">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="24" style="display: none; "> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var> <em jstcache="0">(<span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> <!-- CALLBACK --> <div jsdisplay="callbackParameters" jstcache="16" style="display: none; "> <h4 jstcache="0">Callback function</h4> <p jstcache="0"> If you specify the <em jstcache="0">callback</em> parameter, it should specify a function that looks like this: </p> <!-- Note: intentionally longer 80 columns --> <pre jstcache="0">function(<span jscontent="callbackSignature" jstcache="29">Type param1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="callbackParameters" jstcache="30"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> </div> </div> <!-- /description --> </div><div class="apiItem" jsselect="functions" jstcache="5" jsinstance="*8"> <a jsvalues=".name:'method-' + name" jstcache="7" name="method-removeTree"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="8">removeTree</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="returns.typeName" jstcache="10" style="display: none; ">void</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="fullName" jstcache="11">chrome.bookmarks.removeTree</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="12" jsinstance="0" class="null"><span jsdisplay="$index" jstcache="21" style="display: none; ">, </span><span jscontent="typeName" jstcache="22">string</span> <var jstcache="0"><span jscontent="name" jstcache="8">id</span></var></span><span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="12" jsinstance="*1" class="optional"><span jsdisplay="$index" jstcache="21">, </span><span jscontent="typeName" jstcache="22">function</span> <var jstcache="0"><span jscontent="name" jstcache="8">callback</span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="13">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="14" style="display: none; "> A description from the json schema def of the function goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="23" jsinstance="0"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">id</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31" style="display: none; ">optional </span><span jscontent="typeName" jstcache="22">string</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28" style="display: none; "> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div><div jsselect="parameters" jstcache="23" jsinstance="*1"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">callback</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">function</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28" style="display: none; "> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="15" style="display: none; ">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="24" style="display: none; "> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var> <em jstcache="0">(<span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> <!-- CALLBACK --> <div jsdisplay="callbackParameters" jstcache="16" style="display: none; "> <h4 jstcache="0">Callback function</h4> <p jstcache="0"> If you specify the <em jstcache="0">callback</em> parameter, it should specify a function that looks like this: </p> <!-- Note: intentionally longer 80 columns --> <pre jstcache="0">function(<span jscontent="callbackSignature" jstcache="29">Type param1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="callbackParameters" jstcache="30"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> </div> </div> <!-- /description --> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> <!-- EVENTS --> <div class="apiGroup" id="events" jstcache="0"> <a name="#events" jstcache="0"></a> <h2 id="events" jstcache="0">Events</h2> <!-- iterates over all events --> <div jsselect="events" class="apiItem" jstcache="6" jsinstance="0"> <a jsvalues=".name:'event-' + name" jstcache="9" name="event-onAdded"></a> <h3 jscontent="name" jstcache="8">onAdded</h3> <div class="summary" jstcache="0"> <!-- Note: intentionally longer 80 columns --> <span class="subdued" jstcache="0">chrome.bookmarks.</span><span jscontent="name" jstcache="8">onAdded</span><span class="subdued" jstcache="0">.addListener</span>(function(<span jscontent="callSignature" jstcache="17">string id, object bookmark</span>) <span class="subdued" jstcache="0">{...}</span>); </div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="13">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="14" style="display: none; "> A description from the json schema def of the event goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="23" jsinstance="0"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">id</var><em jstcache="0"> (<span jscontent="typeName" jstcache="22">string</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26">Undocumented.</dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28" style="display: none; "> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div><div jsselect="parameters" jstcache="23" jsinstance="*1"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">bookmark</var><em jstcache="0"> (<span jscontent="typeName" jstcache="22">object</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26">Undocumented.</dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28" style="display: none; "> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> </div> <!-- /decription --> </div><div jsselect="events" class="apiItem" jstcache="6" jsinstance="1"> <a jsvalues=".name:'event-' + name" jstcache="9" name="event-onRemoved"></a> <h3 jscontent="name" jstcache="8">onRemoved</h3> <div class="summary" jstcache="0"> <!-- Note: intentionally longer 80 columns --> <span class="subdued" jstcache="0">chrome.bookmarks.</span><span jscontent="name" jstcache="8">onRemoved</span><span class="subdued" jstcache="0">.addListener</span>(function(<span jscontent="callSignature" jstcache="17">string id, object RemoveInfo</span>) <span class="subdued" jstcache="0">{...}</span>); </div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="13">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="14" style="display: none; "> A description from the json schema def of the event goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="23" jsinstance="0"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">id</var><em jstcache="0"> (<span jscontent="typeName" jstcache="22">string</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26">Undocumented.</dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28" style="display: none; "> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div><div jsselect="parameters" jstcache="23" jsinstance="*1"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">RemoveInfo</var><em jstcache="0"> (<span jscontent="typeName" jstcache="22">object</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26">Undocumented.</dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28" style="display: none; "> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> </div> <!-- /decription --> </div><div jsselect="events" class="apiItem" jstcache="6" jsinstance="2"> <a jsvalues=".name:'event-' + name" jstcache="9" name="event-onChanged"></a> <h3 jscontent="name" jstcache="8">onChanged</h3> <div class="summary" jstcache="0"> <!-- Note: intentionally longer 80 columns --> <span class="subdued" jstcache="0">chrome.bookmarks.</span><span jscontent="name" jstcache="8">onChanged</span><span class="subdued" jstcache="0">.addListener</span>(function(<span jscontent="callSignature" jstcache="17">string id, object ChangeInfo</span>) <span class="subdued" jstcache="0">{...}</span>); </div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="13">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="14" style="display: none; "> A description from the json schema def of the event goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="23" jsinstance="0"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">id</var><em jstcache="0"> (<span jscontent="typeName" jstcache="22">string</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26">Undocumented.</dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28" style="display: none; "> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div><div jsselect="parameters" jstcache="23" jsinstance="*1"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">ChangeInfo</var><em jstcache="0"> (<span jscontent="typeName" jstcache="22">object</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26">Undocumented.</dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28" style="display: none; "> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> </div> <!-- /decription --> </div><div jsselect="events" class="apiItem" jstcache="6" jsinstance="3"> <a jsvalues=".name:'event-' + name" jstcache="9" name="event-onMoved"></a> <h3 jscontent="name" jstcache="8">onMoved</h3> <div class="summary" jstcache="0"> <!-- Note: intentionally longer 80 columns --> <span class="subdued" jstcache="0">chrome.bookmarks.</span><span jscontent="name" jstcache="8">onMoved</span><span class="subdued" jstcache="0">.addListener</span>(function(<span jscontent="callSignature" jstcache="17">string id, object MoveInfo</span>) <span class="subdued" jstcache="0">{...}</span>); </div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="13">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="14" style="display: none; "> A description from the json schema def of the event goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="23" jsinstance="0"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">id</var><em jstcache="0"> (<span jscontent="typeName" jstcache="22">string</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26">Undocumented.</dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28" style="display: none; "> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div><div jsselect="parameters" jstcache="23" jsinstance="*1"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">MoveInfo</var><em jstcache="0"> (<span jscontent="typeName" jstcache="22">object</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26">Undocumented.</dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28" style="display: none; "> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> </div> <!-- /decription --> </div><div jsselect="events" class="apiItem" jstcache="6" jsinstance="*4"> <a jsvalues=".name:'event-' + name" jstcache="9" name="event-onChildrenReordered"></a> <h3 jscontent="name" jstcache="8">onChildrenReordered</h3> <div class="summary" jstcache="0"> <!-- Note: intentionally longer 80 columns --> <span class="subdued" jstcache="0">chrome.bookmarks.</span><span jscontent="name" jstcache="8">onChildrenReordered</span><span class="subdued" jstcache="0">.addListener</span>(function(<span jscontent="callSignature" jstcache="17">string id, object childIds</span>) <span class="subdued" jstcache="0">{...}</span>); </div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="13">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="14" style="display: none; "> A description from the json schema def of the event goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="23" jsinstance="0"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">id</var><em jstcache="0"> (<span jscontent="typeName" jstcache="22">string</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26">Undocumented.</dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28" style="display: none; "> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div><div jsselect="parameters" jstcache="23" jsinstance="*1"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">childIds</var><em jstcache="0"> (<span jscontent="typeName" jstcache="22">object</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26">Undocumented.</dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28" style="display: none; "> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> </div> <!-- /decription --> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> </div> <!-- /apiPage --> </div> <!-- /mainColumn --> </div> <!-- /pageContent --> <div id="pageFooter" --="" jstcache="0"> Copyright 2009 <br jstcache="0"> TBD: copyright/license should be automatically included here </div> <!-- /pageFooter --> </div> <!-- /container --> </body></html>
diff --git a/chrome/common/extensions/docs/build/build.py b/chrome/common/extensions/docs/build/build.py new file mode 100755 index 0000000..be822f9 --- /dev/null +++ b/chrome/common/extensions/docs/build/build.py @@ -0,0 +1,163 @@ +#!/usr/bin/python +# Copyright (c) 2009 The Chromium Authors. All rights reserved. +# Use of this source code is governed by a BSD-style license that can be +# found in the LICENSE file. + +"""Docbuilder for extension docs.""" + +import os +import os.path +import shutil +import sys + +from subprocess import Popen, PIPE +from optparse import OptionParser + +_script_path = os.path.realpath(__file__) +_build_dir = os.path.dirname(_script_path) +_base_dir = os.path.normpath(_build_dir + "/..") +_static_dir = _base_dir + "/static" +_js_dir = _base_dir + "/js" +_template_dir = _base_dir + "/template" +_extension_api_dir = os.path.normpath(_base_dir + "/../api") + +_extension_api_json = _extension_api_dir + "/extension_api.json" +_api_template_html = _template_dir + "/api_template.html" +_page_shell_html = _template_dir + "/page_shell.html" +_generator_html = _build_dir + "/generator.html" + +_expected_output_preamble = "<!DOCTYPE html>" + +# HACK! This is required because we can only depend on python 2.4 and +# the calling environment may not be setup to set the PYTHONPATH +sys.path.append(os.path.normpath(_base_dir + + "/../../../../third_party")) +import simplejson as json + +def RenderPage(name, test_shell): + """ + Calls test_shell --layout-tests .../generator.html?<name> and writes the + result to .../docs/<name>.html + """ + + if not name: + raise Exception("RenderPage called with empty name"); + + generator_url = _generator_html + "?" + name + input_file = _base_dir + "/" + name + ".html" + + # Copy page_shell to destination output and move aside original, if it exists. + original = None; + if (os.path.isfile(input_file)): + original = open(input_file, 'r').read() + os.remove(input_file) + + shutil.copy(_page_shell_html, input_file) + + # Run test_shell and capture result + p = Popen([test_shell, "--layout-tests", generator_url], shell=True, + stdout=PIPE) + + # first output line is url that was processed by test_shell + p.stdout.readline() + + # second output line is the layoutTestShell.dumpText() value. + result = p.stdout.readline() + + # Remove page_shell + os.remove(input_file) + + if (not result.startswith(_expected_output_preamble)): + if (original): + open(input_file).write(original); + raise Exception("test_shell returned unexpected output: " + result); + + # Write output + open(input_file, 'w').write(result); + if (original and result == original): + return None + else: + return input_file + +def FindTestShell(): + # This is hackey. It is used to guess the location of the test_shell + chrome_dir = os.path.normpath(_base_dir + "/../../../") + src_dir = os.path.normpath(chrome_dir + "/../") + + search_locations = [] + + if (sys.platform in ('cygwin', 'win32')): + search_locations.append(chrome_dir + "/Debug/test_shell.exe") + search_locations.append(chrome_dir + "/Release/test_shell.exe") + + if (sys.platform in ('linux', 'linux2')): + search_locations.append(src_dir + "/sconsbuild/Debug/test_shell") + search_locations.append(src_dir + "/out/Debug/test_shell") + search_locations.append(src_dir + "/sconsbuild/Release/test_shell") + search_locations.append(src_dir + "/out/Release/test_shell") + + if (sys.platform == 'darwin'): + search_locations.append(src_dir + + "/xcodebuild/Debug/TestShell.app/Contents/MacOS/TestShell") + search_locations.append(src_dir + + "/xcodebuild/Release/TestShell.app/Contents/MacOS/TestShell") + + for loc in search_locations: + if os.path.isfile(loc): + return loc + + raise Exception ("Could not find test_shell executable\n" + + "**test_shell may need to be built**\n" + + "Searched: \n" + "\n".join(search_locations) + "\n" + + "To specify a path to test_shell use --test-shell-path") + +def GetAPIModuleNames(): + contents = open(_extension_api_json, 'r').read(); + extension_api = json.loads(contents, encoding="ASCII") + return set( module['namespace'].encode() for module in extension_api) + +def GetStaticFileNames(): + static_files = os.listdir(_static_dir) + return set(os.path.splitext(file)[0] + for file in static_files + if file.endswith(".html")) + +def main(): + parser = OptionParser() + parser.add_option("--test-shell-path", dest="test_shell_path") + (options, args) = parser.parse_args() + + if (options.test_shell_path and os.path.isfile(options.test_shell_path)): + test_shell = options.test_shell_path + else: + test_shell = FindTestShell() + + # Read static file names + static_names = GetStaticFileNames() + + # Read module names + module_names = GetAPIModuleNames() + + # All pages to generate + page_names = static_names | module_names + + modified_files = [] + for page in page_names: + modified_file = RenderPage(page, test_shell) + if (modified_file): + modified_files.append(modified_file) + + if (len(modified_files) == 0): + print "Output files match existing files. No changes made." + else: + print ("ATTENTION: EXTENSION DOCS HAVE CHANGED\n" + + "The following files have been modified and should be checked\n" + + "into source control (ideally in the same changelist as the\n" + + "underlying files that resulting in their changing).") + for f in modified_files: + print f; + + return 0; + +if __name__ == '__main__': + sys.exit(main())
\ No newline at end of file diff --git a/chrome/common/extensions/docs/build/generator.html b/chrome/common/extensions/docs/build/generator.html new file mode 100755 index 0000000..7e82e0e --- /dev/null +++ b/chrome/common/extensions/docs/build/generator.html @@ -0,0 +1,38 @@ +<html> + <head> + <script> +var childFrame; + +function generate() { + if (!window.layoutTestController) { + alert("window.layoutTestController not defined."); + return; + } + + layoutTestController.dumpAsText(); + layoutTestController.waitUntilDone(); + + var page = window.location.search.substring(1); + if (!page) { + alert("please specify which page to generate via " + + "?<page> ... ie. generator.html?tabs"); + } + + childFrame = document.createElement('iframe'); + childFrame.src = "../" + page + ".html?regenerate"; + childFrame.style.display = "none"; + document.body.appendChild(childFrame); +} + +function done() { + var textNode = document.createTextNode( + childFrame.contentWindow.serializePage()); + document.getElementsByTagName("body")[0].appendChild(textNode); + + layoutTestController.notifyDone(); +} + </script> + </head> + <body onload="generate();"> + </body> +</html>
\ No newline at end of file diff --git a/chrome/common/extensions/docs/content_scripts.html b/chrome/common/extensions/docs/content_scripts.html index faf8a37..9ff4f28 100755 --- a/chrome/common/extensions/docs/content_scripts.html +++ b/chrome/common/extensions/docs/content_scripts.html @@ -1,46 +1 @@ -<!DOCTYPE html> -<!-- This page is a placeholder for generated extensions api doc. Note: - 1) The <head> information in this page is significant, should be uniform - across api docs and should be edited only with knowledge of the - templating mechanism. - 2) The <body> tag *must* retain id="body" - 3) All <body>.innerHTML is genereated as an rendering step. If viewed in a - browser, it will be re-generated from the template, json schema and - authored overview content. - 4) The <body>.innerHTML is also generated by an offline step so that this - page may easily be indexed by search engines. - - TODO(rafaelw): Abstract this into a "pageshell" that becomes the single - version of page template shell and the "instance" pages (bookmarks.html, - etc...) can be generated with a build step. ---> -<!-- <html> must retain id="template --> -<html xmlns="http://www.w3.org/1999/xhtml"> - <!-- <head> data is significant and loads the needed libraries and styles --> - <head> - <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> - <title jscontent="pageTitle">pageTitle</title> - <link href="css/ApiRefStyles.css" rel="stylesheet" type="text/css"> - <script type="text/javascript" - src="../../../third_party/jstemplate/jstemplate_compiled.js"> - </script> - <script type="text/javascript" src="js/api_page_generator.js"></script> - <script> -// Re-render the page if the user-agent is chrome and it is being served as -// a file:/// scheme. This allows both the initial render to static as well -// as dynamic re-rendering for developers/doc-writers working on local changes. -window.onload = function() { - var chrome = navigator.userAgent.indexOf("Chrome") > -1; - var fileScheme = location.protocol == "file:"; - var regenerate = chrome && fileScheme; - //if (regenerate) { - window.renderPage(); - //} -} - </script> - </head> - <!-- <body> content is completely generated. Do not edit, as it will be - and rewritten. --> - <body class="hidden"> - </body> -</html> +<!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc. Note: 1) The <head> information in this page is significant, should be uniform across api docs and should be edited only with knowledge of the templating mechanism. 2) The <body> tag *must* retain id="body" 3) All <body>.innerHTML is genereated as an rendering step. If viewed in a browser, it will be re-generated from the template, json schema and authored overview content. 4) The <body>.innerHTML is also generated by an offline step so that this page may easily be indexed by search engines. TODO(rafaelw): Abstract this into a "pageshell" that becomes the single version of page template shell and the "instance" pages (bookmarks.html, etc...) can be generated with a build step. --><!-- <html> must retain id="template --><html xmlns="http://www.w3.org/1999/xhtml" jstcache="0"><!-- <head> data is significant and loads the needed libraries and styles --><head jstcache="0"> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" jstcache="0"> <title jscontent="pageTitle" jstcache="1">content_scripts</title> <link href="css/ApiRefStyles.css" rel="stylesheet" type="text/css" jstcache="0"> <script type="text/javascript" src="../../../third_party/jstemplate/jstemplate_compiled.js" jstcache="0"> </script> <script type="text/javascript" src="js/api_page_generator.js" jstcache="0"></script> <script type="text/javascript" src="js/bootstrap.js" jstcache="0"></script> </head><!-- <body> content is completely generated. Do not edit, as it will be and rewritten. --><body class="" jstcache="0"> <div id="container" jstcache="0"> <a name="top" jstcache="0"> </a> <!-- API HEADER --> <div id="pageHeader" jstcache="0"> <!-- BREADCRUMB --> <!-- TODO: Fix these hrefs --> <div id="breadcrumbs" jstcache="0"> <a href="index.html" jstcache="0">Google Chrome Extensions</a> > <a href="reference_index.html" jstcache="0">Reference</a> > <a href="api_index.html" jstcache="0">chrome.* APIs</a> > <span jscontent="namespace" jstcache="2">null</span> </div> <div id="searchbox" jstcache="0"> <form action="http://www.google.com/cse" id="cse-search-box" jstcache="0"> <div jstcache="0"> <input type="hidden" name="cx" value="002967670403910741006:61_cvzfqtno" jstcache="0"> <input type="hidden" name="ie" value="UTF-8" jstcache="0"> <input type="text" name="q" size="31" jstcache="0"> <input type="submit" name="sa" value="Search" jstcache="0"> </div> </form> <script type="text/javascript" src="http://www.google.com/jsapi" jstcache="0"></script> <script type="text/javascript" jstcache="0">google.load("elements", "1", {packages: "transliteration"});</script> <script type="text/javascript" src="http://www.google.com/coop/cse/t13n?form=cse-search-box&t13n_langs=en" jstcache="0"></script> <script type="text/javascript" src="http://www.google.com/coop/cse/brand?form=cse-search-box&lang=en" jstcache="0"></script> </div> <div id="pageTitle" jstcache="0"> <h1 jscontent="h1Header" jstcache="3">content_scripts</h1> </div> </div> <!-- /pageHeader --> <div id="pageContent" jstcache="0"> <!-- SIDENAV --> <div id="leftNav" jstcache="0"> <ul jstcache="0"> <li jstcache="0"> <a href="overview.html" jstcache="0">Overview</a></li> <li jstcache="0"> <a href="getstarted.html" jstcache="0">Get Started</a></li> <li jstcache="0"> <a href="devguide.html" jstcache="0">Developer's Guide</a></li> <li jstcache="0"> Reference <ul jstcache="0"> <li jstcache="0"> <a href="api_index.html" jstcache="0">Extension APIs</a> <ul jstcache="0"> <li jsselect="apiModules" jstcache="18" jsinstance="0"> <a jscontent="name" jsvalues=".href:module + '.html'" jstcache="25" href="bookmarks.html">Bookmarks</a> </li><li jsselect="apiModules" jstcache="18" jsinstance="1"> <a jscontent="name" jsvalues=".href:module + '.html'" jstcache="25" href="toolstrip.html">Toolstrip</a> </li><li jsselect="apiModules" jstcache="18" jsinstance="2"> <a jscontent="name" jsvalues=".href:module + '.html'" jstcache="25" href="pageActions.html">PageActions</a> </li><li jsselect="apiModules" jstcache="18" jsinstance="3"> <a jscontent="name" jsvalues=".href:module + '.html'" jstcache="25" href="windows.html">Windows</a> </li><li jsselect="apiModules" jstcache="18" jsinstance="4"> <a jscontent="name" jsvalues=".href:module + '.html'" jstcache="25" href="tabs.html">Tabs</a> </li><li jsselect="apiModules" jstcache="18" jsinstance="*5"> <a jscontent="name" jsvalues=".href:module + '.html'" jstcache="25" href="self.html">Self</a> </li> </ul> </li> </ul> </li> </ul> </div> <div id="mainColumn" jstcache="0"> <!-- TABLE OF CONTENTS --> <div id="toc" jsselect="apiDefinition" jstcache="4" style="display: none; "> <p jstcache="0">Contents</p> <ol jstcache="0"> <li jstcache="0"> <a href="#overview" jstcache="0">Description</a> <ol jstcache="0"> <li jstcache="0"><a href="#overview-properties" jstcache="0">Properties</a></li> <li jstcache="0"><a href="#overview-examples" jstcache="0">Examples</a></li> </ol> </li> <li jstcache="0"> <a href="#methods" jstcache="0">Methods</a> <ol jstcache="0"> <li jsselect="functions" jstcache="5"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-anchor" jstcache="19">methodName</a> </li> </ol> </li> <li jstcache="0"> <a href="#events" jstcache="0">Events</a> <ol jstcache="0"> <li jsselect="events" jstcache="6"> <a jscontent="name" jsvalues=".href:'#event-' + name" href="#event-anchor" jstcache="20">eventName</a> </li> </ol> </li> <!-- TODO: What do we do about structs/types? --> <li jstcache="0"> <a href="#structs" jstcache="0">TODO: Structs</a> <ol jstcache="0"> <li jstcache="0"><a href="#struct-BookmarkTreeNode" jstcache="0"></a></li> </ol> </li> </ol> [PENDING: links to all h2s and h3s should go here -- would it be possible to link to overview h3s, as well? if so, how should we create their anchor/id values?] </div> <!-- /TABLE OF CONTENTS --> <!-- STATIC CONTENT PLACEHOLDER --> <div id="static" jstcache="0"><p jstcache="0">Content Scripts are JavaScript files that run in the context of web pages. By using the standard <a href="http://www.w3.org/TR/DOM-Level-2-HTML/" jstcache="0">Document Object Model</a> (DOM), they can read details of the web pages the browser visits, or make changes to them. </p><p jstcache="0">Some examples of things that content scripts can do include: </p><ul jstcache="0"> <li jstcache="0">Find unlinked URLs in web pages and convert them into hyperlinks </li><li jstcache="0">Increase the font size to make text more legible </li><li jstcache="0">Find and process <a href="http://microformats.org/" jstcache="0">microformat</a> data in the DOM </li></ul> <h3 id="registration" jstcache="0">Registration</h3> <p jstcache="0">Content scripts are registered in an extension's <a href="manifest.html" jstcache="0">manifest.json</a> file, like so: </p><pre jstcache="0">{ "name": "My First Extension", "version": "1.0", "description": "The first extension that I made.", <span style="background:yellow; font-weight:bold;" jstcache="0"> "content_scripts": [ { "matches": ["http://www.google.com/*"], "css": ["mystyles.css"], "js": ["jquery.js", "myscript.js"] } ]</span> }</pre> <p jstcache="0">An extension can contain any number of content scripts, and a content script can consist of any number of JavaScript or CSS files. The value of the <code jstcache="0">matches</code> property controls when the content script will run. </p><p jstcache="0">Each content script registered in the manifest can specify the following properties:</p> <table jstcache="0"> <tbody jstcache="0"><tr jstcache="0"> <th jstcache="0">Name</th> <th jstcache="0">Type</th> <th jstcache="0">Description</th> </tr> <tr jstcache="0"> <td jstcache="0">matches</td> <td jstcache="0">array of strings</td> <td jstcache="0">Required. Controls the pages this content script will be injected into. See <a href="#match_patterns" jstcache="0">Match Patterns</a> for more details on the syntax of these strins.</td> </tr> <tr jstcache="0"> <td jstcache="0">js</td> <td jstcache="0"><nobr jstcache="0">array of strings</nobr></td> <td jstcache="0">Optional. The list of JavaScript files to be injected into matching pages. These are injected in the order they appear in this array.</td> </tr> <tr jstcache="0"> <td jstcache="0">css</td> <td jstcache="0">array of strings</td> <td jstcache="0">Optional. The list of CSS files to be injected into matching pages. These are injected in the order they appear in this array, before any DOM is constructed or displayed for the page.</td> </tr> <tr jstcache="0"> <td jstcache="0">run_at</td> <td jstcache="0">string</td> <td jstcache="0">Optional. Controls when the files in <code jstcache="0">js</code> are injected. Can be <code jstcache="0">"document_start"</code> or <code jstcache="0">"document_end"</code>. Defaults to <code jstcache="0">"document_end"</code>. In the case of <code jstcache="0">"document_start"</code>, the files are injected after any files from <code jstcache="0">"css"</code>, but before any other DOM is constructed or any other script is run. In the case of <code jstcache="0">"document_end"</code>, the files are injected after the DOM is complete, but before subresources like images and frames have necessarily loaded.</td> </tr> </tbody></table> <h3 id="match_patterns" jstcache="0">Match Patterns</h3> <p jstcache="0">TODO</p> <h3 id="execution_environment" jstcache="0">Execution Environment</h3> <p jstcache="0">Content scripts execute in a special environment called an <em jstcache="0">isolated world</em>. They have access to the DOM of the page they are injected into, but not to any JavaScript variables or functions created by the page. It looks to each content script as if there is no other JavaScript executing on the page it is running on. The same is true in reverse: JavaScript running on the page cannot call any functions or access any variables defined by content scripts. </p><p jstcache="0">For example, consider this simple page: </p><pre jstcache="0">hello.html =========== <html> <button id="button">click me</button> <script> var greeting = "hello!"; function sayGreeting() { alert(greeting); } document.getElementById("button").onclick = sayGreeting; </script> </html></pre> <p jstcache="0">Now, suppose this content script was injected into hello.html: </p><pre jstcache="0">contentscript.js ================== console.log(greeting); // undefined console.log(sayGreeting); // undefined console.log(document.getElementById("button").onclick); // still undefined document.getElementById("button").onclick = function() { alert("hola!"); }</pre> <p jstcache="0">Now, if the button is pressed, you will see both greetings. </p><p jstcache="0">Isolated worlds allow each content script to make changes to its JavaScript environment without worrying about conflicting with the page or with other contnet scripts. For example, a content script could include JQuery v1 and the page could include JQuery v2, and they wouldn't conflict with each other. </p><p jstcache="0">Another important benefit of isolated worlds is that they completely separate the JavaScript on the page from the JavaScript in extensions. This allows us to offer extra functionality to content scripts that should not be accessible from web pages without worrying about web pages accessing it. </p><h3 id="messaging" jstcache="0">Messaging</h3> <p jstcache="0">Content scripts can communicate with their parent extension using message passing. The content script opens a channel to the extension using the <a href="extension.html#connect" jstcache="0">chrome.extension.connect()</a> method and then sends messages back and forth to it. The messages can contain any valid JSON object (null, boolean, number, string, array, or object). </p><p jstcache="0">The parent extension can also open a channel to a content script in a given tab by calling <a href="tabs.html#connect" jstcache="0">chrome.tabs.connect(tabId)</a>. </p><p jstcache="0">When a channel is opened from a content script to an extension, the <a href="extension.html#onConnect" jstcache="0">onConnect</a> event is fired in all views in the extension. Any view can receive the event. The event contains a <a href="extension.html#port" jstcache="0">Port</a> object, which can be used by the extension view to communicate back to the content script. </p><p jstcache="0">[TODO: Complete this]</p></div> <!-- API PAGE --> <div class="apiPage" jsselect="apiDefinition" jstcache="4" style="display: none; "> <!-- METHODS --> <div class="apiGroup" id="methods" jstcache="0"> <a name="#methods" jstcache="0"></a> <h2 jstcache="0">Methods</h2> <!-- iterates over all functions --> <div class="apiItem" jsselect="functions" jstcache="5"> <a jsvalues=".name:'method-' + name" jstcache="7"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="8">method name</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="returns.typeName" jstcache="10">void</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="fullName" jstcache="11">chrome.module.methodName</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="12"><span jsdisplay="$index" jstcache="21">, </span><span jscontent="typeName" jstcache="22"></span> <var jstcache="0"><span jscontent="name" jstcache="8"></span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="13">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="14"> A description from the json schema def of the function goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="23"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="15">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="24"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var> <em jstcache="0">(<span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> <!-- CALLBACK --> <div jsdisplay="callbackParameters" jstcache="16"> <h4 jstcache="0">Callback function</h4> <p jstcache="0"> If you specify the <em jstcache="0">callback</em> parameter, it should specify a function that looks like this: </p> <!-- Note: intentionally longer 80 columns --> <pre jstcache="0">function(<span jscontent="callbackSignature" jstcache="29">Type param1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="callbackParameters" jstcache="30"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> </div> </div> <!-- /description --> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> <!-- EVENTS --> <div class="apiGroup" id="events" jstcache="0"> <a name="#events" jstcache="0"></a> <h2 id="events" jstcache="0">Events</h2> <!-- iterates over all events --> <div jsselect="events" class="apiItem" jstcache="6"> <a jsvalues=".name:'event-' + name" jstcache="9"></a> <h3 jscontent="name" jstcache="8">event name</h3> <div class="summary" jstcache="0"> <!-- Note: intentionally longer 80 columns --> <span class="subdued" jstcache="0">chrome.bookmarks.</span><span jscontent="name" jstcache="8">onEvent</span><span class="subdued" jstcache="0">.addListener</span>(function(<span jscontent="callSignature" jstcache="17">Type param1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>); </div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="13">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="14"> A description from the json schema def of the event goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="23"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26">Undocumented.</dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> </div> <!-- /decription --> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> </div> <!-- /apiPage --> </div> <!-- /mainColumn --> </div> <!-- /pageContent --> <div id="pageFooter" --="" jstcache="0"> Copyright 2009 <br jstcache="0"> TBD: copyright/license should be automatically included here </div> <!-- /pageFooter --> </div> <!-- /container --> </body></html>
diff --git a/chrome/common/extensions/docs/devguide.html b/chrome/common/extensions/docs/devguide.html index deb02cb..5987efe 100755 --- a/chrome/common/extensions/docs/devguide.html +++ b/chrome/common/extensions/docs/devguide.html @@ -1,142 +1 @@ -!DOCTYPE html> -<!-- This page is a placeholder for generated extensions api doc. Note: - 1) The <head> information in this page is significant, should be uniform - across api docs and should be edited only with knowledge of the - templating mechanism. - 2) The <body> tag *must* retain id="body" - 3) All <body>.innerHTML is genereated as an rendering step. If viewed in a - browser, it will be re-generated from the template, json schema and - authored overview content. - 4) The <body>.innerHTML is also generated by an offline step so that this - page may easily be indexed by search engines. - - TODO(rafaelw): Abstract this into a "pageshell" that becomes the single - version of page template shell and the "instance" pages (bookmarks.html, - etc...) can be generated with a build step. ---> -<!-- <html> must retain id="template --> -<html xmlns="http://www.w3.org/1999/xhtml"> - <!-- <head> data is significant and loads the needed libraries and styles --> - <head> - <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> - <title jscontent="pageTitle">pageTitle</title> - <link href="css/ApiRefStyles.css" rel="stylesheet" type="text/css"> - <script type="text/javascript" - src="../../../third_party/jstemplate/jstemplate_compiled.js"> - </script> - <script type="text/javascript" src="js/api_page_generator.js"></script> - <script> -// Re-render the page if the user-agent is chrome and it is being served as -// a file:/// scheme. This allows both the initial render to static as well -// as dynamic re-rendering for developers/doc-writers working on local changes. -window.onload = function() { - var chrome = navigator.userAgent.indexOf("Chrome") > -1; - var fileScheme = location.protocol == "file:"; - var regenerate = chrome && fileScheme; - //if (regenerate) { - window.renderPage(); - //} -} - </script> - </head> - <!-- <body> content is completely generated. Do not edit, as it will be - and rewritten. --> - <body class="hidden"> - </body> -</html> ->>>>>>> .merge-right.r22299 -======= -<!DOCTYPE html> -<!-- This page is a placeholder for generated extensions api doc. Note: - 1) The <head> information in this page is significant, should be uniform - across api docs and should be edited only with knowledge of the - templating mechanism. - 2) The <body> tag *must* retain id="body" - 3) All <body>.innerHTML is genereated as an rendering step. If viewed in a - browser, it will be re-generated from the template, json schema and - authored overview content. - 4) The <body>.innerHTML is also generated by an offline step so that this - page may easily be indexed by search engines. - - TODO(rafaelw): Abstract this into a "pageshell" that becomes the single - version of page template shell and the "instance" pages (bookmarks.html, - etc...) can be generated with a build step. ---> -<!-- <html> must retain id="template --> -<html xmlns="http://www.w3.org/1999/xhtml"> - <!-- <head> data is significant and loads the needed libraries and styles --> - <head> - <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> - <title jscontent="pageTitle">pageTitle</title> - <link href="css/ApiRefStyles.css" rel="stylesheet" type="text/css"> - <script type="text/javascript" - src="../../../third_party/jstemplate/jstemplate_compiled.js"> - </script> - <script type="text/javascript" src="js/api_page_generator.js"></script> - <script> -// Re-render the page if the user-agent is chrome and it is being served as -// a file:/// scheme. This allows both the initial render to static as well -// as dynamic re-rendering for developers/doc-writers working on local changes. -window.onload = function() { - var chrome = navigator.userAgent.indexOf("Chrome") > -1; - var fileScheme = location.protocol == "file:"; - var regenerate = chrome && fileScheme; - //if (regenerate) { - window.renderPage(); - //} -} - </script> - </head> - <!-- <body> content is completely generated. Do not edit, as it will be - and rewritten. --> - <body class="hidden"> - </body> -</html> ->>>>>>> .merge-right.r22299 -======= -<!DOCTYPE html> -<!-- This page is a placeholder for generated extensions api doc. Note: - 1) The <head> information in this page is significant, should be uniform - across api docs and should be edited only with knowledge of the - templating mechanism. - 2) The <body> tag *must* retain id="body" - 3) All <body>.innerHTML is genereated as an rendering step. If viewed in a - browser, it will be re-generated from the template, json schema and - authored overview content. - 4) The <body>.innerHTML is also generated by an offline step so that this - page may easily be indexed by search engines. - - TODO(rafaelw): Abstract this into a "pageshell" that becomes the single - version of page template shell and the "instance" pages (bookmarks.html, - etc...) can be generated with a build step. ---> -<!-- <html> must retain id="template --> -<html xmlns="http://www.w3.org/1999/xhtml"> - <!-- <head> data is significant and loads the needed libraries and styles --> - <head> - <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> - <title jscontent="pageTitle">pageTitle</title> - <link href="css/ApiRefStyles.css" rel="stylesheet" type="text/css"> - <script type="text/javascript" - src="../../../third_party/jstemplate/jstemplate_compiled.js"> - </script> - <script type="text/javascript" src="js/api_page_generator.js"></script> - <script> -// Re-render the page if the user-agent is chrome and it is being served as -// a file:/// scheme. This allows both the initial render to static as well -// as dynamic re-rendering for developers/doc-writers working on local changes. -window.onload = function() { - var chrome = navigator.userAgent.indexOf("Chrome") > -1; - var fileScheme = location.protocol == "file:"; - var regenerate = chrome && fileScheme; - //if (regenerate) { - window.renderPage(); - //} -} - </script> - </head> - <!-- <body> content is completely generated. Do not edit, as it will be - and rewritten. --> - <body class="hidden"> - </body> -</html> +<!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc. Note: 1) The <head> information in this page is significant, should be uniform across api docs and should be edited only with knowledge of the templating mechanism. 2) The <body> tag *must* retain id="body" 3) All <body>.innerHTML is genereated as an rendering step. If viewed in a browser, it will be re-generated from the template, json schema and authored overview content. 4) The <body>.innerHTML is also generated by an offline step so that this page may easily be indexed by search engines. TODO(rafaelw): Abstract this into a "pageshell" that becomes the single version of page template shell and the "instance" pages (bookmarks.html, etc...) can be generated with a build step. --><!-- <html> must retain id="template --><html xmlns="http://www.w3.org/1999/xhtml" jstcache="0"><!-- <head> data is significant and loads the needed libraries and styles --><head jstcache="0"> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" jstcache="0"> <title jscontent="pageTitle" jstcache="1">devguide</title> <link href="css/ApiRefStyles.css" rel="stylesheet" type="text/css" jstcache="0"> <script type="text/javascript" src="../../../third_party/jstemplate/jstemplate_compiled.js" jstcache="0"> </script> <script type="text/javascript" src="js/api_page_generator.js" jstcache="0"></script> <script type="text/javascript" src="js/bootstrap.js" jstcache="0"></script> </head><!-- <body> content is completely generated. Do not edit, as it will be and rewritten. --><body class="" jstcache="0"> <div id="container" jstcache="0"> <a name="top" jstcache="0"> </a> <!-- API HEADER --> <div id="pageHeader" jstcache="0"> <!-- BREADCRUMB --> <!-- TODO: Fix these hrefs --> <div id="breadcrumbs" jstcache="0"> <a href="index.html" jstcache="0">Google Chrome Extensions</a> > <a href="reference_index.html" jstcache="0">Reference</a> > <a href="api_index.html" jstcache="0">chrome.* APIs</a> > <span jscontent="namespace" jstcache="2">null</span> </div> <div id="searchbox" jstcache="0"> <form action="http://www.google.com/cse" id="cse-search-box" jstcache="0"> <div jstcache="0"> <input type="hidden" name="cx" value="002967670403910741006:61_cvzfqtno" jstcache="0"> <input type="hidden" name="ie" value="UTF-8" jstcache="0"> <input type="text" name="q" size="31" jstcache="0"> <input type="submit" name="sa" value="Search" jstcache="0"> </div> </form> <script type="text/javascript" src="http://www.google.com/jsapi" jstcache="0"></script> <script type="text/javascript" jstcache="0">google.load("elements", "1", {packages: "transliteration"});</script> <script type="text/javascript" src="http://www.google.com/coop/cse/t13n?form=cse-search-box&t13n_langs=en" jstcache="0"></script> <script type="text/javascript" src="http://www.google.com/coop/cse/brand?form=cse-search-box&lang=en" jstcache="0"></script> </div> <div id="pageTitle" jstcache="0"> <h1 jscontent="h1Header" jstcache="3">devguide</h1> </div> </div> <!-- /pageHeader --> <div id="pageContent" jstcache="0"> <!-- SIDENAV --> <div id="leftNav" jstcache="0"> <ul jstcache="0"> <li jstcache="0"> <a href="overview.html" jstcache="0">Overview</a></li> <li jstcache="0"> <a href="getstarted.html" jstcache="0">Get Started</a></li> <li jstcache="0"> <a href="devguide.html" jstcache="0">Developer's Guide</a></li> <li jstcache="0"> Reference <ul jstcache="0"> <li jstcache="0"> <a href="api_index.html" jstcache="0">Extension APIs</a> <ul jstcache="0"> <li jsselect="apiModules" jstcache="18" jsinstance="0"> <a jscontent="name" jsvalues=".href:module + '.html'" jstcache="25" href="bookmarks.html">Bookmarks</a> </li><li jsselect="apiModules" jstcache="18" jsinstance="1"> <a jscontent="name" jsvalues=".href:module + '.html'" jstcache="25" href="toolstrip.html">Toolstrip</a> </li><li jsselect="apiModules" jstcache="18" jsinstance="2"> <a jscontent="name" jsvalues=".href:module + '.html'" jstcache="25" href="pageActions.html">PageActions</a> </li><li jsselect="apiModules" jstcache="18" jsinstance="3"> <a jscontent="name" jsvalues=".href:module + '.html'" jstcache="25" href="windows.html">Windows</a> </li><li jsselect="apiModules" jstcache="18" jsinstance="4"> <a jscontent="name" jsvalues=".href:module + '.html'" jstcache="25" href="tabs.html">Tabs</a> </li><li jsselect="apiModules" jstcache="18" jsinstance="*5"> <a jscontent="name" jsvalues=".href:module + '.html'" jstcache="25" href="self.html">Self</a> </li> </ul> </li> </ul> </li> </ul> </div> <div id="mainColumn" jstcache="0"> <!-- TABLE OF CONTENTS --> <div id="toc" jsselect="apiDefinition" jstcache="4" style="display: none; "> <p jstcache="0">Contents</p> <ol jstcache="0"> <li jstcache="0"> <a href="#overview" jstcache="0">Description</a> <ol jstcache="0"> <li jstcache="0"><a href="#overview-properties" jstcache="0">Properties</a></li> <li jstcache="0"><a href="#overview-examples" jstcache="0">Examples</a></li> </ol> </li> <li jstcache="0"> <a href="#methods" jstcache="0">Methods</a> <ol jstcache="0"> <li jsselect="functions" jstcache="5"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-anchor" jstcache="19">methodName</a> </li> </ol> </li> <li jstcache="0"> <a href="#events" jstcache="0">Events</a> <ol jstcache="0"> <li jsselect="events" jstcache="6"> <a jscontent="name" jsvalues=".href:'#event-' + name" href="#event-anchor" jstcache="20">eventName</a> </li> </ol> </li> <!-- TODO: What do we do about structs/types? --> <li jstcache="0"> <a href="#structs" jstcache="0">TODO: Structs</a> <ol jstcache="0"> <li jstcache="0"><a href="#struct-BookmarkTreeNode" jstcache="0"></a></li> </ol> </li> </ol> [PENDING: links to all h2s and h3s should go here -- would it be possible to link to overview h3s, as well? if so, how should we create their anchor/id values?] </div> <!-- /TABLE OF CONTENTS --> <!-- STATIC CONTENT PLACEHOLDER --> <div id="static" jstcache="0"><p jstcache="0"> [PENDING: intro to the guide goes here. say where to go. lots o' links.] </p> <p jstcache="0"> Lorem ipsum dolor sit amet, consectetur adipiscing elit. Fusce sed elit felis. Vestibulum porta mauris eget mi placerat a condimentum leo semper. Ut scelerisque, ipsum in cursus semper, lectus enim molestie ante, a porttitor dolor neque sit amet lorem. Integer dignissim gravida eros ac rhoncus. Curabitur porttitor hendrerit dolor nec aliquam. Ut vulputate ultrices eros eu ultrices. Pellentesque tempor mattis odio in blandit. Proin nulla metus, tristique eget iaculis gravida, varius at leo. Ut dolor mi, auctor et scelerisque vitae, volutpat eleifend magna. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Morbi ut risus nec massa consectetur accumsan sed non est. Fusce ornare eros et felis dignissim convallis. Maecenas condimentum purus eget nisl condimentum vitae ornare diam sollicitudin. Nulla et dictum ante. In lacus odio, dapibus vel faucibus at, posuere id enim. Nulla tincidunt felis id lectus convallis vulputate. Phasellus libero dui, posuere sollicitudin egestas eget, blandit in urna. Sed cursus tellus sed diam hendrerit pulvinar. </p> <p jstcache="0"> Nam tincidunt mollis aliquam. Suspendisse bibendum dignissim dui, ac mollis ligula fringilla sit amet. Pellentesque dapibus lobortis dignissim. Cras eu lorem a ligula imperdiet ultricies. Phasellus ipsum mi, accumsan quis dignissim eu, commodo ut mi. Nulla sagittis aliquet malesuada. Ut lobortis tellus vitae dolor venenatis eu ullamcorper lorem gravida. Quisque non pharetra velit. Maecenas elit risus, ultricies in sagittis eget, facilisis sed neque. Quisque feugiat porta pharetra. Vestibulum lorem magna, pellentesque et mattis sit amet, euismod et dui. </p></div> <!-- API PAGE --> <div class="apiPage" jsselect="apiDefinition" jstcache="4" style="display: none; "> <!-- METHODS --> <div class="apiGroup" id="methods" jstcache="0"> <a name="#methods" jstcache="0"></a> <h2 jstcache="0">Methods</h2> <!-- iterates over all functions --> <div class="apiItem" jsselect="functions" jstcache="5"> <a jsvalues=".name:'method-' + name" jstcache="7"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="8">method name</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="returns.typeName" jstcache="10">void</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="fullName" jstcache="11">chrome.module.methodName</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="12"><span jsdisplay="$index" jstcache="21">, </span><span jscontent="typeName" jstcache="22"></span> <var jstcache="0"><span jscontent="name" jstcache="8"></span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="13">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="14"> A description from the json schema def of the function goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="23"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="15">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="24"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var> <em jstcache="0">(<span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> <!-- CALLBACK --> <div jsdisplay="callbackParameters" jstcache="16"> <h4 jstcache="0">Callback function</h4> <p jstcache="0"> If you specify the <em jstcache="0">callback</em> parameter, it should specify a function that looks like this: </p> <!-- Note: intentionally longer 80 columns --> <pre jstcache="0">function(<span jscontent="callbackSignature" jstcache="29">Type param1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="callbackParameters" jstcache="30"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> </div> </div> <!-- /description --> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> <!-- EVENTS --> <div class="apiGroup" id="events" jstcache="0"> <a name="#events" jstcache="0"></a> <h2 id="events" jstcache="0">Events</h2> <!-- iterates over all events --> <div jsselect="events" class="apiItem" jstcache="6"> <a jsvalues=".name:'event-' + name" jstcache="9"></a> <h3 jscontent="name" jstcache="8">event name</h3> <div class="summary" jstcache="0"> <!-- Note: intentionally longer 80 columns --> <span class="subdued" jstcache="0">chrome.bookmarks.</span><span jscontent="name" jstcache="8">onEvent</span><span class="subdued" jstcache="0">.addListener</span>(function(<span jscontent="callSignature" jstcache="17">Type param1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>); </div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="13">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="14"> A description from the json schema def of the event goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="23"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26">Undocumented.</dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> </div> <!-- /decription --> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> </div> <!-- /apiPage --> </div> <!-- /mainColumn --> </div> <!-- /pageContent --> <div id="pageFooter" --="" jstcache="0"> Copyright 2009 <br jstcache="0"> TBD: copyright/license should be automatically included here </div> <!-- /pageFooter --> </div> <!-- /container --> </body></html>
diff --git a/chrome/common/extensions/docs/getstarted.html b/chrome/common/extensions/docs/getstarted.html index faf8a37..6e2e03fe 100755 --- a/chrome/common/extensions/docs/getstarted.html +++ b/chrome/common/extensions/docs/getstarted.html @@ -1,46 +1 @@ -<!DOCTYPE html> -<!-- This page is a placeholder for generated extensions api doc. Note: - 1) The <head> information in this page is significant, should be uniform - across api docs and should be edited only with knowledge of the - templating mechanism. - 2) The <body> tag *must* retain id="body" - 3) All <body>.innerHTML is genereated as an rendering step. If viewed in a - browser, it will be re-generated from the template, json schema and - authored overview content. - 4) The <body>.innerHTML is also generated by an offline step so that this - page may easily be indexed by search engines. - - TODO(rafaelw): Abstract this into a "pageshell" that becomes the single - version of page template shell and the "instance" pages (bookmarks.html, - etc...) can be generated with a build step. ---> -<!-- <html> must retain id="template --> -<html xmlns="http://www.w3.org/1999/xhtml"> - <!-- <head> data is significant and loads the needed libraries and styles --> - <head> - <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> - <title jscontent="pageTitle">pageTitle</title> - <link href="css/ApiRefStyles.css" rel="stylesheet" type="text/css"> - <script type="text/javascript" - src="../../../third_party/jstemplate/jstemplate_compiled.js"> - </script> - <script type="text/javascript" src="js/api_page_generator.js"></script> - <script> -// Re-render the page if the user-agent is chrome and it is being served as -// a file:/// scheme. This allows both the initial render to static as well -// as dynamic re-rendering for developers/doc-writers working on local changes. -window.onload = function() { - var chrome = navigator.userAgent.indexOf("Chrome") > -1; - var fileScheme = location.protocol == "file:"; - var regenerate = chrome && fileScheme; - //if (regenerate) { - window.renderPage(); - //} -} - </script> - </head> - <!-- <body> content is completely generated. Do not edit, as it will be - and rewritten. --> - <body class="hidden"> - </body> -</html> +<!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc. Note: 1) The <head> information in this page is significant, should be uniform across api docs and should be edited only with knowledge of the templating mechanism. 2) The <body> tag *must* retain id="body" 3) All <body>.innerHTML is genereated as an rendering step. If viewed in a browser, it will be re-generated from the template, json schema and authored overview content. 4) The <body>.innerHTML is also generated by an offline step so that this page may easily be indexed by search engines. TODO(rafaelw): Abstract this into a "pageshell" that becomes the single version of page template shell and the "instance" pages (bookmarks.html, etc...) can be generated with a build step. --><!-- <html> must retain id="template --><html xmlns="http://www.w3.org/1999/xhtml" jstcache="0"><!-- <head> data is significant and loads the needed libraries and styles --><head jstcache="0"> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" jstcache="0"> <title jscontent="pageTitle" jstcache="1">getstarted</title> <link href="css/ApiRefStyles.css" rel="stylesheet" type="text/css" jstcache="0"> <script type="text/javascript" src="../../../third_party/jstemplate/jstemplate_compiled.js" jstcache="0"> </script> <script type="text/javascript" src="js/api_page_generator.js" jstcache="0"></script> <script type="text/javascript" src="js/bootstrap.js" jstcache="0"></script> </head><!-- <body> content is completely generated. Do not edit, as it will be and rewritten. --><body class="" jstcache="0"> <div id="container" jstcache="0"> <a name="top" jstcache="0"> </a> <!-- API HEADER --> <div id="pageHeader" jstcache="0"> <!-- BREADCRUMB --> <!-- TODO: Fix these hrefs --> <div id="breadcrumbs" jstcache="0"> <a href="index.html" jstcache="0">Google Chrome Extensions</a> > <a href="reference_index.html" jstcache="0">Reference</a> > <a href="api_index.html" jstcache="0">chrome.* APIs</a> > <span jscontent="namespace" jstcache="2">null</span> </div> <div id="searchbox" jstcache="0"> <form action="http://www.google.com/cse" id="cse-search-box" jstcache="0"> <div jstcache="0"> <input type="hidden" name="cx" value="002967670403910741006:61_cvzfqtno" jstcache="0"> <input type="hidden" name="ie" value="UTF-8" jstcache="0"> <input type="text" name="q" size="31" jstcache="0"> <input type="submit" name="sa" value="Search" jstcache="0"> </div> </form> <script type="text/javascript" src="http://www.google.com/jsapi" jstcache="0"></script> <script type="text/javascript" jstcache="0">google.load("elements", "1", {packages: "transliteration"});</script> <script type="text/javascript" src="http://www.google.com/coop/cse/t13n?form=cse-search-box&t13n_langs=en" jstcache="0"></script> <script type="text/javascript" src="http://www.google.com/coop/cse/brand?form=cse-search-box&lang=en" jstcache="0"></script> </div> <div id="pageTitle" jstcache="0"> <h1 jscontent="h1Header" jstcache="3">getstarted</h1> </div> </div> <!-- /pageHeader --> <div id="pageContent" jstcache="0"> <!-- SIDENAV --> <div id="leftNav" jstcache="0"> <ul jstcache="0"> <li jstcache="0"> <a href="overview.html" jstcache="0">Overview</a></li> <li jstcache="0"> <a href="getstarted.html" jstcache="0">Get Started</a></li> <li jstcache="0"> <a href="devguide.html" jstcache="0">Developer's Guide</a></li> <li jstcache="0"> Reference <ul jstcache="0"> <li jstcache="0"> <a href="api_index.html" jstcache="0">Extension APIs</a> <ul jstcache="0"> <li jsselect="apiModules" jstcache="18" jsinstance="0"> <a jscontent="name" jsvalues=".href:module + '.html'" jstcache="25" href="bookmarks.html">Bookmarks</a> </li><li jsselect="apiModules" jstcache="18" jsinstance="1"> <a jscontent="name" jsvalues=".href:module + '.html'" jstcache="25" href="toolstrip.html">Toolstrip</a> </li><li jsselect="apiModules" jstcache="18" jsinstance="2"> <a jscontent="name" jsvalues=".href:module + '.html'" jstcache="25" href="pageActions.html">PageActions</a> </li><li jsselect="apiModules" jstcache="18" jsinstance="3"> <a jscontent="name" jsvalues=".href:module + '.html'" jstcache="25" href="windows.html">Windows</a> </li><li jsselect="apiModules" jstcache="18" jsinstance="4"> <a jscontent="name" jsvalues=".href:module + '.html'" jstcache="25" href="tabs.html">Tabs</a> </li><li jsselect="apiModules" jstcache="18" jsinstance="*5"> <a jscontent="name" jsvalues=".href:module + '.html'" jstcache="25" href="self.html">Self</a> </li> </ul> </li> </ul> </li> </ul> </div> <div id="mainColumn" jstcache="0"> <!-- TABLE OF CONTENTS --> <div id="toc" jsselect="apiDefinition" jstcache="4" style="display: none; "> <p jstcache="0">Contents</p> <ol jstcache="0"> <li jstcache="0"> <a href="#overview" jstcache="0">Description</a> <ol jstcache="0"> <li jstcache="0"><a href="#overview-properties" jstcache="0">Properties</a></li> <li jstcache="0"><a href="#overview-examples" jstcache="0">Examples</a></li> </ol> </li> <li jstcache="0"> <a href="#methods" jstcache="0">Methods</a> <ol jstcache="0"> <li jsselect="functions" jstcache="5"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-anchor" jstcache="19">methodName</a> </li> </ol> </li> <li jstcache="0"> <a href="#events" jstcache="0">Events</a> <ol jstcache="0"> <li jsselect="events" jstcache="6"> <a jscontent="name" jsvalues=".href:'#event-' + name" href="#event-anchor" jstcache="20">eventName</a> </li> </ol> </li> <!-- TODO: What do we do about structs/types? --> <li jstcache="0"> <a href="#structs" jstcache="0">TODO: Structs</a> <ol jstcache="0"> <li jstcache="0"><a href="#struct-BookmarkTreeNode" jstcache="0"></a></li> </ol> </li> </ol> [PENDING: links to all h2s and h3s should go here -- would it be possible to link to overview h3s, as well? if so, how should we create their anchor/id values?] </div> <!-- /TABLE OF CONTENTS --> <!-- STATIC CONTENT PLACEHOLDER --> <div id="static" jstcache="0"><p jstcache="0"> This tutorial walks you through creating a simple extension. To complete this tutorial, you must have Windows; Linux and Mac don't yet support extensions. </p> <h2 id="browser" jstcache="0">Get your browser ready</h2> <p jstcache="0"> To develop extensions for Google Chrome, you need to set up your browser: </p> <ol jstcache="0"> <li jstcache="0"><a href="http://dev.chromium.org/getting-involved/dev-channel" jstcache="0">Subscribe to the Dev channel</a> of Google Chrome for Windows. </li> <li jstcache="0"><a href="http://dev.chromium.org/developers/creating-and-using-profiles" jstcache="0">Create a separate profile</a> for testing <em jstcache="0">(optional but highly recommended)</em>. Having a testing profile means that you can use Google Chrome (with your default profile) for everyday browsing, even if your extension has horrible bugs.</li> </ol> <h2 id="load" jstcache="0">Create and load an extension</h2> <p jstcache="0"> In this section, you'll write a <em jstcache="0">toolstrip</em> — an extension that puts a bit of UI into the <em jstcache="0">toolbar</em> at the bottom of the Google Chrome window. </p> <ol jstcache="0"> <li jstcache="0"> Create a folder somewhere on your computer to contain your extension's code. We'll assume the folder is located at <strong jstcache="0"><code jstcache="0">c:\myext</code></strong>, but it can be anywhere. </li> <li jstcache="0"> Inside your extension's folder, create a text file called <strong jstcache="0"><code jstcache="0">manifest.json</code></strong>, and put this in it: <pre jstcache="0">{ "name": "My First Extension", "version": "1.0", "description": "The first extension that I made.", "toolstrips": [ "my_toolstrip.html" ] }</pre> </li> <li jstcache="0"> In the same folder, create a text file called <strong jstcache="0"><code jstcache="0">my_toolstrip.html</code></strong>, and put this in it: <pre jstcache="0"><div class="toolstrip-button"> <span>Hello, World!</span> </div></pre> </li> <li jstcache="0"> Load the extension: <ol type="a" jstcache="0"> <li jstcache="0"> Change the shortcut that you use to start the browser (or create a new one) so that it has the <code jstcache="0">--enable-extensions</code> and <code jstcache="0">--load-extension</code> flags. For example, if your extension is at <code jstcache="0">c:\myext</code>, your shortcut might look something like this: <pre jstcache="0">chrome.exe <span class="newCode" jstcache="0">--enable-extensions --load-extension="c:\myext"</span></pre> </li> <li jstcache="0">Exit Google Chrome. If you have a separate profile for testing, you only need to exit the browser instances that use the testing profile. </li> <li jstcache="0">Double-click the shortcut to start the browser.</li> </ol> <p jstcache="0"> <b jstcache="0">Note:</b> For details on changing shortcut properties, see <a href="http://dev.chromium.org/developers/creating-and-using-profiles" jstcache="0">Creating and Using Profiles</a>.</p> </li> </ol> <p jstcache="0"> You should see the UI for your extension at the bottom left of the browser, looking something like this: </p> <table jstcache="0"> <tbody jstcache="0"> <tr jstcache="0"> <td align="center" width="33%" jstcache="0"><img src="images/hw-1.gif" alt="" jstcache="0"></td> <td align="center" width="33%" jstcache="0"><img src="images/hw-2.gif" alt="" jstcache="0"></td> <td align="center" width="33%" jstcache="0"><img src="images/hw-3.gif" alt="" jstcache="0"></td> </tr> <tr jstcache="0"> <th align="center" width="33%" jstcache="0"> default appearance</th> <th align="center" width="33%" jstcache="0"> initial onhover appearance</th> <th align="center" width="33%" jstcache="0"> final onhover appearance</th> </tr> </tbody> </table> <p jstcache="0"> Your extension's button is automatically styled to look like it belongs in the browser. If you put the cursor over the button, the button gets a nice, rounded edge, just like the buttons in the bookmark bar. After a while, a tooltip comes up, identifying the extension. </p> <p jstcache="0"> [PENDING: troubleshooting info should go here. what are symptoms of common typos, including misnamed files? what are the symptoms if you don't have the dev channel?] </p> <h2 id="code" jstcache="0">Add code to the extension</h2> <p jstcache="0"> In this step, you'll make your extension <em jstcache="0">do</em> something besides just look good. </p> <ol jstcache="0"> <li jstcache="0"> <p jstcache="0"> Inside your extension's folder, create a text file called <strong jstcache="0"><code jstcache="0">hello_world.html</code></strong>, and add the following code to it:</p> <blockquote jstcache="0"> <a href="samples/hello_world.txt" jstcache="0">CSS and JavaScript code for hello_world</a></blockquote> </li> <li jstcache="0"> <p jstcache="0"> Edit <code jstcache="0">my_toolstrip.html</code>, so that it has the following code: </p> <pre jstcache="0"><div class="toolstrip-button"<span class="newCode" jstcache="0"> onclick="window.open('hello_world.html')"</span>> <span>Hello, World!</span> </div></pre> </li> <li jstcache="0"> Restart the browser to load the new version of the extension.</li> <li jstcache="0">Click the button. A window should come up that displays <code jstcache="0">hello_world.html</code>. </li> </ol> <p jstcache="0"> It should look something like this:</p> <img src="images/hello_world-page.gif" alt="a window with a grid of images related to HELLO WORLD" jstcache="0"> <p jstcache="0"> If you don't see that page, try the instructions again, following them exactly. Don't try loading an HTML file that isn't in the extension's folder — it won't work! </p> <h2 id="debug" jstcache="0">Debug the extension</h2> <p jstcache="0"> You can use the browser's built-in developer tools to view your extension's code, display debugging output, and debug your extension. </p> <ol jstcache="0"> <li jstcache="0"> <p jstcache="0"> Edit <code jstcache="0">my_toolstrip.html</code>, so that it has the following code: </p> <pre jstcache="0"><span class="newCode" jstcache="0"><script> function helloWorld() { var hwFile = 'hello_world.html'; console.log("in helloWorld()"); window.open(hwFile); } </script></span> <div class="toolstrip-button" onclick="<span class="newCode" jstcache="0">helloWorld();</span>"> <span>Hello, World!</span> </div></pre> <p jstcache="0"> The relocated code still has the same effect, but now it has some debugging output, thanks to the call to <code jstcache="0">console.log()</code>.</p> </li> <li jstcache="0"> Restart the browser, so that it loads your new version of the extension. <!-- This might be confusing. Maybe we should instead cover location.reload() later, after we've shown the console. <div class="note"> <b>Tip:</b> If you don't want to restart your browser, you can get an updated version of the extension by opening a new window. The new window will contain the updated extension; old windows will contain the old version. </div> --> </li> <li jstcache="0"> Right-click the <strong jstcache="0">Hello, World!</strong> button (at the bottom left) to bring up the Developer Tools window for this instance of your toolstrip. The window should look something like this: <p jstcache="0"> <img src="images/devtools-1.gif" alt="" jstcache="0"> </p> <!-- Possibly we should recommend starting the Dev Tools using chrome://extensions, rather than right-click. However, that adds some stuff (such as id) that might be confusing. --> </li> <li jstcache="0"> Click the <strong jstcache="0">Scripts</strong> button. If necessary, choose <strong jstcache="0">my_toolstrip.html</strong> from the list of scripts. The result should be something like this: <p jstcache="0"> <img src="images/devtools-2.gif" alt="" jstcache="0"> </p> </li> <li jstcache="0"> Set a debugging breakpoint at the <code jstcache="0">window.open()</code> statement by clicking <strong jstcache="0">5</strong> in the left column: <p jstcache="0"> <img src="images/devtools-3.gif" alt="" jstcache="0"> </p> </li> <li jstcache="0"> Click the Console button (second from left, at the bottom of the Developer Tools window) so that you can see both the code and the console. <p jstcache="0"> <img src="images/devtools-4.gif" alt="" jstcache="0"></p> </li> <li jstcache="0"> Back in the main browser window, click the <strong jstcache="0">Hello, World!</strong> button, so that the extension begins executing. You should see the output of <code jstcache="0">console.log()</code> along with the line number, and execution should stop just before the call to <code jstcache="0">window.open()</code>. <p jstcache="0"> <img src="images/devtools-5.gif" alt="" jstcache="0"> </p> <p jstcache="0"> The Call Stack area at the right of the tools window shows that the <code jstcache="0">helloWorld()</code> method was called by an anonymous function that was called by <code jstcache="0">onclick</code>. Anywhere in the Call Stack or console that you see a file and line number (for example, "my_toolstrip.html:4"), you can click that text to see the relevant line of code. </p> </li> <li jstcache="0"> In the upper right part of the tools window, scroll down (if necessary) until you can see the local scope variables. This section shows the current values of all variables in the current scope. For example, you can see that <code jstcache="0">hwFile</code> is a local variable that has the value "hello_world.html". <p jstcache="0"> <img src="images/devtools-6.gif" alt="" jstcache="0"> </p> </li> <li jstcache="0"> Click the buttons at the upper right of the window to resume execution or to step through the code. Once the call to <code jstcache="0">window.open()</code> returns, the main browser window should open a new tab that displays the contents of <code jstcache="0">hello_world.html</code>.</li> </ol> <p jstcache="0"> You now know how to load and debug an extension!</p> <h2 id="summary" jstcache="0">Summary</h2> <p jstcache="0"> [PENDING: Summarize what we did, what it means, what else we would've done if this were a real extension (e.g. package it), and where to find more information. Suggest where to go next.]</p> </div> <!-- API PAGE --> <div class="apiPage" jsselect="apiDefinition" jstcache="4" style="display: none; "> <!-- METHODS --> <div class="apiGroup" id="methods" jstcache="0"> <a name="#methods" jstcache="0"></a> <h2 jstcache="0">Methods</h2> <!-- iterates over all functions --> <div class="apiItem" jsselect="functions" jstcache="5"> <a jsvalues=".name:'method-' + name" jstcache="7"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="8">method name</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="returns.typeName" jstcache="10">void</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="fullName" jstcache="11">chrome.module.methodName</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="12"><span jsdisplay="$index" jstcache="21">, </span><span jscontent="typeName" jstcache="22"></span> <var jstcache="0"><span jscontent="name" jstcache="8"></span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="13">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="14"> A description from the json schema def of the function goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="23"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="15">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="24"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var> <em jstcache="0">(<span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> <!-- CALLBACK --> <div jsdisplay="callbackParameters" jstcache="16"> <h4 jstcache="0">Callback function</h4> <p jstcache="0"> If you specify the <em jstcache="0">callback</em> parameter, it should specify a function that looks like this: </p> <!-- Note: intentionally longer 80 columns --> <pre jstcache="0">function(<span jscontent="callbackSignature" jstcache="29">Type param1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="callbackParameters" jstcache="30"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> </div> </div> <!-- /description --> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> <!-- EVENTS --> <div class="apiGroup" id="events" jstcache="0"> <a name="#events" jstcache="0"></a> <h2 id="events" jstcache="0">Events</h2> <!-- iterates over all events --> <div jsselect="events" class="apiItem" jstcache="6"> <a jsvalues=".name:'event-' + name" jstcache="9"></a> <h3 jscontent="name" jstcache="8">event name</h3> <div class="summary" jstcache="0"> <!-- Note: intentionally longer 80 columns --> <span class="subdued" jstcache="0">chrome.bookmarks.</span><span jscontent="name" jstcache="8">onEvent</span><span class="subdued" jstcache="0">.addListener</span>(function(<span jscontent="callSignature" jstcache="17">Type param1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>); </div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="13">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="14"> A description from the json schema def of the event goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="23"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26">Undocumented.</dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> </div> <!-- /decription --> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> </div> <!-- /apiPage --> </div> <!-- /mainColumn --> </div> <!-- /pageContent --> <div id="pageFooter" --="" jstcache="0"> Copyright 2009 <br jstcache="0"> TBD: copyright/license should be automatically included here </div> <!-- /pageFooter --> </div> <!-- /container --> </body></html>
diff --git a/chrome/common/extensions/docs/index.html b/chrome/common/extensions/docs/index.html index faf8a37..e863386 100755 --- a/chrome/common/extensions/docs/index.html +++ b/chrome/common/extensions/docs/index.html @@ -1,46 +1 @@ -<!DOCTYPE html> -<!-- This page is a placeholder for generated extensions api doc. Note: - 1) The <head> information in this page is significant, should be uniform - across api docs and should be edited only with knowledge of the - templating mechanism. - 2) The <body> tag *must* retain id="body" - 3) All <body>.innerHTML is genereated as an rendering step. If viewed in a - browser, it will be re-generated from the template, json schema and - authored overview content. - 4) The <body>.innerHTML is also generated by an offline step so that this - page may easily be indexed by search engines. - - TODO(rafaelw): Abstract this into a "pageshell" that becomes the single - version of page template shell and the "instance" pages (bookmarks.html, - etc...) can be generated with a build step. ---> -<!-- <html> must retain id="template --> -<html xmlns="http://www.w3.org/1999/xhtml"> - <!-- <head> data is significant and loads the needed libraries and styles --> - <head> - <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> - <title jscontent="pageTitle">pageTitle</title> - <link href="css/ApiRefStyles.css" rel="stylesheet" type="text/css"> - <script type="text/javascript" - src="../../../third_party/jstemplate/jstemplate_compiled.js"> - </script> - <script type="text/javascript" src="js/api_page_generator.js"></script> - <script> -// Re-render the page if the user-agent is chrome and it is being served as -// a file:/// scheme. This allows both the initial render to static as well -// as dynamic re-rendering for developers/doc-writers working on local changes. -window.onload = function() { - var chrome = navigator.userAgent.indexOf("Chrome") > -1; - var fileScheme = location.protocol == "file:"; - var regenerate = chrome && fileScheme; - //if (regenerate) { - window.renderPage(); - //} -} - </script> - </head> - <!-- <body> content is completely generated. Do not edit, as it will be - and rewritten. --> - <body class="hidden"> - </body> -</html> +<!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc. Note: 1) The <head> information in this page is significant, should be uniform across api docs and should be edited only with knowledge of the templating mechanism. 2) The <body> tag *must* retain id="body" 3) All <body>.innerHTML is genereated as an rendering step. If viewed in a browser, it will be re-generated from the template, json schema and authored overview content. 4) The <body>.innerHTML is also generated by an offline step so that this page may easily be indexed by search engines. TODO(rafaelw): Abstract this into a "pageshell" that becomes the single version of page template shell and the "instance" pages (bookmarks.html, etc...) can be generated with a build step. --><!-- <html> must retain id="template --><html xmlns="http://www.w3.org/1999/xhtml" jstcache="0"><!-- <head> data is significant and loads the needed libraries and styles --><head jstcache="0"> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" jstcache="0"> <title jscontent="pageTitle" jstcache="1">index</title> <link href="css/ApiRefStyles.css" rel="stylesheet" type="text/css" jstcache="0"> <script type="text/javascript" src="../../../third_party/jstemplate/jstemplate_compiled.js" jstcache="0"> </script> <script type="text/javascript" src="js/api_page_generator.js" jstcache="0"></script> <script type="text/javascript" src="js/bootstrap.js" jstcache="0"></script> </head><!-- <body> content is completely generated. Do not edit, as it will be and rewritten. --><body class="" jstcache="0"> <div id="container" jstcache="0"> <a name="top" jstcache="0"> </a> <!-- API HEADER --> <div id="pageHeader" jstcache="0"> <!-- BREADCRUMB --> <!-- TODO: Fix these hrefs --> <div id="breadcrumbs" jstcache="0"> <a href="index.html" jstcache="0">Google Chrome Extensions</a> > <a href="reference_index.html" jstcache="0">Reference</a> > <a href="api_index.html" jstcache="0">chrome.* APIs</a> > <span jscontent="namespace" jstcache="2">null</span> </div> <div id="searchbox" jstcache="0"> <form action="http://www.google.com/cse" id="cse-search-box" jstcache="0"> <div jstcache="0"> <input type="hidden" name="cx" value="002967670403910741006:61_cvzfqtno" jstcache="0"> <input type="hidden" name="ie" value="UTF-8" jstcache="0"> <input type="text" name="q" size="31" jstcache="0"> <input type="submit" name="sa" value="Search" jstcache="0"> </div> </form> <script type="text/javascript" src="http://www.google.com/jsapi" jstcache="0"></script> <script type="text/javascript" jstcache="0">google.load("elements", "1", {packages: "transliteration"});</script> <script type="text/javascript" src="http://www.google.com/coop/cse/t13n?form=cse-search-box&t13n_langs=en" jstcache="0"></script> <script type="text/javascript" src="http://www.google.com/coop/cse/brand?form=cse-search-box&lang=en" jstcache="0"></script> </div> <div id="pageTitle" jstcache="0"> <h1 jscontent="h1Header" jstcache="3">index</h1> </div> </div> <!-- /pageHeader --> <div id="pageContent" jstcache="0"> <!-- SIDENAV --> <div id="leftNav" jstcache="0"> <ul jstcache="0"> <li jstcache="0"> <a href="overview.html" jstcache="0">Overview</a></li> <li jstcache="0"> <a href="getstarted.html" jstcache="0">Get Started</a></li> <li jstcache="0"> <a href="devguide.html" jstcache="0">Developer's Guide</a></li> <li jstcache="0"> Reference <ul jstcache="0"> <li jstcache="0"> <a href="api_index.html" jstcache="0">Extension APIs</a> <ul jstcache="0"> <li jsselect="apiModules" jstcache="18" jsinstance="0"> <a jscontent="name" jsvalues=".href:module + '.html'" jstcache="25" href="bookmarks.html">Bookmarks</a> </li><li jsselect="apiModules" jstcache="18" jsinstance="1"> <a jscontent="name" jsvalues=".href:module + '.html'" jstcache="25" href="toolstrip.html">Toolstrip</a> </li><li jsselect="apiModules" jstcache="18" jsinstance="2"> <a jscontent="name" jsvalues=".href:module + '.html'" jstcache="25" href="pageActions.html">PageActions</a> </li><li jsselect="apiModules" jstcache="18" jsinstance="3"> <a jscontent="name" jsvalues=".href:module + '.html'" jstcache="25" href="windows.html">Windows</a> </li><li jsselect="apiModules" jstcache="18" jsinstance="4"> <a jscontent="name" jsvalues=".href:module + '.html'" jstcache="25" href="tabs.html">Tabs</a> </li><li jsselect="apiModules" jstcache="18" jsinstance="*5"> <a jscontent="name" jsvalues=".href:module + '.html'" jstcache="25" href="self.html">Self</a> </li> </ul> </li> </ul> </li> </ul> </div> <div id="mainColumn" jstcache="0"> <!-- TABLE OF CONTENTS --> <div id="toc" jsselect="apiDefinition" jstcache="4" style="display: none; "> <p jstcache="0">Contents</p> <ol jstcache="0"> <li jstcache="0"> <a href="#overview" jstcache="0">Description</a> <ol jstcache="0"> <li jstcache="0"><a href="#overview-properties" jstcache="0">Properties</a></li> <li jstcache="0"><a href="#overview-examples" jstcache="0">Examples</a></li> </ol> </li> <li jstcache="0"> <a href="#methods" jstcache="0">Methods</a> <ol jstcache="0"> <li jsselect="functions" jstcache="5"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-anchor" jstcache="19">methodName</a> </li> </ol> </li> <li jstcache="0"> <a href="#events" jstcache="0">Events</a> <ol jstcache="0"> <li jsselect="events" jstcache="6"> <a jscontent="name" jsvalues=".href:'#event-' + name" href="#event-anchor" jstcache="20">eventName</a> </li> </ol> </li> <!-- TODO: What do we do about structs/types? --> <li jstcache="0"> <a href="#structs" jstcache="0">TODO: Structs</a> <ol jstcache="0"> <li jstcache="0"><a href="#struct-BookmarkTreeNode" jstcache="0"></a></li> </ol> </li> </ol> [PENDING: links to all h2s and h3s should go here -- would it be possible to link to overview h3s, as well? if so, how should we create their anchor/id values?] </div> <!-- /TABLE OF CONTENTS --> <!-- STATIC CONTENT PLACEHOLDER --> <div id="static" jstcache="0"><p jstcache="0"> If you want to customize Google Chrome, you've come to the right place. An <em jstcache="0">extension</em> is a bundle of web code (HTML, JavaScript, perhaps some CSS) that lets you add functionality or a bit of user interface (usually both) to the browser. <a href="http://dev.chromium.org/developers/design-documents/extensions/samples" jstcache="0">Examples of extensions</a> include a mail checker, a newsfeed subscriber, and a status monitor.<br jstcache="0"> </p> <h3 jstcache="0">Contents</h3> <p jstcache="0"> This documentation is just being written; here's what we have so far. You might also want to look at <a href="#other" jstcache="0">Other resources</a>. If you just want to <em jstcache="0">make</em> something, go to <a href="getstarted.html" jstcache="0">Get Started</a>. </p> <ul jstcache="0"> <li jstcache="0"><a href="overview.html" jstcache="0">Overview</a></li> <li jstcache="0"><a href="getstarted.html" jstcache="0">Get Started</a> (Hello, World!)</li> <li jstcache="0"><a href="devguide.html" jstcache="0">Developer's Guide</a></li> <li jstcache="0"><a href="reference/index.html" jstcache="0">Reference</a> <ul jstcache="0"> <li jstcache="0">manifest.json</li> <li jstcache="0">Toolstrips and Moles</li> <li jstcache="0">Background pages</li> <li jstcache="0">Page actions</li> <li jstcache="0"><a href="content_scripts.html" jstcache="0">Content scripts</a></li> <li jstcache="0">Cross-Origin XMLHttpRequest</li> <li jstcache="0">Bookmarks</li> <li jstcache="0">Tabs</li> <li jstcache="0">Windows</li> <li jstcache="0">[PENDING: Fill out the programmatic API bullets automatically?]</li> </ul> </li><li jstcache="0">Samples</li> <ul jstcache="0"> <li jstcache="0">#1</li> <li jstcache="0">#2</li> </ul> </ul> <h3 id="other" jstcache="0">Other resources</h3> <ul jstcache="0"> <li jstcache="0"><a href="http://dev.chromium.org/developers/design-documents/extensions" jstcache="0">Design documents</a>:</li> <ul jstcache="0"> <li jstcache="0"><a href="http://dev.chromium.org/developers/design-documents/extensions/howto" jstcache="0">HOWTO</a>: The precursor to Get Started [PENDING: make sure it's still useful]</li> <li jstcache="0"><a href="http://dev.chromium.org/developers/design-documents/extensions/packaging" jstcache="0">Packaging</a>: [PENDING: might be obsolete]</li> <li jstcache="0">APIs:</li> <ul jstcache="0"> <li jstcache="0"><a href="http://dev.chromium.org/developers/design-documents/extensions/bookmarks-api" jstcache="0">Bookmarks</a></li> <li jstcache="0"><a href="http://dev.chromium.org/developers/design-documents/extensions/events" jstcache="0">Events</a></li> </ul> <ul jstcache="0"> <li jstcache="0"><a href="http://dev.chromium.org/developers/design-documents/extensions/tabs-api" jstcache="0">Tabs</a></li> </ul> <ul jstcache="0"> <li jstcache="0"><a href="http://dev.chromium.org/developers/design-documents/extensions/windows-api" jstcache="0">Windows</a></li> </ul> <li jstcache="0">Features:</li> <ul jstcache="0"> <li jstcache="0"><a href="http://dev.chromium.org/developers/design-documents/extensions/toolstrips" jstcache="0">Toolstrips</a>: Add UI to the toolbar area</li> <li jstcache="0"><a href="http://dev.chromium.org/developers/design-documents/extensions/content-scripts" jstcache="0">Content scripts</a>: Run code within the context of web pages</li> <li jstcache="0"><a href="http://dev.chromium.org/developers/design-documents/extensions/background-pages" jstcache="0">Background pages</a>: Run code that's not directly related to the UI</li> <li jstcache="0"><a href="http://dev.chromium.org/developers/design-documents/extensions/cross-origin-xhr" jstcache="0">Cross-Origin XMLHttpRequest</a>: Communicate with multiple domains</li> </ul> </ul> <li jstcache="0"><a href="http://groups.google.com/group/chromium-extensions" jstcache="0">chromium-extensions</a> (discussion group)</li> </ul> </div> <!-- API PAGE --> <div class="apiPage" jsselect="apiDefinition" jstcache="4" style="display: none; "> <!-- METHODS --> <div class="apiGroup" id="methods" jstcache="0"> <a name="#methods" jstcache="0"></a> <h2 jstcache="0">Methods</h2> <!-- iterates over all functions --> <div class="apiItem" jsselect="functions" jstcache="5"> <a jsvalues=".name:'method-' + name" jstcache="7"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="8">method name</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="returns.typeName" jstcache="10">void</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="fullName" jstcache="11">chrome.module.methodName</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="12"><span jsdisplay="$index" jstcache="21">, </span><span jscontent="typeName" jstcache="22"></span> <var jstcache="0"><span jscontent="name" jstcache="8"></span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="13">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="14"> A description from the json schema def of the function goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="23"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="15">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="24"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var> <em jstcache="0">(<span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> <!-- CALLBACK --> <div jsdisplay="callbackParameters" jstcache="16"> <h4 jstcache="0">Callback function</h4> <p jstcache="0"> If you specify the <em jstcache="0">callback</em> parameter, it should specify a function that looks like this: </p> <!-- Note: intentionally longer 80 columns --> <pre jstcache="0">function(<span jscontent="callbackSignature" jstcache="29">Type param1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="callbackParameters" jstcache="30"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> </div> </div> <!-- /description --> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> <!-- EVENTS --> <div class="apiGroup" id="events" jstcache="0"> <a name="#events" jstcache="0"></a> <h2 id="events" jstcache="0">Events</h2> <!-- iterates over all events --> <div jsselect="events" class="apiItem" jstcache="6"> <a jsvalues=".name:'event-' + name" jstcache="9"></a> <h3 jscontent="name" jstcache="8">event name</h3> <div class="summary" jstcache="0"> <!-- Note: intentionally longer 80 columns --> <span class="subdued" jstcache="0">chrome.bookmarks.</span><span jscontent="name" jstcache="8">onEvent</span><span class="subdued" jstcache="0">.addListener</span>(function(<span jscontent="callSignature" jstcache="17">Type param1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>); </div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="13">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="14"> A description from the json schema def of the event goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="23"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26">Undocumented.</dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> </div> <!-- /decription --> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> </div> <!-- /apiPage --> </div> <!-- /mainColumn --> </div> <!-- /pageContent --> <div id="pageFooter" --="" jstcache="0"> Copyright 2009 <br jstcache="0"> TBD: copyright/license should be automatically included here </div> <!-- /pageFooter --> </div> <!-- /container --> </body></html>
diff --git a/chrome/common/extensions/docs/js/api_page_generator.js b/chrome/common/extensions/docs/js/api_page_generator.js index e45a5b7..4613d75 100755 --- a/chrome/common/extensions/docs/js/api_page_generator.js +++ b/chrome/common/extensions/docs/js/api_page_generator.js @@ -53,7 +53,11 @@ function extend(obj, obj2) { function renderPage() { var pathParts = document.location.href.split(/\/|\./); pageName = pathParts[pathParts.length - 2]; - + if (!pageName) { + alert("Empty page name for: " + document.location.href); + return; + } + // Fetch the api template and insert into the <body>. fetchContent(API_TEMPLATE, function(templateContent) { document.getElementsByTagName("body")[0].innerHTML = templateContent; @@ -68,7 +72,7 @@ function fetchStatic() { fetchContent(staticResource(pageName), function(overviewContent) { document.getElementById("static").innerHTML = overviewContent; fetchSchema(); - + }, function(error) { // Not fatal. Some api pages may not have matching static content. fetchSchema(); @@ -88,6 +92,7 @@ function fetchSchema() { * onSuccess(content) */ function fetchContent(url, onSuccess, onError) { + var localUrl = url; var xhr = new XMLHttpRequest(); var abortTimerId = window.setTimeout(function() { xhr.abort(); @@ -96,10 +101,10 @@ function fetchContent(url, onSuccess, onError) { function handleError(error) { window.clearTimeout(abortTimerId); - if (onError) { + if (onError) onError(error); - } - console.error("XHR Failed: " + error); + else + console.error("XHR Failed fetching: " + localUrl + "..." + error); } try { @@ -113,9 +118,9 @@ function fetchContent(url, onSuccess, onError) { } } } - + xhr.onerror = handleError; - + xhr.open("GET", url, true); xhr.send(null); } catch(e) { @@ -134,7 +139,7 @@ function fetchContent(url, onSuccess, onError) { function renderTemplate(schemaContent) { pageData = {}; var schema = JSON.parse(schemaContent); - + schema.each(function(module) { if (module.namespace == pageName) { // This page is an api page. Setup types and apiDefinition. @@ -147,16 +152,24 @@ function renderTemplate(schemaContent) { preprocessApi(pageData, schema); } }); - + setupPageData(pageData, schema); - + // Render to template var input = new JsEvalContext(pageData); var output = document.getElementsByTagName("html")[0]; jstProcess(input, output); - + // Show. document.getElementsByTagName("body")[0].className = ""; + + if (parent && parent.done) + parent.done(); +} + +function serializePage() { + var s = new XMLSerializer(); + return s.serializeToString(document); } function setupPageData(pageData, schema) { @@ -170,7 +183,7 @@ function setupPageData(pageData, schema) { pageData.apiModules.push(m); }); pageData.apiModules.sort(function(a, b) { return a.name > b.name; }); - + if (!pageData.pageTitle) { pageData.pageTitle = pageName; pageData.h1Header = pageName; @@ -203,13 +216,13 @@ function preprocessApi(pageData, schema) { }); } } - + // Setup any type: "object" pameters to have an array of params (rather than // named properties). f.parameters.each(function(param) { addPropertyListIfObject(param); }); - + // Setup return typeName & _propertyList, if any. if (f.returns) { linkTypeReference(f.returns); @@ -217,7 +230,7 @@ function preprocessApi(pageData, schema) { addPropertyListIfObject(f.returns); } }); - + module.events.each(function(e) { linkTypeReferences(e.parameters); assignTypeNames(e.parameters); @@ -274,19 +287,19 @@ function assignTypeNames(parameters) { function typeName(schema) { if (schema.$ref) schema = types[schema.$ref]; - + if (schema.choice) { var typeNames = []; schema.choice.each(function(c) { typeNames.push(typeName(c)); }); - + return typeNames.join(" or "); } - + if (schema.type == "array") return "array of " + typeName(schema.items); - + return schema.type; } @@ -299,6 +312,6 @@ function generateSignatureString(parameters) { parameters.each(function(param, i) { retval.push(param.typeName + " " + param.name); }); - + return retval.join(", "); }
\ No newline at end of file diff --git a/chrome/common/extensions/docs/js/bootstrap.js b/chrome/common/extensions/docs/js/bootstrap.js new file mode 100755 index 0000000..5282030d --- /dev/null +++ b/chrome/common/extensions/docs/js/bootstrap.js @@ -0,0 +1,11 @@ +window.onload = function() { + // Regenerate page if we are passed the "?regenerate" search param + // or if the user-agent is chrome AND the document is being served + // from the file:/// scheme. + if (window.location.search == "?regenerate" || + navigator.userAgent.indexOf("Chrome") > -1) { + // Hide body content initially to minimize flashing. + document.getElementsByTagName("body")[0].className = "hidden"; + window.renderPage(); + } +}
\ No newline at end of file diff --git a/chrome/common/extensions/docs/overview.html b/chrome/common/extensions/docs/overview.html index faf8a37..52600a7 100755 --- a/chrome/common/extensions/docs/overview.html +++ b/chrome/common/extensions/docs/overview.html @@ -1,46 +1 @@ -<!DOCTYPE html> -<!-- This page is a placeholder for generated extensions api doc. Note: - 1) The <head> information in this page is significant, should be uniform - across api docs and should be edited only with knowledge of the - templating mechanism. - 2) The <body> tag *must* retain id="body" - 3) All <body>.innerHTML is genereated as an rendering step. If viewed in a - browser, it will be re-generated from the template, json schema and - authored overview content. - 4) The <body>.innerHTML is also generated by an offline step so that this - page may easily be indexed by search engines. - - TODO(rafaelw): Abstract this into a "pageshell" that becomes the single - version of page template shell and the "instance" pages (bookmarks.html, - etc...) can be generated with a build step. ---> -<!-- <html> must retain id="template --> -<html xmlns="http://www.w3.org/1999/xhtml"> - <!-- <head> data is significant and loads the needed libraries and styles --> - <head> - <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> - <title jscontent="pageTitle">pageTitle</title> - <link href="css/ApiRefStyles.css" rel="stylesheet" type="text/css"> - <script type="text/javascript" - src="../../../third_party/jstemplate/jstemplate_compiled.js"> - </script> - <script type="text/javascript" src="js/api_page_generator.js"></script> - <script> -// Re-render the page if the user-agent is chrome and it is being served as -// a file:/// scheme. This allows both the initial render to static as well -// as dynamic re-rendering for developers/doc-writers working on local changes. -window.onload = function() { - var chrome = navigator.userAgent.indexOf("Chrome") > -1; - var fileScheme = location.protocol == "file:"; - var regenerate = chrome && fileScheme; - //if (regenerate) { - window.renderPage(); - //} -} - </script> - </head> - <!-- <body> content is completely generated. Do not edit, as it will be - and rewritten. --> - <body class="hidden"> - </body> -</html> +<!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc. Note: 1) The <head> information in this page is significant, should be uniform across api docs and should be edited only with knowledge of the templating mechanism. 2) The <body> tag *must* retain id="body" 3) All <body>.innerHTML is genereated as an rendering step. If viewed in a browser, it will be re-generated from the template, json schema and authored overview content. 4) The <body>.innerHTML is also generated by an offline step so that this page may easily be indexed by search engines. TODO(rafaelw): Abstract this into a "pageshell" that becomes the single version of page template shell and the "instance" pages (bookmarks.html, etc...) can be generated with a build step. --><!-- <html> must retain id="template --><html xmlns="http://www.w3.org/1999/xhtml" jstcache="0"><!-- <head> data is significant and loads the needed libraries and styles --><head jstcache="0"> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" jstcache="0"> <title jscontent="pageTitle" jstcache="1">overview</title> <link href="css/ApiRefStyles.css" rel="stylesheet" type="text/css" jstcache="0"> <script type="text/javascript" src="../../../third_party/jstemplate/jstemplate_compiled.js" jstcache="0"> </script> <script type="text/javascript" src="js/api_page_generator.js" jstcache="0"></script> <script type="text/javascript" src="js/bootstrap.js" jstcache="0"></script> </head><!-- <body> content is completely generated. Do not edit, as it will be and rewritten. --><body class="" jstcache="0"> <div id="container" jstcache="0"> <a name="top" jstcache="0"> </a> <!-- API HEADER --> <div id="pageHeader" jstcache="0"> <!-- BREADCRUMB --> <!-- TODO: Fix these hrefs --> <div id="breadcrumbs" jstcache="0"> <a href="index.html" jstcache="0">Google Chrome Extensions</a> > <a href="reference_index.html" jstcache="0">Reference</a> > <a href="api_index.html" jstcache="0">chrome.* APIs</a> > <span jscontent="namespace" jstcache="2">null</span> </div> <div id="searchbox" jstcache="0"> <form action="http://www.google.com/cse" id="cse-search-box" jstcache="0"> <div jstcache="0"> <input type="hidden" name="cx" value="002967670403910741006:61_cvzfqtno" jstcache="0"> <input type="hidden" name="ie" value="UTF-8" jstcache="0"> <input type="text" name="q" size="31" jstcache="0"> <input type="submit" name="sa" value="Search" jstcache="0"> </div> </form> <script type="text/javascript" src="http://www.google.com/jsapi" jstcache="0"></script> <script type="text/javascript" jstcache="0">google.load("elements", "1", {packages: "transliteration"});</script> <script type="text/javascript" src="http://www.google.com/coop/cse/t13n?form=cse-search-box&t13n_langs=en" jstcache="0"></script> <script type="text/javascript" src="http://www.google.com/coop/cse/brand?form=cse-search-box&lang=en" jstcache="0"></script> </div> <div id="pageTitle" jstcache="0"> <h1 jscontent="h1Header" jstcache="3">overview</h1> </div> </div> <!-- /pageHeader --> <div id="pageContent" jstcache="0"> <!-- SIDENAV --> <div id="leftNav" jstcache="0"> <ul jstcache="0"> <li jstcache="0"> <a href="overview.html" jstcache="0">Overview</a></li> <li jstcache="0"> <a href="getstarted.html" jstcache="0">Get Started</a></li> <li jstcache="0"> <a href="devguide.html" jstcache="0">Developer's Guide</a></li> <li jstcache="0"> Reference <ul jstcache="0"> <li jstcache="0"> <a href="api_index.html" jstcache="0">Extension APIs</a> <ul jstcache="0"> <li jsselect="apiModules" jstcache="18" jsinstance="0"> <a jscontent="name" jsvalues=".href:module + '.html'" jstcache="25" href="bookmarks.html">Bookmarks</a> </li><li jsselect="apiModules" jstcache="18" jsinstance="1"> <a jscontent="name" jsvalues=".href:module + '.html'" jstcache="25" href="toolstrip.html">Toolstrip</a> </li><li jsselect="apiModules" jstcache="18" jsinstance="2"> <a jscontent="name" jsvalues=".href:module + '.html'" jstcache="25" href="pageActions.html">PageActions</a> </li><li jsselect="apiModules" jstcache="18" jsinstance="3"> <a jscontent="name" jsvalues=".href:module + '.html'" jstcache="25" href="windows.html">Windows</a> </li><li jsselect="apiModules" jstcache="18" jsinstance="4"> <a jscontent="name" jsvalues=".href:module + '.html'" jstcache="25" href="tabs.html">Tabs</a> </li><li jsselect="apiModules" jstcache="18" jsinstance="*5"> <a jscontent="name" jsvalues=".href:module + '.html'" jstcache="25" href="self.html">Self</a> </li> </ul> </li> </ul> </li> </ul> </div> <div id="mainColumn" jstcache="0"> <!-- TABLE OF CONTENTS --> <div id="toc" jsselect="apiDefinition" jstcache="4" style="display: none; "> <p jstcache="0">Contents</p> <ol jstcache="0"> <li jstcache="0"> <a href="#overview" jstcache="0">Description</a> <ol jstcache="0"> <li jstcache="0"><a href="#overview-properties" jstcache="0">Properties</a></li> <li jstcache="0"><a href="#overview-examples" jstcache="0">Examples</a></li> </ol> </li> <li jstcache="0"> <a href="#methods" jstcache="0">Methods</a> <ol jstcache="0"> <li jsselect="functions" jstcache="5"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-anchor" jstcache="19">methodName</a> </li> </ol> </li> <li jstcache="0"> <a href="#events" jstcache="0">Events</a> <ol jstcache="0"> <li jsselect="events" jstcache="6"> <a jscontent="name" jsvalues=".href:'#event-' + name" href="#event-anchor" jstcache="20">eventName</a> </li> </ol> </li> <!-- TODO: What do we do about structs/types? --> <li jstcache="0"> <a href="#structs" jstcache="0">TODO: Structs</a> <ol jstcache="0"> <li jstcache="0"><a href="#struct-BookmarkTreeNode" jstcache="0"></a></li> </ol> </li> </ol> [PENDING: links to all h2s and h3s should go here -- would it be possible to link to overview h3s, as well? if so, how should we create their anchor/id values?] </div> <!-- /TABLE OF CONTENTS --> <!-- STATIC CONTENT PLACEHOLDER --> <div id="static" jstcache="0"><p jstcache="0"> [PENDING: technical overview to be provided] </p> <p jstcache="0"> Lorem ipsum dolor sit amet, consectetur adipiscing elit. Fusce sed elit felis. Vestibulum porta mauris eget mi placerat a condimentum leo semper. Ut scelerisque, ipsum in cursus semper, lectus enim molestie ante, a porttitor dolor neque sit amet lorem. Integer dignissim gravida eros ac rhoncus. Curabitur porttitor hendrerit dolor nec aliquam. Ut vulputate ultrices eros eu ultrices. Pellentesque tempor mattis odio in blandit. Proin nulla metus, tristique eget iaculis gravida, varius at leo. Ut dolor mi, auctor et scelerisque vitae, volutpat eleifend magna. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Morbi ut risus nec massa consectetur accumsan sed non est. Fusce ornare eros et felis dignissim convallis. Maecenas condimentum purus eget nisl condimentum vitae ornare diam sollicitudin. Nulla et dictum ante. In lacus odio, dapibus vel faucibus at, posuere id enim. Nulla tincidunt felis id lectus convallis vulputate. Phasellus libero dui, posuere sollicitudin egestas eget, blandit in urna. Sed cursus tellus sed diam hendrerit pulvinar. </p> <p jstcache="0"> Nam tincidunt mollis aliquam. Suspendisse bibendum dignissim dui, ac mollis ligula fringilla sit amet. Pellentesque dapibus lobortis dignissim. Cras eu lorem a ligula imperdiet ultricies. Phasellus ipsum mi, accumsan quis dignissim eu, commodo ut mi. Nulla sagittis aliquet malesuada. Ut lobortis tellus vitae dolor venenatis eu ullamcorper lorem gravida. Quisque non pharetra velit. Maecenas elit risus, ultricies in sagittis eget, facilisis sed neque. Quisque feugiat porta pharetra. Vestibulum lorem magna, pellentesque et mattis sit amet, euismod et dui. </p> <p jstcache="0"> Phasellus consectetur dolor auctor mi luctus eu auctor velit aliquam. Donec malesuada laoreet risus, et facilisis massa rhoncus sit amet. Vivamus sit amet fermentum lorem. Morbi nulla quam, ultricies malesuada scelerisque a, convallis vitae nisl. Pellentesque consequat libero sit amet lectus convallis varius. Donec at mi orci. Duis malesuada massa nulla. Nam vel tellus mauris. Suspendisse potenti. Cras euismod, orci volutpat ornare condimentum, eros nibh iaculis lectus, ac euismod nibh eros nec turpis. Nullam at est elit, quis sagittis est. </p> <p jstcache="0"> Donec aliquet, velit in elementum semper, purus metus laoreet nisl, in aliquet nulla erat eu quam. Fusce iaculis, augue quis tristique posuere, massa tortor congue lacus, ac scelerisque velit tortor eget lorem. Praesent in massa enim, fermentum imperdiet ligula. Suspendisse purus sapien, sagittis eu condimentum ut, scelerisque vel purus. Vestibulum ornare faucibus metus eu rutrum. Maecenas convallis felis vitae lorem tincidunt vitae interdum nunc adipiscing. Proin a egestas enim. Proin mattis mollis urna id lobortis. Sed id libero nec purus sollicitudin tristique id vitae purus. Duis rutrum semper mollis. Nam posuere nulla at mi egestas nec auctor mauris pretium. Ut nec quam lectus. Vivamus laoreet ligula ut odio ultricies aliquet. Aliquam erat volutpat. Nunc quis lectus vitae massa consectetur tempus vitae eu mi. </p> <p jstcache="0"> Duis vel nunc ut orci pretium eleifend ac posuere nisi. Curabitur in lorem in sapien lobortis facilisis. Vestibulum varius sapien lacus. Morbi urna sapien, iaculis a mollis eget, pharetra id sapien. Nulla bibendum, tellus non tristique sodales, eros erat elementum nisl, et ultricies velit mauris nec odio. Aliquam nisi turpis, accumsan sit amet condimentum non, volutpat eget arcu. Praesent euismod elementum lorem, in mollis justo lacinia ut. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Mauris aliquet elit sit amet dolor iaculis viverra vehicula magna accumsan. Praesent tempor imperdiet mauris, eu viverra mauris ultricies sed. In quam lacus, porttitor in facilisis id, blandit vel massa. Maecenas rutrum ullamcorper enim eu bibendum. Fusce mauris velit, eleifend vitae consectetur et, condimentum at nunc. Proin id hendrerit turpis. </p> </div> <!-- API PAGE --> <div class="apiPage" jsselect="apiDefinition" jstcache="4" style="display: none; "> <!-- METHODS --> <div class="apiGroup" id="methods" jstcache="0"> <a name="#methods" jstcache="0"></a> <h2 jstcache="0">Methods</h2> <!-- iterates over all functions --> <div class="apiItem" jsselect="functions" jstcache="5"> <a jsvalues=".name:'method-' + name" jstcache="7"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="8">method name</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="returns.typeName" jstcache="10">void</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="fullName" jstcache="11">chrome.module.methodName</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="12"><span jsdisplay="$index" jstcache="21">, </span><span jscontent="typeName" jstcache="22"></span> <var jstcache="0"><span jscontent="name" jstcache="8"></span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="13">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="14"> A description from the json schema def of the function goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="23"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="15">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="24"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var> <em jstcache="0">(<span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> <!-- CALLBACK --> <div jsdisplay="callbackParameters" jstcache="16"> <h4 jstcache="0">Callback function</h4> <p jstcache="0"> If you specify the <em jstcache="0">callback</em> parameter, it should specify a function that looks like this: </p> <!-- Note: intentionally longer 80 columns --> <pre jstcache="0">function(<span jscontent="callbackSignature" jstcache="29">Type param1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="callbackParameters" jstcache="30"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> </div> </div> <!-- /description --> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> <!-- EVENTS --> <div class="apiGroup" id="events" jstcache="0"> <a name="#events" jstcache="0"></a> <h2 id="events" jstcache="0">Events</h2> <!-- iterates over all events --> <div jsselect="events" class="apiItem" jstcache="6"> <a jsvalues=".name:'event-' + name" jstcache="9"></a> <h3 jscontent="name" jstcache="8">event name</h3> <div class="summary" jstcache="0"> <!-- Note: intentionally longer 80 columns --> <span class="subdued" jstcache="0">chrome.bookmarks.</span><span jscontent="name" jstcache="8">onEvent</span><span class="subdued" jstcache="0">.addListener</span>(function(<span jscontent="callSignature" jstcache="17">Type param1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>); </div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="13">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="14"> A description from the json schema def of the event goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="23"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26">Undocumented.</dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> </div> <!-- /decription --> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> </div> <!-- /apiPage --> </div> <!-- /mainColumn --> </div> <!-- /pageContent --> <div id="pageFooter" --="" jstcache="0"> Copyright 2009 <br jstcache="0"> TBD: copyright/license should be automatically included here </div> <!-- /pageFooter --> </div> <!-- /container --> </body></html>
diff --git a/chrome/common/extensions/docs/pageActions.html b/chrome/common/extensions/docs/pageActions.html index faf8a37..74c72ee7 100755 --- a/chrome/common/extensions/docs/pageActions.html +++ b/chrome/common/extensions/docs/pageActions.html @@ -1,46 +1 @@ -<!DOCTYPE html> -<!-- This page is a placeholder for generated extensions api doc. Note: - 1) The <head> information in this page is significant, should be uniform - across api docs and should be edited only with knowledge of the - templating mechanism. - 2) The <body> tag *must* retain id="body" - 3) All <body>.innerHTML is genereated as an rendering step. If viewed in a - browser, it will be re-generated from the template, json schema and - authored overview content. - 4) The <body>.innerHTML is also generated by an offline step so that this - page may easily be indexed by search engines. - - TODO(rafaelw): Abstract this into a "pageshell" that becomes the single - version of page template shell and the "instance" pages (bookmarks.html, - etc...) can be generated with a build step. ---> -<!-- <html> must retain id="template --> -<html xmlns="http://www.w3.org/1999/xhtml"> - <!-- <head> data is significant and loads the needed libraries and styles --> - <head> - <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> - <title jscontent="pageTitle">pageTitle</title> - <link href="css/ApiRefStyles.css" rel="stylesheet" type="text/css"> - <script type="text/javascript" - src="../../../third_party/jstemplate/jstemplate_compiled.js"> - </script> - <script type="text/javascript" src="js/api_page_generator.js"></script> - <script> -// Re-render the page if the user-agent is chrome and it is being served as -// a file:/// scheme. This allows both the initial render to static as well -// as dynamic re-rendering for developers/doc-writers working on local changes. -window.onload = function() { - var chrome = navigator.userAgent.indexOf("Chrome") > -1; - var fileScheme = location.protocol == "file:"; - var regenerate = chrome && fileScheme; - //if (regenerate) { - window.renderPage(); - //} -} - </script> - </head> - <!-- <body> content is completely generated. Do not edit, as it will be - and rewritten. --> - <body class="hidden"> - </body> -</html> +<!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc. Note: 1) The <head> information in this page is significant, should be uniform across api docs and should be edited only with knowledge of the templating mechanism. 2) The <body> tag *must* retain id="body" 3) All <body>.innerHTML is genereated as an rendering step. If viewed in a browser, it will be re-generated from the template, json schema and authored overview content. 4) The <body>.innerHTML is also generated by an offline step so that this page may easily be indexed by search engines. TODO(rafaelw): Abstract this into a "pageshell" that becomes the single version of page template shell and the "instance" pages (bookmarks.html, etc...) can be generated with a build step. --><!-- <html> must retain id="template --><html xmlns="http://www.w3.org/1999/xhtml" jstcache="0"><!-- <head> data is significant and loads the needed libraries and styles --><head jstcache="0"> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" jstcache="0"> <title jscontent="pageTitle" jstcache="1">chrome.pageActions API Reference</title> <link href="css/ApiRefStyles.css" rel="stylesheet" type="text/css" jstcache="0"> <script type="text/javascript" src="../../../third_party/jstemplate/jstemplate_compiled.js" jstcache="0"> </script> <script type="text/javascript" src="js/api_page_generator.js" jstcache="0"></script> <script type="text/javascript" src="js/bootstrap.js" jstcache="0"></script> </head><!-- <body> content is completely generated. Do not edit, as it will be and rewritten. --><body class="" jstcache="0"> <div id="container" jstcache="0"> <a name="top" jstcache="0"> </a> <!-- API HEADER --> <div id="pageHeader" jstcache="0"> <!-- BREADCRUMB --> <!-- TODO: Fix these hrefs --> <div id="breadcrumbs" jstcache="0"> <a href="index.html" jstcache="0">Google Chrome Extensions</a> > <a href="reference_index.html" jstcache="0">Reference</a> > <a href="api_index.html" jstcache="0">chrome.* APIs</a> > <span jscontent="namespace" jstcache="2">null</span> </div> <div id="searchbox" jstcache="0"> <form action="http://www.google.com/cse" id="cse-search-box" jstcache="0"> <div jstcache="0"> <input type="hidden" name="cx" value="002967670403910741006:61_cvzfqtno" jstcache="0"> <input type="hidden" name="ie" value="UTF-8" jstcache="0"> <input type="text" name="q" size="31" jstcache="0"> <input type="submit" name="sa" value="Search" jstcache="0"> </div> </form> <script type="text/javascript" src="http://www.google.com/jsapi" jstcache="0"></script> <script type="text/javascript" jstcache="0">google.load("elements", "1", {packages: "transliteration"});</script> <script type="text/javascript" src="http://www.google.com/coop/cse/t13n?form=cse-search-box&t13n_langs=en" jstcache="0"></script> <script type="text/javascript" src="http://www.google.com/coop/cse/brand?form=cse-search-box&lang=en" jstcache="0"></script> </div> <div id="pageTitle" jstcache="0"> <h1 jscontent="h1Header" jstcache="3">chrome.pageActions</h1> </div> </div> <!-- /pageHeader --> <div id="pageContent" jstcache="0"> <!-- SIDENAV --> <div id="leftNav" jstcache="0"> <ul jstcache="0"> <li jstcache="0"> <a href="overview.html" jstcache="0">Overview</a></li> <li jstcache="0"> <a href="getstarted.html" jstcache="0">Get Started</a></li> <li jstcache="0"> <a href="devguide.html" jstcache="0">Developer's Guide</a></li> <li jstcache="0"> Reference <ul jstcache="0"> <li jstcache="0"> <a href="api_index.html" jstcache="0">Extension APIs</a> <ul jstcache="0"> <li jsselect="apiModules" jstcache="18" jsinstance="0"> <a jscontent="name" jsvalues=".href:module + '.html'" jstcache="25" href="bookmarks.html">Bookmarks</a> </li><li jsselect="apiModules" jstcache="18" jsinstance="1"> <a jscontent="name" jsvalues=".href:module + '.html'" jstcache="25" href="toolstrip.html">Toolstrip</a> </li><li jsselect="apiModules" jstcache="18" jsinstance="2"> <a jscontent="name" jsvalues=".href:module + '.html'" jstcache="25" href="pageActions.html">PageActions</a> </li><li jsselect="apiModules" jstcache="18" jsinstance="3"> <a jscontent="name" jsvalues=".href:module + '.html'" jstcache="25" href="windows.html">Windows</a> </li><li jsselect="apiModules" jstcache="18" jsinstance="4"> <a jscontent="name" jsvalues=".href:module + '.html'" jstcache="25" href="tabs.html">Tabs</a> </li><li jsselect="apiModules" jstcache="18" jsinstance="*5"> <a jscontent="name" jsvalues=".href:module + '.html'" jstcache="25" href="self.html">Self</a> </li> </ul> </li> </ul> </li> </ul> </div> <div id="mainColumn" jstcache="0"> <!-- TABLE OF CONTENTS --> <div id="toc" jsselect="apiDefinition" jstcache="4"> <p jstcache="0">Contents</p> <ol jstcache="0"> <li jstcache="0"> <a href="#overview" jstcache="0">Description</a> <ol jstcache="0"> <li jstcache="0"><a href="#overview-properties" jstcache="0">Properties</a></li> <li jstcache="0"><a href="#overview-examples" jstcache="0">Examples</a></li> </ol> </li> <li jstcache="0"> <a href="#methods" jstcache="0">Methods</a> <ol jstcache="0"> <li jsselect="functions" jstcache="5" jsinstance="0"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-enableForTab" jstcache="19">enableForTab</a> </li><li jsselect="functions" jstcache="5" jsinstance="*1"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-disableForTab" jstcache="19">disableForTab</a> </li> </ol> </li> <li jstcache="0"> <a href="#events" jstcache="0">Events</a> <ol jstcache="0"> <li jsselect="events" jstcache="6" jsinstance="*0" style="display: none; "> <a jscontent="name" jsvalues=".href:'#event-' + name" href="#event-anchor" jstcache="20">eventName</a> </li> </ol> </li> <!-- TODO: What do we do about structs/types? --> <li jstcache="0"> <a href="#structs" jstcache="0">TODO: Structs</a> <ol jstcache="0"> <li jstcache="0"><a href="#struct-BookmarkTreeNode" jstcache="0"></a></li> </ol> </li> </ol> [PENDING: links to all h2s and h3s should go here -- would it be possible to link to overview h3s, as well? if so, how should we create their anchor/id values?] </div> <!-- /TABLE OF CONTENTS --> <!-- STATIC CONTENT PLACEHOLDER --> <div id="static" jstcache="0"><!-- BEGIN AUTHORED CONTENT --> <p class="todo" jstcache="0"> [PENDING: API Module Overview Goes Here] </p> <!-- END AUTHORED CONTENT --> </div> <!-- API PAGE --> <div class="apiPage" jsselect="apiDefinition" jstcache="4"> <!-- METHODS --> <div class="apiGroup" id="methods" jstcache="0"> <a name="#methods" jstcache="0"></a> <h2 jstcache="0">Methods</h2> <!-- iterates over all functions --> <div class="apiItem" jsselect="functions" jstcache="5" jsinstance="0"> <a jsvalues=".name:'method-' + name" jstcache="7" name="method-enableForTab"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="8">enableForTab</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="returns.typeName" jstcache="10" style="display: none; ">void</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="fullName" jstcache="11">chrome.pageActions.enableForTab</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="12" jsinstance="0" class="null"><span jsdisplay="$index" jstcache="21" style="display: none; ">, </span><span jscontent="typeName" jstcache="22">string</span> <var jstcache="0"><span jscontent="name" jstcache="8">pageActionId</span></var></span><span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="12" jsinstance="*1" class=""><span jsdisplay="$index" jstcache="21">, </span><span jscontent="typeName" jstcache="22">object</span> <var jstcache="0"><span jscontent="name" jstcache="8">action</span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="13">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="14" style="display: none; "> A description from the json schema def of the function goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="23" jsinstance="0"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">pageActionId</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31" style="display: none; ">optional </span><span jscontent="typeName" jstcache="22">string</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28" style="display: none; "> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div><div jsselect="parameters" jstcache="23" jsinstance="*1"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">action</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31" style="display: none; ">optional </span><span jscontent="typeName" jstcache="22">object</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32" jsinstance="0"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">tabId</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31" style="display: none; ">optional </span><span jscontent="typeName" jstcache="22">integer</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> </div><div jsselect="_propertyList" jstcache="32" jsinstance="1"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">url</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31" style="display: none; ">optional </span><span jscontent="typeName" jstcache="22">string</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> </div><div jsselect="_propertyList" jstcache="32" jsinstance="2"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">title</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">string</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> </div><div jsselect="_propertyList" jstcache="32" jsinstance="*3"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">iconId</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">integer</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="15" style="display: none; ">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="24" style="display: none; "> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var> <em jstcache="0">(<span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> <!-- CALLBACK --> <div jsdisplay="callbackParameters" jstcache="16" style="display: none; "> <h4 jstcache="0">Callback function</h4> <p jstcache="0"> If you specify the <em jstcache="0">callback</em> parameter, it should specify a function that looks like this: </p> <!-- Note: intentionally longer 80 columns --> <pre jstcache="0">function(<span jscontent="callbackSignature" jstcache="29">Type param1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="callbackParameters" jstcache="30"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> </div> </div> <!-- /description --> </div><div class="apiItem" jsselect="functions" jstcache="5" jsinstance="*1"> <a jsvalues=".name:'method-' + name" jstcache="7" name="method-disableForTab"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="8">disableForTab</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="returns.typeName" jstcache="10" style="display: none; ">void</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="fullName" jstcache="11">chrome.pageActions.disableForTab</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="12" jsinstance="0" class="null"><span jsdisplay="$index" jstcache="21" style="display: none; ">, </span><span jscontent="typeName" jstcache="22">string</span> <var jstcache="0"><span jscontent="name" jstcache="8">pageActionId</span></var></span><span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="12" jsinstance="*1" class=""><span jsdisplay="$index" jstcache="21">, </span><span jscontent="typeName" jstcache="22">object</span> <var jstcache="0"><span jscontent="name" jstcache="8">action</span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="13">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="14" style="display: none; "> A description from the json schema def of the function goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="23" jsinstance="0"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">pageActionId</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31" style="display: none; ">optional </span><span jscontent="typeName" jstcache="22">string</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28" style="display: none; "> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div><div jsselect="parameters" jstcache="23" jsinstance="*1"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">action</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31" style="display: none; ">optional </span><span jscontent="typeName" jstcache="22">object</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32" jsinstance="0"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">tabId</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31" style="display: none; ">optional </span><span jscontent="typeName" jstcache="22">integer</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> </div><div jsselect="_propertyList" jstcache="32" jsinstance="*1"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">url</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31" style="display: none; ">optional </span><span jscontent="typeName" jstcache="22">string</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="15" style="display: none; ">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="24" style="display: none; "> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var> <em jstcache="0">(<span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> <!-- CALLBACK --> <div jsdisplay="callbackParameters" jstcache="16" style="display: none; "> <h4 jstcache="0">Callback function</h4> <p jstcache="0"> If you specify the <em jstcache="0">callback</em> parameter, it should specify a function that looks like this: </p> <!-- Note: intentionally longer 80 columns --> <pre jstcache="0">function(<span jscontent="callbackSignature" jstcache="29">Type param1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="callbackParameters" jstcache="30"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> </div> </div> <!-- /description --> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> <!-- EVENTS --> <div class="apiGroup" id="events" jstcache="0"> <a name="#events" jstcache="0"></a> <h2 id="events" jstcache="0">Events</h2> <!-- iterates over all events --> <div jsselect="events" class="apiItem" jstcache="6" jsinstance="*0" style="display: none; "> <a jsvalues=".name:'event-' + name" jstcache="9"></a> <h3 jscontent="name" jstcache="8">event name</h3> <div class="summary" jstcache="0"> <!-- Note: intentionally longer 80 columns --> <span class="subdued" jstcache="0">chrome.bookmarks.</span><span jscontent="name" jstcache="8">onEvent</span><span class="subdued" jstcache="0">.addListener</span>(function(<span jscontent="callSignature" jstcache="17">Type param1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>); </div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="13">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="14"> A description from the json schema def of the event goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="23"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26">Undocumented.</dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> </div> <!-- /decription --> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> </div> <!-- /apiPage --> </div> <!-- /mainColumn --> </div> <!-- /pageContent --> <div id="pageFooter" --="" jstcache="0"> Copyright 2009 <br jstcache="0"> TBD: copyright/license should be automatically included here </div> <!-- /pageFooter --> </div> <!-- /container --> </body></html>
diff --git a/chrome/common/extensions/docs/self.html b/chrome/common/extensions/docs/self.html index faf8a37..ef436d8 100755 --- a/chrome/common/extensions/docs/self.html +++ b/chrome/common/extensions/docs/self.html @@ -1,46 +1 @@ -<!DOCTYPE html> -<!-- This page is a placeholder for generated extensions api doc. Note: - 1) The <head> information in this page is significant, should be uniform - across api docs and should be edited only with knowledge of the - templating mechanism. - 2) The <body> tag *must* retain id="body" - 3) All <body>.innerHTML is genereated as an rendering step. If viewed in a - browser, it will be re-generated from the template, json schema and - authored overview content. - 4) The <body>.innerHTML is also generated by an offline step so that this - page may easily be indexed by search engines. - - TODO(rafaelw): Abstract this into a "pageshell" that becomes the single - version of page template shell and the "instance" pages (bookmarks.html, - etc...) can be generated with a build step. ---> -<!-- <html> must retain id="template --> -<html xmlns="http://www.w3.org/1999/xhtml"> - <!-- <head> data is significant and loads the needed libraries and styles --> - <head> - <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> - <title jscontent="pageTitle">pageTitle</title> - <link href="css/ApiRefStyles.css" rel="stylesheet" type="text/css"> - <script type="text/javascript" - src="../../../third_party/jstemplate/jstemplate_compiled.js"> - </script> - <script type="text/javascript" src="js/api_page_generator.js"></script> - <script> -// Re-render the page if the user-agent is chrome and it is being served as -// a file:/// scheme. This allows both the initial render to static as well -// as dynamic re-rendering for developers/doc-writers working on local changes. -window.onload = function() { - var chrome = navigator.userAgent.indexOf("Chrome") > -1; - var fileScheme = location.protocol == "file:"; - var regenerate = chrome && fileScheme; - //if (regenerate) { - window.renderPage(); - //} -} - </script> - </head> - <!-- <body> content is completely generated. Do not edit, as it will be - and rewritten. --> - <body class="hidden"> - </body> -</html> +<!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc. Note: 1) The <head> information in this page is significant, should be uniform across api docs and should be edited only with knowledge of the templating mechanism. 2) The <body> tag *must* retain id="body" 3) All <body>.innerHTML is genereated as an rendering step. If viewed in a browser, it will be re-generated from the template, json schema and authored overview content. 4) The <body>.innerHTML is also generated by an offline step so that this page may easily be indexed by search engines. TODO(rafaelw): Abstract this into a "pageshell" that becomes the single version of page template shell and the "instance" pages (bookmarks.html, etc...) can be generated with a build step. --><!-- <html> must retain id="template --><html xmlns="http://www.w3.org/1999/xhtml" jstcache="0"><!-- <head> data is significant and loads the needed libraries and styles --><head jstcache="0"> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" jstcache="0"> <title jscontent="pageTitle" jstcache="1">chrome.self API Reference</title> <link href="css/ApiRefStyles.css" rel="stylesheet" type="text/css" jstcache="0"> <script type="text/javascript" src="../../../third_party/jstemplate/jstemplate_compiled.js" jstcache="0"> </script> <script type="text/javascript" src="js/api_page_generator.js" jstcache="0"></script> <script type="text/javascript" src="js/bootstrap.js" jstcache="0"></script> </head><!-- <body> content is completely generated. Do not edit, as it will be and rewritten. --><body class="" jstcache="0"> <div id="container" jstcache="0"> <a name="top" jstcache="0"> </a> <!-- API HEADER --> <div id="pageHeader" jstcache="0"> <!-- BREADCRUMB --> <!-- TODO: Fix these hrefs --> <div id="breadcrumbs" jstcache="0"> <a href="index.html" jstcache="0">Google Chrome Extensions</a> > <a href="reference_index.html" jstcache="0">Reference</a> > <a href="api_index.html" jstcache="0">chrome.* APIs</a> > <span jscontent="namespace" jstcache="2">null</span> </div> <div id="searchbox" jstcache="0"> <form action="http://www.google.com/cse" id="cse-search-box" jstcache="0"> <div jstcache="0"> <input type="hidden" name="cx" value="002967670403910741006:61_cvzfqtno" jstcache="0"> <input type="hidden" name="ie" value="UTF-8" jstcache="0"> <input type="text" name="q" size="31" jstcache="0"> <input type="submit" name="sa" value="Search" jstcache="0"> </div> </form> <script type="text/javascript" src="http://www.google.com/jsapi" jstcache="0"></script> <script type="text/javascript" jstcache="0">google.load("elements", "1", {packages: "transliteration"});</script> <script type="text/javascript" src="http://www.google.com/coop/cse/t13n?form=cse-search-box&t13n_langs=en" jstcache="0"></script> <script type="text/javascript" src="http://www.google.com/coop/cse/brand?form=cse-search-box&lang=en" jstcache="0"></script> </div> <div id="pageTitle" jstcache="0"> <h1 jscontent="h1Header" jstcache="3">chrome.self</h1> </div> </div> <!-- /pageHeader --> <div id="pageContent" jstcache="0"> <!-- SIDENAV --> <div id="leftNav" jstcache="0"> <ul jstcache="0"> <li jstcache="0"> <a href="overview.html" jstcache="0">Overview</a></li> <li jstcache="0"> <a href="getstarted.html" jstcache="0">Get Started</a></li> <li jstcache="0"> <a href="devguide.html" jstcache="0">Developer's Guide</a></li> <li jstcache="0"> Reference <ul jstcache="0"> <li jstcache="0"> <a href="api_index.html" jstcache="0">Extension APIs</a> <ul jstcache="0"> <li jsselect="apiModules" jstcache="18" jsinstance="0"> <a jscontent="name" jsvalues=".href:module + '.html'" jstcache="25" href="bookmarks.html">Bookmarks</a> </li><li jsselect="apiModules" jstcache="18" jsinstance="1"> <a jscontent="name" jsvalues=".href:module + '.html'" jstcache="25" href="toolstrip.html">Toolstrip</a> </li><li jsselect="apiModules" jstcache="18" jsinstance="2"> <a jscontent="name" jsvalues=".href:module + '.html'" jstcache="25" href="pageActions.html">PageActions</a> </li><li jsselect="apiModules" jstcache="18" jsinstance="3"> <a jscontent="name" jsvalues=".href:module + '.html'" jstcache="25" href="windows.html">Windows</a> </li><li jsselect="apiModules" jstcache="18" jsinstance="4"> <a jscontent="name" jsvalues=".href:module + '.html'" jstcache="25" href="tabs.html">Tabs</a> </li><li jsselect="apiModules" jstcache="18" jsinstance="*5"> <a jscontent="name" jsvalues=".href:module + '.html'" jstcache="25" href="self.html">Self</a> </li> </ul> </li> </ul> </li> </ul> </div> <div id="mainColumn" jstcache="0"> <!-- TABLE OF CONTENTS --> <div id="toc" jsselect="apiDefinition" jstcache="4"> <p jstcache="0">Contents</p> <ol jstcache="0"> <li jstcache="0"> <a href="#overview" jstcache="0">Description</a> <ol jstcache="0"> <li jstcache="0"><a href="#overview-properties" jstcache="0">Properties</a></li> <li jstcache="0"><a href="#overview-examples" jstcache="0">Examples</a></li> </ol> </li> <li jstcache="0"> <a href="#methods" jstcache="0">Methods</a> <ol jstcache="0"> <li jsselect="functions" jstcache="5" jsinstance="*0"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-getViews" jstcache="19">getViews</a> </li> </ol> </li> <li jstcache="0"> <a href="#events" jstcache="0">Events</a> <ol jstcache="0"> <li jsselect="events" jstcache="6" jsinstance="*0" style="display: none; "> <a jscontent="name" jsvalues=".href:'#event-' + name" href="#event-anchor" jstcache="20">eventName</a> </li> </ol> </li> <!-- TODO: What do we do about structs/types? --> <li jstcache="0"> <a href="#structs" jstcache="0">TODO: Structs</a> <ol jstcache="0"> <li jstcache="0"><a href="#struct-BookmarkTreeNode" jstcache="0"></a></li> </ol> </li> </ol> [PENDING: links to all h2s and h3s should go here -- would it be possible to link to overview h3s, as well? if so, how should we create their anchor/id values?] </div> <!-- /TABLE OF CONTENTS --> <!-- STATIC CONTENT PLACEHOLDER --> <div id="static" jstcache="0"><!-- BEGIN AUTHORED CONTENT --> <p class="todo" jstcache="0"> [PENDING: API Module Overview Goes Here] </p> <!-- END AUTHORED CONTENT --> </div> <!-- API PAGE --> <div class="apiPage" jsselect="apiDefinition" jstcache="4"> <!-- METHODS --> <div class="apiGroup" id="methods" jstcache="0"> <a name="#methods" jstcache="0"></a> <h2 jstcache="0">Methods</h2> <!-- iterates over all functions --> <div class="apiItem" jsselect="functions" jstcache="5" jsinstance="*0"> <a jsvalues=".name:'method-' + name" jstcache="7" name="method-getViews"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="8">getViews</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="returns.typeName" jstcache="10">array of object</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="fullName" jstcache="11">chrome.self.getViews</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="12" jsinstance="*0" style="display: none; "><span jsdisplay="$index" jstcache="21">, </span><span jscontent="typeName" jstcache="22"></span> <var jstcache="0"><span jscontent="name" jstcache="8"></span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="13" style="display: none; ">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="14">Returns an array of the global JavaScript objects for each of the views running inside the current extension. This includes toolstrips, background pages, and tabs.</p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="23" jsinstance="*0" style="display: none; "> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="15">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="24"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8"><!--framePath //<!--frame0-->--></var> <em jstcache="0">(<span jscontent="typeName" jstcache="22">array of object</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26" style="display: none; "> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27">Array of HTMLWindow objects</dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28" style="display: none; "> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> <!-- CALLBACK --> <div jsdisplay="callbackParameters" jstcache="16" style="display: none; "> <h4 jstcache="0">Callback function</h4> <p jstcache="0"> If you specify the <em jstcache="0">callback</em> parameter, it should specify a function that looks like this: </p> <!-- Note: intentionally longer 80 columns --> <pre jstcache="0">function(<span jscontent="callbackSignature" jstcache="29">Type param1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="callbackParameters" jstcache="30"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> </div> </div> <!-- /description --> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> <!-- EVENTS --> <div class="apiGroup" id="events" jstcache="0"> <a name="#events" jstcache="0"></a> <h2 id="events" jstcache="0">Events</h2> <!-- iterates over all events --> <div jsselect="events" class="apiItem" jstcache="6" jsinstance="*0" style="display: none; "> <a jsvalues=".name:'event-' + name" jstcache="9"></a> <h3 jscontent="name" jstcache="8">event name</h3> <div class="summary" jstcache="0"> <!-- Note: intentionally longer 80 columns --> <span class="subdued" jstcache="0">chrome.bookmarks.</span><span jscontent="name" jstcache="8">onEvent</span><span class="subdued" jstcache="0">.addListener</span>(function(<span jscontent="callSignature" jstcache="17">Type param1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>); </div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="13">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="14"> A description from the json schema def of the event goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="23"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26">Undocumented.</dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> </div> <!-- /decription --> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> </div> <!-- /apiPage --> </div> <!-- /mainColumn --> </div> <!-- /pageContent --> <div id="pageFooter" --="" jstcache="0"> Copyright 2009 <br jstcache="0"> TBD: copyright/license should be automatically included here </div> <!-- /pageFooter --> </div> <!-- /container --> </body></html>
diff --git a/chrome/common/extensions/docs/tabs.html b/chrome/common/extensions/docs/tabs.html index faf8a37..a14315f 100755 --- a/chrome/common/extensions/docs/tabs.html +++ b/chrome/common/extensions/docs/tabs.html @@ -1,46 +1 @@ -<!DOCTYPE html> -<!-- This page is a placeholder for generated extensions api doc. Note: - 1) The <head> information in this page is significant, should be uniform - across api docs and should be edited only with knowledge of the - templating mechanism. - 2) The <body> tag *must* retain id="body" - 3) All <body>.innerHTML is genereated as an rendering step. If viewed in a - browser, it will be re-generated from the template, json schema and - authored overview content. - 4) The <body>.innerHTML is also generated by an offline step so that this - page may easily be indexed by search engines. - - TODO(rafaelw): Abstract this into a "pageshell" that becomes the single - version of page template shell and the "instance" pages (bookmarks.html, - etc...) can be generated with a build step. ---> -<!-- <html> must retain id="template --> -<html xmlns="http://www.w3.org/1999/xhtml"> - <!-- <head> data is significant and loads the needed libraries and styles --> - <head> - <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> - <title jscontent="pageTitle">pageTitle</title> - <link href="css/ApiRefStyles.css" rel="stylesheet" type="text/css"> - <script type="text/javascript" - src="../../../third_party/jstemplate/jstemplate_compiled.js"> - </script> - <script type="text/javascript" src="js/api_page_generator.js"></script> - <script> -// Re-render the page if the user-agent is chrome and it is being served as -// a file:/// scheme. This allows both the initial render to static as well -// as dynamic re-rendering for developers/doc-writers working on local changes. -window.onload = function() { - var chrome = navigator.userAgent.indexOf("Chrome") > -1; - var fileScheme = location.protocol == "file:"; - var regenerate = chrome && fileScheme; - //if (regenerate) { - window.renderPage(); - //} -} - </script> - </head> - <!-- <body> content is completely generated. Do not edit, as it will be - and rewritten. --> - <body class="hidden"> - </body> -</html> +<!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc. Note: 1) The <head> information in this page is significant, should be uniform across api docs and should be edited only with knowledge of the templating mechanism. 2) The <body> tag *must* retain id="body" 3) All <body>.innerHTML is genereated as an rendering step. If viewed in a browser, it will be re-generated from the template, json schema and authored overview content. 4) The <body>.innerHTML is also generated by an offline step so that this page may easily be indexed by search engines. TODO(rafaelw): Abstract this into a "pageshell" that becomes the single version of page template shell and the "instance" pages (bookmarks.html, etc...) can be generated with a build step. --><!-- <html> must retain id="template --><html xmlns="http://www.w3.org/1999/xhtml" jstcache="0"><!-- <head> data is significant and loads the needed libraries and styles --><head jstcache="0"> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" jstcache="0"> <title jscontent="pageTitle" jstcache="1">chrome.tabs API Reference</title> <link href="css/ApiRefStyles.css" rel="stylesheet" type="text/css" jstcache="0"> <script type="text/javascript" src="../../../third_party/jstemplate/jstemplate_compiled.js" jstcache="0"> </script> <script type="text/javascript" src="js/api_page_generator.js" jstcache="0"></script> <script type="text/javascript" src="js/bootstrap.js" jstcache="0"></script> </head><!-- <body> content is completely generated. Do not edit, as it will be and rewritten. --><body class="" jstcache="0"> <div id="container" jstcache="0"> <a name="top" jstcache="0"> </a> <!-- API HEADER --> <div id="pageHeader" jstcache="0"> <!-- BREADCRUMB --> <!-- TODO: Fix these hrefs --> <div id="breadcrumbs" jstcache="0"> <a href="index.html" jstcache="0">Google Chrome Extensions</a> > <a href="reference_index.html" jstcache="0">Reference</a> > <a href="api_index.html" jstcache="0">chrome.* APIs</a> > <span jscontent="namespace" jstcache="2">null</span> </div> <div id="searchbox" jstcache="0"> <form action="http://www.google.com/cse" id="cse-search-box" jstcache="0"> <div jstcache="0"> <input type="hidden" name="cx" value="002967670403910741006:61_cvzfqtno" jstcache="0"> <input type="hidden" name="ie" value="UTF-8" jstcache="0"> <input type="text" name="q" size="31" jstcache="0"> <input type="submit" name="sa" value="Search" jstcache="0"> </div> </form> <script type="text/javascript" src="http://www.google.com/jsapi" jstcache="0"></script> <script type="text/javascript" jstcache="0">google.load("elements", "1", {packages: "transliteration"});</script> <script type="text/javascript" src="http://www.google.com/coop/cse/t13n?form=cse-search-box&t13n_langs=en" jstcache="0"></script> <script type="text/javascript" src="http://www.google.com/coop/cse/brand?form=cse-search-box&lang=en" jstcache="0"></script> </div> <div id="pageTitle" jstcache="0"> <h1 jscontent="h1Header" jstcache="3">chrome.tabs</h1> </div> </div> <!-- /pageHeader --> <div id="pageContent" jstcache="0"> <!-- SIDENAV --> <div id="leftNav" jstcache="0"> <ul jstcache="0"> <li jstcache="0"> <a href="overview.html" jstcache="0">Overview</a></li> <li jstcache="0"> <a href="getstarted.html" jstcache="0">Get Started</a></li> <li jstcache="0"> <a href="devguide.html" jstcache="0">Developer's Guide</a></li> <li jstcache="0"> Reference <ul jstcache="0"> <li jstcache="0"> <a href="api_index.html" jstcache="0">Extension APIs</a> <ul jstcache="0"> <li jsselect="apiModules" jstcache="18" jsinstance="0"> <a jscontent="name" jsvalues=".href:module + '.html'" jstcache="25" href="bookmarks.html">Bookmarks</a> </li><li jsselect="apiModules" jstcache="18" jsinstance="1"> <a jscontent="name" jsvalues=".href:module + '.html'" jstcache="25" href="toolstrip.html">Toolstrip</a> </li><li jsselect="apiModules" jstcache="18" jsinstance="2"> <a jscontent="name" jsvalues=".href:module + '.html'" jstcache="25" href="pageActions.html">PageActions</a> </li><li jsselect="apiModules" jstcache="18" jsinstance="3"> <a jscontent="name" jsvalues=".href:module + '.html'" jstcache="25" href="windows.html">Windows</a> </li><li jsselect="apiModules" jstcache="18" jsinstance="4"> <a jscontent="name" jsvalues=".href:module + '.html'" jstcache="25" href="tabs.html">Tabs</a> </li><li jsselect="apiModules" jstcache="18" jsinstance="*5"> <a jscontent="name" jsvalues=".href:module + '.html'" jstcache="25" href="self.html">Self</a> </li> </ul> </li> </ul> </li> </ul> </div> <div id="mainColumn" jstcache="0"> <!-- TABLE OF CONTENTS --> <div id="toc" jsselect="apiDefinition" jstcache="4"> <p jstcache="0">Contents</p> <ol jstcache="0"> <li jstcache="0"> <a href="#overview" jstcache="0">Description</a> <ol jstcache="0"> <li jstcache="0"><a href="#overview-properties" jstcache="0">Properties</a></li> <li jstcache="0"><a href="#overview-examples" jstcache="0">Examples</a></li> </ol> </li> <li jstcache="0"> <a href="#methods" jstcache="0">Methods</a> <ol jstcache="0"> <li jsselect="functions" jstcache="5" jsinstance="0"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-get" jstcache="19">get</a> </li><li jsselect="functions" jstcache="5" jsinstance="1"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-connect" jstcache="19">connect</a> </li><li jsselect="functions" jstcache="5" jsinstance="2"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-getSelected" jstcache="19">getSelected</a> </li><li jsselect="functions" jstcache="5" jsinstance="3"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-getAllInWindow" jstcache="19">getAllInWindow</a> </li><li jsselect="functions" jstcache="5" jsinstance="4"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-create" jstcache="19">create</a> </li><li jsselect="functions" jstcache="5" jsinstance="5"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-update" jstcache="19">update</a> </li><li jsselect="functions" jstcache="5" jsinstance="6"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-move" jstcache="19">move</a> </li><li jsselect="functions" jstcache="5" jsinstance="7"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-remove" jstcache="19">remove</a> </li><li jsselect="functions" jstcache="5" jsinstance="*8"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-detectLanguage" jstcache="19">detectLanguage</a> </li> </ol> </li> <li jstcache="0"> <a href="#events" jstcache="0">Events</a> <ol jstcache="0"> <li jsselect="events" jstcache="6" jsinstance="0"> <a jscontent="name" jsvalues=".href:'#event-' + name" href="#event-onCreated" jstcache="20">onCreated</a> </li><li jsselect="events" jstcache="6" jsinstance="1"> <a jscontent="name" jsvalues=".href:'#event-' + name" href="#event-onUpdated" jstcache="20">onUpdated</a> </li><li jsselect="events" jstcache="6" jsinstance="2"> <a jscontent="name" jsvalues=".href:'#event-' + name" href="#event-onMoved" jstcache="20">onMoved</a> </li><li jsselect="events" jstcache="6" jsinstance="3"> <a jscontent="name" jsvalues=".href:'#event-' + name" href="#event-onSelectionChanged" jstcache="20">onSelectionChanged</a> </li><li jsselect="events" jstcache="6" jsinstance="4"> <a jscontent="name" jsvalues=".href:'#event-' + name" href="#event-onAttached" jstcache="20">onAttached</a> </li><li jsselect="events" jstcache="6" jsinstance="5"> <a jscontent="name" jsvalues=".href:'#event-' + name" href="#event-onDetached" jstcache="20">onDetached</a> </li><li jsselect="events" jstcache="6" jsinstance="*6"> <a jscontent="name" jsvalues=".href:'#event-' + name" href="#event-onRemoved" jstcache="20">onRemoved</a> </li> </ol> </li> <!-- TODO: What do we do about structs/types? --> <li jstcache="0"> <a href="#structs" jstcache="0">TODO: Structs</a> <ol jstcache="0"> <li jstcache="0"><a href="#struct-BookmarkTreeNode" jstcache="0"></a></li> </ol> </li> </ol> [PENDING: links to all h2s and h3s should go here -- would it be possible to link to overview h3s, as well? if so, how should we create their anchor/id values?] </div> <!-- /TABLE OF CONTENTS --> <!-- STATIC CONTENT PLACEHOLDER --> <div id="static" jstcache="0"><!-- BEGIN AUTHORED CONTENT --> <p class="todo" jstcache="0"> [PENDING: API Module Overview Goes Here] </p> <!-- END AUTHORED CONTENT --> </div> <!-- API PAGE --> <div class="apiPage" jsselect="apiDefinition" jstcache="4"> <!-- METHODS --> <div class="apiGroup" id="methods" jstcache="0"> <a name="#methods" jstcache="0"></a> <h2 jstcache="0">Methods</h2> <!-- iterates over all functions --> <div class="apiItem" jsselect="functions" jstcache="5" jsinstance="0"> <a jsvalues=".name:'method-' + name" jstcache="7" name="method-get"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="8">get</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="returns.typeName" jstcache="10" style="display: none; ">void</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="fullName" jstcache="11">chrome.tabs.get</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="12" jsinstance="0" class="null"><span jsdisplay="$index" jstcache="21" style="display: none; ">, </span><span jscontent="typeName" jstcache="22">integer</span> <var jstcache="0"><span jscontent="name" jstcache="8">tabId</span></var></span><span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="12" jsinstance="*1" class="null"><span jsdisplay="$index" jstcache="21">, </span><span jscontent="typeName" jstcache="22">function</span> <var jstcache="0"><span jscontent="name" jstcache="8">callback</span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="13">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="14" style="display: none; "> A description from the json schema def of the function goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="23" jsinstance="0"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">tabId</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31" style="display: none; ">optional </span><span jscontent="typeName" jstcache="22">integer</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28" style="display: none; "> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div><div jsselect="parameters" jstcache="23" jsinstance="*1"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">callback</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31" style="display: none; ">optional </span><span jscontent="typeName" jstcache="22">function</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28" style="display: none; "> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="15" style="display: none; ">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="24" style="display: none; "> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var> <em jstcache="0">(<span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> <!-- CALLBACK --> <div jsdisplay="callbackParameters" jstcache="16"> <h4 jstcache="0">Callback function</h4> <p jstcache="0"> If you specify the <em jstcache="0">callback</em> parameter, it should specify a function that looks like this: </p> <!-- Note: intentionally longer 80 columns --> <pre jstcache="0">function(<span jscontent="callbackSignature" jstcache="29">object tab</span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="callbackParameters" jstcache="30" jsinstance="*0"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">tab</var><em jstcache="0"> (<span jscontent="typeName" jstcache="22">object</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32" jsinstance="0"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">id</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31" style="display: none; ">optional </span><span jscontent="typeName" jstcache="22">integer</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> </div><div jsselect="_propertyList" jstcache="32" jsinstance="1"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">index</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31" style="display: none; ">optional </span><span jscontent="typeName" jstcache="22">integer</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> </div><div jsselect="_propertyList" jstcache="32" jsinstance="2"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">windowId</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31" style="display: none; ">optional </span><span jscontent="typeName" jstcache="22">integer</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> </div><div jsselect="_propertyList" jstcache="32" jsinstance="3"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">selected</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31" style="display: none; ">optional </span><span jscontent="typeName" jstcache="22">boolean</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> </div><div jsselect="_propertyList" jstcache="32" jsinstance="4"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">url</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31" style="display: none; ">optional </span><span jscontent="typeName" jstcache="22">string</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> </div><div jsselect="_propertyList" jstcache="32" jsinstance="5"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">title</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">string</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> </div><div jsselect="_propertyList" jstcache="32" jsinstance="*6"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">favIconUrl</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">string</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> </div> </div> <!-- /description --> </div><div class="apiItem" jsselect="functions" jstcache="5" jsinstance="1"> <a jsvalues=".name:'method-' + name" jstcache="7" name="method-connect"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="8">connect</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="returns.typeName" jstcache="10">object</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="fullName" jstcache="11">chrome.tabs.connect</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="12" jsinstance="0" class="optional"><span jsdisplay="$index" jstcache="21" style="display: none; ">, </span><span jscontent="typeName" jstcache="22">integer</span> <var jstcache="0"><span jscontent="name" jstcache="8">tabId</span></var></span><span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="12" jsinstance="*1" class="optional"><span jsdisplay="$index" jstcache="21">, </span><span jscontent="typeName" jstcache="22">string</span> <var jstcache="0"><span jscontent="name" jstcache="8">name</span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="13">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="14" style="display: none; "> A description from the json schema def of the function goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="23" jsinstance="0"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">tabId</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">integer</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28" style="display: none; "> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div><div jsselect="parameters" jstcache="23" jsinstance="*1"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">name</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">string</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28" style="display: none; "> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="15">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="24"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">Port</var> <em jstcache="0">(<span jscontent="typeName" jstcache="22">object</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32" jsinstance="0"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">name</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31" style="display: none; ">optional </span><span jscontent="typeName" jstcache="22">string</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> </div><div jsselect="_propertyList" jstcache="32" jsinstance="1"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">onDisconnect</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31" style="display: none; ">optional </span><span jscontent="typeName" jstcache="22">object</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> </div><div jsselect="_propertyList" jstcache="32" jsinstance="*2"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">onMessage</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31" style="display: none; ">optional </span><span jscontent="typeName" jstcache="22">object</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> <!-- CALLBACK --> <div jsdisplay="callbackParameters" jstcache="16" style="display: none; "> <h4 jstcache="0">Callback function</h4> <p jstcache="0"> If you specify the <em jstcache="0">callback</em> parameter, it should specify a function that looks like this: </p> <!-- Note: intentionally longer 80 columns --> <pre jstcache="0">function(<span jscontent="callbackSignature" jstcache="29">Type param1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="callbackParameters" jstcache="30"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> </div> </div> <!-- /description --> </div><div class="apiItem" jsselect="functions" jstcache="5" jsinstance="2"> <a jsvalues=".name:'method-' + name" jstcache="7" name="method-getSelected"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="8">getSelected</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="returns.typeName" jstcache="10" style="display: none; ">void</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="fullName" jstcache="11">chrome.tabs.getSelected</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="12" jsinstance="0" class="optional"><span jsdisplay="$index" jstcache="21" style="display: none; ">, </span><span jscontent="typeName" jstcache="22">integer</span> <var jstcache="0"><span jscontent="name" jstcache="8">windowId</span></var></span><span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="12" jsinstance="*1" class="null"><span jsdisplay="$index" jstcache="21">, </span><span jscontent="typeName" jstcache="22">function</span> <var jstcache="0"><span jscontent="name" jstcache="8">callback</span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="13">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="14" style="display: none; "> A description from the json schema def of the function goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="23" jsinstance="0"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">windowId</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">integer</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28" style="display: none; "> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div><div jsselect="parameters" jstcache="23" jsinstance="*1"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">callback</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31" style="display: none; ">optional </span><span jscontent="typeName" jstcache="22">function</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28" style="display: none; "> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="15" style="display: none; ">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="24" style="display: none; "> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var> <em jstcache="0">(<span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> <!-- CALLBACK --> <div jsdisplay="callbackParameters" jstcache="16"> <h4 jstcache="0">Callback function</h4> <p jstcache="0"> If you specify the <em jstcache="0">callback</em> parameter, it should specify a function that looks like this: </p> <!-- Note: intentionally longer 80 columns --> <pre jstcache="0">function(<span jscontent="callbackSignature" jstcache="29">object tab</span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="callbackParameters" jstcache="30" jsinstance="*0"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">tab</var><em jstcache="0"> (<span jscontent="typeName" jstcache="22">object</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32" jsinstance="0"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">id</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31" style="display: none; ">optional </span><span jscontent="typeName" jstcache="22">integer</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> </div><div jsselect="_propertyList" jstcache="32" jsinstance="1"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">index</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31" style="display: none; ">optional </span><span jscontent="typeName" jstcache="22">integer</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> </div><div jsselect="_propertyList" jstcache="32" jsinstance="2"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">windowId</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31" style="display: none; ">optional </span><span jscontent="typeName" jstcache="22">integer</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> </div><div jsselect="_propertyList" jstcache="32" jsinstance="3"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">selected</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31" style="display: none; ">optional </span><span jscontent="typeName" jstcache="22">boolean</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> </div><div jsselect="_propertyList" jstcache="32" jsinstance="4"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">url</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31" style="display: none; ">optional </span><span jscontent="typeName" jstcache="22">string</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> </div><div jsselect="_propertyList" jstcache="32" jsinstance="5"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">title</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">string</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> </div><div jsselect="_propertyList" jstcache="32" jsinstance="*6"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">favIconUrl</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">string</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> </div> </div> <!-- /description --> </div><div class="apiItem" jsselect="functions" jstcache="5" jsinstance="3"> <a jsvalues=".name:'method-' + name" jstcache="7" name="method-getAllInWindow"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="8">getAllInWindow</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="returns.typeName" jstcache="10" style="display: none; ">void</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="fullName" jstcache="11">chrome.tabs.getAllInWindow</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="12" jsinstance="0" class="optional"><span jsdisplay="$index" jstcache="21" style="display: none; ">, </span><span jscontent="typeName" jstcache="22">integer</span> <var jstcache="0"><span jscontent="name" jstcache="8">windowId</span></var></span><span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="12" jsinstance="*1" class="null"><span jsdisplay="$index" jstcache="21">, </span><span jscontent="typeName" jstcache="22">function</span> <var jstcache="0"><span jscontent="name" jstcache="8">callback</span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="13">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="14" style="display: none; "> A description from the json schema def of the function goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="23" jsinstance="0"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">windowId</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">integer</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28" style="display: none; "> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div><div jsselect="parameters" jstcache="23" jsinstance="*1"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">callback</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31" style="display: none; ">optional </span><span jscontent="typeName" jstcache="22">function</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28" style="display: none; "> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="15" style="display: none; ">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="24" style="display: none; "> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var> <em jstcache="0">(<span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> <!-- CALLBACK --> <div jsdisplay="callbackParameters" jstcache="16" style="display: none; "> <h4 jstcache="0">Callback function</h4> <p jstcache="0"> If you specify the <em jstcache="0">callback</em> parameter, it should specify a function that looks like this: </p> <!-- Note: intentionally longer 80 columns --> <pre jstcache="0">function(<span jscontent="callbackSignature" jstcache="29">Type param1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="callbackParameters" jstcache="30"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> </div> </div> <!-- /description --> </div><div class="apiItem" jsselect="functions" jstcache="5" jsinstance="4"> <a jsvalues=".name:'method-' + name" jstcache="7" name="method-create"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="8">create</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="returns.typeName" jstcache="10" style="display: none; ">void</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="fullName" jstcache="11">chrome.tabs.create</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="12" jsinstance="0" class="null"><span jsdisplay="$index" jstcache="21" style="display: none; ">, </span><span jscontent="typeName" jstcache="22">object</span> <var jstcache="0"><span jscontent="name" jstcache="8">CreateProperties</span></var></span><span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="12" jsinstance="*1" class="optional"><span jsdisplay="$index" jstcache="21">, </span><span jscontent="typeName" jstcache="22">function</span> <var jstcache="0"><span jscontent="name" jstcache="8">callback</span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="13">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="14" style="display: none; "> A description from the json schema def of the function goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="23" jsinstance="0"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">CreateProperties</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31" style="display: none; ">optional </span><span jscontent="typeName" jstcache="22">object</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32" jsinstance="0"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">windowId</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">integer</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> </div><div jsselect="_propertyList" jstcache="32" jsinstance="1"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">index</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">integer</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> </div><div jsselect="_propertyList" jstcache="32" jsinstance="2"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">url</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">string</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> </div><div jsselect="_propertyList" jstcache="32" jsinstance="*3"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">selected</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">boolean</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div><div jsselect="parameters" jstcache="23" jsinstance="*1"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">callback</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">function</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28" style="display: none; "> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="15" style="display: none; ">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="24" style="display: none; "> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var> <em jstcache="0">(<span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> <!-- CALLBACK --> <div jsdisplay="callbackParameters" jstcache="16"> <h4 jstcache="0">Callback function</h4> <p jstcache="0"> If you specify the <em jstcache="0">callback</em> parameter, it should specify a function that looks like this: </p> <!-- Note: intentionally longer 80 columns --> <pre jstcache="0">function(<span jscontent="callbackSignature" jstcache="29">object tab</span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="callbackParameters" jstcache="30" jsinstance="*0"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">tab</var><em jstcache="0"> (<span jscontent="typeName" jstcache="22">object</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32" jsinstance="0"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">id</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31" style="display: none; ">optional </span><span jscontent="typeName" jstcache="22">integer</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> </div><div jsselect="_propertyList" jstcache="32" jsinstance="1"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">index</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31" style="display: none; ">optional </span><span jscontent="typeName" jstcache="22">integer</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> </div><div jsselect="_propertyList" jstcache="32" jsinstance="2"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">windowId</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31" style="display: none; ">optional </span><span jscontent="typeName" jstcache="22">integer</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> </div><div jsselect="_propertyList" jstcache="32" jsinstance="3"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">selected</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31" style="display: none; ">optional </span><span jscontent="typeName" jstcache="22">boolean</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> </div><div jsselect="_propertyList" jstcache="32" jsinstance="4"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">url</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31" style="display: none; ">optional </span><span jscontent="typeName" jstcache="22">string</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> </div><div jsselect="_propertyList" jstcache="32" jsinstance="5"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">title</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">string</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> </div><div jsselect="_propertyList" jstcache="32" jsinstance="*6"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">favIconUrl</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">string</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> </div> </div> <!-- /description --> </div><div class="apiItem" jsselect="functions" jstcache="5" jsinstance="5"> <a jsvalues=".name:'method-' + name" jstcache="7" name="method-update"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="8">update</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="returns.typeName" jstcache="10" style="display: none; ">void</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="fullName" jstcache="11">chrome.tabs.update</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="12" jsinstance="0" class="null"><span jsdisplay="$index" jstcache="21" style="display: none; ">, </span><span jscontent="typeName" jstcache="22">integer</span> <var jstcache="0"><span jscontent="name" jstcache="8">tabId</span></var></span><span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="12" jsinstance="1" class="null"><span jsdisplay="$index" jstcache="21">, </span><span jscontent="typeName" jstcache="22">object</span> <var jstcache="0"><span jscontent="name" jstcache="8">UpdateProperties</span></var></span><span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="12" jsinstance="*2" class="optional"><span jsdisplay="$index" jstcache="21">, </span><span jscontent="typeName" jstcache="22">function</span> <var jstcache="0"><span jscontent="name" jstcache="8">callback</span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="13">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="14" style="display: none; "> A description from the json schema def of the function goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="23" jsinstance="0"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">tabId</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31" style="display: none; ">optional </span><span jscontent="typeName" jstcache="22">integer</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28" style="display: none; "> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div><div jsselect="parameters" jstcache="23" jsinstance="1"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">UpdateProperties</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31" style="display: none; ">optional </span><span jscontent="typeName" jstcache="22">object</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32" jsinstance="0"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">url</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">string</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> </div><div jsselect="_propertyList" jstcache="32" jsinstance="*1"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">selected</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">boolean</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div><div jsselect="parameters" jstcache="23" jsinstance="*2"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">callback</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">function</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28" style="display: none; "> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="15" style="display: none; ">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="24" style="display: none; "> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var> <em jstcache="0">(<span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> <!-- CALLBACK --> <div jsdisplay="callbackParameters" jstcache="16"> <h4 jstcache="0">Callback function</h4> <p jstcache="0"> If you specify the <em jstcache="0">callback</em> parameter, it should specify a function that looks like this: </p> <!-- Note: intentionally longer 80 columns --> <pre jstcache="0">function(<span jscontent="callbackSignature" jstcache="29"></span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="callbackParameters" jstcache="30" jsinstance="*0" style="display: none; "> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> </div> </div> <!-- /description --> </div><div class="apiItem" jsselect="functions" jstcache="5" jsinstance="6"> <a jsvalues=".name:'method-' + name" jstcache="7" name="method-move"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="8">move</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="returns.typeName" jstcache="10" style="display: none; ">void</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="fullName" jstcache="11">chrome.tabs.move</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="12" jsinstance="0" class="null"><span jsdisplay="$index" jstcache="21" style="display: none; ">, </span><span jscontent="typeName" jstcache="22">integer</span> <var jstcache="0"><span jscontent="name" jstcache="8">tabId</span></var></span><span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="12" jsinstance="1" class="null"><span jsdisplay="$index" jstcache="21">, </span><span jscontent="typeName" jstcache="22">object</span> <var jstcache="0"><span jscontent="name" jstcache="8">MoveProperties</span></var></span><span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="12" jsinstance="*2" class="optional"><span jsdisplay="$index" jstcache="21">, </span><span jscontent="typeName" jstcache="22">function</span> <var jstcache="0"><span jscontent="name" jstcache="8">callback</span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="13">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="14" style="display: none; "> A description from the json schema def of the function goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="23" jsinstance="0"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">tabId</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31" style="display: none; ">optional </span><span jscontent="typeName" jstcache="22">integer</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28" style="display: none; "> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div><div jsselect="parameters" jstcache="23" jsinstance="1"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">MoveProperties</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31" style="display: none; ">optional </span><span jscontent="typeName" jstcache="22">object</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32" jsinstance="0"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">windowId</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">integer</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> </div><div jsselect="_propertyList" jstcache="32" jsinstance="*1"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">index</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31" style="display: none; ">optional </span><span jscontent="typeName" jstcache="22">integer</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div><div jsselect="parameters" jstcache="23" jsinstance="*2"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">callback</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">function</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28" style="display: none; "> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="15" style="display: none; ">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="24" style="display: none; "> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var> <em jstcache="0">(<span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> <!-- CALLBACK --> <div jsdisplay="callbackParameters" jstcache="16"> <h4 jstcache="0">Callback function</h4> <p jstcache="0"> If you specify the <em jstcache="0">callback</em> parameter, it should specify a function that looks like this: </p> <!-- Note: intentionally longer 80 columns --> <pre jstcache="0">function(<span jscontent="callbackSignature" jstcache="29"></span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="callbackParameters" jstcache="30" jsinstance="*0" style="display: none; "> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> </div> </div> <!-- /description --> </div><div class="apiItem" jsselect="functions" jstcache="5" jsinstance="7"> <a jsvalues=".name:'method-' + name" jstcache="7" name="method-remove"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="8">remove</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="returns.typeName" jstcache="10" style="display: none; ">void</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="fullName" jstcache="11">chrome.tabs.remove</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="12" jsinstance="0" class="optional"><span jsdisplay="$index" jstcache="21" style="display: none; ">, </span><span jscontent="typeName" jstcache="22">integer</span> <var jstcache="0"><span jscontent="name" jstcache="8">tabId</span></var></span><span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="12" jsinstance="*1" class="optional"><span jsdisplay="$index" jstcache="21">, </span><span jscontent="typeName" jstcache="22">function</span> <var jstcache="0"><span jscontent="name" jstcache="8">callback</span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="13">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="14" style="display: none; "> A description from the json schema def of the function goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="23" jsinstance="0"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">tabId</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">integer</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28" style="display: none; "> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div><div jsselect="parameters" jstcache="23" jsinstance="*1"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">callback</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">function</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28" style="display: none; "> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="15" style="display: none; ">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="24" style="display: none; "> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var> <em jstcache="0">(<span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> <!-- CALLBACK --> <div jsdisplay="callbackParameters" jstcache="16"> <h4 jstcache="0">Callback function</h4> <p jstcache="0"> If you specify the <em jstcache="0">callback</em> parameter, it should specify a function that looks like this: </p> <!-- Note: intentionally longer 80 columns --> <pre jstcache="0">function(<span jscontent="callbackSignature" jstcache="29"></span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="callbackParameters" jstcache="30" jsinstance="*0" style="display: none; "> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> </div> </div> <!-- /description --> </div><div class="apiItem" jsselect="functions" jstcache="5" jsinstance="*8"> <a jsvalues=".name:'method-' + name" jstcache="7" name="method-detectLanguage"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="8">detectLanguage</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="returns.typeName" jstcache="10" style="display: none; ">void</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="fullName" jstcache="11">chrome.tabs.detectLanguage</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="12" jsinstance="0" class="optional"><span jsdisplay="$index" jstcache="21" style="display: none; ">, </span><span jscontent="typeName" jstcache="22">integer</span> <var jstcache="0"><span jscontent="name" jstcache="8">tabId</span></var></span><span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="12" jsinstance="*1" class="null"><span jsdisplay="$index" jstcache="21">, </span><span jscontent="typeName" jstcache="22">function</span> <var jstcache="0"><span jscontent="name" jstcache="8">callback</span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="13" style="display: none; ">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="14">detect language of tab.</p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="23" jsinstance="0"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">tabId</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">integer</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28" style="display: none; "> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div><div jsselect="parameters" jstcache="23" jsinstance="*1"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">callback</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31" style="display: none; ">optional </span><span jscontent="typeName" jstcache="22">function</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28" style="display: none; "> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="15" style="display: none; ">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="24" style="display: none; "> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var> <em jstcache="0">(<span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> <!-- CALLBACK --> <div jsdisplay="callbackParameters" jstcache="16"> <h4 jstcache="0">Callback function</h4> <p jstcache="0"> If you specify the <em jstcache="0">callback</em> parameter, it should specify a function that looks like this: </p> <!-- Note: intentionally longer 80 columns --> <pre jstcache="0">function(<span jscontent="callbackSignature" jstcache="29">string language</span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="callbackParameters" jstcache="30" jsinstance="*0"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">language</var><em jstcache="0"> (<span jscontent="typeName" jstcache="22">string</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28" style="display: none; "> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> </div> </div> <!-- /description --> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> <!-- EVENTS --> <div class="apiGroup" id="events" jstcache="0"> <a name="#events" jstcache="0"></a> <h2 id="events" jstcache="0">Events</h2> <!-- iterates over all events --> <div jsselect="events" class="apiItem" jstcache="6" jsinstance="0"> <a jsvalues=".name:'event-' + name" jstcache="9" name="event-onCreated"></a> <h3 jscontent="name" jstcache="8">onCreated</h3> <div class="summary" jstcache="0"> <!-- Note: intentionally longer 80 columns --> <span class="subdued" jstcache="0">chrome.bookmarks.</span><span jscontent="name" jstcache="8">onCreated</span><span class="subdued" jstcache="0">.addListener</span>(function(<span jscontent="callSignature" jstcache="17">object tab</span>) <span class="subdued" jstcache="0">{...}</span>); </div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="13">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="14" style="display: none; "> A description from the json schema def of the event goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="23" jsinstance="*0"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">tab</var><em jstcache="0"> (<span jscontent="typeName" jstcache="22">object</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26">Undocumented.</dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32" jsinstance="0"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">id</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31" style="display: none; ">optional </span><span jscontent="typeName" jstcache="22">integer</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> </div><div jsselect="_propertyList" jstcache="32" jsinstance="1"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">index</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31" style="display: none; ">optional </span><span jscontent="typeName" jstcache="22">integer</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> </div><div jsselect="_propertyList" jstcache="32" jsinstance="2"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">windowId</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31" style="display: none; ">optional </span><span jscontent="typeName" jstcache="22">integer</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> </div><div jsselect="_propertyList" jstcache="32" jsinstance="3"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">selected</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31" style="display: none; ">optional </span><span jscontent="typeName" jstcache="22">boolean</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> </div><div jsselect="_propertyList" jstcache="32" jsinstance="4"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">url</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31" style="display: none; ">optional </span><span jscontent="typeName" jstcache="22">string</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> </div><div jsselect="_propertyList" jstcache="32" jsinstance="5"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">title</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">string</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> </div><div jsselect="_propertyList" jstcache="32" jsinstance="*6"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">favIconUrl</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">string</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> </div> <!-- /decription --> </div><div jsselect="events" class="apiItem" jstcache="6" jsinstance="1"> <a jsvalues=".name:'event-' + name" jstcache="9" name="event-onUpdated"></a> <h3 jscontent="name" jstcache="8">onUpdated</h3> <div class="summary" jstcache="0"> <!-- Note: intentionally longer 80 columns --> <span class="subdued" jstcache="0">chrome.bookmarks.</span><span jscontent="name" jstcache="8">onUpdated</span><span class="subdued" jstcache="0">.addListener</span>(function(<span jscontent="callSignature" jstcache="17">integer tabId, object ChangedProps</span>) <span class="subdued" jstcache="0">{...}</span>); </div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="13">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="14" style="display: none; "> A description from the json schema def of the event goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="23" jsinstance="0"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">tabId</var><em jstcache="0"> (<span jscontent="typeName" jstcache="22">integer</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26">Undocumented.</dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28" style="display: none; "> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div><div jsselect="parameters" jstcache="23" jsinstance="*1"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">ChangedProps</var><em jstcache="0"> (<span jscontent="typeName" jstcache="22">object</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26">Undocumented.</dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32" jsinstance="0"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">tabId</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31" style="display: none; ">optional </span><span jscontent="typeName" jstcache="22">integer</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> </div><div jsselect="_propertyList" jstcache="32" jsinstance="1"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">status</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31" style="display: none; ">optional </span><span jscontent="typeName" jstcache="22">string</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> </div><div jsselect="_propertyList" jstcache="32" jsinstance="*2"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">url</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">string</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> </div> <!-- /decription --> </div><div jsselect="events" class="apiItem" jstcache="6" jsinstance="2"> <a jsvalues=".name:'event-' + name" jstcache="9" name="event-onMoved"></a> <h3 jscontent="name" jstcache="8">onMoved</h3> <div class="summary" jstcache="0"> <!-- Note: intentionally longer 80 columns --> <span class="subdued" jstcache="0">chrome.bookmarks.</span><span jscontent="name" jstcache="8">onMoved</span><span class="subdued" jstcache="0">.addListener</span>(function(<span jscontent="callSignature" jstcache="17">integer tabId, object MoveInfo</span>) <span class="subdued" jstcache="0">{...}</span>); </div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="13">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="14" style="display: none; "> A description from the json schema def of the event goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="23" jsinstance="0"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">tabId</var><em jstcache="0"> (<span jscontent="typeName" jstcache="22">integer</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26">Undocumented.</dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28" style="display: none; "> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div><div jsselect="parameters" jstcache="23" jsinstance="*1"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">MoveInfo</var><em jstcache="0"> (<span jscontent="typeName" jstcache="22">object</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26">Undocumented.</dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32" jsinstance="0"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">windowId</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31" style="display: none; ">optional </span><span jscontent="typeName" jstcache="22">integer</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> </div><div jsselect="_propertyList" jstcache="32" jsinstance="1"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">fromIndex</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31" style="display: none; ">optional </span><span jscontent="typeName" jstcache="22">integer</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> </div><div jsselect="_propertyList" jstcache="32" jsinstance="*2"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">toIndex</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31" style="display: none; ">optional </span><span jscontent="typeName" jstcache="22">integer</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> </div> <!-- /decription --> </div><div jsselect="events" class="apiItem" jstcache="6" jsinstance="3"> <a jsvalues=".name:'event-' + name" jstcache="9" name="event-onSelectionChanged"></a> <h3 jscontent="name" jstcache="8">onSelectionChanged</h3> <div class="summary" jstcache="0"> <!-- Note: intentionally longer 80 columns --> <span class="subdued" jstcache="0">chrome.bookmarks.</span><span jscontent="name" jstcache="8">onSelectionChanged</span><span class="subdued" jstcache="0">.addListener</span>(function(<span jscontent="callSignature" jstcache="17">integer tabId, object SelectInfo</span>) <span class="subdued" jstcache="0">{...}</span>); </div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="13">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="14" style="display: none; "> A description from the json schema def of the event goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="23" jsinstance="0"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">tabId</var><em jstcache="0"> (<span jscontent="typeName" jstcache="22">integer</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26">Undocumented.</dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28" style="display: none; "> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div><div jsselect="parameters" jstcache="23" jsinstance="*1"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">SelectInfo</var><em jstcache="0"> (<span jscontent="typeName" jstcache="22">object</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26">Undocumented.</dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32" jsinstance="*0"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">windowId</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31" style="display: none; ">optional </span><span jscontent="typeName" jstcache="22">integer</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> </div> <!-- /decription --> </div><div jsselect="events" class="apiItem" jstcache="6" jsinstance="4"> <a jsvalues=".name:'event-' + name" jstcache="9" name="event-onAttached"></a> <h3 jscontent="name" jstcache="8">onAttached</h3> <div class="summary" jstcache="0"> <!-- Note: intentionally longer 80 columns --> <span class="subdued" jstcache="0">chrome.bookmarks.</span><span jscontent="name" jstcache="8">onAttached</span><span class="subdued" jstcache="0">.addListener</span>(function(<span jscontent="callSignature" jstcache="17">integer tabId, object AttachInfo</span>) <span class="subdued" jstcache="0">{...}</span>); </div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="13">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="14" style="display: none; "> A description from the json schema def of the event goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="23" jsinstance="0"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">tabId</var><em jstcache="0"> (<span jscontent="typeName" jstcache="22">integer</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26">Undocumented.</dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28" style="display: none; "> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div><div jsselect="parameters" jstcache="23" jsinstance="*1"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">AttachInfo</var><em jstcache="0"> (<span jscontent="typeName" jstcache="22">object</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26">Undocumented.</dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32" jsinstance="0"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">newWindowId</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31" style="display: none; ">optional </span><span jscontent="typeName" jstcache="22">integer</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> </div><div jsselect="_propertyList" jstcache="32" jsinstance="*1"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">newPosition</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31" style="display: none; ">optional </span><span jscontent="typeName" jstcache="22">integer</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> </div> <!-- /decription --> </div><div jsselect="events" class="apiItem" jstcache="6" jsinstance="5"> <a jsvalues=".name:'event-' + name" jstcache="9" name="event-onDetached"></a> <h3 jscontent="name" jstcache="8">onDetached</h3> <div class="summary" jstcache="0"> <!-- Note: intentionally longer 80 columns --> <span class="subdued" jstcache="0">chrome.bookmarks.</span><span jscontent="name" jstcache="8">onDetached</span><span class="subdued" jstcache="0">.addListener</span>(function(<span jscontent="callSignature" jstcache="17">integer tabId, object DetachInfo</span>) <span class="subdued" jstcache="0">{...}</span>); </div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="13">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="14" style="display: none; "> A description from the json schema def of the event goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="23" jsinstance="0"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">tabId</var><em jstcache="0"> (<span jscontent="typeName" jstcache="22">integer</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26">Undocumented.</dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28" style="display: none; "> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div><div jsselect="parameters" jstcache="23" jsinstance="*1"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">DetachInfo</var><em jstcache="0"> (<span jscontent="typeName" jstcache="22">object</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26">Undocumented.</dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32" jsinstance="0"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">oldWindowId</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31" style="display: none; ">optional </span><span jscontent="typeName" jstcache="22">integer</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> </div><div jsselect="_propertyList" jstcache="32" jsinstance="*1"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">oldPosition</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31" style="display: none; ">optional </span><span jscontent="typeName" jstcache="22">integer</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> </div> <!-- /decription --> </div><div jsselect="events" class="apiItem" jstcache="6" jsinstance="*6"> <a jsvalues=".name:'event-' + name" jstcache="9" name="event-onRemoved"></a> <h3 jscontent="name" jstcache="8">onRemoved</h3> <div class="summary" jstcache="0"> <!-- Note: intentionally longer 80 columns --> <span class="subdued" jstcache="0">chrome.bookmarks.</span><span jscontent="name" jstcache="8">onRemoved</span><span class="subdued" jstcache="0">.addListener</span>(function(<span jscontent="callSignature" jstcache="17">integer tabId</span>) <span class="subdued" jstcache="0">{...}</span>); </div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="13">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="14" style="display: none; "> A description from the json schema def of the event goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="23" jsinstance="*0"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">tabId</var><em jstcache="0"> (<span jscontent="typeName" jstcache="22">integer</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26">Undocumented.</dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28" style="display: none; "> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> </div> <!-- /decription --> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> </div> <!-- /apiPage --> </div> <!-- /mainColumn --> </div> <!-- /pageContent --> <div id="pageFooter" --="" jstcache="0"> Copyright 2009 <br jstcache="0"> TBD: copyright/license should be automatically included here </div> <!-- /pageFooter --> </div> <!-- /container --> </body></html>
diff --git a/chrome/common/extensions/docs/template/page_shell.html b/chrome/common/extensions/docs/template/page_shell.html index faf8a37..792a9ac 100755 --- a/chrome/common/extensions/docs/template/page_shell.html +++ b/chrome/common/extensions/docs/template/page_shell.html @@ -25,19 +25,7 @@ src="../../../third_party/jstemplate/jstemplate_compiled.js"> </script> <script type="text/javascript" src="js/api_page_generator.js"></script> - <script> -// Re-render the page if the user-agent is chrome and it is being served as -// a file:/// scheme. This allows both the initial render to static as well -// as dynamic re-rendering for developers/doc-writers working on local changes. -window.onload = function() { - var chrome = navigator.userAgent.indexOf("Chrome") > -1; - var fileScheme = location.protocol == "file:"; - var regenerate = chrome && fileScheme; - //if (regenerate) { - window.renderPage(); - //} -} - </script> + <script type="text/javascript" src="js/bootstrap.js"></script> </head> <!-- <body> content is completely generated. Do not edit, as it will be and rewritten. --> diff --git a/chrome/common/extensions/docs/toolstrip.html b/chrome/common/extensions/docs/toolstrip.html index faf8a37..94472b5 100644..100755 --- a/chrome/common/extensions/docs/toolstrip.html +++ b/chrome/common/extensions/docs/toolstrip.html @@ -1,46 +1 @@ -<!DOCTYPE html> -<!-- This page is a placeholder for generated extensions api doc. Note: - 1) The <head> information in this page is significant, should be uniform - across api docs and should be edited only with knowledge of the - templating mechanism. - 2) The <body> tag *must* retain id="body" - 3) All <body>.innerHTML is genereated as an rendering step. If viewed in a - browser, it will be re-generated from the template, json schema and - authored overview content. - 4) The <body>.innerHTML is also generated by an offline step so that this - page may easily be indexed by search engines. - - TODO(rafaelw): Abstract this into a "pageshell" that becomes the single - version of page template shell and the "instance" pages (bookmarks.html, - etc...) can be generated with a build step. ---> -<!-- <html> must retain id="template --> -<html xmlns="http://www.w3.org/1999/xhtml"> - <!-- <head> data is significant and loads the needed libraries and styles --> - <head> - <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> - <title jscontent="pageTitle">pageTitle</title> - <link href="css/ApiRefStyles.css" rel="stylesheet" type="text/css"> - <script type="text/javascript" - src="../../../third_party/jstemplate/jstemplate_compiled.js"> - </script> - <script type="text/javascript" src="js/api_page_generator.js"></script> - <script> -// Re-render the page if the user-agent is chrome and it is being served as -// a file:/// scheme. This allows both the initial render to static as well -// as dynamic re-rendering for developers/doc-writers working on local changes. -window.onload = function() { - var chrome = navigator.userAgent.indexOf("Chrome") > -1; - var fileScheme = location.protocol == "file:"; - var regenerate = chrome && fileScheme; - //if (regenerate) { - window.renderPage(); - //} -} - </script> - </head> - <!-- <body> content is completely generated. Do not edit, as it will be - and rewritten. --> - <body class="hidden"> - </body> -</html> +<!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc. Note: 1) The <head> information in this page is significant, should be uniform across api docs and should be edited only with knowledge of the templating mechanism. 2) The <body> tag *must* retain id="body" 3) All <body>.innerHTML is genereated as an rendering step. If viewed in a browser, it will be re-generated from the template, json schema and authored overview content. 4) The <body>.innerHTML is also generated by an offline step so that this page may easily be indexed by search engines. TODO(rafaelw): Abstract this into a "pageshell" that becomes the single version of page template shell and the "instance" pages (bookmarks.html, etc...) can be generated with a build step. --><!-- <html> must retain id="template --><html xmlns="http://www.w3.org/1999/xhtml" jstcache="0"><!-- <head> data is significant and loads the needed libraries and styles --><head jstcache="0"> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" jstcache="0"> <title jscontent="pageTitle" jstcache="1">chrome.toolstrip API Reference</title> <link href="css/ApiRefStyles.css" rel="stylesheet" type="text/css" jstcache="0"> <script type="text/javascript" src="../../../third_party/jstemplate/jstemplate_compiled.js" jstcache="0"> </script> <script type="text/javascript" src="js/api_page_generator.js" jstcache="0"></script> <script type="text/javascript" src="js/bootstrap.js" jstcache="0"></script> </head><!-- <body> content is completely generated. Do not edit, as it will be and rewritten. --><body class="" jstcache="0"> <div id="container" jstcache="0"> <a name="top" jstcache="0"> </a> <!-- API HEADER --> <div id="pageHeader" jstcache="0"> <!-- BREADCRUMB --> <!-- TODO: Fix these hrefs --> <div id="breadcrumbs" jstcache="0"> <a href="index.html" jstcache="0">Google Chrome Extensions</a> > <a href="reference_index.html" jstcache="0">Reference</a> > <a href="api_index.html" jstcache="0">chrome.* APIs</a> > <span jscontent="namespace" jstcache="2">null</span> </div> <div id="searchbox" jstcache="0"> <form action="http://www.google.com/cse" id="cse-search-box" jstcache="0"> <div jstcache="0"> <input type="hidden" name="cx" value="002967670403910741006:61_cvzfqtno" jstcache="0"> <input type="hidden" name="ie" value="UTF-8" jstcache="0"> <input type="text" name="q" size="31" jstcache="0"> <input type="submit" name="sa" value="Search" jstcache="0"> </div> </form> <script type="text/javascript" src="http://www.google.com/jsapi" jstcache="0"></script> <script type="text/javascript" jstcache="0">google.load("elements", "1", {packages: "transliteration"});</script> <script type="text/javascript" src="http://www.google.com/coop/cse/t13n?form=cse-search-box&t13n_langs=en" jstcache="0"></script> <script type="text/javascript" src="http://www.google.com/coop/cse/brand?form=cse-search-box&lang=en" jstcache="0"></script> </div> <div id="pageTitle" jstcache="0"> <h1 jscontent="h1Header" jstcache="3">chrome.toolstrip</h1> </div> </div> <!-- /pageHeader --> <div id="pageContent" jstcache="0"> <!-- SIDENAV --> <div id="leftNav" jstcache="0"> <ul jstcache="0"> <li jstcache="0"> <a href="overview.html" jstcache="0">Overview</a></li> <li jstcache="0"> <a href="getstarted.html" jstcache="0">Get Started</a></li> <li jstcache="0"> <a href="devguide.html" jstcache="0">Developer's Guide</a></li> <li jstcache="0"> Reference <ul jstcache="0"> <li jstcache="0"> <a href="api_index.html" jstcache="0">Extension APIs</a> <ul jstcache="0"> <li jsselect="apiModules" jstcache="18" jsinstance="0"> <a jscontent="name" jsvalues=".href:module + '.html'" jstcache="25" href="bookmarks.html">Bookmarks</a> </li><li jsselect="apiModules" jstcache="18" jsinstance="1"> <a jscontent="name" jsvalues=".href:module + '.html'" jstcache="25" href="toolstrip.html">Toolstrip</a> </li><li jsselect="apiModules" jstcache="18" jsinstance="2"> <a jscontent="name" jsvalues=".href:module + '.html'" jstcache="25" href="pageActions.html">PageActions</a> </li><li jsselect="apiModules" jstcache="18" jsinstance="3"> <a jscontent="name" jsvalues=".href:module + '.html'" jstcache="25" href="windows.html">Windows</a> </li><li jsselect="apiModules" jstcache="18" jsinstance="4"> <a jscontent="name" jsvalues=".href:module + '.html'" jstcache="25" href="tabs.html">Tabs</a> </li><li jsselect="apiModules" jstcache="18" jsinstance="*5"> <a jscontent="name" jsvalues=".href:module + '.html'" jstcache="25" href="self.html">Self</a> </li> </ul> </li> </ul> </li> </ul> </div> <div id="mainColumn" jstcache="0"> <!-- TABLE OF CONTENTS --> <div id="toc" jsselect="apiDefinition" jstcache="4"> <p jstcache="0">Contents</p> <ol jstcache="0"> <li jstcache="0"> <a href="#overview" jstcache="0">Description</a> <ol jstcache="0"> <li jstcache="0"><a href="#overview-properties" jstcache="0">Properties</a></li> <li jstcache="0"><a href="#overview-examples" jstcache="0">Examples</a></li> </ol> </li> <li jstcache="0"> <a href="#methods" jstcache="0">Methods</a> <ol jstcache="0"> <li jsselect="functions" jstcache="5" jsinstance="0"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-expand" jstcache="19">expand</a> </li><li jsselect="functions" jstcache="5" jsinstance="*1"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-collapse" jstcache="19">collapse</a> </li> </ol> </li> <li jstcache="0"> <a href="#events" jstcache="0">Events</a> <ol jstcache="0"> <li jsselect="events" jstcache="6" jsinstance="*0" style="display: none; "> <a jscontent="name" jsvalues=".href:'#event-' + name" href="#event-anchor" jstcache="20">eventName</a> </li> </ol> </li> <!-- TODO: What do we do about structs/types? --> <li jstcache="0"> <a href="#structs" jstcache="0">TODO: Structs</a> <ol jstcache="0"> <li jstcache="0"><a href="#struct-BookmarkTreeNode" jstcache="0"></a></li> </ol> </li> </ol> [PENDING: links to all h2s and h3s should go here -- would it be possible to link to overview h3s, as well? if so, how should we create their anchor/id values?] </div> <!-- /TABLE OF CONTENTS --> <!-- STATIC CONTENT PLACEHOLDER --> <div id="static" jstcache="0"></div> <!-- API PAGE --> <div class="apiPage" jsselect="apiDefinition" jstcache="4"> <!-- METHODS --> <div class="apiGroup" id="methods" jstcache="0"> <a name="#methods" jstcache="0"></a> <h2 jstcache="0">Methods</h2> <!-- iterates over all functions --> <div class="apiItem" jsselect="functions" jstcache="5" jsinstance="0"> <a jsvalues=".name:'method-' + name" jstcache="7" name="method-expand"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="8">expand</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="returns.typeName" jstcache="10" style="display: none; ">void</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="fullName" jstcache="11">chrome.toolstrip.expand</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="12" jsinstance="0" class="null"><span jsdisplay="$index" jstcache="21" style="display: none; ">, </span><span jscontent="typeName" jstcache="22">integer</span> <var jstcache="0"><span jscontent="name" jstcache="8">height</span></var></span><span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="12" jsinstance="1" class="optional"><span jsdisplay="$index" jstcache="21">, </span><span jscontent="typeName" jstcache="22">string</span> <var jstcache="0"><span jscontent="name" jstcache="8">url</span></var></span><span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="12" jsinstance="*2" class="optional"><span jsdisplay="$index" jstcache="21">, </span><span jscontent="typeName" jstcache="22">function</span> <var jstcache="0"><span jscontent="name" jstcache="8">callback</span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="13">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="14" style="display: none; "> A description from the json schema def of the function goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="23" jsinstance="0"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">height</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31" style="display: none; ">optional </span><span jscontent="typeName" jstcache="22">integer</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28" style="display: none; "> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div><div jsselect="parameters" jstcache="23" jsinstance="1"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">url</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">string</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28" style="display: none; "> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div><div jsselect="parameters" jstcache="23" jsinstance="*2"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">callback</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">function</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28" style="display: none; "> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="15" style="display: none; ">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="24" style="display: none; "> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var> <em jstcache="0">(<span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> <!-- CALLBACK --> <div jsdisplay="callbackParameters" jstcache="16" style="display: none; "> <h4 jstcache="0">Callback function</h4> <p jstcache="0"> If you specify the <em jstcache="0">callback</em> parameter, it should specify a function that looks like this: </p> <!-- Note: intentionally longer 80 columns --> <pre jstcache="0">function(<span jscontent="callbackSignature" jstcache="29">Type param1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="callbackParameters" jstcache="30"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> </div> </div> <!-- /description --> </div><div class="apiItem" jsselect="functions" jstcache="5" jsinstance="*1"> <a jsvalues=".name:'method-' + name" jstcache="7" name="method-collapse"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="8">collapse</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="returns.typeName" jstcache="10" style="display: none; ">void</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="fullName" jstcache="11">chrome.toolstrip.collapse</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="12" jsinstance="0" class="optional"><span jsdisplay="$index" jstcache="21" style="display: none; ">, </span><span jscontent="typeName" jstcache="22">string</span> <var jstcache="0"><span jscontent="name" jstcache="8">url</span></var></span><span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="12" jsinstance="*1" class="optional"><span jsdisplay="$index" jstcache="21">, </span><span jscontent="typeName" jstcache="22">function</span> <var jstcache="0"><span jscontent="name" jstcache="8">callback</span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="13">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="14" style="display: none; "> A description from the json schema def of the function goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="23" jsinstance="0"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">url</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">string</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28" style="display: none; "> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div><div jsselect="parameters" jstcache="23" jsinstance="*1"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">callback</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">function</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28" style="display: none; "> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="15" style="display: none; ">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="24" style="display: none; "> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var> <em jstcache="0">(<span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> <!-- CALLBACK --> <div jsdisplay="callbackParameters" jstcache="16" style="display: none; "> <h4 jstcache="0">Callback function</h4> <p jstcache="0"> If you specify the <em jstcache="0">callback</em> parameter, it should specify a function that looks like this: </p> <!-- Note: intentionally longer 80 columns --> <pre jstcache="0">function(<span jscontent="callbackSignature" jstcache="29">Type param1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="callbackParameters" jstcache="30"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> </div> </div> <!-- /description --> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> <!-- EVENTS --> <div class="apiGroup" id="events" jstcache="0"> <a name="#events" jstcache="0"></a> <h2 id="events" jstcache="0">Events</h2> <!-- iterates over all events --> <div jsselect="events" class="apiItem" jstcache="6" jsinstance="*0" style="display: none; "> <a jsvalues=".name:'event-' + name" jstcache="9"></a> <h3 jscontent="name" jstcache="8">event name</h3> <div class="summary" jstcache="0"> <!-- Note: intentionally longer 80 columns --> <span class="subdued" jstcache="0">chrome.bookmarks.</span><span jscontent="name" jstcache="8">onEvent</span><span class="subdued" jstcache="0">.addListener</span>(function(<span jscontent="callSignature" jstcache="17">Type param1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>); </div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="13">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="14"> A description from the json schema def of the event goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="23"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26">Undocumented.</dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> </div> <!-- /decription --> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> </div> <!-- /apiPage --> </div> <!-- /mainColumn --> </div> <!-- /pageContent --> <div id="pageFooter" --="" jstcache="0"> Copyright 2009 <br jstcache="0"> TBD: copyright/license should be automatically included here </div> <!-- /pageFooter --> </div> <!-- /container --> </body></html><!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc. Note: 1) The <head> information in this page is significant, should be uniform across api docs and should be edited only with knowledge of the templating mechanism. 2) The <body> tag *must* retain id="body" 3) All <body>.innerHTML is genereated as an rendering step. If viewed in a browser, it will be re-generated from the template, json schema and authored overview content. 4) The <body>.innerHTML is also generated by an offline step so that this page may easily be indexed by search engines. TODO(rafaelw): Abstract this into a "pageshell" that becomes the single version of page template shell and the "instance" pages (bookmarks.html, etc...) can be generated with a build step. --><!-- <html> must retain id="template --><html xmlns="http://www.w3.org/1999/xhtml" jstcache="0"><!-- <head> data is significant and loads the needed libraries and styles --><head jstcache="0"> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" jstcache="0"> <title jscontent="pageTitle" jstcache="1">chrome.toolstrip API Reference</title> <link href="css/ApiRefStyles.css" rel="stylesheet" type="text/css" jstcache="0"> <script type="text/javascript" src="../../../third_party/jstemplate/jstemplate_compiled.js" jstcache="0"> </script> <script type="text/javascript" src="js/api_page_generator.js" jstcache="0"></script> <script type="text/javascript" src="js/bootstrap.js" jstcache="0"></script> </head><!-- <body> content is completely generated. Do not edit, as it will be and rewritten. --><body class="" jstcache="0"> <div id="container" jstcache="0"> <a name="top" jstcache="0"> </a> <!-- API HEADER --> <div id="pageHeader" jstcache="0"> <!-- BREADCRUMB --> <!-- TODO: Fix these hrefs --> <div id="breadcrumbs" jstcache="0"> <a href="index.html" jstcache="0">Google Chrome Extensions</a> > <a href="reference_index.html" jstcache="0">Reference</a> > <a href="api_index.html" jstcache="0">chrome.* APIs</a> > <span jscontent="namespace" jstcache="2">null</span> </div> <div id="searchbox" jstcache="0"> <form action="http://www.google.com/cse" id="cse-search-box" jstcache="0"> <div jstcache="0"> <input type="hidden" name="cx" value="002967670403910741006:61_cvzfqtno" jstcache="0"> <input type="hidden" name="ie" value="UTF-8" jstcache="0"> <input type="text" name="q" size="31" jstcache="0"> <input type="submit" name="sa" value="Search" jstcache="0"> </div> </form> <script type="text/javascript" src="http://www.google.com/jsapi" jstcache="0"></script> <script type="text/javascript" jstcache="0">google.load("elements", "1", {packages: "transliteration"});</script> <script type="text/javascript" src="http://www.google.com/coop/cse/t13n?form=cse-search-box&t13n_langs=en" jstcache="0"></script> <script type="text/javascript" src="http://www.google.com/coop/cse/brand?form=cse-search-box&lang=en" jstcache="0"></script> </div> <div id="pageTitle" jstcache="0"> <h1 jscontent="h1Header" jstcache="3">chrome.toolstrip</h1> </div> </div> <!-- /pageHeader --> <div id="pageContent" jstcache="0"> <!-- SIDENAV --> <div id="leftNav" jstcache="0"> <ul jstcache="0"> <li jstcache="0"> <a href="overview.html" jstcache="0">Overview</a></li> <li jstcache="0"> <a href="getstarted.html" jstcache="0">Get Started</a></li> <li jstcache="0"> <a href="devguide.html" jstcache="0">Developer's Guide</a></li> <li jstcache="0"> Reference <ul jstcache="0"> <li jstcache="0"> <a href="api_index.html" jstcache="0">Extension APIs</a> <ul jstcache="0"> <li jsselect="apiModules" jstcache="18" jsinstance="0"> <a jscontent="name" jsvalues=".href:module + '.html'" jstcache="25" href="bookmarks.html">Bookmarks</a> </li><li jsselect="apiModules" jstcache="18" jsinstance="1"> <a jscontent="name" jsvalues=".href:module + '.html'" jstcache="25" href="toolstrip.html">Toolstrip</a> </li><li jsselect="apiModules" jstcache="18" jsinstance="2"> <a jscontent="name" jsvalues=".href:module + '.html'" jstcache="25" href="pageActions.html">PageActions</a> </li><li jsselect="apiModules" jstcache="18" jsinstance="3"> <a jscontent="name" jsvalues=".href:module + '.html'" jstcache="25" href="windows.html">Windows</a> </li><li jsselect="apiModules" jstcache="18" jsinstance="4"> <a jscontent="name" jsvalues=".href:module + '.html'" jstcache="25" href="tabs.html">Tabs</a> </li><li jsselect="apiModules" jstcache="18" jsinstance="*5"> <a jscontent="name" jsvalues=".href:module + '.html'" jstcache="25" href="self.html">Self</a> </li> </ul> </li> </ul> </li> </ul> </div> <div id="mainColumn" jstcache="0"> <!-- TABLE OF CONTENTS --> <div id="toc" jsselect="apiDefinition" jstcache="4"> <p jstcache="0">Contents</p> <ol jstcache="0"> <li jstcache="0"> <a href="#overview" jstcache="0">Description</a> <ol jstcache="0"> <li jstcache="0"><a href="#overview-properties" jstcache="0">Properties</a></li> <li jstcache="0"><a href="#overview-examples" jstcache="0">Examples</a></li> </ol> </li> <li jstcache="0"> <a href="#methods" jstcache="0">Methods</a> <ol jstcache="0"> <li jsselect="functions" jstcache="5" jsinstance="0"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-expand" jstcache="19">expand</a> </li><li jsselect="functions" jstcache="5" jsinstance="*1"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-collapse" jstcache="19">collapse</a> </li> </ol> </li> <li jstcache="0"> <a href="#events" jstcache="0">Events</a> <ol jstcache="0"> <li jsselect="events" jstcache="6" jsinstance="*0" style="display: none; "> <a jscontent="name" jsvalues=".href:'#event-' + name" href="#event-anchor" jstcache="20">eventName</a> </li> </ol> </li> <!-- TODO: What do we do about structs/types? --> <li jstcache="0"> <a href="#structs" jstcache="0">TODO: Structs</a> <ol jstcache="0"> <li jstcache="0"><a href="#struct-BookmarkTreeNode" jstcache="0"></a></li> </ol> </li> </ol> [PENDING: links to all h2s and h3s should go here -- would it be possible to link to overview h3s, as well? if so, how should we create their anchor/id values?] </div> <!-- /TABLE OF CONTENTS --> <!-- STATIC CONTENT PLACEHOLDER --> <div id="static" jstcache="0"></div> <!-- API PAGE --> <div class="apiPage" jsselect="apiDefinition" jstcache="4"> <!-- METHODS --> <div class="apiGroup" id="methods" jstcache="0"> <a name="#methods" jstcache="0"></a> <h2 jstcache="0">Methods</h2> <!-- iterates over all functions --> <div class="apiItem" jsselect="functions" jstcache="5" jsinstance="0"> <a jsvalues=".name:'method-' + name" jstcache="7" name="method-expand"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="8">expand</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="returns.typeName" jstcache="10" style="display: none; ">void</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="fullName" jstcache="11">chrome.toolstrip.expand</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="12" jsinstance="0" class="null"><span jsdisplay="$index" jstcache="21" style="display: none; ">, </span><span jscontent="typeName" jstcache="22">integer</span> <var jstcache="0"><span jscontent="name" jstcache="8">height</span></var></span><span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="12" jsinstance="1" class="optional"><span jsdisplay="$index" jstcache="21">, </span><span jscontent="typeName" jstcache="22">string</span> <var jstcache="0"><span jscontent="name" jstcache="8">url</span></var></span><span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="12" jsinstance="*2" class="optional"><span jsdisplay="$index" jstcache="21">, </span><span jscontent="typeName" jstcache="22">function</span> <var jstcache="0"><span jscontent="name" jstcache="8">callback</span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="13">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="14" style="display: none; "> A description from the json schema def of the function goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="23" jsinstance="0"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">height</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31" style="display: none; ">optional </span><span jscontent="typeName" jstcache="22">integer</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28" style="display: none; "> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div><div jsselect="parameters" jstcache="23" jsinstance="1"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">url</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">string</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28" style="display: none; "> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div><div jsselect="parameters" jstcache="23" jsinstance="*2"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">callback</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">function</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28" style="display: none; "> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="15" style="display: none; ">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="24" style="display: none; "> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var> <em jstcache="0">(<span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> <!-- CALLBACK --> <div jsdisplay="callbackParameters" jstcache="16" style="display: none; "> <h4 jstcache="0">Callback function</h4> <p jstcache="0"> If you specify the <em jstcache="0">callback</em> parameter, it should specify a function that looks like this: </p> <!-- Note: intentionally longer 80 columns --> <pre jstcache="0">function(<span jscontent="callbackSignature" jstcache="29">Type param1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="callbackParameters" jstcache="30"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> </div> </div> <!-- /description --> </div><div class="apiItem" jsselect="functions" jstcache="5" jsinstance="*1"> <a jsvalues=".name:'method-' + name" jstcache="7" name="method-collapse"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="8">collapse</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="returns.typeName" jstcache="10" style="display: none; ">void</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="fullName" jstcache="11">chrome.toolstrip.collapse</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="12" jsinstance="0" class="optional"><span jsdisplay="$index" jstcache="21" style="display: none; ">, </span><span jscontent="typeName" jstcache="22">string</span> <var jstcache="0"><span jscontent="name" jstcache="8">url</span></var></span><span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="12" jsinstance="*1" class="optional"><span jsdisplay="$index" jstcache="21">, </span><span jscontent="typeName" jstcache="22">function</span> <var jstcache="0"><span jscontent="name" jstcache="8">callback</span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="13">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="14" style="display: none; "> A description from the json schema def of the function goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="23" jsinstance="0"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">url</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">string</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28" style="display: none; "> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div><div jsselect="parameters" jstcache="23" jsinstance="*1"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">callback</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">function</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28" style="display: none; "> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="15" style="display: none; ">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="24" style="display: none; "> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var> <em jstcache="0">(<span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> <!-- CALLBACK --> <div jsdisplay="callbackParameters" jstcache="16" style="display: none; "> <h4 jstcache="0">Callback function</h4> <p jstcache="0"> If you specify the <em jstcache="0">callback</em> parameter, it should specify a function that looks like this: </p> <!-- Note: intentionally longer 80 columns --> <pre jstcache="0">function(<span jscontent="callbackSignature" jstcache="29">Type param1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="callbackParameters" jstcache="30"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> </div> </div> <!-- /description --> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> <!-- EVENTS --> <div class="apiGroup" id="events" jstcache="0"> <a name="#events" jstcache="0"></a> <h2 id="events" jstcache="0">Events</h2> <!-- iterates over all events --> <div jsselect="events" class="apiItem" jstcache="6" jsinstance="*0" style="display: none; "> <a jsvalues=".name:'event-' + name" jstcache="9"></a> <h3 jscontent="name" jstcache="8">event name</h3> <div class="summary" jstcache="0"> <!-- Note: intentionally longer 80 columns --> <span class="subdued" jstcache="0">chrome.bookmarks.</span><span jscontent="name" jstcache="8">onEvent</span><span class="subdued" jstcache="0">.addListener</span>(function(<span jscontent="callSignature" jstcache="17">Type param1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>); </div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="13">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="14"> A description from the json schema def of the event goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="23"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26">Undocumented.</dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> </div> <!-- /decription --> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> </div> <!-- /apiPage --> </div> <!-- /mainColumn --> </div> <!-- /pageContent --> <div id="pageFooter" --="" jstcache="0"> Copyright 2009 <br jstcache="0"> TBD: copyright/license should be automatically included here </div> <!-- /pageFooter --> </div> <!-- /container --> </body></html>
diff --git a/chrome/common/extensions/docs/windows.html b/chrome/common/extensions/docs/windows.html index faf8a37..2bd300b 100755 --- a/chrome/common/extensions/docs/windows.html +++ b/chrome/common/extensions/docs/windows.html @@ -1,46 +1 @@ -<!DOCTYPE html> -<!-- This page is a placeholder for generated extensions api doc. Note: - 1) The <head> information in this page is significant, should be uniform - across api docs and should be edited only with knowledge of the - templating mechanism. - 2) The <body> tag *must* retain id="body" - 3) All <body>.innerHTML is genereated as an rendering step. If viewed in a - browser, it will be re-generated from the template, json schema and - authored overview content. - 4) The <body>.innerHTML is also generated by an offline step so that this - page may easily be indexed by search engines. - - TODO(rafaelw): Abstract this into a "pageshell" that becomes the single - version of page template shell and the "instance" pages (bookmarks.html, - etc...) can be generated with a build step. ---> -<!-- <html> must retain id="template --> -<html xmlns="http://www.w3.org/1999/xhtml"> - <!-- <head> data is significant and loads the needed libraries and styles --> - <head> - <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> - <title jscontent="pageTitle">pageTitle</title> - <link href="css/ApiRefStyles.css" rel="stylesheet" type="text/css"> - <script type="text/javascript" - src="../../../third_party/jstemplate/jstemplate_compiled.js"> - </script> - <script type="text/javascript" src="js/api_page_generator.js"></script> - <script> -// Re-render the page if the user-agent is chrome and it is being served as -// a file:/// scheme. This allows both the initial render to static as well -// as dynamic re-rendering for developers/doc-writers working on local changes. -window.onload = function() { - var chrome = navigator.userAgent.indexOf("Chrome") > -1; - var fileScheme = location.protocol == "file:"; - var regenerate = chrome && fileScheme; - //if (regenerate) { - window.renderPage(); - //} -} - </script> - </head> - <!-- <body> content is completely generated. Do not edit, as it will be - and rewritten. --> - <body class="hidden"> - </body> -</html> +<!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc. Note: 1) The <head> information in this page is significant, should be uniform across api docs and should be edited only with knowledge of the templating mechanism. 2) The <body> tag *must* retain id="body" 3) All <body>.innerHTML is genereated as an rendering step. If viewed in a browser, it will be re-generated from the template, json schema and authored overview content. 4) The <body>.innerHTML is also generated by an offline step so that this page may easily be indexed by search engines. TODO(rafaelw): Abstract this into a "pageshell" that becomes the single version of page template shell and the "instance" pages (bookmarks.html, etc...) can be generated with a build step. --><!-- <html> must retain id="template --><html xmlns="http://www.w3.org/1999/xhtml" jstcache="0"><!-- <head> data is significant and loads the needed libraries and styles --><head jstcache="0"> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" jstcache="0"> <title jscontent="pageTitle" jstcache="1">chrome.windows API Reference</title> <link href="css/ApiRefStyles.css" rel="stylesheet" type="text/css" jstcache="0"> <script type="text/javascript" src="../../../third_party/jstemplate/jstemplate_compiled.js" jstcache="0"> </script> <script type="text/javascript" src="js/api_page_generator.js" jstcache="0"></script> <script type="text/javascript" src="js/bootstrap.js" jstcache="0"></script> </head><!-- <body> content is completely generated. Do not edit, as it will be and rewritten. --><body class="" jstcache="0"> <div id="container" jstcache="0"> <a name="top" jstcache="0"> </a> <!-- API HEADER --> <div id="pageHeader" jstcache="0"> <!-- BREADCRUMB --> <!-- TODO: Fix these hrefs --> <div id="breadcrumbs" jstcache="0"> <a href="index.html" jstcache="0">Google Chrome Extensions</a> > <a href="reference_index.html" jstcache="0">Reference</a> > <a href="api_index.html" jstcache="0">chrome.* APIs</a> > <span jscontent="namespace" jstcache="2">null</span> </div> <div id="searchbox" jstcache="0"> <form action="http://www.google.com/cse" id="cse-search-box" jstcache="0"> <div jstcache="0"> <input type="hidden" name="cx" value="002967670403910741006:61_cvzfqtno" jstcache="0"> <input type="hidden" name="ie" value="UTF-8" jstcache="0"> <input type="text" name="q" size="31" jstcache="0"> <input type="submit" name="sa" value="Search" jstcache="0"> </div> </form> <script type="text/javascript" src="http://www.google.com/jsapi" jstcache="0"></script> <script type="text/javascript" jstcache="0">google.load("elements", "1", {packages: "transliteration"});</script> <script type="text/javascript" src="http://www.google.com/coop/cse/t13n?form=cse-search-box&t13n_langs=en" jstcache="0"></script> <script type="text/javascript" src="http://www.google.com/coop/cse/brand?form=cse-search-box&lang=en" jstcache="0"></script> </div> <div id="pageTitle" jstcache="0"> <h1 jscontent="h1Header" jstcache="3">chrome.windows</h1> </div> </div> <!-- /pageHeader --> <div id="pageContent" jstcache="0"> <!-- SIDENAV --> <div id="leftNav" jstcache="0"> <ul jstcache="0"> <li jstcache="0"> <a href="overview.html" jstcache="0">Overview</a></li> <li jstcache="0"> <a href="getstarted.html" jstcache="0">Get Started</a></li> <li jstcache="0"> <a href="devguide.html" jstcache="0">Developer's Guide</a></li> <li jstcache="0"> Reference <ul jstcache="0"> <li jstcache="0"> <a href="api_index.html" jstcache="0">Extension APIs</a> <ul jstcache="0"> <li jsselect="apiModules" jstcache="18" jsinstance="0"> <a jscontent="name" jsvalues=".href:module + '.html'" jstcache="25" href="bookmarks.html">Bookmarks</a> </li><li jsselect="apiModules" jstcache="18" jsinstance="1"> <a jscontent="name" jsvalues=".href:module + '.html'" jstcache="25" href="toolstrip.html">Toolstrip</a> </li><li jsselect="apiModules" jstcache="18" jsinstance="2"> <a jscontent="name" jsvalues=".href:module + '.html'" jstcache="25" href="pageActions.html">PageActions</a> </li><li jsselect="apiModules" jstcache="18" jsinstance="3"> <a jscontent="name" jsvalues=".href:module + '.html'" jstcache="25" href="windows.html">Windows</a> </li><li jsselect="apiModules" jstcache="18" jsinstance="4"> <a jscontent="name" jsvalues=".href:module + '.html'" jstcache="25" href="tabs.html">Tabs</a> </li><li jsselect="apiModules" jstcache="18" jsinstance="*5"> <a jscontent="name" jsvalues=".href:module + '.html'" jstcache="25" href="self.html">Self</a> </li> </ul> </li> </ul> </li> </ul> </div> <div id="mainColumn" jstcache="0"> <!-- TABLE OF CONTENTS --> <div id="toc" jsselect="apiDefinition" jstcache="4"> <p jstcache="0">Contents</p> <ol jstcache="0"> <li jstcache="0"> <a href="#overview" jstcache="0">Description</a> <ol jstcache="0"> <li jstcache="0"><a href="#overview-properties" jstcache="0">Properties</a></li> <li jstcache="0"><a href="#overview-examples" jstcache="0">Examples</a></li> </ol> </li> <li jstcache="0"> <a href="#methods" jstcache="0">Methods</a> <ol jstcache="0"> <li jsselect="functions" jstcache="5" jsinstance="0"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-get" jstcache="19">get</a> </li><li jsselect="functions" jstcache="5" jsinstance="1"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-getCurrent" jstcache="19">getCurrent</a> </li><li jsselect="functions" jstcache="5" jsinstance="2"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-getLastFocused" jstcache="19">getLastFocused</a> </li><li jsselect="functions" jstcache="5" jsinstance="3"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-getAll" jstcache="19">getAll</a> </li><li jsselect="functions" jstcache="5" jsinstance="4"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-create" jstcache="19">create</a> </li><li jsselect="functions" jstcache="5" jsinstance="5"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-update" jstcache="19">update</a> </li><li jsselect="functions" jstcache="5" jsinstance="*6"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-remove" jstcache="19">remove</a> </li> </ol> </li> <li jstcache="0"> <a href="#events" jstcache="0">Events</a> <ol jstcache="0"> <li jsselect="events" jstcache="6" jsinstance="0"> <a jscontent="name" jsvalues=".href:'#event-' + name" href="#event-onCreated" jstcache="20">onCreated</a> </li><li jsselect="events" jstcache="6" jsinstance="1"> <a jscontent="name" jsvalues=".href:'#event-' + name" href="#event-onRemoved" jstcache="20">onRemoved</a> </li><li jsselect="events" jstcache="6" jsinstance="*2"> <a jscontent="name" jsvalues=".href:'#event-' + name" href="#event-onFocusChanged" jstcache="20">onFocusChanged</a> </li> </ol> </li> <!-- TODO: What do we do about structs/types? --> <li jstcache="0"> <a href="#structs" jstcache="0">TODO: Structs</a> <ol jstcache="0"> <li jstcache="0"><a href="#struct-BookmarkTreeNode" jstcache="0"></a></li> </ol> </li> </ol> [PENDING: links to all h2s and h3s should go here -- would it be possible to link to overview h3s, as well? if so, how should we create their anchor/id values?] </div> <!-- /TABLE OF CONTENTS --> <!-- STATIC CONTENT PLACEHOLDER --> <div id="static" jstcache="0"><!-- BEGIN AUTHORED CONTENT --> <p class="todo" jstcache="0"> [PENDING: API Module Overview Goes Here] </p> <!-- END AUTHORED CONTENT --> </div> <!-- API PAGE --> <div class="apiPage" jsselect="apiDefinition" jstcache="4"> <!-- METHODS --> <div class="apiGroup" id="methods" jstcache="0"> <a name="#methods" jstcache="0"></a> <h2 jstcache="0">Methods</h2> <!-- iterates over all functions --> <div class="apiItem" jsselect="functions" jstcache="5" jsinstance="0"> <a jsvalues=".name:'method-' + name" jstcache="7" name="method-get"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="8">get</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="returns.typeName" jstcache="10" style="display: none; ">void</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="fullName" jstcache="11">chrome.windows.get</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="12" jsinstance="0" class="null"><span jsdisplay="$index" jstcache="21" style="display: none; ">, </span><span jscontent="typeName" jstcache="22">integer</span> <var jstcache="0"><span jscontent="name" jstcache="8">windowId</span></var></span><span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="12" jsinstance="*1" class="null"><span jsdisplay="$index" jstcache="21">, </span><span jscontent="typeName" jstcache="22">function</span> <var jstcache="0"><span jscontent="name" jstcache="8">callback</span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="13">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="14" style="display: none; "> A description from the json schema def of the function goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="23" jsinstance="0"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">windowId</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31" style="display: none; ">optional </span><span jscontent="typeName" jstcache="22">integer</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28" style="display: none; "> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div><div jsselect="parameters" jstcache="23" jsinstance="*1"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">callback</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31" style="display: none; ">optional </span><span jscontent="typeName" jstcache="22">function</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28" style="display: none; "> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="15" style="display: none; ">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="24" style="display: none; "> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var> <em jstcache="0">(<span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> <!-- CALLBACK --> <div jsdisplay="callbackParameters" jstcache="16" style="display: none; "> <h4 jstcache="0">Callback function</h4> <p jstcache="0"> If you specify the <em jstcache="0">callback</em> parameter, it should specify a function that looks like this: </p> <!-- Note: intentionally longer 80 columns --> <pre jstcache="0">function(<span jscontent="callbackSignature" jstcache="29">Type param1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="callbackParameters" jstcache="30"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> </div> </div> <!-- /description --> </div><div class="apiItem" jsselect="functions" jstcache="5" jsinstance="1"> <a jsvalues=".name:'method-' + name" jstcache="7" name="method-getCurrent"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="8">getCurrent</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="returns.typeName" jstcache="10" style="display: none; ">void</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="fullName" jstcache="11">chrome.windows.getCurrent</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="12" jsinstance="*0" class="null"><span jsdisplay="$index" jstcache="21" style="display: none; ">, </span><span jscontent="typeName" jstcache="22">function</span> <var jstcache="0"><span jscontent="name" jstcache="8">callback</span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="13">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="14" style="display: none; "> A description from the json schema def of the function goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="23" jsinstance="*0"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">callback</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31" style="display: none; ">optional </span><span jscontent="typeName" jstcache="22">function</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28" style="display: none; "> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="15" style="display: none; ">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="24" style="display: none; "> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var> <em jstcache="0">(<span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> <!-- CALLBACK --> <div jsdisplay="callbackParameters" jstcache="16" style="display: none; "> <h4 jstcache="0">Callback function</h4> <p jstcache="0"> If you specify the <em jstcache="0">callback</em> parameter, it should specify a function that looks like this: </p> <!-- Note: intentionally longer 80 columns --> <pre jstcache="0">function(<span jscontent="callbackSignature" jstcache="29">Type param1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="callbackParameters" jstcache="30"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> </div> </div> <!-- /description --> </div><div class="apiItem" jsselect="functions" jstcache="5" jsinstance="2"> <a jsvalues=".name:'method-' + name" jstcache="7" name="method-getLastFocused"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="8">getLastFocused</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="returns.typeName" jstcache="10" style="display: none; ">void</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="fullName" jstcache="11">chrome.windows.getLastFocused</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="12" jsinstance="*0" class="null"><span jsdisplay="$index" jstcache="21" style="display: none; ">, </span><span jscontent="typeName" jstcache="22">function</span> <var jstcache="0"><span jscontent="name" jstcache="8">callback</span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="13">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="14" style="display: none; "> A description from the json schema def of the function goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="23" jsinstance="*0"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">callback</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31" style="display: none; ">optional </span><span jscontent="typeName" jstcache="22">function</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28" style="display: none; "> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="15" style="display: none; ">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="24" style="display: none; "> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var> <em jstcache="0">(<span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> <!-- CALLBACK --> <div jsdisplay="callbackParameters" jstcache="16" style="display: none; "> <h4 jstcache="0">Callback function</h4> <p jstcache="0"> If you specify the <em jstcache="0">callback</em> parameter, it should specify a function that looks like this: </p> <!-- Note: intentionally longer 80 columns --> <pre jstcache="0">function(<span jscontent="callbackSignature" jstcache="29">Type param1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="callbackParameters" jstcache="30"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> </div> </div> <!-- /description --> </div><div class="apiItem" jsselect="functions" jstcache="5" jsinstance="3"> <a jsvalues=".name:'method-' + name" jstcache="7" name="method-getAll"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="8">getAll</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="returns.typeName" jstcache="10" style="display: none; ">void</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="fullName" jstcache="11">chrome.windows.getAll</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="12" jsinstance="0" class="optional"><span jsdisplay="$index" jstcache="21" style="display: none; ">, </span><span jscontent="typeName" jstcache="22">boolean</span> <var jstcache="0"><span jscontent="name" jstcache="8">populate</span></var></span><span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="12" jsinstance="*1" class="null"><span jsdisplay="$index" jstcache="21">, </span><span jscontent="typeName" jstcache="22">function</span> <var jstcache="0"><span jscontent="name" jstcache="8">callback</span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="13">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="14" style="display: none; "> A description from the json schema def of the function goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="23" jsinstance="0"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">populate</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">boolean</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28" style="display: none; "> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div><div jsselect="parameters" jstcache="23" jsinstance="*1"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">callback</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31" style="display: none; ">optional </span><span jscontent="typeName" jstcache="22">function</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28" style="display: none; "> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="15" style="display: none; ">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="24" style="display: none; "> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var> <em jstcache="0">(<span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> <!-- CALLBACK --> <div jsdisplay="callbackParameters" jstcache="16" style="display: none; "> <h4 jstcache="0">Callback function</h4> <p jstcache="0"> If you specify the <em jstcache="0">callback</em> parameter, it should specify a function that looks like this: </p> <!-- Note: intentionally longer 80 columns --> <pre jstcache="0">function(<span jscontent="callbackSignature" jstcache="29">Type param1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="callbackParameters" jstcache="30"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> </div> </div> <!-- /description --> </div><div class="apiItem" jsselect="functions" jstcache="5" jsinstance="4"> <a jsvalues=".name:'method-' + name" jstcache="7" name="method-create"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="8">create</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="returns.typeName" jstcache="10" style="display: none; ">void</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="fullName" jstcache="11">chrome.windows.create</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="12" jsinstance="0" class="optional"><span jsdisplay="$index" jstcache="21" style="display: none; ">, </span><span jscontent="typeName" jstcache="22">object</span> <var jstcache="0"><span jscontent="name" jstcache="8">CreateData</span></var></span><span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="12" jsinstance="*1" class="optional"><span jsdisplay="$index" jstcache="21">, </span><span jscontent="typeName" jstcache="22">function</span> <var jstcache="0"><span jscontent="name" jstcache="8">callback</span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="13">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="14" style="display: none; "> A description from the json schema def of the function goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="23" jsinstance="0"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">CreateData</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">object</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32" jsinstance="0"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">url</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">string</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> </div><div jsselect="_propertyList" jstcache="32" jsinstance="1"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">left</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">integer</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> </div><div jsselect="_propertyList" jstcache="32" jsinstance="2"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">top</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">integer</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> </div><div jsselect="_propertyList" jstcache="32" jsinstance="3"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">width</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">integer</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> </div><div jsselect="_propertyList" jstcache="32" jsinstance="*4"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">height</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">integer</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div><div jsselect="parameters" jstcache="23" jsinstance="*1"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">callback</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">function</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28" style="display: none; "> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="15" style="display: none; ">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="24" style="display: none; "> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var> <em jstcache="0">(<span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> <!-- CALLBACK --> <div jsdisplay="callbackParameters" jstcache="16" style="display: none; "> <h4 jstcache="0">Callback function</h4> <p jstcache="0"> If you specify the <em jstcache="0">callback</em> parameter, it should specify a function that looks like this: </p> <!-- Note: intentionally longer 80 columns --> <pre jstcache="0">function(<span jscontent="callbackSignature" jstcache="29">Type param1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="callbackParameters" jstcache="30"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> </div> </div> <!-- /description --> </div><div class="apiItem" jsselect="functions" jstcache="5" jsinstance="5"> <a jsvalues=".name:'method-' + name" jstcache="7" name="method-update"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="8">update</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="returns.typeName" jstcache="10" style="display: none; ">void</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="fullName" jstcache="11">chrome.windows.update</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="12" jsinstance="0" class="null"><span jsdisplay="$index" jstcache="21" style="display: none; ">, </span><span jscontent="typeName" jstcache="22">integer</span> <var jstcache="0"><span jscontent="name" jstcache="8">windowId</span></var></span><span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="12" jsinstance="1" class="null"><span jsdisplay="$index" jstcache="21">, </span><span jscontent="typeName" jstcache="22">object</span> <var jstcache="0"><span jscontent="name" jstcache="8">UpdateInfo</span></var></span><span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="12" jsinstance="*2" class="optional"><span jsdisplay="$index" jstcache="21">, </span><span jscontent="typeName" jstcache="22">function</span> <var jstcache="0"><span jscontent="name" jstcache="8">callback</span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="13">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="14" style="display: none; "> A description from the json schema def of the function goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="23" jsinstance="0"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">windowId</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31" style="display: none; ">optional </span><span jscontent="typeName" jstcache="22">integer</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28" style="display: none; "> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div><div jsselect="parameters" jstcache="23" jsinstance="1"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">UpdateInfo</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31" style="display: none; ">optional </span><span jscontent="typeName" jstcache="22">object</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32" jsinstance="0"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">left</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">integer</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> </div><div jsselect="_propertyList" jstcache="32" jsinstance="1"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">top</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">integer</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> </div><div jsselect="_propertyList" jstcache="32" jsinstance="2"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">width</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">integer</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> </div><div jsselect="_propertyList" jstcache="32" jsinstance="*3"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">height</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">integer</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div><div jsselect="parameters" jstcache="23" jsinstance="*2"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">callback</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">function</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28" style="display: none; "> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="15" style="display: none; ">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="24" style="display: none; "> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var> <em jstcache="0">(<span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> <!-- CALLBACK --> <div jsdisplay="callbackParameters" jstcache="16" style="display: none; "> <h4 jstcache="0">Callback function</h4> <p jstcache="0"> If you specify the <em jstcache="0">callback</em> parameter, it should specify a function that looks like this: </p> <!-- Note: intentionally longer 80 columns --> <pre jstcache="0">function(<span jscontent="callbackSignature" jstcache="29">Type param1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="callbackParameters" jstcache="30"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> </div> </div> <!-- /description --> </div><div class="apiItem" jsselect="functions" jstcache="5" jsinstance="*6"> <a jsvalues=".name:'method-' + name" jstcache="7" name="method-remove"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="8">remove</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="returns.typeName" jstcache="10" style="display: none; ">void</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="fullName" jstcache="11">chrome.windows.remove</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="12" jsinstance="0" class="null"><span jsdisplay="$index" jstcache="21" style="display: none; ">, </span><span jscontent="typeName" jstcache="22">integer</span> <var jstcache="0"><span jscontent="name" jstcache="8">windowId</span></var></span><span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="12" jsinstance="*1" class="optional"><span jsdisplay="$index" jstcache="21">, </span><span jscontent="typeName" jstcache="22">function</span> <var jstcache="0"><span jscontent="name" jstcache="8">callback</span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="13">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="14" style="display: none; "> A description from the json schema def of the function goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="23" jsinstance="0"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">windowId</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31" style="display: none; ">optional </span><span jscontent="typeName" jstcache="22">integer</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28" style="display: none; "> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div><div jsselect="parameters" jstcache="23" jsinstance="*1"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">callback</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">function</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28" style="display: none; "> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="15" style="display: none; ">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="24" style="display: none; "> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var> <em jstcache="0">(<span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> <!-- CALLBACK --> <div jsdisplay="callbackParameters" jstcache="16" style="display: none; "> <h4 jstcache="0">Callback function</h4> <p jstcache="0"> If you specify the <em jstcache="0">callback</em> parameter, it should specify a function that looks like this: </p> <!-- Note: intentionally longer 80 columns --> <pre jstcache="0">function(<span jscontent="callbackSignature" jstcache="29">Type param1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="callbackParameters" jstcache="30"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> </div> </div> <!-- /description --> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> <!-- EVENTS --> <div class="apiGroup" id="events" jstcache="0"> <a name="#events" jstcache="0"></a> <h2 id="events" jstcache="0">Events</h2> <!-- iterates over all events --> <div jsselect="events" class="apiItem" jstcache="6" jsinstance="0"> <a jsvalues=".name:'event-' + name" jstcache="9" name="event-onCreated"></a> <h3 jscontent="name" jstcache="8">onCreated</h3> <div class="summary" jstcache="0"> <!-- Note: intentionally longer 80 columns --> <span class="subdued" jstcache="0">chrome.bookmarks.</span><span jscontent="name" jstcache="8">onCreated</span><span class="subdued" jstcache="0">.addListener</span>(function(<span jscontent="callSignature" jstcache="17">integer windowId</span>) <span class="subdued" jstcache="0">{...}</span>); </div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="13">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="14" style="display: none; "> A description from the json schema def of the event goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="23" jsinstance="*0"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">windowId</var><em jstcache="0"> (<span jscontent="typeName" jstcache="22">integer</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26">Undocumented.</dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28" style="display: none; "> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> </div> <!-- /decription --> </div><div jsselect="events" class="apiItem" jstcache="6" jsinstance="1"> <a jsvalues=".name:'event-' + name" jstcache="9" name="event-onRemoved"></a> <h3 jscontent="name" jstcache="8">onRemoved</h3> <div class="summary" jstcache="0"> <!-- Note: intentionally longer 80 columns --> <span class="subdued" jstcache="0">chrome.bookmarks.</span><span jscontent="name" jstcache="8">onRemoved</span><span class="subdued" jstcache="0">.addListener</span>(function(<span jscontent="callSignature" jstcache="17">integer windowId</span>) <span class="subdued" jstcache="0">{...}</span>); </div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="13">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="14" style="display: none; "> A description from the json schema def of the event goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="23" jsinstance="*0"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">windowId</var><em jstcache="0"> (<span jscontent="typeName" jstcache="22">integer</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26">Undocumented.</dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28" style="display: none; "> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> </div> <!-- /decription --> </div><div jsselect="events" class="apiItem" jstcache="6" jsinstance="*2"> <a jsvalues=".name:'event-' + name" jstcache="9" name="event-onFocusChanged"></a> <h3 jscontent="name" jstcache="8">onFocusChanged</h3> <div class="summary" jstcache="0"> <!-- Note: intentionally longer 80 columns --> <span class="subdued" jstcache="0">chrome.bookmarks.</span><span jscontent="name" jstcache="8">onFocusChanged</span><span class="subdued" jstcache="0">.addListener</span>(function(<span jscontent="callSignature" jstcache="17">integer windowId</span>) <span class="subdued" jstcache="0">{...}</span>); </div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="13">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="14" style="display: none; "> A description from the json schema def of the event goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="23" jsinstance="*0"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">windowId</var><em jstcache="0"> (<span jscontent="typeName" jstcache="22">integer</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26">Undocumented.</dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28" style="display: none; "> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> </div> <!-- /decription --> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> </div> <!-- /apiPage --> </div> <!-- /mainColumn --> </div> <!-- /pageContent --> <div id="pageFooter" --="" jstcache="0"> Copyright 2009 <br jstcache="0"> TBD: copyright/license should be automatically included here </div> <!-- /pageFooter --> </div> <!-- /container --> </body></html>
|