Merge pull request #9137 from runinspring/patch-3

add some document

docs-translations/zh-CN/api/structures/bluetooth-device.md

@@ -0,0 +1,4 @@
+# 蓝牙设备 Object
+
+* `deviceName` String
+* `deviceId` String

docs-translations/zh-CN/api/structures/certificate-principal.md

@@ -0,0 +1,8 @@
+# CertificatePrincipal Object
+
+* `commonName` String - 通用名
+* `organizations` String[] - 组织名
+* `organizationUnits` String[] - 组织单位名称
+* `locality` String - 地区
+* `state` String - 州或省
+* `country` String - 国家或地区

docs-translations/zh-CN/api/structures/certificate.md

@@ -0,0 +1,12 @@
+# Certificate Object 证书对象
+
+* `data` String - PEM encoded data
+* `issuer` [CertificatePrincipal](certificate-principal.md) - Issuer principal
+* `issuerName` String - Issuer's Common Name
+* `issuerCert` Certificate - Issuer certificate (if not self-signed)
+* `subject` [CertificatePrincipal](certificate-principal.md) - Subject principal
+* `subjectName` String - Subject's Common Name
+* `serialNumber` String - Hex value represented string
+* `validStart` Number - Start date of the certificate being valid in seconds
+* `validExpiry` Number - End date of the certificate being valid in seconds
+* `fingerprint` String - Fingerprint of the certificate

docs-translations/zh-CN/api/structures/cookie.md

@@ -0,0 +1,12 @@
+# Cookie Object
+
+* `name` String - cookie 的名称.
+* `value` String - cookie 的值.
+* `domain` String (optional) - cookie 的域名.
+* `hostOnly` Boolean (optional) - cookie 的类型是否为 host-only.
+* `path` String (optional) - cookie 的路径.
+* `secure` Boolean (optional) - cookie 是否标记为安全.
+* `httpOnly` Boolean (optional) - cookie 是否只标记为 HTTP.
+* `session` Boolean (optional) - cookie 是否是一个 session cookie, 还是一个带有过期时间的持续 cookie.
+* `expirationDate` Double (optional) -  cookie 距离 UNIX 时间戳的过期时间，数值为秒。不需要提供给 session
+  cookies.

docs-translations/zh-CN/api/structures/crash-report.md

@@ -0,0 +1,4 @@
+# 崩溃报告的对象
+
+* `date` String
+* `ID` Integer

docs-translations/zh-CN/api/structures/desktop-capturer-source.md

@@ -0,0 +1,7 @@
+# DesktopCapturerSource Object
+
+* `id` String - 窗口或者屏幕的标识符，当调用 [`navigator.webkitGetUserMedia`] 时可以被当成 `chromeMediaSourceId` 使用。
+标识符的格式为`window:XX` 或 `screen:XX`，`XX` 是一个随机生成的数字.
+* `name` String - 窗口的来源将被命名为 `Entire Screen` 或 `Screen <index>`，而窗口来源的名字将会和窗口的标题匹配.
+* `thumbnail` [NativeImage](../native-image.md) - 缩略图. **注:** 通过 `desktopCapturer.getSources` 方法，
+不能保证缩略图的大小与 `options` 中指定的 `thumbnailSize` 相同。实际大小取决于窗口或者屏幕的比例。

docs-translations/zh-CN/api/structures/display.md

@@ -0,0 +1,15 @@
+# Display Object
+
+* `id` Number - Unique identifier associated with the display.
+* `rotation` Number - Can be 0, 90, 180, 270, represents screen rotation in
+  clock-wise degrees.
+* `scaleFactor` Number - Output device's pixel scale factor.
+* `touchSupport` String - Can be `available`, `unavailable`, `unknown`.
+* `bounds` [Rectangle](rectangle.md)
+* `size` [Size](size.md)
+* `workArea` [Rectangle](rectangle.md)
+* `workAreaSize` [Size](size.md)
+
+The `Display` object represents a physical display connected to the system. A
+fake `Display` may exist on a headless system, or a `Display` may correspond to
+a remote, virtual display.

docs-translations/zh-CN/api/structures/file-filter.md

@@ -0,0 +1,4 @@
+# FileFilter Object
+
+* `name` String
+* `extensions` String[]

docs-translations/zh-CN/api/structures/jump-list-category.md

