Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
Tonvia
Docs
提交
3777db35
D
Docs
项目概览
Tonvia
/
Docs
与 Fork 源项目一致
Fork自
OpenHarmony / Docs
通知
1
Star
0
Fork
0
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
D
Docs
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
提交
Issue看板
体验新版 GitCode,发现更多精彩内容 >>
提交
3777db35
编写于
3月 10, 2022
作者:
Y
yuyaozhi
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
Fix format issues of ability api
Signed-off-by:
N
yuyaozhi
<
yuyaozhi@h-partners.com
>
上级
60e1117c
变更
25
展开全部
隐藏空白更改
内联
并排
Showing
25 changed file
with
967 addition
and
894 deletion
+967
-894
zh-cn/application-dev/reference/apis/js-apis-Context.md
zh-cn/application-dev/reference/apis/js-apis-Context.md
+47
-83
zh-cn/application-dev/reference/apis/js-apis-DataUriUtils.md
zh-cn/application-dev/reference/apis/js-apis-DataUriUtils.md
+12
-2
zh-cn/application-dev/reference/apis/js-apis-ability-context.md
...application-dev/reference/apis/js-apis-ability-context.md
+109
-109
zh-cn/application-dev/reference/apis/js-apis-abilityrunninginfo.md
...lication-dev/reference/apis/js-apis-abilityrunninginfo.md
+14
-15
zh-cn/application-dev/reference/apis/js-apis-abilitystagecontext.md
...ication-dev/reference/apis/js-apis-abilitystagecontext.md
+4
-4
zh-cn/application-dev/reference/apis/js-apis-application-MissionInfo.md
...ion-dev/reference/apis/js-apis-application-MissionInfo.md
+9
-9
zh-cn/application-dev/reference/apis/js-apis-application-ability.md
...ication-dev/reference/apis/js-apis-application-ability.md
+128
-82
zh-cn/application-dev/reference/apis/js-apis-application-abilitystage.md
...on-dev/reference/apis/js-apis-application-abilitystage.md
+27
-17
zh-cn/application-dev/reference/apis/js-apis-application-context.md
...ication-dev/reference/apis/js-apis-application-context.md
+29
-22
zh-cn/application-dev/reference/apis/js-apis-appmanager.md
zh-cn/application-dev/reference/apis/js-apis-appmanager.md
+21
-15
zh-cn/application-dev/reference/apis/js-apis-configuration.md
...n/application-dev/reference/apis/js-apis-configuration.md
+6
-6
zh-cn/application-dev/reference/apis/js-apis-configurationconstant.md
...ation-dev/reference/apis/js-apis-configurationconstant.md
+38
-23
zh-cn/application-dev/reference/apis/js-apis-dataAbilityHelper.md
...plication-dev/reference/apis/js-apis-dataAbilityHelper.md
+59
-98
zh-cn/application-dev/reference/apis/js-apis-eventhub.md
zh-cn/application-dev/reference/apis/js-apis-eventhub.md
+19
-22
zh-cn/application-dev/reference/apis/js-apis-extension-context.md
...plication-dev/reference/apis/js-apis-extension-context.md
+1
-1
zh-cn/application-dev/reference/apis/js-apis-featureAbility.md
.../application-dev/reference/apis/js-apis-featureAbility.md
+59
-86
zh-cn/application-dev/reference/apis/js-apis-formbindingdata.md
...application-dev/reference/apis/js-apis-formbindingdata.md
+11
-7
zh-cn/application-dev/reference/apis/js-apis-formextension.md
...n/application-dev/reference/apis/js-apis-formextension.md
+36
-24
zh-cn/application-dev/reference/apis/js-apis-formextensioncontext.md
...cation-dev/reference/apis/js-apis-formextensioncontext.md
+12
-8
zh-cn/application-dev/reference/apis/js-apis-missionManager.md
.../application-dev/reference/apis/js-apis-missionManager.md
+166
-104
zh-cn/application-dev/reference/apis/js-apis-particleAbility.md
...application-dev/reference/apis/js-apis-particleAbility.md
+77
-74
zh-cn/application-dev/reference/apis/js-apis-permissionrequestresult.md
...ion-dev/reference/apis/js-apis-permissionrequestresult.md
+2
-2
zh-cn/application-dev/reference/apis/js-apis-processrunninginfo.md
...lication-dev/reference/apis/js-apis-processrunninginfo.md
+5
-5
zh-cn/application-dev/reference/apis/js-apis-service-extension-context.md
...n-dev/reference/apis/js-apis-service-extension-context.md
+50
-50
zh-cn/application-dev/reference/apis/js-apis-service-extension.md
...plication-dev/reference/apis/js-apis-service-extension.md
+26
-26
未找到文件。
zh-cn/application-dev/reference/apis/js-apis-Context.md
浏览文件 @
3777db35
...
...
@@ -15,9 +15,7 @@ var context = featureAbility.getContext();
context
.
getOrCreateLocalDir
()
```
## Context
### getOrCreateLocalDir
## Context.getOrCreateLocalDir
getOrCreateLocalDir(callback: AsyncCallback
\<
string>): void
...
...
@@ -25,13 +23,10 @@ getOrCreateLocalDir(callback: AsyncCallback\<string>): void
如果是第一次调用,将创建目录。
**系统能力:**
SystemCapability.Ability.AbilityRuntime.Core
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
**参数:**
| 名称 | 类型 | 必填 | 描述 |
| -------- | ---------------------- | ---- | -------------------------- |
| callback | AsyncCallback
\<
string> | 是 | 返回应用程序的本地根目录。 |
...
...
@@ -48,7 +43,7 @@ context.getOrCreateLocalDir((err, data)=>{
##
#
getOrCreateLocalDir
##
Context.
getOrCreateLocalDir
getOrCreateLocalDir(): Promise
\<
string>
...
...
@@ -56,9 +51,7 @@ getOrCreateLocalDir(): Promise\<string>
如果是第一次调用,将创建目录。
**系统能力:**
SystemCapability.Ability.AbilityRuntime.Core
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
**返回值:**
...
...
@@ -78,19 +71,16 @@ context.getOrCreateLocalDir().then((data) => {
##
#
verifyPermission
##
Context.
verifyPermission
verifyPermission(permission: string, options: PermissionOptions, callback: AsyncCallback
\<
number>): void
验证系统中运行的特定pid和uid是否允许指定的权限(callback形式)。
**系统能力:**
SystemCapability.Ability.AbilityRuntime.Core
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
**参数:**
| 名称 | 类型 | 必填 | 描述 |
| ---------- | --------------------------------------- | ---- | ------------------------------------- |
| permission | string | 是 | 指定权限的名称。 |
...
...
@@ -110,14 +100,15 @@ bundle.getBundleInfo('com.context.test', 1, (datainfo) =>{
##
#
verifyPermission
##
Context.
verifyPermission
verifyPermission(permission: string, callback: AsyncCallback
\<
number>): void
验证系统中运行的当前pid和uid是否具有指定的权限(callback形式)。
**
参数:**
**
系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
**参数:**
| 名称 | 类型 | 必填 | 描述 |
| ---------- | ---------------------- | ---- | ------------------------------------- |
...
...
@@ -132,19 +123,16 @@ var context = featureAbility.getContext();
context
.
verifyPermission
(
"
com.example.permission
"
)
```
##
#
verifyPermission
##
Context.
verifyPermission
verifyPermission(permission: string, options?: PermissionOptions): Promise
\<
number>
验证系统中运行的特定pid和uid是否具有指定的权限(Promise形式)。
**系统能力:**
SystemCapability.Ability.AbilityRuntime.Core
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
**参数:**
| 名称 | 类型 | 必填 | 描述 |
| ---------- | --------------------------------------- | ---- | ---------------- |
| permission | string | 是 | 指定权限的名称。 |
...
...
@@ -170,24 +158,22 @@ context.verifyPermission('com.context.permission',Permission).then((data) => {
##
#
requestPermissionsFromUser
##
Context.
requestPermissionsFromUser
requestPermissionsFromUser(permissions: Array
\<
string>, requestCode: number, resultCallback: AsyncCallback
<
[
PermissionRequestResult
](
#permissionrequestresult
)
>
)
requestPermissionsFromUser(permissions: Array
\<
string>, requestCode: number, resultCallback: AsyncCallback
<
[
PermissionRequestResult
](
#permissionrequestresult
)
>
)
: void
从系统请求某些权限(callback形式)。
**系统能力:**
SystemCapability.Ability.AbilityRuntime.Core
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
**参数:**
| 名称 | 类型 | 必填 | 描述 |
| -------------- | ------------------------------------------------------------ | ---- | ----------------------------------------------- |
| permissions | Array
\<
string> | 是 | 指示要请求的权限列表。此参数不能为null。 |
| requestCode | number | 是 | 指示要传递给PermissionRequestResult的请求代码。 |
| resultCallback | AsyncCallback
<
[
PermissionRequestResult
](
#permissionrequestresult
)
>
| 是 | 返回授权结果信息。 |
**示例:**
```
js
...
...
@@ -208,15 +194,13 @@ context.requestPermissionsFromUser(
##
#
getApplicationInfo
##
Context.
getApplicationInfo
getApplicationInfo(callback: AsyncCallback
\<
ApplicationInfo>)
getApplicationInfo(callback: AsyncCallback
\<
ApplicationInfo>)
: void
获取有关当前应用程序的信息(callback形式)。
**系统能力:**
SystemCapability.Ability.AbilityRuntime.Core
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
**参数:**
...
...
@@ -234,15 +218,13 @@ context.getApplicationInfo()
##
#
getApplicationInfo
##
Context.
getApplicationInfo
getApplicationInfo(): Promise
\<
ApplicationInfo>
获取有关当前应用程序的信息(Promise形式)。
**系统能力:**
SystemCapability.Ability.AbilityRuntime.Core
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
**返回值:**
...
...
@@ -263,15 +245,13 @@ context.getApplicationInfo().then((data) => {
##
#
getBundleName
##
Context.
getBundleName
getBundleName(callback: AsyncCallback
\<
string>): void
获取当前ability的捆绑包名称(callback形式)。
**系统能力:**
SystemCapability.Ability.AbilityRuntime.Core
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
**参数:**
...
...
@@ -289,15 +269,13 @@ context.getBundleName()
##
#
getBundleName
##
Context.
getBundleName
getBundleName(): Promise
\<
string>
获取当前ability的捆绑包名称(Promise形式)。
**系统能力:**
SystemCapability.Ability.AbilityRuntime.Core
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
**返回值:**
...
...
@@ -318,15 +296,13 @@ context.getBundleName().then((data) => {
##
#
getProcessInfo
##
Context.
getProcessInfo
getProcessInfo(callback: AsyncCallback
\<
ProcessInfo>)
getProcessInfo(callback: AsyncCallback
\<
ProcessInfo>)
: void
获取有关当前进程的信息,包括进程ID和名称(callback形式)。
**系统能力:**
SystemCapability.Ability.AbilityRuntime.Core
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
**参数:**
...
...
@@ -344,15 +320,13 @@ context.getProcessInfo()
##
#
getProcessInfo
##
Context.
getProcessInfo
getProcessInfo(): Promise
\<
ProcessInfo>
获取有关当前进程的信息,包括进程id和名称(Promise形式)。
**系统能力:**
SystemCapability.Ability.AbilityRuntime.Core
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
**返回值:**
...
...
@@ -373,7 +347,7 @@ context.getProcessInfo().then((data) => {
##
#
getElementName
##
Context.
getElementName
getElementName(callback: AsyncCallback
\<
ElementName>): void
...
...
@@ -381,9 +355,7 @@ getElementName(callback: AsyncCallback\<ElementName>): void
此方法仅适用于页面功能。
**系统能力:**
SystemCapability.Ability.AbilityRuntime.Core
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
**参数:**
...
...
@@ -401,7 +373,7 @@ context.getElementName()
##
#
getElementName
##
Context.
getElementName
getElementName(): Promise
\<
ElementName>
...
...
@@ -409,9 +381,7 @@ getElementName(): Promise\<ElementName>
此方法仅适用于页面功能。
**系统能力:**
SystemCapability.Ability.AbilityRuntime.Core
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
**返回值:**
...
...
@@ -430,15 +400,15 @@ context.getElementName().then((data) => {
});
```
##
#
getProcessName
##
Context.
getProcessName
getProcessName(callback: AsyncCallback
\<
string>): void
获取当前进程的名称(callback形式)。
**系统能力
:**
**系统能力
**
:SystemCapability.Ability.AbilityRuntime.Core
SystemCapability.Ability.AbilityRuntime.Core
**参数:**
| 名称 | 类型 | 必填 | 描述 |
| -------- | ---------------------- | ---- | -------------------- |
...
...
@@ -454,15 +424,13 @@ context.getProcessName()
##
#
getProcessName
##
Context.
getProcessName
getProcessName(): Promise
\<
string>
获取当前进程的名称(Promise形式)。
**系统能力:**
SystemCapability.Ability.AbilityRuntime.Core
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
**返回值:**
...
...
@@ -483,15 +451,13 @@ context.getProcessName().then((data) => {
##
#
getCallingBundle
##
Context.
getCallingBundle
getCallingBundle(callback: AsyncCallback
\<
string>): void
获取调用ability的包名称(callback形式)。
**系统能力:**
SystemCapability.Ability.AbilityRuntime.Core
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
**参数:**
...
...
@@ -509,15 +475,13 @@ context.getCallingBundle()
##
#
getCallingBundle
##
Context.
getCallingBundle
getCallingBundle(): Promise
\<
string>
获取调用ability的包名称(Promise形式)。
**系统能力:**
SystemCapability.Ability.AbilityRuntime.Core
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
**返回值:**
...
...
@@ -540,13 +504,13 @@ context.getCallingBundle().then((data) => {
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ---- | -------- | ------ | ---- | ------ |
| pid | 只读 | number | 否 | 进程id
<br><b>
系统能力:
</b>
SystemCapability.Ability.AbilityRuntime.Core
|
| uid | 只读 | number | 否 | 用户id
<br><b>
系统能力:
</b>
SystemCapability.Ability.AbilityRuntime.Core |
| pid | 只读 | number | 否 | 进程id
。
<br/>
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
|
| uid | 只读 | number | 否 | 用户id
。
<br/>
**系统能力**
:
SystemCapability.Ability.AbilityRuntime.Core |
## PermissionRequestResult
| 名称 | 读写属性 | 类型 | 必填 | 描述 |
| ----------- | -------- | -------------- | ---- | ------------------ |
| requestCode | 只读 | number | 是 | 用户传入的请求代码
<br><b>
系统能力:
</b>
SystemCapability.Ability.AbilityRuntime.Core |
| permissions | 只读 | Array
\<
string> | 是 | 用户传入的权限
<br><b>
系统能力:
</b>
SystemCapability.Ability.AbilityRuntime.Core |
| authResults | 只读 | Array
\<
number> | 是 | 求权限的结果
<br><b>
系统能力:
</b>
SystemCapability.Ability.AbilityRuntime.Core
|
| requestCode | 只读 | number | 是 | 用户传入的请求代码
。
<br/>
**系统能力**
:
SystemCapability.Ability.AbilityRuntime.Core |
| permissions | 只读 | Array
\<
string> | 是 | 用户传入的权限
。
<br/>
**系统能力**
:
SystemCapability.Ability.AbilityRuntime.Core |
| authResults | 只读 | Array
\<
number> | 是 | 求权限的结果
。
<br/>
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
|
zh-cn/application-dev/reference/apis/js-apis-DataUriUtils.md
浏览文件 @
3777db35
...
...
@@ -12,14 +12,16 @@ getId(uri: string): number
获取附加到给定uri的路径组件末尾的ID。
**
参数:**
**
系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
**参数:**
| 名称 | 类型 | 必填 | 描述 |
| ---- | ------ | ---- | --------------------------- |
| uri | string | 是 | 指示要从中获取ID的uri对象。 |
**返回值:**
| 类型 | 说明 |
| ------ | ------------------------ |
| number | 附加到路径组件末尾的ID。 |
...
...
@@ -38,8 +40,9 @@ attachId(uri: string, id: number): string
将给定ID附加到给定uri的路径组件的末尾。
**
参数:**
**
系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
**参数:**
| 名称 | 类型 | 必填 | 描述 |
| ---- | ------ | ---- | --------------------------- |
...
...
@@ -47,6 +50,7 @@ attachId(uri: string, id: number): string
| id | number | 是 | 指示要附加的ID。 |
**返回值:**
| 类型 | 说明 |
| ------ | --------------------- |
| string | 附加给定ID的uri对象。 |
...
...
@@ -69,6 +73,8 @@ deleteId(uri: string): string
从给定uri的路径组件的末尾删除ID。
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
**参数:**
| 名称 | 类型 | 必填 | 描述 |
...
...
@@ -76,6 +82,7 @@ deleteId(uri: string): string
| uri | string | 是 | 指示要从中删除ID的uri对象。 |
**返回值:**
| 类型 | 说明 |
| ------ | ------------------- |
| string | ID已删除的uri对象。 |
...
...
@@ -94,6 +101,8 @@ updateId(uri: string, id: number): string
更新指定uri中的ID。
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
**参数:**
| 名称 | 类型 | 必填 | 描述 |
...
...
@@ -102,6 +111,7 @@ updateId(uri: string, id: number): string
| id | number | 是 | 指示新ID |
**返回值:**
| 类型 | 说明 |
| ------ | --------------- |
| string | 更新的uri对象。 |
...
...
zh-cn/application-dev/reference/apis/js-apis-ability-context.md
浏览文件 @
3777db35
...
...
@@ -33,7 +33,7 @@ Ability的上下文环境,继承自Context。
```
```
js
import
Ability
from
'
@ohos.application.Ability
'
class
MainAbility
extends
Ability
{
onWindowStageCreate
(
windowStage
)
{
...
...
@@ -47,28 +47,28 @@ class MainAbility extends Ability {
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| abilityInfo | AbilityInfo | 是 | 否 | Abilityinfo相关信息 |
| currentHapModuleInfo | HapModuleInfo | 是 | 否 | 当前hap包的信息 |
| abilityInfo | AbilityInfo | 是 | 否 | Abilityinfo相关信息
<br/>
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
|
| currentHapModuleInfo | HapModuleInfo | 是 | 否 | 当前hap包的信息
<br/>
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
|
## startAbility
##
AbilityContext.
startAbility
startAbility(want: Want, callback: AsyncCallback
<
void
>
): void
启动Ability。
**系统能力
:**
**系统能力
**
:SystemCapability.Ability.AbilityRuntime.Core
SystemCapability.Ability.AbilityRuntime.Core
**参数:**
-
参数:
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want |
[
Want
](
js-apis-featureAbility.md#Want类型说明
)
| 是 | 启动Ability的want信息。 |
| callback | AsyncCallback
<
void
>
| 是 | callback形式返回启动结果 |
-
示例:
```
**示例:**
```
js
var
want
=
{
"
deviceId
"
:
""
,
"
bundleName
"
:
"
com.extreme.test
"
,
...
...
@@ -80,26 +80,25 @@ SystemCapability.Ability.AbilityRuntime.Core
```
## startAbility
##
AbilityContext.
startAbility
startAbility(want: Want, options: StartOptions, callback: AsyncCallback
<
void
>
): void
启动Ability。
**系统能力
:**
**系统能力
**
:SystemCapability.Ability.AbilityRuntime.Core
SystemCapability.Ability.AbilityRuntime.Core
**参数:**
-
参数:
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want |
[
Want
](
js-apis-featureAbility.md#Want类型说明
)
| 是 | 启动Ability的want信息。 |
| options | StartOptions | 是 | 启动Ability所携带的参数。 |
| callback | AsyncCallback
<
void
>
| 是 | callback形式返回启动结果。 |
-
示例:
**示例:**
```
```
js
var
want
=
{
"
deviceId
"
:
""
,
"
bundleName
"
:
"
com.extreme.test
"
,
...
...
@@ -114,29 +113,30 @@ SystemCapability.Ability.AbilityRuntime.Core
```
## startAbility
##
AbilityContext.
startAbility
startAbility(want: Want, options: StartOptions): Promise
<
void
>
;
启动Ability。通过Promise返回结果。
**系统能力
:**
**系统能力
**
:SystemCapability.Ability.AbilityRuntime.Core
SystemCapability.Ability.AbilityRuntime.Core
**参数:**
-
参数:
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want |
[
Want
](
js-apis-featureAbility.md#Want类型说明
)
| 是 | 启动Ability的want信息。 |
| options | StartOptions | 是 | 启动Ability所携带的参数。 |
-
返回值:
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
| Promise
<
void
>
| Promise形式返回启动结果。 |
-
示例:
```
**示例:**
```
js
var
want
=
{
"
deviceId
"
:
""
,
"
bundleName
"
:
"
com.extreme.test
"
,
...
...
@@ -154,25 +154,25 @@ SystemCapability.Ability.AbilityRuntime.Core
```
## startAbilityForResult
##
AbilityContext.
startAbilityForResult
startAbilityForResult(want: Want, callback: AsyncCallback
<
AbilityResult
>
): void;
启动Ability并在结束的时候返回执行结果。
**系统能力
:**
**系统能力
**
:SystemCapability.Ability.AbilityRuntime.Core
SystemCapability.Ability.AbilityRuntime.Core
**参数:**
-
参数:
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want |
[
Want
](
js-apis-featureAbility.md#Want类型说明
)
| 是 | 启动Ability的want信息。 |
| callback | AsyncCallback
<
[AbilityResult](js-apis-featureAbility.md#abilityresult)
>
| 是 | 执行结果回调函数。 |
-
示例:
```
**示例:**
```
js
this
.
context
.
startAbilityForResult
(
{
bundleName
:
"
com.extreme.myapplication
"
,
abilityName
:
"
MainAbilityDemo2
"
},
(
error
,
result
)
=>
{
...
...
@@ -182,17 +182,16 @@ SystemCapability.Ability.AbilityRuntime.Core
);
```
## startAbilityForResult
##
AbilityContext.
startAbilityForResult
startAbilityForResult(want: Want, options: StartOptions, callback: AsyncCallback
<
AbilityResult
>
): void;
启动Ability并在结束的时候返回执行结果。
**系统能力
:**
**系统能力
**
:SystemCapability.Ability.AbilityRuntime.Core
SystemCapability.Ability.AbilityRuntime.Core
**参数:**
-
参数:
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want |
[
Want
](
js-apis-featureAbility.md#Want类型说明
)
| 是 | 启动Ability的want信息。 |
...
...
@@ -200,8 +199,9 @@ SystemCapability.Ability.AbilityRuntime.Core
| callback | AsyncCallback
<
[AbilityResult](js-apis-featureAbility.md#abilityresult)
>
| 是 | 执行结果回调函数。 |
-
示例:
```
**示例:**
```
js
var
options
=
{
windowMode
:
0
,
};
...
...
@@ -215,30 +215,31 @@ SystemCapability.Ability.AbilityRuntime.Core
```
## startAbilityForResult
##
AbilityContext.
startAbilityForResult
startAbilityForResult(want: Want, options: StartOptions): Promise
<
AbilityResult
>
;
启动Ability并在结束的时候返回执行结果。
**系统能力
:**
**系统能力
**
:SystemCapability.Ability.AbilityRuntime.Core
SystemCapability.Ability.AbilityRuntime.Core
**参数:**
-
参数:
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want |
[
Want
](
js-apis-featureAbility.md#Want类型说明
)
| 是 | 启动Ability的want信息。 |
| options | StartOptions | 是 | 启动Ability所携带的参数。 |
-
返回值
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
| Promise
<
[AbilityResult](js-apis-featureAbility.md#abilityresult)
>
| Promise形式返回执行结果。 |
-
示例:
```
**示例:**
```
js
var
options
=
{
windowMode
:
0
,
};
...
...
@@ -250,46 +251,46 @@ SystemCapability.Ability.AbilityRuntime.Core
```
## terminateSelf
##
AbilityContext.
terminateSelf
terminateSelf(callback: AsyncCallback
<
void
>
): void;
停止Ability自身。
**系统能力
:**
**系统能力
**
:SystemCapability.Ability.AbilityRuntime.Core
SystemCapability.Ability.AbilityRuntime.Core
**参数:**
-
参数:
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback
<
void
>
| 是 | 回调函数,返回接口调用是否成功的结果。 |
-
示例:
```
**示例:**
```
js
this
.
context
.
terminateSelf
((
err
)
=>
{
console
.
log
(
'
terminateSelf result:
'
+
JSON
.
stringfy
(
err
));
});
```
## terminateSelf
##
AbilityContext.
terminateSelf
terminateSelf(): Promise
<
void
>
;
停止Ability自身。通过Promise返回结果。
**系统能力
:**
**系统能力
**
:SystemCapability.Ability.AbilityRuntime.Core
SystemCapability.Ability.AbilityRuntime.Core
**返回值:**
-
返回值:
| 类型 | 说明 |
| -------- | -------- |
| Promise
<
void
>
| 返回一个Promise,包含接口的结果。 |
-
示例:
```
**示例:**
```
js
this
.
context
.
terminateSelf
(
want
).
then
((
data
)
=>
{
console
.
log
(
'
success:
'
+
JSON
.
stringfy
(
data
));
}).
catch
((
error
)
=>
{
...
...
@@ -298,24 +299,24 @@ SystemCapability.Ability.AbilityRuntime.Core
```
## terminateSelfWithResult
##
AbilityContext.
terminateSelfWithResult
terminateSelfWithResult(parameter: AbilityResult, callback: AsyncCallback
<
void
>
): void;
停止Ability,并返回给调用startAbilityForResult 接口调用方的相关信息。
**系统能力
:**
**系统能力
**
:SystemCapability.Ability.AbilityRuntime.Core
SystemCapability.Ability.AbilityRuntime.Core
**参数:**
-
参数
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| parameter |
[
AbilityResult
](
js-apis-featureAbility.md#abilityresult
)
| 是 | 返回给调用startAbilityForResult
接口调用方的相关信息。 |
| callback | AsyncCallback
<
void
>
| 是 | callback形式返回停止结果。 |
-
示例:
```
**示例:**
```
js
this
.
context
.
terminateSelfWithResult
(
{
want
:
{
bundleName
:
"
com.extreme.myapplication
"
,
abilityName
:
"
MainAbilityDemo
"
},
...
...
@@ -327,28 +328,29 @@ SystemCapability.Ability.AbilityRuntime.Core
```
## terminateSelfWithResult
##
AbilityContext.
terminateSelfWithResult
terminateSelfWithResult(parameter: AbilityResult): Promise
<
void
>
;
停止Ability,并返回给调用startAbilityForResult 接口相关信息。
**系统能力
:**
**系统能力
**
:SystemCapability.Ability.AbilityRuntime.Core
SystemCapability.Ability.AbilityRuntime.Core
**参数:**
-
参数:
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| parameter |
[
AbilityResult
](
js-apis-featureAbility.md#abilityresult
)
| 是 | 返回给startAbilityForResult
调用方的信息。 |
-
返回值:
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
| Promise
<
void
>
| promise形式返回停止结果。 |
-
示例:
```
**示例:**
```
js
this
.
context
.
terminateSelfWithResult
(
{
want
:
{
bundleName
:
"
com.extreme.myapplication
"
,
abilityName
:
"
MainAbilityDemo
"
},
...
...
@@ -360,29 +362,29 @@ SystemCapability.Ability.AbilityRuntime.Core
```
## startAbilityByCall
##
AbilityContext.
startAbilityByCall
startAbilityByCall(want: Want): Promise
<
Caller
>
;
获取指定通用组件服务端的caller通信接口, 并且将指定通用组件服务端拉起并切换到后台。
**系统能力
:**
**系统能力
**
:SystemCapability.Ability.AbilityRuntime.Core
SystemCapability.Ability.AbilityRuntime.Core
**参数:**
-
参数:
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want |
[
Want
](
js-apis-featureAbility.md#Want类型说明
)
| 是 | 传入需要启动的ability的信息,包含ability名称、包名、设备ID,设备ID缺省或为空表示启动本地ability。 |
-
返回值:
| 类型 | 说明 |
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
| Promise
<>
| 获取要通讯的caller对象。 |
| Promise
<
Caller
>
| 获取要通讯的caller对象。 |
-
示例:
**示例:**
```
```
js
import
Ability
from
'
@ohos.application.Ability
'
;
var
caller
;
export
default
class
MainAbility
extends
Ability
{
...
...
@@ -402,23 +404,22 @@ SystemCapability.Ability.AbilityRuntime.Core
```
## requestPermissionsFromUser
##
AbilityContext.
requestPermissionsFromUser
requestPermissionsFromUser(permissions: Array
<
string
>
, requestCallback: AsyncCallback
<
PermissionRequestResult
>
) : void;
拉起弹窗请求用户授权。
**系统能力
:**
**系统能力
**
:SystemCapability.Ability.AbilityRuntime.Core
SystemCapability.Ability.AbilityRuntime.Core
**参数:**
-
参数:
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| permissions | Array
<
string
>
| 是 | 权限列表。 |
| callback | AsyncCallback
<
[PermissionRequestResult](js-apis-permissionrequestresult.md)
>
| 是 | 回调函数,返回接口调用是否成功的结果。 |
-
示例:
**示例:**
```
this.context.requestPermissionsFromUser(permissions,(result) => {
...
...
@@ -427,27 +428,27 @@ SystemCapability.Ability.AbilityRuntime.Core
```
## requestPermissionsFromUser
##
AbilityContext.
requestPermissionsFromUser
requestPermissionsFromUser(permissions: Array
<
string
>
) : Promise
<
PermissionRequestResult
>
;
拉起弹窗请求用户授权。通过Promise返回结果。
**系统能力
:**
**系统能力
**
:SystemCapability.Ability.AbilityRuntime.Core
SystemCapability.Ability.AbilityRuntime.Core
**参数:**
-
参数:
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| permissions | Array
<
string
>
| 是 | 权限列表。 |
| permissions | Array
<
string
>
| 是 | 权限列表。 |
**返回值:**
-
返回值:
| 类型 | 说明 |
| 类型 | 说明 |
| -------- | -------- |
| Promise
<
[PermissionRequestResult](js-apis-permissionrequestresult.md)
>
| 返回一个Promise,包含接口的结果。 |
-
示例:
**示例:**
```
this.context.requestPermissionsFromUser(permissions).then((data) => {
...
...
@@ -458,54 +459,53 @@ SystemCapability.Ability.AbilityRuntime.Core
```
## setMissionLabel
##
AbilityContext.
setMissionLabel
setMissionLabel(label: string, callback:AsyncCallback
<
void
>
): void;
设置ability在任务中显示的名称。
**系统能力
:**
**系统能力
**
:SystemCapability.Ability.AbilityRuntime.Core
SystemCapability.Ability.AbilityRuntime.Core
**参数:**
-
参数:
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| label | string | 是 | 显示名称。 |
| callback | AsyncCallback
<
void
>
| 是 | 回调函数,返回接口调用是否成功的结果。 |
-
示例:
**示例:**
```
```
js
this
.
context
.
setMissionLabel
(
"
test
"
,(
result
)
=>
{
console
.
log
(
'
requestPermissionsFromUserresult:
'
+
JSON
.
stringfy
(
result
));
});
```
## setMissionLabel
##
AbilityContext.
setMissionLabel
setMissionLabel(label: string
, callback:AsyncCallback
<
void
>
): void
;
setMissionLabel(label: string
): Promise
<void>
;
设置ability在任务中显示的名称。
**系统能力
:**
**系统能力
**
:SystemCapability.Ability.AbilityRuntime.Core
SystemCapability.Ability.AbilityRuntime.Core
**参数:**
-
参数:
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| label | string | 是 | 显示名称。 |
-
返回值:
| 类型 | 说明 |
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
| Promise
<
void
>
| 返回一个Promise,包含接口的结果。 |
-
示例:
**示例:**
```
```
js
this
.
context
.
setMissionLabel
(
"
test
"
).
then
((
data
)
=>
{
console
.
log
(
'
success:
'
+
JSON
.
stringfy
(
data
));
}).
catch
((
error
)
=>
{
...
...
zh-cn/application-dev/reference/apis/js-apis-abilityrunninginfo.md
浏览文件 @
3777db35
...
...
@@ -19,34 +19,33 @@ Ability运行相关信息。
```
```
js
import
abilitymanager
from
'
@ohos.application.abilityManager
'
;
abilitymanager
.
getAbilityRunningInfos
((
err
,
data
)
=>
{
console
.
log
(
"
getAbilityRunningInfos err:
"
+
err
+
"
data:
"
+
JSON
.
stringify
(
data
));
});
```
## 属性
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| ability | ElementName | 是 | 否 | Ability匹配信息。 |
| pid | number | 是 | 否 | 进程ID。 |
| uid | number | 是 | 否 | 用户ID。 |
| processName | string | 是 | 否 | 进程名称。 |
| startTime | number | 是 | 否 | Ability启动时间。 |
| abilityState |
[
abilityManager.AbilityState
](
#abilitymanager-abilitystate
)
| 是 | 否 | Ability状态。 |
| ability | ElementName | 是 | 否 | Ability匹配信息。
<br/>
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
|
| pid | number | 是 | 否 | 进程ID。
<br/>
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
|
| uid | number | 是 | 否 | 用户ID。
<br/>
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
|
| processName | string | 是 | 否 | 进程名称。
<br/>
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
|
| startTime | number | 是 | 否 | Ability启动时间。
<br/>
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
|
| abilityState |
[
abilityManager.AbilityState
](
#abilitymanager-abilitystate
)
| 是 | 否 | Ability状态。
<br/>
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
|
## abilityManager.AbilityState
Ability的状态信息。
| 名称 | 值 | 说明 |
| 名称 | 值 | 说明 |
| -------- | -------- | -------- |
| INITIAL | 0 | 表示ability为initial状态。
|
| FOREGROUND | 9 | 表示ability为foreground状态。 |
| BACKGROUND | 10 | 表示ability为background状态。 |
| FOREGROUNDING | 11 | 表示ability为foregrounding状态。 |
| BACKGROUNDING | 12 | 表示ability为backgrounding状态。 |
| INITIAL | 0 | 表示ability为initial状态。
<br/>
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
|
| FOREGROUND | 9 | 表示ability为foreground状态。
<br/>
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
|
| BACKGROUND | 10 | 表示ability为background状态。
<br/>
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
|
| FOREGROUNDING | 11 | 表示ability为foregrounding状态。
<br/>
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
|
| BACKGROUNDING | 12 | 表示ability为backgrounding状态。
<br/>
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
|
zh-cn/application-dev/reference/apis/js-apis-abilitystagecontext.md
浏览文件 @
3777db35
...
...
@@ -18,7 +18,7 @@ AbilityStage的上下文环境,继承自[Context](js-apis-application-context.
```
```
js
import
AbilityStage
from
'
@ohos.application.AbilityStage
'
;
class
MyAbilityStage
extends
AbilityStage
{
onCreate
()
{
...
...
@@ -30,7 +30,7 @@ class MyAbilityStage extends AbilityStage {
## 属性
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| currentHapModuleInfo | HapModuleInfo | 是 | 否 | AbilityStage对应的ModuleInfo对象。 |
| config |
[
Configuration
](
js-apis-configuration.md
)
| 是 | 否 | 环境变化对象。 |
| currentHapModuleInfo | HapModuleInfo | 是 | 否 | AbilityStage对应的ModuleInfo对象。
<br/>
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
|
| config |
[
Configuration
](
js-apis-configuration.md
)
| 是 | 否 | 环境变化对象。
<br/>
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
|
zh-cn/application-dev/reference/apis/js-apis-application-MissionInfo.md
浏览文件 @
3777db35
...
...
@@ -21,13 +21,13 @@ import Want from "../@ohos.application.Want";
表示Ability对应任务信息的枚举。
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| missionId | number | 是 | 是 | 表示任务ID。
|
| runningState | number | 是 | 是 | 表示运行状态。 |
| lockedState | boolean | 是 | 是 | 表示锁定状态。 |
| timestamp | string | 是 | 是 | 表示任务的最近创建或更新时间。 |
| want |
[
Want
](
js-apis-featureAbility.md#want
)
| 是 | 是 | 表示任务的Want信息。 |
| label | string | 是 | 是 | 表示任务的标签。 |
| iconPath | string | 是 | 是 | 表示任务的图标路径。 |
| continuable | boolean | 是 | 是 | 表示任务是否可以继续。 |
| missionId | number | 是 | 是 | 表示任务ID。
<br/>
**系统能力**
:SystemCapability.Ability.AbilityBase
|
| runningState | number | 是 | 是 | 表示运行状态。
<br/>
**系统能力**
:SystemCapability.Ability.AbilityBase
|
| lockedState | boolean | 是 | 是 | 表示锁定状态。
<br/>
**系统能力**
:SystemCapability.Ability.AbilityBase
|
| timestamp | string | 是 | 是 | 表示任务的最近创建或更新时间。
<br/>
**系统能力**
:SystemCapability.Ability.AbilityBase
|
| want |
[
Want
](
js-apis-featureAbility.md#want
)
| 是 | 是 | 表示任务的Want信息。
<br/>
**系统能力**
:SystemCapability.Ability.AbilityBase
|
| label | string | 是 | 是 | 表示任务的标签。
<br/>
**系统能力**
:SystemCapability.Ability.AbilityBase
|
| iconPath | string | 是 | 是 | 表示任务的图标路径。
<br/>
**系统能力**
:SystemCapability.Ability.AbilityBase
|
| continuable | boolean | 是 | 是 | 表示任务是否可以继续。
<br/>
**系统能力**
:SystemCapability.Ability.AbilityBase
|
zh-cn/application-dev/reference/apis/js-apis-application-ability.md
浏览文件 @
3777db35
...
...
@@ -39,28 +39,31 @@ import Ability from '@ohos.application.Ability';
## 属性
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| context |
[
AbilityContext
](
js-apis-ability-context.md
)
| 是 | 否 | 上下文。 |
| launchWant |
[
Want
](
js-apis-featureAbility.md#Want类型说明
)
| 是 | 否 | Ability启动时的参数。 |
| lastRequestWant |
[
Want
](
js-apis-featureAbility.md#Want类型说明
)
| 是 | 否 | Ability最后请求时的参数。 |
| context |
[
AbilityContext
](
js-apis-ability-context.md
)
| 是 | 否 | 上下文。
<br/>
**系统能力**
:SystemCapability.Ability.AbilityRuntime.AbilityCore
|
| launchWant |
[
Want
](
js-apis-featureAbility.md#Want类型说明
)
| 是 | 否 | Ability启动时的参数。
<br/>
**系统能力**
:SystemCapability.Ability.AbilityRuntime.AbilityCore
|
| lastRequestWant |
[
Want
](
js-apis-featureAbility.md#Want类型说明
)
| 是 | 否 | Ability最后请求时的参数。
<br/>
**系统能力**
:SystemCapability.Ability.AbilityRuntime.AbilityCore
|
## onCreate
##
Ability.
onCreate
onCreate(want: Want,param:LaunchParam): void
Ability创建时回调,执行初始化业务逻辑操作。
-
参数:
| 参数名 | 类型 | 必填 | 说明 |
**系统能力**
:SystemCapability.Ability.AbilityRuntime.AbilityCore
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want |
[
Want
](
js-apis-featureAbility.md#Want类型说明
)
| 是 | 当前Ability的Want类型信息,包括ability名称、bundle名称等。 |
| param | LaunchParam | 是 | 创建
ability、上次异常退出的原因信息。 |
-
示例:
**示例:**
```
```
js
class
myAbility
extends
Ability
{
onCreate
(
want
,
param
)
{
console
.
log
(
'
onCreate, want:
'
+
want
.
abilityName
);
...
...
@@ -69,20 +72,23 @@ Ability创建时回调,执行初始化业务逻辑操作。
```
## onWindowStageCreate
##
Ability.
onWindowStageCreate
onWindowStageCreate(windowStage: window.WindowStage): void
当WindowStage创建后调用。
-
参数:
| 参数名 | 类型 | 必填 | 说明 |
**系统能力**
:SystemCapability.Ability.AbilityRuntime.AbilityCore
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| windowStage | window.WindowStage | 是 | WindowStage相关信息。 |
-
示例:
**示例:**
```
```
js
class
myAbility
extends
Ability
{
onWindowStageCreate
(
windowStage
)
{
console
.
log
(
'
onWindowStageCreate
'
);
...
...
@@ -91,15 +97,17 @@ onWindowStageCreate(windowStage: window.WindowStage): void
```
## onWindowStageDestroy
##
Ability.
onWindowStageDestroy
onWindowStageDestroy(): void
当WindowStage销毁后调用。
-
示例:
**系统能力**
:SystemCapability.Ability.AbilityRuntime.AbilityCore
**示例:**
```
```
js
class
myAbility
extends
Ability
{
onWindowStageDestroy
()
{
console
.
log
(
'
onWindowStageDestroy
'
);
...
...
@@ -108,20 +116,23 @@ onWindowStageDestroy(): void
```
## onWindowStageRestore
##
Ability.
onWindowStageRestore
onWindowStageRestore(windowStage: window.WindowStage): void
当迁移多实例ability时,恢复WindowStage后调用。
-
参数:
| 参数名 | 类型 | 必填 | 说明 |
**系统能力**
:SystemCapability.Ability.AbilityRuntime.AbilityCore
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| windowStage | window.WindowStage | 是 | WindowStage相关信息。 |
-
示例:
**示例:**
```
```
js
class
myAbility
extends
Ability
{
onWindowStageRestore
(
windowStage
)
{
console
.
log
(
'
onWindowStageRestore
'
);
...
...
@@ -130,15 +141,17 @@ onWindowStageRestore(windowStage: window.WindowStage): void
```
## onDestroy
##
Ability.
onDestroy
onDestroy(): void;
Ability生命周期回调,在销毁时回调,执行资源清理等操作。
-
示例:
**系统能力**
:SystemCapability.Ability.AbilityRuntime.AbilityCore
**示例:**
```
```
js
class
myAbility
extends
Ability
{
onDestroy
()
{
console
.
log
(
'
onDestroy
'
);
...
...
@@ -147,15 +160,17 @@ Ability生命周期回调,在销毁时回调,执行资源清理等操作。
```
## onForeground
##
Ability.
onForeground
onForeground(): void;
Ability生命周期回调,当应用处于前台时触发。
-
示例:
**系统能力**
:SystemCapability.Ability.AbilityRuntime.AbilityCore
**示例:**
```
```
js
class
myAbility
extends
Ability
{
onForeground
()
{
console
.
log
(
'
onForeground
'
);
...
...
@@ -164,15 +179,17 @@ Ability生命周期回调,当应用处于前台时触发。
```
## onBackground
##
Ability.
onBackground
onBackground(): void;
Ability生命周期回调,当应用处于后台时触发。
-
示例:
**系统能力**
:SystemCapability.Ability.AbilityRuntime.AbilityCore
**示例:**
```
```
js
class
myAbility
extends
Ability
{
onBackground
()
{
console
.
log
(
'
onBackground
'
);
...
...
@@ -181,25 +198,29 @@ Ability生命周期回调,当应用处于后台时触发。
```
## onContinue
##
Ability.
onContinue
onContinue(wantParam : {[key: string]: any}): boolean;
当ability迁移准备迁移时触发,保存数据。
-
参数:
| 参数名 | 类型 | 必填 | 说明 |
**系统能力**
:SystemCapability.Ability.AbilityRuntime.AbilityCore
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| wantParam | {[key:
string]:
any} | 是 | want相关参数。 |
-
返回值:
| 类型 | 说明 |
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
| boolean | true表示同意迁移,false表示拒绝迁移。 |
-
示例:
**示例:**
```
```
js
class
myAbility
extends
Ability
{
onContinue
(
wantParams
)
{
console
.
log
(
'
onContinue
'
);
...
...
@@ -210,20 +231,23 @@ onContinue(wantParam : {[key: string]: any}): boolean;
```
## onNewWant
##
Ability.
onNewWant
onNewWant(want: Want): void;
当ability的启动模式设置为单例时回调会被调用。
-
参数:
| 参数名 | 类型 | 必填 | 说明 |
**系统能力**
:SystemCapability.Ability.AbilityRuntime.AbilityCore
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want |
[
Want
](
js-apis-featureAbility.md#Want类型说明
)
| 是 | Want类型参数,如ability名称,包名等。 |
-
示例:
**示例:**
```
```
js
class
myAbility
extends
Ability
{
onNewWant
(
want
)
{
console
.
log
(
'
onNewWant, want:
'
+
want
.
abilityName
);
...
...
@@ -232,20 +256,23 @@ onNewWant(want: Want): void;
```
## onConfigurationUpdated
##
Ability.
onConfigurationUpdated
onConfigurationUpdated(config: Configuration): void;
当系统配置更新时调用。
-
参数:
| 参数名 | 类型 | 必填 | 说明 |
**系统能力**
:SystemCapability.Ability.AbilityRuntime.AbilityCore
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| config |
[
Configuration
](
#section188911144124715
)
| 是 | 表示需要更新的配置信息。 |
-
示例:
**示例:**
```
```
js
class
myAbility
extends
Ability
{
onConfigurationUpdated
(
config
)
{
console
.
log
(
'
onConfigurationUpdated, config:
'
+
JSON
.
stringify
(
config
));
...
...
@@ -259,26 +286,30 @@ onConfigurationUpdated(config: Configuration): void;
通用组件Caller通信客户端调用接口, 用来向通用组件服务端发送约定数据。
##
#
call
##
Caller.
call
call(method, data: rpc.Sequenceable): Promise
<
void
>
;
call(method
: string
, data: rpc.Sequenceable): Promise
<
void
>
;
向通用组件服务端发送约定序列化数据。
-
参数:
| 参数名 | 类型 | 必填 | 说明 |
**系统能力**
:SystemCapability.Ability.AbilityRuntime.AbilityCore
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| method | string | 是 | 约定的服务端注册事件字符串。 |
| data | rpc.Sequenceable | 是 | 由开发者实现的Sequenceable可序列化数据。 |
-
返回值:
| 类型 | 说明 |
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
| Promise
<
void
>
| Promise形式返回应答。 |
-
示例:
**示例:**
```
```
js
import
Ability
from
'
@ohos.application.Ability
'
;
class
MyMessageAble
{
// 自定义的Sequenceable数据结构
num
:
0
...
...
@@ -318,26 +349,30 @@ call(method, data: rpc.Sequenceable): Promise<void>;
```
##
#
callWithResult
##
Caller.
callWithResult
callWithResult(method, data: rpc.Sequenceable): Promise
<
rpc.MessageParcel
>
;
callWithResult(method
: string
, data: rpc.Sequenceable): Promise
<
rpc.MessageParcel
>
;
向通用组件服务端发送约定序列化数据, 并将服务端返回的约定序列化数据带回。
-
参数:
| 参数名 | 类型 | 必填 | 说明 |
**系统能力**
:SystemCapability.Ability.AbilityRuntime.AbilityCore
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| method | string | 是 | 约定的服务端注册事件字符串。 |
| data | rpc.Sequenceable | 是 | 由开发者实现的Sequenceable可序列化数据。 |
-
返回值:
| 类型 | 说明 |
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
| Promise
<
rpc.MessageParcel
>
| Promise形式返回通用组件服务端应答数据。 |
-
示例:
**示例:**
```
```
js
import
Ability
from
'
@ohos.application.Ability
'
;
class
MyMessageAble
{
num
:
0
...
...
@@ -379,15 +414,17 @@ callWithResult(method, data: rpc.Sequenceable): Promise<rpc.MessageParcel>
```
##
#
release
##
Caller.
release
release(): void;
主动释放通用组件服务端的通信接口。
-
示例:
**系统能力**
:SystemCapability.Ability.AbilityRuntime.AbilityCore
**示例:**
```
```
js
import
Ability
from
'
@ohos.application.Ability
'
;
var
caller
;
export
default
class
MainAbility
extends
Ability
{
...
...
@@ -407,20 +444,23 @@ release(): void;
```
##
#
onRelease
##
Caller.
onRelease
onRelease(callback: function): void;
注册通用组件服务端Stub断开监听通知。
-
参数:
| 参数名 | 类型 | 必填 | 说明 |
**系统能力**
:SystemCapability.Ability.AbilityRuntime.AbilityCore
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | function | 是 | 返回onRelease回调结果。 |
-
示例:
**示例:**
```
```
js
import
Ability
from
'
@ohos.application.Ability
'
;
var
caller
;
export
default
class
MainAbility
extends
Ability
{
...
...
@@ -447,21 +487,24 @@ onRelease(callback: function): void;
通用组件服务端注册和解除客户端caller通知送信的callback接口。
##
#
on
##
Callee.
on
on(method: string, callback: function): void;
通用组件服务端注册消息通知callback。
-
参数:
| 参数名 | 类型 | 必填 | 说明 |
**系统能力**
:SystemCapability.Ability.AbilityRuntime.AbilityCore
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| method | string | 是 | 与客户端约定的通知消息字符串。 |
| callback | function | 是 | 一个rpc.MessageParcel类型入参的js通知同步回调函数,
回调函数至少要返回一个空的rpc.Sequenceable数据对象,
其他视为函数执行错误。 |
-
示例:
**示例:**
```
```
js
import
Ability
from
'
@ohos.application.Ability
'
;
class
MyMessageAble
{
num
:
0
...
...
@@ -496,20 +539,23 @@ on(method: string, callback: function): void;
```
##
#
off
##
Callee.
off
off(method: string): void;
解除通用组件服务端注册消息通知callback。
-
参数:
| 参数名 | 类型 | 必填 | 说明 |
**系统能力**
:SystemCapability.Ability.AbilityRuntime.AbilityCore
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| method | string | 是 | 已注册的通知事件字符串。 |
-
示例:
**示例:**
```
```
js
import
Ability
from
'
@ohos.application.Ability
'
;
var
method
=
'
call_Function
'
;
export
default
class
MainAbility
extends
Ability
{
...
...
zh-cn/application-dev/reference/apis/js-apis-application-abilitystage.md
浏览文件 @
3777db35
...
...
@@ -16,20 +16,23 @@ AbilityStage是HAP包的运行时类。在HAP加载的时候,通知开发者
## 导入模块
```
```
js
import
AbilityStage
from
'
@ohos.application.AbilityStage
'
;
```
## onCreate
## AbilityStage.onCreate
onCreate(): void
当应用创建时调用。
-
示例
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
**示例:**
```
```
js
class
MyAbilityStage
extends
AbilityStage
{
onCreate
()
{
console
.
log
(
"
MyAbilityStage.onCreate is called
"
)
...
...
@@ -38,25 +41,29 @@ onCreate(): void
```
## onAcceptWant
##
AbilityStage.
onAcceptWant
onAcceptWant(want: Want): string;
启动一个specified ability时触发的事件。
-
参数:
| 参数名 | 类型 | 必填 | 说明 |
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want |
[
Want
](
js-apis-featureAbility.md#Want类型说明
)
| 是 | Want类型参数,传入需要启动的ability的信息,如ability名称,包名等。 |
-
返回值:
| 类型 | 说明 |
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
| string | 用户返回一个ability标识,如果之前启动过次标识的ability,不创建新的实例并拉回栈顶,否则创建新的实例并启动。 |
-
示例
**示例:**
```
```
js
class
MyAbilityStage
extends
AbilityStage
{
onAcceptWant
(
want
)
{
console
.
log
(
"
MyAbilityStage.onAcceptWant called
"
);
...
...
@@ -66,20 +73,23 @@ onAcceptWant(want: Want): string;
```
## onConfigurationUpdated
##
AbilityStage.
onConfigurationUpdated
onConfigurationUpdated(config: Configuration): void;
环境变化通知接口,发生全局配置变更时回调。
-
参数:
| 参数名 | 类型 | 必填 | 说明 |
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| config |
[
Configuration
](
js-apis-configuration.md
)
| 是 | 发生全局配置变更时触发回调,当前全局配置包括系统语言、深浅色模式。 |
-
示例:
**示例:**
```
```
js
class
MyAbilityStage
extends
AbilityStage
{
onConfigurationUpdated
(
config
)
{
console
.
log
(
'
onConfigurationUpdated, language:
'
+
config
.
language
);
...
...
zh-cn/application-dev/reference/apis/js-apis-application-context.md
浏览文件 @
3777db35
...
...
@@ -23,56 +23,63 @@
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| resourceManager | ResourceManager | 是 | 否 | ResourceManager对象。 |
| applicationInfo | ApplicationInfo | 是 | 否 | 当前应用信息。 |
| cacheDir | string | 是 | 否 | 应用在内部存储上的缓存路径。 |
| tempDir | string | 是 | 否 | 应用的临时文件路径。 |
| filesDir | string | 是 | 否 | 应用在内部存储上的文件路径。 |
| databaseDir | string | 是 | 否 | 获取本地数据存储路径。 |
| storageDir | string | 是 | 否 | 获取轻量级数据存储路径。 |
| bundleCodeDir | string | 是 | 否 | 应用安装路径。 |
| distributedFilesDir | string | 是 | 否 | 应用的分布式文件路径。 |
| eventHub |
[
EventHub
](
js-apis-eventhub.md
)
| 是 | 否 | 事件中心信息。|
| resourceManager | ResourceManager | 是 | 否 | ResourceManager对象。
<br/>
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
|
| applicationInfo | ApplicationInfo | 是 | 否 | 当前应用信息。
<br/>
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
|
| cacheDir | string | 是 | 否 | 应用在内部存储上的缓存路径。
<br/>
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
|
| tempDir | string | 是 | 否 | 应用的临时文件路径。
<br/>
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
|
| filesDir | string | 是 | 否 | 应用在内部存储上的文件路径。
<br/>
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
|
| databaseDir | string | 是 | 否 | 获取本地数据存储路径。
<br/>
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
|
| storageDir | string | 是 | 否 | 获取轻量级数据存储路径。
<br/>
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
|
| bundleCodeDir | string | 是 | 否 | 应用安装路径。
<br/>
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
|
| distributedFilesDir | string | 是 | 否 | 应用的分布式文件路径。
<br/>
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
|
| eventHub |
[
EventHub
](
js-apis-eventhub.md
)
| 是 | 否 | 事件中心信息。
<br/>
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
|
## createBundleContext
##
Context.
createBundleContext
createBundleContext(bundleName: string): Context;
创建指定应用上下文。
-
参数:
| 参数名 | 类型 | 必填 | 说明 |
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| bundleName | string | 是 | 应用bundle名。 |
-
返回值:
| 类型 | 说明 |
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
| Context | 对应创建应用的上下文context。 |
-
示例:
**示例:**
```
```
js
let
test
=
"
com.huawei.test
"
;
let
context
=
this
.
context
.
createBundleContext
(
test
);
```
## getApplicationContext
##
Context.
getApplicationContext
getApplicationContext(): Context;
获取当前context。
-
返回值:
| 类型 | 说明 |
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
| Context | 当前Context
信息。 |
-
示例:
**示例:**
```
```
js
// 必选项。
let
context
=
this
.
context
.
getApplicationContext
();
```
zh-cn/application-dev/reference/apis/js-apis-appmanager.md
浏览文件 @
3777db35
...
...
@@ -15,50 +15,56 @@ App运行相关信息。
## 导入模块
```
```
js
import
app
from
'
@ohos.application.appManager
'
;
```
## isRunningInStabilityTest
##
appManager.
isRunningInStabilityTest
static isRunningInStabilityTest(callback: AsyncCallback
<
boolean
>
): void
查询当前用户是否是一个稳定性测试。
-
参数:
| 参数名 | 类型 | 必填 | 说明 |
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback
<
boolean
>
| 否 | 返回当前是否处于稳定性测试场景。 |
-
示例:
**示例:**
```
```
js
import
app
from
'
@ohos.application.appManager
'
;
app.isRunningInStabilityTest((err
,
flag) => {
console.log('startAbility result:' + JSON.stringfy(err);
}
app
.
isRunningInStabilityTest
((
err
,
flag
)
=>
{
console
.
log
(
'
startAbility result:
'
+
JSON
.
stringfy
(
err
)
)
;
}
)
```
## isRunningInStabilityTest
##
appManager.
isRunningInStabilityTest
static isRunningInStabilityTest(): Promise
<
boolean
>
查询当前是否处于稳定性测试场景。
-
返回值:
| 类型 | 说明 |
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
| Promise
<
boolean
>
| 返回当前是否处于稳定性测试场景。 |
-
示例:
**示例:**
```
```
js
import
app
from
'
@ohos.application.appManager
'
;
app
.
isRunningInStabilityTest
().
then
((
flag
)
=>
{
console
.
log
(
'
success:
'
+
JSON
.
stringfy
(
flag
));
)
).catch((error) => {
}
).
catch
((
error
)
=>
{
console
.
log
(
'
failed:
'
+
JSON
.
stringfy
(
error
));
});
```
zh-cn/application-dev/reference/apis/js-apis-configuration.md
浏览文件 @
3777db35
...
...
@@ -14,7 +14,7 @@
## 导入模块
```
```
js
import
Configuration
from
'
@ohos.application.Configuration
'
;
```
...
...
@@ -23,8 +23,8 @@ import Configuration from '@ohos.application.Configuration';
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| language | string | 是 | 是 | 表示应用程序的当前语言。 |
| colorMode |
[
ColorMode
](
js-apis-configurationconstant.md
)
| 是 | 是 | 表示深浅色模式,取值范围:浅色模式(COLOR_MODE_LIGHT),深色模式(COLOR_MODE_DARK)。默认为浅色。 |
| direction | Direction | 是 | 否 | 表示屏幕方向,取值范围:水平方向(DIRECTION_HORIZONTAL),垂直方向(DIRECTION_VERTICAL)。 |
| screenDensity | ScreenDensity | 是 | 否 | 表示屏幕分辨率,取值范围:SCREEN_DENSITY_SDPI(120)、SCREEN_DENSITY_MDPI(160)、SCREEN_DENSITY_LDPI(240)、SCREEN_DENSITY_XLDPI(320)、SCREEN_DENSITY_XXLDPI(480)、SCREEN_DENSITY_XXXLDPI(640)。 |
| displayId | number | 是 | 否 | 表示应用所在的displayId。 |
| language | string | 是 | 是 | 表示应用程序的当前语言。
<br/>
**系统能力**
:SystemCapability.Ability.AbilityBase
|
| colorMode |
[
ColorMode
](
js-apis-configurationconstant.md
)
| 是 | 是 | 表示深浅色模式,取值范围:浅色模式(COLOR_MODE_LIGHT),深色模式(COLOR_MODE_DARK)。默认为浅色。
<br/>
**系统能力**
:SystemCapability.Ability.AbilityBase
|
| direction | Direction | 是 | 否 | 表示屏幕方向,取值范围:水平方向(DIRECTION_HORIZONTAL),垂直方向(DIRECTION_VERTICAL)。
<br/>
**系统能力**
:SystemCapability.Ability.AbilityBase
|
| screenDensity | ScreenDensity | 是 | 否 | 表示屏幕分辨率,取值范围:SCREEN_DENSITY_SDPI(120)、SCREEN_DENSITY_MDPI(160)、SCREEN_DENSITY_LDPI(240)、SCREEN_DENSITY_XLDPI(320)、SCREEN_DENSITY_XXLDPI(480)、SCREEN_DENSITY_XXXLDPI(640)。
<br/>
**系统能力**
:SystemCapability.Ability.AbilityBase
|
| displayId | number | 是 | 否 | 表示应用所在的displayId。
<br/>
**系统能力**
:SystemCapability.Ability.AbilityBase
|
zh-cn/application-dev/reference/apis/js-apis-configurationconstant.md
浏览文件 @
3777db35
...
...
@@ -16,46 +16,61 @@
## 导入模块
```
```
js
import
ConfigurationConstant
from
'
@ohos.application.ConfigurationConstant
'
;
```
## ColorMode
## Co
nfigurationConstant.Co
lorMode
使用时通过ConfigurationConstant.ColorMode获取
,示例:ConfigurationConstant.ColorMode.COLOR_MODE_LIGHT
。
使用时通过ConfigurationConstant.ColorMode获取。
**示例:**
| 名称 | 值 | 说明 |
```
ConfigurationConstant.ColorMode.COLOR_MODE_LIGHT。
```
| 名称 | 值 | 说明 |
| -------- | -------- | -------- |
| COLOR_MODE_NOT_SET | -1 | 未设置颜色模式。 |
| COLOR_MODE_DARK | 0 | 深色模式。 |
| COLOR_MODE_LIGHT | 1 | 浅色模式。 |
| COLOR_MODE_NOT_SET | -1 | 未设置颜色模式。
<br/>
**系统能力**
:SystemCapability.Ability.AbilityBase |
| COLOR_MODE_DARK | 0 | 深色模式。
<br/>
**系统能力**
:SystemCapability.Ability.AbilityBase |
| COLOR_MODE_LIGHT | 1 | 浅色模式。
<br/>
**系统能力**
:SystemCapability.Ability.AbilityBase|
## ConfigurationConstant.Direction
## Direction
使用时通过ConfigurationConstant.Direction获取。
使用时通过ConfigurationConstant.Direction获取,示例:ConfigurationConstant.Direction.DIRECTION_VERTICAL。
**示例:**
```
ConfigurationConstant.Direction.DIRECTION_VERTICAL。
```
| 名称 | 值 | 说明 |
| 名称 | 值 | 说明 |
| -------- | -------- | -------- |
| DIRECTION_NOT_SET | -1 | 未设置方向。 |
| DIRECTION_VERTICAL | 0 | 垂直方向。 |
| DIRECTION_HORIZONTAL | 1 | 水平方向。 |
| DIRECTION_NOT_SET | -1 | 未设置方向。
<br/>
**系统能力**
:SystemCapability.Ability.AbilityBase|
| DIRECTION_VERTICAL | 0 | 垂直方向。
<br/>
**系统能力**
:SystemCapability.Ability.AbilityBase|
| DIRECTION_HORIZONTAL | 1 | 水平方向。
<br/>
**系统能力**
:SystemCapability.Ability.AbilityBase|
## ConfigurationConstant.ScreenDensity
## ScreenDensity
使用时通过ConfigurationConstant.ScreenDensity获取。
使用时通过ConfigurationConstant.ScreenDensity获取,示例:ConfigurationConstant.ScreenDensity.SCREEN_DENSITY_NOT_SET。
**示例:**
```
ConfigurationConstant.ScreenDensity.SCREEN_DENSITY_NOT_SET。
```
| 名称 | 值 | 说明 |
| 名称 | 值 | 说明 |
| -------- | -------- | -------- |
| SCREEN_DENSITY_NOT_SET | 0 | 未设置屏幕分辨率。 |
| SCREEN_DENSITY_SDPI | 120 | 屏幕分辨率为"sdpi"。 |
| SCREEN_DENSITY_MDPI | 160 | 屏幕分辨率为"mdpi"。 |
| SCREEN_DENSITY_LDPI | 240 | 屏幕分辨率为"ldpi"。 |
| SCREEN_DENSITY_XLDPI | 320 | 屏幕分辨率为"xldpi"。 |
| SCREEN_DENSITY_XXLDPI | 480 | 屏幕分辨率为"xxldpi"。 |
| SCREEN_DENSITY_XXXLDPI | 640 | 屏幕分辨率为"xxxldpi"。 |
| SCREEN_DENSITY_NOT_SET | 0 | 未设置屏幕分辨率。
<br/>
**系统能力**
:SystemCapability.Ability.AbilityBase
|
| SCREEN_DENSITY_SDPI | 120 | 屏幕分辨率为"sdpi"。
<br/>
**系统能力**
:SystemCapability.Ability.AbilityBase
|
| SCREEN_DENSITY_MDPI | 160 | 屏幕分辨率为"mdpi"。
<br/>
**系统能力**
:SystemCapability.Ability.AbilityBase
|
| SCREEN_DENSITY_LDPI | 240 | 屏幕分辨率为"ldpi"。
<br/>
**系统能力**
:SystemCapability.Ability.AbilityBase
|
| SCREEN_DENSITY_XLDPI | 320 | 屏幕分辨率为"xldpi"。
<br/>
**系统能力**
:SystemCapability.Ability.AbilityBase
|
| SCREEN_DENSITY_XXLDPI | 480 | 屏幕分辨率为"xxldpi"。
<br/>
**系统能力**
:SystemCapability.Ability.AbilityBase
|
| SCREEN_DENSITY_XXXLDPI | 640 | 屏幕分辨率为"xxxldpi"。
<br/>
**系统能力**
:SystemCapability.Ability.AbilityBase
|
zh-cn/application-dev/reference/apis/js-apis-dataAbilityHelper.md
浏览文件 @
3777db35
...
...
@@ -8,17 +8,13 @@ import ohos_data_ability from '@ohos.data.dataability'
import ohos_data_rdb from '@ohos.data.rdb'
```
## DataAbilityHelper
### openFile
## DataAbilityHelper.openFile
openFile(uri: string, mode: string, callback: AsyncCallback
\<
number>): void
在指定的远程路径中打开文件(callback形式)。
**系统能力:**
SystemCapability.Ability.AbilityRuntime.FAModel
**系统能力**
:SystemCapability.Ability.AbilityRuntime.FAModel
**参数:**
...
...
@@ -44,15 +40,13 @@ DAHelper.openFile(
});
```
##
#
openFile
##
DataAbilityHelper.
openFile
openFile(uri: string, mode: string): Promise
\<
number>
在指定的远程路径中打开文件(promise形式)。
**系统能力:**
SystemCapability.Ability.AbilityRuntime.FAModel
**系统能力**
:SystemCapability.Ability.AbilityRuntime.FAModel
**参数:**
...
...
@@ -62,6 +56,7 @@ SystemCapability.Ability.AbilityRuntime.FAModel
| mode | string | 是 | 指示文件打开模式‘rwt’。 |
**返回值:**
| 类型 | 说明 |
| ---------------- | ---------------- |
| Promise
\<
number> | 返回文件描述符。 |
...
...
@@ -81,15 +76,13 @@ DAHelper.openFile(
});
```
##
# on('dataChange')
##
DataAbilityHelper.on
on(type: 'dataChange', uri: string, callback: AsyncCallback
\<
void>): void
注册观察者以观察给定uri指定的数据callback通知。
**系统能力:**
SystemCapability.Ability.AbilityRuntime.FAModel
**系统能力**
:SystemCapability.Ability.AbilityRuntime.FAModel
**参数:**
...
...
@@ -116,15 +109,13 @@ helper.on(
)
```
##
# off('dataChange')
##
DataAbilityHelper.off
off(type: 'dataChange', uri: string, callback?: AsyncCallback
\<
void>): void
注消观察者以停止观察给定uri指定的数据callback通知。
**系统能力:**
SystemCapability.Ability.AbilityRuntime.FAModel
**系统能力**
:SystemCapability.Ability.AbilityRuntime.FAModel
**参数:**
...
...
@@ -155,15 +146,13 @@ helper.off(
)
```
##
#
getType
##
DataAbilityHelper.
getType
getType(uri: string, callback: AsyncCallback
\<
string>): void
获取给定URI指定数据的MIME类型(callback形式)。
**系统能力:**
SystemCapability.Ability.AbilityRuntime.FAModel
**系统能力**
:SystemCapability.Ability.AbilityRuntime.FAModel
**参数:**
...
...
@@ -186,15 +175,13 @@ DAHelper.getType(
});
```
##
#
getType
##
DataAbilityHelper.
getType
getType(uri: string): Promise
\<
string>
获取给定URI指定数据的MIME类型(Promise形式)。
**系统能力:**
SystemCapability.Ability.AbilityRuntime.FAModel
**系统能力**
:SystemCapability.Ability.AbilityRuntime.FAModel
**参数:**
...
...
@@ -203,6 +190,7 @@ SystemCapability.Ability.AbilityRuntime.FAModel
| uri | string | 是 | 指示要操作的数据的路径。 |
**返回值:**
| 类型 | 说明 |
| ---------------- | ----------------------------------- |
| Promise
\<
string> | 返回与uri指定的数据匹配的MIME类型。 |
...
...
@@ -221,15 +209,13 @@ DAHelper.getType(
});
```
##
#
getFileTypes
##
DataAbilityHelper.
getFileTypes
getFileTypes(uri: string, mimeTypeFilter: string, callback: AsyncCallback
<Array
\<
string
>
>): void
获取支持的文件的MIME类型(callback形式)。
**系统能力:**
SystemCapability.Ability.AbilityRuntime.FAModel
**系统能力**
:SystemCapability.Ability.AbilityRuntime.FAModel
**参数:**
...
...
@@ -256,15 +242,13 @@ DAHelper.getFileTypes(
##
#
getFileTypes
##
DataAbilityHelper.
getFileTypes
getFileTypes(uri: string, mimeTypeFilter: string): Promise
\<
Array
\<
string>>
获取支持的文件的MIME类型(Promise形式)。
**系统能力:**
SystemCapability.Ability.AbilityRuntime.FAModel
**系统能力**
:SystemCapability.Ability.AbilityRuntime.FAModel
**参数:**
...
...
@@ -274,6 +258,7 @@ SystemCapability.Ability.AbilityRuntime.FAModel
| mimeTypeFilter | string | 是 | 指示要获取的文件的MIME类型。 |
**返回值:**
| 类型 | 说明 |
| ------------------------ | ------------------------ |
| Promise
\<
Array
\<
string>> | 返回匹配的MIME类型数组。 |
...
...
@@ -293,15 +278,13 @@ DAHelper.getFileTypes(
});
```
##
#
normalizeUri
##
DataAbilityHelper.
normalizeUri
normalizeUri(uri: string, callback: AsyncCallback
\<
string>): void
将引用数据功能的给定uri转换为规范化uri(callback形式)。
**系统能力:**
SystemCapability.Ability.AbilityRuntime.FAModel
**系统能力**
:SystemCapability.Ability.AbilityRuntime.FAModel
**参数:**
...
...
@@ -324,15 +307,13 @@ DAHelper.normalizeUri(
});
```
##
#
normalizeUri
##
DataAbilityHelper.
normalizeUri
normalizeUri(uri: string): Promise
\<
string>
将引用数据功能的给定uri转换为规范化uri(Promise形式)。
**系统能力:**
SystemCapability.Ability.AbilityRuntime.FAModel
**系统能力**
:SystemCapability.Ability.AbilityRuntime.FAModel
**参数:**
...
...
@@ -341,6 +322,7 @@ SystemCapability.Ability.AbilityRuntime.FAModel
| uri | string | 是 | 指示要规范化的uri对象。 |
**返回值:**
| 类型 | 说明 |
| ---------------- | ------------------------------------------------------ |
| Promise
\<
string> | 如果数据功能支持uri规范化,则返回规范化uri对象;否则返回null。 |
...
...
@@ -359,15 +341,13 @@ DAHelper.normalizeUri(
});
```
##
#
denormalizeUri
##
DataAbilityHelper.
denormalizeUri
denormalizeUri(uri: string, callback: AsyncCallback
\<
string>): void
将由normalizeUri(uri)生成的给定规范化uri转换为非规范化uri(callback形式)。
**系统能力:**
SystemCapability.Ability.AbilityRuntime.FAModel
**系统能力**
:SystemCapability.Ability.AbilityRuntime.FAModel
**参数:**
...
...
@@ -392,15 +372,13 @@ DAHelper.denormalizeUri(
##
#
denormalizeUri
##
DataAbilityHelper.
denormalizeUri
denormalizeUri(uri: string): Promise
\<
string>
将由normalizeUri(uri)生成的给定规范化uri转换为非规范化uri(Promise形式)。
**系统能力:**
SystemCapability.Ability.AbilityRuntime.FAModel
**系统能力**
:SystemCapability.Ability.AbilityRuntime.FAModel
**参数:**
...
...
@@ -409,6 +387,7 @@ SystemCapability.Ability.AbilityRuntime.FAModel
| uri | string | 是 | 指示要规范化的uri对象。 |
**返回值:**
| 类型 | 说明 |
| ---------------- | ----------------------------------------- |
| Promise
\<
string> | 如果反规范化成功,则返回反规范化uri对象。 |
...
...
@@ -427,15 +406,13 @@ DAHelper.denormalizeUri(
});
```
##
#
notifyChange
##
DataAbilityHelper.
notifyChange
notifyChange(uri: string, callback: AsyncCallback
\<
void>): void
通知已注册的观察者uri指定的数据资源的更改(callback形式)。
**系统能力:**
SystemCapability.Ability.AbilityRuntime.FAModel
**系统能力**
:SystemCapability.Ability.AbilityRuntime.FAModel
**参数:**
...
...
@@ -458,15 +435,13 @@ helper.notifyChange(
});
```
##
#
notifyChange
##
DataAbilityHelper.
notifyChange
notifyChange(uri: string): Promise
\<
void>
通知已注册的观察者uri指定的数据资源的更改(Promise形式)。
**系统能力:**
SystemCapability.Ability.AbilityRuntime.FAModel
**系统能力**
:SystemCapability.Ability.AbilityRuntime.FAModel
**参数:**
...
...
@@ -475,6 +450,7 @@ SystemCapability.Ability.AbilityRuntime.FAModel
| uri | string | 是 | 指示要操作的数据的路径。 |
**返回值:**
| 类型 | 说明 |
| -------------- | --------------------- |
| Promise
\<
void> | 返回值为Promise对象。 |
...
...
@@ -493,15 +469,13 @@ DAHelper.notifyChange(
});
```
##
#
insert
##
DataAbilityHelper.
insert
insert(uri: string, valuesBucket: rdb.ValuesBucket, callback: AsyncCallback
\<
number>): void
将单个数据记录插入数据库(callback形式)。
**系统能力:**
SystemCapability.Ability.AbilityRuntime.FAModel
**系统能力**
:SystemCapability.Ability.AbilityRuntime.FAModel
**参数:**
...
...
@@ -532,15 +506,13 @@ DAHelper.insert(
});
```
##
#
insert
##
DataAbilityHelper.
insert
insert(uri: string, valuesBucket: rdb.ValuesBucket): Promise
\<
number>
将单个数据记录插入数据库(Promise形式)。
**系统能力:**
SystemCapability.Ability.AbilityRuntime.FAModel
**系统能力**
:SystemCapability.Ability.AbilityRuntime.FAModel
**参数:**
...
...
@@ -550,6 +522,7 @@ SystemCapability.Ability.AbilityRuntime.FAModel
| valuesBucket | rdb.ValuesBucket | 是 | 指示要插入的数据记录。如果此参数为空,将插入一个空行。 |
**返回值:**
| 类型 | 说明 |
| ---------------- | ------------------------ |
| Promise
\<
number> | 返回插入数据记录的索引。 |
...
...
@@ -575,15 +548,13 @@ DAHelper.insert(
});
```
##
#
batchInsert
##
DataAbilityHelper.
batchInsert
batchInsert(uri: string, valuesBuckets: Array
<rdb.ValuesBucket>
, callback: AsyncCallback
\<
number>): void
插入数据库(callback形式)。
**系统能力:**
SystemCapability.Ability.AbilityRuntime.FAModel
**系统能力**
:SystemCapability.Ability.AbilityRuntime.FAModel
**参数:**
...
...
@@ -611,15 +582,13 @@ DAHelper.batchInsert(
});
```
##
#
batchInsert
##
DataAbilityHelper.
batchInsert
batchInsert(uri: string, valuesBuckets: Array
<rdb.ValuesBucket>
): Promise
\<
number>
将多个数据记录插入数据库(Promise形式)。
**系统能力:**
SystemCapability.Ability.AbilityRuntime.FAModel
**系统能力**
:SystemCapability.Ability.AbilityRuntime.FAModel
**参数:**
...
...
@@ -629,6 +598,7 @@ SystemCapability.Ability.AbilityRuntime.FAModel
| valuesBucket | Array
<rdb.ValuesBucket>
| 是 | 指示要插入的数据记录。 |
**返回值:**
| 类型 | 说明 |
| ---------------- | ---------------------- |
| Promise
\<
number> | 返回插入的数据记录数。 |
...
...
@@ -651,15 +621,13 @@ DAHelper.batchInsert(
});
```
##
#
delete
##
DataAbilityHelper.
delete
delete(uri: string, predicates: dataAbility.DataAbilityPredicates, callback: AsyncCallback
\<
number>): void
从数据库中删除一个或多个数据记录(callback形式)。
**系统能力:**
SystemCapability.Ability.AbilityRuntime.FAModel
**系统能力**
:SystemCapability.Ability.AbilityRuntime.FAModel
**参数:**
...
...
@@ -686,15 +654,13 @@ DAHelper.delete(
});
```
##
#
delete
##
DataAbilityHelper.
delete
delete(uri: string, predicates: dataAbility.DataAbilityPredicates): Promise
\<
number>
从数据库中删除一个或多个数据记录(Promise形式)。
**系统能力:**
SystemCapability.Ability.AbilityRuntime.FAModel
**系统能力**
:SystemCapability.Ability.AbilityRuntime.FAModel
**参数:**
...
...
@@ -704,6 +670,7 @@ SystemCapability.Ability.AbilityRuntime.FAModel
| valuesBucket | dataAbility.DataAbilityPredicates | 是 | 指示筛选条件。当此参数为null时,应定义处理逻辑。 |
**返回值:**
| 类型 | 说明 |
| ---------------- | ------------------------ |
| Promise
\<
number> | 返回已删除的数据记录数。 |
...
...
@@ -724,15 +691,13 @@ DAHelper.delete(
});
```
##
#
update
##
DataAbilityHelper.
update
update(uri: string, valuesBucket: rdb.ValuesBucket, predicates: dataAbility.DataAbilityPredicates, callback: AsyncCallback
\<
number>): void
更新数据库中的数据记录(callback形式)。
**系统能力:**
SystemCapability.Ability.AbilityRuntime.FAModel
**系统能力**
:SystemCapability.Ability.AbilityRuntime.FAModel
**参数:**
...
...
@@ -767,15 +732,13 @@ DAHelper.update(
});
```
##
#
update
##
DataAbilityHelper.
update
update(uri: string, valuesBucket: rdb.ValuesBucket, predicates: dataAbility.DataAbilityPredicates): Promise
\<
number>
更新数据库中的数据记录(Promise形式)。
**系统能力:**
SystemCapability.Ability.AbilityRuntime.FAModel
**系统能力**
:SystemCapability.Ability.AbilityRuntime.FAModel
**参数:**
...
...
@@ -786,6 +749,7 @@ SystemCapability.Ability.AbilityRuntime.FAModel
| predicates | dataAbility.DataAbilityPredicates | 是 | 指示筛选条件。当此参数为null时,应定义处理逻辑。 |
**返回值:**
| 类型 | 说明 |
| ---------------- | -------------------------------------------- |
| Promise
\<
number> | 返回值为Promise对象,Promise中包含应用信息。 |
...
...
@@ -814,15 +778,13 @@ DAHelper.update(
});
```
##
#
query
##
DataAbilityHelper.
query
query(uri: string, columns: Array
\<
string>, predicates: dataAbility.DataAbilityPredicates, callback: AsyncCallback
\<
ResultSet>): void
查询数据库中的数据(callback形式)。
**系统能力:**
SystemCapability.Ability.AbilityRuntime.FAModel
**系统能力**
:SystemCapability.Ability.AbilityRuntime.FAModel
**参数:**
...
...
@@ -854,15 +816,13 @@ DAHelper.query(
##
#
query
##
DataAbilityHelper.
query
query(uri: string, columns: Array
\<
string>, predicates: dataAbility.DataAbilityPredicates): Promise
\<
ResultSet>
查询数据库中的数据(Promise形式)。
**系统能力:**
SystemCapability.Ability.AbilityRuntime.FAModel
**系统能力**
:SystemCapability.Ability.AbilityRuntime.FAModel
**参数:**
...
...
@@ -873,6 +833,7 @@ SystemCapability.Ability.AbilityRuntime.FAModel
| predicates | dataAbility.DataAbilityPredicates | 是 | 指示筛选条件。当此参数为null时,应定义处理逻辑。 |
**返回值:**
| 类型 | 说明 |
| ------------------- | -------------- |
| Promise
\<
ResultSet> | 返回查询结果。 |
...
...
zh-cn/application-dev/reference/apis/js-apis-eventhub.md
浏览文件 @
3777db35
...
...
@@ -20,7 +20,7 @@
```
```
js
import
Ability
from
'
@ohos.application.Ability
'
export
default
class
MainAbility
extends
Ability
{
onForeground
()
{
...
...
@@ -30,25 +30,24 @@ export default class MainAbility extends Ability {
```
## on
##
EventHub.
on
on(event: string, callback: Function): void;
订阅指定事件。
**系统能力
:**
**系统能力
**
:SystemCapability.Ability.AbilityRuntime.Core
SystemCapability.Ability.AbilityRuntime.Core
**参数:**
-
参数:
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| event | string | 是 | 事件名称。 |
| callback | Function | 是 | 事件回调,事件触发后运行。 |
-
示例:
**示例:**
```
```
js
import
Ability
from
'
@ohos.application.Ability
'
export
default
class
MainAbility
extends
Ability
{
...
...
@@ -69,25 +68,24 @@ SystemCapability.Ability.AbilityRuntime.Core
```
## off
##
EventHub.
off
off(event: string, callback?: Function): void;
取消订阅指定事件。当callback传值时,取消订阅指定的callback;未传值时,取消订阅该事件下所有callback。
**系统能力
:**
**系统能力
**
:SystemCapability.Ability.AbilityRuntime.Core
SystemCapability.Ability.AbilityRuntime.Core
**参数:**
-
参数:
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| event | string | 是 | 事件名称。 |
| callback | Function | 否 | 事件回调。如果不传callback,则取消订阅该事件下所有callback。 |
-
示例:
**示例:**
```
```
js
import
Ability
from
'
@ohos.application.Ability
'
export
default
class
MainAbility
extends
Ability
{
...
...
@@ -108,25 +106,24 @@ SystemCapability.Ability.AbilityRuntime.Core
```
## emit
##
EventHub.
emit
emit(event: string, ...args: Object[]): void;
触发指定事件。
**系统能力
:**
**系统能力
**
:SystemCapability.Ability.AbilityRuntime.Core
SystemCapability.Ability.AbilityRuntime.Core
**参数:**
-
参数:
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| event | string | 是 | 事件名称。 |
| ...args | Object[] | 是 | 可变参数,事件触发时,传递给回调函数的参数。 |
-
示例:
**示例:**
```
```
js
import
Ability
from
'
@ohos.application.Ability
'
export
default
class
MainAbility
extends
Ability
{
...
...
zh-cn/application-dev/reference/apis/js-apis-extension-context.md
浏览文件 @
3777db35
...
...
@@ -11,4 +11,4 @@ Extension的上下文环境,继承自Context。
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| currentHapModuleInfo | HapModuleInfo | 是 | 否 | 当前Hap包的信息。
<br
><b>
系统能力:
</b>
SystemCapability.Ability.AbilityRuntime.Core
|
| currentHapModuleInfo | HapModuleInfo | 是 | 否 | 当前Hap包的信息。
<br
/>
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
|
zh-cn/application-dev/reference/apis/js-apis-featureAbility.md
浏览文件 @
3777db35
此差异已折叠。
点击以展开。
zh-cn/application-dev/reference/apis/js-apis-formbindingdata.md
浏览文件 @
3777db35
...
...
@@ -19,33 +19,37 @@ createFormBindingData(obj?: Object | string): FormBindingData
创建一个FormBindingData对象。
-
参数:
**系统能力**
:SystemCapability.Ability.Form
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | -------------- | ---- | ------------------------------------------------------------ |
| obj | Object或string | 否 | js卡片要展示的数据。可以是包含若干键值对的Object或者 json 格式的字符串。 |
-
返回值:
**返回值:**
| 类型 | 说明 |
| ----------------------------------- | --------------------------------------- |
|
[
FormBindingData
](
#formbindingdata
)
| 根据传入数据创建的FormBindingData对象。 |
**示例:**
-
示例:
```
```
js
let
obj
=
{
"
temperature
"
:
"
21°
"
};
let
formBindingDataObj
=
formBindingData
.
createFormBindingData
(
obj
);
```
## FormBindingData
##
formBindingData.
FormBindingData
FormBindingData相关描述。
**系统能力**
:SystemCapability.Ability.Form
**参数:**
| 名称 | 类型 | 说明 |
| ---- | -------------- | ------------------------------------------------------------ |
| obj | Object或string | js卡片要展示的数据。可以是包含若干键值对的Object或者 json 格式的字符串。 |
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-formextension.md
浏览文件 @
3777db35
...
...
@@ -19,7 +19,7 @@ import FormExtension from '@ohos.application.FormExtension';
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| ------- | ------------------------------------------------------- | ---- | ---- | --------------------------------------------------- |
| context |
[
FormExtensionContext
](
js-apis-formextensioncontext.md
)
| 是 | 否 | FormExtension的上下文环境,继承自ExtensionContext。 |
| context |
[
FormExtensionContext
](
js-apis-formextensioncontext.md
)
| 是 | 否 | FormExtension的上下文环境,继承自ExtensionContext。
<br/>
**系统能力**
:SystemCapability.Ability.Form
|
## onCreate
...
...
@@ -27,21 +27,23 @@ onCreate(want: Want): formBindingData.FormBindingData
卡片提供方接收创建卡片的通知接口。
-
参数:
**系统能力**
:SystemCapability.Ability.Form
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | -------------------------------------- | ---- | ------------------------------------------------------------ |
| want |
[
Want
](
js-apis-featureAbility.md#want
)
| 是 | 当前Extension相关的Want类型信息,包括卡片ID、卡片名称、卡片样式等。这些卡片信息必须作为持久数据进行管理,以便后续更新和删除卡片。 |
-
返回值:
**返回值:**
| 类型 | 说明 |
| ------------------------------------------------------------ | ----------------------------------------------------------- |
|
[
formBindingData.FormBindingData
](
js-apis-formbindingdata.md#formbindingdata
)
| 一个formBindingData.FormBindingData对象,卡片要显示的数据。 |
-
示例:
**示例:**
```
```
js
export
default
class
MyFormExtension
extends
FormExtension
{
onCreate
(
want
)
{
console
.
log
(
'
FormExtension onCreate, want:
'
+
want
.
abilityName
);
...
...
@@ -55,19 +57,21 @@ onCreate(want: Want): formBindingData.FormBindingData
}
```
## onCastToNormal
##
FormExtension.
onCastToNormal
onCastToNormal(formId: string): void
卡片提供方接收临时卡片转常态卡片的通知接口。
-
参数:
**系统能力**
:SystemCapability.Ability.Form
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------------------------ |
| formId | string | 是 | 请求转换为常态的卡片ID。 |
-
示例:
**示例:**
```
export default class MyFormExtension extends FormExtension {
...
...
@@ -77,21 +81,23 @@ onCastToNormal(formId: string): void
}
```
## onUpdate
##
FormExtension.
onUpdate
onUpdate(formId: string): void
卡片提供方接收更新卡片的通知接口。获取最新数据后调用
[
FormExtensionContext
](
js-apis-formextensioncontext.md
)
的updateForm接口刷新卡片数据。
-
参数:
**系统能力**
:SystemCapability.Ability.Form
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------------------ |
| formId | string | 是 | 请求更新的卡片ID。 |
-
示例:
**示例:**
```
```
js
export
default
class
MyFormExtension
extends
FormExtension
{
onUpdate
(
formId
)
{
console
.
log
(
'
FormExtension onUpdate, formId:
'
+
formId
);
...
...
@@ -105,21 +111,23 @@ onUpdate(formId: string): void
}
```
## onVisibilityChange
##
FormExtension.
onVisibilityChange
onVisibilityChange(newStatus: { [key: string]: number }): void
卡片提供方接收修改可见性的通知接口。
-
参数:
**系统能力**
:SystemCapability.Ability.Form
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| --------- | ------------------------- | ---- | ---------------------------- |
| newStatus | { [key: string]: number } | 是 | 请求修改的卡片ID和可见状态。 |
-
示例:
**示例:**
```
```
js
export
default
class
MyFormExtension
extends
FormExtension
{
onVisibilityChange
(
newStatus
)
{
console
.
log
(
'
FormExtension onVisibilityChange, newStatus:
'
+
newStatus
);
...
...
@@ -137,22 +145,24 @@ onVisibilityChange(newStatus: { [key: string]: number }): void
}
```
## onEvent
##
FormExtension.
onEvent
onEvent(formId: string, message: string): void
卡片提供方接收处理卡片事件的通知接口。
-
参数:
**系统能力**
:SystemCapability.Ability.Form
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------ | ---- | ---------------------- |
| formId | string | 是 | 请求触发事件的卡片ID。 |
| message | string | 是 | 事件消息。 |
-
示例:
**示例:**
```
```
js
export
default
class
MyFormExtension
extends
FormExtension
{
onEvent
(
formId
,
message
)
{
console
.
log
(
'
FormExtension onEvent, formId:
'
+
formId
+
"
, message:
"
+
message
);
...
...
@@ -160,21 +170,23 @@ onEvent(formId: string, message: string): void
}
```
## onDestroy
##
FormExtension.
onDestroy
onDestroy(formId: string): void
卡片提供方接收销毁卡片的通知接口。
-
参数:
**系统能力**
:SystemCapability.Ability.Form
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------------------ |
| formId | string | 是 | 请求销毁的卡片ID。 |
-
示例:
**示例:**
```
```
js
export
default
class
MyFormExtension
extends
FormExtension
{
onDestroy
(
formId
)
{
console
.
log
(
'
FormExtension onDestroy, formId:
'
+
formId
);
...
...
zh-cn/application-dev/reference/apis/js-apis-formextensioncontext.md
浏览文件 @
3777db35
...
...
@@ -5,13 +5,15 @@
FormExtension的上下文环境,提供FormExtension具有的能力和接口,继承自ExtensionContext。
## updateForm
##
FormExtensionContext.
updateForm
updateForm(formId: string, formBindingData: formBindingData.FormBindingData, callback: AsyncCallback
\<
void>): void
主动更新卡片。
-
参数:
**系统能力**
:SystemCapability.Ability.Form
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| --------------- | ------------------------------------------------------------ | ---- | -------------------------------------- |
...
...
@@ -19,35 +21,37 @@ updateForm(formId: string, formBindingData: formBindingData.FormBindingData, cal
| formBindingData |
[
formBindingData.FormBindingData
](
js-apis-formbindingdata.md#formbindingdata
)
| 是 | 卡片新的数据。 |
| callback | AsyncCallback
\<
void> | 是 | 回调函数,返回接口调用是否成功的结果。 |
-
示例:
**示例:**
```
```
js
let
obj2
=
formBindingData
.
createFormBindingData
({
temperature
:
"
22c
"
,
time
:
"
22:00
"
});
this
.
context
.
updateForm
(
formId
,
obj2
,
(
data
)
=>
{
console
.
log
(
'
FormExtension context updateForm, data:
'
+
data
);
});
```
## updateForm
##
FormExtensionContext.
updateForm
updateForm(formId: string, formBindingData: formBindingData.FormBindingData): Promise
\<
void>
更新卡片。
-
参数:
**系统能力**
:SystemCapability.Ability.Form
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| --------------- | ------------------------------------------------------------ | ---- | ------------------ |
| formId | string | 是 | 请求更新的卡片ID。 |
| formBindingData |
[
formBindingData.FormBindingData
](
js-apis-formbindingdata.md#formbindingdata
)
| 是 | 卡片新的数据。 |
-
返回值:
**返回值:**
| 类型 | 说明 |
| -------------- | --------------------------------- |
| Promise
\<
void> | 返回一个Promise,包含接口的结果。 |
-
示例:
**示例:**
```
let obj2 = formBindingData.createFormBindingData({temperature:"22c", time:"22:00"});
...
...
zh-cn/application-dev/reference/apis/js-apis-missionManager.md
浏览文件 @
3777db35
...
...
@@ -16,25 +16,29 @@ import missionManager from '@ohos.application.missionManager'
```
## registerMissionListener
##
missionManager.
registerMissionListener
function registerMissionListener(listener: MissionListener): number;
注册系统任务状态监听。
-
参数:
| 参数名 | 类型 | 必填 | 说明 |
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Mission
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| listener | MissionListener | 是 | 系统任务监听方法。 |
-
返回值:
| 类型 | 说明 |
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
| number | 监听方法的index值,由系统创建,在注册系统任务状态监听时分配,和监听方法一一对应
。 |
-
示例:
**示例:**
```
```
js
var
listener
=
{
onMissionCreated
:
this
.
onMissionCreatedCallback
,
onMissionDestroyed
:
this
.
onMissionDestroyedCallback
,
...
...
@@ -47,21 +51,24 @@ function registerMissionListener(listener: MissionListener): number;
```
## unregisterMissionListener
##
missionManager.
unregisterMissionListener
function unregisterMissionListener(listenerId: number, callback: AsyncCallback
<
void
>
): void;
取消任务状态监听。
-
参数:
| 参数名 | 类型 | 必填 | 说明 |
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Mission
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| listenerId | number | 是 | 系统任务状态监听方法的index值,和监听方法一一对应,由registerMissionListener方法返回。 |
| callback | AsyncCallback
<
void
>
| 是 | 执行结果回调函数。 |
-
示例:
**示例:**
```
```
js
var
listener
=
{
onMissionCreated
:
this
.
onMissionCreatedCallback
,
onMissionDestroyed
:
this
.
onMissionDestroyedCallback
,
...
...
@@ -77,20 +84,23 @@ function unregisterMissionListener(listenerId: number, callback: AsyncCallback&l
```
## unregisterMissionListener
##
missionManager.
unregisterMissionListener
function unregisterMissionListener(listenerId: number): Promise
<
void
>
;
取消任务状态监听,以promise方式返回执行结果。
-
参数:
| 参数名 | 类型 | 必填 | 说明 |
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Mission
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| listenerId | number | 是 | 系统任务状态监听方法的index值,和监听方法一一对应,由registerMissionListener方法返回。 |
-
示例:
**示例:**
```
```
js
var
listener
=
{
onMissionCreated
:
this
.
onMissionCreatedCallback
,
onMissionDestroyed
:
this
.
onMissionDestroyedCallback
,
...
...
@@ -106,22 +116,25 @@ function unregisterMissionListener(listenerId: number): Promise<void>;
```
## getMissionInfo
##
missionManager.
getMissionInfo
function getMissionInfo(deviceId: string, missionId: number, callback: AsyncCallback
<
MissionInfo
>
): void;
获取任务信息,以异步回调的方式返回任务信息。
-
参数:
| 参数名 | 类型 | 必填 | 说明 |
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Mission
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| deviceId | string | 是 | 设备ID,本机默认为空字符串。 |
| missionId | number | 是 | 任务ID。 |
| callback | AsyncCallback
<
MissionInfo
>
| 是 | 执行结果回调函数,返回任务信息。 |
-
示例:
**示例:**
```
```
js
import
missionManager
from
'
@ohos.application.missionManager
'
missionManager
.
getMissionInfo
(
""
,
allMissions
[
0
].
missionId
,
(
error
,
mission
)
=>
{
...
...
@@ -136,26 +149,30 @@ function getMissionInfo(deviceId: string, missionId: number, callback: AsyncCall
```
## getMissionInfo
##
missionManager.
getMissionInfo
function getMissionInfo(deviceId: string, missionId: number): Promise
<
MissionInfo
>
;
获取任务信息,以promise方式返回任务信息。
-
参数:
| 参数名 | 类型 | 必填 | 说明 |
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Mission
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| deviceId | string | 是 | 设备ID,本机默认为空字符串。 |
| missionId | number | 是 | 任务ID。 |
-
返回值:
| 类型 | 说明 |
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
|
[
MissionInfo
](
js-apis-application-MissionInfo.md
)
| 任务信息。 |
-
示例:
**示例:**
```
```
js
import
missionManager
from
'
@ohos.application.missionManager
'
var
mission
=
await
missionManager
.
getMissionInfo
(
""
,
id
).
catch
(
function
(
err
){
...
...
@@ -164,22 +181,25 @@ function getMissionInfo(deviceId: string, missionId: number): Promise<Mission
```
## getMissionInfos
##
missionManager.
getMissionInfos
function getMissionInfos(deviceId: string, numMax: number, callback: AsyncCallback
<
Array
<
MissionInfo
>>
): void;
获取所有任务信息,以回调函数的方式返回任务信息数组。
-
参数:
| 参数名 | 类型 | 必填 | 说明 |
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Mission
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| deviceId | string | 是 | 设备ID,本机默认为空字符串。 |
| numMax | number | 是 | 任务信息数量上限。 |
| callback | AsyncCallback
<
Array
<
[MissionInfo](js-apis-application-MissionInfo.md)
>>
| 是 | 执行结果回调函数,返回任务信息数组。 |
-
示例:
**示例:**
```
```
js
import
missionManager
from
'
@ohos.application.missionManager
'
missionManager
.
getMissionInfos
(
""
,
10
,
(
error
,
missions
)
=>
{
...
...
@@ -190,26 +210,30 @@ function getMissionInfos(deviceId: string, numMax: number, callback: AsyncCallba
```
## getMissionInfos
##
missionManager.
getMissionInfos
function getMissionInfos(deviceId: string, numMax: number): Promise
<
Array
<
MissionInfo
>>
;
获取所有任务信息,以promise的方式返回任务信息数组。
-
参数:
| 参数名 | 类型 | 必填 | 说明 |
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Mission
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| deviceId | string | 是 | 设备ID,本机默认为空字符串。 |
| numMax | number | 是 | 任务信息数量上限。 |
-
返回值:
| 类型 | 说明 |
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
| Array
<
MissionInfo
>
| 任务信息数组。 |
-
示例:
**示例:**
```
```
js
import
missionManager
from
'
@ohos.application.missionManager
'
var
allMissions
=
await
missionManager
.
getMissionInfos
(
""
,
10
).
catch
(
function
(
err
){
...
...
@@ -218,22 +242,25 @@ function getMissionInfos(deviceId: string, numMax: number): Promise<Array<
```
## getMissionSnapShot
##
missionManager.
getMissionSnapShot
function getMissionSnapShot(deviceId: string, missionId: number, callback: AsyncCallback
<
MissionSnapshot
>
): void;
获取任务快照,以回调函数的方式返回快照内容。
-
参数:
| 参数名 | 类型 | 必填 | 说明 |
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Mission
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| deviceId | string | 是 | 设备ID,本机默认为空字符串。 |
| missionId | number | 是 | 任务ID。 |
| callback | AsyncCallback
<
[MissionSnapshot](js-apis-application-MissionSnapshot.md)
>
| 是 | 执行结果回调函数,返回任务快照信息。 |
-
示例:
**示例:**
```
```
js
import
missionManager
from
'
@ohos.application.missionManager
'
missionManager
.
getMissionInfos
(
""
,
10
,
(
error
,
missions
)
=>
{
...
...
@@ -250,26 +277,30 @@ function getMissionSnapShot(deviceId: string, missionId: number, callback: Async
```
## getMissionSnapShot
##
missionManager.
getMissionSnapShot
function getMissionSnapShot(deviceId: string, missionId: number): Promise
<
MissionSnapshot
>
;
获取任务快照,以promise的方式返回快照内容。
-
参数:
| 参数名 | 类型 | 必填 | 说明 |
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Mission
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| deviceId | string | 是 | 设备ID,本机默认为空字符串。 |
| missionId | number | 是 | 任务ID。 |
-
返回值:
| 类型 | 说明 |
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
| MissionSnapshot | 任务快照信息。 |
-
示例:
**示例:**
```
```
js
import
missionManager
from
'
@ohos.application.missionManager
'
var
allMissions
=
await
missionManager
.
getMissionInfos
(
""
,
10
).
catch
(
function
(
err
){
...
...
@@ -284,21 +315,24 @@ function getMissionSnapShot(deviceId: string, missionId: number): Promise<Mis
```
## lockMission
##
missionManager.
lockMission
function lockMission(missionId: number, callback: AsyncCallback
<
void
>
): void;
锁定指定任务id的任务,以回调函数的方式返回。
-
参数:
| 参数名 | 类型 | 必填 | 说明 |
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Mission
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| missionId | number | 是 | 任务ID。 |
| callback | AsyncCallback
<
void
>
| 是 | 执行结果回调函数。 |
-
示例:
**示例:**
```
```
js
import
missionManager
from
'
@ohos.application.missionManager
'
missionManager
.
getMissionInfos
(
""
,
10
,
(
error
,
missions
)
=>
{
...
...
@@ -314,20 +348,23 @@ function lockMission(missionId: number, callback: AsyncCallback<void>): vo
```
## lockMission
##
missionManager.
lockMission
function lockMission(missionId: number): Promise
<
void
>
;
锁定指定任务id的任务,以promise方式返回。
-
参数:
| 参数名 | 类型 | 必填 | 说明 |
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Mission
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| missionId | number | 是 | 任务ID。 |
-
示例:
**示例:**
```
```
js
import
missionManager
from
'
@ohos.application.missionManager
'
var
allMissions
=
await
missionManager
.
getMissionInfos
(
""
,
10
).
catch
(
function
(
err
){
...
...
@@ -343,20 +380,23 @@ function lockMission(missionId: number): Promise<void>;
```
## unlockMission
##
missionManager.
unlockMission
function unlockMission(missionId: number, callback: AsyncCallback
<
void
>
): void;
解锁指定任务id的任务,以回调函数的方式返回。
-
参数:
| 参数名 | 类型 | 必填 | 说明 |
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Mission
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| missionId | number | 是 | 任务ID。 |
-
示例:
**示例:**
```
```
js
import
missionManager
from
'
@ohos.application.missionManager
'
missionManager
.
getMissionInfos
(
""
,
10
,
(
error
,
missions
)
=>
{
...
...
@@ -372,20 +412,23 @@ function unlockMission(missionId: number, callback: AsyncCallback<void>):
```
## unlockMission
##
missionManager.
unlockMission
function unlockMission(missionId: number): Promise
<
void
>
;
解锁指定任务id的任务,以promise的方式返回。
-
参数:
| 参数名 | 类型 | 必填 | 说明 |
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Mission
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| missionId | number | 是 | 任务ID。 |
-
示例:
**示例:**
```
```
js
import
missionManager
from
'
@ohos.application.missionManager
'
var
allMissions
=
await
missionManager
.
getMissionInfos
(
""
,
10
).
catch
(
function
(
err
){
...
...
@@ -404,21 +447,24 @@ function unlockMission(missionId: number): Promise<void>;
```
## clearMission
##
missionManager.
clearMission
function clearMission(missionId: number, callback: AsyncCallback
<
void
>
): void;
清理指定任务id的任务,无论该任务是否被锁定,以回调函数的方式返回。
-
参数:
| 参数名 | 类型 | 必填 | 说明 |
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Mission
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| missionId | number | 是 | 任务ID。 |
| callback | AsyncCallback
<
void
>
| 是 | 执行结果回调函数。 |
-
示例:
**示例:**
```
```
js
import
missionManager
from
'
@ohos.application.missionManager
'
missionManager
.
getMissionInfos
(
""
,
10
,
(
error
,
missions
)
=>
{
...
...
@@ -434,20 +480,23 @@ function clearMission(missionId: number, callback: AsyncCallback<void>): v
```
## clearMission
##
missionManager.
clearMission
function clearMission(missionId: number): Promise
<
void
>
;
清理指定任务id的任务,无论该任务是否被锁定,以promise的方式返回。
-
参数:
| 参数名 | 类型 | 必填 | 说明 |
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Mission
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| missionId | number | 是 | 任务ID。 |
-
示例:
**示例:**
```
```
js
import
missionManager
from
'
@ohos.application.missionManager
'
var
allMissions
=
await
missionManager
.
getMissionInfos
(
""
,
10
).
catch
(
function
(
err
){
...
...
@@ -463,15 +512,17 @@ function clearMission(missionId: number): Promise<void>;
```
## clearAllMissions
##
missionManager.
clearAllMissions
function clearAllMissions(callback: AsyncCallback
<
void
>
): void;
清理所有未锁定的任务,以回调函数的方式返回。
-
示例:
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Mission
```
**示例:**
```
js
import
missionManager
from
'
@ohos.application.missionManager
'
missionManager
.
clearAllMissions
().
then
(()
=>
{
...
...
@@ -480,15 +531,17 @@ function clearAllMissions(callback: AsyncCallback<void>): void;
```
## clearAllMissions
##
missionManager.
clearAllMissions
function clearAllMissions(): Promise
<
void
>
;
清理所有未锁定的任务,以promise的方式返回。
-
示例:
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Mission
```
**示例:**
```
js
import
missionManager
from
'
@ohos.application.missionManager
'
await
missionManager
.
clearAllMissions
().
catch
(
function
(
err
){
console
.
log
(
err
);
...
...
@@ -496,21 +549,24 @@ function clearAllMissions(): Promise<void>;
```
## moveMissionToFront
## m
issionManager.m
oveMissionToFront
function moveMissionToFront(missionId: number, callback: AsyncCallback
<
void
>
): void;
把指定任务id的任务切到前台,以回调函数的方式返回。
-
参数:
| 参数名 | 类型 | 必填 | 说明 |
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Mission
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| missionId | number | 是 | 任务ID。 |
| callback | AsyncCallback
<
void
>
| 是 | 执行结果回调函数。 |
-
示例:
**示例:**
```
```
js
import
missionManager
from
'
@ohos.application.missionManager
'
missionManager
.
getMissionInfos
(
""
,
10
,
(
error
,
missions
)
=>
{
...
...
@@ -526,22 +582,25 @@ function moveMissionToFront(missionId: number, callback: AsyncCallback<void&g
```
## moveMissionToFront
## m
issionManager.m
oveMissionToFront
function moveMissionToFront(missionId: number, options: StartOptions, callback: AsyncCallback
<
void
>
): void;
把指定任务id的任务切到前台,同时指定任务切换到前台时的启动参数,例如窗口模式、设备ID等,以回调函数的方式返回。
-
参数:
| 参数名 | 类型 | 必填 | 说明 |
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Mission
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| missionId | number | 是 | 任务ID。 |
| options | StartOptions | 是 | 启动参数选项,用于指定任务切到前台时的窗口模式,设备ID等。 |
| callback | AsyncCallback
<
void
>
| 是 | 执行结果回调函数。 |
-
示例:
**示例:**
```
```
js
import
missionManager
from
'
@ohos.application.missionManager
'
missionManager
.
getMissionInfos
(
""
,
10
,
(
error
,
missions
)
=>
{
...
...
@@ -557,21 +616,24 @@ function moveMissionToFront(missionId: number, options: StartOptions, callback:
```
## moveMissionToFront
## m
issionManager.m
oveMissionToFront
function moveMissionToFront(missionId: number, options?: StartOptions): Promise
<
void
>
;
把指定任务id的任务切到前台,以promise的方式返回。
-
参数:
| 参数名 | 类型 | 必填 | 说明 |
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Mission
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| missionId | number | 是 | 任务ID。 |
| options | StartOptions | 否 | 启动参数选项,用于指定任务切到前台时的窗口模式,设备ID等。 |
-
示例:
**示例:**
```
```
js
import
missionManager
from
'
@ohos.application.missionManager
'
var
allMissions
=
await
missionManager
.
getMissionInfos
(
""
,
10
).
catch
(
function
(
err
){
...
...
zh-cn/application-dev/reference/apis/js-apis-particleAbility.md
浏览文件 @
3777db35
此差异已折叠。
点击以展开。
zh-cn/application-dev/reference/apis/js-apis-permissionrequestresult.md
浏览文件 @
3777db35
...
...
@@ -14,5 +14,5 @@
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| permissions | Array
<
string
>
| 是 | 否 | 用户传入的权限。
<br
><b>
系统能力:
</b>
SystemCapability.Ability.AbilityRuntime.Core|
| authResults | Array
<
number
>
| 是 | 否 | 相应请求权限的结果。0表示授权成功,-1表示失败。
<br
><b>
系统能力:
</b>
SystemCapability.Ability.AbilityRuntime.Core |
| permissions | Array
<
string
>
| 是 | 否 | 用户传入的权限。
<br
/>
**系统能力**
:
SystemCapability.Ability.AbilityRuntime.Core|
| authResults | Array
<
number
>
| 是 | 否 | 相应请求权限的结果。0表示授权成功,-1表示失败。
<br
/>
**系统能力**
:
SystemCapability.Ability.AbilityRuntime.Core |
zh-cn/application-dev/reference/apis/js-apis-processrunninginfo.md
浏览文件 @
3777db35
...
...
@@ -18,7 +18,7 @@
```
```
js
import
appManager
from
'
@ohos.application.appManager
'
;
appManager
.
getProcessRunningInfos
((
error
,
data
)
=>
{
console
.
log
(
"
getProcessRunningInfos error:
"
+
error
.
code
+
"
data:
"
+
JSON
.
stringify
(
data
));
...
...
@@ -30,7 +30,7 @@ appManager.getProcessRunningInfos((error,data) => {
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| pid | number | 是 | 否 | 进程ID。
<br
><b>
系统能力:
</b>
SystemCapability.Ability.AbilityRuntime.Core |
| uid | number | 是 | 否 | 用户ID。
<br
><b>
系统能力:
</b>
SystemCapability.Ability.AbilityRuntime.Core |
| processName | string | 是 | 否 | 进程名称。
<br
><b>
系统能力:
</b>
SystemCapability.Ability.AbilityRuntime.Core |
| bundleNames | Array
<
string
>
| 是 | 否 | 进程中所有运行的包名称。
<br
><b>
系统能力:
</b>
SystemCapability.Ability.AbilityRuntime.Core |
| pid | number | 是 | 否 | 进程ID。
<br
/>
**系统能力**
:
SystemCapability.Ability.AbilityRuntime.Core |
| uid | number | 是 | 否 | 用户ID。
<br
/>
**系统能力**
:
SystemCapability.Ability.AbilityRuntime.Core |
| processName | string | 是 | 否 | 进程名称。
<br
/>
**系统能力**
:
SystemCapability.Ability.AbilityRuntime.Core |
| bundleNames | Array
<
string
>
| 是 | 否 | 进程中所有运行的包名称。
<br
/>
**系统能力**
:
SystemCapability.Ability.AbilityRuntime.Core |
zh-cn/application-dev/reference/apis/js-apis-service-extension-context.md
浏览文件 @
3777db35
...
...
@@ -9,25 +9,22 @@ ServiceExtension的上下文环境,提供ServiceExtension具有的能力和接
## startAbility
startAbility(want: Want, callback: AsyncCallback
<
void
>
): void;
启动Ability。
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
**系统能力:**
SystemCapability.Ability.AbilityRuntime.Core
**参数:**
-
参数:
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want |
[
Want
](
js-apis-featureAbility.md#Want类型说明
)
| 是 | Want类型参数,传入需要启动的ability的信息,如ability名称,包名等。 |
| callback | AsyncCallback
<
void
>
| 否 | 回调函数,返回接口调用是否成功的结果。 |
-
示例:
```
**示例:**
```
js
let
want
=
{
"
bundleName
"
:
"
com.example.myapp
"
,
"
abilityName
"
:
"
com.example.myapp.MyAbility
"
...
...
@@ -38,28 +35,29 @@ SystemCapability.Ability.AbilityRuntime.Core
```
## startAbility
##
ServiceExtensionContext.
startAbility
startAbility(want: Want): Promise
<
void
>
;
启动Ability。通过Promise返回结果。
**系统能力
:**
**系统能力
**
:SystemCapability.Ability.AbilityRuntime.Core
SystemCapability.Ability.AbilityRuntime.Core
**参数:**
-
参数:
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want |
[
Want
](
js-apis-featureAbility.md#Want类型说明
)
| 是 | Want类型参数,传入需要启动的ability的信息,如ability名称,包名等。 |
-
返回值:
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
| Promise
<
void
>
| 返回一个Promise,包含接口的结果。 |
-
示例:
```
**示例:**
```
js
let
want
=
{
"
bundleName
"
:
"
com.example.myapp
"
,
"
abilityName
"
:
"
com.example.myapp.MyAbility
"
...
...
@@ -72,46 +70,46 @@ SystemCapability.Ability.AbilityRuntime.Core
```
## terminateSelf
##
ServiceExtensionContext.
terminateSelf
terminateSelf(callback: AsyncCallback
<
void
>
): void;
停止Ability自身。
**系统能力
:**
**系统能力
**
:SystemCapability.Ability.AbilityRuntime.Core
SystemCapability.Ability.AbilityRuntime.Core
**参数:**
-
参数:
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| callback | AsyncCallback
<
void
>
| 否 | 回调函数,返回接口调用是否成功的结果。 |
-
示例:
```
**示例:**
```
js
this
.
context
.
terminateSelf
((
err
)
=>
{
console
.
log
(
'
terminateSelf result:
'
+
JSON
.
stringfy
(
err
));
});
```
## terminateSelf
##
ServiceExtensionContext.
terminateSelf
terminateSelf(): Promise
<
void
>
;
停止自身。通过Promise返回结果。
**系统能力
:**
**系统能力
**
:SystemCapability.Ability.AbilityRuntime.Core
SystemCapability.Ability.AbilityRuntime.Core
**返回值:**
-
返回值:
| 类型 | 说明 |
| -------- | -------- |
| Promise
<
void
>
| 返回一个Promise,包含接口的结果。 |
-
示例:
```
**示例:**
```
js
this
.
context
.
terminateSelf
(
want
).
then
((
data
)
=>
{
console
.
log
(
'
success:
'
+
JSON
.
stringfy
(
data
));
}).
catch
((
error
)
=>
{
...
...
@@ -120,29 +118,30 @@ SystemCapability.Ability.AbilityRuntime.Core
```
## connectAbility
##
ServiceExtensionContext.
connectAbility
connectAbility(want: Want, options: ConnectOptions): number;
将一个Ability与服务类型的Ability绑定。
**系统能力
:**
**系统能力
**
:SystemCapability.Ability.AbilityRuntime.Core
SystemCapability.Ability.AbilityRuntime.Core
**参数:**
-
参数:
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want |
[
Want
](
js-apis-featureAbility.md#Want类型说明
)
| 是 | Want类型参数,传入需要启动的ability的信息,如ability名称,包名等。 |
| options |
[
ConnectOptions
](
#connectoptions
)
| 是 | ConnectOptions类型的回调函数,返回服务连接成功、断开或连接失败后的信息。 |
-
返回值
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
| number | 返回一个number,后续根据这个number去断开连接。 |
-
示例:
```
**示例:**
```
js
let
want
=
{
"
bundleName
"
:
"
com.example.myapp
"
,
"
abilityName
"
:
"
com.example.myapp.MyAbility
"
...
...
@@ -156,52 +155,53 @@ SystemCapability.Ability.AbilityRuntime.Core
```
## disconnectAbility
##
ServiceExtensionContext.
disconnectAbility
disconnectAbility(connection: number, callback:AsyncCallback
<
void
>
): void;
将一个Ability与绑定的服务类型的Ability解绑。
**系统能力
:**
**系统能力
**
:SystemCapability.Ability.AbilityRuntime.Core
SystemCapability.Ability.AbilityRuntime.Core
**参数:**
-
参数:
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| connection | number | 是 | 在connectAbility中返回的number。 |
| callback | AsyncCallback
<
void
>
| 否 | 回调函数,返回接口调用是否成功的结果。 |
-
示例:
```
**示例:**
```
js
this
.
context
.
disconnectAbility
(
connection
,
(
err
)
=>
{
// connection为connectAbility中的返回值
console
.
log
(
'
terminateSelf result:
'
+
JSON
.
stringfy
(
err
));
});
```
## disconnectAbility
##
ServiceExtensionContext.
disconnectAbility
disconnectAbility(connection: number): Promise
<
void
>
;
将一个Ability与绑定的服务类型的Ability解绑。通过Promise返回结果。
**系统能力
:**
**系统能力
**
:SystemCapability.Ability.AbilityRuntime.Core
SystemCapability.Ability.AbilityRuntime.Core
**参数:**
-
参数:
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| connection | number | 是 | 在connectAbility中返回的number。 |
-
返回值:
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
| Promise
<
void
>
| 返回一个Promise,包含接口的结果。 |
-
示例:
```
**示例:**
```
js
this
.
context
.
disconnectAbility
(
connection
).
then
((
data
)
=>
{
// connection为connectAbility中的返回值
console
.
log
(
'
success:
'
+
JSON
.
stringfy
(
data
));
}).
catch
((
error
)
=>
{
...
...
@@ -216,6 +216,6 @@ ConnectOptions数据结构。
| 名称 | 说明 |
| -------- | -------- |
| onConnect(elementName:ElementName,
remote:IRemoteObject) | Ability成功连接一个服务类型Ability的回调接口。
<br
><b>
系统能力:
</b>
SystemCapability.Ability.AbilityRuntime.Core |
| onDisconnect(elementName:ElementName) | 对端服务发生异常或者被杀死回调该接口。
<br
><b>
系统能力:
</b>
SystemCapability.Ability.AbilityRuntime.Core |
| onFailed(code:
number) | 连接失败时回调该接口。
<br
><b>
系统能力:
</b>
SystemCapability.Ability.AbilityRuntime.Core |
| onConnect(elementName:ElementName,
remote:IRemoteObject) | Ability成功连接一个服务类型Ability的回调接口。
<br
/>
**系统能力**
:
SystemCapability.Ability.AbilityRuntime.Core |
| onDisconnect(elementName:ElementName) | 对端服务发生异常或者被杀死回调该接口。
<br
/>
**系统能力**
:
SystemCapability.Ability.AbilityRuntime.Core |
| onFailed(code:
number) | 连接失败时回调该接口。
<br
/>
**系统能力**
:
SystemCapability.Ability.AbilityRuntime.Core |
zh-cn/application-dev/reference/apis/js-apis-service-extension.md
浏览文件 @
3777db35
...
...
@@ -23,7 +23,7 @@ import ServiceExtension from '@ohos.application.ServiceExtension';
| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| context |
[
ServiceExtensionContext
](
js-apis-service-extension-context.md
)
| 是 | 否 | ServiceExtension的上下文环境,继承自ExtensionContext。 |
| context |
[
ServiceExtensionContext
](
js-apis-service-extension-context.md
)
| 是 | 否 | ServiceExtension的上下文环境,继承自ExtensionContext。
<br/>
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
|
## onCreate
...
...
@@ -32,17 +32,17 @@ onCreate(want: Want): void;
Extension生命周期回调,在创建时回调,执行初始化业务逻辑操作。
**系统能力
:**
**系统能力
**
:SystemCapability.Ability.AbilityRuntime.Core
SystemCapability.Ability.AbilityRuntime.Core
**参数:**
-
参数:
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want |
[
Want
](
js-apis-featureAbility.md#Want类型说明
)
| 是 | 当前Extension相关的Want类型信息,包括ability名称、bundle名称等。 |
-
示例:
```
**示例:**
```
js
class
ServiceExt
extends
ServiceExtension
{
onCreate
(
want
)
{
console
.
log
(
'
onCreate, want:
'
+
want
.
abilityName
);
...
...
@@ -57,12 +57,11 @@ onDestroy(): void;
Extension生命周期回调,在销毁时回调,执行资源清理等操作。
**系统能力
:**
**系统能力
**
:SystemCapability.Ability.AbilityRuntime.Core
SystemCapability.Ability.AbilityRuntime.Core
**示例:**
-
示例:
```
```
js
class
ServiceExt
extends
ServiceExtension
{
onDestroy
()
{
console
.
log
(
'
onDestroy
'
);
...
...
@@ -77,18 +76,18 @@ onRequest(want: Want, startId: number): void;
Extension生命周期回调,如果是startAbility拉起的服务,会在onCreate之后回调。每次拉起服务都会回调,startId会递增。
**系统能力
:**
**系统能力
**
:SystemCapability.Ability.AbilityRuntime.Core
SystemCapability.Ability.AbilityRuntime.Core
**参数:**
-
参数:
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want |
[
Want
](
js-apis-featureAbility.md#Want类型说明
)
| 是 | 当前Extension相关的Want类型信息,包括ability名称、bundle名称等。 |
| startId | number | 是 | 返回拉起次数。首次拉起初始值返回1,多次之后自动递增。 |
-
示例:
```
**示例:**
```
js
class
ServiceExt
extends
ServiceExtension
{
onRequest
(
want
,
startId
)
{
console
.
log
(
'
onRequest, want:
'
+
want
.
abilityName
);
...
...
@@ -103,22 +102,23 @@ onConnect(want: Want): rpc.RemoteObject;
Extension生命周期回调,如果是connectAbility拉起的服务,会在onCreate之后回调。返回一个RemoteObject对象,用于和客户端进行通信。
**系统能力
:**
**系统能力
**
:SystemCapability.Ability.AbilityRuntime.Core
SystemCapability.Ability.AbilityRuntime.Core
**参数:**
-
参数:
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want |
[
Want
](
js-apis-featureAbility.md#Want类型说明
)
| 是 | 当前Extension相关的Want类型信息,包括ability名称、bundle名称等。 |
-
返回值:
**返回值:**
| 类型 | 说明 |
| -------- | -------- |
| rpc.RemoteObject | 一个RemoteObject对象,用于和客户端进行通信。 |
-
示例:
```
**示例:**
```
js
import
rpc
from
'
@ohos.rpc
'
class
StubTest
extends
rpc
.
RemoteObject
{
constructor
(
des
)
{
...
...
@@ -142,17 +142,17 @@ onDisconnect(want: Want): void;
Extension的生命周期,断开服务连接时回调。
**系统能力
:**
**系统能力
**
:SystemCapability.Ability.AbilityRuntime.Core
SystemCapability.Ability.AbilityRuntime.Core
**参数:**
-
参数:
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| want |
[
Want
](
js-apis-featureAbility.md#Want类型说明
)
| 是 | 当前Extension相关的Want类型信息,包括ability名称、bundle名称等。 |
-
示例:
```
**示例:**
```
js
class
ServiceExt
extends
ServiceExtension
{
onDisconnect
(
want
)
{
console
.
log
(
'
onDisconnect, want:
'
+
want
.
abilityName
);
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录