From 0b6725770ce74068bbe6507818b86d0d430c8ced Mon Sep 17 00:00:00 2001 From: huangjie Date: Tue, 22 Aug 2023 14:25:21 +0800 Subject: [PATCH] =?UTF-8?q?=E8=B5=84=E6=BA=90=E5=A2=9E=E5=8A=A0rawfile?= =?UTF-8?q?=E7=9B=B8=E5=85=B3=E5=90=8C=E6=AD=A5=E6=8E=A5=E5=8F=A3=E6=96=87?= =?UTF-8?q?=E6=A1=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: huangjie --- .../apis/js-apis-resource-manager.md | 142 ++++++++++++++++++ 1 file changed, 142 insertions(+) diff --git a/zh-cn/application-dev/reference/apis/js-apis-resource-manager.md b/zh-cn/application-dev/reference/apis/js-apis-resource-manager.md index 6e333f0280..5d29a95caa 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-resource-manager.md +++ b/zh-cn/application-dev/reference/apis/js-apis-resource-manager.md @@ -3540,6 +3540,43 @@ getColorByName(resName: string): Promise<number> } ``` +### getRawFileContentSync10+ + +getRawFileContentSync(path: string): Uint8Array + +用户获取resources/rawfile目录下对应的rawfile文件内容,使用同步形式返回字节数组。 + +**系统能力:** SystemCapability.Global.ResourceManager + +**参数:** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------------- | ---- | ----------------------- | +| path | string | 是 | rawfile文件路径 | + +**返回值:** + +| 类型 | 说明 | +| --------------------- | ---------- | +| Uint8Array | 返回获取的rawfile文件内容 | + +**错误码:** + +以下错误码的详细介绍请参见[资源管理错误码](../errorcodes/errorcode-resource-manager.md)。 + +| 错误码ID | 错误信息 | +| -------- | ---------------------------------------- | +| 9001005 | If the resource not found by path. | + +**示例:** + ```ts + try { + this.context.resourceManager.getRawFileContentSync("test.txt"); + } catch (error) { + console.error(`getRawFileContentSync failed, error code: ${error.code}, message: ${error.message}.`); + } + ``` + ### getRawFileContent9+ getRawFileContent(path: string, callback: AsyncCallback<Uint8Array>): void @@ -3619,6 +3656,43 @@ getRawFileContent(path: string): Promise<Uint8Array> } ``` +### getRawFileListSync10+ + +getRawFileListSync(path: string): Array\ + +用户获取resources/rawfile目录下文件夹及文件列表,使用同步形式返回文件列表的字符串数组。 + +**系统能力:** SystemCapability.Global.ResourceManager + +**参数:** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------------- | ---- | ----------------------- | +| path | string | 是 | rawfile文件夹路径 | + +**返回值:** + +| 类型 | 说明 | +| ------------------------- | ----------- | +| Array\ | rawfile文件夹下的列表(包含子文件夹和文件) | + +**错误码:** + +以下错误码的详细介绍请参见[资源管理错误码](../errorcodes/errorcode-resource-manager.md)。 + +| 错误码ID | 错误信息 | +| -------- | ---------------------------------------- | +| 9001005 | If the resource not found by path. | + +**示例:** + ```ts + try { // 传入""表示获取rawfile根目录下的文件列表 + this.context.resourceManager.getRawFileListSync("") + } catch (error) { + console.error(`getRawFileListSync failed, error code: ${error.code}, message: ${error.message}.`); + } + ``` + ### getRawFileList10+ getRawFileList(path: string, callback: AsyncCallback<Array\>): void; @@ -3698,6 +3772,43 @@ getRawFileList(path: string): Promise<Array\> } ``` +### getRawFdSync10+ + +getRawFdSync(path: string): RawFileDescriptor + +用户获取resources/rawfile目录下对应rawfile文件的descriptor。 + +**系统能力:** SystemCapability.Global.ResourceManager + +**参数:** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ---------------------------------------- | ---- | -------------------------------- | +| path | string | 是 | rawfile文件路径 | + +**返回值:** + +| 类型 | 说明 | +| ------------------------- | ----------- | +| [RawFileDescriptor](#rawfiledescriptor8) | rawfile文件的descriptor | + +**错误码:** + +以下错误码的详细介绍请参见[资源管理错误码](../errorcodes/errorcode-resource-manager.md)。 + +| 错误码ID | 错误信息 | +| -------- | ---------------------------------------- | +| 9001005 | If the resource not found by path. | + +**示例:** + ```ts + try { + this.context.resourceManager.getRawFdSync("test.txt"); + } catch (error) { + console.error(`getRawFdSync failed, error code: ${error.code}, message: ${error.message}.`); + } + ``` + ### getRawFd9+ getRawFd(path: string, callback: AsyncCallback<RawFileDescriptor>): void @@ -3781,6 +3892,37 @@ getRawFd(path: string): Promise<RawFileDescriptor> } ``` +### closeRawFdSync10+ + +closeRawFdSync(path: string): void + +用户关闭resources/rawfile目录下rawfile文件的descriptor。 + +**系统能力**:SystemCapability.Global.ResourceManager + +**参数:** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------- | ---- | ----------- | +| path | string | 是 | rawfile文件路径 | + +**错误码:** + +以下错误码的详细介绍请参见[资源管理错误码](../errorcodes/errorcode-resource-manager.md)。 + +| 错误码ID | 错误信息 | +| -------- | ---------------------------------------- | +| 9001005 | The resource not found by path. | + +**示例:** + ```ts + try { + this.context.resourceManager.closeRawFdSync("test.txt"); + } catch (error) { + console.error(`closeRawFd failed, error code: ${error.code}, message: ${error.message}.`); + } + ``` + ### closeRawFd9+ closeRawFd(path: string, callback: AsyncCallback<void>): void -- GitLab