From dc32abbf2844f243ffda58c8157e027e4bd1372c Mon Sep 17 00:00:00 2001 From: "miket@chromium.org" Date: Wed, 4 Apr 2012 21:52:50 +0000 Subject: Fixed documentation. experimental.socket is nodoc, but it was once generated and committed by accident, and then got orphaned. page_cycler.zip was corrupt. Regenerated. BUG=none TEST=none TBR=clintstaley@chromium.org,mihaip@chromium.org Review URL: https://chromiumcodereview.appspot.com/9960028 git-svn-id: svn://svn.chromium.org/chrome/trunk/src@130743 0039d316-1c4b-4281-b951-d872f2087c98 --- .../docs/examples/api/record/page_cycler.zip | Bin 0 -> 9174 bytes .../extensions/docs/experimental.socket.html | 2529 -------------------- chrome/common/extensions/docs/privacy.html | 2 +- 3 files changed, 1 insertion(+), 2530 deletions(-) delete mode 100644 chrome/common/extensions/docs/experimental.socket.html (limited to 'chrome/common/extensions/docs') diff --git a/chrome/common/extensions/docs/examples/api/record/page_cycler.zip b/chrome/common/extensions/docs/examples/api/record/page_cycler.zip index e69de29..42578d3 100644 Binary files a/chrome/common/extensions/docs/examples/api/record/page_cycler.zip and b/chrome/common/extensions/docs/examples/api/record/page_cycler.zip differ diff --git a/chrome/common/extensions/docs/experimental.socket.html b/chrome/common/extensions/docs/experimental.socket.html deleted file mode 100644 index c5db342..0000000 --- a/chrome/common/extensions/docs/experimental.socket.html +++ /dev/null @@ -1,2529 +0,0 @@ - - - - - - - - - chrome.experimental.socket - Google Chrome Extensions - Google Code -
-
- You are viewing extension docs in chrome via the 'file:' scheme: are you expecting to see local changes when you refresh? You'll need run chrome with --allow-file-access-from-files. -
- - -
- - -
-
- paramName - - - -
- ( - optional - enumerated - - - Type - - - - array of - - paramType - - - - ) -
- - -
-
- Undocumented. -
-
- Description of this parameter from the json schema. -
-
- This parameter was added in version - . - You must omit this parameter in earlier versions, - and you may omit it in any version. If you require this - parameter, the manifest key - minimum_chrome_version - can ensure that your extension won't be run in an earlier browser version. -
- - -
-
-
-
-
-
-
-
- - -
-
-
- - -
-
-
- - -
-
-
- -
- -
-
Parameters
-
-
-
-
-
-
-
- - -
    -
  1. - Properties -
      -
    1. - propertyName -
      2. -
    -
    2. -
  2. - Methods -
      -
    1. - methodName -
      2. -
    -
    3. -
  3. - Events -
      -
    1. - eventName -
      2. -
    -
    4. -
  4. - Types -
      -
    1. - id -
        -
        -
        -
      -
      2. -
    -
    5. -
-
- - - - - - - - - - - -
- - -
-

Google Chrome Extensions (Labs)

- -
- -
- - - - -
-
-

chrome.experimental.socket

-
- -
-

Contents

-
    -
  1. - h2Name -
      -
    1. - h3Name -
      2. -
    -
    2. -
  2. - API reference: chrome.experimental.socket -
      -
    1. - Properties -
        -
      1. - propertyName -
        2. -
      -
      2. -
    2. - Methods -
        -
      1. - close -
      2. - connect -
      3. - create -
      4. - destroy -
      5. - write -
        6. -
      -
      3. -
    3. - Events -
        -
      1. - eventName -
        2. -
      -
      4. -
    4. - Types -
        -
      1. - SocketEvent -
          -
        1. - Methods -
            -
          1. - methodName -
            2. -
          -
          2. -
        2. - Events -
            -
          1. - eventName -
            2. -
          -
          3. -
        -
        2. -
      -
      5. -
    -
    3. -
-
- - - -

- For information on how to use experimental APIs, see the chrome.experimental.* APIs page. -

- - -
- - -
- -

