未验证 提交 eaf49a9d 编写于 作者: O openharmony_ci 提交者: Gitee

!12027 资源文档规范整改

Merge pull request !12027 from maoziduanl/master
......@@ -96,7 +96,8 @@ getResourceManager(): Promise<ResourceManager>
**系统能力**:SystemCapability.Global.ResourceManager
**返回值:**
**返回值:**
| 类型 | 说明 |
| ---------------------------------------- | ----------------- |
| Promise<[ResourceManager](#resourcemanager)> | Promise方式返回资源管理对象 |
......@@ -133,7 +134,8 @@ getResourceManager(bundleName: string): Promise<ResourceManager>
| ---------- | ------ | ---- | ------------- |
| bundleName | string | 是 | 指定应用的Bundle名称 |
**返回值:**
**返回值:**
| 类型 | 说明 |
| ---------------------------------------- | ------------------ |
| Promise<[ResourceManager](#resourcemanager)> | Promise方式返回的资源管理对象 |
......@@ -332,7 +334,8 @@ getStringValue(resId: number): Promise<string>
| ----- | ------ | ---- | ----- |
| resId | number | 是 | 资源ID值 |
**返回值:**
**返回值:**
| 类型 | 说明 |
| --------------------- | ----------- |
| Promise<string> | 资源ID值对应的字符串 |
......@@ -423,6 +426,7 @@ getStringValue(resource: Resource): Promise<string>
| resource | [Resource](#resource9) | 是 | 资源信息 |
**返回值:**
| 类型 | 说明 |
| --------------------- | ---------------- |
| Promise<string> | resource对象对应的字符串 |
......@@ -511,7 +515,8 @@ getStringArrayValue(resId: number): Promise<Array<string>>
| ----- | ------ | ---- | ----- |
| resId | number | 是 | 资源ID值 |
**返回值:**
**返回值:**
| 类型 | 说明 |
| ---------------------------------- | ------------- |
| Promise<Array<string>> | 资源ID值对应的字符串数组 |
......@@ -598,7 +603,8 @@ getStringArrayValue(resource: Resource): Promise<Array<string>>
| -------- | ---------------------- | ---- | ---- |
| resource | [Resource](#resource9) | 是 | 资源信息 |
**返回值:**
**返回值:**
| 类型 | 说明 |
| ---------------------------------- | ------------------ |
| Promise<Array<string>> | resource对象对应的字符串数组 |
......@@ -686,7 +692,8 @@ getMediaContent(resId: number): Promise<Uint8Array>
| ----- | ------ | ---- | ----- |
| resId | number | 是 | 资源ID值 |
**返回值:**
**返回值:**
| 类型 | 说明 |
| ------------------------- | -------------- |
| Promise<Uint8Array> | 资源ID值对应的媒体文件内容 |
......@@ -771,7 +778,8 @@ getMediaContent(resource: Resource): Promise<Uint8Array>
| -------- | ---------------------- | ---- | ---- |
| resource | [Resource](#resource9) | 是 | 资源信息 |
**返回值:**
**返回值:**
| 类型 | 说明 |
| ------------------------- | ------------------- |
| Promise<Uint8Array> | resource对象对应的媒体文件内容 |
......@@ -858,7 +866,8 @@ getMediaContentBase64(resId: number): Promise<string>
| ----- | ------ | ---- | ----- |
| resId | number | 是 | 资源ID值 |
**返回值:**
**返回值:**
| 类型 | 说明 |
| --------------------- | -------------------- |
| Promise<string> | 资源ID值对应的图片资源Base64编码 |
......@@ -943,7 +952,8 @@ getMediaContentBase64(resource: Resource): Promise<string>
| -------- | ---------------------- | ---- | ---- |
| resource | [Resource](#resource9) | 是 | 资源信息 |
**返回值:**
**返回值:**
| 类型 | 说明 |
| --------------------- | ------------------------- |
| Promise<string> | resource对象对应的图片资源Base64编码 |
......@@ -1013,7 +1023,8 @@ getConfiguration(): Promise<Configuration>
**系统能力**:SystemCapability.Global.ResourceManager
**返回值:**
**返回值:**
| 类型 | 说明 |
| ---------------------------------------- | ---------------- |
| Promise<[Configuration](#configuration)> | 设备的Configuration |
......@@ -1068,7 +1079,8 @@ getDeviceCapability(): Promise<DeviceCapability>
**系统能力**:SystemCapability.Global.ResourceManager
**返回值:**
**返回值:**
| 类型 | 说明 |
| ---------------------------------------- | ------------------- |
| Promise<[DeviceCapability](#devicecapability)> | 设备的DeviceCapability |
......@@ -1143,7 +1155,8 @@ getPluralStringValue(resId: number, num: number): Promise<string>
| resId | number | 是 | 资源ID值 |
| num | number | 是 | 数量值 |
**返回值:**
**返回值:**
| 类型 | 说明 |
| --------------------- | ------------------------- |
| Promise<string> | 根据提供的数量获取对应ID字符串表示的单复数字符串 |
......@@ -1233,7 +1246,8 @@ getPluralString(resource: Resource, num: number): Promise<string>
| resource | [Resource](#resource9) | 是 | 资源信息 |
| num | number | 是 | 数量值 |
**返回值:**
**返回值:**
| 类型 | 说明 |
| --------------------- | ------------------------------ |
| Promise<string> | 根据提供的数量获取对应resource对象表示的单复数字符串 |
......@@ -1320,7 +1334,8 @@ getRawFileContent(path: string): Promise<Uint8Array>
| ---- | ------ | ---- | ----------- |
| path | string | 是 | rawfile文件路径 |
**返回值:**
**返回值:**
| 类型 | 说明 |
| ------------------------- | ----------- |
| Promise<Uint8Array> | rawfile文件内容 |
......@@ -1401,7 +1416,8 @@ getRawFd(path: string): Promise<RawFileDescriptor>
| ---- | ------ | ---- | ----------- |
| path | string | 是 | rawfile文件路径 |
**返回值:**
**返回值:**
| 类型 | 说明 |
| ---------------------------------------- | ------------------- |
| Promise<[RawFileDescriptor](#rawfiledescriptor8)> | rawfile文件descriptor |
......@@ -1469,7 +1485,8 @@ closeRawFileDescriptor(path: string): Promise<void>
| ---- | ------ | ---- | ----------- |
| path | string | 是 | rawfile文件路径 |
**返回值:**
**返回值:**
| 类型 | 说明 |
| ------------------- | ---- |
| Promise<void> | 无返回值 |
......@@ -1537,7 +1554,8 @@ closeRawFd(path: string): Promise<void>
| ---- | ------ | ---- | ----------- |
| path | string | 是 | rawfile文件路径 |
**返回值:**
**返回值:**
| 类型 | 说明 |
| ------------------- | ---- |
| Promise<void> | 无返回值 |
......@@ -1634,6 +1652,7 @@ getStringByName(resName: string): Promise<string>
| resName | string | 是 | 资源名称 |
**返回值:**
| 类型 | 说明 |
| --------------------- | ---------- |
| Promise<string> | 资源名称对应的字符串 |
......@@ -1715,7 +1734,8 @@ getStringArrayByName(resName: string): Promise<Array<string>>
| ------- | ------ | ---- | ---- |
| resName | string | 是 | 资源名称 |
**返回值:**
**返回值:**
| 类型 | 说明 |
| ---------------------------------- | ------------ |
| Promise<Array<string>> | 资源名称对应的字符串数组 |
......@@ -1797,7 +1817,8 @@ getMediaByName(resName: string): Promise<Uint8Array>
| ------- | ------ | ---- | ---- |
| resName | string | 是 | 资源名称 |
**返回值:**
**返回值:**
| 类型 | 说明 |
| ------------------------- | ------------- |
| Promise<Uint8Array> | 资源名称对应的媒体文件内容 |
......@@ -1879,7 +1900,8 @@ getMediaBase64ByName(resName: string): Promise<string>
| ------- | ------ | ---- | ---- |
| resName | string | 是 | 资源名称 |
**返回值:**
**返回值:**
| 类型 | 说明 |
| --------------------- | ------------------- |
| Promise<string> | 资源名称对应的图片资源Base64编码 |
......@@ -1964,7 +1986,8 @@ getPluralStringByName(resName: string, num: number): Promise<string>
| resName | string | 是 | 资源名称 |
| num | number | 是 | 数量值 |
**返回值:**
**返回值:**
| 类型 | 说明 |
| --------------------- | ---------------------- |
| Promise<string> | 根据传入的数量值获取资源名称对应的字符串资源 |
......@@ -2006,7 +2029,8 @@ getStringSync(resId: number): string
| ----- | ------ | ---- | ----- |
| resId | number | 是 | 资源ID值 |
**返回值:**
**返回值:**
| 类型 | 说明 |
| ------ | ----------- |
| string | 资源ID值对应的字符串 |
......@@ -2044,7 +2068,8 @@ getStringSync(resource: Resource): string
| -------- | ---------------------- | ---- | ---- |
| resource | [Resource](#resource9) | 是 | 资源信息 |
**返回值:**
**返回值:**
| 类型 | 说明 |
| ------ | ---------------- |
| string | resource对象对应的字符串 |
......@@ -2087,7 +2112,8 @@ getStringByNameSync(resName: string): string
| ------- | ------ | ---- | ---- |
| resName | string | 是 | 资源名称 |
**返回值:**
**返回值:**
| 类型 | 说明 |
| ------ | ---------- |
| string | 资源名称对应的字符串 |
......@@ -2125,7 +2151,8 @@ getBoolean(resId: number): boolean
| ----- | ------ | ---- | ----- |
| resId | number | 是 | 资源ID值 |
**返回值:**
**返回值:**
| 类型 | 说明 |
| ------- | ------------ |
| boolean | 资源ID值对应的布尔结果 |
......@@ -2162,7 +2189,8 @@ getBoolean(resource: Resource): boolean
| -------- | ---------------------- | ---- | ---- |
| resource | [Resource](#resource9) | 是 | 资源信息 |
**返回值:**
**返回值:**
| 类型 | 说明 |
| ------- | ----------------- |
| boolean | resource对象对应的布尔结果 |
......@@ -2205,7 +2233,8 @@ getBooleanByName(resName: string): boolean
| ------- | ------ | ---- | ---- |
| resName | string | 是 | 资源名称 |
**返回值:**
**返回值:**
| 类型 | 说明 |
| ------- | ----------- |
| boolean | 资源名称对应的布尔结果 |
......@@ -2243,7 +2272,8 @@ getNumber(resId: number): number
| ----- | ------ | ---- | ----- |
| resId | number | 是 | 资源ID值 |
**返回值:**
**返回值:**
| 类型 | 说明 |
| ------ | ---------- |
| number | 资源ID值对应的数值 |
......@@ -2287,7 +2317,8 @@ getNumber(resource: Resource): number
| -------- | ---------------------- | ---- | ---- |
| resource | [Resource](#resource9) | 是 | 资源信息 |
**返回值:**
**返回值:**
| 类型 | 说明 |
| ------ | --------------- |
| number | resource对象对应的数值 |
......@@ -2330,7 +2361,8 @@ getNumberByName(resName: string): number
| ------- | ------ | ---- | ---- |
| resName | string | 是 | 资源名称 |
**返回值:**
**返回值:**
| 类型 | 说明 |
| ------ | --------- |
| number | 资源名称对应的数值 |
......@@ -2408,7 +2440,8 @@ getString(resId: number): Promise<string>
| ----- | ------ | ---- | ----- |
| resId | number | 是 | 资源ID值 |
**返回值:**
**返回值:**
| 类型 | 说明 |
| --------------------- | ----------- |
| Promise<string> | 资源ID值对应的字符串 |
......@@ -2472,7 +2505,8 @@ getStringArray(resId: number): Promise<Array<string>>
| ----- | ------ | ---- | ----- |
| resId | number | 是 | 资源ID值 |
**返回值:**
**返回值:**
| 类型 | 说明 |
| ---------------------------------- | ------------- |
| Promise<Array<string>> | 资源ID值对应的字符串数组 |
......@@ -2536,7 +2570,8 @@ getMedia(resId: number): Promise<Uint8Array>
| ----- | ------ | ---- | ----- |
| resId | number | 是 | 资源ID值 |
**返回值:**
**返回值:**
| 类型 | 说明 |
| ------------------------- | -------------- |
| Promise<Uint8Array> | 资源ID值对应的媒体文件内容 |
......@@ -2600,7 +2635,8 @@ getMediaBase64(resId: number): Promise<string>
| ----- | ------ | ---- | ----- |
| resId | number | 是 | 资源ID值 |
**返回值:**
**返回值:**
| 类型 | 说明 |
| --------------------- | -------------------- |
| Promise<string> | 资源ID值对应的图片资源Base64编码 |
......@@ -2634,7 +2670,8 @@ getPluralString(resId: number, num: number): Promise<string>
| resId | number | 是 | 资源ID值 |
| num | number | 是 | 数量值 |
**返回值:**
**返回值:**
| 类型 | 说明 |
| --------------------- | ------------------------- |
| Promise<string> | 根据提供的数量获取对应ID字符串表示的单复数字符串 |
......@@ -2730,7 +2767,8 @@ getRawFile(path: string): Promise<Uint8Array>
| ---- | ------ | ---- | ----------- |
| path | string | 是 | rawfile文件路径 |
**返回值:**
**返回值:**
| 类型 | 说明 |
| ------------------------- | ----------- |
| Promise<Uint8Array> | rawfile文件内容 |
......@@ -2795,7 +2833,8 @@ getRawFileDescriptor(path: string): Promise<RawFileDescriptor>
| ---- | ------ | ---- | ----------- |
| path | string | 是 | rawfile文件路径 |
**返回值:**
**返回值:**
| 类型 | 说明 |
| ---------------------------------------- | ------------------- |
| Promise<[RawFileDescriptor](#rawfiledescriptor8)> | rawfile文件descriptor |
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册