Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
40c8f755
D
Docs
项目概览
OpenHarmony
/
Docs
1 年多 前同步成功
通知
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看板
未验证
提交
40c8f755
编写于
8月 24, 2023
作者:
O
openharmony_ci
提交者:
Gitee
8月 24, 2023
浏览文件
操作
浏览文件
下载
差异文件
!22877 新增包管理同步接口文档
Merge pull request !22877 from junyi233/master
上级
03070ea4
7e6bf5a9
变更
1
显示空白变更内容
内联
并排
Showing
1 changed file
with
274 addition
and
0 deletion
+274
-0
zh-cn/application-dev/reference/apis/js-apis-bundleManager.md
...n/application-dev/reference/apis/js-apis-bundleManager.md
+274
-0
未找到文件。
zh-cn/application-dev/reference/apis/js-apis-bundleManager.md
浏览文件 @
40c8f755
...
@@ -1590,6 +1590,52 @@ try {
...
@@ -1590,6 +1590,52 @@ try {
}
}
```
```
### bundleManager.getBundleNameByUidSync<sup>10+</sup>
getBundleNameByUidSync(uid: number): string;
以同步方法根据给定的uid获取对应的bundleName。
**系统接口:**
此接口为系统接口。
**需要权限:**
ohos.permission.GET_BUNDLE_INFO_PRIVILEGED or ohos.permission.GET_BUNDLE_INFO
**系统能力:**
SystemCapability.BundleManager.BundleFramework.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ---- | ------ | ---- | ------------------ |
| uid | number | 是 | 表示应用程序的UID。 |
**返回值:**
| 类型 | 说明 |
| ---------------- | --------------------------- |
| string | 返回获取到的bundleName。 |
**错误码:**
以下错误码的详细介绍请参见
[
ohos.bundle错误码
](
../errorcodes/errorcode-bundle.md
)
。
| 错误码ID | 错误信息 |
| -------- | ---------------------|
| 17700021 | The uid is not found. |
**示例:**
```
ts
import
bundleManager
from
'
@ohos.bundle.bundleManager
'
;
import
hilog
from
'
@ohos.hilog
'
;
let
uid
=
20010005
;
try
{
let
data
=
bundleManager
.
getBundleNameByUidSync
(
uid
);
hilog
.
info
(
0x0000
,
'
testTag
'
,
'
getBundleNameByUidSync successfully. Data: %{public}s
'
,
JSON
.
stringify
(
data
));
}
catch
(
err
)
{
hilog
.
error
(
0x0000
,
'
testTag
'
,
'
getBundleNameByUidSync failed. Cause: %{public}s
'
,
err
.
message
);
}
```
### bundleManager.getBundleArchiveInfo
### bundleManager.getBundleArchiveInfo
getBundleArchiveInfo(hapFilePath: string, bundleFlags:
[
number
](
#bundleflag
)
, callback: AsyncCallback
\<
[
BundleInfo
](
js-apis-bundleManager-bundleInfo.md
)
>): void;
getBundleArchiveInfo(hapFilePath: string, bundleFlags:
[
number
](
#bundleflag
)
, callback: AsyncCallback
\<
[
BundleInfo
](
js-apis-bundleManager-bundleInfo.md
)
>): void;
...
@@ -1691,6 +1737,55 @@ try {
...
@@ -1691,6 +1737,55 @@ try {
}
}
```
```
### bundleManager.getBundleArchiveInfoSync<sup>10+</sup>
getBundleArchiveInfoSync(hapFilePath: string, bundleFlags: number): BundleInfo;
以同步方法根据给定的hapFilePath和bundleFlags获取BundleInfo对象。
**系统接口:**
此接口为系统接口。
**需要权限:**
ohos.permission.GET_BUNDLE_INFO_PRIVILEGED
**系统能力:**
SystemCapability.BundleManager.BundleFramework.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ----------- | ------ | ---- | ------------------------------------------------------------ |
| hapFilePath | string | 是 | 表示存储HAP的路径,路径应该是当前应用程序数据目录的相对路径。 |
| bundleFlags |
[
number
](
#bundleflag
)
| 是 | 表示用于指定要返回的BundleInfo对象中包含的信息的标志。 |
**返回值:**
| 类型 | 说明 |
| ----------------------------------------------------------- | --------------------------- |
|
[
BundleInfo
](
js-apis-bundleManager-bundleInfo.md
)
| 返回BundleInfo对象。 |
**错误码:**
以下错误码的详细介绍请参见
[
ohos.bundle错误码
](
../errorcodes/errorcode-bundle.md
)
。
| 错误码ID | 错误信息 |
| -------- | -------------------------- |
| 17700022 | The hapFilePath is invalid. |
**示例:**
```
ts
import
bundleManager
from
'
@ohos.bundle.bundleManager
'
;
import
hilog
from
'
@ohos.hilog
'
;
let
hapFilePath
=
"
/data/xxx/test.hap
"
;
let
bundleFlags
=
bundleManager
.
BundleFlag
.
GET_BUNDLE_INFO_DEFAULT
;
try
{
let
data
=
bundleManager
.
getBundleArchiveInfoSync
(
hapFilePath
,
bundleFlags
)
hilog
.
info
(
0x0000
,
'
testTag
'
,
'
getBundleArchiveInfoSync successfully. Data: %{public}s
'
,
JSON
.
stringify
(
data
));
}
catch
(
err
)
{
hilog
.
error
(
0x0000
,
'
testTag
'
,
'
getBundleArchiveInfoSync failed. Cause: %{public}s
'
,
err
.
message
);
}
```
### bundleManager.cleanBundleCacheFiles
### bundleManager.cleanBundleCacheFiles
cleanBundleCacheFiles(bundleName: string, callback: AsyncCallback
\<
void>): void;
cleanBundleCacheFiles(bundleName: string, callback: AsyncCallback
\<
void>): void;
...
@@ -2780,6 +2875,70 @@ try {
...
@@ -2780,6 +2875,70 @@ try {
}
}
```
```
### bundleManager.getProfileByAbilitySync<sup>10+</sup>
getProfileByAbilitySync(moduleName: string, abilityName: string, metadataName?: string): Array
\<
string
\>
;
以同步方法根据给定的moduleName、abilityName和metadataName获取相应配置文件的json格式字符串,返回对象为string数组。
**系统能力:**
SystemCapability.BundleManager.BundleFramework.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ------------ | ------ | ---- | -------------------------- |
| moduleName | string | 是 | 表示应用程序的moduleName。 |
| abilityName | string | 是 | 表示应用程序的abilityName。 |
| metadataName | string | 否 | 表示应用程序的metadataName,默认值为空。 |
**返回值:**
| 类型 | 说明 |
| ----------------------- | ------------------------------- |
| Array
\<
string> | 数组对象,返回Array
\<
string>。 |
**错误码:**
以下错误码的详细介绍请参见
[
ohos.bundle错误码
](
../errorcodes/errorcode-bundle.md
)
。
| 错误码ID | 错误信息 |
| -------- | ------------------------------------------------------------ |
| 17700002 | The specified moduleName is not existed. |
| 17700003 | The specified abilityName is not existed. |
| 17700024 | Failed to get the profile because there is no profile in the HAP. |
| 17700026 | The specified bundle is disabled. |
| 17700029 | The specified ability is disabled. |
**示例:**
```
ts
import
bundleManager
from
'
@ohos.bundle.bundleManager
'
;
import
hilog
from
'
@ohos.hilog
'
;
let
moduleName
=
'
entry
'
;
let
abilityName
=
'
EntryAbility
'
;
try
{
let
data
=
bundleManager
.
getProfileByAbilitySync
(
moduleName
,
abilityName
);
hilog
.
info
(
0x0000
,
'
testTag
'
,
'
getProfileByAbilitySync successfully. Data: %{public}s
'
,
JSON
.
stringify
(
data
));
}
catch
(
err
)
{
hilog
.
error
(
0x0000
,
'
testTag
'
,
'
getProfileByAbilitySync failed. Cause: %{public}s
'
,
err
.
message
);
}
```
```
ts
import
bundleManager
from
'
@ohos.bundle.bundleManager
'
;
import
hilog
from
'
@ohos.hilog
'
;
let
moduleName
:
string
=
'
entry
'
;
let
abilityName
:
string
=
'
EntryAbility
'
;
let
metadataName
:
string
=
'
com.example.myapplication.metadata
'
;
try
{
let
data
=
bundleManager
.
getProfileByAbilitySync
(
moduleName
,
abilityName
,
metadataName
);
hilog
.
info
(
0x0000
,
'
testTag
'
,
'
getProfileByAbilitySync successfully. Data: %{public}s
'
,
JSON
.
stringify
(
data
));
}
catch
(
err
)
{
hilog
.
error
(
0x0000
,
'
testTag
'
,
'
getProfileByAbilitySync failed. Cause: %{public}s
'
,
err
.
message
);
}
```
### bundleManager.getProfileByExtensionAbility
### bundleManager.getProfileByExtensionAbility
getProfileByExtensionAbility(moduleName: string, extensionAbilityName: string, metadataName: string, callback: AsyncCallback
\<
Array
\<
string
\>\>
): void;
getProfileByExtensionAbility(moduleName: string, extensionAbilityName: string, metadataName: string, callback: AsyncCallback
\<
Array
\<
string
\>\>
): void;
...
@@ -2893,6 +3052,63 @@ try {
...
@@ -2893,6 +3052,63 @@ try {
}
}
```
```
### bundleManager.getProfileByExtensionAbilitySync<sup>10+</sup>
getProfileByExtensionAbilitySync(moduleName: string, extensionAbilityName: string, metadataName?: string): Array
\<
string
\>
;
以同步方法根据给定的moduleName、extensionAbilityName和metadataName获取相应配置文件的json格式字符串,返回对象为string数组。
**系统能力:**
SystemCapability.BundleManager.BundleFramework.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------------------- | ------ | ---- | ---------------------------------- |
| moduleName | string | 是 | 表示应用程序的moduleName。 |
| extensionAbilityName | string | 是 | 表示应用程序的extensionAbilityName。 |
| metadataName | string | 否 | 表示应用程序的metadataName,默认值为空。 |
**返回值:**
| 类型 | 说明 |
| ----------------------- | ----------------------------------- |
| Array
\<
string> | 返回Array
\<
string>对象。 |
**错误码:**
以下错误码的详细介绍请参见
[
ohos.bundle错误码
](
../errorcodes/errorcode-bundle.md
)
。
| 错误码ID | 错误信息 |
| -------- | ------------------------------------------------------------ |
| 17700002 | The specified moduleName is not existed. |
| 17700003 | The specified extensionAbilityName not existed. |
| 17700024 | Failed to get the profile because there is no profile in the HAP. |
| 17700026 | The specified bundle is disabled. |
**示例:**
```
ts
import
bundleManager
from
'
@ohos.bundle.bundleManager
'
;
import
hilog
from
'
@ohos.hilog
'
;
let
moduleName
=
'
entry
'
;
let
extensionAbilityName
=
'
com.example.myapplication.extension
'
;
let
metadataName
=
'
com.example.myapplication.metadata
'
;
try
{
let
data
=
bundleManager
.
getProfileByExtensionAbilitySync
(
moduleName
,
extensionAbilityName
);
hilog
.
info
(
0x0000
,
'
testTag
'
,
'
getProfileByExtensionAbilitySync successfully. Data: %{public}s
'
,
JSON
.
stringify
(
data
));
}
catch
(
err
)
{
hilog
.
error
(
0x0000
,
'
testTag
'
,
'
getProfileByExtensionAbilitySync failed. Cause: %{public}s
'
,
err
.
message
);
}
try
{
let
data
=
bundleManager
.
getProfileByExtensionAbilitySync
(
moduleName
,
extensionAbilityName
,
metadataName
);
hilog
.
info
(
0x0000
,
'
testTag
'
,
'
getProfileByExtensionAbilitySync successfully. Data: %{public}s
'
,
JSON
.
stringify
(
data
));
}
catch
(
err
)
{
hilog
.
error
(
0x0000
,
'
testTag
'
,
'
getProfileByExtensionAbilitySync failed. Cause: %{public}s
'
,
err
.
message
);
}
```
### bundleManager.getPermissionDef
### bundleManager.getPermissionDef
getPermissionDef(permissionName: string, callback: AsyncCallback
\<
[
PermissionDef
](
js-apis-bundleManager-permissionDef.md
)
>): void;
getPermissionDef(permissionName: string, callback: AsyncCallback
\<
[
PermissionDef
](
js-apis-bundleManager-permissionDef.md
)
>): void;
...
@@ -3744,6 +3960,64 @@ try {
...
@@ -3744,6 +3960,64 @@ try {
}
}
```
```
### bundleManager.getAppProvisionInfoSync<sup>10+</sup>
getAppProvisionInfoSync(bundleName: string, userId?: number): AppProvisionInfo;
以同步方法根据bundleName和userId获取应用的provision配置文件信息并返回结果。
**系统接口:**
此接口为系统接口
**需要权限:**
ohos.permission.GET_BUNDLE_INFO_PRIVILEGED
**系统能力:**
SystemCapability.BundleManager.BundleFramework.Core
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------------ | ---- | ------------------------------------------------------------ |
| bundleName | string | 是 | 指定的bundleName。 |
| userId | number | 否 | 表示用户ID,默认值:调用方所在用户,取值范围:大于等于0,可以通过接口
[
getOsAccountLocalId
](
js-apis-osAccount.md#getosaccountlocalid9
)
获取当前设备上的用户ID。 |
**返回值:**
| 类型 | 说明 |
| ------------------------------------------------------------ | ----------------------------------- |
|
[
AppProvisionInfo
](
js-apis-bundleManager-AppProvisionInfo.md
)
| AppProvisionInfo对象,返回应用的provision配置文件信息。 |
**错误码:**
以下错误码的详细介绍请参见
[
ohos.bundle错误码
](
../errorcodes/errorcode-bundle.md
)
。
| 错误码ID | 错误信息 |
| -------- | -------------------------------------- |
| 17700001 | The specified bundleName is not found. |
| 17700004 | The specified user ID is not found. |
**示例:**
```
ts
import
bundleManager
from
'
@ohos.bundle.bundleManager
'
;
import
hilog
from
'
@ohos.hilog
'
;
let
bundleName
=
"
com.ohos.myapplication
"
;
let
userId
=
100
;
try
{
let
data
=
bundleManager
.
getAppProvisionInfoSync
(
bundleName
);
hilog
.
info
(
0x0000
,
'
testTag
'
,
'
getAppProvisionInfoSync successfully. Data: %{public}s
'
,
JSON
.
stringify
(
data
));
}
catch
(
err
)
{
hilog
.
error
(
0x0000
,
'
testTag
'
,
'
getAppProvisionInfoSync failed. Cause: %{public}s
'
,
err
.
message
);
}
try
{
let
data
=
bundleManager
.
getAppProvisionInfoSync
(
bundleName
,
userId
);
hilog
.
info
(
0x0000
,
'
testTag
'
,
'
getAppProvisionInfoSync successfully. Data: %{public}s
'
,
JSON
.
stringify
(
data
));
}
catch
(
err
)
{
hilog
.
error
(
0x0000
,
'
testTag
'
,
'
getAppProvisionInfoSync failed. Cause: %{public}s
'
,
err
.
message
);
}
```
### bundleManager.getSpecifiedDistributionType<sup>10+</sup>
### bundleManager.getSpecifiedDistributionType<sup>10+</sup>
getSpecifiedDistributionType(bundleName: string): string;
getSpecifiedDistributionType(bundleName: string): string;
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录