API reference: chrome.experimental.socket

- - - - - -
- -

Methods

- - -
- -

close

- -
void - - chrome.experimental.socket.close(, integer - socketId)
- -
- -

Closes the socket.

- - -

Parameters

-
-
-
-
- socketId - - - -
- ( - - - - - Type - - - - array of - - integer - - - - ) -
- - -
- -
The socketId.
-
- This parameter was added in version - . - You must omit this parameter in earlier versions, - and you may omit it in any version. If you require this - parameter, the manifest key - minimum_chrome_version - can ensure that your extension won't be run in an earlier browser version. -
- - -
-
-
-
-
-
-
-
- - -
-
-
- - -
-
-
- - -
-
-
- -
-
-
- - -

Returns

-
-
-
-
-
-
- - -
-
-

Callback function

-

- The callback parameter should specify a function - that looks like this: -

-

- If you specify the callback parameter, it should - specify a function that looks like this: -

- - - 
function(Type param1, Type param2) {...};
-
-
-
-
-
-
-
-
- - -

- This function was added in version . - If you require this function, the manifest key - minimum_chrome_version - can ensure that your extension won't be run in an earlier browser version. -

-
- -
- -

connect

- -
void - - chrome.experimental.socket.connect(, integer - socketId, string - hostname, integer - port, function - callback)
- -
- -

Connects the socket to the given address. In the case of a UDP socket, this method merely associates the address with the socket for future sent data.

- - -

Parameters

-
-
-
-
- socketId - - - -
- ( - - - - - Type - - - - array of - - integer - - - - ) -
- - -
- -
The socketId.
-
- This parameter was added in version - . - You must omit this parameter in earlier versions, - and you may omit it in any version. If you require this - parameter, the manifest key - minimum_chrome_version - can ensure that your extension won't be run in an earlier browser version. -
- - -
-
-
-
-
-
-
-
- - -
-
-
- - -
-
-
- - -
-
-
- -
-
-
-
- hostname - - - -
- ( - - - - - Type - - - - array of - - string - - - - ) -
- - -
- -
The remote hostname.
-
- This parameter was added in version - . - You must omit this parameter in earlier versions, - and you may omit it in any version. If you require this - parameter, the manifest key - minimum_chrome_version - can ensure that your extension won't be run in an earlier browser version. -
- - -
-
-
-
-
-
-
-
- - -
-
-
- - -
-
-
- - -
-
-
- -
-
-
-
- port - - - -
- ( - - - - - Type - - - - array of - - integer - - - - ) -
- - -
- -
The remote port.
-
- This parameter was added in version - . - You must omit this parameter in earlier versions, - and you may omit it in any version. If you require this - parameter, the manifest key - minimum_chrome_version - can ensure that your extension won't be run in an earlier browser version. -
- - -
-
-
-
-
-
-
-
- - -
-
-
- - -
-
-
- - -
-
-
- -
-
-
-
- callback - - - -
- ( - - - - - Type - - - - array of - - function - - - - ) -
- - -
- -
Called when the connection is complete.
-
- This parameter was added in version - . - You must omit this parameter in earlier versions, - and you may omit it in any version. If you require this - parameter, the manifest key - minimum_chrome_version - can ensure that your extension won't be run in an earlier browser version. -
- - -
-
-
-
-
-
-
-
- - -
-
-
- - -
-
-
- - -
-
-
- -
-
-
- - -

Returns

-
-
-
-
-
-
- - -
-
-

Callback function

-

- The callback parameter should specify a function - that looks like this: -

-

- If you specify the callback parameter, it should - specify a function that looks like this: -

- - - 
function(boolean result) {...};
-
-
-
-
- result - - - -
- ( - - - - - Type - - - - array of - - boolean - - - - ) -
- - -
- -
True if successful, false otherwise.
-
- This parameter was added in version - . - You must omit this parameter in earlier versions, - and you may omit it in any version. If you require this - parameter, the manifest key - minimum_chrome_version - can ensure that your extension won't be run in an earlier browser version. -
- - -
-
-
-
-
-
-
-
- - -
-
-
- - -
-
-
- - -
-
-
- -
-
-
-
-
- - -

