diff --git a/zh-cn/application-dev/reference/apis/js-apis-Context.md b/zh-cn/application-dev/reference/apis/js-apis-Context.md index 1d16cea627dddfdf1ce83449b5939dafe2f42823..a2126d2e0593480ebdbfb8de388204ee5c8bac97 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-Context.md +++ b/zh-cn/application-dev/reference/apis/js-apis-Context.md @@ -25,6 +25,10 @@ getOrCreateLocalDir(callback: AsyncCallback\): void 如果是第一次调用，将创建目录。 +**系统能力:** + +SystemCapability.Ability.AbilityRuntime.Core + **参数：** @@ -52,6 +56,10 @@ getOrCreateLocalDir(): Promise\ 如果是第一次调用，将创建目录。 +**系统能力:** + +SystemCapability.Ability.AbilityRuntime.Core + **返回值：** | 类型 | 说明 | @@ -76,6 +84,10 @@ verifyPermission(permission: string, options: PermissionOptions, callback: Async 验证系统中运行的特定pid和uid是否允许指定的权限（callback形式）。 +**系统能力:** + +SystemCapability.Ability.AbilityRuntime.Core + **参数：** @@ -126,6 +138,10 @@ verifyPermission(permission: string, options?: PermissionOptions): Promise\, requestCode: number, res 从系统请求某些权限（callback形式）。 +**系统能力:** + +SystemCapability.Ability.AbilityRuntime.Core + **参数：** @@ -194,6 +214,10 @@ getApplicationInfo(callback: AsyncCallback\) 获取有关当前应用程序的信息（callback形式）。 +**系统能力:** + +SystemCapability.Ability.AbilityRuntime.Core + **参数：** | 名称 | 类型 | 必填 | 描述 | @@ -216,6 +240,10 @@ getApplicationInfo(): Promise\ 获取有关当前应用程序的信息（Promise形式）。 +**系统能力:** + +SystemCapability.Ability.AbilityRuntime.Core + **返回值：** | 类型 | 说明 | @@ -241,6 +269,10 @@ getBundleName(callback: AsyncCallback\): void 获取当前ability的捆绑包名称（callback形式）。 +**系统能力:** + +SystemCapability.Ability.AbilityRuntime.Core + **参数：** | 名称 | 类型 | 必填 | 描述 | @@ -263,6 +295,10 @@ getBundleName(): Promise\ 获取当前ability的捆绑包名称（Promise形式）。 +**系统能力:** + +SystemCapability.Ability.AbilityRuntime.Core + **返回值：** | 类型 | 说明 | @@ -288,6 +324,10 @@ getProcessInfo(callback: AsyncCallback\) 获取有关当前进程的信息，包括进程ID和名称（callback形式）。 +**系统能力:** + +SystemCapability.Ability.AbilityRuntime.Core + **参数：** | 名称 | 类型 | 必填 | 描述 | @@ -310,6 +350,10 @@ getProcessInfo(): Promise\ 获取有关当前进程的信息，包括进程id和名称（Promise形式）。 +**系统能力:** + +SystemCapability.Ability.AbilityRuntime.Core + **返回值：** | 类型 | 说明 | @@ -337,6 +381,10 @@ getElementName(callback: AsyncCallback\): void 此方法仅适用于页面功能。 +**系统能力:** + +SystemCapability.Ability.AbilityRuntime.Core + **参数：** | 名称 | 类型 | 必填 | 描述 | @@ -361,6 +409,10 @@ getElementName(): Promise\ 此方法仅适用于页面功能。 +**系统能力:** + +SystemCapability.Ability.AbilityRuntime.Core + **返回值：** | 类型 | 说明 | @@ -384,6 +436,10 @@ getProcessName(callback: AsyncCallback\): void 获取当前进程的名称（callback形式）。 +**系统能力:** + +SystemCapability.Ability.AbilityRuntime.Core + | 名称 | 类型 | 必填 | 描述 | | -------- | ---------------------- | ---- | -------------------- | | callback | AsyncCallback\ | 是 | 返回当前进程的名称。 | @@ -404,6 +460,10 @@ getProcessName(): Promise\ 获取当前进程的名称（Promise形式）。 +**系统能力:** + +SystemCapability.Ability.AbilityRuntime.Core + **返回值：** | 类型 | 说明 | @@ -429,6 +489,10 @@ getCallingBundle(callback: AsyncCallback\): void 获取调用ability的包名称（callback形式）。 +**系统能力:** + +SystemCapability.Ability.AbilityRuntime.Core + **参数：** | 名称 | 类型 | 必填 | 描述 | @@ -451,6 +515,10 @@ getCallingBundle(): Promise\ 获取调用ability的包名称（Promise形式）。 +**系统能力:** + +SystemCapability.Ability.AbilityRuntime.Core + **返回值：** | 类型 | 说明 | @@ -472,13 +540,13 @@ context.getCallingBundle().then((data) => { | 名称 | 读写属性 | 类型 | 必填 | 描述 | | ---- | -------- | ------ | ---- | ------ | -| pid | 只读 | number | 否 | 进程id | -| uid | 只读 | number | 否 | 用户id | +| pid | 只读 | number | 否 | 进程id
系统能力：SystemCapability.Ability.AbilityRuntime.Core| +| uid | 只读 | number | 否 | 用户id
系统能力：SystemCapability.Ability.AbilityRuntime.Core | ## PermissionRequestResult | 名称 | 读写属性 | 类型 | 必填 | 描述 | | ----------- | -------- | -------------- | ---- | ------------------ | -| requestCode | 只读 | number | 是 | 用户传入的请求代码 | -| permissions | 只读 | Array\ | 是 | 用户传入的权限 | -| authResults | 只读 | Array\ | 是 | 求权限的结果 | +| requestCode | 只读 | number | 是 | 用户传入的请求代码
系统能力：SystemCapability.Ability.AbilityRuntime.Core | +| permissions | 只读 | Array\ | 是 | 用户传入的权限
系统能力：SystemCapability.Ability.AbilityRuntime.Core | +| authResults | 只读 | Array\ | 是 | 求权限的结果
系统能力：SystemCapability.Ability.AbilityRuntime.Core | diff --git a/zh-cn/application-dev/reference/apis/js-apis-ability-context.md b/zh-cn/application-dev/reference/apis/js-apis-ability-context.md index e55c684dc866fad4c8df94b1229cae6301b72f94..fe0cc01c0233ec1a5663546eba911d6f1080310f 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-ability-context.md +++ b/zh-cn/application-dev/reference/apis/js-apis-ability-context.md @@ -57,6 +57,10 @@ startAbility(want: Want, callback: AsyncCallback<void>): void 启动Ability。 +**系统能力:** + +SystemCapability.Ability.AbilityRuntime.Core + - 参数： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | @@ -82,6 +86,10 @@ startAbility(want: Want, options: StartOptions, callback: AsyncCallback<void& 启动Ability。 +**系统能力:** + +SystemCapability.Ability.AbilityRuntime.Core + - 参数： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | @@ -112,6 +120,10 @@ startAbility(want: Want, options: StartOptions): Promise<void>; 启动Ability。通过Promise返回结果。 +**系统能力:** + +SystemCapability.Ability.AbilityRuntime.Core + - 参数： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | @@ -148,6 +160,10 @@ startAbilityForResult(want: Want, callback: AsyncCallback<AbilityResult>): 启动Ability并在结束的时候返回执行结果。 +**系统能力:** + +SystemCapability.Ability.AbilityRuntime.Core + - 参数： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | @@ -172,6 +188,10 @@ startAbilityForResult(want: Want, options: StartOptions, callback: AsyncCallback 启动Ability并在结束的时候返回执行结果。 +**系统能力:** + +SystemCapability.Ability.AbilityRuntime.Core + - 参数： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | @@ -201,6 +221,10 @@ startAbilityForResult(want: Want, options: StartOptions): Promise<AbilityResu 启动Ability并在结束的时候返回执行结果。 +**系统能力:** + +SystemCapability.Ability.AbilityRuntime.Core + - 参数： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | @@ -232,6 +256,10 @@ terminateSelf(callback: AsyncCallback<void>): void; 停止Ability自身。 +**系统能力:** + +SystemCapability.Ability.AbilityRuntime.Core + - 参数： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | @@ -251,6 +279,10 @@ terminateSelf(): Promise<void>; 停止Ability自身。通过Promise返回结果。 +**系统能力:** + +SystemCapability.Ability.AbilityRuntime.Core + - 返回值： | 类型 | 说明 | | -------- | -------- | @@ -272,6 +304,10 @@ terminateSelfWithResult(parameter: AbilityResult, callback: AsyncCallback<voi 停止Ability，并返回给调用startAbilityForResult 接口调用方的相关信息。 +**系统能力:** + +SystemCapability.Ability.AbilityRuntime.Core + - 参数 | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | @@ -297,6 +333,10 @@ terminateSelfWithResult(parameter: AbilityResult): Promise<void>; 停止Ability，并返回给调用startAbilityForResult 接口相关信息。 +**系统能力:** + +SystemCapability.Ability.AbilityRuntime.Core + - 参数： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | @@ -326,6 +366,10 @@ startAbilityByCall(want: Want): Promise<Caller>; 获取指定通用组件服务端的caller通信接口, 并且将指定通用组件服务端拉起并切换到后台。 +**系统能力:** + +SystemCapability.Ability.AbilityRuntime.Core + - 参数： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | @@ -364,6 +408,10 @@ requestPermissionsFromUser(permissions: Array<string>, requestCallback: As 拉起弹窗请求用户授权。 +**系统能力:** + +SystemCapability.Ability.AbilityRuntime.Core + - 参数： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | @@ -385,6 +433,10 @@ requestPermissionsFromUser(permissions: Array<string>) : Promise<Permis 拉起弹窗请求用户授权。通过Promise返回结果。 +**系统能力:** + +SystemCapability.Ability.AbilityRuntime.Core + - 参数： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | @@ -412,6 +464,10 @@ setMissionLabel(label: string, callback:AsyncCallback<void>): void; 设置ability在任务中显示的名称。 +**系统能力:** + +SystemCapability.Ability.AbilityRuntime.Core + - 参数： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | @@ -433,6 +489,10 @@ setMissionLabel(label: string, callback:AsyncCallback<void>): void; 设置ability在任务中显示的名称。 +**系统能力:** + +SystemCapability.Ability.AbilityRuntime.Core + - 参数： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | diff --git a/zh-cn/application-dev/reference/apis/js-apis-dataAbilityHelper.md b/zh-cn/application-dev/reference/apis/js-apis-dataAbilityHelper.md index 3c0e4627e4c8d0a1fabf9498df7eee99ebb4355e..c26248bb238c4584237f13b0ed026d4bcd99e0e3 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-dataAbilityHelper.md +++ b/zh-cn/application-dev/reference/apis/js-apis-dataAbilityHelper.md @@ -16,6 +16,10 @@ openFile(uri: string, mode: string, callback: AsyncCallback\): void 在指定的远程路径中打开文件（callback形式）。 +**系统能力:** + +SystemCapability.Ability.AbilityRuntime.FAModel + **参数：** | 名称 | 类型 | 必填 | 描述 | @@ -44,6 +48,10 @@ DAHelper.openFile( openFile(uri: string, mode: string): Promise\ +**系统能力:** + +SystemCapability.Ability.AbilityRuntime.FAModel + **参数：** | 名称 | 类型 | 必填 | 描述 | @@ -77,6 +85,10 @@ on(type: 'dataChange', uri: string, callback: AsyncCallback\): void 注册观察者以观察给定uri指定的数据callback通知。 +**系统能力:** + +SystemCapability.Ability.AbilityRuntime.FAModel + **参数：** | 名称 | 类型 | 必填 | 描述 | @@ -108,6 +120,10 @@ off(type: 'dataChange', uri: string, callback?: AsyncCallback\): void 注消观察者以停止观察给定uri指定的数据callback通知。 +**系统能力:** + +SystemCapability.Ability.AbilityRuntime.FAModel + **参数：** | 名称 | 类型 | 必填 | 描述 | @@ -143,6 +159,10 @@ getType(uri: string, callback: AsyncCallback\): void 获取给定URI指定数据的MIME类型（callback形式）。 +**系统能力:** + +SystemCapability.Ability.AbilityRuntime.FAModel + **参数：** | 名称 | 类型 | 必填 | 描述 | @@ -170,6 +190,10 @@ getType(uri: string): Promise\ 获取给定URI指定数据的MIME类型（Promise形式）。 +**系统能力:** + +SystemCapability.Ability.AbilityRuntime.FAModel + **参数：** | 名称 | 类型 | 必填 | 描述 | @@ -201,6 +225,10 @@ getFileTypes(uri: string, mimeTypeFilter: string, callback: AsyncCallback> 获取支持的文件的MIME类型（Promise形式）。 +**系统能力:** + +SystemCapability.Ability.AbilityRuntime.FAModel + **参数：** | 名称 | 类型 | 必填 | 描述 | @@ -265,6 +297,10 @@ normalizeUri(uri: string, callback: AsyncCallback\): void 将引用数据功能的给定uri转换为规范化uri（callback形式）。 +**系统能力:** + +SystemCapability.Ability.AbilityRuntime.FAModel + **参数：** | 名称 | 类型 | 必填 | 描述 | @@ -292,6 +328,10 @@ normalizeUri(uri: string): Promise\ 将引用数据功能的给定uri转换为规范化uri（Promise形式）。 +**系统能力:** + +SystemCapability.Ability.AbilityRuntime.FAModel + **参数：** | 名称 | 类型 | 必填 | 描述 | @@ -323,6 +363,10 @@ denormalizeUri(uri: string, callback: AsyncCallback\): void 将由normalizeUri（uri）生成的给定规范化uri转换为非规范化uri（callback形式）。 +**系统能力:** + +SystemCapability.Ability.AbilityRuntime.FAModel + **参数：** | 名称 | 类型 | 必填 | 描述 | @@ -352,6 +396,10 @@ denormalizeUri(uri: string): Promise\ 将由normalizeUri（uri）生成的给定规范化uri转换为非规范化uri（Promise形式）。 +**系统能力:** + +SystemCapability.Ability.AbilityRuntime.FAModel + **参数：** | 名称 | 类型 | 必填 | 描述 | @@ -383,6 +431,10 @@ notifyChange(uri: string, callback: AsyncCallback\): void 通知已注册的观察者uri指定的数据资源的更改（callback形式）。 +**系统能力:** + +SystemCapability.Ability.AbilityRuntime.FAModel + **参数：** | 名称 | 类型 | 必填 | 描述 | @@ -410,6 +462,10 @@ notifyChange(uri: string): Promise\ 通知已注册的观察者uri指定的数据资源的更改（Promise形式）。 +**系统能力:** + +SystemCapability.Ability.AbilityRuntime.FAModel + **参数：** | 名称 | 类型 | 必填 | 描述 | @@ -441,6 +497,10 @@ insert(uri: string, valuesBucket: rdb.ValuesBucket, callback: AsyncCallback\ 将单个数据记录插入数据库（Promise形式）。 +**系统能力:** + +SystemCapability.Ability.AbilityRuntime.FAModel + **参数：** | 名称 | 类型 | 必填 | 描述 | @@ -515,6 +579,10 @@ batchInsert(uri: string, valuesBuckets: Array, callback: Async 插入数据库（callback形式）。 +**系统能力:** + +SystemCapability.Ability.AbilityRuntime.FAModel + **参数：** | 名称 | 类型 | 必填 | 描述 | @@ -547,6 +615,10 @@ batchInsert(uri: string, valuesBuckets: Array): Promise\, predicates: dataAbility.DataAbilityP 查询数据库中的数据（callback形式）。 +**系统能力:** + +SystemCapability.Ability.AbilityRuntime.FAModel + **参数：** | 名称 | 类型 | 必填 | 描述 | @@ -766,6 +858,10 @@ query(uri: string, columns: Array\, predicates: dataAbility.DataAbilityP 查询数据库中的数据（Promise形式）。 +**系统能力:** + +SystemCapability.Ability.AbilityRuntime.FAModel + **参数：** | 名称 | 类型 | 必填 | 描述 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-eventhub.md b/zh-cn/application-dev/reference/apis/js-apis-eventhub.md index 265e5f01827e5b0b9a74747fcae4f6e1027396a3..0fd0ecc9b5b3c2bef0c7d988bc1312737c559726 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-eventhub.md +++ b/zh-cn/application-dev/reference/apis/js-apis-eventhub.md @@ -36,6 +36,10 @@ on(event: string, callback: Function): void; 订阅指定事件。 +**系统能力:** + +SystemCapability.Ability.AbilityRuntime.Core + - 参数： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | @@ -71,6 +75,10 @@ off(event: string, callback?: Function): void; 取消订阅指定事件。当callback传值时，取消订阅指定的callback；未传值时，取消订阅该事件下所有callback。 +**系统能力:** + +SystemCapability.Ability.AbilityRuntime.Core + - 参数： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | @@ -106,6 +114,10 @@ emit(event: string, ...args: Object[]): void; 触发指定事件。 +**系统能力:** + +SystemCapability.Ability.AbilityRuntime.Core + - 参数： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | diff --git a/zh-cn/application-dev/reference/apis/js-apis-extension-context.md b/zh-cn/application-dev/reference/apis/js-apis-extension-context.md index 356b5605583fd2ea4cb9f108aa4f51901dd5b974..19ef7b6ee3dd7f51163024b94f2cf36c51991b5b 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-extension-context.md +++ b/zh-cn/application-dev/reference/apis/js-apis-extension-context.md @@ -11,4 +11,4 @@ Extension的上下文环境，继承自Context。 | 名称 | 参数类型 | 可读 | 可写 | 说明 | | -------- | -------- | -------- | -------- | -------- | -| currentHapModuleInfo | HapModuleInfo | 是 | 否 | 当前Hap包的信息。 | +| currentHapModuleInfo | HapModuleInfo | 是 | 否 | 当前Hap包的信息。
系统能力：SystemCapability.Ability.AbilityRuntime.Core | diff --git a/zh-cn/application-dev/reference/apis/js-apis-extensionrunninginfo.md b/zh-cn/application-dev/reference/apis/js-apis-extensionrunninginfo.md index aede4031e5fad55e705dc0f382bf10387c18dd3e..36b807c84b12e60d9a89f6cd83cccf3b8888d058 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-extensionrunninginfo.md +++ b/zh-cn/application-dev/reference/apis/js-apis-extensionrunninginfo.md @@ -31,13 +31,13 @@ abilitymanager.getExtensionRunningInfos(upperLimit, (err,data) => { | 名称 | 参数类型 | 可读 | 可写 | 说明 | | -------- | -------- | -------- | -------- | -------- | -| extension | ElementName | 是 | 否 | Extension匹配信息。 | -| pid | number | 是 | 否 | 进程ID。 | -| uid | number | 是 | 否 | 用户ID。 | -| processName | string | 是 | 否 | 进程名称。 | -| startTime | number | 是 | 否 | Extension启动时间。 | -| clientPackage | Array<String> | 是 | 否 | 连接客户端包名。 | -| type | [bundle.ExtensionAbilityType](#bundle-extensionabilitytype) | 是 | 否 | Extension类型。 | +| extension | ElementName | 是 | 否 | Extension匹配信息。
系统能力：SystemCapability.Ability.AbilityRuntime.Core | +| pid | number | 是 | 否 | 进程ID。
系统能力：SystemCapability.Ability.AbilityRuntime.Core | +| uid | number | 是 | 否 | 用户ID。
系统能力：SystemCapability.Ability.AbilityRuntime.Core | +| processName | string | 是 | 否 | 进程名称。
系统能力：SystemCapability.Ability.AbilityRuntime.Core | +| startTime | number | 是 | 否 | Extension启动时间。
系统能力：SystemCapability.Ability.AbilityRuntime.Core | +| clientPackage | Array<String> | 是 | 否 | 连接客户端包名。
系统能力：SystemCapability.Ability.AbilityRuntime.Core | +| type | [bundle.ExtensionAbilityType](#bundle-extensionabilitytype) | 是 | 否 | Extension类型。
系统能力：SystemCapability.Ability.AbilityRuntime.Core | ## bundle.ExtensionAbilityType @@ -46,13 +46,13 @@ Extension类型。 | 名称 | 值 | 说明 | | -------- | -------- | -------- | -| FORM | 0 | 表示带有form类型的扩展信息。 | -| WORK_SCHEDULER | 1 | 表示带有work schedule类型的扩展信息。 | -| INPUT_METHOD | 2 | 表示用输入法类型的扩展信息。 | -| SERVICE | 3 | 表示带有service类型的扩展信息。 | -| ACCESSIBILITY | 4 | 表示具有可访问性类型的扩展信息。 | -| DATA_SHARE | 5 | 表示带有datashare类型的扩展信息。 | -| FILE_SHARE | 6 | 表示带有fileshare类型的扩展信息。 | -| STATIC_SUBSCRIBER | 7 | 表示带有静态订阅者类型的扩展信息。 | -| WALLPAPER | 8 | 表示带有wallpaper类型的扩展信息。 | -| UNSPECIFIED | 9 | 表示未指定类型信息。 | +| FORM | 0 | 表示带有form类型的扩展信息。
系统能力：SystemCapability.BundleManager.BundleFramework | +| WORK_SCHEDULER | 1 | 表示带有work schedule类型的扩展信息。
系统能力：SystemCapability.BundleManager.BundleFramework | +| INPUT_METHOD | 2 | 表示用输入法类型的扩展信息。
系统能力：SystemCapability.BundleManager.BundleFramework | +| SERVICE | 3 | 表示带有service类型的扩展信息。
系统能力：SystemCapability.BundleManager.BundleFramework | +| ACCESSIBILITY | 4 | 表示具有可访问性类型的扩展信息。
系统能力：SystemCapability.BundleManager.BundleFramework | +| DATA_SHARE | 5 | 表示带有datashare类型的扩展信息。
系统能力：SystemCapability.BundleManager.BundleFramework | +| FILE_SHARE | 6 | 表示带有fileshare类型的扩展信息。
系统能力：SystemCapability.BundleManager.BundleFramework | +| STATIC_SUBSCRIBER | 7 | 表示带有静态订阅者类型的扩展信息。
系统能力：SystemCapability.BundleManager.BundleFramework | +| WALLPAPER | 8 | 表示带有wallpaper类型的扩展信息。
系统能力：SystemCapability.BundleManager.BundleFramework | +| UNSPECIFIED | 9 | 表示未指定类型信息。
系统能力：SystemCapability.BundleManager.BundleFramework | diff --git a/zh-cn/application-dev/reference/apis/js-apis-featureAbility.md b/zh-cn/application-dev/reference/apis/js-apis-featureAbility.md index a2fb9c0522e8711b967f0545f08298a99bdbb005..54ac9cd1bc3b34c7950da2ac95e781f74c2e65da 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-featureAbility.md +++ b/zh-cn/application-dev/reference/apis/js-apis-featureAbility.md @@ -16,6 +16,10 @@ startAbility(parameter: StartAbilityParameter, callback: AsyncCallback\) 启动新的ability（callback形式）。 +**系统能力:** + +SystemCapability.Ability.AbilityRuntime.FAModel + **参数：** | 名称 | 类型 | 必填 | 描述 | @@ -53,6 +57,10 @@ startAbility(parameter: StartAbilityParameter): Promise\ 启动新的ability（Promise形式）。 +**系统能力:** + +SystemCapability.Ability.AbilityRuntime.FAModel + **参数：** | 名称 | 类型 | 必填 | 描述 | @@ -89,6 +97,10 @@ acquireDataAbilityHelper(uri: string): DataAbilityHelper 获取dataAbilityHelper。 +**系统能力:** + +SystemCapability.Ability.AbilityRuntime.FAModel + **参数：** | 名称 | 类型 | 必填 | 描述 | @@ -116,6 +128,10 @@ startAbilityForResult(parameter: StartAbilityParameter, callback: AsyncCallback\ 启动一个ability，并在该ability被销毁时返回执行结果（callback形式）。 +**系统能力:** + +SystemCapability.Ability.AbilityRuntime.FAModel + **参数：** | 名称 | 类型 | 必填 | 描述 | @@ -151,6 +167,10 @@ startAbilityForResult(parameter: StartAbilityParameter): Promise\ 启动一个ability，并在该ability被销毁时返回执行结果（Promise形式）。 +**系统能力:** + +SystemCapability.Ability.AbilityRuntime.FAModel + **参数：** | 名称 | 类型 | 必填 | 描述 | @@ -204,6 +224,10 @@ terminateSelfWithResult(parameter: AbilityResult, callback: AsyncCallback\ 设置此Page Ability将返回给调用者的结果代码和数据并破坏此Page Ability（callback形式）。 +**系统能力:** + +SystemCapability.Ability.AbilityRuntime.FAModel + **参数：** | 名称 | 类型 | 必填 | 描述 | @@ -250,6 +274,10 @@ terminateSelfWithResult(parameter: AbilityResult): Promise\ 设置此Page Ability将返回给调用者的结果代码和数据并破坏此Page Ability（Promise形式）。 +**系统能力:** + +SystemCapability.Ability.AbilityRuntime.FAModel + **参数：** | 名称 | 类型 | 必填 | 描述 | @@ -304,6 +332,10 @@ hasWindowFocus(callback: AsyncCallback\): void 检查Ability的主窗口是否具有窗口焦点（callback形式）。 +**系统能力:** + +SystemCapability.Ability.AbilityRuntime.FAModel + **参数：** | 名称 | 类型 | 必填 | 描述 | @@ -325,6 +357,10 @@ hasWindowFocus(): Promise\ 检查Ability的主窗口是否具有窗口焦点（Promise形式）。 +**系统能力:** + +SystemCapability.Ability.AbilityRuntime.FAModel + **返回值：** | 类型 | 说明 | @@ -348,6 +384,10 @@ getWant(callback: AsyncCallback\): void 获取从Ability发送的Want（callback形式）。 +**系统能力:** + +SystemCapability.Ability.AbilityRuntime.FAModel + **参数：** | 名称 | 类型 | 必填 | 描述 | @@ -369,6 +409,10 @@ getWant(): Promise\ 获取从Ability发送的Want（Promise形式）。 +**系统能力:** + +SystemCapability.Ability.AbilityRuntime.FAModel + **返回值：** | 类型 | 说明 | | ----------------------- | ------------------------- | @@ -389,6 +433,10 @@ getContext(): Context 获取应用上下文。 +**系统能力:** + +SystemCapability.Ability.AbilityRuntime.FAModel + **返回值：** | 类型 | 说明 | | ------- | -------------------- | @@ -410,6 +458,10 @@ terminateSelf(callback: AsyncCallback\): void 设置Page Ability返回给被调用方的结果代码和数据，并销毁此Page Ability（callback形式）。 +**系统能力:** + +SystemCapability.Ability.AbilityRuntime.FAModel + **参数：** | 名称 | 类型 | 必填 | 描述 | @@ -431,6 +483,10 @@ terminateSelf(): Promise\ 设置Page Ability返回给被调用方的结果代码和数据，并销毁此Page Ability（Promise形式）。 +**系统能力:** + +SystemCapability.Ability.AbilityRuntime.FAModel + **返回值：** | 类型 | 说明 | | -------------- | ------------------------- | @@ -450,6 +506,10 @@ connectAbility(request: Want, options:ConnectOptions): number 将当前ability连接到指定ServiceAbility（callback形式）。 +**系统能力:** + +SystemCapability.Ability.AbilityRuntime.FAModel + **参数：** | 名称 | 类型 | 必填 | 描述 | @@ -461,17 +521,17 @@ connectAbility(request: Want, options:ConnectOptions): number | 名称 | 读写属性 | 类型 | 必填 | 描述 | | ------------ | -------- | -------- | ---- | ---------------------------------- | -| deviceId | 只读 | string | 否 | 表示被连接的ServiceAbility的设备id，缺省表示连接本地的ServiceAbility | -| bundleName | 只读 | string | 是 | 表示被连接的ServiceAbility的包名 | -| abilityName | 只读 | string | 是 | 表示被连接的ServiceAbility的类名 | +| deviceId | 只读 | string | 否 | 表示被连接的ServiceAbility的设备id，缺省表示连接本地的ServiceAbility
系统能力：SystemCapability.Ability.AbilityBase | +| bundleName | 只读 | string | 是 | 表示被连接的ServiceAbility的包名
系统能力：SystemCapability.Ability.AbilityBase | +| abilityName | 只读 | string | 是 | 表示被连接的ServiceAbility的类名
系统能力：SystemCapability.Ability.AbilityBase | **ConnectOptions类型说明：** | 名称 | 读写属性 | 类型 | 必填 | 描述 | | ------------ | -------- | -------- | ---- | ---------------------------------- | -| onConnect | 只读 | function | 是 | 连接成功时的回调函数 | -| onDisconnect | 只读 | function | 是 | 连接失败时的回调函数 | -| onFailed | 只读 | function | 是 | ConnectAbility调用失败时的回调函数 | +| onConnect | 只读 | function | 是 | 连接成功时的回调函数
系统能力：SystemCapability.Ability.AbilityRuntime.Core | +| onDisconnect | 只读 | function | 是 | 连接失败时的回调函数
系统能力：SystemCapability.Ability.AbilityRuntime.Core | +| onFailed | 只读 | function | 是 | ConnectAbility调用失败时的回调函数
系统能力：SystemCapability.Ability.AbilityRuntime.Core | **返回值：** | 类型 | 说明 | @@ -512,6 +572,10 @@ disconnectAbility(connection: number, callback:AsyncCallback\): void 断开与指定ServiceAbility的连接（callback形式）。 +**系统能力:** + +SystemCapability.Ability.AbilityRuntime.FAModel + **参数：** | 名称 | 类型 | 必填 | 描述 | @@ -557,6 +621,10 @@ disconnectAbility(connection: number): Promise\ 断开与指定ServiceAbility的连接（Promise形式）。 +**系统能力:** + +SystemCapability.Ability.AbilityRuntime.FAModel + **参数：** | 名称 | 类型 | 必填 | 描述 | @@ -602,6 +670,10 @@ continueAbility(options: ContinueAbilityOptions, callback: AsyncCallback\) 迁移一个ability到目标设备，并返回执行结果（callback形式）。 +**系统能力:** + +SystemCapability.Ability.AbilityRuntime.FAModel + **参数：** | 名称 | 类型 | 必填 | 描述 | @@ -613,8 +685,8 @@ continueAbility(options: ContinueAbilityOptions, callback: AsyncCallback\) | 名称 | 读写属性 | 类型 | 必填 | 描述 | | ---------- | -------- | ------- | ---- | ------------------------------------------------------------ | -| deviceId | 只读 | string | 是 | 表示需要包含有关目标启动能力的信息。 | -| reversible | 只读 | boolean | 是 | 是否支持回迁的标志，目前不支持该功能，为保留字段，可填false。 | +| deviceId | 只读 | string | 是 | 表示需要包含有关目标启动能力的信息。
系统能力：SystemCapability.Ability.AbilityRuntime.Core | +| reversible | 只读 | boolean | 是 | 是否支持回迁的标志，目前不支持该功能，为保留字段，可填false。
系统能力：SystemCapability.Ability.AbilityRuntime.Core | **示例：** @@ -689,6 +761,10 @@ continueAbility(options: ContinueAbilityOptions): Promise\; 迁移一个ability到目标设备，并返回执行结果（Promise形式）。 +**系统能力:** + +SystemCapability.Ability.AbilityRuntime.FAModel + **参数：** | 名称 | 类型 | 必填 | 描述 | @@ -699,8 +775,8 @@ continueAbility(options: ContinueAbilityOptions): Promise\; | 名称 | 读写属性 | 类型 | 必填 | 描述 | | ---------- | -------- | ------- | ---- | ------------------------------------------------------------ | -| deviceId | 只读 | string | 是 | 表示需要包含有关目标启动能力的信息。 | -| reversible | 只读 | boolean | 是 | 是否支持回迁的标志，目前不支持该功能，为保留字段，可填false。 | +| deviceId | 只读 | string | 是 | 表示需要包含有关目标启动能力的信息。
系统能力：SystemCapability.Ability.AbilityRuntime.Core | +| reversible | 只读 | boolean | 是 | 是否支持回迁的标志，目前不支持该功能，为保留字段，可填false。
系统能力：SystemCapability.Ability.AbilityRuntime.Core | **示例：** @@ -775,48 +851,48 @@ export default { | 名称 | 读写属性 | 类型 | 必填 | 描述 | | ---------- | -------- | --------------------- | ---- | ------------------------------------------------------------ | -| resultCode | 只读 | number | 是 | 指示销毁该能力后返回的结果代码。您可以定义结果代码来识别错误（暂不支持） | -| want | 只读 | [Want](#want) | 否 | 指示销毁该能力后返回的数据。您可以定义返回的数据。此参数可以为null。 | +| resultCode | 只读 | number | 是 | 指示销毁该能力后返回的结果代码。您可以定义结果代码来识别错误（暂不支持）
系统能力：SystemCapability.Ability.AbilityBase | +| want | 只读 | [Want](#want) | 否 | 指示销毁该能力后返回的数据。您可以定义返回的数据。此参数可以为null。
系统能力：SystemCapability.Ability.AbilityBase | ## StartAbilityParameter | 名称 | 读写属性 | 类型 | 必填 | 描述 | | ------------------- | -------- | -------------------- | ---- | ------------------------------------------------------------ | -| want | 只读 | [Want](#want) | 是 | 表示需要包含有关目标启动能力的信息。 | -| abilityStartSetting | 只读 | {[key: string]: any} | 否 | 表示能力的特殊属性，当开发者启动能力时，该属性可以作为调用中的输入参数传递。 | +| want | 只读 | [Want](#want) | 是 | 表示需要包含有关目标启动能力的信息。
系统能力：SystemCapability.Ability.AbilityRuntime.FAModel | +| abilityStartSetting | 只读 | {[key: string]: any} | 否 | 表示能力的特殊属性，当开发者启动能力时，该属性可以作为调用中的输入参数传递。
系统能力：SystemCapability.Ability.AbilityRuntime.FAModel | ## Want | 名称 | 读写属性 | 类型 | 必填 | 描述 | | ----------- | -------- | -------------------- | ---- | ------------------------------------------------------------ | -| deviceId | 只读 | string | 否 | 表示运行指定Ability的设备ID。 | -| bundleName | 只读 | string | 否 | 表示包描述。如果在Want中同时指定了BundleName和AbilityName，则Want可以直接匹配到指定的Ability。 | -| abilityName | 只读 | string | 否 | 表示待启动的Ability名称。如果在Want中同时指定了BundleName和AbilityName，则Want可以直接匹配到指定的Ability。 | -| uri | 只读 | string | 否 | 表示Uri描述。如果在Want中指定了Uri，则Want将匹配指定的Uri信息，包括scheme, schemeSpecificPart, authority和path信息。 | -| type | 只读 | string | 否 | 表示MIME type类型描述，比如："text/plain" 、 "image/*"等。 | -| flags | 只读 | number | 否 | 表示处理Want的方式。默认传数字，具体参考：[flags说明](#flags说明)。 | -| action | 只读 | string | 否 | 表示action选项描述。 | -| parameters | 只读 | {[key: string]: any} | 否 | 表示WantParams描述。 | -| entities | 只读 | Array\ | 否 | 表示entities相关描述。 | +| deviceId | 只读 | string | 否 | 表示运行指定Ability的设备ID。
系统能力：SystemCapability.Ability.AbilityBase | +| bundleName | 只读 | string | 否 | 表示包描述。如果在Want中同时指定了BundleName和AbilityName，则Want可以直接匹配到指定的Ability。
系统能力：SystemCapability.Ability.AbilityBase | +| abilityName | 只读 | string | 否 | 表示待启动的Ability名称。如果在Want中同时指定了BundleName和AbilityName，则Want可以直接匹配到指定的Ability。
系统能力：SystemCapability.Ability.AbilityBase | +| uri | 只读 | string | 否 | 表示Uri描述。如果在Want中指定了Uri，则Want将匹配指定的Uri信息，包括scheme, schemeSpecificPart, authority和path信息。
系统能力：SystemCapability.Ability.AbilityBase | +| type | 只读 | string | 否 | 表示MIME type类型描述，比如："text/plain" 、 "image/*"等。
系统能力：SystemCapability.Ability.AbilityBase | +| flags | 只读 | number | 否 | 表示处理Want的方式。默认传数字，具体参考：[flags说明](#flags说明)。
系统能力：SystemCapability.Ability.AbilityBase | +| action | 只读 | string | 否 | 表示action选项描述。
系统能力：SystemCapability.Ability.AbilityBase | +| parameters | 只读 | {[key: string]: any} | 否 | 表示WantParams描述。
系统能力：SystemCapability.Ability.AbilityBase | +| entities | 只读 | Array\ | 否 | 表示entities相关描述。
系统能力：SystemCapability.Ability.AbilityBase | ## flags说明 | 名称 | 参数 | 描述 | | ------------------------------------ | ---------- | ------------------------------------------------------------ | -| FLAG_AUTH_READ_URI_PERMISSION | 0x00000001 | 指示对URI执行读取操作的授权 | -| FLAG_AUTH_WRITE_URI_PERMISSION | 0x00000002 | 指示对URI执行写入操作的授权 | -| FLAG_ABILITY_FORWARD_RESULT | 0x00000004 | 将结果返回给元能力 | -| FLAG_ABILITY_CONTINUATION | 0x00000008 | 确定是否可以将本地设备上的功能迁移到远程设备 | -| FLAG_NOT_OHOS_COMPONENT | 0x00000010 | 指定组件是否属于OHOS | -| FLAG_ABILITY_FORM_ENABLED | 0x00000020 | 指定是否启动某个能力 | -| FLAG_AUTH_PERSISTABLE_URI_PERMISSION | 0x00000040 | 指示URI上可能持久化的授权 | -| FLAG_AUTH_PREFIX_URI_PERMISSION | 0x00000080 | 按照前缀匹配的方式验证URI权限 | -| FLAG_ABILITYSLICE_MULTI_DEVICE | 0x00000100 | 支持分布式调度系统中的多设备启动 | -| FLAG_START_FOREGROUND_ABILITY | 0x00000200 | 指示无论主机应用程序是否已启动，都将启动使用服务模板的功能 | -| FLAG_ABILITY_CONTINUATION_REVERSIBLE | 0x00000400 | 表示迁移是可拉回的。 | -| FLAG_INSTALL_ON_DEMAND | 0x00000800 | 如果未安装指定的功能，请安装该功能 | -| FLAG_INSTALL_WITH_BACKGROUND_MODE | 0x80000000 | 如果未安装，使用后台模式安装该功能。 | -| FLAG_ABILITY_CLEAR_MISSION | 0x00008000 | 指示清除其他任务的操作。可以为传递给**ohos.app.Context#startAbility**的**Want**设置此标志，并且必须与**flag_ABILITY_NEW_MISSION**一起使用 | -| FLAG_ABILITY_NEW_MISSION | 0x10000000 | 指示在历史任务堆栈上创建任务的操作。 | -| FLAG_ABILITY_MISSION_TOP | 0x20000000 | 指示如果启动能力的现有实例已位于任务堆栈的顶部，则将重用该实例。否则，将创建一个新的能力实例。 | +| FLAG_AUTH_READ_URI_PERMISSION | 0x00000001 | 指示对URI执行读取操作的授权
系统能力：SystemCapability.Ability.AbilityBase | +| FLAG_AUTH_WRITE_URI_PERMISSION | 0x00000002 | 指示对URI执行写入操作的授权
系统能力：SystemCapability.Ability.AbilityBase | +| FLAG_ABILITY_FORWARD_RESULT | 0x00000004 | 将结果返回给元能力
系统能力：SystemCapability.Ability.AbilityBase | +| FLAG_ABILITY_CONTINUATION | 0x00000008 | 确定是否可以将本地设备上的功能迁移到远程设备
系统能力：SystemCapability.Ability.AbilityBase | +| FLAG_NOT_OHOS_COMPONENT | 0x00000010 | 指定组件是否属于OHOS
系统能力：SystemCapability.Ability.AbilityBase | +| FLAG_ABILITY_FORM_ENABLED | 0x00000020 | 指定是否启动某个能力
系统能力：SystemCapability.Ability.AbilityBase | +| FLAG_AUTH_PERSISTABLE_URI_PERMISSION | 0x00000040 | 指示URI上可能持久化的授权
系统能力：SystemCapability.Ability.AbilityBase | +| FLAG_AUTH_PREFIX_URI_PERMISSION | 0x00000080 | 按照前缀匹配的方式验证URI权限
系统能力：SystemCapability.Ability.AbilityBase | +| FLAG_ABILITYSLICE_MULTI_DEVICE | 0x00000100 | 支持分布式调度系统中的多设备启动
系统能力：SystemCapability.Ability.AbilityBase | +| FLAG_START_FOREGROUND_ABILITY | 0x00000200 | 指示无论主机应用程序是否已启动，都将启动使用服务模板的功能
系统能力：SystemCapability.Ability.AbilityBase | +| FLAG_ABILITY_CONTINUATION_REVERSIBLE | 0x00000400 | 表示迁移是可拉回的。
系统能力：SystemCapability.Ability.AbilityBase | +| FLAG_INSTALL_ON_DEMAND | 0x00000800 | 如果未安装指定的功能，请安装该功能
系统能力：SystemCapability.Ability.AbilityBase | +| FLAG_INSTALL_WITH_BACKGROUND_MODE | 0x80000000 | 如果未安装，使用后台模式安装该功能。
系统能力：SystemCapability.Ability.AbilityBase | +| FLAG_ABILITY_CLEAR_MISSION | 0x00008000 | 指示清除其他任务的操作。可以为传递给**ohos.app.Context#startAbility**的**Want**设置此标志，并且必须与**flag_ABILITY_NEW_MISSION**一起使用
系统能力：SystemCapability.Ability.AbilityBase | +| FLAG_ABILITY_NEW_MISSION | 0x10000000 | 指示在历史任务堆栈上创建任务的操作。
系统能力：SystemCapability.Ability.AbilityBase | +| FLAG_ABILITY_MISSION_TOP | 0x20000000 | 指示如果启动能力的现有实例已位于任务堆栈的顶部，则将重用该实例。否则，将创建一个新的能力实例。
系统能力：SystemCapability.Ability.AbilityBase | diff --git a/zh-cn/application-dev/reference/apis/js-apis-particleAbility.md b/zh-cn/application-dev/reference/apis/js-apis-particleAbility.md index e1379476c531c9183822403d040e53bcfea8aef6..9f12115ff008d02a4c3eff94dda598f127a822bb 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-particleAbility.md +++ b/zh-cn/application-dev/reference/apis/js-apis-particleAbility.md @@ -16,6 +16,10 @@ startAbility(parameter: StartAbilityParameter, callback: AsyncCallback\: v 使用此方法启动指定的particleAbility（callback形式）。 +**系统能力:** + +SystemCapability.Ability.AbilityRuntime.FAModel + **参数：** @@ -53,9 +57,17 @@ particleAbility.startAbility( ## particleAbility.startAbility +**系统能力:** + +SystemCapability.Ability.AbilityRuntime.FAModel + startAbility(parameter: StartAbilityParameter): Promise\ 使用此方法启动指定的particleAbility（Promise形式）。 +**系统能力:** + +SystemCapability.Ability.AbilityRuntime.FAModel + **参数：** @@ -99,6 +111,10 @@ terminateSelf(callback: AsyncCallback\): void 终止particleAbility（callback形式）。 +**系统能力:** + +SystemCapability.Ability.AbilityRuntime.FAModel + **参数：** | 名称 | 类型 | 必填 | 描述 | @@ -124,6 +140,10 @@ terminateSelf(): Promise\ 终止particleAbility（Promise形式）。 +**系统能力:** + +SystemCapability.Ability.AbilityRuntime.FAModel + **返回值：** | 类型 | 说明 | | -------------- | ------------------------- | @@ -146,6 +166,10 @@ acquireDataAbilityHelper(uri: string): DataAbilityHelper 获取dataAbilityHelper。 +**系统能力:** + +SystemCapability.Ability.AbilityRuntime.FAModel + **参数：** | 名称 | 类型 | 必填 | 描述 | @@ -170,43 +194,43 @@ particleAbility.acquireDataAbilityHelper(uri) | 名称 | 读写属性 | 类型 | 必填 | 描述 | | ------------------- | -------- | --------------------- | ---- | ------------------------------------------------------------ | -| want | 只读 | [Want](#want) | 是 | 表示需要包含有关目标启动能力的信息。 | -| abilityStartSetting | 只读 | {[key: string]: any} | 否 | 表示能力的特殊属性，当开发者启动能力时，该属性可以作为调用中的输入参数传递。 | +| want | 只读 | [Want](#want) | 是 | 表示需要包含有关目标启动能力的信息。
系统能力：SystemCapability.Ability.AbilityRuntime.FAModel | +| abilityStartSetting | 只读 | {[key: string]: any} | 否 | 表示能力的特殊属性，当开发者启动能力时，该属性可以作为调用中的输入参数传递。
系统能力：SystemCapability.Ability.AbilityRuntime.FAModel | ## Want | 名称 | 读写属性 | 类型 | 必填 | 描述 | | ----------- | -------- | -------------------- | ---- | ------------------------------------------------------------ | -| deviceId | 只读 | string | 否 | 表示运行指定Ability的设备ID。 | -| bundleName | 只读 | string | 否 | 表示包描述。如果在Want中同时指定了BundleName和AbilityName，则Want可以直接匹配到指定的Ability。 | -| abilityName | 只读 | string | 否 | 表示待启动的Ability名称。如果在Want中同时指定了BundleName和AbilityName，则Want可以直接匹配到指定的Ability。 | -| uri | 只读 | string | 否 | 表示Uri描述。如果在Want中指定了Uri，则Want将匹配指定的Uri信息，包括scheme, schemeSpecificPart, authority和path信息。 | -| type | 只读 | string | 否 | 表示MIME type类型描述，比如："text/plain" 、 "image/*"等。 | -| flags | 只读 | number | 否 | 表示处理Want的方式。默认传数字，具体参考：[flags说明](#flags说明)。 | -| action | 只读 | string | 否 | 表示action选项描述。 | -| parameters | 只读 | {[key: string]: any} | 否 | 表示WantParams描述。 | -| entities | 只读 | Array\ | 否 | 表示entities相关描述。 | +| deviceId | 只读 | string | 否 | 表示运行指定Ability的设备ID。
系统能力：SystemCapability.Ability.AbilityBase | +| bundleName | 只读 | string | 否 | 表示包描述。如果在Want中同时指定了BundleName和AbilityName，则Want可以直接匹配到指定的Ability。
系统能力：SystemCapability.Ability.AbilityBase | +| abilityName | 只读 | string | 否 | 表示待启动的Ability名称。如果在Want中同时指定了BundleName和AbilityName，则Want可以直接匹配到指定的Ability。
系统能力：SystemCapability.Ability.AbilityBase | +| uri | 只读 | string | 否 | 表示Uri描述。如果在Want中指定了Uri，则Want将匹配指定的Uri信息，包括scheme, schemeSpecificPart, authority和path信息。
系统能力：SystemCapability.Ability.AbilityBase | +| type | 只读 | string | 否 | 表示MIME type类型描述，比如："text/plain" 、 "image/*"等。
系统能力：SystemCapability.Ability.AbilityBase | +| flags | 只读 | number | 否 | 表示处理Want的方式。默认传数字，具体参考：[flags说明](#flags说明)。
系统能力：SystemCapability.Ability.AbilityBase | +| action | 只读 | string | 否 | 表示action选项描述。
系统能力：SystemCapability.Ability.AbilityBase | +| parameters | 只读 | {[key: string]: any} | 否 | 表示WantParams描述。
系统能力：SystemCapability.Ability.AbilityBase | +| entities | 只读 | Array\ | 否 | 表示entities相关描述。
系统能力：SystemCapability.Ability.AbilityBase | ## flags说明 | 名称 | 参数 | 描述 | | ------------------------------------ | ---------- | ------------------------------------------------------------ | -| FLAG_AUTH_READ_URI_PERMISSION | 0x00000001 | 指示对URI执行读取操作的授权 | -| FLAG_AUTH_WRITE_URI_PERMISSION | 0x00000002 | 指示对URI执行写入操作的授权 | -| FLAG_ABILITY_FORWARD_RESULT | 0x00000004 | 将结果返回给元能力 | -| FLAG_ABILITY_CONTINUATION | 0x00000008 | 确定是否可以将本地设备上的功能迁移到远程设备 | -| FLAG_NOT_OHOS_COMPONENT | 0x00000010 | 指定组件是否属于OHOS | -| FLAG_ABILITY_FORM_ENABLED | 0x00000020 | 指定是否启动某个能力 | -| FLAG_AUTH_PERSISTABLE_URI_PERMISSION | 0x00000040 | 指示URI上可能持久化的授权 | -| FLAG_AUTH_PREFIX_URI_PERMISSION | 0x00000080 | 按照前缀匹配的方式验证URI权限 | -| FLAG_ABILITYSLICE_MULTI_DEVICE | 0x00000100 | 支持分布式调度系统中的多设备启动 | -| FLAG_START_FOREGROUND_ABILITY | 0x00000200 | 指示无论主机应用程序是否已启动，都将启动使用服务模板的功能 | -| FLAG_ABILITY_CONTINUATION_REVERSIBLE | 0x00000400 | 表示迁移是可拉回的。 | -| FLAG_INSTALL_ON_DEMAND | 0x00000800 | 如果未安装指定的功能，请安装该功能 | -| FLAG_INSTALL_WITH_BACKGROUND_MODE | 0x80000000 | 如果未安装，使用后台模式安装该功能。 | -| FLAG_ABILITY_CLEAR_MISSION | 0x00008000 | 指示清除其他任务的操作。可以为传递给{@link ohos.app.Context#startAbility}的{@code Want}设置此标志，并且必须与{@link flag_ABILITY_NEW_MISSION}一起使用 | -| FLAG_ABILITY_NEW_MISSION | 0x10000000 | 指示在历史任务堆栈上创建任务的操作。 | -| FLAG_ABILITY_MISSION_TOP | 0x20000000 | 指示如果启动能力的现有实例已位于任务堆栈的顶部，则将重用该实例。否则，将创建一个新的能力实例。 | +| FLAG_AUTH_READ_URI_PERMISSION | 0x00000001 | 指示对URI执行读取操作的授权
系统能力：SystemCapability.Ability.AbilityBase | +| FLAG_AUTH_WRITE_URI_PERMISSION | 0x00000002 | 指示对URI执行写入操作的授权
系统能力：SystemCapability.Ability.AbilityBase | +| FLAG_ABILITY_FORWARD_RESULT | 0x00000004 | 将结果返回给元能力
系统能力：SystemCapability.Ability.AbilityBase | +| FLAG_ABILITY_CONTINUATION | 0x00000008 | 确定是否可以将本地设备上的功能迁移到远程设备
系统能力：SystemCapability.Ability.AbilityBase | +| FLAG_NOT_OHOS_COMPONENT | 0x00000010 | 指定组件是否属于OHOS
系统能力：SystemCapability.Ability.AbilityBase | +| FLAG_ABILITY_FORM_ENABLED | 0x00000020 | 指定是否启动某个能力
系统能力：SystemCapability.Ability.AbilityBase | +| FLAG_AUTH_PERSISTABLE_URI_PERMISSION | 0x00000040 | 指示URI上可能持久化的授权
系统能力：SystemCapability.Ability.AbilityBase | +| FLAG_AUTH_PREFIX_URI_PERMISSION | 0x00000080 | 按照前缀匹配的方式验证URI权限
系统能力：SystemCapability.Ability.AbilityBase | +| FLAG_ABILITYSLICE_MULTI_DEVICE | 0x00000100 | 支持分布式调度系统中的多设备启动
系统能力：SystemCapability.Ability.AbilityBase | +| FLAG_START_FOREGROUND_ABILITY | 0x00000200 | 指示无论主机应用程序是否已启动，都将启动使用服务模板的功能
系统能力：SystemCapability.Ability.AbilityBase | +| FLAG_ABILITY_CONTINUATION_REVERSIBLE | 0x00000400 | 表示迁移是可拉回的。
系统能力：SystemCapability.Ability.AbilityBase | +| FLAG_INSTALL_ON_DEMAND | 0x00000800 | 如果未安装指定的功能，请安装该功能
系统能力：SystemCapability.Ability.AbilityBase | +| FLAG_INSTALL_WITH_BACKGROUND_MODE | 0x80000000 | 如果未安装，使用后台模式安装该功能。
系统能力：SystemCapability.Ability.AbilityBase | +| FLAG_ABILITY_CLEAR_MISSION | 0x00008000 | 指示清除其他任务的操作。可以为传递给{@link ohos.app.Context#startAbility}的{@code Want}设置此标志，并且必须与{@link flag_ABILITY_NEW_MISSION}一起使用
系统能力：SystemCapability.Ability.AbilityBase | +| FLAG_ABILITY_NEW_MISSION | 0x10000000 | 指示在历史任务堆栈上创建任务的操作。
系统能力：SystemCapability.Ability.AbilityBase | +| FLAG_ABILITY_MISSION_TOP | 0x20000000 | 指示如果启动能力的现有实例已位于任务堆栈的顶部，则将重用该实例。否则，将创建一个新的能力实例。
系统能力：SystemCapability.Ability.AbilityBase | ## AbilityStartSetting @@ -216,9 +240,9 @@ abilityStartSetting属性是一个定义为[key: string]: any的对象，key对 | 名称 | 参数 | 描述 | | --------------- | --------------- | -------------------------- | -| BOUNDS_KEY | "abilityBounds" | 窗口显示大小属性的名称。 | -| WINDOW_MODE_KEY | "windowMode" | 窗口显示模式属性的名称。 | -| DISPLAY_ID_KEY | "displayId" | 窗口显示设备ID属性的名称。 | +| BOUNDS_KEY | "abilityBounds" | 窗口显示大小属性的名称。
系统能力：SystemCapability.Ability.AbilityRuntime.FAModel | +| WINDOW_MODE_KEY | "windowMode" | 窗口显示模式属性的名称。
系统能力：SystemCapability.Ability.AbilityRuntime.FAModel | +| DISPLAY_ID_KEY | "displayId" | 窗口显示设备ID属性的名称。
系统能力：SystemCapability.Ability.AbilityRuntime.FAModel | ## AbilityWindowConfiguration @@ -226,11 +250,11 @@ abilityStartSetting属性是一个定义为[key: string]: any的对象，key对 | 名称 | 参数 | 描述 | | --------------------------- | ---- | ---------- | -| WINDOW_MODE_UNDEFINED | 0 | 未定义。 | -| WINDOW_MODE_FULLSCREEN | 1 | 全屏。 | -| WINDOW_MODE_SPLIT_PRIMARY | 100 | 分屏主屏。 | -| WINDOW_MODE_SPLIT_SECONDARY | 101 | 分屏次屏。 | -| WINDOW_MODE_FLOATING | 102 | 悬浮窗。 | +| WINDOW_MODE_UNDEFINED | 0 | 未定义。
系统能力：SystemCapability.Ability.AbilityRuntime.FAModel | +| WINDOW_MODE_FULLSCREEN | 1 | 全屏。
系统能力：SystemCapability.Ability.AbilityRuntime.FAModel | +| WINDOW_MODE_SPLIT_PRIMARY | 100 | 分屏主屏。
系统能力：SystemCapability.Ability.AbilityRuntime.FAModel | +| WINDOW_MODE_SPLIT_SECONDARY | 101 | 分屏次屏。
系统能力：SystemCapability.Ability.AbilityRuntime.FAModel | +| WINDOW_MODE_FLOATING | 102 | 悬浮窗。
系统能力：SystemCapability.Ability.AbilityRuntime.FAModel | ## particleAbility.startBackgroundRunning @@ -239,6 +263,10 @@ startBackgroundRunning(id: number, request: NotificationRequest, callback: Async 向系统申请长时任务，使用callback形式返回结果。（此接口为api7接口，后续会被废弃，请使用新的api8接口） +**系统能力:** + +SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask + - **参数**： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | @@ -295,6 +323,10 @@ wantAgent.getWantAgent(wantAgentInfo).then((wantAgentObj) => { startBackgroundRunning(id: number, request: NotificationRequest): Promise<void> +**系统能力:** + +SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask + 向系统申请长时任务，使用promise形式返回结果。（此接口为api7接口，后续会被废弃，请使用新的api8接口） **参数**： @@ -355,6 +387,10 @@ cancelBackgroundRunning(callback: AsyncCallback<void>): void; 向系统申请取消长时任务，使用callback形式返回结果。（此接口为api7接口，后续会被废弃，请使用新的api8接口） +**系统能力:** + +SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask + - **参数**： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | @@ -382,6 +418,10 @@ cancelBackgroundRunning(): Promise<void>; 向系统申请取消长时任务，使用promise形式返回结果。（此接口为api7接口，后续会被废弃，请使用新的api8接口） +**系统能力:** + +SystemCapability.ResourceSchedule.BackgroundTaskManager.ContinuousTask + **返回值** | 类型 | 说明 | | -------------- | ------------------------- | diff --git a/zh-cn/application-dev/reference/apis/js-apis-permissionrequestresult.md b/zh-cn/application-dev/reference/apis/js-apis-permissionrequestresult.md index 65317e07f3e3b68c887fec2687701407ddd19386..7047a1584e6e46b1c01b027c3bd6be3a745831b4 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-permissionrequestresult.md +++ b/zh-cn/application-dev/reference/apis/js-apis-permissionrequestresult.md @@ -14,5 +14,5 @@ | 名称 | 参数类型 | 可读 | 可写 | 说明 | | -------- | -------- | -------- | -------- | -------- | -| permissions | Array<string> | 是 | 否 | 用户传入的权限。 | -| authResults | Array<number> | 是 | 否 | 相应请求权限的结果。0表示授权成功，-1表示失败。 | +| permissions | Array<string> | 是 | 否 | 用户传入的权限。
系统能力：SystemCapability.Ability.AbilityRuntime.Core| +| authResults | Array<number> | 是 | 否 | 相应请求权限的结果。0表示授权成功，-1表示失败。
系统能力：SystemCapability.Ability.AbilityRuntime.Core | diff --git a/zh-cn/application-dev/reference/apis/js-apis-processrunninginfo.md b/zh-cn/application-dev/reference/apis/js-apis-processrunninginfo.md index d22b2afe122785331b69c77ac474f52512dda061..dbcf41ed4c7870ea70096a7993d732d56e390ee8 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-processrunninginfo.md +++ b/zh-cn/application-dev/reference/apis/js-apis-processrunninginfo.md @@ -30,7 +30,7 @@ appManager.getProcessRunningInfos((error,data) => { | 名称 | 参数类型 | 可读 | 可写 | 说明 | | -------- | -------- | -------- | -------- | -------- | -| pid | number | 是 | 否 | 进程ID。 | -| uid | number | 是 | 否 | 用户ID。 | -| processName | string | 是 | 否 | 进程名称。 | -| bundleNames | Array<string> | 是 | 否 | 进程中所有运行的包名称。 | +| pid | number | 是 | 否 | 进程ID。
系统能力：SystemCapability.Ability.AbilityRuntime.Core | +| uid | number | 是 | 否 | 用户ID。
系统能力：SystemCapability.Ability.AbilityRuntime.Core | +| processName | string | 是 | 否 | 进程名称。
系统能力：SystemCapability.Ability.AbilityRuntime.Core | +| bundleNames | Array<string> | 是 | 否 | 进程中所有运行的包名称。
系统能力：SystemCapability.Ability.AbilityRuntime.Core | diff --git a/zh-cn/application-dev/reference/apis/js-apis-service-extension-context.md b/zh-cn/application-dev/reference/apis/js-apis-service-extension-context.md index 9df9866c2cd51d00b76c2bd3b72809a483629bbb..1438b120f5806e34d2c72c9dda1b2de62930ddcc 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-service-extension-context.md +++ b/zh-cn/application-dev/reference/apis/js-apis-service-extension-context.md @@ -16,6 +16,10 @@ startAbility(want: Want, callback: AsyncCallback<void>): void; 启动Ability。 +**系统能力:** + +SystemCapability.Ability.AbilityRuntime.Core + - 参数： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | @@ -40,6 +44,10 @@ startAbility(want: Want): Promise<void>; 启动Ability。通过Promise返回结果。 +**系统能力:** + +SystemCapability.Ability.AbilityRuntime.Core + - 参数： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | @@ -70,6 +78,10 @@ terminateSelf(callback: AsyncCallback<void>): void; 停止Ability自身。 +**系统能力:** + +SystemCapability.Ability.AbilityRuntime.Core + - 参数： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | @@ -89,6 +101,10 @@ terminateSelf(): Promise<void>; 停止自身。通过Promise返回结果。 +**系统能力:** + +SystemCapability.Ability.AbilityRuntime.Core + - 返回值： | 类型 | 说明 | | -------- | -------- | @@ -110,6 +126,10 @@ connectAbility(want: Want, options: ConnectOptions): number; 将一个Ability与服务类型的Ability绑定。 +**系统能力:** + +SystemCapability.Ability.AbilityRuntime.Core + - 参数： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | @@ -142,6 +162,10 @@ disconnectAbility(connection: number, callback:AsyncCallback<void>): void; 将一个Ability与绑定的服务类型的Ability解绑。 +**系统能力:** + +SystemCapability.Ability.AbilityRuntime.Core + - 参数： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | @@ -162,6 +186,10 @@ disconnectAbility(connection: number): Promise<void>; 将一个Ability与绑定的服务类型的Ability解绑。通过Promise返回结果。 +**系统能力:** + +SystemCapability.Ability.AbilityRuntime.Core + - 参数： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | @@ -171,7 +199,7 @@ disconnectAbility(connection: number): Promise<void>; | 类型 | 说明 | | -------- | -------- | | Promise<void> | 返回一个Promise，包含接口的结果。 | - + - 示例： ``` this.context.disconnectAbility(connection).then((data) => { // connection为connectAbility中的返回值 @@ -188,6 +216,6 @@ ConnectOptions数据结构。 | 名称 | 说明 | | -------- | -------- | -| onConnect(elementName:ElementName, remote:IRemoteObject) | Ability成功连接一个服务类型Ability的回调接口。 | -| onDisconnect(elementName:ElementName) | 对端服务发生异常或者被杀死回调该接口。 | -| onFailed(code: number) | 连接失败时回调该接口。 | +| onConnect(elementName:ElementName, remote:IRemoteObject) | Ability成功连接一个服务类型Ability的回调接口。
系统能力：SystemCapability.Ability.AbilityRuntime.Core | +| onDisconnect(elementName:ElementName) | 对端服务发生异常或者被杀死回调该接口。
系统能力：SystemCapability.Ability.AbilityRuntime.Core | +| onFailed(code: number) | 连接失败时回调该接口。
系统能力：SystemCapability.Ability.AbilityRuntime.Core | diff --git a/zh-cn/application-dev/reference/apis/js-apis-service-extension.md b/zh-cn/application-dev/reference/apis/js-apis-service-extension.md index 4084b560e9ebed38d7be22ebf75285723e1a80da..52366fd4dcc40a35bbb4342fec2f781b12b802e7 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-service-extension.md +++ b/zh-cn/application-dev/reference/apis/js-apis-service-extension.md @@ -32,6 +32,10 @@ onCreate(want: Want): void; Extension生命周期回调，在创建时回调，执行初始化业务逻辑操作。 +**系统能力:** + +SystemCapability.Ability.AbilityRuntime.Core + - 参数： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | @@ -53,6 +57,10 @@ onDestroy(): void; Extension生命周期回调，在销毁时回调，执行资源清理等操作。 +**系统能力:** + +SystemCapability.Ability.AbilityRuntime.Core + - 示例： ``` class ServiceExt extends ServiceExtension { @@ -69,6 +77,10 @@ onRequest(want: Want, startId: number): void; Extension生命周期回调，如果是startAbility拉起的服务，会在onCreate之后回调。每次拉起服务都会回调，startId会递增。 +**系统能力:** + +SystemCapability.Ability.AbilityRuntime.Core + - 参数： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | @@ -91,6 +103,10 @@ onConnect(want: Want): rpc.RemoteObject; Extension生命周期回调，如果是connectAbility拉起的服务，会在onCreate之后回调。返回一个RemoteObject对象，用于和客户端进行通信。 +**系统能力:** + +SystemCapability.Ability.AbilityRuntime.Core + - 参数： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | @@ -126,6 +142,10 @@ onDisconnect(want: Want): void; Extension的生命周期，断开服务连接时回调。 +**系统能力:** + +SystemCapability.Ability.AbilityRuntime.Core + - 参数： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | diff --git a/zh-cn/application-dev/reference/apis/js-apis-uripermissionmanager.md b/zh-cn/application-dev/reference/apis/js-apis-uripermissionmanager.md index 34cc33c69437954800242c7cbeff198bccd1da5f..14a3814de074e2cdcdbed759f59fa4151ca8411c 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-uripermissionmanager.md +++ b/zh-cn/application-dev/reference/apis/js-apis-uripermissionmanager.md @@ -26,6 +26,10 @@ verifyUriPermission(uri: string, flag: wantConstant.Flags, accessTokenId: number 检验某个应用是否对指定的uri有flag指定的权限。 +**系统能力:** + +SystemCapability.Ability.AbilityRuntime.Core + - 参数： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | @@ -50,6 +54,10 @@ verifyUriPermission(uri: string, flag: wantConstant.Flags, accessTokenId: number 检验某个应用是否对指定的uri有flag指定的权限。 +**系统能力:** + +SystemCapability.Ability.AbilityRuntime.Core + - 参数： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- |