Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
4d7d9402
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看板
体验新版 GitCode,发现更多精彩内容 >>
提交
4d7d9402
编写于
7月 05, 2022
作者:
Z
zhuxiang
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
add resource manager js interface for resource object
Signed-off-by:
N
zhuxiang
<
zhuxiang6@huawei.com
>
上级
31de0451
变更
1
隐藏空白更改
内联
并排
Showing
1 changed file
with
405 addition
and
0 deletion
+405
-0
zh-cn/application-dev/reference/apis/js-apis-resource-manager.md
...pplication-dev/reference/apis/js-apis-resource-manager.md
+405
-0
未找到文件。
zh-cn/application-dev/reference/apis/js-apis-resource-manager.md
浏览文件 @
4d7d9402
...
...
@@ -238,6 +238,18 @@ resourceManager.getResourceManager((error, mgr) => {
| offset | number | rawfile的起始偏移量 |
| length | number | rawfile的文件长度 |
## Resource
表示的资源信息。
**系统能力:**
以下各项对应的系统能力均为SystemCapability.Global.ResourceManager
| 名称 | 类型 | 说明 |
| ------ | ------ | ------------------ |
| bundleName | string | 应用的bundle名称 |
| moduleName | string | 应用的module名称 |
| id | number | 资源的id值 |
## ResourceManager
...
...
@@ -307,6 +319,68 @@ getString(resId: number): Promise<string>
```
### getString<sup>9+</sup>
getString(resource: Resource, callback: AsyncCallback
<
string
>
): void
用户获取指定resource对象对应的字符串,使用callback形式返回字符串。
**系统能力**
:SystemCapability.Global.ResourceManager
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------- | ---- | --------------- |
| resource |
[
Resource
](
#resource
)
| 是 | 资源信息 |
| callback | AsyncCallback
<
string
>
| 是 | 异步回调,用于返回获取的字符串 |
**示例:**
```
let resource = {
bundleName: "com.example.myapplication",
moduleName: "entry",
id: $r('app.string.test').id
};
this.context.resourceManager.getString(resource, (error, value) => {
if (error != null) {
console.log("error is " + error);
} else {
let str = value;
}
});
```
### getString<sup>9+</sup>
getString(resource: Resource): Promise
<
string
>
用户获取指定resource对象对应的字符串,使用Promise形式返回字符串。
**系统能力**
:SystemCapability.Global.ResourceManager
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----- |
| resource |
[
Resource
](
#resource
)
| 是 | 资源信息 |
**返回值:**
| 类型 | 说明 |
| --------------------- | ----------- |
| Promise
<
string
>
| resource对象对应的字符串 |
**示例:**
```
let resource = {
bundleName: "com.example.myapplication",
moduleName: "entry",
id: $r('app.string.test').id
};
this.context.resourceManager.getString(resource).then(value => {
let str = value;
}).catch(error => {
console.log("getstring promise error is " + error);
});
```
### getStringArray
getStringArray(resId: number, callback: AsyncCallback
<
Array
<
string
>>
): void
...
...
@@ -364,6 +438,67 @@ getStringArray(resId: number): Promise<Array<string>>
});
```
### getStringArray<sup>9+</sup>
getStringArray(resource: Resource, callback: AsyncCallback
<
Array
<
string
>>
): void
用户获取指定resource对象对应的字符串数组,使用callback形式返回回字符串数组。
**系统能力**
:SystemCapability.Global.ResourceManager
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------- | ---- | --------------- |
| resource |
[
Resource
](
#resource
)
| 是 | 资源信息 |
| callback | AsyncCallback
<
Array
<
string
>>
| 是 | 异步回调,用于返回获取的字符串数组 |
**示例:**
```
let resource = {
bundleName: "com.example.myapplication",
moduleName: "entry",
id: $r('app.strarray.test').id
};
this.context.resourceManager.getStringArray(resource, (error, value) => {
if (error != null) {
console.log("error is " + error);
} else {
let strArray = value;
}
});
```
### getStringArray<sup>9+</sup>
getStringArray(resource: Resource): Promise
<
Array
<
string
>>
用户获取指定resource对象对应的字符串数组,使用Promise形式返回字符串数组。
**系统能力**
:SystemCapability.Global.ResourceManager
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----- |
| resource |
[
Resource
](
#resource
)
| 是 | 资源信息 |
**返回值:**
| 类型 | 说明 |
| --------------------- | ----------- |
| Promise
<
Array
<
string
>>
| resource对象对应的字符串数组 |
**示例:**
```
let resource = {
bundleName: "com.example.myapplication",
moduleName: "entry",
id: $r('app.strarray.test').id
};
this.context.resourceManager.getStringArray(resource).then(value => {
let strArray = value;
}).catch(error => {
console.log("getStringArray promise error is " + error);
});
```
### getMedia
...
...
@@ -422,6 +557,67 @@ getMedia(resId: number): Promise<Uint8Array>
});
```
### getMedia<sup>9+</sup>
getMedia(resource: Resource, callback: AsyncCallback
<
Uint8Array
>
): void
用户获取指定resource对象对应的媒体文件内容,使用callback形式返回字节数组。
**系统能力**
:SystemCapability.Global.ResourceManager
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------- | ---- | --------------- |
| resource |
[
Resource
](
#resource
)
| 是 | 资源信息 |
| callback | AsyncCallback
<
Uint8Array
>
| 是 | 异步回调,用于返回获取的媒体文件内容 |
**示例:**
```
let resource = {
bundleName: "com.example.myapplication",
moduleName: "entry",
id: $r('app.media.test').id
};
this.context.resourceManager.getMedia(resource, (error, value) => {
if (error != null) {
console.log("error is " + error);
} else {
let media = value;
}
});
```
### getMedia<sup>9+</sup>
getMedia(resource: Resource): Promise
<
Uint8Array
>
用户获取指定resource对象对应的媒体文件内容,使用Promise形式返回字节数组。
**系统能力**
:SystemCapability.Global.ResourceManager
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----- |
| resource |
[
Resource
](
#resource
)
| 是 | 资源信息 |
**返回值:**
| 类型 | 说明 |
| --------------------- | ----------- |
| Promise
<
Uint8Array
>
| resource对象对应的媒体文件内容 |
**示例:**
```
let resource = {
bundleName: "com.example.myapplication",
moduleName: "entry",
id: $r('app.media.test').id
};
this.context.resourceManager.getMedia(resource).then(value => {
let media = value;
}).catch(error => {
console.log("getMedia promise error is " + error);
});
```
### getMediaBase64
...
...
@@ -480,6 +676,68 @@ getMediaBase64(resId: number): Promise<string>
});
```
### getMediaBase64<sup>9+</sup>
getMediaBase64(resource: Resource, callback: AsyncCallback
<
string
>
): void
用户获取指定resource对象对应的图片资源Base64编码,使用callback形式返回字符串。
**系统能力**
:SystemCapability.Global.ResourceManager
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------- | ---- | ------------------------ |
| resource |
[
Resource
](
#resource
)
| 是 | 资源信息 |
| callback | AsyncCallback
<
string
>
| 是 | 异步回调,用于返回获取的图片资源Base64编码 |
**示例:**
```
let resource = {
bundleName: "com.example.myapplication",
moduleName: "entry",
id: $r('app.media.test').id
};
this.context.resourceManager.getMediaBase64(resource, (error, value) => {
if (error != null) {
console.log("error is " + error);
} else {
let media = value;
}
});
```
### getMediaBase64<sup>9+</sup>
getMediaBase64(resource: Resource): Promise
<
string
>
用户获取指定resource对象对应的图片资源Base64编码,使用Promise形式返回字符串。
**系统能力**
:SystemCapability.Global.ResourceManager
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----- |
| resource |
[
Resource
](
#resource
)
| 是 | 资源信息 |
**返回值:**
| 类型 | 说明 |
| --------------------- | -------------------- |
| Promise
<
string
>
| resource对象对应的图片资源Base64编码 |
**示例:**
```
let resource = {
bundleName: "com.example.myapplication",
moduleName: "entry",
id: $r('app.media.test').id
};
this.context.resourceManager.getMediaBase64(resource).then(value => {
let media = value;
}).catch(error => {
console.log("getMediaBase64 promise error is " + error);
});
```
### getConfiguration
...
...
@@ -648,6 +906,70 @@ getPluralString(resId: number, num: number): Promise<string>
});
```
### getPluralString<sup>9+</sup>
getPluralString(resource: Resource, num: number, callback: AsyncCallback
<
string
>
): void
根据指定数量获取指定resource对象表示的单复数字符串,使用callback形式返回字符串。
**系统能力**
:SystemCapability.Global.ResourceManager
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------- | ---- | ------------------------------- |
| resource |
[
Resource
](
#resource
)
| 是 | 资源信息 |
| num | number | 是 | 数量值 |
| callback | AsyncCallback
<
string
>
| 是 | 异步回调,返回根据指定数量获取指定resource对象表示的单复数字符串 |
**示例:**
```
let resource = {
bundleName: "com.example.myapplication",
moduleName: "entry",
id: $r('app.plural.test').id
};
this.context.resourceManager.getPluralString(resource, 1, (error, value) => {
if (error != null) {
console.log("error is " + error);
} else {
let str = value;
}
});
```
### getPluralString<sup>9+</sup>
getPluralString(resource: Resource, num: number): Promise
<
string
>
根据指定数量获取对指定resource对象表示的单复数字符串,使用Promise形式返回字符串。
**系统能力**
:SystemCapability.Global.ResourceManager
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----- |
| resource |
[
Resource
](
#resource
)
| 是 | 资源信息 |
| num | number | 是 | 数量值 |
**返回值:**
| 类型 | 说明 |
| --------------------- | ------------------------- |
| Promise
<
string
>
| 根据提供的数量获取对应resource对象表示的单复数字符串 |
**示例:**
```
let resource = {
bundleName: "com.example.myapplication",
moduleName: "entry",
id: $r('app.plural.test').id
};
this.context.resourceManager.getPluralString(resource, 1).then(value => {
let str = value;
}).catch(error => {
console.log("getPluralString promise error is " + error);
});
```
### getRawFile<sup>8+</sup>
getRawFile(path: string, callback: AsyncCallback
<
Uint8Array
>
): void
...
...
@@ -1118,6 +1440,34 @@ getStringSync(resId: number): string
resourceManager.getStringSync($r('app.string.test').id);
```
### getStringSync<sup>9+</sup>
getStringSync(resource: Resource): string
用户获取指定resource对象对应的字符串,使用同步方式返回字符串。
**系统能力**
:SystemCapability.Global.ResourceManager
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----- |
| resource |
[
Resource
](
#resource
)
| 是 | 资源信息 |
**返回值:**
| 类型 | 说明 |
| --------------------- | ----------- |
| string | resource对象对应的字符串 |
**示例:**
```
let resource = {
bundleName: "com.example.myapplication",
moduleName: "entry",
id: $r('app.string.test').id
};
this.context.resourceManager.getStringSync(resource);
```
### getStringByNameSync<sup>9+</sup>
getStringByNameSync(resName: string): string
...
...
@@ -1163,6 +1513,33 @@ getBoolean(resId: number): boolean
```
resourceManager.getBoolean($r('app.boolean.boolean_test').id);
```
### getBoolean<sup>9+</sup>
getBoolean(resource: Resource): boolean
使用同步方式,返回获取指定resource对象对应的布尔结果。
**系统能力**
:SystemCapability.Global.ResourceManager
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----- |
| resource |
[
Resource
](
#resource
)
| 是 | 资源信息 |
**返回值:**
| 类型 | 说明 |
| --------------------- | ----------- |
| boolean | resource对象对应的布尔结果 |
**示例:**
```
let resource = {
bundleName: "com.example.myapplication",
moduleName: "entry",
id: $r('app.boolean.boolean_test').id
};
this.context.resourceManager.getBoolean(resource);
```
### getBooleanByName<sup>9+</sup>
...
...
@@ -1211,6 +1588,34 @@ getNumber(resId: number): number
resourceManager.getNumber($r('app.float.float_test').id);
```
### getNumber<sup>9+</sup>
getNumber(resource: Resource): number
用户获取指定resource对象对应的integer数值或者float数值,使用同步方式返回资源对应的数值。
**系统能力**
:SystemCapability.Global.ResourceManager
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| ----- | ------ | ---- | ----- |
| resource |
[
Resource
](
#resource
)
| 是 | 资源信息 |
**返回值:**
| 类型 | 说明 |
| --------------------- | ----------- |
| number | resource对象对应的数值 |
**示例:**
```
let resource = {
bundleName: "com.example.myapplication",
moduleName: "entry",
id: $r('app.integer.integer_test').id
};
this.context.resourceManager.getNumber(resource);
```
### getNumberByName<sup>9+</sup>
getNumberByName(resName: string): number
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录