- This function was added in version . - If you require this function, the manifest key - minimum_chrome_version - can ensure that your extension won't be run in an earlier browser version. -

-
- -
- -

create

- -
void - - chrome.experimental.socket.create(, string - type, object - options, function - callback)
- -
- -

Creates a socket of the specified type.

- - -

Parameters

-
-
-
-
- type - - - -
- ( - - enumerated - - - Type - - - - array of - - string - ["udp"] - - - ) -
- - -
- -
The type of socket to create. Must be udp.
-
- This parameter was added in version - . - You must omit this parameter in earlier versions, - and you may omit it in any version. If you require this - parameter, the manifest key - minimum_chrome_version - can ensure that your extension won't be run in an earlier browser version. -
- - -
-
-
-
-
-
-
-
- - -
-
-
- - -
-
-
- - -
-
-
- -
-
-
-
- options - - - -
- ( - optional - - - - Type - - - - array of - - object - - - - ) -
- - -
- -
The socket options.
-
- This parameter was added in version - . - You must omit this parameter in earlier versions, - and you may omit it in any version. If you require this - parameter, the manifest key - minimum_chrome_version - can ensure that your extension won't be run in an earlier browser version. -
- - -
-
-
-
-
- onEvent - - - -
- ( - optional - - - - Type - - - - array of - - function - - - - ) -
- - -
- -
This function is called with events that occur during the lifetime of the socket.
-
- This parameter was added in version - . - You must omit this parameter in earlier versions, - and you may omit it in any version. If you require this - parameter, the manifest key - minimum_chrome_version - can ensure that your extension won't be run in an earlier browser version. -
- - -
-
-
-
-
-
-
-
- - -
-
-
- - -
-
-
- - -
-
-
Parameters
-
-
-
-
- event - - - -
- ( - - - - - SocketEvent - - - - array of - - paramType - - - - ) -
- - -
- -
The socket event.
-
- This parameter was added in version - . - You must omit this parameter in earlier versions, - and you may omit it in any version. If you require this - parameter, the manifest key - minimum_chrome_version - can ensure that your extension won't be run in an earlier browser version. -
- - -
-
-
-
-
-
-
-
- - -
-
-
- - -
-
-
- - -
-
-
- -
-
-
-
-
- -
-
-
-
- - -
-
-
- - -
-
-
- - -
-
-
- -
-
-
-
- callback - - - -
- ( - - - - - Type - - - - array of - - function - - - - ) -
- - -
- -
Called when the socket has been created.
-
- This parameter was added in version - . - You must omit this parameter in earlier versions, - and you may omit it in any version. If you require this - parameter, the manifest key - minimum_chrome_version - can ensure that your extension won't be run in an earlier browser version. -
- - -
-
-
-
-
-
-
-
- - -
-
-
- - -
-
-
- - -
-
-
- -
-
-
- - -

Returns

-
-
-
-
-
-
- - -
-
-

Callback function

-

- The callback parameter should specify a function - that looks like this: -

-

- If you specify the callback parameter, it should - specify a function that looks like this: -

- - - 
function(object socketInfo) {...};
-
-
-
-
- socketInfo - - - -
- ( - - - - - Type - - - - array of - - object - - - - ) -
- - -
-
- Undocumented. -
-
- Description of this parameter from the json schema. -
-
- This parameter was added in version - . - You must omit this parameter in earlier versions, - and you may omit it in any version. If you require this - parameter, the manifest key - minimum_chrome_version - can ensure that your extension won't be run in an earlier browser version. -
- - -
-
-
-
-
- socketId - - - -
- ( - - - - - Type - - - - array of - - integer - - - - ) -
- - -
- -
The id of the newly created socket.
-
- This parameter was added in version - . - You must omit this parameter in earlier versions, - and you may omit it in any version. If you require this - parameter, the manifest key - minimum_chrome_version - can ensure that your extension won't be run in an earlier browser version. -
- - -
-
-
-
-
-
-
-
- - -
-
-
- - -
-
-
- - -
-
-
- -
-
-
-
- - -
-
-
- - -
-
-
- - -
-
-
- -
-
-
-
-
- - -

