From 94ff5fd497d38445fe3b43d32c82e7156b31a12b Mon Sep 17 00:00:00 2001 From: yudechen Date: Mon, 28 Nov 2022 17:39:30 +0800 Subject: [PATCH] docs: add documentation for @ohos.systemCapability.d.ts. Signed-off-by: yudechen Change-Id: I4547e04f3319a0a28848e71f4ba3a4e94d51e5a3 --- .../reference/apis/Readme-CN.md | 1 + .../apis/js-apis-system-capability.md | 82 +++++++++++++++++++ 2 files changed, 83 insertions(+) create mode 100755 zh-cn/application-dev/reference/apis/js-apis-system-capability.md diff --git a/zh-cn/application-dev/reference/apis/Readme-CN.md b/zh-cn/application-dev/reference/apis/Readme-CN.md index f2249cb441..e2802a1c15 100755 --- a/zh-cn/application-dev/reference/apis/Readme-CN.md +++ b/zh-cn/application-dev/reference/apis/Readme-CN.md @@ -234,6 +234,7 @@ - [@ohos.runningLock (Runninglock锁)](js-apis-runninglock.md) - [@ohos.sensor (传感器)](js-apis-sensor.md) - [@ohos.settings (设置数据项名称)](js-apis-settings.md) + - [@ohos.systemCapability (系统能力)](js-apis-system-capability.md) - [@ohos.systemParameter (系统属性)](js-apis-system-parameter.md) - [@ohos.thermal (热管理)](js-apis-thermal.md) - [@ohos.update (升级)](js-apis-update.md) diff --git a/zh-cn/application-dev/reference/apis/js-apis-system-capability.md b/zh-cn/application-dev/reference/apis/js-apis-system-capability.md new file mode 100755 index 0000000000..831e9d899d --- /dev/null +++ b/zh-cn/application-dev/reference/apis/js-apis-system-capability.md @@ -0,0 +1,82 @@ +# 系统能力 + +系统能力(SystemCapability)是部件向开发者提供的接口的集合,各个部件通过定义系统能力来描述该部件所能提供的能力。其基本操作原语为querySystemCapabilities,可以查询系统能力的集合。 +详细的系统能力原理及配置可参考 +[系统能力](../../../device-dev/subsystems/subsys-build-syscap.md)。 + +> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** +> - 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。 +> - 本模块接口为系统接口。 + + +## 导入模块 + +```ts +import systemcapability from '@ohos.systemCapability' +``` + +## systemcapability.querySystemCapabilities + +querySystemCapabilities(callback: AsyncCallback): void; + +获取系统能力集合的字符串,并调用回调函数。 + +**系统能力:** SystemCapability.Developtools.Syscap + +**参数:** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| callback | AsyncCallback | 是 | 回调函数 | + + +**示例:** + +```ts +try { + systemcapability.querySystemCapabilities(function (err, data) { + if (err == undefined) { + console.log("get system capabilities:" + data) + } else { + console.log(" get system capabilities err:" + err.code) + }}); +}catch(e){ + console.log("get unexpected error: " + e); +} +``` + + +## systemcapability.querySystemCapabilities + +querySystemCapabilities(): Promise<string> + +获取系统能力的集合。 + +**系统能力:** SystemCapability.Startup.SystemInfo + +**返回值:** + +| 类型 | 说明 | +| -------- | -------- | +| Promise<string> | Promise示例,用于异步获取结果。 | + +**示例:** + +```ts +try { + var p = systemcapability.querySystemCapabilities(); + p.then(function (value) { + console.log("get system capabilities: " + value); + }).catch(function (err) { + console.log("get system capabilities error: " + err.code); + }); +}catch(e){ + console.log("get unexpected error: " + e); +} +``` + + +> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** +> 以上接口所返回的system capability集合形式均为编码后的数字字符串形式。 + + -- GitLab