add docs
This commit is contained in:
parent
2d7ceae320
commit
2044208fd6
3 changed files with 69 additions and 0 deletions
|
@ -969,6 +969,29 @@ Same as `webContents.capturePage([rect, ]callback)`.
|
||||||
* `httpReferrer` String (optional) - A HTTP Referrer url.
|
* `httpReferrer` String (optional) - A HTTP Referrer url.
|
||||||
* `userAgent` String (optional) - A user agent originating the request.
|
* `userAgent` String (optional) - A user agent originating the request.
|
||||||
* `extraHeaders` String (optional) - Extra headers separated by "\n"
|
* `extraHeaders` String (optional) - Extra headers separated by "\n"
|
||||||
|
* `postData` Array (optional) - An array of `upload` objects which
|
||||||
|
provides the request body for `POST` navigation.
|
||||||
|
|
||||||
|
* `upload` Object
|
||||||
|
* `type` String - `data`, `file`, `filsSystem`, `blob`.
|
||||||
|
|
||||||
|
If `type` is `data` then `upload` object must contain:
|
||||||
|
* `bytes` Buffer - Raw data to be uploaded.
|
||||||
|
|
||||||
|
If `type` is `file` then `upload` object must contain:
|
||||||
|
* `filePath` String - Path of file to be uploaded.
|
||||||
|
* `offset` Integer
|
||||||
|
* `length` Integer
|
||||||
|
* `modificationTime` Double
|
||||||
|
|
||||||
|
If `type` is `fileSystem` then `upload` object must contain:
|
||||||
|
* `filsSystemURL` String - FileSystem url to read data for upload.
|
||||||
|
* `offset` Integer
|
||||||
|
* `length` Integer
|
||||||
|
* `modificationTime` Double
|
||||||
|
|
||||||
|
If `type` is `blob` then `upload` object must contain:
|
||||||
|
* `blobUUID` String - UUID of blob data to upload.
|
||||||
|
|
||||||
Same as `webContents.loadURL(url[, options])`.
|
Same as `webContents.loadURL(url[, options])`.
|
||||||
|
|
||||||
|
|
|
@ -490,6 +490,29 @@ win.loadURL('http://github.com')
|
||||||
* `httpReferrer` String - A HTTP Referrer url.
|
* `httpReferrer` String - A HTTP Referrer url.
|
||||||
* `userAgent` String - A user agent originating the request.
|
* `userAgent` String - A user agent originating the request.
|
||||||
* `extraHeaders` String - Extra headers separated by "\n"
|
* `extraHeaders` String - Extra headers separated by "\n"
|
||||||
|
* `postData` Array - An array of `upload` objects which
|
||||||
|
provides the request body for `POST` navigation.
|
||||||
|
|
||||||
|
* `upload` Object
|
||||||
|
* `type` String - `data`, `file`, `filsSystem`, `blob`.
|
||||||
|
|
||||||
|
If `type` is `data` then `upload` object must contain:
|
||||||
|
* `bytes` Buffer - Raw data to be uploaded.
|
||||||
|
|
||||||
|
If `type` is `file` then `upload` object must contain:
|
||||||
|
* `filePath` String - Path of file to be uploaded.
|
||||||
|
* `offset` Integer
|
||||||
|
* `length` Integer
|
||||||
|
* `modificationTime` Double
|
||||||
|
|
||||||
|
If `type` is `fileSystem` then `upload` object must contain:
|
||||||
|
* `filsSystemURL` String - FileSystem url to read data for upload.
|
||||||
|
* `offset` Integer
|
||||||
|
* `length` Integer
|
||||||
|
* `modificationTime` Double
|
||||||
|
|
||||||
|
If `type` is `blob` then `upload` object must contain:
|
||||||
|
* `blobUUID` String - UUID of blob data to upload.
|
||||||
|
|
||||||
Loads the `url` in the window. The `url` must contain the protocol prefix,
|
Loads the `url` in the window. The `url` must contain the protocol prefix,
|
||||||
e.g. the `http://` or `file://`. If the load should bypass http cache then
|
e.g. the `http://` or `file://`. If the load should bypass http cache then
|
||||||
|
|
|
@ -265,6 +265,29 @@ webview.addEventListener('dom-ready', () => {
|
||||||
* `httpReferrer` String - A HTTP Referrer url.
|
* `httpReferrer` String - A HTTP Referrer url.
|
||||||
* `userAgent` String - A user agent originating the request.
|
* `userAgent` String - A user agent originating the request.
|
||||||
* `extraHeaders` String - Extra headers separated by "\n"
|
* `extraHeaders` String - Extra headers separated by "\n"
|
||||||
|
* `postData` Array - An array of `upload` objects which
|
||||||
|
provides the request body for `POST` navigation.
|
||||||
|
|
||||||
|
* `upload` Object
|
||||||
|
* `type` String - `data`, `file`, `filsSystem`, `blob`.
|
||||||
|
|
||||||
|
If `type` is `data` then `upload` object must contain:
|
||||||
|
* `bytes` Buffer - Raw data to be uploaded.
|
||||||
|
|
||||||
|
If `type` is `file` then `upload` object must contain:
|
||||||
|
* `filePath` String - Path of file to be uploaded.
|
||||||
|
* `offset` Integer
|
||||||
|
* `length` Integer
|
||||||
|
* `modificationTime` Double
|
||||||
|
|
||||||
|
If `type` is `fileSystem` then `upload` object must contain:
|
||||||
|
* `filsSystemURL` String - FileSystem url to read data for upload.
|
||||||
|
* `offset` Integer
|
||||||
|
* `length` Integer
|
||||||
|
* `modificationTime` Double
|
||||||
|
|
||||||
|
If `type` is `blob` then `upload` object must contain:
|
||||||
|
* `blobUUID` String - UUID of blob data to upload.
|
||||||
|
|
||||||
Loads the `url` in the webview, the `url` must contain the protocol prefix,
|
Loads the `url` in the webview, the `url` must contain the protocol prefix,
|
||||||
e.g. the `http://` or `file://`.
|
e.g. the `http://` or `file://`.
|
||||||
|
|
Loading…
Add table
Reference in a new issue