- This function was added in version . - If you require this function, the manifest key - minimum_chrome_version - can ensure that your extension won't be run in an earlier browser version. -

-
- -
- -

destroy

- -
void - - chrome.experimental.socket.destroy(, integer - socketId)
- -
- -

Destroys the socket. Each socket created should be destroyed after use.

- - -

Parameters

-
-
-
-
- socketId - - - -
- ( - - - - - Type - - - - array of - - integer - - - - ) -
- - -
- -
The socketId.
-
- This parameter was added in version - . - You must omit this parameter in earlier versions, - and you may omit it in any version. If you require this - parameter, the manifest key - minimum_chrome_version - can ensure that your extension won't be run in an earlier browser version. -
- - -
-
-
-
-
-
-
-
- - -
-
-
- - -
-
-
- - -
-
-
- -
-
-
- - -

Returns

-
-
-
-
-
-
- - -
-
-

Callback function

-

- The callback parameter should specify a function - that looks like this: -

-

- If you specify the callback parameter, it should - specify a function that looks like this: -

- - - 
function(Type param1, Type param2) {...};
-
-
-
-
-
-
-
-
- - -

- This function was added in version . - If you require this function, the manifest key - minimum_chrome_version - can ensure that your extension won't be run in an earlier browser version. -

-
- -
- -

write

- -
void - - chrome.experimental.socket.write(, integer - socketId, string - data, function - callback)
- -
- -

Writes data on the connected socket.

- - -

Parameters

-
-
-
-
- socketId - - - -
- ( - - - - - Type - - - - array of - - integer - - - - ) -
- - -
- -
The socketId.
-
- This parameter was added in version - . - You must omit this parameter in earlier versions, - and you may omit it in any version. If you require this - parameter, the manifest key - minimum_chrome_version - can ensure that your extension won't be run in an earlier browser version. -
- - -
-
-
-
-
-
-
-
- - -
-
-
- - -
-
-
- - -
-
-
- -
-
-
-
- data - - - -
- ( - - - - - Type - - - - array of - - string - - - - ) -
- - -
- -
The data to write. Warning: will probably become a blob or other appropriate binary-friendly type.
-
- This parameter was added in version - . - You must omit this parameter in earlier versions, - and you may omit it in any version. If you require this - parameter, the manifest key - minimum_chrome_version - can ensure that your extension won't be run in an earlier browser version. -
- - -
-
-
-
-
-
-
-
- - -
-
-
- - -
-
-
- - -
-
-
- -
-
-
-
- callback - - - -
- ( - - - - - Type - - - - array of - - function - - - - ) -
- - -
- -
Called when any of the following happens: the write operation completes, the write operation blocked before completion, or an error occurred.
-
- This parameter was added in version - . - You must omit this parameter in earlier versions, - and you may omit it in any version. If you require this - parameter, the manifest key - minimum_chrome_version - can ensure that your extension won't be run in an earlier browser version. -
- - -
-
-
-
-
-
-
-
- - -
-
-
- - -
-
-
- - -
-
-
- -
-
-
- - -

Returns

-
-
-
-
-
-
- - -
-
-

Callback function

-

- The callback parameter should specify a function - that looks like this: -

-

- If you specify the callback parameter, it should - specify a function that looks like this: -

- - - 
function(object writeInfo) {...};
-
-
-
-
- writeInfo - - - -
- ( - - - - - Type - - - - array of - - object - - - - ) -
- - -
-
- Undocumented. -
-
- Description of this parameter from the json schema. -
-
- This parameter was added in version - . - You must omit this parameter in earlier versions, - and you may omit it in any version. If you require this - parameter, the manifest key - minimum_chrome_version - can ensure that your extension won't be run in an earlier browser version. -
- - -
-
-
-
-
- bytesWritten - - - -
- ( - - - - - Type - - - - array of - - integer - - - - ) -
- - -
- -
The number of bytes sent, or a negative error code.
-
- This parameter was added in version - . - You must omit this parameter in earlier versions, - and you may omit it in any version. If you require this - parameter, the manifest key - minimum_chrome_version - can ensure that your extension won't be run in an earlier browser version. -
- - -
-
-
-
-
-
-
-
- - -
-
-
- - -
-
-
- - -
-
-
- -
-
-
-
- - -
-
-
- - -
-
-
- - -
-
-
- -
-
-
-
-
- - -

