提交 acaf3840 编写于 作者: H huangjie

文档规范整改

Signed-off-by: Nhuangjie <huangjie125@huawei.com>
上级 a6f3eb34
...@@ -97,6 +97,7 @@ getResourceManager(): Promise&lt;ResourceManager&gt; ...@@ -97,6 +97,7 @@ getResourceManager(): Promise&lt;ResourceManager&gt;
**系统能力**:SystemCapability.Global.ResourceManager **系统能力**:SystemCapability.Global.ResourceManager
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| ---------------------------------------- | ----------------- | | ---------------------------------------- | ----------------- |
| Promise&lt;[ResourceManager](#resourcemanager)&gt; | Promise方式返回资源管理对象 | | Promise&lt;[ResourceManager](#resourcemanager)&gt; | Promise方式返回资源管理对象 |
...@@ -134,6 +135,7 @@ getResourceManager(bundleName: string): Promise&lt;ResourceManager&gt; ...@@ -134,6 +135,7 @@ getResourceManager(bundleName: string): Promise&lt;ResourceManager&gt;
| bundleName | string | 是 | 指定应用的Bundle名称 | | bundleName | string | 是 | 指定应用的Bundle名称 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| ---------------------------------------- | ------------------ | | ---------------------------------------- | ------------------ |
| Promise&lt;[ResourceManager](#resourcemanager)&gt; | Promise方式返回的资源管理对象 | | Promise&lt;[ResourceManager](#resourcemanager)&gt; | Promise方式返回的资源管理对象 |
...@@ -333,6 +335,7 @@ getStringValue(resId: number): Promise&lt;string&gt; ...@@ -333,6 +335,7 @@ getStringValue(resId: number): Promise&lt;string&gt;
| resId | number | 是 | 资源ID值 | | resId | number | 是 | 资源ID值 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| --------------------- | ----------- | | --------------------- | ----------- |
| Promise&lt;string&gt; | 资源ID值对应的字符串 | | Promise&lt;string&gt; | 资源ID值对应的字符串 |
...@@ -423,6 +426,7 @@ getStringValue(resource: Resource): Promise&lt;string&gt; ...@@ -423,6 +426,7 @@ getStringValue(resource: Resource): Promise&lt;string&gt;
| resource | [Resource](#resource9) | 是 | 资源信息 | | resource | [Resource](#resource9) | 是 | 资源信息 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| --------------------- | ---------------- | | --------------------- | ---------------- |
| Promise&lt;string&gt; | resource对象对应的字符串 | | Promise&lt;string&gt; | resource对象对应的字符串 |
...@@ -512,6 +516,7 @@ getStringArrayValue(resId: number): Promise&lt;Array&lt;string&gt;&gt; ...@@ -512,6 +516,7 @@ getStringArrayValue(resId: number): Promise&lt;Array&lt;string&gt;&gt;
| resId | number | 是 | 资源ID值 | | resId | number | 是 | 资源ID值 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| ---------------------------------- | ------------- | | ---------------------------------- | ------------- |
| Promise&lt;Array&lt;string&gt;&gt; | 资源ID值对应的字符串数组 | | Promise&lt;Array&lt;string&gt;&gt; | 资源ID值对应的字符串数组 |
...@@ -599,6 +604,7 @@ getStringArrayValue(resource: Resource): Promise&lt;Array&lt;string&gt;&gt; ...@@ -599,6 +604,7 @@ getStringArrayValue(resource: Resource): Promise&lt;Array&lt;string&gt;&gt;
| resource | [Resource](#resource9) | 是 | 资源信息 | | resource | [Resource](#resource9) | 是 | 资源信息 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| ---------------------------------- | ------------------ | | ---------------------------------- | ------------------ |
| Promise&lt;Array&lt;string&gt;&gt; | resource对象对应的字符串数组 | | Promise&lt;Array&lt;string&gt;&gt; | resource对象对应的字符串数组 |
...@@ -687,6 +693,7 @@ getMediaContent(resId: number): Promise&lt;Uint8Array&gt; ...@@ -687,6 +693,7 @@ getMediaContent(resId: number): Promise&lt;Uint8Array&gt;
| resId | number | 是 | 资源ID值 | | resId | number | 是 | 资源ID值 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| ------------------------- | -------------- | | ------------------------- | -------------- |
| Promise&lt;Uint8Array&gt; | 资源ID值对应的媒体文件内容 | | Promise&lt;Uint8Array&gt; | 资源ID值对应的媒体文件内容 |
...@@ -772,6 +779,7 @@ getMediaContent(resource: Resource): Promise&lt;Uint8Array&gt; ...@@ -772,6 +779,7 @@ getMediaContent(resource: Resource): Promise&lt;Uint8Array&gt;
| resource | [Resource](#resource9) | 是 | 资源信息 | | resource | [Resource](#resource9) | 是 | 资源信息 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| ------------------------- | ------------------- | | ------------------------- | ------------------- |
| Promise&lt;Uint8Array&gt; | resource对象对应的媒体文件内容 | | Promise&lt;Uint8Array&gt; | resource对象对应的媒体文件内容 |
...@@ -859,6 +867,7 @@ getMediaContentBase64(resId: number): Promise&lt;string&gt; ...@@ -859,6 +867,7 @@ getMediaContentBase64(resId: number): Promise&lt;string&gt;
| resId | number | 是 | 资源ID值 | | resId | number | 是 | 资源ID值 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| --------------------- | -------------------- | | --------------------- | -------------------- |
| Promise&lt;string&gt; | 资源ID值对应的图片资源Base64编码 | | Promise&lt;string&gt; | 资源ID值对应的图片资源Base64编码 |
...@@ -944,6 +953,7 @@ getMediaContentBase64(resource: Resource): Promise&lt;string&gt; ...@@ -944,6 +953,7 @@ getMediaContentBase64(resource: Resource): Promise&lt;string&gt;
| resource | [Resource](#resource9) | 是 | 资源信息 | | resource | [Resource](#resource9) | 是 | 资源信息 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| --------------------- | ------------------------- | | --------------------- | ------------------------- |
| Promise&lt;string&gt; | resource对象对应的图片资源Base64编码 | | Promise&lt;string&gt; | resource对象对应的图片资源Base64编码 |
...@@ -1014,6 +1024,7 @@ getConfiguration(): Promise&lt;Configuration&gt; ...@@ -1014,6 +1024,7 @@ getConfiguration(): Promise&lt;Configuration&gt;
**系统能力**:SystemCapability.Global.ResourceManager **系统能力**:SystemCapability.Global.ResourceManager
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| ---------------------------------------- | ---------------- | | ---------------------------------------- | ---------------- |
| Promise&lt;[Configuration](#configuration)&gt; | 设备的Configuration | | Promise&lt;[Configuration](#configuration)&gt; | 设备的Configuration |
...@@ -1069,6 +1080,7 @@ getDeviceCapability(): Promise&lt;DeviceCapability&gt; ...@@ -1069,6 +1080,7 @@ getDeviceCapability(): Promise&lt;DeviceCapability&gt;
**系统能力**:SystemCapability.Global.ResourceManager **系统能力**:SystemCapability.Global.ResourceManager
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| ---------------------------------------- | ------------------- | | ---------------------------------------- | ------------------- |
| Promise&lt;[DeviceCapability](#devicecapability)&gt; | 设备的DeviceCapability | | Promise&lt;[DeviceCapability](#devicecapability)&gt; | 设备的DeviceCapability |
...@@ -1144,6 +1156,7 @@ getPluralStringValue(resId: number, num: number): Promise&lt;string&gt; ...@@ -1144,6 +1156,7 @@ getPluralStringValue(resId: number, num: number): Promise&lt;string&gt;
| num | number | 是 | 数量值 | | num | number | 是 | 数量值 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| --------------------- | ------------------------- | | --------------------- | ------------------------- |
| Promise&lt;string&gt; | 根据提供的数量获取对应ID字符串表示的单复数字符串 | | Promise&lt;string&gt; | 根据提供的数量获取对应ID字符串表示的单复数字符串 |
...@@ -1234,6 +1247,7 @@ getPluralString(resource: Resource, num: number): Promise&lt;string&gt; ...@@ -1234,6 +1247,7 @@ getPluralString(resource: Resource, num: number): Promise&lt;string&gt;
| num | number | 是 | 数量值 | | num | number | 是 | 数量值 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| --------------------- | ------------------------------ | | --------------------- | ------------------------------ |
| Promise&lt;string&gt; | 根据提供的数量获取对应resource对象表示的单复数字符串 | | Promise&lt;string&gt; | 根据提供的数量获取对应resource对象表示的单复数字符串 |
...@@ -1321,6 +1335,7 @@ getRawFileContent(path: string): Promise&lt;Uint8Array&gt; ...@@ -1321,6 +1335,7 @@ getRawFileContent(path: string): Promise&lt;Uint8Array&gt;
| path | string | 是 | rawfile文件路径 | | path | string | 是 | rawfile文件路径 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| ------------------------- | ----------- | | ------------------------- | ----------- |
| Promise&lt;Uint8Array&gt; | rawfile文件内容 | | Promise&lt;Uint8Array&gt; | rawfile文件内容 |
...@@ -1402,6 +1417,7 @@ getRawFd(path: string): Promise&lt;RawFileDescriptor&gt; ...@@ -1402,6 +1417,7 @@ getRawFd(path: string): Promise&lt;RawFileDescriptor&gt;
| path | string | 是 | rawfile文件路径 | | path | string | 是 | rawfile文件路径 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| ---------------------------------------- | ------------------- | | ---------------------------------------- | ------------------- |
| Promise&lt;[RawFileDescriptor](#rawfiledescriptor8)&gt; | rawfile文件descriptor | | Promise&lt;[RawFileDescriptor](#rawfiledescriptor8)&gt; | rawfile文件descriptor |
...@@ -1470,6 +1486,7 @@ closeRawFileDescriptor(path: string): Promise&lt;void&gt; ...@@ -1470,6 +1486,7 @@ closeRawFileDescriptor(path: string): Promise&lt;void&gt;
| path | string | 是 | rawfile文件路径 | | path | string | 是 | rawfile文件路径 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| ------------------- | ---- | | ------------------- | ---- |
| Promise&lt;void&gt; | 无返回值 | | Promise&lt;void&gt; | 无返回值 |
...@@ -1538,6 +1555,7 @@ closeRawFd(path: string): Promise&lt;void&gt; ...@@ -1538,6 +1555,7 @@ closeRawFd(path: string): Promise&lt;void&gt;
| path | string | 是 | rawfile文件路径 | | path | string | 是 | rawfile文件路径 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| ------------------- | ---- | | ------------------- | ---- |
| Promise&lt;void&gt; | 无返回值 | | Promise&lt;void&gt; | 无返回值 |
...@@ -1634,6 +1652,7 @@ getStringByName(resName: string): Promise&lt;string&gt; ...@@ -1634,6 +1652,7 @@ getStringByName(resName: string): Promise&lt;string&gt;
| resName | string | 是 | 资源名称 | | resName | string | 是 | 资源名称 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| --------------------- | ---------- | | --------------------- | ---------- |
| Promise&lt;string&gt; | 资源名称对应的字符串 | | Promise&lt;string&gt; | 资源名称对应的字符串 |
...@@ -1716,6 +1735,7 @@ getStringArrayByName(resName: string): Promise&lt;Array&lt;string&gt;&gt; ...@@ -1716,6 +1735,7 @@ getStringArrayByName(resName: string): Promise&lt;Array&lt;string&gt;&gt;
| resName | string | 是 | 资源名称 | | resName | string | 是 | 资源名称 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| ---------------------------------- | ------------ | | ---------------------------------- | ------------ |
| Promise&lt;Array&lt;string&gt;&gt; | 资源名称对应的字符串数组 | | Promise&lt;Array&lt;string&gt;&gt; | 资源名称对应的字符串数组 |
...@@ -1798,6 +1818,7 @@ getMediaByName(resName: string): Promise&lt;Uint8Array&gt; ...@@ -1798,6 +1818,7 @@ getMediaByName(resName: string): Promise&lt;Uint8Array&gt;
| resName | string | 是 | 资源名称 | | resName | string | 是 | 资源名称 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| ------------------------- | ------------- | | ------------------------- | ------------- |
| Promise&lt;Uint8Array&gt; | 资源名称对应的媒体文件内容 | | Promise&lt;Uint8Array&gt; | 资源名称对应的媒体文件内容 |
...@@ -1880,6 +1901,7 @@ getMediaBase64ByName(resName: string): Promise&lt;string&gt; ...@@ -1880,6 +1901,7 @@ getMediaBase64ByName(resName: string): Promise&lt;string&gt;
| resName | string | 是 | 资源名称 | | resName | string | 是 | 资源名称 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| --------------------- | ------------------- | | --------------------- | ------------------- |
| Promise&lt;string&gt; | 资源名称对应的图片资源Base64编码 | | Promise&lt;string&gt; | 资源名称对应的图片资源Base64编码 |
...@@ -1965,6 +1987,7 @@ getPluralStringByName(resName: string, num: number): Promise&lt;string&gt; ...@@ -1965,6 +1987,7 @@ getPluralStringByName(resName: string, num: number): Promise&lt;string&gt;
| num | number | 是 | 数量值 | | num | number | 是 | 数量值 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| --------------------- | ---------------------- | | --------------------- | ---------------------- |
| Promise&lt;string&gt; | 根据传入的数量值获取资源名称对应的字符串资源 | | Promise&lt;string&gt; | 根据传入的数量值获取资源名称对应的字符串资源 |
...@@ -2007,6 +2030,7 @@ getStringSync(resId: number): string ...@@ -2007,6 +2030,7 @@ getStringSync(resId: number): string
| resId | number | 是 | 资源ID值 | | resId | number | 是 | 资源ID值 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| ------ | ----------- | | ------ | ----------- |
| string | 资源ID值对应的字符串 | | string | 资源ID值对应的字符串 |
...@@ -2045,6 +2069,7 @@ getStringSync(resource: Resource): string ...@@ -2045,6 +2069,7 @@ getStringSync(resource: Resource): string
| resource | [Resource](#resource9) | 是 | 资源信息 | | resource | [Resource](#resource9) | 是 | 资源信息 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| ------ | ---------------- | | ------ | ---------------- |
| string | resource对象对应的字符串 | | string | resource对象对应的字符串 |
...@@ -2088,6 +2113,7 @@ getStringByNameSync(resName: string): string ...@@ -2088,6 +2113,7 @@ getStringByNameSync(resName: string): string
| resName | string | 是 | 资源名称 | | resName | string | 是 | 资源名称 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| ------ | ---------- | | ------ | ---------- |
| string | 资源名称对应的字符串 | | string | 资源名称对应的字符串 |
...@@ -2126,6 +2152,7 @@ getBoolean(resId: number): boolean ...@@ -2126,6 +2152,7 @@ getBoolean(resId: number): boolean
| resId | number | 是 | 资源ID值 | | resId | number | 是 | 资源ID值 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| ------- | ------------ | | ------- | ------------ |
| boolean | 资源ID值对应的布尔结果 | | boolean | 资源ID值对应的布尔结果 |
...@@ -2163,6 +2190,7 @@ getBoolean(resource: Resource): boolean ...@@ -2163,6 +2190,7 @@ getBoolean(resource: Resource): boolean
| resource | [Resource](#resource9) | 是 | 资源信息 | | resource | [Resource](#resource9) | 是 | 资源信息 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| ------- | ----------------- | | ------- | ----------------- |
| boolean | resource对象对应的布尔结果 | | boolean | resource对象对应的布尔结果 |
...@@ -2206,6 +2234,7 @@ getBooleanByName(resName: string): boolean ...@@ -2206,6 +2234,7 @@ getBooleanByName(resName: string): boolean
| resName | string | 是 | 资源名称 | | resName | string | 是 | 资源名称 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| ------- | ----------- | | ------- | ----------- |
| boolean | 资源名称对应的布尔结果 | | boolean | 资源名称对应的布尔结果 |
...@@ -2244,6 +2273,7 @@ getNumber(resId: number): number ...@@ -2244,6 +2273,7 @@ getNumber(resId: number): number
| resId | number | 是 | 资源ID值 | | resId | number | 是 | 资源ID值 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| ------ | ---------- | | ------ | ---------- |
| number | 资源ID值对应的数值 | | number | 资源ID值对应的数值 |
...@@ -2288,6 +2318,7 @@ getNumber(resource: Resource): number ...@@ -2288,6 +2318,7 @@ getNumber(resource: Resource): number
| resource | [Resource](#resource9) | 是 | 资源信息 | | resource | [Resource](#resource9) | 是 | 资源信息 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| ------ | --------------- | | ------ | --------------- |
| number | resource对象对应的数值 | | number | resource对象对应的数值 |
...@@ -2331,6 +2362,7 @@ getNumberByName(resName: string): number ...@@ -2331,6 +2362,7 @@ getNumberByName(resName: string): number
| resName | string | 是 | 资源名称 | | resName | string | 是 | 资源名称 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| ------ | --------- | | ------ | --------- |
| number | 资源名称对应的数值 | | number | 资源名称对应的数值 |
...@@ -2409,6 +2441,7 @@ getString(resId: number): Promise&lt;string&gt; ...@@ -2409,6 +2441,7 @@ getString(resId: number): Promise&lt;string&gt;
| resId | number | 是 | 资源ID值 | | resId | number | 是 | 资源ID值 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| --------------------- | ----------- | | --------------------- | ----------- |
| Promise&lt;string&gt; | 资源ID值对应的字符串 | | Promise&lt;string&gt; | 资源ID值对应的字符串 |
...@@ -2473,6 +2506,7 @@ getStringArray(resId: number): Promise&lt;Array&lt;string&gt;&gt; ...@@ -2473,6 +2506,7 @@ getStringArray(resId: number): Promise&lt;Array&lt;string&gt;&gt;
| resId | number | 是 | 资源ID值 | | resId | number | 是 | 资源ID值 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| ---------------------------------- | ------------- | | ---------------------------------- | ------------- |
| Promise&lt;Array&lt;string&gt;&gt; | 资源ID值对应的字符串数组 | | Promise&lt;Array&lt;string&gt;&gt; | 资源ID值对应的字符串数组 |
...@@ -2537,6 +2571,7 @@ getMedia(resId: number): Promise&lt;Uint8Array&gt; ...@@ -2537,6 +2571,7 @@ getMedia(resId: number): Promise&lt;Uint8Array&gt;
| resId | number | 是 | 资源ID值 | | resId | number | 是 | 资源ID值 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| ------------------------- | -------------- | | ------------------------- | -------------- |
| Promise&lt;Uint8Array&gt; | 资源ID值对应的媒体文件内容 | | Promise&lt;Uint8Array&gt; | 资源ID值对应的媒体文件内容 |
...@@ -2601,6 +2636,7 @@ getMediaBase64(resId: number): Promise&lt;string&gt; ...@@ -2601,6 +2636,7 @@ getMediaBase64(resId: number): Promise&lt;string&gt;
| resId | number | 是 | 资源ID值 | | resId | number | 是 | 资源ID值 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| --------------------- | -------------------- | | --------------------- | -------------------- |
| Promise&lt;string&gt; | 资源ID值对应的图片资源Base64编码 | | Promise&lt;string&gt; | 资源ID值对应的图片资源Base64编码 |
...@@ -2635,6 +2671,7 @@ getPluralString(resId: number, num: number): Promise&lt;string&gt; ...@@ -2635,6 +2671,7 @@ getPluralString(resId: number, num: number): Promise&lt;string&gt;
| num | number | 是 | 数量值 | | num | number | 是 | 数量值 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| --------------------- | ------------------------- | | --------------------- | ------------------------- |
| Promise&lt;string&gt; | 根据提供的数量获取对应ID字符串表示的单复数字符串 | | Promise&lt;string&gt; | 根据提供的数量获取对应ID字符串表示的单复数字符串 |
...@@ -2731,6 +2768,7 @@ getRawFile(path: string): Promise&lt;Uint8Array&gt; ...@@ -2731,6 +2768,7 @@ getRawFile(path: string): Promise&lt;Uint8Array&gt;
| path | string | 是 | rawfile文件路径 | | path | string | 是 | rawfile文件路径 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| ------------------------- | ----------- | | ------------------------- | ----------- |
| Promise&lt;Uint8Array&gt; | rawfile文件内容 | | Promise&lt;Uint8Array&gt; | rawfile文件内容 |
...@@ -2796,6 +2834,7 @@ getRawFileDescriptor(path: string): Promise&lt;RawFileDescriptor&gt; ...@@ -2796,6 +2834,7 @@ getRawFileDescriptor(path: string): Promise&lt;RawFileDescriptor&gt;
| path | string | 是 | rawfile文件路径 | | path | string | 是 | rawfile文件路径 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| ---------------------------------------- | ------------------- | | ---------------------------------------- | ------------------- |
| Promise&lt;[RawFileDescriptor](#rawfiledescriptor8)&gt; | rawfile文件descriptor | | Promise&lt;[RawFileDescriptor](#rawfiledescriptor8)&gt; | rawfile文件descriptor |
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册