提交 21868bd6 编写于 作者: E ester.zhou

Update doc (15830)

Signed-off-by: Nester.zhou <ester.zhou@huawei.com>
上级 93b7c65a
......@@ -16,7 +16,7 @@ import device from '@system.device';
## device.getInfo
getInfo(Object): void
getInfo(options?: GetDeviceOptions): void
Obtains the device information.
......@@ -30,11 +30,25 @@ Obtains the device information.
| Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- |
| success | Function | No| Called when API call is successful.|
| fail | Function | No| Called when API call has failed.|
| complete | Function | No| Called when API call is complete.|
| options | [GetDeviceOptions](#getdeviceoptions) | No| Parameters for obtaining the device information.|
**Return value of success()**
## GetDeviceOptions
Defines the parameters for obtaining the device information.
**System capability**: SystemCapability.Startup.SystemInfo
| Name| Type| Mandatory| Description|
| -------- | -------- | -------- | -------- |
| success | (data: DeviceResponse)=> void| No| Called when API call is successful. **data** indicates the returned device information. For details, see [DeviceResponse](#deviceresponse).|
| fail | (data: any,code:number)=> void| No| Called when API call has failed. **code** indicates the error code returned upon a failure.<br>**code:200**: Certain information could not be obtained.|
| complete | () => void| No| Called when API call is complete.|
## DeviceResponse
Provides the device information.
**System capability**: SystemCapability.Startup.SystemInfo
| Name| Type| Description|
| -------- | -------- | -------- |
......@@ -49,14 +63,9 @@ Obtains the device information.
| screenDensity<sup>4+</sup> | number | Screen density.|
| screenShape<sup>4+</sup> | string | Screen shape. The options are as follows:<br>- **rect**: rectangular screen<br>- **circle**: round screen|
| apiVersion<sup>4+</sup> | number | API version.|
| releaseType<sup>4+</sup> | string | Release type. The value includes both the release type and the API version, for example, Beta1.<br>Available release types are as follows:<br>- **Canary**: For the same API version, different canary releases are compatible with each other, but not compatible with those of the **beta** and **release** type.<br>- **Beta**: For the same API version, different beta releases are compatible with each other, but not compatible with those of the **release** type.<br>- **Release**: Releases of this type are compatible with the latest five API versions.|
| releaseType<sup>4+</sup> | string | Release type. The value includes both the release type and the API version, for example, Beta1.<br>Available release types are as follows:<br>- **Canary**: Releases of this type are compatible with each other under the same API version, but not with those of the **beta** and **release** type.<br>- **Beta**: Releases of this type are compatible with each other under the same API version, but not with those of the **release** type.<br>- **Release**: Releases of this type are compatible with the latest five API versions.|
| deviceType<sup>4+</sup> | string | Device type.|
**Return value of fail()**
| Error Code| Description|
| -------- | -------- |
| 200 | Certain information cannot be obtained.|
**Example**
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册