- This function was added in version . - If you require this function, the manifest key - minimum_chrome_version - can ensure that your extension won't be run in an earlier browser version. -

-
- -
- -
- - - - - -
- -

Types

- - -
- -

SocketEvent

- -
-
- paramName - - - -
- ( - - - - - Type - - - - array of - - object - - - - ) -
- - -
- -
A socket event.
-
- This parameter was added in version - . - You must omit this parameter in earlier versions, - and you may omit it in any version. If you require this - parameter, the manifest key - minimum_chrome_version - can ensure that your extension won't be run in an earlier browser version. -
- - -
-
-
-
-
- type - - - -
- ( - - enumerated - - - Type - - - - array of - - string - ["data", "error"] - - - ) -
- - -
- -
A 'data' event represents data received on the socket. An 'error' event represents an error.
-
- This parameter was added in version - . - You must omit this parameter in earlier versions, - and you may omit it in any version. If you require this - parameter, the manifest key - minimum_chrome_version - can ensure that your extension won't be run in an earlier browser version. -
- - -
-
-
-
-
-
-
-
- - -
-
-
- - -
-
-
- - -
-
-
- -
-
-
-
- byteCount - - - -
- ( - optional - - - - Type - - - - array of - - integer - - - - ) -
- - -
- -
The number of bytes received in a 'data' event.
-
- This parameter was added in version - . - You must omit this parameter in earlier versions, - and you may omit it in any version. If you require this - parameter, the manifest key - minimum_chrome_version - can ensure that your extension won't be run in an earlier browser version. -
- - -
-
-
-
-
-
-
-
- - -
-
-
- - -
-
-
- - -
-
-
- -
-
-
-
- bytes - - - -
- ( - optional - - - - Type - - - - array of - - blob - - - - ) -
- - -
- -
The data received.
-
- This parameter was added in version - . - You must omit this parameter in earlier versions, - and you may omit it in any version. If you require this - parameter, the manifest key - minimum_chrome_version - can ensure that your extension won't be run in an earlier browser version. -
- - -
-
-
-
-
-
-
-
- - -
-
-
- - -
-
-
- - -
-
-
- -
-
-
-
- errorCode - - - -
- ( - optional - - - - Type - - - - array of - - integer - - - - ) -
- - -
- -
The error code, if the event type is 'error'.
-
- This parameter was added in version - . - You must omit this parameter in earlier versions, - and you may omit it in any version. If you require this - parameter, the manifest key - minimum_chrome_version - can ensure that your extension won't be run in an earlier browser version. -
- - -
-
-
-
-
-
-
-
- - -
-
-
- - -
-
-
- - -
-
-
- -
-
-
-
- errorMessage - - - -
- ( - optional - - - - Type - - - - array of - - string - - - - ) -
- - -
- -
The error description, if the event type is 'error'.
-
- This parameter was added in version - . - You must omit this parameter in earlier versions, - and you may omit it in any version. If you require this - parameter, the manifest key - minimum_chrome_version - can ensure that your extension won't be run in an earlier browser version. -
- - -
-
-
-
-
-
-
-
- - -
-
-
- - -
-
-
- - -
-
-
- -
-
-
-
- - -
-
-
- - -
-
-
- - -
-
-
- -
- -
- -
- -
-
-
-
- -
- diff --git a/chrome/common/extensions/docs/privacy.html b/chrome/common/extensions/docs/privacy.html index f553122..9722ee4 100644 --- a/chrome/common/extensions/docs/privacy.html +++ b/chrome/common/extensions/docs/privacy.html @@ -359,7 +359,7 @@

Reading the current value of a Chrome setting is straightforward. You'll first need to find the property you're interested in, then you'll call - get() on that object in order to retrieve its current value and + get() on that object in order to retrieve it's current value and your extension's level of control. For example, to determine if Chrome's Autofill feature is enabled, you'd write:

-- cgit v1.1