mirrors/electron
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

update docs

Browse source
This commit is contained in:
deepak1556 2016-10-12 23:35:35 +05:30 committed by Kevin Sawicki
parent ad5f944185
commit dbe57c4ad4
6 changed files with 28 additions and 72 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

30
docs/api/browser-window.md
View file

@ -966,32 +966,10 @@ Same as `webContents.capturePage([rect, ]callback)`.
* `url` String
* `options` Object (optional)
* `httpReferrer` String (optional) - A HTTP Referrer url.
* `userAgent` String (optional) - A user agent originating the request.
* `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.
* `httpReferrer` String - A HTTP Referrer url.
* `userAgent` String - A user agent originating the request.
* `extraHeaders` String - Extra headers separated by "\n"
* `postData` ([UploadData](structures/upload-data.md) | [UploadFile](structures/upload-file.md) | [UploadFileSystem](structures/upload-file-system.md) | [UploadBlob](structures/upload-blob.md))[]
Same as `webContents.loadURL(url[, options])`.

4
docs/api/structures/upload-blob.md Normal file
View file

@ -0,0 +1,4 @@
# Upload blob Object
* `type` String - `blob`.
* `blobUUID` String - UUID of blob data to upload.

9
docs/api/structures/upload-file-system.md Normal file
View file

@ -0,0 +1,9 @@
# Upload fileSystem Object
* `type` String - `fileSystem`.
* `filsSystemURL` String - FileSystem url to read data for upload.
* `offset` Integer - Defaults to `0`.
* `length` Integer - Number of bytes to read from `offset`.
Defaults to `0`.
* `modificationTime` Double - Last Modification time in
number of seconds sine the UNIX epoch.

9
docs/api/structures/upload-file.md Normal file
View file

@ -0,0 +1,9 @@
# Upload file Object
* `type` String - `file`.
* `filePath` String - Path of file to be uploaded.
* `offset` Integer - Defaults to `0`.
* `length` Integer - Number of bytes to read from `offset`.
Defaults to `0`.
* `modificationTime` Double - Last Modification time in
number of seconds sine the UNIX epoch.

24
docs/api/web-contents.md
View file

@ -490,29 +490,7 @@ win.loadURL('http://github.com')
* `httpReferrer` String - A HTTP Referrer url.
* `userAgent` String - A user agent originating the request.
* `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.
* `postData` ([UploadData](structures/upload-data.md) | [UploadFile](structures/upload-file.md) | [UploadFileSystem](structures/upload-file-system.md) | [UploadBlob](structures/upload-blob.md))[]
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

24
docs/api/web-view-tag.md
View file

@ -265,29 +265,7 @@ webview.addEventListener('dom-ready', () => {
* `httpReferrer` String - A HTTP Referrer url.
* `userAgent` String - A user agent originating the request.
* `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.
* `postData` ([UploadData](structures/upload-data.md) | [UploadFile](structures/upload-file.md) | [UploadFileSystem](structures/upload-file-system.md) | [UploadBlob](structures/upload-blob.md))[]
Loads the `url` in the webview, the `url` must contain the protocol prefix,
e.g. the `http://` or `file://`.