@@ -0,0 +1,21 @@
+# JumpListCategory Object
+
+* `type` String (optional) - One of the following:
+  * `tasks` - Items in this category will be placed into the standard `Tasks`
+    category. There can be only one such category, and it will always be
+    displayed at the bottom of the Jump List.
+  * `frequent` - Displays a list of files frequently opened by the app, the
+    name of the category and its items are set by Windows.
+  * `recent` - Displays a list of files recently opened by the app, the name
+    of the category and its items are set by Windows. Items may be added to
+    this category indirectly using `app.addRecentDocument(path)`.
+  * `custom` - Displays tasks or file links, `name` must be set by the app.
+* `name` String (optional) - Must be set if `type` is `custom`, otherwise it should be
+  omitted.
+* `items` JumpListItem[] (optional) - Array of [`JumpListItem`](jump-list-item.md) objects if `type` is `tasks` or
+  `custom`, otherwise it should be omitted.
+
+**Note:** If a `JumpListCategory` object has neither the `type` nor the `name`
+property set then its `type` is assumed to be `tasks`. If the `name` property
+is set but the `type` property is omitted then the `type` is assumed to be
+`custom`.

docs-translations/zh-CN/api/structures/jump-list-item.md

@@ -0,0 +1,28 @@
+# JumpListItem Object
+
+* `type` String (optional) - One of the following:
+  * `task` - A task will launch an app with specific arguments.
+  * `separator` - Can be used to separate items in the standard `Tasks`
+    category.
+  * `file` - A file link will open a file using the app that created the
+    Jump List, for this to work the app must be registered as a handler for
+    the file type (though it doesn't have to be the default handler).
+* `path` String (optional) - Path of the file to open, should only be set if `type` is
+  `file`.
+* `program` String (optional) - Path of the program to execute, usually you should
+  specify `process.execPath` which opens the current program. Should only be
+  set if `type` is `task`.
+* `args` String (optional) - The command line arguments when `program` is executed. Should
+  only be set if `type` is `task`.
+* `title` String (optional) - The text to be displayed for the item in the Jump List.
+  Should only be set if `type` is `task`.
+* `description` String (optional) - Description of the task (displayed in a tooltip).
+  Should only be set if `type` is `task`.
+* `iconPath` String (optional) - The absolute path to an icon to be displayed in a
+  Jump List, which can be an arbitrary resource file that contains an icon
+  (e.g. `.ico`, `.exe`, `.dll`). You can usually specify `process.execPath` to
+  show the program icon.
+* `iconIndex` Number (optional) - The index of the icon in the resource file. If a
+  resource file contains multiple icons this value can be used to specify the
+  zero-based index of the icon that should be displayed for this task. If a
+  resource file contains only one icon, this property should be set to zero.

docs-translations/zh-CN/api/structures/memory-usage-details.md

@@ -0,0 +1,5 @@
+# MemoryUsageDetails Object
+
+* `count` Number
+* `size` Number
+* `liveSize` Number

docs-translations/zh-CN/api/structures/mime-typed-buffer.md

@@ -0,0 +1,4 @@
+# MimeTypedBuffer Object
+
+* `mimeType` String - The mimeType of the Buffer that you are sending
+* `data` Buffer - The actual Buffer content

docs-translations/zh-CN/api/structures/point.md

@@ -0,0 +1,4 @@
+# Point Object
+
+* `x` Number
+* `y` Number

docs-translations/zh-CN/api/structures/rectangle.md

@@ -0,0 +1,6 @@
+# Rectangle Object
+
+* `x` Number - The x coordinate of the origin of the rectangle
+* `y` Number - The y coordinate of the origin of the rectangle
+* `width` Number
+* `height` Number

docs-translations/zh-CN/api/structures/remove-client-certificate.md

@@ -0,0 +1,5 @@
+# RemoveClientCertificate Object
+
+* `type` String - `clientCertificate`.
+* `origin` String - Origin of the server whose associated client certificate
+  must be removed from the cache.

docs-translations/zh-CN/api/structures/remove-password.md

@@ -0,0 +1,15 @@
+# RemovePassword Object
+
+* `type` String - `password`.
+* `origin` String (optional) - When provided, the authentication info
+  related to the origin will only be removed otherwise the entire cache
+  will be cleared.
+* `scheme` String (optional) - Scheme of the authentication.
+  Can be `basic`, `digest`, `ntlm`, `negotiate`. Must be provided if
+  removing by `origin`.
+* `realm` String (optional) - Realm of the authentication. Must be provided if
+  removing by `origin`.
+* `username` String (optional) - Credentials of the authentication. Must be
+  provided if removing by `origin`.
+* `password` String (optional) - Credentials of the authentication. Must be
+  provided if removing by `origin`.

docs-translations/zh-CN/api/structures/scrubber-item.md

@@ -0,0 +1,4 @@
+# ScrubberItem Object
+
+* `label` String - (Optional) The text to appear in this item
+* `icon` NativeImage - (Optional) The image to appear in this item

docs-translations/zh-CN/api/structures/segmented-control-segment.md

@@ -0,0 +1,5 @@
+# SegmentedControlSegment Object
+
+* `label` String - (Optional) The text to appear in this segment
+* `icon` NativeImage - (Optional) The image to appear in this segment
+* `enabled` Boolean - (Optional) Whether this segment is selectable. Default: true

docs-translations/zh-CN/api/structures/shortcut-details.md

@@ -0,0 +1,15 @@
+# ShortcutDetails Object
+
+* `target` String - The target to launch from this shortcut.
+* `cwd` String (optional) - The working directory. Default is empty.
+* `args` String (optional) - The arguments to be applied to `target` when
+launching from this shortcut. Default is empty.
+* `description` String (optional) - The description of the shortcut. Default
+is empty.
+* `icon` String (optional) - The path to the icon, can be a DLL or EXE. `icon`
+and `iconIndex` have to be set together. Default is empty, which uses the
+target's icon.
+* `iconIndex` Number (optional) - The resource ID of icon when `icon` is a
+DLL or EXE. Default is 0.
+* `appUserModelId` String (optional) - The Application User Model ID. Default
+is empty.

docs-translations/zh-CN/api/structures/size.md

@@ -0,0 +1,4 @@
+# Size Object
+
+* `width` Number
+* `height` Number

docs-translations/zh-CN/api/structures/task.md

@@ -0,0 +1,14 @@
+# Task Object
+
+* `program` String - Path of the program to execute, usually you should
+  specify `process.execPath` which opens the current program.
+* `arguments` String - The command line arguments when `program` is
+  executed.
+* `title` String - The string to be displayed in a JumpList.
+* `description` String - Description of this task.
+* `iconPath` String - The absolute path to an icon to be displayed in a
+  JumpList, which can be an arbitrary resource file that contains an icon. You
+  can usually specify `process.execPath` to show the icon of the program.
+* `iconIndex` Number - The icon index in the icon file. If an icon file
+  consists of two or more icons, set this value to identify the icon. If an
+  icon file consists of one icon, this value is 0.

docs-translations/zh-CN/api/structures/thumbar-button.md

@@ -0,0 +1,21 @@
+# ThumbarButton Object
+
+* `icon` [NativeImage](../native-image.md) - The icon showing in thumbnail
+  toolbar.
+* `click` Function
+* `tooltip` String (optional) - The text of the button's tooltip.
+* `flags` String[] (optional) - Control specific states and behaviors of the
+  button. By default, it is `['enabled']`.
+
+The `flags` is an array that can include following `String`s:
+
+* `enabled` - The button is active and available to the user.
+* `disabled` - The button is disabled. It is present, but has a visual state
+  indicating it will not respond to user action.
+* `dismissonclick` - When the button is clicked, the thumbnail window closes
+  immediately.
+* `nobackground` - Do not draw a button border, use only the image.
+* `hidden` - The button is not shown to the user.
+* `noninteractive` - The button is enabled but not interactive; no pressed
+  button state is drawn. This value is intended for instances where the button
+  is used in a notification.

docs-translations/zh-CN/api/structures/upload-blob.md

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

docs-translations/zh-CN/api/structures/upload-data.md

@@ -0,0 +1,6 @@
+# UploadData Object
+
+* `bytes` Buffer - Content being sent.
+* `file` String - Path of file being uploaded.
+* `blobUUID` String - UUID of blob data. Use [ses.getBlobData](../session.md#sesgetblobdataidentifier-callback) method
+  to retrieve the data.

docs-translations/zh-CN/api/structures/upload-file-system.md

@@ -0,0 +1,9 @@
+# UploadFileSystem 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.

docs-translations/zh-CN/api/structures/upload-file.md

@@ -0,0 +1,9 @@
+# UploadFile 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.

docs-translations/zh-CN/api/structures/upload-raw-data.md

@@ -0,0 +1,4 @@
+# UploadRawData Object
+
+* `type` String - `rawData`.
+* `bytes` Buffer - Data to be uploaded.