Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
9643df3c
D
Docs
项目概览
OpenHarmony
/
Docs
接近 2 年 前同步成功
通知
159
Star
292
Fork
28
代码
文件
提交
分支
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看板
提交
9643df3c
编写于
5月 18, 2023
作者:
Y
yuyaozhi
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
Fix document consistency issues of ability
Signed-off-by:
N
yuyaozhi
<
yuyaozhi@huawei.com
>
上级
8773f51b
变更
43
展开全部
隐藏空白更改
内联
并排
Showing
43 changed file
with
568 addition
and
293 deletion
+568
-293
zh-cn/application-dev/reference/apis/js-apis-app-ability-ability.md
...ication-dev/reference/apis/js-apis-app-ability-ability.md
+6
-0
zh-cn/application-dev/reference/apis/js-apis-app-ability-abilityConstant.md
...dev/reference/apis/js-apis-app-ability-abilityConstant.md
+3
-3
zh-cn/application-dev/reference/apis/js-apis-app-ability-abilityManager.md
...-dev/reference/apis/js-apis-app-ability-abilityManager.md
+2
-2
zh-cn/application-dev/reference/apis/js-apis-app-ability-appManager.md
...tion-dev/reference/apis/js-apis-app-ability-appManager.md
+11
-3
zh-cn/application-dev/reference/apis/js-apis-app-ability-appRecovery.md
...ion-dev/reference/apis/js-apis-app-ability-appRecovery.md
+11
-3
zh-cn/application-dev/reference/apis/js-apis-app-ability-configuration.md
...n-dev/reference/apis/js-apis-app-ability-configuration.md
+6
-0
zh-cn/application-dev/reference/apis/js-apis-app-ability-dataUriUtils.md
...on-dev/reference/apis/js-apis-app-ability-dataUriUtils.md
+4
-4
zh-cn/application-dev/reference/apis/js-apis-app-ability-dialogRequest.md
...n-dev/reference/apis/js-apis-app-ability-dialogRequest.md
+185
-28
zh-cn/application-dev/reference/apis/js-apis-app-ability-environmentCallback.md
...reference/apis/js-apis-app-ability-environmentCallback.md
+3
-4
zh-cn/application-dev/reference/apis/js-apis-app-ability-missionManager.md
...-dev/reference/apis/js-apis-app-ability-missionManager.md
+20
-17
zh-cn/application-dev/reference/apis/js-apis-app-ability-quickFixManager.md
...dev/reference/apis/js-apis-app-ability-quickFixManager.md
+4
-4
zh-cn/application-dev/reference/apis/js-apis-app-ability-startOptions.md
...on-dev/reference/apis/js-apis-app-ability-startOptions.md
+0
-3
zh-cn/application-dev/reference/apis/js-apis-app-ability-uiAbility.md
...ation-dev/reference/apis/js-apis-app-ability-uiAbility.md
+13
-6
zh-cn/application-dev/reference/apis/js-apis-app-ability-want.md
...pplication-dev/reference/apis/js-apis-app-ability-want.md
+45
-8
zh-cn/application-dev/reference/apis/js-apis-app-ability-wantAgent.md
...ation-dev/reference/apis/js-apis-app-ability-wantAgent.md
+2
-1
zh-cn/application-dev/reference/apis/js-apis-app-ability-wantConstant.md
...on-dev/reference/apis/js-apis-app-ability-wantConstant.md
+7
-4
zh-cn/application-dev/reference/apis/js-apis-app-form-formHost.md
...plication-dev/reference/apis/js-apis-app-form-formHost.md
+84
-46
zh-cn/application-dev/reference/apis/js-apis-app-form-formInfo.md
...plication-dev/reference/apis/js-apis-app-form-formInfo.md
+4
-1
zh-cn/application-dev/reference/apis/js-apis-app-form-formProvider.md
...ation-dev/reference/apis/js-apis-app-form-formProvider.md
+24
-31
zh-cn/application-dev/reference/apis/js-apis-application-appManager.md
...tion-dev/reference/apis/js-apis-application-appManager.md
+10
-2
zh-cn/application-dev/reference/apis/js-apis-application-configuration.md
...n-dev/reference/apis/js-apis-application-configuration.md
+7
-0
zh-cn/application-dev/reference/apis/js-apis-application-environmentCallback.md
...reference/apis/js-apis-application-environmentCallback.md
+0
-82
zh-cn/application-dev/reference/apis/js-apis-businessAbilityRouter.md
...ation-dev/reference/apis/js-apis-businessAbilityRouter.md
+4
-4
zh-cn/application-dev/reference/apis/js-apis-distributedMissionManager.md
...n-dev/reference/apis/js-apis-distributedMissionManager.md
+2
-2
zh-cn/application-dev/reference/apis/js-apis-inner-ability-connectOptions.md
...ev/reference/apis/js-apis-inner-ability-connectOptions.md
+4
-0
zh-cn/application-dev/reference/apis/js-apis-inner-application-abilityStageMonitor.md
...nce/apis/js-apis-inner-application-abilityStageMonitor.md
+5
-2
zh-cn/application-dev/reference/apis/js-apis-inner-application-abilityStateData.md
...erence/apis/js-apis-inner-application-abilityStateData.md
+10
-6
zh-cn/application-dev/reference/apis/js-apis-inner-application-applicationContext.md
...ence/apis/js-apis-inner-application-applicationContext.md
+0
-4
zh-cn/application-dev/reference/apis/js-apis-inner-application-applicationStateObserver.md
...pis/js-apis-inner-application-applicationStateObserver.md
+10
-8
zh-cn/application-dev/reference/apis/js-apis-inner-application-continueCallback.md
...erence/apis/js-apis-inner-application-continueCallback.md
+4
-0
zh-cn/application-dev/reference/apis/js-apis-inner-application-continueDeviceInfo.md
...ence/apis/js-apis-inner-application-continueDeviceInfo.md
+4
-0
zh-cn/application-dev/reference/apis/js-apis-inner-application-errorObserver.md
...reference/apis/js-apis-inner-application-errorObserver.md
+5
-1
zh-cn/application-dev/reference/apis/js-apis-inner-application-formExtensionContext.md
...ce/apis/js-apis-inner-application-formExtensionContext.md
+1
-1
zh-cn/application-dev/reference/apis/js-apis-inner-application-missionCallbacks.md
...erence/apis/js-apis-inner-application-missionCallbacks.md
+4
-0
zh-cn/application-dev/reference/apis/js-apis-inner-application-missionInfo.md
...v/reference/apis/js-apis-inner-application-missionInfo.md
+4
-0
zh-cn/application-dev/reference/apis/js-apis-inner-application-missionListener.md
...ference/apis/js-apis-inner-application-missionListener.md
+7
-3
zh-cn/application-dev/reference/apis/js-apis-inner-application-missionParameter.md
...erence/apis/js-apis-inner-application-missionParameter.md
+4
-0
zh-cn/application-dev/reference/apis/js-apis-inner-application-processData.md
...v/reference/apis/js-apis-inner-application-processData.md
+9
-5
zh-cn/application-dev/reference/apis/js-apis-inner-application-uiAbilityContext.md
...erence/apis/js-apis-inner-application-uiAbilityContext.md
+27
-4
zh-cn/application-dev/reference/apis/js-apis-inner-wantAgent-triggerInfo.md
...dev/reference/apis/js-apis-inner-wantAgent-triggerInfo.md
+4
-0
zh-cn/application-dev/reference/apis/js-apis-inner-wantAgent-wantAgentInfo.md
...v/reference/apis/js-apis-inner-wantAgent-wantAgentInfo.md
+4
-0
zh-cn/application-dev/reference/apis/js-apis-uripermissionmanager.md
...cation-dev/reference/apis/js-apis-uripermissionmanager.md
+1
-1
zh-cn/application-dev/reference/apis/js-apis-wantAgent.md
zh-cn/application-dev/reference/apis/js-apis-wantAgent.md
+4
-0
未找到文件。
zh-cn/application-dev/reference/apis/js-apis-app-ability-ability.md
浏览文件 @
9643df3c
...
...
@@ -7,6 +7,12 @@
> 本模块首批接口从API version 9 开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
> 本模块接口仅可在Stage模型下使用。
## 导入模块
```
ts
import
Ability
from
'
@ohos.app.ability.Ability
'
;
```
## Ability.onConfigurationUpdate
onConfigurationUpdate(newConfig: Configuration): void;
...
...
zh-cn/application-dev/reference/apis/js-apis-app-ability-abilityConstant.md
浏览文件 @
9643df3c
...
...
@@ -30,7 +30,7 @@ import AbilityConstant from '@ohos.app.ability.AbilityConstant';
Ability初次启动原因,该类型为枚举,可配合
[
Ability
](
js-apis-app-ability-uiAbility.md
)
的
[
onCreate(want, launchParam)
](
js-apis-app-ability-uiAbility.md#uiabilityoncreate
)
方法根据launchParam.launchReason的不同类型执行相应操作。
**系统能力**
:
以下各项对应的系统能力均为
SystemCapability.Ability.AbilityRuntime.Core
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
| 名称 | 值 | 说明 |
| ----------------------------- | ---- | ------------------------------------------------------------ |
...
...
@@ -59,7 +59,7 @@ class MyAbility extends UIAbility {
Ability上次退出原因,该类型为枚举,可配合
[
Ability
](
js-apis-app-ability-uiAbility.md
)
的
[
onCreate(want, launchParam)
](
js-apis-app-ability-uiAbility.md#uiabilityoncreate
)
方法根据launchParam.lastExitReason的不同类型执行相应操作。
**系统能力**
:
以下各项对应的系统能力均为
SystemCapability.Ability.AbilityRuntime.Core
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
| 名称 | 值 | 说明 |
| ----------------------------- | ---- | ------------------------------------------------------------ |
...
...
@@ -85,7 +85,7 @@ class MyAbility extends UIAbility {
Ability迁移结果,该类型为枚举,可配合
[
Ability
](
js-apis-app-ability-uiAbility.md
)
的
[
onContinue(wantParam)
](
js-apis-app-ability-uiAbility.md#uiabilityoncontinue
)
方法进完成相应的返回。
**系统能力**
:
以下各项对应的系统能力均为
SystemCapability.Ability.AbilityRuntime.Core
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
| 名称 | 值 | 说明 |
| ----------------------------- | ---- | ------------------------------------------------------------ |
...
...
zh-cn/application-dev/reference/apis/js-apis-app-ability-abilityManager.md
浏览文件 @
9643df3c
...
...
@@ -412,7 +412,7 @@ acquireShareData(missionId: number, callback: AsyncCallback<{[key: string]: Obje
```
ts
import
abilityManager
from
'
@ohos.app.ability.abilityManager
'
;
abilityManager
.
acquireShareData
(
1
,
(
err
,
wantParam
)
=>
{
abilityManager
.
acquireShareData
(
1
,
(
err
,
data
)
=>
{
if
(
err
)
{
console
.
error
(
`acquireShareData fail, err:
${
JSON
.
stringify
(
err
)}
`
);
}
else
{
...
...
@@ -449,7 +449,7 @@ acquireShareData(missionId: number): Promise<{[key: string]: Object}>;
```
ts
import
abilityManager
from
'
@ohos.app.ability.abilityManager
'
;
try
{
abilityManager
.
acquireShareData
(
1
).
then
((
wantParam
)
=>
{
abilityManager
.
acquireShareData
(
1
).
then
((
data
)
=>
{
console
.
log
(
`acquireShareData success, data:
${
JSON
.
stringify
(
data
)}
`
);
}).
catch
((
err
)
=>
{
console
.
error
(
`acquireShareData fail, err:
${
JSON
.
stringify
(
err
)}
`
);
...
...
zh-cn/application-dev/reference/apis/js-apis-app-ability-appManager.md
浏览文件 @
9643df3c
...
...
@@ -669,7 +669,11 @@ killProcessWithAccount(bundleName: string, accountId: number): Promise\<void\>
切断account进程(Promise形式)。
**需要权限**
:ohos.permission.CLEAN_BACKGROUND_PROCESSES,ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS,当accountId为当前用户时,不需要校验ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS权限。
> **说明:**
>
> 当accountId为当前用户时,不需要校验ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS权限。
**需要权限**
:ohos.permission.CLEAN_BACKGROUND_PROCESSES,ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
...
...
@@ -715,12 +719,16 @@ killProcessWithAccount(bundleName: string, accountId: number, callback: AsyncCal
切断account进程(callback形式)。
> **说明:**
>
> 当accountId为当前用户时,不需要校验ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS权限。
**需要权限**
:ohos.permission.CLEAN_BACKGROUND_PROCESSES,ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
**系统API**
: 此接口为系统接口,三方应用不支持调用。
**需要权限**
:ohos.permission.CLEAN_BACKGROUND_PROCESSES,ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS,当accountId为当前用户时,不需要校验ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS权限。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
...
...
zh-cn/application-dev/reference/apis/js-apis-app-ability-appRecovery.md
浏览文件 @
9643df3c
...
...
@@ -173,9 +173,17 @@ saveAppState(context?: UIAbilityContext): boolean;
```
ts
import
appRecovery
from
'
@ohos.app.ability.appRecovery
'
;
onBackground
()
{
hilog
.
info
(
0x0000
,
'
[demo]
'
,
'
%{public}s
'
,
'
EntryAbility onBackground
'
);
appRecovery
.
saveAppState
(
this
.
context
)
let
observer
=
{
onUnhandledException
(
errorMsg
)
{
console
.
log
(
'
onUnhandledException, errorMsg:
'
,
errorMsg
);
appRecovery
.
saveAppState
(
this
.
context
);
}
};
try
{
errorManager
.
on
(
'
error
'
,
observer
);
}
catch
(
paramError
)
{
console
.
error
(
'
error: ${paramError.code}, ${paramError.message}
'
);
}
```
...
...
zh-cn/application-dev/reference/apis/js-apis-app-ability-configuration.md
浏览文件 @
9643df3c
...
...
@@ -6,6 +6,12 @@
>
> 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
## 导入模块
```
ts
import
Configuration
from
'
@ohos.app.ability.Configuration
'
;
```
**系统能力**
:以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase
| 名称 | 类型 | 可读 | 可写 | 说明 |
...
...
zh-cn/application-dev/reference/apis/js-apis-app-ability-dataUriUtils.md
浏览文件 @
9643df3c
...
...
@@ -22,7 +22,7 @@ getId(uri: string): number
**参数:**
|
名称 | 类型 | 必填 | 描述
|
|
参数名 | 类型 | 必填 | 说明
|
| ---- | ------ | ---- | --------------------------- |
| uri | string | 是 | 表示uri对象。 |
...
...
@@ -55,7 +55,7 @@ attachId(uri: string, id: number): string
**参数:**
|
名称 | 类型 | 必填 | 描述
|
|
参数名 | 类型 | 必填 | 说明
|
| ---- | ------ | ---- | --------------------------- |
| uri | string | 是 | 表示uri对象。 |
| id | number | 是 | 表示要附加的ID。 |
...
...
@@ -94,7 +94,7 @@ deleteId(uri: string): string
**参数:**
|
名称 | 类型 | 必填 | 描述
|
|
参数名 | 类型 | 必填 | 说明
|
| ---- | ------ | ---- | --------------------------- |
| uri | string | 是 | 表示要从中删除ID的uri对象。 |
...
...
@@ -128,7 +128,7 @@ updateId(uri: string, id: number): string
**参数:**
|
名称 | 类型 | 必填 | 描述
|
|
参数名 | 类型 | 必填 | 说明
|
| ---- | ------ | ---- | ------------------- |
| uri | string | 是 | 表示uri对象 |
| id | number | 是 | 表示要更新的ID |
...
...
zh-cn/application-dev/reference/apis/js-apis-app-ability-dialogRequest.md
浏览文件 @
9643df3c
...
...
@@ -24,7 +24,7 @@ getRequestInfo(want: Want): RequestInfo
**参数:**
|
名称 | 类型 | 必填 | 描述
|
|
参数名 | 类型 | 必填 | 说明
|
| ---- | ------ | ---- | --------------------------- |
| want |
[
Want
](
js-apis-application-want.md
)
| 是 | 表示发起方请求弹框时传入的want信息。 |
...
...
@@ -41,32 +41,71 @@ getRequestInfo(want: Want): RequestInfo
import
rpc
from
'
@ohos.rpc
'
;
import
dialogRequest
from
'
@ohos.app.ability.dialogRequest
'
;
export
default
class
ServiceExtAbility
extends
ServiceExtensionAbility
{
onCreate
(
want
)
{
console
.
info
(
TAG
,
`onCreate, want:
${
want
.
abilityName
}
`
);
}
const
REQUEST_VALUE
=
1
;
onRequest
(
want
,
startId
)
{
console
.
info
(
TAG
,
`onRequest, want:
${
want
.
abilityName
}
`
);
try
{
var
requestInfo
=
dialogRequest
.
getRequestInfo
(
want
);
}
catch
(
err
)
{
console
.
error
(
'
getRequestInfo err= ${JSON.stringify(err)}
'
);
class
StubTest
extends
rpc
.
RemoteObject
{
constructor
(
des
)
{
super
(
des
);
}
onRemoteRequest
(
code
,
data
,
reply
,
option
)
{
if
(
code
===
REQUEST_VALUE
)
{
let
optFir
=
data
.
readInt
();
let
optSec
=
data
.
readInt
();
reply
.
writeInt
(
optFir
+
optSec
);
}
}
return
true
;
}
queryLocallInterface
(
descriptor
)
{
return
null
;
}
getInterfaceDescriptor
()
{
return
""
;
}
getCallingPid
()
{
return
REQUEST_VALUE
;
}
getCallingUid
()
{
return
REQUEST_VALUE
;
}
attachLocalInterface
(
localInterface
,
descriptor
)
{
}
}
let
TAG
=
"
getRequestInfoTest
"
;
export
default
class
ServiceExtAbility
extends
ServiceExtensionAbility
{
onCreate
(
want
)
{
console
.
info
(
TAG
,
`onCreate, want:
${
want
.
abilityName
}
`
);
}
onRequest
(
want
,
startId
)
{
console
.
info
(
TAG
,
`onRequest, want:
${
want
.
abilityName
}
`
);
try
{
var
requestInfo
=
dialogRequest
.
getRequestInfo
(
want
);
}
catch
(
err
)
{
console
.
error
(
'
getRequestInfo err= ${JSON.stringify(err)}
'
);
}
}
onConnect
(
want
)
{
console
.
info
(
TAG
,
`onConnect, want:
${
want
.
abilityName
}
`
);
}
onConnect
(
want
)
{
console
.
info
(
TAG
,
`onConnect, want:
${
want
.
abilityName
}
`
);
return
new
StubTest
(
"
test
"
);
}
onDisconnect
(
want
)
{
console
.
info
(
TAG
,
`onDisconnect, want:
${
want
.
abilityName
}
`
);
}
onDisconnect
(
want
)
{
console
.
info
(
TAG
,
`onDisconnect, want:
${
want
.
abilityName
}
`
);
}
onDestroy
()
{
console
.
info
(
TAG
,
`onDestroy`
);
}
}
onDestroy
()
{
console
.
info
(
TAG
,
`onDestroy`
);
}
}
```
## dialogRequest.getRequestCallback
...
...
@@ -79,7 +118,7 @@ getRequestCallback(want: Want): RequestCallback
**参数:**
|
名称 | 类型 | 必填 | 描述
|
|
参数名 | 类型 | 必填 | 说明
|
| ---- | ------ | ---- | --------------------------- |
| want | [Want](js-apis-application-want.md) | 是 | 表示发起方请求弹框时传入的want信息。 |
...
...
@@ -95,6 +134,44 @@ getRequestCallback(want: Want): RequestCallback
import ServiceExtensionAbility from '@ohos.app.ability.ServiceExtensionAbility';
import rpc from '@ohos.rpc';
import dialogRequest from '@ohos.app.ability.dialogRequest';
let TAG = "getRequestCallbackTest";
const REQUEST_VALUE = 1;
class StubTest extends rpc.RemoteObject {
constructor(des) {
super(des);
}
onRemoteRequest(code, data, reply, option) {
if (code === REQUEST_VALUE) {
let optFir = data.readInt();
let optSec = data.readInt();
reply.writeInt(optFir + optSec);
}
return true;
}
queryLocallInterface(descriptor) {
return null;
}
getInterfaceDescriptor() {
return "";
}
getCallingPid() {
return REQUEST_VALUE;
}
getCallingUid() {
return REQUEST_VALUE;
}
attachLocalInterface(localInterface, descriptor) {
}
}
export default class ServiceExtAbility extends ServiceExtensionAbility {
onCreate(want) {
...
...
@@ -112,6 +189,7 @@ getRequestCallback(want: Want): RequestCallback
onConnect(want) {
console.info(TAG, `onConnect, want: ${want.abilityName}`);
return new StubTest("test");
}
onDisconnect(want) {
...
...
@@ -127,7 +205,7 @@ getRequestCallback(want: Want): RequestCallback
## RequestInfo
表示发起方请求信息,作为窗口绑定模态弹框的入参。
**系统能力**:SystemCapability.Ability.AbilityRuntime.
Ability
Core
**系统能力**:SystemCapability.Ability.AbilityRuntime.Core
**示例:**
...
...
@@ -136,6 +214,44 @@ getRequestCallback(want: Want): RequestCallback
import rpc from '@ohos.rpc';
import dialogRequest from '@ohos.app.ability.dialogRequest';
import window from '@ohos.window';
let TAG = "RequestInfoTest";
const REQUEST_VALUE = 1;
class StubTest extends rpc.RemoteObject {
constructor(des) {
super(des);
}
onRemoteRequest(code, data, reply, option) {
if (code === REQUEST_VALUE) {
let optFir = data.readInt();
let optSec = data.readInt();
reply.writeInt(optFir + optSec);
}
return true;
}
queryLocallInterface(descriptor) {
return null;
}
getInterfaceDescriptor() {
return "";
}
getCallingPid() {
return REQUEST_VALUE;
}
getCallingUid() {
return REQUEST_VALUE;
}
attachLocalInterface(localInterface, descriptor) {
}
}
export default class ServiceExtAbility extends ServiceExtensionAbility {
onCreate(want) {
...
...
@@ -162,6 +278,8 @@ getRequestCallback(want: Want): RequestCallback
onConnect(want) {
console.info(TAG, `onConnect, want: ${want.abilityName}`);
return new StubTest("test");
}
onDisconnect(want) {
...
...
@@ -178,9 +296,9 @@ getRequestCallback(want: Want): RequestCallback
模态弹框请求结果码。
**系统能力**
:SystemCapability.Ability.AbilityRuntime.
AbilityCore。
**系统能力**
:SystemCapability.Ability.AbilityRuntime.
Core
|
名称
| 值 | 说明 |
|
参数名
| 值 | 说明 |
| ------------ | ------------------ | ---------------------- |
| RESULT_OK | 0 | 表示成功。 |
| RESULT_CANCEL | 1 | 表示失败。 |
...
...
@@ -190,7 +308,7 @@ getRequestCallback(want: Want): RequestCallback
## 属性
**系统能力**
:SystemCapability.Ability.AbilityRuntime.
Ability
Core
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
| 名称 | 类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
...
...
@@ -206,7 +324,7 @@ setRequestResult(result: RequestResult): void;
设置请求结果
**系统能力**
:SystemCapability.Ability.AbilityRuntime.
Ability
Core
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
**参数:**
...
...
@@ -228,6 +346,44 @@ setRequestResult(result: RequestResult): void;
import
ServiceExtensionAbility
from
'
@ohos.app.ability.ServiceExtensionAbility
'
;
import
rpc
from
'
@ohos.rpc
'
;
import
dialogRequest
from
'
@ohos.app.ability.dialogRequest
'
;
let
TAG
=
"
setRequestResultTest
"
;
const
REQUEST_VALUE
=
1
;
class
StubTest
extends
rpc
.
RemoteObject
{
constructor
(
des
)
{
super
(
des
);
}
onRemoteRequest
(
code
,
data
,
reply
,
option
)
{
if
(
code
===
REQUEST_VALUE
)
{
let
optFir
=
data
.
readInt
();
let
optSec
=
data
.
readInt
();
reply
.
writeInt
(
optFir
+
optSec
);
}
return
true
;
}
queryLocallInterface
(
descriptor
)
{
return
null
;
}
getInterfaceDescriptor
()
{
return
""
;
}
getCallingPid
()
{
return
REQUEST_VALUE
;
}
getCallingUid
()
{
return
REQUEST_VALUE
;
}
attachLocalInterface
(
localInterface
,
descriptor
)
{
}
}
export
default
class
ServiceExtAbility
extends
ServiceExtensionAbility
{
onCreate
(
want
)
{
...
...
@@ -249,6 +405,7 @@ setRequestResult(result: RequestResult): void;
onConnect
(
want
)
{
console
.
info
(
TAG
,
`onConnect, want:
${
want
.
abilityName
}
`
);
return
new
StubTest
(
"
test
"
);
}
onDisconnect
(
want
)
{
...
...
zh-cn/application-dev/reference/apis/js-apis-app-ability-environmentCallback.md
浏览文件 @
9643df3c
...
...
@@ -45,8 +45,7 @@ onMemoryLevel(level: AbilityConstant.MemoryLevel): void;
**示例:**
```
ts
```
ts
import
UIAbility
from
'
@ohos.app.ability.Ability
'
;
let
callbackId
;
...
...
@@ -58,7 +57,7 @@ export default class MyAbility extends UIAbility {
let
environmentCallback
=
{
onConfigurationUpdated
(
config
){
console
.
log
(
'
onConfigurationUpdated config: ${JSON.stringify(config)}
'
);
}
}
,
onMemoryLevel
(
level
){
console
.
log
(
'
onMemoryLevel level: ${JSON.stringify(level)}
'
);
...
...
@@ -81,4 +80,4 @@ export default class MyAbility extends UIAbility {
});
}
}
```
\ No newline at end of file
```
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-app-ability-missionManager.md
浏览文件 @
9643df3c
...
...
@@ -311,33 +311,36 @@ getMissionInfo(deviceId: string, missionId: number, callback: AsyncCallback<M
**示例:**
```
ts
import
missionManager
from
'
@ohos.app.ability.missionManager
'
;
import
missionManager
from
'
@ohos.app.ability.missionManager
'
;
let
testMissionId
=
1
;
try
{
let
allMissions
=
await
missionManager
.
getMissionInfos
(
''
,
10
).
catch
(
function
(
err
){
console
.
log
(
err
);});
if
(
allMissions
&&
allMissions
.
length
>
0
)
{
testMissionId
=
allMissions
[
0
].
missionId
;
}
let
testMissionId
=
1
;
missionManager
.
getMissionInfo
(
''
,
testMissionId
,
(
error
,
mission
)
=>
{
if
(
error
)
{
missionManager
.
getMissionInfos
(
''
,
10
)
.
then
((
allMissions
)
=>
{
try
{
if
(
allMissions
&&
allMissions
.
length
>
0
)
{
testMissionId
=
allMissions
[
0
].
missionId
;
}
missionManager
.
getMissionInfo
(
''
,
testMissionId
,
(
error
,
mission
)
=>
{
if
(
error
)
{
console
.
error
(
'
getMissionInfo failed, error.code: ${error.code}, error.message: ${error.message}
'
);
}
else
{
}
else
{
console
.
log
(
'
mission.missionId = ${mission.missionId}
'
);
console
.
log
(
'
mission.runningState = ${mission.runningState}
'
);
console
.
log
(
'
mission.lockedState = ${mission.lockedState}
'
);
console
.
log
(
'
mission.timestamp = ${mission.timestamp}
'
);
console
.
log
(
'
mission.label = ${mission.label}
'
);
console
.
log
(
'
mission.iconPath = ${mission.iconPath}
'
);
}
});
}
catch
(
paramError
)
{
console
.
error
(
'
error.code: ${paramError.code}, error.message: ${paramError.message}
'
);
}
});
}
catch
(
paramError
)
{
console
.
error
(
'
error.code: ${paramError.code}, error.message: ${paramError.message}
'
);
}
})
.
catch
(
function
(
err
){
console
.
log
(
err
);});
```
## missionManager.getMissionInfo
getMissionInfo(deviceId: string, missionId: number): Promise
<
MissionInfo
>
;
...
...
@@ -943,8 +946,8 @@ clearAllMissions(): Promise<void>;
import
missionManager
from
'
@ohos.app.ability.missionManager
'
;
try
{
missionManager
.
clearAllMissions
(
bundleName
).
then
(()
=>
{
console
.
info
(
'
clearAllMissions successfully.
'
);
missionManager
.
clearAllMissions
(
bundleName
).
then
((
data
)
=>
{
console
.
info
(
'
clearAllMissions successfully.
Data: ${JSON.stringify(data)}
'
);
}).
catch
(
err
=>
{
console
.
error
(
'
clearAllMissions failed: ${err.message}
'
);
});
...
...
zh-cn/application-dev/reference/apis/js-apis-app-ability-quickFixManager.md
浏览文件 @
9643df3c
...
...
@@ -66,7 +66,7 @@ applyQuickFix(hapModuleQuickFixFiles: Array\<string>, callback: AsyncCallback\<v
| 错误码ID | 错误信息 |
| ------- | -------- |
| 18500002 |
Copy file failed, maybe
not exist or inaccessible. |
| 18500002 |
The specified quick fix is invalid. It may
not exist or inaccessible. |
| 18500008 | Internal error. |
在打补丁过程中发生的错误,其错误码及错误信息通过公共事件
[
COMMON_EVENT_QUICK_FIX_APPLY_RESULT
](
commonEvent-definitions.md#common_event_quick_fix_apply_result9
)
的参数返回给应用开发者。这部分错误码及错误信息如下:
...
...
@@ -128,7 +128,7 @@ applyQuickFix(hapModuleQuickFixFiles: Array\<string>): Promise\<void>;
| 错误码ID | 错误信息 |
| ------- | -------- |
| 18500002 |
Copy file failed, maybe
not exist or inaccessible. |
| 18500002 |
The specified quick fix is invalid. It may
not exist or inaccessible. |
| 18500008 | Internal error. |
在打补丁过程中发生的错误,其错误码及错误信息通过公共事件
[
COMMON_EVENT_QUICK_FIX_APPLY_RESULT
](
commonEvent-definitions.md#common_event_quick_fix_apply_result9
)
的参数返回给应用开发者。这部分错误码及错误信息如下:
...
...
@@ -181,7 +181,7 @@ getApplicationQuickFixInfo(bundleName: string, callback: AsyncCallback\<Applicat
| 错误码ID | 错误信息 |
| ------- | -------- |
| 18500001 | The
bundle is not exist
. |
| 18500001 | The
specified bundleName is invalid
. |
| 18500008 | Internal error. |
以上错误码详细介绍请参考
[
errcode-ability
](
../errorcodes/errorcode-ability.md
)
。
...
...
@@ -231,7 +231,7 @@ getApplicationQuickFixInfo(bundleName: string): Promise\<ApplicationQuickFixInfo
| 错误码ID | 错误信息 |
| ------- | -------- |
| 18500001 | The
bundle is not exist
. |
| 18500001 | The
specified bundleName is invalid
. |
| 18500008 | Internal error. |
以上错误码详细介绍请参考
[
errcode-ability
](
../errorcodes/errorcode-ability.md
)
。
...
...
zh-cn/application-dev/reference/apis/js-apis-app-ability-startOptions.md
浏览文件 @
9643df3c
...
...
@@ -15,11 +15,8 @@ import StartOptions from '@ohos.app.ability.StartOptions';
## 属性
**系统能力**
:以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
**系统API**
: 此接口为系统接口,三方应用不支持调用。
| 名称 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
|
[
windowMode
](
js-apis-app-ability-abilityConstant.md#abilityconstantwindowmode
)
| number | 否 | 窗口模式。 |
...
...
zh-cn/application-dev/reference/apis/js-apis-app-ability-uiAbility.md
浏览文件 @
9643df3c
...
...
@@ -371,7 +371,7 @@ call(method: string, data: rpc.Parcelable): Promise<void>;
| ------- | -------------------------------- |
| 16200001 | Caller released. The caller has been released. |
| 16200002 | Callee invalid. The callee does not exist. |
| 16000050 | Internal
E
rror. |
| 16000050 | Internal
e
rror. |
以上错误码详细介绍请参考
[
errcode-ability
](
../errorcodes/errorcode-ability.md
)
。
...
...
@@ -452,7 +452,7 @@ callWithResult(method: string, data: rpc.Parcelable): Promise<rpc.MessageSequ
| ------- | -------------------------------- |
| 16200001 | Caller released. The caller has been released. |
| 16200002 | Callee invalid. The callee does not exist. |
| 16000050 | Internal
E
rror. |
| 16000050 | Internal
e
rror. |
以上错误码详细介绍请参考
[
errcode-ability
](
../errorcodes/errorcode-ability.md
)
。
...
...
@@ -597,9 +597,9 @@ release(): void;
}
```
## Caller.onRemoteStateChange
## Caller.onRemoteStateChange<sup>10+</sup>
onRemoteStateChange(callback: OnRemoteStateChangeCallback): void;
onRemoteStateChange(callback: OnRemoteStateChangeCallback): void;
注册协同场景下跨设备组件状态变化监听通知。
...
...
@@ -650,7 +650,7 @@ release(): void;
## Caller.on
on(type: 'release', callback: OnReleaseCallback): void;
on(type: 'release', callback: OnReleaseCallback): void;
注册通用组件服务端Stub(桩)断开监听通知。
...
...
@@ -667,6 +667,7 @@ release(): void;
| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
| 401 | If the input parameter is not valid parameter. |
| 16200001 | Caller released. The caller has been released. |
以上错误码详细介绍请参考
[
errcode-ability
](
../errorcodes/errorcode-ability.md
)
。
...
...
@@ -712,6 +713,12 @@ off(type: 'release', callback: OnReleaseCallback): void;
| type | string | 是 | 监听releaseCall事件,固定为'release'。 |
| callback |
[
OnReleaseCallback
](
#onreleasecallback
)
| 是 | 返回off回调结果。 |
**错误码:**
| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
| 401 | If the input parameter is not valid parameter. |
**示例:**
```
ts
...
...
@@ -903,7 +910,7 @@ off(method: string): void;
| -------- | -------- | -------- | -------- | -------- |
| (msg: string) | 是 | 否 | function | 调用者注册的侦听器函数接口的原型。 |
## OnRemoteStateChangeCallback
## OnRemoteStateChangeCallback
<sup>10+</sup>
(msg: string): void;
...
...
zh-cn/application-dev/reference/apis/js-apis-app-ability-want.md
浏览文件 @
9643df3c
...
...
@@ -26,7 +26,7 @@ import Want from '@ohos.app.ability.Want';
| entities | Array
\<
string> | 否 | 表示目标Ability额外的类别信息(如:浏览器、视频播放器)。在隐式Want中是对action字段的补充。在隐式Want中,您可以定义该字段,来过滤匹配Ability类型。 |
| uri | string | 否 | 表示携带的数据,一般配合type使用,指明待处理的数据类型。如果在Want中指定了uri,则Want将匹配指定的Uri信息,包括
`scheme`
、
`schemeSpecificPart`
、
`authority`
和
`path`
信息。 |
| type | string | 否 | 表示MIME type类型描述,打开文件的类型,主要用于文管打开文件。比如:'text/xml' 、 'image/
*
'等,MIME定义请参见https://www.iana.org/assignments/media-types/media-types.xhtml?utm_source=ld246.com。 |
| parameters | {
[
key: string]: any} | 否 | 表示WantParams描述,由开发者自行决定传入的键值对。默认会携带以下key值:<br />- ohos.aafwk.callerPid:表示拉起方的pid。<br />- ohos.aafwk.param.callerBundleName:表示拉起方的Bundle Name。<br />- ohos.aafwk.param.callerToken:表示拉起方的token。<br />- ohos.aafwk.param.callerUid:表示[BundleInfo
](
js-apis-bundleManager-bundleInfo.md#bundleinfo-1
)
中的uid,应用包里应用程序的uid。
<br
/>
- component.startup.newRules:表示是否启用新的管控规则。
<br
/>
- moduleName:表示拉起方的模块名,该字段的值即使定义成其他字符串,在传递到另一端时会被修改为正确的值。
<br
/>
- ohos.dlp.params.sandbox:表示dlp文件才会有。 |
| parameters | {
[
key: string]: any} | 否 | 表示WantParams描述,由开发者自行决定传入的键值对。默认会携带以下key值:<br />- ohos.aafwk.callerPid:表示拉起方的pid。<br />- ohos.aafwk.param.callerBundleName:表示拉起方的Bundle Name。<br />- ohos.aafwk.param.callerToken:表示拉起方的token。<br />- ohos.aafwk.param.callerUid:表示[BundleInfo
](
js-apis-bundleManager-bundleInfo.md#bundleinfo-1
)
中的uid,应用包里应用程序的uid。
<br
/>
- component.startup.newRules:表示是否启用新的管控规则。
<br
/>
- moduleName:表示拉起方的模块名,该字段的值即使定义成其他字符串,在传递到另一端时会被修改为正确的值。
<br
/>
- ohos.dlp.params.sandbox:表示dlp文件才会有。
<br
/>
- ability.params.backToOtherMissionStack:表示是否支持跨任务链返回。
|
|
[
flags
](
js-apis-ability-wantConstant.md#wantconstantflags
)
| number | 否 | 表示处理Want的方式。默认传数字。
<br
/>
例如通过wantConstant.Flags.FLAG_ABILITY_CONTINUATION表示是否以设备间迁移方式启动Ability。 |
**示例:**
...
...
@@ -34,7 +34,8 @@ import Want from '@ohos.app.ability.Want';
-
基础用法:在UIAbility对象中调用,示例中的context的获取方式请参见
[
获取UIAbility的上下文信息
](
../../application-models/uiability-usage.md#获取uiability的上下文信息
)
。
```
ts
let
context
=
...;
// UIAbilityContext
import
common
from
'
@ohos.app.ability.common
'
;
let
context
=
getContext
(
this
)
as
common
.
UIAbilityContext
;
// UIAbilityContext
let
want
=
{
'
deviceId
'
:
''
,
// deviceId为空表示本设备
'
bundleName
'
:
'
com.example.myapplication
'
,
...
...
@@ -52,7 +53,8 @@ import Want from '@ohos.app.ability.Want';
* 字符串(String)
```ts
let context = ...; // UIAbilityContext
import common from '@ohos.app.ability.common';
let context = getContext(this) as common.UIAbilityContext; // UIAbilityContext
let want = {
bundleName: 'com.example.myapplication',
abilityName: 'FuncAbility',
...
...
@@ -67,7 +69,8 @@ import Want from '@ohos.app.ability.Want';
```
* 数字(Number)
```ts
let context = ...; // UIAbilityContext
import common from '@ohos.app.ability.common';
let context = getContext(this) as common.UIAbilityContext; // UIAbilityContext
let want = {
bundleName: 'com.example.myapplication',
abilityName: 'FuncAbility',
...
...
@@ -83,7 +86,8 @@ import Want from '@ohos.app.ability.Want';
```
* 布尔(Boolean)
```ts
let context = ...; // UIAbilityContext
import common from '@ohos.app.ability.common';
let context = getContext(this) as common.UIAbilityContext; // UIAbilityContext
let want = {
bundleName: 'com.example.myapplication',
abilityName: 'FuncAbility',
...
...
@@ -98,7 +102,8 @@ import Want from '@ohos.app.ability.Want';
```
* 对象(Object)
```ts
let context = ...; // UIAbilityContext
import common from '@ohos.app.ability.common';
let context = getContext(this) as common.UIAbilityContext; // UIAbilityContext
let want = {
bundleName: 'com.example.myapplication',
abilityName: 'FuncAbility',
...
...
@@ -118,7 +123,8 @@ import Want from '@ohos.app.ability.Want';
```
* 数组(Array)
```ts
let context = ...; // UIAbilityContext
import common from '@ohos.app.ability.common';
let context = getContext(this) as common.UIAbilityContext; // UIAbilityContext
let want = {
bundleName: 'com.example.myapplication',
abilityName: 'FuncAbility',
...
...
@@ -138,7 +144,8 @@ import Want from '@ohos.app.ability.Want';
```ts
import fs from '@ohos.file.fs';
let context = ...; // UIAbilityContext
import common from '@ohos.app.ability.common';
let context = getContext(this) as common.UIAbilityContext; // UIAbilityContext
let fd;
try {
...
...
@@ -160,3 +167,33 @@ import Want from '@ohos.app.ability.Want';
console.error(`Failed to startAbility. Code: ${err.code}, message: ${err.message}`);
});
```
- parameter参数用法:以ability.params.backToOtherMissionStack为例,ServiceExtension在拉起UIAbility的时候,可以支持跨任务链返回。
```ts
// (1) UIAbility1启动一个ServiceExtension
let context = getContext(this) as common.UIAbilityContext; // UIAbilityContext
let want = {
bundleName: 'com.example.myapplication1',
abilityName: 'ServiceExtensionAbility',
};
context.startAbility(want, (err) => {
console.error(`Failed to startAbility. Code: ${err.code}, message: ${err.message}`);
});
// (2) 该ServiceExtension去启动另一个UIAbility2,并在启动的时候携带参数ability.params.backToOtherMissionStack为true
let context = ...; // ServiceExtensionContext
let want = {
bundleName: 'com.example.myapplication2',
abilityName: 'MainAbility',
parameters: {
"ability.params.backToOtherMissionStack": true,
},
};
context.startAbility(want, (err) => {
console.error(`Failed to startAbility. Code: ${err.code}, message: ${err.message}`);
});
```
说明:上例中,如果ServiceExtension启动UIAbility2时不携带ability.params.backToOtherMissionStack参数,或者携带的ability.params.backToOtherMissionStack参数为false,则UIAbility1和UIAbility2不在同一个任务栈里面,在UIAbility2的界面点back键,不会回到UIAbility1的界面。如果携带的ability.params.backToOtherMissionStack参数为true,则表示支持跨任务链返回,此时在UIAbility2的界面点back键,会回到UIAbility1的界面。
zh-cn/application-dev/reference/apis/js-apis-app-ability-wantAgent.md
浏览文件 @
9643df3c
...
...
@@ -118,6 +118,7 @@ getWantAgent(info: WantAgentInfo): Promise\<WantAgent\>
**示例:**
```
ts
let
wantAgent
;
//WantAgentInfo对象
let
wantAgentInfo
=
{
wants
:
[
...
...
@@ -1181,7 +1182,7 @@ function getWantAgentCallback(err, data) {
}
}
try
{
WantAgent
.
getOperationType
Callback
(
wantAgent
,
getOperationTypeCallback
);
WantAgent
.
getOperationType
(
wantAgent
,
getOperationTypeCallback
);
}
catch
(
err
)
{
console
.
error
(
'
getOperationTypeCallback failed! ${err.code} ${err.message}
'
);
}
...
...
zh-cn/application-dev/reference/apis/js-apis-app-ability-wantConstant.md
浏览文件 @
9643df3c
...
...
@@ -16,6 +16,8 @@ import wantConstant from '@ohos.app.ability.wantConstant';
want的Params操作的常量。
**系统能力**
:以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase
| 名称 | 值 | 说明 |
| ----------------------- | ---------------------------------- | ------------------------------------------------------------------------------ |
| DLP_PARAMS_SANDBOX | ohos.dlp.params.sandbox | 指示沙盒标志的参数的操作。
<br>
**系统API**
:该接口为系统接口,三方应用不支持调用。 |
...
...
@@ -23,10 +25,11 @@ want的Params操作的常量。
| DLP_PARAMS_MODULE_NAME | ohos.dlp.params.moduleName | 指示DLP模块名称的参数的操作。
<br>
**系统API**
:该接口为系统接口,三方应用不支持调用。 |
| DLP_PARAMS_ABILITY_NAME | ohos.dlp.params.abilityName | 指示DLP能力名称的参数的操作。
<br>
**系统API**
:该接口为系统接口,三方应用不支持调用。 |
| DLP_PARAMS_INDEX | ohos.dlp.params.index | 指示DLP索引参数的操作。
<br>
**系统API**
:该接口为系统接口,三方应用不支持调用。 |
| ABILITY_RECOVERY_RESTART | ohos.ability.params.abilityRecoveryRestart | 指示当前Ability是否发生了故障恢复重启。 |
| CONTENT_TITLE_KEY | ohos.extra.param.key.contentTitle | 指示原子化服务支持分享标题的参数的操作。
<br>
**系统API**
:该接口为系统接口,三方应用不支持调用。 |
| SHARE_ABSTRACT_KEY | ohos.extra.param.key.shareAbstract | 指示原子化服务支持分享内容的参数的操作。
<br>
**系统API**
:该接口为系统接口,三方应用不支持调用。 |
| SHARE_URL_KEY | ohos.extra.param.key.shareUrl | 指示原子化服务支持分享链接的参数的操作。
<br>
**系统API**
:该接口为系统接口,三方应用不支持调用。 |
| ABILITY_BACK_TO_OTHER_MISSION_STACK | ability.params.backToOtherMissionStack | 表示是否支持跨任务链返回。
<br>
**系统API**
:该接口为系统接口,三方应用不支持调用。 |
| ABILITY_RECOVERY_RESTART
<sup>
10+
</sup>
| ohos.ability.params.abilityRecoveryRestart | 指示当前Ability是否发生了故障恢复重启。 |
| CONTENT_TITLE_KEY
<sup>
10+
</sup>
| ohos.extra.param.key.contentTitle | 指示原子化服务支持分享标题的参数的操作。 |
| SHARE_ABSTRACT_KEY
<sup>
10+
</sup>
| ohos.extra.param.key.shareAbstract | 指示原子化服务支持分享内容的参数的操作。 |
| SHARE_URL_KEY
<sup>
10+
</sup>
| ohos.extra.param.key.shareUrl | 指示原子化服务支持分享链接的参数的操作。 |
## wantConstant.Flags
...
...
zh-cn/application-dev/reference/apis/js-apis-app-form-formHost.md
浏览文件 @
9643df3c
此差异已折叠。
点击以展开。
zh-cn/application-dev/reference/apis/js-apis-app-form-formInfo.md
浏览文件 @
9643df3c
...
...
@@ -18,6 +18,8 @@ import formInfo from '@ohos.app.form.formInfo';
**系统能力**
:SystemCapability.Ability.Form
**系统API**
: 此接口为系统接口,三方应用不支持调用。
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ----------- | -------- | -------- | -------------------- | ------------------------------------------------------------ |
| bundleName | string | 是 | 否 | 卡片所属包的Bundle名称。 |
...
...
@@ -100,7 +102,7 @@ import formInfo from '@ohos.app.form.formInfo';
| HEIGHT_KEY | 'ohos.extra.param.key.form_height' | 卡片高度。 |
| TEMPORARY_KEY | 'ohos.extra.param.key.form_temporary' | 临时卡片。 |
| ABILITY_NAME_KEY | 'ohos.extra.param.key.ability_name' | ability名称。 |
| DEVICE_ID_KEY | 'ohos.extra.param.key.device_id' | 设备标识。 |
| DEVICE_ID_KEY | 'ohos.extra.param.key.device_id'
<br>
**系统API**
: 此接口为系统接口,三方应用不支持调用。
| 设备标识。 |
| BUNDLE_NAME_KEY | 'ohos.extra.param.key.bundle_name' | 指示指定要获取的捆绑Bundle名称的键。 |
| LAUNCH_REASON_KEY
<sup>
10+
</sup>
| 'ohos.extra.param.key.form_launch_reason' | 卡片创建原因。 |
| PARAM_FORM_CUSTOMIZE_KEY
<sup>
10+
</sup>
| 'ohos.extra.param.key.form_customize' | 自定义数据。 |
...
...
@@ -138,6 +140,7 @@ import formInfo from '@ohos.app.form.formInfo';
| 名称 | 值 | 说明 |
| ----------- | ---- | ------------ |
| UNKNOWN | 0 | 表示卡片为未知。 |
| FORM_VISIBLE | 1 | 表示卡片为可见。 |
| FORM_INVISIBLE | 2 | 表示卡片为不可见。 |
...
...
zh-cn/application-dev/reference/apis/js-apis-app-form-formProvider.md
浏览文件 @
9643df3c
...
...
@@ -39,13 +39,12 @@ setFormNextRefreshTime(formId: string, minute: number, callback: AsyncCallback&l
| 16501001 | The ID of the form to be operated does not exist. |
| 16501002 | The number of forms exceeds upper bound. |
| 16501003 | The form can not be operated by the current application. |
|以上错误码的详细介绍请参见
[
卡片错误码
](
../errorcodes/errorcode-form.md
)
。||
以上错误码的详细介绍请参见
[
卡片错误码
](
../errorcodes/errorcode-form.md
)
。
**示例:**
```
ts
import
formProvider
from
'
@ohos.app.form.formProvider
'
;
let
formId
=
'
12400633174999288
'
;
try
{
formProvider
.
setFormNextRefreshTime
(
formId
,
5
,
(
error
)
=>
{
...
...
@@ -93,13 +92,12 @@ setFormNextRefreshTime(formId: string, minute: number): Promise<void>
| 16501001 | The ID of the form to be operated does not exist. |
| 16501002 | The number of forms exceeds upper bound. |
| 16501003 | The form can not be operated by the current application. |
|以上错误码的详细介绍请参见
[
卡片错误码
](
../errorcodes/errorcode-form.md
)
。||
以上错误码的详细介绍请参见
[
卡片错误码
](
../errorcodes/errorcode-form.md
)
。
**示例:**
```
ts
import
formProvider
from
'
@ohos.app.form.formProvider
'
;
let
formId
=
'
12400633174999288
'
;
try
{
formProvider
.
setFormNextRefreshTime
(
formId
,
5
).
then
(()
=>
{
...
...
@@ -139,13 +137,13 @@ updateForm(formId: string, formBindingData: formBindingData.FormBindingData,call
| 16501000 | An internal functional error occurred. |
| 16501001 | The ID of the form to be operated does not exist. |
| 16501003 | The form can not be operated by the current application. |
|以上错误码的详细介绍请参见
[
卡片错误码
](
../errorcodes/errorcode-form.md
)
。||
以上错误码的详细介绍请参见
[
卡片错误码
](
../errorcodes/errorcode-form.md
)
。
**示例:**
```
ts
import
formBindingData
from
'
@ohos.app.form.formBindingData
'
;
import
formProvider
from
'
@ohos.app.form.formProvider
'
;
let
formId
=
'
12400633174999288
'
;
try
{
...
...
@@ -194,13 +192,13 @@ updateForm(formId: string, formBindingData: formBindingData.FormBindingData): Pr
| 16501000 | An internal functional error occurred. |
| 16501001 | The ID of the form to be operated does not exist. |
| 16501003 | The form can not be operated by the current application. |
|以上错误码的详细介绍请参见
[
卡片错误码
](
../errorcodes/errorcode-form.md
)
。||
以上错误码的详细介绍请参见
[
卡片错误码
](
../errorcodes/errorcode-form.md
)
。
**示例:**
```
ts
import
formBindingData
from
'
@ohos.app.form.formBindingData
'
;
import
formProvider
from
'
@ohos.app.form.formProvider
'
;
let
formId
=
'
12400633174999288
'
;
let
obj
=
formBindingData
.
createFormBindingData
({
temperature
:
'
22c
'
,
time
:
'
22:00
'
});
...
...
@@ -236,14 +234,13 @@ getFormsInfo(callback: AsyncCallback<Array<formInfo.FormInfo>>): voi
| 16500050 | An IPC connection error happened. |
| 16500100 | Failed to obtain the configuration information. |
| 16501000 | An internal functional error occurred. |
|以上错误码的详细介绍请参见
[
卡片错误码
](
../errorcodes/errorcode-form.md
)
。||
以上错误码的详细介绍请参见
[
卡片错误码
](
../errorcodes/errorcode-form.md
)
。
**示例:**
```
ts
import
formProvider
from
'
@ohos.app.form.formProvider
'
;
try
{
formProvider
.
getFormsInfo
((
error
,
data
)
=>
{
if
(
error
)
{
...
...
@@ -279,13 +276,13 @@ getFormsInfo(filter: formInfo.FormInfoFilter, callback: AsyncCallback<Array&l
| 16500050 | An IPC connection error happened. |
| 16500100 | Failed to obtain the configuration information. |
| 16501000 | An internal functional error occurred. |
|以上错误码的详细介绍请参见
[
卡片错误码
](
../errorcodes/errorcode-form.md
)
。||
以上错误码的详细介绍请参见
[
卡片错误码
](
../errorcodes/errorcode-form.md
)
。
**示例:**
```
ts
import
formInfo
from
'
@ohos.app.form.formInfo
'
;
import
formProvider
from
'
@ohos.app.form.formProvider
'
;
const
filter
:
formInfo
.
FormInfoFilter
=
{
// get info of forms belong to module entry.
...
...
@@ -332,13 +329,13 @@ getFormsInfo(filter?: formInfo.FormInfoFilter): Promise<Array<formInfo.For
| 16500050 | An IPC connection error happened. |
| 16500100 | Failed to obtain the configuration information. |
| 16501000 | An internal functional error occurred. |
|以上错误码的详细介绍请参见
[
卡片错误码
](
../errorcodes/errorcode-form.md
)
。||
以上错误码的详细介绍请参见
[
卡片错误码
](
../errorcodes/errorcode-form.md
)
。
**示例:**
```
ts
import
formInfo
from
'
@ohos.app.form.formInfo
'
;
import
formProvider
from
'
@ohos.app.form.formProvider
'
;
const
filter
:
formInfo
.
FormInfoFilter
=
{
// get info of forms belong to module entry.
...
...
@@ -382,13 +379,13 @@ requestPublishForm(want: Want, formBindingData: formBindingData.FormBindingData,
| 16500050 | An IPC connection error happened. |
| 16500100 | Failed to obtain the configuration information. |
| 16501000 | An internal functional error occurred. |
|以上错误码的详细介绍请参见
[
卡片错误码
](
../errorcodes/errorcode-form.md
)
。||
以上错误码的详细介绍请参见
[
卡片错误码
](
../errorcodes/errorcode-form.md
)
。
**示例:**
```
ts
import
formBindingData
from
'
@ohos.app.form.formBindingData
'
;
import
formProvider
from
'
@ohos.app.form.formProvider
'
;
let
want
=
{
abilityName
:
'
FormAbility
'
,
...
...
@@ -438,13 +435,12 @@ requestPublishForm(want: Want, callback: AsyncCallback<string>): void
| 16500050 | An IPC connection error happened. |
| 16500100 | Failed to obtain the configuration information. |
| 16501000 | An internal functional error occurred. |
|以上错误码的详细介绍请参见
[
卡片错误码
](
../errorcodes/errorcode-form.md
)
。||
以上错误码的详细介绍请参见
[
卡片错误码
](
../errorcodes/errorcode-form.md
)
。
**示例:**
```
ts
import
formProvider
from
'
@ohos.app.form.formProvider
'
;
let
want
=
{
abilityName
:
'
FormAbility
'
,
parameters
:
{
...
...
@@ -498,13 +494,12 @@ requestPublishForm(want: Want, formBindingData?: formBindingData.FormBindingData
| 16500050 | An IPC connection error happened. |
| 16500100 | Failed to obtain the configuration information. |
| 16501000 | An internal functional error occurred. |
|以上错误码的详细介绍请参见
[
卡片错误码
](
../errorcodes/errorcode-form.md
)
。||
以上错误码的详细介绍请参见
[
卡片错误码
](
../errorcodes/errorcode-form.md
)
。
**示例:**
```
ts
import
formProvider
from
'
@ohos.app.form.formProvider
'
;
let
want
=
{
abilityName
:
'
FormAbility
'
,
parameters
:
{
...
...
@@ -548,13 +543,12 @@ isRequestPublishFormSupported(callback: AsyncCallback<boolean>): void
| 401 | If the input parameter is not valid parameter. |
| 16500050 | An IPC connection error happened. |
| 16501000 | An internal functional error occurred. |
|以上错误码的详细介绍请参见
[
卡片错误码
](
../errorcodes/errorcode-form.md
)
。||
以上错误码的详细介绍请参见
[
卡片错误码
](
../errorcodes/errorcode-form.md
)
。
**示例:**
```
ts
import
formProvider
from
'
@ohos.app.form.formProvider
'
;
try
{
formProvider
.
isRequestPublishFormSupported
((
error
,
isSupported
)
=>
{
if
(
error
)
{
...
...
@@ -611,13 +605,12 @@ isRequestPublishFormSupported(): Promise<boolean>
| 202 | The application is not a system application. |
| 16500050 | An IPC connection error happened. |
| 16501000 | An internal functional error occurred. |
|以上错误码的详细介绍请参见
[
卡片错误码
](
../errorcodes/errorcode-form.md
)
。||
以上错误码的详细介绍请参见
[
卡片错误码
](
../errorcodes/errorcode-form.md
)
。
**示例:**
```
ts
import
formProvider
from
'
@ohos.app.form.formProvider
'
;
try
{
formProvider
.
isRequestPublishFormSupported
().
then
((
isSupported
)
=>
{
if
(
isSupported
)
{
...
...
zh-cn/application-dev/reference/apis/js-apis-application-appManager.md
浏览文件 @
9643df3c
...
...
@@ -400,7 +400,11 @@ killProcessWithAccount(bundleName: string, accountId: number): Promise\<void\>
切断account进程(Promise形式)。
**需要权限**
:ohos.permission.CLEAN_BACKGROUND_PROCESSES,ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS,当accountId为当前用户时,不需要校验ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS权限。
> **说明:**
>
> 当accountId为当前用户时,不需要校验ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS权限。
**需要权限**
:ohos.permission.CLEAN_BACKGROUND_PROCESSES,ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
...
...
@@ -434,11 +438,15 @@ killProcessWithAccount(bundleName: string, accountId: number, callback: AsyncCal
切断account进程(callback形式)。
> **说明:**
>
> 当accountId为当前用户时,不需要校验ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS权限。
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
**系统API**
: 此接口为系统接口,三方应用不支持调用。
**需要权限**
:ohos.permission.CLEAN_BACKGROUND_PROCESSES,ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS
,当accountId为当前用户时,不需要校验ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS权限。
**需要权限**
:ohos.permission.CLEAN_BACKGROUND_PROCESSES,ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS
**参数:**
...
...
zh-cn/application-dev/reference/apis/js-apis-application-configuration.md
浏览文件 @
9643df3c
...
...
@@ -3,9 +3,16 @@
定义环境变化信息。Configuration是接口定义,仅做字段声明。
> **说明:**
>
> 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
> 本模块从API version 9废弃,替换模块为[@ohos.app.ability.Configuration (Configuration)](js-apis-app-ability-configuration.md)
## 导入模块
```
ts
import
Configuration
from
'
@ohos.app.application.Configuration
'
;
```
**系统能力**
:以下各项对应的系统能力均为SystemCapability.Ability.AbilityBase
| 名称 | 类型 | 可读 | 可写 | 说明 |
...
...
zh-cn/application-dev/reference/apis/js-apis-application-environmentCallback.md
已删除
100755 → 0
浏览文件 @
8773f51b
# @ohos.application.EnvironmentCallback (EnvironmentCallback)
EnvironmentCallback模块提供应用上下文ApplicationContext对系统环境变化监听回调的能力,包括onConfigurationUpdated、onMemoryLevel方法。
> **说明:**
>
> 本模块首批接口从API version 9 开始支持,从API version 9后续版本废弃,替换模块为[@ohos.app.ability.EnvironmentCallback](js-apis-app-ability-environmentCallback.md)。后续版本的新增接口,采用上角标单独标记接口的起始版本。
> 本模块接口仅可在Stage模型下使用。
## 导入模块
```
ts
import
EnvironmentCallback
from
'
@ohos.application.EnvironmentCallback
'
;
```
## EnvironmentCallback.onConfigurationUpdated
onConfigurationUpdated(config: Configuration): void;
注册系统环境变化的监听后,在系统环境变化时触发回调。
**系统能力**
:SystemCapability.Ability.AbilityRuntime.AbilityCore
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| config |
[
Configuration
](
js-apis-application-configuration.md
)
| 是 | 变化后的Configuration对象。 |
## EnvironmentCallback.onMemoryLevel
onMemoryLevel(level: number): void;
注册系统内存基线水平变化监听后,在系统内存基线水平变化时触发回调。
**系统能力**
:SystemCapability.Ability.AbilityRuntime.AbilityCore
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| level |
[
MemoryLevel
](
js-apis-app-ability-abilityConstant.md#abilityconstantmemorylevel
)
| 是 | 表示当前内存的基线水平。 |
**示例:**
```
ts
import
UIAbility
from
'
@ohos.app.ability.UIAbility
'
;
let
callbackId
;
export
default
class
EntryAbility
extends
UIAbility
{
onCreate
()
{
console
.
log
(
'
MyAbility onCreate
'
);
globalThis
.
applicationContext
=
this
.
context
.
getApplicationContext
();
let
environmentCallback
=
{
onConfigurationUpdated
(
config
){
console
.
log
(
'
onConfigurationUpdated config: ${JSON.stringify(config)}
'
);
},
onMemoryLevel
(
level
){
console
.
log
(
'
onMemoryLevel level: ${level}
'
);
}
};
// 1.获取applicationContext
let
applicationContext
=
globalThis
.
applicationContext
;
// 2.通过applicationContext注册监听应用内生命周期
callbackId
=
applicationContext
.
registerEnvironmentCallback
(
environmentCallback
);
console
.
log
(
'
registerEnvironmentCallback number: ${JSON.stringify(callbackId)}
'
);
}
onDestroy
()
{
let
applicationContext
=
globalThis
.
applicationContext
;
applicationContext
.
unregisterEnvironmentCallback
(
callbackId
,
(
error
,
data
)
=>
{
if
(
error
&&
error
.
code
!==
0
)
{
console
.
error
(
'
unregisterEnvironmentCallback fail, error: ${JSON.stringify(error)}
'
);
}
else
{
console
.
log
(
'
unregisterEnvironmentCallback success, data: ${JSON.stringify(data)}
'
);
}
});
}
}
```
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-businessAbilityRouter.md
浏览文件 @
9643df3c
...
...
@@ -26,9 +26,9 @@ import businessAbilityRouter from '@ohos.app.businessAbilityRouter';
此枚举值用于标识过滤条件类型。
**系统能力:**
以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework.Core
。
**系统能力:**
以下各项对应的系统能力均为SystemCapability.BundleManager.BundleFramework.Core
**系统
接口:**
此接口为系统接口。
**系统
API:**
此接口为系统接口。
| 名称 | 值 | 说明 |
| ----------- | ---- | ------------------------------------ |
...
...
@@ -39,9 +39,9 @@ import businessAbilityRouter from '@ohos.app.businessAbilityRouter';
此过滤值用于过滤查询的ability类型。
**系统能力:**
SystemCapability.BundleManager.BundleFrame
Work.FreeInstall
**系统能力:**
SystemCapability.BundleManager.BundleFrame
work.Core
**系统
接口:**
此接口为系统接口。
**系统
API:**
此接口为系统接口。
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ------------ | ------------ | ---- | ---- | -------------------------------------- |
...
...
zh-cn/application-dev/reference/apis/js-apis-distributedMissionManager.md
浏览文件 @
9643df3c
...
...
@@ -360,7 +360,7 @@ continueMission(parameter: ContinueDeviceInfo, options: ContinueCallback, callba
迁移任务,以回调函数的方式返回。
**需要权限**
:ohos.permission.MANAGE_MISSIONS
and
ohos.permission.DISTRIBUTED_DATASYNC
**需要权限**
:ohos.permission.MANAGE_MISSIONS
,
ohos.permission.DISTRIBUTED_DATASYNC
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Mission
...
...
@@ -418,7 +418,7 @@ continueMission(parameter: ContinueDeviceInfo, options: ContinueCallback): Promi
迁移任务,以promise方式返回执行结果。
**需要权限**
:ohos.permission.MANAGE_MISSIONS
and
ohos.permission.DISTRIBUTED_DATASYNC
**需要权限**
:ohos.permission.MANAGE_MISSIONS
,
ohos.permission.DISTRIBUTED_DATASYNC
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Mission
...
...
zh-cn/application-dev/reference/apis/js-apis-inner-ability-connectOptions.md
浏览文件 @
9643df3c
...
...
@@ -2,6 +2,10 @@
在连接指定的后台服务时作为入参,用于接收连接过程中的状态变化,如作为
[
connectServiceExtensionAbility
](
js-apis-inner-application-uiAbilityContext.md#uiabilitycontextconnectserviceextensionability
)
的入参,连接指定的ServiceExtensionAbility。
> **说明:**
>
> 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
## 导入模块
```
ts
...
...
zh-cn/application-dev/reference/apis/js-apis-inner-application-abilityStageMonitor.md
浏览文件 @
9643df3c
...
...
@@ -2,13 +2,16 @@
提供用于匹配满足指定条件的受监视的AbilityStage对象的方法。最近匹配的AbilityStage对象将保存在AbilityStageMonitor对象中。
> **说明:**
>
> 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
**系统能力**
:以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ------------------------------------------------------------ | -------- | ---- | ---- | ------------------------------------------------------------ |
| moduleName
<sup>
9+
</sup>
| string | 是 | 是 | 要监视的abilityStage的模块名。 |
| srcEntrance
<sup>
9+
</sup>
| string | 是 | 是 | 要监视的abilityStage的源路径。 |
| moduleName | string | 是 | 是 | 要监视的abilityStage的模块名。 |
| srcEntrance | string | 是 | 是 | 要监视的abilityStage的源路径。 |
**示例:**
```
ts
...
...
zh-cn/application-dev/reference/apis/js-apis-inner-application-abilityStateData.md
浏览文件 @
9643df3c
...
...
@@ -2,6 +2,10 @@
定义Ability状态信息,可以通过
[
registerApplicationStateObserver
](
js-apis-application-appManager.md#appmanagerregisterapplicationstateobserver8
)
注册生命周期变化监听后,通过
[
ApplicationStateObserver
](
js-apis-inner-application-applicationStateObserver.md
)
的onAbilityStateChanged生命周期回调获取。
> **说明:**
>
> 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
## 导入模块
```
ts
...
...
@@ -12,13 +16,13 @@ import appManager from '@ohos.application.appManager';
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ----------------------- | ---------| ---- | ---- | ------------------------- |
| pid
<sup>
8+
</sup>
| number | 是 | 否 | 进程ID。 |
| bundleName
<sup>
8+
</sup>
| string | 是 | 否 | 应用Bundle名称。 |
| abilityName
<sup>
8+
</sup>
| string | 是 | 否 | Ability名称。 |
| uid
<sup>
8+
</sup>
| number | 是 | 否 | 用户ID。 |
| state
<sup>
8+
</sup>
| number | 是 | 否 |
[
Ability状态
](
#ability状态
)
。 |
| pid | number | 是 | 否 | 进程ID。 |
| bundleName | string | 是 | 否 | 应用Bundle名称。 |
| abilityName | string | 是 | 否 | Ability名称。 |
| uid | number | 是 | 否 | 用户ID。 |
| state | number | 是 | 否 |
[
Ability状态
](
#ability状态
)
。 |
| moduleName
<sup>
9+
</sup>
| string | 是 | 否 | Ability所属的HAP的名称。 |
| abilityType
<sup>
8+
</sup>
| number | 是 | 否 |
[
Ability类型
](
#ability类型
)
:页面或服务等。 |
| abilityType | number | 是 | 否 |
[
Ability类型
](
#ability类型
)
:页面或服务等。 |
#### Ability状态
...
...
zh-cn/application-dev/reference/apis/js-apis-inner-application-applicationContext.md
浏览文件 @
9643df3c
...
...
@@ -309,7 +309,6 @@ getRunningProcessInformation(): Promise\<Array\<ProcessInformation>>;
**示例:**
```
ts
let
applicationContext
=
this
.
context
.
getApplicationContext
();
applicationContext
.
getRunningProcessInformation
().
then
((
data
)
=>
{
console
.
log
(
'
The process running information is: ${JSON.stringify(data)}
'
);
}).
catch
((
error
)
=>
{
...
...
@@ -347,7 +346,6 @@ getRunningProcessInformation(callback: AsyncCallback\<Array\<ProcessInformation>
**示例:**
```
ts
let
applicationContext
=
this
.
context
.
getApplicationContext
();
applicationContext
.
getRunningProcessInformation
((
err
,
data
)
=>
{
if
(
err
)
{
console
.
error
(
'
getRunningProcessInformation faile, err: ${JSON.stringify(err)}
'
);
...
...
@@ -382,7 +380,6 @@ killAllProcesses(): Promise\<void\>;
**示例:**
```
ts
let
applicationContext
=
this
.
context
.
getApplicationContext
();
applicationContext
.
killAllProcesses
();
```
...
...
@@ -411,7 +408,6 @@ killAllProcesses(callback: AsyncCallback\<void\>);
**示例:**
```
ts
let
applicationContext
=
this
.
context
.
getApplicationContext
();
applicationContext
.
killAllProcesses
(
error
=>
{
if
(
error
)
{
console
.
error
(
'
killAllProcesses fail, error: ${JSON.stringify(error)}
'
);
...
...
zh-cn/application-dev/reference/apis/js-apis-inner-application-applicationStateObserver.md
浏览文件 @
9643df3c
...
...
@@ -2,10 +2,14 @@
定义应用状态监听,可以作为
[
registerApplicationStateObserver
](
js-apis-application-appManager.md#appmanagerregisterapplicationstateobserver8
)
的入参监听当前应用的生命周期变化。
> **说明:**
>
> 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
## 导入模块
```
ts
import
appManager
from
'
@ohos.app
lication
.appManager
'
;
import
appManager
from
'
@ohos.app
.ability
.appManager
'
;
```
**系统能力**
:以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
...
...
@@ -14,16 +18,14 @@ import appManager from '@ohos.application.appManager';
| 名称 | | 类型 | 可读 | 可写 | 说明 |
| ----------------------- | ---------| ---- | ---- | ------------------------- | ------------------------- |
| onForegroundApplicationChanged
<sup>
8+
</sup>
|
[
AppStateData
](
js-apis-inner-application-appStateData.md
)
| AsyncCallback
\<
void> | 是 | 否 | 应用前后台状态发生变化时执行的回调函数。 |
| onAbilityStateChanged
<sup>
8+
</sup>
|
[
AbilityStateData
](
js-apis-inner-application-abilityStateData.md
)
| AsyncCallback
\<
void> | 是 | 否 | ability状态发生变化时执行的回调函数。 |
| onProcessCreated
<sup>
8+
</sup>
|
[
ProcessData
](
js-apis-inner-application-processData.md
)
| AsyncCallback
\<
void> | 是 | 否 | 进程创建时执行的回调函数。 |
| onProcessDied
<sup>
8+
</sup>
|
[
ProcessData
](
js-apis-inner-application-processData.md
)
| AsyncCallback
\<
void> | 是 | 否 | 进程销毁时执行的回调函数。 |
| onProcessStateChanged
<sup>
8
+
</sup>
|
[
ProcessData
](
js-apis-inner-application-processData.md
)
| AsyncCallback
\<
void> | 是 | 否 | 进程状态更新时执行的回调函数。 |
| onForegroundApplicationChanged |
[
AppStateData
](
js-apis-inner-application-appStateData.md
)
| AsyncCallback
\<
void> | 是 | 否 | 应用前后台状态发生变化时执行的回调函数。 |
| onAbilityStateChanged |
[
AbilityStateData
](
js-apis-inner-application-abilityStateData.md
)
| AsyncCallback
\<
void> | 是 | 否 | ability状态发生变化时执行的回调函数。 |
| onProcessCreated |
[
ProcessData
](
js-apis-inner-application-processData.md
)
| AsyncCallback
\<
void> | 是 | 否 | 进程创建时执行的回调函数。 |
| onProcessDied |
[
ProcessData
](
js-apis-inner-application-processData.md
)
| AsyncCallback
\<
void> | 是 | 否 | 进程销毁时执行的回调函数。 |
| onProcessStateChanged
<sup>
9
+
</sup>
|
[
ProcessData
](
js-apis-inner-application-processData.md
)
| AsyncCallback
\<
void> | 是 | 否 | 进程状态更新时执行的回调函数。 |
**示例:**
```
ts
import
appManager
from
'
@ohos.app.ability.appManager
'
;
let
applicationStateObserver
=
{
onForegroundApplicationChanged
(
appStateData
)
{
console
.
log
(
'
onForegroundApplicationChanged appStateData: ${JSON.stringify(appStateData)}
'
);
...
...
zh-cn/application-dev/reference/apis/js-apis-inner-application-continueCallback.md
浏览文件 @
9643df3c
...
...
@@ -2,6 +2,10 @@
表示跨设备迁移Mission完成后,返回迁移结果的回调函数,迁移Mission详见:
[
continueMission接口
](
js-apis-distributedMissionManager.md#distributedmissionmanagercontinuemission
)
。
> **说明:**
>
> 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
## ContinueCallback.onContinueDone
onContinueDone(result: number): void;
...
...
zh-cn/application-dev/reference/apis/js-apis-inner-application-continueDeviceInfo.md
浏览文件 @
9643df3c
...
...
@@ -2,6 +2,10 @@
表示发起Mission迁移时所需参数的枚举,迁移Mission详见:
[
continueMission接口
](
js-apis-distributedMissionManager.md#distributedmissionmanagercontinuemission
)
。
> **说明:**
>
> 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Mission
| 名称 | 类型 | 可读 | 可写 | 说明 |
...
...
zh-cn/application-dev/reference/apis/js-apis-inner-application-errorObserver.md
浏览文件 @
9643df3c
...
...
@@ -2,6 +2,10 @@
定义异常监听,可以作为
[
ErrorManager.on
](
js-apis-app-ability-errorManager.md#errormanageron
)
的入参监听当前应用发生的异常。
> **说明:**
>
> 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
## 导入模块
```
ts
...
...
@@ -40,7 +44,7 @@ try {
}
```
## ErrorObserver.onException
## ErrorObserver.onException
<sup>10+</sup>
onException?(errObject: Error): void;
...
...
zh-cn/application-dev/reference/apis/js-apis-inner-application-formExtensionContext.md
浏览文件 @
9643df3c
...
...
@@ -23,7 +23,7 @@ import common from '@ohos.app.ability.common';
import
FormExtensionAbility
from
'
@ohos.app.form.FormExtensionAbility
'
;
import
formBindingData
from
'
@ohos.app.form.formBindingData
'
;
export
default
class
MyFormExtensionAbility
extends
FormExtensionAbility
{
class
MyFormExtensionAbility
extends
FormExtensionAbility
{
onAddForm
(
want
)
{
let
formContext
=
this
.
context
;
// 获取FormExtensionContext
// ...
...
...
zh-cn/application-dev/reference/apis/js-apis-inner-application-missionCallbacks.md
浏览文件 @
9643df3c
...
...
@@ -2,6 +2,10 @@
作为可以
[
registerMissionListener
](
js-apis-distributedMissionManager.md#distributedmissionmanagerregistermissionlistener
)
的入参,表示开始同步后,建立的回调函数。
> **说明:**
>
> 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Mission
| 名称 | 类型 | 可读 | 可写 | 说明 |
...
...
zh-cn/application-dev/reference/apis/js-apis-inner-application-missionInfo.md
浏览文件 @
9643df3c
...
...
@@ -2,6 +2,10 @@
表示任务的详细信息,可以通过
[
getMissionInfo
](
js-apis-app-ability-missionManager.md#missionmanagergetmissioninfo
)
获取。
> **说明:**
>
> 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
## 导入模块
```
ts
...
...
zh-cn/application-dev/reference/apis/js-apis-inner-application-missionListener.md
浏览文件 @
9643df3c
...
...
@@ -2,6 +2,10 @@
定义系统任务状态监听,可以通过
[
on
](
js-apis-app-ability-missionManager.md#missionmanageron
)
注册。
> **说明:**
>
> 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
## 导入模块
```
ts
...
...
@@ -16,9 +20,9 @@ import missionManager from '@ohos.app.ability.missionManager';
| onMissionDestroyed | function | 否 | 表示当系统销毁任务时回调执行。 |
| onMissionSnapshotChanged | function | 否 | 表示当系统更新任务缩略图时回调执行。 |
| onMissionMovedToFront | function | 否 | 表示当系统将任务移动到前台时回调执行。 |
| onMissionLabelUpdated | function | 否 | 表示当系统更新任务标签时回调执行。 |
| onMissionIconUpdated | function | 否 | 表示当系统更新任务图标时回调执行。 |
| onMissionClosed | function | 否 | 表示当系统关闭任务时回调执行。 |
| onMissionLabelUpdated
<sup>
9+
</sup>
| function | 否 | 表示当系统更新任务标签时回调执行。 |
| onMissionIconUpdated
<sup>
9+
</sup>
| function | 否 | 表示当系统更新任务图标时回调执行。 |
| onMissionClosed
<sup>
9+
</sup>
| function | 否 | 表示当系统关闭任务时回调执行。 |
**示例:**
```
ts
...
...
zh-cn/application-dev/reference/apis/js-apis-inner-application-missionParameter.md
浏览文件 @
9643df3c
...
...
@@ -2,6 +2,10 @@
作为
[
startSyncRemoteMissions
](
js-apis-distributedMissionManager.md#distributedmissionmanagerstartsyncremotemissions
)
的入参,表示同步时所需参数的枚举。
> **说明:**
>
> 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Mission
| 名称 | 类型 | 可读 | 可写 | 说明 |
...
...
zh-cn/application-dev/reference/apis/js-apis-inner-application-processData.md
浏览文件 @
9643df3c
...
...
@@ -2,10 +2,14 @@
进程数据的对象定义。使用接口
[
registerApplicationStateObserver
](
js-apis-application-appManager.md#appmanagerregisterapplicationstateobserver8
)
注册生命周期变化监听后,当应用或组件的生命周期变化时,系统通过
[
ApplicationStateObserver
](
js-apis-inner-application-applicationStateObserver.md
)
的onProcessCreated等方法回调给开发者。
> **说明:**
>
> 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
## 导入模块
```
ts
import
appManager
from
'
@ohos.app
.ability
.appManager
'
;
import
appManager
from
'
@ohos.app
lication
.appManager
'
;
```
**系统能力**
:以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core
...
...
@@ -14,16 +18,16 @@ import appManager from '@ohos.app.ability.appManager';
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ----------------------- | ---------| ---- | ---- | ------------------------- |
| pid
<sup>
8+
</sup>
| number | 是 | 否 | 进程ID。 |
| bundleName
<sup>
8+
</sup>
| string | 是 | 否 | 应用包名。 |
| uid
<sup>
8+
</sup>
| number | 是 | 否 | 应用的uid。 |
| pid | number | 是 | 否 | 进程ID。 |
| bundleName | string | 是 | 否 | 应用包名。 |
| uid | number | 是 | 否 | 应用的uid。 |
| isContinuousTask
<sup>
9+
</sup>
| boolean | 是 | 否 | 是否为长时任务,true表示是,false表示不是 |
| isKeepAlive
<sup>
9+
</sup>
| boolean | 是 | 否 | 是否为常驻进程,true表示是,false表示不是 |
| state
<sup>
9+
</sup>
| number | 是 | 否 | 应用的状态,取值及对应的状态为:0(刚创建),2(前台),4(后台),5(已终止)。 |
**示例:**
```
ts
import
appManager
from
'
@ohos.app
.ability
.appManager
'
;
import
appManager
from
'
@ohos.app
lication
.appManager
'
;
let
applicationStateObserver
=
{
onForegroundApplicationChanged
(
appStateData
)
{
...
...
zh-cn/application-dev/reference/apis/js-apis-inner-application-uiAbilityContext.md
浏览文件 @
9643df3c
...
...
@@ -367,7 +367,7 @@ try {
// 执行正常业务
console
.
info
(
'
startAbilityForResult succeed
'
);
});
}
catch
(
paramErro
r
)
{
}
catch
(
er
r
)
{
// 处理入参错误异常
console
.
error
(
`startAbilityForResult failed, code is
${
err
.
code
}
, message is
${
err
.
message
}
`
);
}
...
...
@@ -785,7 +785,7 @@ try {
// 处理业务逻辑错误
console
.
error
(
`startServiceExtensionAbility failed, code is
${
err
.
code
}
, message is
${
err
.
message
}
`
);
});
}
catch
(
paramErro
r
)
{
}
catch
(
er
r
)
{
// 处理入参错误异常
console
.
error
(
`startServiceExtensionAbility failed, code is
${
err
.
code
}
, message is
${
err
.
message
}
`
);
}
...
...
@@ -1397,6 +1397,7 @@ let want = {
bundleName
:
'
com.example.myapplication
'
,
abilityName
:
'
ServiceExtensionAbility
'
};
let
commRemote
;
let
options
=
{
onConnect
(
elementName
,
remote
)
{
commRemote
=
remote
;
...
...
@@ -1466,6 +1467,7 @@ let want = {
abilityName
:
'
ServiceExtensionAbility
'
};
let
accountId
=
100
;
let
commRemote
;
let
options
=
{
onConnect
(
elementName
,
remote
)
{
commRemote
=
remote
;
...
...
@@ -1522,6 +1524,7 @@ disconnectServiceExtensionAbility(connection: number): Promise\<void>;
```
ts
// connection为connectServiceExtensionAbility中的返回值
let
connection
=
1
;
let
commRemote
;
try
{
this
.
context
.
disconnectServiceExtensionAbility
(
connection
,
(
err
)
=>
{
...
...
@@ -1570,6 +1573,24 @@ disconnectServiceExtensionAbility(connection: number, callback:AsyncCallback\<vo
```
ts
// connection为connectServiceExtensionAbility中的返回值
let
connection
=
1
;
let
commRemote
;
try
{
this
.
context
.
disconnectServiceExtensionAbility
(
connection
,
(
err
)
=>
{
commRemote
=
null
;
if
(
err
.
code
)
{
// 处理业务逻辑错误
console
.
error
(
`disconnectServiceExtensionAbility failed, code is
${
err
.
code
}
, message is
${
err
.
message
}
`
);
return
;
}
// 执行正常业务
console
.
info
(
'
disconnectServiceExtensionAbility succeed
'
);
});
}
catch
(
err
)
{
commRemote
=
null
;
// 处理入参错误异常
console
.
error
(
`disconnectServiceExtensionAbility failed, code is
${
err
.
code
}
, message is
${
err
.
message
}
`
);
}
try
{
this
.
context
.
disconnectServiceExtensionAbility
(
connection
,
(
err
)
=>
{
...
...
@@ -1683,11 +1704,11 @@ try {
// 执行正常业务
caller
=
obj
;
console
.
info
(
'
startAbilityByCall succeed
'
);
}).
catch
((
err
or
)
=>
{
}).
catch
((
err
)
=>
{
// 处理业务逻辑错误
console
.
error
(
`startAbilityByCall failed, code is
${
err
.
code
}
, message is
${
err
.
message
}
`
);
});
}
catch
(
paramErro
r
)
{
}
catch
(
er
r
)
{
// 处理入参错误异常
console
.
error
(
`startAbilityByCall failed, code is
${
err
.
code
}
, message is
${
err
.
message
}
`
);
}
...
...
@@ -2071,6 +2092,8 @@ setMissionIcon(icon: image.PixelMap): Promise\<void>;
**示例:**
```
ts
import
image
from
'
@ohos.multimedia.image
'
;
let
imagePixelMap
;
let
color
=
new
ArrayBuffer
(
0
);
let
initializationOptions
=
{
...
...
zh-cn/application-dev/reference/apis/js-apis-inner-wantAgent-triggerInfo.md
浏览文件 @
9643df3c
...
...
@@ -2,6 +2,10 @@
作为
[
trigger
](
js-apis-app-ability-wantAgent.md#wantagenttrigger
)
的入参定义触发WantAgent所需要的信息。
> **说明:**
>
> 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
## 导入模块
```
ts
...
...
zh-cn/application-dev/reference/apis/js-apis-inner-wantAgent-wantAgentInfo.md
浏览文件 @
9643df3c
...
...
@@ -2,6 +2,10 @@
定义触发WantAgent所需要的信息,可以作为
[
getWantAgent
](
js-apis-app-ability-wantAgent.md#wantagentgetwantagent
)
的入参创建指定的WantAgent对象。
> **说明:**
>
> 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
## 导入模块
```
ts
...
...
zh-cn/application-dev/reference/apis/js-apis-uripermissionmanager.md
浏览文件 @
9643df3c
...
...
@@ -11,7 +11,7 @@ URI权限管理模块。用于应用A授权/撤销授权URI给应用B
```
js
import
U
riPermissionManager
from
'
@ohos.application.uriPermissionManager
'
;
import
u
riPermissionManager
from
'
@ohos.application.uriPermissionManager
'
;
```
...
...
zh-cn/application-dev/reference/apis/js-apis-wantAgent.md
浏览文件 @
9643df3c
...
...
@@ -20,6 +20,8 @@ getWant(agent: WantAgent, callback: AsyncCallback\<Want\>): void
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
**系统API**
:该接口为系统接口,三方应用不支持调用。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
...
...
@@ -91,6 +93,8 @@ getWant(agent: WantAgent): Promise\<Want\>
**系统能力**
:SystemCapability.Ability.AbilityRuntime.Core
**系统API**
:该接口为系统接口,三方应用不支持调用。
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录