diff --git a/en/application-dev/reference/apis/figures/en_image_url.png b/en/application-dev/reference/apis/figures/en-us_image_url.png similarity index 100% rename from en/application-dev/reference/apis/figures/en_image_url.png rename to en/application-dev/reference/apis/figures/en-us_image_url.png diff --git a/en/application-dev/reference/apis/js-apis-media.md b/en/application-dev/reference/apis/js-apis-media.md index c4038fefdb493e042022f8d4490b6faf43f08aac..89c0c298d6a369fcf7ac7fc3abc63be304b56977 100644 --- a/en/application-dev/reference/apis/js-apis-media.md +++ b/en/application-dev/reference/apis/js-apis-media.md @@ -283,7 +283,7 @@ For details about the audio playback demo, see [Audio Playback Development](../. | Name | Type | Readable| Writable| Description | | ----------- | ------------------------- | ---- | ---- | ------------------------------------------------------------ | -| src | string | Yes | Yes | Audio media URI. The mainstream audio formats (MPEG-4, AAC, MPEG-3, OGG, and WAV) are supported.
**Example of supported URIs**:
1. FD playback: fd://xx
![](figures/en_image_url.png)
2. HTTP network playback: http://xx
3. HLS network playback path (under development)
**Note**:
To use media materials, you must declare the read permission. Otherwise, the media materials cannot be played properly.| +| src | string | Yes | Yes | Audio media URI. The mainstream audio formats (MPEG-4, AAC, MPEG-3, OGG, and WAV) are supported.
**Example of supported URIs**:
1. FD playback: fd://xx
![](figures/en-us_image_url.png)
2. HTTP network playback: http://xx
3. HLS network playback path (under development)
**Note**:
To use media materials, you must declare the read permission. Otherwise, the media materials cannot be played properly. | | loop | boolean | Yes | Yes | Whether to loop audio playback. The value **true** means to loop audio playback, and **false** means the opposite. | | currentTime | number | Yes | No | Current audio playback position. | | duration | number | Yes | No | Audio duration. | @@ -677,7 +677,7 @@ For details about the video playback demo, see [Video Playback Development](../. | Name | Type | Readable| Writable| Description | | ------------------------ | ---------------------------------- | ---- | ---- | ------------------------------------------------------------ | -| url8+ | string | Yes | Yes | Video media URL. The mainstream video formats (MPEG-4, MPEG-TS, WebM, and MKV) are supported.
**Example of supported URIs**:
1. FD playback: fd://xx
![](figures/en_image_url.png)
2. HTTP network playback: http://xx
3. HLS network playback path (under development)
**Note**:
To use media materials, you must declare the read permission. Otherwise, the media materials cannot be played properly.| +| url8+ | string | Yes | Yes | Video media URL. The mainstream video formats (MPEG-4, MPEG-TS, WebM, and MKV) are supported.
**Example of supported URIs**:
1. FD playback: fd://xx
![](figures/en-us_image_url.png)
2. HTTP network playback: http://xx
3. HLS network playback path (under development)
**Note**:
To use media materials, you must declare the read permission. Otherwise, the media materials cannot be played properly. | | loop8+ | boolean | Yes | Yes | Whether to loop video playback. The value **true** means to loop video playback, and **false** means the opposite. | | currentTime8+ | number | Yes | No | Current video playback position. | | duration8+ | number | Yes | No | Video duration. The value **-1** indicates the live streaming mode. | diff --git a/zh-cn/application-dev/reference/apis/js-apis-hilog.md b/zh-cn/application-dev/reference/apis/js-apis-hilog.md index ac6a312bcff2245870cb01e43ae16921629bfad2..9b9d2ae03726f7ecec0ee84363eae843ccff2129 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-hilog.md +++ b/zh-cn/application-dev/reference/apis/js-apis-hilog.md @@ -2,7 +2,7 @@ > **说明：** > -> 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 +> 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 ## 导入模块 diff --git a/zh-cn/application-dev/reference/apis/js-apis-image.md b/zh-cn/application-dev/reference/apis/js-apis-image.md index aea41dd90db5a2e7a7660086ec055b1022143fd8..394f072cad66ee11f4c0c31c1b74df6b71bdd72f 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-image.md +++ b/zh-cn/application-dev/reference/apis/js-apis-image.md @@ -39,7 +39,7 @@ image.createPixelMap(Color, opts) ## image.createPixelMap8+ -createPixelMap(colors: ArrayBuffer, opts: InitializetionOptions) callback: AsyncCallback\): void +createPixelMap(colors: ArrayBuffer, options: InitializetionOptions, callback: AsyncCallback\): void 通过属性创建PixelMap，通过回调函数返回结果。 @@ -799,7 +799,7 @@ const imagePackerApi = image.createImagePacker(); ### packing -packing(source: ImageSource, option: PackingOption, callback: AsyncCallback>): void +packing(source: ImageSource, option: PackingOption, callback: AsyncCallback>): void 图片压缩或重新打包，使用callback形式返回结果。 @@ -807,11 +807,11 @@ packing(source: ImageSource, option: PackingOption, callback: AsyncCallback> | 是 | 获取图片打包回调，返回打包后数据。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ---------------------------------- | ---- | ---------------------------------- | +| source | [ImageSource](#imagesource) | 是 | 打包的图片源。 | +| option | [PackingOption](#packingoption) | 是 | 设置打包参数。 | +| callback | AsyncCallback> | 是 | 获取图片打包回调，返回打包后数据。 | **示例：** @@ -822,7 +822,7 @@ imagePackerApi.packing(imageSourceApi, packOpts, data => {}) ### packing -packing(source: ImageSource, option: PackingOption): Promise> +packing(source: ImageSource, option: PackingOption): Promise> 图片压缩或重新打包，使用Promise形式返回结果。 @@ -837,9 +837,9 @@ packing(source: ImageSource, option: PackingOption): Promise> **返回值：** -| 类型 | 说明 | -| :---------------------- | :-------------------------------------------- | -| Promise> | Promise实例，用于异步获取压缩或打包后的数据。 | +| 类型 | 说明 | +| :--------------------------- | :-------------------------------------------- | +| Promise> | Promise实例，用于异步获取压缩或打包后的数据。 | **示例：** @@ -852,7 +852,7 @@ imagePackerApi.packing(imageSourceApi, packOpts) ### packing -packing(source: PixelMap, option: PackingOption, callback: AsyncCallback): void; +packing(source: PixelMap, option: PackingOption, callback: AsyncCallback\): void 图片压缩或重新打包，使用callback形式返回结果。 @@ -864,7 +864,7 @@ packing(source: PixelMap, option: PackingOption, callback: AsyncCallback | 是 | 获取图片打包回调，返回打包后数据。 | +| callback | AsyncCallback\ | 是 | 获取图片打包回调，返回打包后数据。 | **示例：** @@ -875,7 +875,7 @@ imagePackerApi.packing(pixelMapApi, packOpts, data => {}) ### packing -packing(source: PixelMap, option: PackingOption): Promise> +packing(source: PixelMap, option: PackingOption): Promise> 图片压缩或重新打包，使用Promise形式返回结果。 @@ -890,9 +890,9 @@ packing(source: PixelMap, option: PackingOption): Promise> **返回值：** -| 类型 | 说明 | -| :---------------------- | :-------------------------------------------- | -| Promise> | Promise实例，用于异步获取压缩或打包后的数据。 | +| 类型 | 说明 | +| :--------------------------- | :-------------------------------------------- | +| Promise> | Promise实例，用于异步获取压缩或打包后的数据。 | **示例：** diff --git a/zh-cn/application-dev/reference/apis/js-apis-medialibrary.md b/zh-cn/application-dev/reference/apis/js-apis-medialibrary.md index a4235f91399c152dc51ca8ffa28474d659f9848b..bc504e4d750f9cb419c4e61b1f2d17250301b3b9 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-medialibrary.md +++ b/zh-cn/application-dev/reference/apis/js-apis-medialibrary.md @@ -8,7 +8,7 @@ import mediaLibrary from '@ohos.multimedia.medialibrary'; ``` -## mediaLibrary.getMediaLibrary +## mediaLibrary.getMediaLibrary8+ getMediaLibrary(context: Context): MediaLibrary @@ -18,9 +18,9 @@ getMediaLibrary(context: Context): MediaLibrary **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ------- | ------- | ------------------------------------- | -------------------------- | -| context | Context | 否6-7
是8+ | 传入Ability实例的Context。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------- | ------- | ---- | -------------------------- | +| context | Context | 是 | 传入Ability实例的Context。 | **返回值：** @@ -36,9 +36,31 @@ import featureAbility from '@ohos.ability.featureAbility'; var context = featureAbility.getContext() var media = mediaLibrary.getMediaLibrary(context); ``` +## mediaLibrary.getMediaLibrary + +getMediaLibrary(): MediaLibrary + +获取媒体库的实例，用于访问和修改用户等个人媒体数据信息（如音频、视频、图片、文档等）。 + +> **说明**： 从API Version 8开始，该接口不再维护，推荐使用新接口[mediaLibrary.getMediaLibrary8+](#medialibrarygetmedialibrary8)。 + +**系统能力**：SystemCapability.Multimedia.MediaLibrary.Core + +**返回值：** + +| 类型 | 说明 | +| ----------------------------- | :--------- | +| [MediaLibrary](#medialibrary) | 媒体库实例 | + +**示例：** + +```js +var media = mediaLibrary.getMediaLibrary(); +``` + ## MediaLibrary -### getFileAssets8+ +### getFileAssets7+ getFileAssets(options: MediaFetchOptions, callback: AsyncCallback<FetchFileResult>): void @@ -51,10 +73,10 @@ getFileAssets(options: MediaFetchOptions, callback: AsyncCallback<FetchFileRe **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ---------------------------------------- | ---- | ------------------------ | -| options | [MediaFetchOptions](#mediafetchoptions8) | 是 | 文件获取选项 | -| callback | AsyncCallback<[FetchFileResult](#fetchfileresult8)> | 是 | 异步获取FetchFileResult之后的回调 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | --------------------------------------------------- | ---- | --------------------------------- | +| options | [MediaFetchOptions](#mediafetchoptions7) | 是 | 文件获取选项 | +| callback | AsyncCallback<[FetchFileResult](#fetchfileresult7)> | 是 | 异步获取FetchFileResult之后的回调 | **示例：** @@ -76,7 +98,7 @@ mediaLibrary.getFileAssets(imagesfetchOp, (error, fetchFileResult) => { } }); ``` -### getFileAssets8+ +### getFileAssets7+ getFileAssets(options: MediaFetchOptions): Promise<FetchFileResult> @@ -88,15 +110,15 @@ getFileAssets(options: MediaFetchOptions): Promise<FetchFileResult> **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ------- | ---------------------------------------- | ---- | ------ | -| options | [MediaFetchOptions](#mediafetchoptions8) | 是 | 文件检索选项 | +| 参数名 | 类型 | 必填 | 说明 | +| ------- | ---------------------------------------- | ---- | ------------ | +| options | [MediaFetchOptions](#mediafetchoptions7) | 是 | 文件检索选项 | **返回值** -| 类型 | 说明 | -| ------------------------------------ | ------- | -| [FetchFileResult](#fetchfileresult8) | 文件数据结果集 | +| 类型 | 说明 | +| ------------------------------------ | -------------- | +| [FetchFileResult](#fetchfileresult7) | 文件数据结果集 | **示例：** @@ -171,12 +193,12 @@ createAsset(mediaType: MediaType, displayName: string, relativePath: string, cal **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ------------ | --------------------------------------- | ---- | ---------------------------------------- | -| mediaType | [MediaType](#mediatype) | 是 | 媒体类型 | -| displayName | string | 是 | 展示文件名 | -| relativePath | string | 是 | 文件保存路径，可以通过[getPublicDirectory](#getpublicdirectory8)获取不同类型文件的保存路径 | -| callback | AsyncCallback<[FileAsset](#fileasset8)> | 是 | 异步获取媒体数据FileAsset之后的回调 | +| 参数名 | 类型 | 必填 | 说明 | +| ------------ | --------------------------------------- | ---- | ------------------------------------------------------------ | +| mediaType | [MediaType](#mediatype8) | 是 | 媒体类型 | +| displayName | string | 是 | 展示文件名 | +| relativePath | string | 是 | 文件保存路径，可以通过[getPublicDirectory](#getpublicdirectory8)获取不同类型文件的保存路径 | +| callback | AsyncCallback<[FileAsset](#fileasset7)> | 是 | 异步获取媒体数据FileAsset之后的回调 | **示例：** @@ -208,17 +230,17 @@ createAsset(mediaType: MediaType, displayName: string, relativePath: string): Pr **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ------------ | ----------------------- | ---- | ---------------------------------------- | -| mediaType | [MediaType](#mediatype) | 是 | 媒体类型 | -| displayName | string | 是 | 展示文件名 | -| relativePath | string | 是 | 相对路径，可以通过getPublicDirectory获取不同类型媒体文件的一层目录的relative path | +| 参数名 | 类型 | 必填 | 说明 | +| ------------ | ------------------------ | ---- | ------------------------------------------------------------ | +| mediaType | [MediaType](#mediatype8) | 是 | 媒体类型 | +| displayName | string | 是 | 展示文件名 | +| relativePath | string | 是 | 相对路径，可以通过getPublicDirectory获取不同类型媒体文件的一层目录的relative path | **返回值** -| 类型 | 说明 | -| ------------------------ | ------------- | -| [FileAsset](#fileasset8) | 媒体数据FileAsset | +| 类型 | 说明 | +| ------------------------ | ----------------- | +| [FileAsset](#fileasset7) | 媒体数据FileAsset | **示例：** @@ -246,10 +268,10 @@ getPublicDirectory(type: DirectoryType, callback: AsyncCallback<string>): **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ------------------------------- | ---- | ----------------- | -| type | [DirectoryType](#directorytype) | 是 | 公共目录类型 | -| callback | AsyncCallback<string> | 是 | callback 返回公共目录路径 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------------------------------- | ---- | ------------------------- | +| type | [DirectoryType](#directorytype8) | 是 | 公共目录类型 | +| callback | AsyncCallback<string> | 是 | callback 返回公共目录路径 | **示例：** @@ -274,15 +296,15 @@ getPublicDirectory(type: DirectoryType): Promise<string> **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ---- | ------------------------------- | ---- | ------ | -| type | [DirectoryType](#directorytype) | 是 | 公共目录类型 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | -------------------------------- | ---- | ------------ | +| type | [DirectoryType](#directorytype8) | 是 | 公共目录类型 | **返回值：** -| 类型 | 说明 | -| --------------- | -------- | -| Promise | 返回公共目录路径 | +| 类型 | 说明 | +| ---------------- | ---------------- | +| Promise\ | 返回公共目录路径 | **示例：** @@ -298,7 +320,7 @@ async function example() { } ``` -### getAlbums8+ +### getAlbums7+ getAlbums(options: MediaFetchOptions, callback: AsyncCallback): void @@ -310,10 +332,10 @@ getAlbums(options: MediaFetchOptions, callback: AsyncCallback> | 是 | 异步获取Album列表之后的回调 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------------------------------------------- | ---- | --------------------------- | +| options | [MediaFetchOptions](#mediafetchoptions7) | 是 | 相册获取条件 | +| callback | AsyncCallback<Array<[Album](#album7)>> | 是 | 异步获取Album列表之后的回调 | **示例：** @@ -333,7 +355,7 @@ mediaLibrary.getAlbums(AlbumNoArgsfetchOp, (err, albumList) => { }) ``` -### getAlbums8+ +### getAlbums7+ getAlbums(options: MediaFetchOptions): Promise @@ -345,15 +367,15 @@ getAlbums(options: MediaFetchOptions): Promise **参数：** -| 参数名 | 类型 | 必填 | 说明 | -| ------- | ---------------------------------------- | ---- | ------ | -| options | [MediaFetchOptions](#mediafetchoptions8) | 是 | 相册获取条件 | +| 参数名 | 类型 | 必填 | 说明 | +| ------- | ---------------------------------------- | ---- | ------------ | +| options | [MediaFetchOptions](#mediafetchoptions7) | 是 | 相册获取条件 | **返回值：** -| 类型 | 说明 | -| -------------------------------- | --------- | -| Promise> | 返回Album列表 | +| 类型 | 说明 | +| -------------------------------- | ------------- | +| Promise> | 返回Album列表 | **示例：** @@ -690,7 +712,7 @@ mediaLibrary.getMediaLibrary().startMediaSelect(option).then((value) => { ``` -## FileAsset8+ +## FileAsset7+ 提供封装文件属性的方法。 @@ -698,29 +720,29 @@ mediaLibrary.getMediaLibrary().startMediaSelect(option).then((value) => { **系统能力：** 以下各项对应的系统能力均为SystemCapability.Multimedia.MediaLibrary.Core -| 名称 | 类型 | 可读 | 可写 | 说明 | -| ------------ | ----------------------- | ---- | ---- | --------------------------------------- | -| id | number | 是 | 否 | 文件资源编号 | -| uri | string | 是 | 否 | 文件资源uri（如：dataability:///media/image/2) | -| mimeType | string | 是 | 否 | 文件扩展属性 | -| mediaType | [MediaType](#mediatype) | 是 | 否 | 媒体类型 | -| displayName | string | 是 | 是 | 显示文件名，包含后缀名 | -| title | string | 是 | 是 | 文件标题 | -| relativePath | string | 是 | 是 | 相对公共目录路径 | -| parent | number | 是 | 否 | 父目录id | -| size | number | 是 | 否 | 文件大小（单位：字节） | -| dateAdded | number | 是 | 否 | 添加日期（添加文件时间到1970年1月1日的秒数值） | -| dateModified | number | 是 | 否 | 修改日期（修改文件时间到1970年1月1日的秒数值） | -| dateTaken | number | 是 | 否 | 拍摄日期（文件拍照时间到1970年1月1日的秒数值） | -| artist | string | 是 | 否 | 作者 | -| audioAlbum | string | 是 | 否 | 专辑 | -| width | number | 是 | 否 | 图片宽度（单位：像素） | -| height | number | 是 | 否 | 图片高度（单位：像素） | -| orientation | number | 是 | 是 | 图片显示方向（顺时针旋转角度，如0，90，180 单位：度） | -| duration | number | 是 | 否 | 持续时间（单位：秒） | -| albumId | number | 是 | 否 | 文件所归属的相册编号 | -| albumUri | string | 是 | 否 | 文件所归属相册uri | -| albumName | string | 是 | 否 | 文件所归属相册名称 | +| 名称 | 类型 | 可读 | 可写 | 说明 | +| ------------------------- | ------------------------ | ---- | ---- | ------------------------------------------------------ | +| id | number | 是 | 否 | 文件资源编号 | +| uri | string | 是 | 否 | 文件资源uri（如：dataability:///media/image/2) | +| mimeType | string | 是 | 否 | 文件扩展属性 | +| mediaType8+ | [MediaType](#mediatype8) | 是 | 否 | 媒体类型 | +| displayName | string | 是 | 是 | 显示文件名，包含后缀名 | +| title | string | 是 | 是 | 文件标题 | +| relativePath8+ | string | 是 | 是 | 相对公共目录路径 | +| parent8+ | number | 是 | 否 | 父目录id | +| size | number | 是 | 否 | 文件大小（单位：字节） | +| dateAdded | number | 是 | 否 | 添加日期（添加文件时间到1970年1月1日的秒数值） | +| dateModified | number | 是 | 否 | 修改日期（修改文件时间到1970年1月1日的秒数值） | +| dateTaken | number | 是 | 否 | 拍摄日期（文件拍照时间到1970年1月1日的秒数值） | +| artist8+ | string | 是 | 否 | 作者 | +| audioAlbum8+ | string | 是 | 否 | 专辑 | +| width | number | 是 | 否 | 图片宽度（单位：像素） | +| height | number | 是 | 否 | 图片高度（单位：像素） | +| orientation | number | 是 | 是 | 图片显示方向（顺时针旋转角度，如0，90，180 单位：度） | +| duration8+ | number | 是 | 否 | 持续时间（单位：秒） | +| albumId | number | 是 | 否 | 文件所归属的相册编号 | +| albumUri8+ | string | 是 | 否 | 文件所归属相册uri | +| albumName | string | 是 | 否 | 文件所归属相册名称 | ### isDirectory8+ @@ -1460,11 +1482,11 @@ async function example() { } ``` -## FetchFileResult8+ +## FetchFileResult7+ 文件检索结果集。 -### getCount8+ +### getCount7+ getCount(): number @@ -1493,7 +1515,7 @@ async function example() { } ``` -### isAfterLast8+ +### isAfterLast7+ isAfterLast(): boolean @@ -1536,7 +1558,7 @@ async function example() { } ``` -### close8+ +### close7+ close(): void @@ -1560,7 +1582,7 @@ async function example() { } ``` -### getFirstObject8+ +### getFirstObject7+ getFirstObject(callback: AsyncCallback<FileAsset>): void @@ -1570,9 +1592,9 @@ getFirstObject(callback: AsyncCallback<FileAsset>): void **参数**： -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ---------------------------------------- | ---- | -------------------------- | -| callback | AsyncCallback<[FileAsset](#fileasset8)> | 是 | 异步获取结果集中第一个FileAsset完成后的回调 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | --------------------------------------------- | ---- | ------------------------------------------- | +| callback | AsyncCallback<[FileAsset](#fileasset7)> | 是 | 异步获取结果集中第一个FileAsset完成后的回调 | **示例**： @@ -1596,7 +1618,7 @@ async function example() { } ``` -### getFirstObject8+ +### getFirstObject7+ getFirstObject(): Promise<FileAsset> @@ -1608,7 +1630,7 @@ getFirstObject(): Promise<FileAsset> | 类型 | 说明 | | --------------------------------------- | -------------------------- | -| Promise<[FileAsset](#fileasset8)> | Promise方式返回FileAsset。 | +| Promise<[FileAsset](#fileasset7)> | Promise方式返回FileAsset。 | **示例**： @@ -1630,7 +1652,7 @@ async function example() { } ``` -### getNextObject8+ +### getNextObject7+ getNextObject(callback: AsyncCallback<FileAsset>): void @@ -1642,9 +1664,9 @@ async function example() { **参数**： -| 参数名 | 类型 | 必填 | 说明 | -| --------- | ---------------------------------------- | ---- | ------------------------- | -| callbacke | AsyncCallback<[FileAsset](#fileasset8)> | 是 | 异步返回结果集中下一个FileAsset之后的回调 | +| 参数名 | 类型 | 必填 | 说明 | +| --------- | --------------------------------------------- | ---- | ----------------------------------------- | +| callbacke | AsyncCallback<[FileAsset](#fileasset7)> | 是 | 异步返回结果集中下一个FileAsset之后的回调 | **示例**： @@ -1668,7 +1690,7 @@ async function example() { } ``` -### getNextObject8+ +### getNextObject7+ getNextObject(): Promise<FileAsset> @@ -1680,9 +1702,9 @@ async function example() { **返回值**： -| 类型 | 说明 | -| --------------------------------------- | ------------- | -| Promise<[FileAsset](#fileasset8)> | 返回FileAsset对象 | +| 类型 | 说明 | +| --------------------------------------- | ----------------- | +| Promise<[FileAsset](#fileasset7)> | 返回FileAsset对象 | **示例**： @@ -1702,7 +1724,7 @@ async function example() { } ``` -### getLastObject8+ +### getLastObject7+ getLastObject(callback: AsyncCallback<FileAsset>): void @@ -1714,7 +1736,7 @@ getLastObject(callback: AsyncCallback<FileAsset>): void | 参数名 | 类型 | 必填 | 说明 | | -------- | --------------------------------------------- | ---- | --------------------------- | -| callback | AsyncCallback<[FileAsset](#fileasset8)> | 是 | 异步返回FileAsset之后的回调 | +| callback | AsyncCallback<[FileAsset](#fileasset7)> | 是 | 异步返回FileAsset之后的回调 | **示例**： @@ -1738,7 +1760,7 @@ async function example() { } ``` -### getLastObject8+ +### getLastObject7+ getLastObject(): Promise<FileAsset> @@ -1748,9 +1770,9 @@ getLastObject(): Promise<FileAsset> **返回值**： -| 类型 | 说明 | -| --------------------------------------- | ------------- | -| Promise<[FileAsset](#fileasset8)> | 返回FileAsset对象 | +| 类型 | 说明 | +| --------------------------------------- | ----------------- | +| Promise<[FileAsset](#fileasset7)> | 返回FileAsset对象 | **示例**： @@ -1768,7 +1790,7 @@ async function example() { } ``` -### getPositionObject8+ +### getPositionObject7+ getPositionObject(index: number, callback: AsyncCallback<FileAsset>): void @@ -1781,7 +1803,7 @@ getPositionObject(index: number, callback: AsyncCallback<FileAsset>): void | 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------------------------------- | ---- | ------------------ | | index | number | 是 | 要获取的文件的索引，从0开始 | -| callback | AsyncCallback<[FileAsset](#fileasset8)> | 是 | 异步返回FileAsset之后的回调 | +| callback | AsyncCallback<[FileAsset](#fileasset7)> | 是 | 异步返回FileAsset之后的回调 | **示例**： @@ -1805,7 +1827,7 @@ async function example() { } ``` -### getPositionObject8+ +### getPositionObject7+ getPositionObject(index: number): Promise<FileAsset> @@ -1823,9 +1845,9 @@ getPositionObject(index: number): Promise<FileAsset> **返回值**： -| 类型 | 说明 | -| --------------------------------------- | ------------- | -| Promise<[FileAsset](#fileasset8)> | 返回FileAsset对象 | +| 类型 | 说明 | +| --------------------------------------- | ----------------- | +| Promise<[FileAsset](#fileasset7)> | 返回FileAsset对象 | **示例**： @@ -1849,7 +1871,7 @@ async function example() { } ``` -### getAllObject8+ +### getAllObject7+ getAllObject(callback: AsyncCallback<Array<FileAsset>>): void @@ -1863,7 +1885,7 @@ getAllObject(callback: AsyncCallback<Array<FileAsset>>): void | 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------------------------------- | ---- | -------------------- | -| callback | AsyncCallback> | 是 | 异步返回FileAsset列表之后的回调 | +| callback | AsyncCallback> | 是 | 异步返回FileAsset列表之后的回调 | **示例**： @@ -1887,7 +1909,7 @@ async function example() { } ``` -### getAllObject8+ +### getAllObject7+ getAllObject(): Promise<Array<FileAsset>> @@ -1897,9 +1919,9 @@ getAllObject(): Promise<Array<FileAsset>> **返回值**： -| 类型 | 说明 | -| ---------------------------------------- | --------------- | -| Promise> | 返回FileAsset对象列表 | +| 类型 | 说明 | +| ---------------------------------------- | --------------------- | +| Promise> | 返回FileAsset对象列表 | **示例**： @@ -1917,7 +1939,7 @@ async function example() { } ``` -## Album8+ +## Album7+ 实体相册 @@ -1927,13 +1949,13 @@ async function example() { | 名称 | 类型 | 可读 | 可写 | 说明 | | ------------ | ------ | ---- | ---- | ------- | -| albumId | number | 是 | 否 | 相册编号 | -| albumName | string | 是 | 是 | 相册名称 | -| albumUri | string | 是 | 否 | 相册Uri | +| albumId | number | 是 | 否 | 相册编号 | +| albumName | string | 是 | 是 | 相册名称 | +| albumUri8+ | string | 是 | 否 | 相册Uri | | dateModified | number | 是 | 否 | 修改日期 | -| count | number | 是 | 否 | 相册中文件数量 | -| relativePath | string | 是 | 否 | 相对路径 | -| coverUri | string | 是 | 否 | 封面文件Uri | +| count8+ | number | 是 | 否 | 相册中文件数量 | +| relativePath8+ | string | 是 | 否 | 相对路径 | +| coverUri8+ | string | 是 | 否 | 封面文件Uri | ### commitModify8+ @@ -2007,7 +2029,7 @@ async function example() { } ``` -### getFileAssets8+ +### getFileAssets7+ getFileAssets(options: MediaFetchOptions, callback: AsyncCallback<FetchFileResult>): void @@ -2021,8 +2043,8 @@ getFileAssets(options: MediaFetchOptions, callback: AsyncCallback<FetchFileRe | 参数名 | 类型 | 必填 | 说明 | | -------- | --------------------------------------------------- | ---- | ----------------------------------- | -| options | [MediaFetchOptions](#mediafetchoptions8) | 是 | 媒体检索选项。 | -| callback | AsyncCallback<[FetchFileResult](#fetchfileresult8)> | 是 | 异步返回FetchFileResult之后的回调。 | +| options | [MediaFetchOptions](#mediafetchoptions7) | 是 | 媒体检索选项。 | +| callback | AsyncCallback<[FetchFileResult](#fetchfileresult7)> | 是 | 异步返回FetchFileResult之后的回调。 | **示例**： @@ -2041,7 +2063,7 @@ async function example() { } ``` -### getFileAssets8+ +### getFileAssets7+ getFileAssets(options?: MediaFetchOptions): Promise<FetchFileResult> @@ -2055,13 +2077,13 @@ async function example() { | 参数名 | 类型 | 必填 | 说明 | | ------- | ---------------------------------------- | ---- | -------------- | -| options | [MediaFetchOptions](#mediafetchoptions8) | 否 | 媒体检索选项。 | +| options | [MediaFetchOptions](#mediafetchoptions7) | 否 | 媒体检索选项。 | **返回值**： | 类型 | 说明 | | --------------------------------------------- | ------------------------- | -| Promise<[FetchFileResult](#fetchfileresult8)> | 返回FetchFileResult对象。 | +| Promise<[FetchFileResult](#fetchfileresult7)> | 返回FetchFileResult对象。 | **示例**： @@ -2087,16 +2109,16 @@ async function example() { **系统能力：** 以下各项对应的系统能力均为SystemCapability.Multimedia.MediaLibrary.Core -| 名称 | 类型 | 可读 | 可写 | 说明 | -| ---------- | ---------- | ---- | ---- | --------- | -| deviceName | string | 是 | 否 | 注册设备的名称 | -| networkId | string | 是 | 否 | 注册设备的网络ID | -| deviceType | DeviceType | 是 | 否 | 设备类型 | -| isOnline | boolean | 是 | 否 | 是否在线 | +| 名称 | 类型 | 可读 | 可写 | 说明 | +| ---------- | -------------------------- | ---- | ---- | ---------------- | +| deviceName | string | 是 | 否 | 注册设备的名称 | +| networkId | string | 是 | 否 | 注册设备的网络ID | +| deviceType | [DeviceType](#devicetype8) | 是 | 否 | 设备类型 | +| isOnline | boolean | 是 | 否 | 是否在线 | -## MediaType +## MediaType8+ 枚举，媒体类型。 @@ -2109,7 +2131,7 @@ async function example() { | VIDEO | 2 | 视频 | | AUDIO | 3 | 音频 | -## FileKey +## FileKey8+ 枚举，文件关键信息。 @@ -2137,7 +2159,7 @@ async function example() { | ALBUM_ID | bucket_id | 文件所归属的相册编号 | | ALBUM_NAME | bucket_display_name | 文件所归属相册名称 | -## DirectoryType +## DirectoryType8+ 枚举，目录类型。 @@ -2152,7 +2174,7 @@ async function example() { | DIR_DOCUMENTS | 4 | 表示文档路径 | | DIR_DOWNLOAD | 5 | 表示下载路径 | -## DeviceType +## DeviceType8+ 枚举，设备类型。 @@ -2168,20 +2190,20 @@ async function example() { | TYPE_CAR | 5 | 车载设备 | | TYPE_TV | 6 | 电视设备 | -## MediaFetchOptions8+ +## MediaFetchOptions7+ 检索条件。 **系统能力：** 以下各项对应的系统能力均为SystemCapability.Multimedia.MediaLibrary.Core -| 名称 | 类型 | 可读 | 可写 | 必填 | 说明 | -| ------------- | ------------------- | ---- | ---- | ---- | ---------------------------------------- | -| selections | string | 是 | 是 | 是 | 检索条件，使用[FileKey](#filekey)中的枚举值作为检索条件的列名。示例：
selections: mediaLibrary.FileKey.MEDIA_TYPE + '= ? OR' +mediaLibrary.FileKey.MEDIA_TYPE + '= ?‘, | -| selectionArgs | Array<string> | 是 | 是 | 是 | 检索条件的值，对应selections中检索条件列的值。
示例：
selectionArgs: [mediaLibrary.MediaType.IMAGE.toString(), mediaLibrary.MediaType.VIDEO.toString()], | -| order | string | 是 | 是 | 否 | 检索结果排序方式，使用[FileKey](#filekey)中的枚举值作为检索结果排序的列，可以用升序或降序排列。示例：
升序排列：order: mediaLibrary.FileKey.DATE_ADDED + " AESC"
降序排列：order: mediaLibrary.FileKey.DATE_ADDED + " DESC" | -| uri | string | 是 | 是 | 否 | 文件URI | -| networkId | string | 是 | 是 | 否 | 注册设备网络ID | -| extendArgs | string | 是 | 是 | 否 | 扩展的检索参数，目前没有扩展检索参数 | +| 名称 | 类型 | 可读 | 可写 | 必填 | 说明 | +| ----------------------- | ------------------- | ---- | ---- | ---- | ------------------------------------------------------------ | +| selections | string | 是 | 是 | 是 | 检索条件，使用[FileKey](#filekey8)中的枚举值作为检索条件的列名。示例：
selections: mediaLibrary.FileKey.MEDIA_TYPE + '= ? OR' +mediaLibrary.FileKey.MEDIA_TYPE + '= ?‘, | +| selectionArgs | Array<string> | 是 | 是 | 是 | 检索条件的值，对应selections中检索条件列的值。
示例：
selectionArgs: [mediaLibrary.MediaType.IMAGE.toString(), mediaLibrary.MediaType.VIDEO.toString()], | +| order8+ | string | 是 | 是 | 否 | 检索结果排序方式，使用[FileKey](#filekey8)中的枚举值作为检索结果排序的列，可以用升序或降序排列。示例：
升序排列：order: mediaLibrary.FileKey.DATE_ADDED + " AESC"
降序排列：order: mediaLibrary.FileKey.DATE_ADDED + " DESC" | +| uri8+ | string | 是 | 是 | 否 | 文件URI | +| networkId8+ | string | 是 | 是 | 否 | 注册设备网络ID | +| extendArgs8+ | string | 是 | 是 | 否 | 扩展的检索参数，目前没有扩展检索参数 | ## Size8+ diff --git a/zh-cn/application-dev/reference/apis/js-apis-osAccount.md b/zh-cn/application-dev/reference/apis/js-apis-osAccount.md index 38af2a5f98606bab9d7f6e5307979ac1f04074f0..8418ed934f58bb002ec63f42541fc3fb8736be7d 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-osAccount.md +++ b/zh-cn/application-dev/reference/apis/js-apis-osAccount.md @@ -1733,23 +1733,23 @@ off(type: 'activate' | 'activating', name: string, callback?: Callback<number **系统能力：** 以下各项对应的系统能力均为SystemCapability.Account.OsAccount。 -| 参数名 | 类型 | 必填 | 说明 | -| ----------------- | ------------------------------------------------------------ | ---- | --------------------------------- | -| localId | number | 是 | 系统帐号ID。 | -| localName | string | 是 | 系统帐号名称。 | -| type | [OsAccountType](#osaccounttype) | 是 | 系统帐号类型 | -| constraints | Array<string> | 否 | 系统帐号[约束](#系统帐号约束列表) | -| isVerified | boolean | 是 | 帐号是否锁屏 | -| photo | string | 否 | 系统帐号头像 | -| createTime | number | 是 | 系统帐号创建时间 | -| lastLoginTime | number | 否 | 系统帐号最后一次登录时间 | -| serialNumber | number | 是 | 系统帐号SN码 | -| isActived | boolean | 是 | 系统帐号激活状态 | -| isCreateCompleted | boolean | 是 | 系统帐号创建是否完整 | -| distributedInfo | [distributedAccount.DistributedInfo](js-apis-distributed-account.md) | 否 | 分布式帐号信息 | -| domainInfo | [DomainAccountInfo](#domainaccountinfo) | 否 | 域帐号信息 | - -## DomainAccountInfo +| 参数名 | 类型 | 必填 | 说明 | +| ------------------------------ | ------------------------------------------------------------ | ---- | --------------------------------- | +| localId | number | 是 | 系统帐号ID。 | +| localName | string | 是 | 系统帐号名称。 | +| type | [OsAccountType](#osaccounttype) | 是 | 系统帐号类型 | +| constraints | Array<string> | 否 | 系统帐号[约束](#系统帐号约束列表) | +| isVerified8+ | boolean | 是 | 帐号是否锁屏 | +| photo8+ | string | 否 | 系统帐号头像 | +| createTime8+ | number | 是 | 系统帐号创建时间 | +| lastLoginTime8+ | number | 否 | 系统帐号最后一次登录时间 | +| serialNumber8+ | number | 是 | 系统帐号SN码 | +| isActived8+ | boolean | 是 | 系统帐号激活状态 | +| isCreateCompleted8+ | boolean | 是 | 系统帐号创建是否完整 | +| distributedInfo | [distributedAccount.DistributedInfo](js-apis-distributed-account.md) | 否 | 分布式帐号信息 | +| domainInfo8+ | [DomainAccountInfo](#domainaccountinfo) | 否 | 域帐号信息 | + +## DomainAccountInfo8+ 域帐号信息。 diff --git a/zh-cn/application-dev/reference/apis/js-apis-xml.md b/zh-cn/application-dev/reference/apis/js-apis-xml.md index ea5263a1747acf9c805a1ccbc27c6a9fec5061e9..6b4ce9fdc1cf3304aa4d9015a7c374bbff7d9324 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-xml.md +++ b/zh-cn/application-dev/reference/apis/js-apis-xml.md @@ -329,6 +329,8 @@ that.parse(options); xml解析选项。 +### 属性 + | 名称 | 参数类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | supportDoctype | boolean | 否 | 是否忽略Doctype , 默认false。 | @@ -337,7 +339,6 @@ xml解析选项。 | attributeValueCallbackFunction | (name: string, value: string)=> boolean | 否 | 获取attributeValue回调函数。 | | tokenValueCallbackFunction | (eventType: [EventType](#eventtype), value: [ParseInfo](#parseinfo))=> boolean | 否 | 获取tokenValue回调函数。 | - ## ParseInfo 当前xml解析信息。