提交 cc012fe6 编写于 作者: Z zengyawen

update docs

Signed-off-by: Nzengyawen <zengyawen1@huawei.com>
上级 bbc6c2c0
...@@ -283,7 +283,7 @@ For details about the audio playback demo, see [Audio Playback Development](../. ...@@ -283,7 +283,7 @@ For details about the audio playback demo, see [Audio Playback Development](../.
| Name | Type | Readable| Writable| Description | | 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.<br>**Example of supported URIs**:<br>1. FD playback: fd://xx<br>![](figures/en_image_url.png)<br>2. HTTP network playback: http://xx<br>3. HLS network playback path (under development)<br>**Note**:<br>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.<br>**Example of supported URIs**:<br>1. FD playback: fd://xx<br>![](figures/en-us_image_url.png)<br>2. HTTP network playback: http://xx<br>3. HLS network playback path (under development)<br>**Note**:<br>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. | | 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. | | currentTime | number | Yes | No | Current audio playback position. |
| duration | number | Yes | No | Audio duration. | | duration | number | Yes | No | Audio duration. |
...@@ -677,7 +677,7 @@ For details about the video playback demo, see [Video Playback Development](../. ...@@ -677,7 +677,7 @@ For details about the video playback demo, see [Video Playback Development](../.
| Name | Type | Readable| Writable| Description | | Name | Type | Readable| Writable| Description |
| ------------------------ | ---------------------------------- | ---- | ---- | ------------------------------------------------------------ | | ------------------------ | ---------------------------------- | ---- | ---- | ------------------------------------------------------------ |
| url<sup>8+</sup> | string | Yes | Yes | Video media URL. The mainstream video formats (MPEG-4, MPEG-TS, WebM, and MKV) are supported.<br>**Example of supported URIs**:<br>1. FD playback: fd://xx<br>![](figures/en_image_url.png)<br>2. HTTP network playback: http://xx<br>3. HLS network playback path (under development)<br>**Note**:<br>To use media materials, you must declare the read permission. Otherwise, the media materials cannot be played properly.| | url<sup>8+</sup> | string | Yes | Yes | Video media URL. The mainstream video formats (MPEG-4, MPEG-TS, WebM, and MKV) are supported.<br>**Example of supported URIs**:<br>1. FD playback: fd://xx<br>![](figures/en-us_image_url.png)<br>2. HTTP network playback: http://xx<br>3. HLS network playback path (under development)<br>**Note**:<br>To use media materials, you must declare the read permission. Otherwise, the media materials cannot be played properly. |
| loop<sup>8+</sup> | boolean | Yes | Yes | Whether to loop video playback. The value **true** means to loop video playback, and **false** means the opposite. | | loop<sup>8+</sup> | boolean | Yes | Yes | Whether to loop video playback. The value **true** means to loop video playback, and **false** means the opposite. |
| currentTime<sup>8+</sup> | number | Yes | No | Current video playback position. | | currentTime<sup>8+</sup> | number | Yes | No | Current video playback position. |
| duration<sup>8+</sup> | number | Yes | No | Video duration. The value **-1** indicates the live streaming mode. | | duration<sup>8+</sup> | number | Yes | No | Video duration. The value **-1** indicates the live streaming mode. |
......
...@@ -2,7 +2,7 @@ ...@@ -2,7 +2,7 @@
> **说明:** > **说明:**
> >
> 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。 > 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
## 导入模块 ## 导入模块
......
...@@ -39,7 +39,7 @@ image.createPixelMap(Color, opts) ...@@ -39,7 +39,7 @@ image.createPixelMap(Color, opts)
## image.createPixelMap<sup>8+</sup> ## image.createPixelMap<sup>8+</sup>
createPixelMap(colors: ArrayBuffer, opts: InitializetionOptions) callback: AsyncCallback\<PixelMap>): void createPixelMap(colors: ArrayBuffer, options: InitializetionOptions, callback: AsyncCallback\<PixelMap>): void
通过属性创建PixelMap,通过回调函数返回结果。 通过属性创建PixelMap,通过回调函数返回结果。
...@@ -799,7 +799,7 @@ const imagePackerApi = image.createImagePacker(); ...@@ -799,7 +799,7 @@ const imagePackerApi = image.createImagePacker();
### packing ### packing
packing(source: ImageSource, option: PackingOption, callback: AsyncCallback<Array\<number>>): void packing(source: ImageSource, option: PackingOption, callback: AsyncCallback<Array\<ArrayBuffer>>): void
图片压缩或重新打包,使用callback形式返回结果。 图片压缩或重新打包,使用callback形式返回结果。
...@@ -808,10 +808,10 @@ packing(source: ImageSource, option: PackingOption, callback: AsyncCallback<Arra ...@@ -808,10 +808,10 @@ packing(source: ImageSource, option: PackingOption, callback: AsyncCallback<Arra
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------- | ---- | ---------------------------------- | | -------- | ---------------------------------- | ---- | ---------------------------------- |
| source | [ImageSource](#imagesource) | 是 | 打包的图片源。 | | source | [ImageSource](#imagesource) | 是 | 打包的图片源。 |
| option | [PackingOption](#packingoption) | 是 | 设置打包参数。 | | option | [PackingOption](#packingoption) | 是 | 设置打包参数。 |
| callback | AsyncCallback<Array\<number>> | 是 | 获取图片打包回调,返回打包后数据。 | | callback | AsyncCallback<Array\<ArrayBuffer>> | 是 | 获取图片打包回调,返回打包后数据。 |
**示例:** **示例:**
...@@ -822,7 +822,7 @@ imagePackerApi.packing(imageSourceApi, packOpts, data => {}) ...@@ -822,7 +822,7 @@ imagePackerApi.packing(imageSourceApi, packOpts, data => {})
### packing ### packing
packing(source: ImageSource, option: PackingOption): Promise<Array\<number>> packing(source: ImageSource, option: PackingOption): Promise<Array\<ArrayBuffer>>
图片压缩或重新打包,使用Promise形式返回结果。 图片压缩或重新打包,使用Promise形式返回结果。
...@@ -838,8 +838,8 @@ packing(source: ImageSource, option: PackingOption): Promise<Array\<number>> ...@@ -838,8 +838,8 @@ packing(source: ImageSource, option: PackingOption): Promise<Array\<number>>
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| :---------------------- | :-------------------------------------------- | | :--------------------------- | :-------------------------------------------- |
| Promise<Array\<number>> | Promise实例,用于异步获取压缩或打包后的数据。 | | Promise<Array\<ArrayBuffer>> | Promise实例,用于异步获取压缩或打包后的数据。 |
**示例:** **示例:**
...@@ -852,7 +852,7 @@ imagePackerApi.packing(imageSourceApi, packOpts) ...@@ -852,7 +852,7 @@ imagePackerApi.packing(imageSourceApi, packOpts)
### packing ### packing
packing(source: PixelMap, option: PackingOption, callback: AsyncCallback<ArrayBuffer>): void; packing(source: PixelMap, option: PackingOption, callback: AsyncCallback\<ArrayBuffer>): void
图片压缩或重新打包,使用callback形式返回结果。 图片压缩或重新打包,使用callback形式返回结果。
...@@ -864,7 +864,7 @@ packing(source: PixelMap, option: PackingOption, callback: AsyncCallback<ArrayBu ...@@ -864,7 +864,7 @@ packing(source: PixelMap, option: PackingOption, callback: AsyncCallback<ArrayBu
| -------- | ------------------------------- | ---- | ---------------------------------- | | -------- | ------------------------------- | ---- | ---------------------------------- |
| source | [PixelMap](#pixelmap) | 是 | 打包的PixelMap资源。 | | source | [PixelMap](#pixelmap) | 是 | 打包的PixelMap资源。 |
| option | [PackingOption](#packingoption) | 是 | 设置打包参数。 | | option | [PackingOption](#packingoption) | 是 | 设置打包参数。 |
| callback | AsyncCallback<ArrayBuffer> | 是 | 获取图片打包回调,返回打包后数据。 | | callback | AsyncCallback\<ArrayBuffer> | 是 | 获取图片打包回调,返回打包后数据。 |
**示例:** **示例:**
...@@ -875,7 +875,7 @@ imagePackerApi.packing(pixelMapApi, packOpts, data => {}) ...@@ -875,7 +875,7 @@ imagePackerApi.packing(pixelMapApi, packOpts, data => {})
### packing ### packing
packing(source: PixelMap, option: PackingOption): Promise<Array\<number>> packing(source: PixelMap, option: PackingOption): Promise<Array\<ArrayBuffer>>
图片压缩或重新打包,使用Promise形式返回结果。 图片压缩或重新打包,使用Promise形式返回结果。
...@@ -891,8 +891,8 @@ packing(source: PixelMap, option: PackingOption): Promise<Array\<number>> ...@@ -891,8 +891,8 @@ packing(source: PixelMap, option: PackingOption): Promise<Array\<number>>
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| :---------------------- | :-------------------------------------------- | | :--------------------------- | :-------------------------------------------- |
| Promise<Array\<number>> | Promise实例,用于异步获取压缩或打包后的数据。 | | Promise<Array\<ArrayBuffer>> | Promise实例,用于异步获取压缩或打包后的数据。 |
**示例:** **示例:**
......
...@@ -8,7 +8,7 @@ ...@@ -8,7 +8,7 @@
import mediaLibrary from '@ohos.multimedia.medialibrary'; import mediaLibrary from '@ohos.multimedia.medialibrary';
``` ```
## mediaLibrary.getMediaLibrary ## mediaLibrary.getMediaLibrary<sup>8+</sup>
getMediaLibrary(context: Context): MediaLibrary getMediaLibrary(context: Context): MediaLibrary
...@@ -19,8 +19,8 @@ getMediaLibrary(context: Context): MediaLibrary ...@@ -19,8 +19,8 @@ getMediaLibrary(context: Context): MediaLibrary
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------- | ------- | ------------------------------------- | -------------------------- | | ------- | ------- | ---- | -------------------------- |
| context | Context | <sup>6-7</sup> <br/><sup>8+</sup> | 传入Ability实例的Context。 | | context | Context | | 传入Ability实例的Context。 |
**返回值:** **返回值:**
...@@ -36,9 +36,34 @@ import featureAbility from '@ohos.ability.featureAbility'; ...@@ -36,9 +36,34 @@ import featureAbility from '@ohos.ability.featureAbility';
var context = featureAbility.getContext() var context = featureAbility.getContext()
var media = mediaLibrary.getMediaLibrary(context); var media = mediaLibrary.getMediaLibrary(context);
``` ```
## mediaLibrary.getMediaLibrary
getMediaLibrary(): MediaLibrary
获取媒体库的实例,用于访问和修改用户等个人媒体数据信息(如音频、视频、图片、文档等)。
> **说明**: 从API Version 8开始,该接口不再维护,推荐使用新接口[mediaLibrary.getMediaLibrary<sup>8+</sup>](medialibrarygetmedialibrary8)。
**系统能力**:SystemCapability.Multimedia.MediaLibrary.Core
**返回值:**
| 类型 | 说明 |
| ----------------------------- | :--------- |
| [MediaLibrary](#medialibrary) | 媒体库实例 |
**示例:**
```js
import featureAbility from '@ohos.ability.featureAbility';
var context = featureAbility.getContext()
var media = mediaLibrary.getMediaLibrary();
```
## MediaLibrary ## MediaLibrary
### getFileAssets<sup>8+</sup> ### getFileAssets<sup>7+</sup>
getFileAssets(options: MediaFetchOptions, callback: AsyncCallback&lt;FetchFileResult&gt;): void getFileAssets(options: MediaFetchOptions, callback: AsyncCallback&lt;FetchFileResult&gt;): void
...@@ -52,9 +77,9 @@ getFileAssets(options: MediaFetchOptions, callback: AsyncCallback&lt;FetchFileRe ...@@ -52,9 +77,9 @@ getFileAssets(options: MediaFetchOptions, callback: AsyncCallback&lt;FetchFileRe
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | ------------------------ | | -------- | --------------------------------------------------- | ---- | --------------------------------- |
| options | [MediaFetchOptions](#mediafetchoptions8) | 是 | 文件获取选项 | | options | [MediaFetchOptions](#mediafetchoptions7) | 是 | 文件获取选项 |
| callback | AsyncCallback<[FetchFileResult](#fetchfileresult8)> | 是 | 异步获取FetchFileResult之后的回调 | | callback | AsyncCallback<[FetchFileResult](#fetchfileresult7)> | 是 | 异步获取FetchFileResult之后的回调 |
**示例:** **示例:**
...@@ -76,7 +101,7 @@ mediaLibrary.getFileAssets(imagesfetchOp, (error, fetchFileResult) => { ...@@ -76,7 +101,7 @@ mediaLibrary.getFileAssets(imagesfetchOp, (error, fetchFileResult) => {
} }
}); });
``` ```
### getFileAssets<sup>8+</sup> ### getFileAssets<sup>7+</sup>
getFileAssets(options: MediaFetchOptions): Promise&lt;FetchFileResult&gt; getFileAssets(options: MediaFetchOptions): Promise&lt;FetchFileResult&gt;
...@@ -89,14 +114,14 @@ getFileAssets(options: MediaFetchOptions): Promise&lt;FetchFileResult&gt; ...@@ -89,14 +114,14 @@ getFileAssets(options: MediaFetchOptions): Promise&lt;FetchFileResult&gt;
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------- | ---------------------------------------- | ---- | ------ | | ------- | ---------------------------------------- | ---- | ------------ |
| options | [MediaFetchOptions](#mediafetchoptions8) | 是 | 文件检索选项 | | options | [MediaFetchOptions](#mediafetchoptions7) | 是 | 文件检索选项 |
**返回值** **返回值**
| 类型 | 说明 | | 类型 | 说明 |
| ------------------------------------ | ------- | | ------------------------------------ | -------------- |
| [FetchFileResult](#fetchfileresult8) | 文件数据结果集 | | [FetchFileResult](#fetchfileresult7) | 文件数据结果集 |
**示例:** **示例:**
...@@ -172,11 +197,11 @@ createAsset(mediaType: MediaType, displayName: string, relativePath: string, cal ...@@ -172,11 +197,11 @@ createAsset(mediaType: MediaType, displayName: string, relativePath: string, cal
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------------ | --------------------------------------- | ---- | ---------------------------------------- | | ------------ | --------------------------------------- | ---- | ------------------------------------------------------------ |
| mediaType | [MediaType](#mediatype) | 是 | 媒体类型 | | mediaType | [MediaType](#mediatype8) | 是 | 媒体类型 |
| displayName | string | 是 | 展示文件名 | | displayName | string | 是 | 展示文件名 |
| relativePath | string | 是 | 文件保存路径,可以通过[getPublicDirectory](#getpublicdirectory8)获取不同类型文件的保存路径 | | relativePath | string | 是 | 文件保存路径,可以通过[getPublicDirectory](#getpublicdirectory8)获取不同类型文件的保存路径 |
| callback | AsyncCallback<[FileAsset](#fileasset8)> | 是 | 异步获取媒体数据FileAsset之后的回调 | | callback | AsyncCallback<[FileAsset](#fileasset7)> | 是 | 异步获取媒体数据FileAsset之后的回调 |
**示例:** **示例:**
...@@ -209,16 +234,16 @@ createAsset(mediaType: MediaType, displayName: string, relativePath: string): Pr ...@@ -209,16 +234,16 @@ createAsset(mediaType: MediaType, displayName: string, relativePath: string): Pr
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------------ | ----------------------- | ---- | ---------------------------------------- | | ------------ | ------------------------ | ---- | ------------------------------------------------------------ |
| mediaType | [MediaType](#mediatype) | 是 | 媒体类型 | | mediaType | [MediaType](#mediatype8) | 是 | 媒体类型 |
| displayName | string | 是 | 展示文件名 | | displayName | string | 是 | 展示文件名 |
| relativePath | string | 是 | 相对路径,可以通过getPublicDirectory获取不同类型媒体文件的一层目录的relative path | | relativePath | string | 是 | 相对路径,可以通过getPublicDirectory获取不同类型媒体文件的一层目录的relative path |
**返回值** **返回值**
| 类型 | 说明 | | 类型 | 说明 |
| ------------------------ | ------------- | | ------------------------ | ----------------- |
| [FileAsset](#fileasset8) | 媒体数据FileAsset | | [FileAsset](#fileasset7) | 媒体数据FileAsset |
**示例:** **示例:**
...@@ -247,8 +272,8 @@ getPublicDirectory(type: DirectoryType, callback: AsyncCallback&lt;string&gt;): ...@@ -247,8 +272,8 @@ getPublicDirectory(type: DirectoryType, callback: AsyncCallback&lt;string&gt;):
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------- | ---- | ----------------- | | -------- | -------------------------------- | ---- | ------------------------- |
| type | [DirectoryType](#directorytype) | 是 | 公共目录类型 | | type | [DirectoryType](#directorytype8) | 是 | 公共目录类型 |
| callback | AsyncCallback&lt;string&gt; | 是 | callback 返回公共目录路径 | | callback | AsyncCallback&lt;string&gt; | 是 | callback 返回公共目录路径 |
**示例:** **示例:**
...@@ -275,14 +300,14 @@ getPublicDirectory(type: DirectoryType): Promise&lt;string&gt; ...@@ -275,14 +300,14 @@ getPublicDirectory(type: DirectoryType): Promise&lt;string&gt;
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ---- | ------------------------------- | ---- | ------ | | ------ | -------------------------------- | ---- | ------------ |
| type | [DirectoryType](#directorytype) | 是 | 公共目录类型 | | type | [DirectoryType](#directorytype8) | 是 | 公共目录类型 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| --------------- | -------- | | ---------------- | ---------------- |
| Promise<string> | 返回公共目录路径 | | Promise\<string> | 返回公共目录路径 |
**示例:** **示例:**
...@@ -298,7 +323,7 @@ async function example() { ...@@ -298,7 +323,7 @@ async function example() {
} }
``` ```
### getAlbums<sup>8+</sup> ### getAlbums<sup>7+</sup>
getAlbums(options: MediaFetchOptions, callback: AsyncCallback<Array&lt;Album&gt;>): void getAlbums(options: MediaFetchOptions, callback: AsyncCallback<Array&lt;Album&gt;>): void
...@@ -311,9 +336,9 @@ getAlbums(options: MediaFetchOptions, callback: AsyncCallback<Array&lt;Album&gt; ...@@ -311,9 +336,9 @@ getAlbums(options: MediaFetchOptions, callback: AsyncCallback<Array&lt;Album&gt;
**参数** **参数**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | ---------------- | | -------- | -------------------------------------------- | ---- | --------------------------- |
| options | [MediaFetchOptions](#mediafetchoptions8) | 是 | 相册获取条件 | | options | [MediaFetchOptions](#mediafetchoptions7) | 是 | 相册获取条件 |
| callback | AsyncCallback&lt;Array<[Album](#album8)>&gt; | 是 | 异步获取Album列表之后的回调 | | callback | AsyncCallback&lt;Array<[Album](#album7)>&gt; | 是 | 异步获取Album列表之后的回调 |
**示例:** **示例:**
...@@ -333,7 +358,7 @@ mediaLibrary.getAlbums(AlbumNoArgsfetchOp, (err, albumList) => { ...@@ -333,7 +358,7 @@ mediaLibrary.getAlbums(AlbumNoArgsfetchOp, (err, albumList) => {
}) })
``` ```
### getAlbums<sup>8+</sup> ### getAlbums<sup>7+</sup>
getAlbums(options: MediaFetchOptions): Promise<Array&lt;Album&gt;> getAlbums(options: MediaFetchOptions): Promise<Array&lt;Album&gt;>
...@@ -346,14 +371,14 @@ getAlbums(options: MediaFetchOptions): Promise<Array&lt;Album&gt;> ...@@ -346,14 +371,14 @@ getAlbums(options: MediaFetchOptions): Promise<Array&lt;Album&gt;>
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------- | ---------------------------------------- | ---- | ------ | | ------- | ---------------------------------------- | ---- | ------------ |
| options | [MediaFetchOptions](#mediafetchoptions8) | 是 | 相册获取条件 | | options | [MediaFetchOptions](#mediafetchoptions7) | 是 | 相册获取条件 |
**返回值:** **返回值:**
| 类型 | 说明 | | 类型 | 说明 |
| -------------------------------- | --------- | | -------------------------------- | ------------- |
| Promise<Array<[Album](#album8)>> | 返回Album列表 | | Promise<Array<[Album](#album7)>> | 返回Album列表 |
**示例:** **示例:**
...@@ -690,7 +715,7 @@ mediaLibrary.getMediaLibrary().startMediaSelect(option).then((value) => { ...@@ -690,7 +715,7 @@ mediaLibrary.getMediaLibrary().startMediaSelect(option).then((value) => {
``` ```
## FileAsset<sup>8+</sup> ## FileAsset<sup>7+</sup>
提供封装文件属性的方法。 提供封装文件属性的方法。
...@@ -699,27 +724,27 @@ mediaLibrary.getMediaLibrary().startMediaSelect(option).then((value) => { ...@@ -699,27 +724,27 @@ mediaLibrary.getMediaLibrary().startMediaSelect(option).then((value) => {
**系统能力:** 以下各项对应的系统能力均为SystemCapability.Multimedia.MediaLibrary.Core **系统能力:** 以下各项对应的系统能力均为SystemCapability.Multimedia.MediaLibrary.Core
| 名称 | 类型 | 可读 | 可写 | 说明 | | 名称 | 类型 | 可读 | 可写 | 说明 |
| ------------ | ----------------------- | ---- | ---- | --------------------------------------- | | ------------------------- | ------------------------ | ---- | ---- | ------------------------------------------------------ |
| id | number | 是 | 否 | 文件资源编号 | | id | number | 是 | 否 | 文件资源编号 |
| uri | string | 是 | 否 | 文件资源uri(如:dataability:///media/image/2) | | uri | string | 是 | 否 | 文件资源uri(如:dataability:///media/image/2) |
| mimeType | string | 是 | 否 | 文件扩展属性 | | mimeType | string | 是 | 否 | 文件扩展属性 |
| mediaType | [MediaType](#mediatype) | 是 | 否 | 媒体类型 | | mediaType<sup>8+</sup> | [MediaType](#mediatype8) | 是 | 否 | 媒体类型 |
| displayName | string | 是 | 是 | 显示文件名,包含后缀名 | | displayName | string | 是 | 是 | 显示文件名,包含后缀名 |
| title | string | 是 | 是 | 文件标题 | | title | string | 是 | 是 | 文件标题 |
| relativePath | string | 是 | 是 | 相对公共目录路径 | | relativePath<sup>8+</sup> | string | 是 | 是 | 相对公共目录路径 |
| parent | number | 是 | 否 | 父目录id | | parent<sup>8+</sup> | number | 是 | 否 | 父目录id |
| size | number | 是 | 否 | 文件大小(单位:字节) | | size | number | 是 | 否 | 文件大小(单位:字节) |
| dateAdded | number | 是 | 否 | 添加日期(添加文件时间到1970年1月1日的秒数值) | | dateAdded | number | 是 | 否 | 添加日期(添加文件时间到1970年1月1日的秒数值) |
| dateModified | number | 是 | 否 | 修改日期(修改文件时间到1970年1月1日的秒数值) | | dateModified | number | 是 | 否 | 修改日期(修改文件时间到1970年1月1日的秒数值) |
| dateTaken | number | 是 | 否 | 拍摄日期(文件拍照时间到1970年1月1日的秒数值) | | dateTaken | number | 是 | 否 | 拍摄日期(文件拍照时间到1970年1月1日的秒数值) |
| artist | string | 是 | 否 | 作者 | | artist<sup>8+</sup> | string | 是 | 否 | 作者 |
| audioAlbum | string | 是 | 否 | 专辑 | | audioAlbum<sup>8+</sup> | string | 是 | 否 | 专辑 |
| width | number | 是 | 否 | 图片宽度(单位:像素) | | width | number | 是 | 否 | 图片宽度(单位:像素) |
| height | number | 是 | 否 | 图片高度(单位:像素) | | height | number | 是 | 否 | 图片高度(单位:像素) |
| orientation | number | 是 | 是 | 图片显示方向(顺时针旋转角度,如0,90,180 单位:度) | | orientation | number | 是 | 是 | 图片显示方向(顺时针旋转角度,如0,90,180 单位:度) |
| duration | number | 是 | 否 | 持续时间(单位:秒) | | duration<sup>8+</sup> | number | 是 | 否 | 持续时间(单位:秒) |
| albumId | number | 是 | 否 | 文件所归属的相册编号 | | albumId | number | 是 | 否 | 文件所归属的相册编号 |
| albumUri | string | 是 | 否 | 文件所归属相册uri | | albumUri<sup>8+</sup> | string | 是 | 否 | 文件所归属相册uri |
| albumName | string | 是 | 否 | 文件所归属相册名称 | | albumName | string | 是 | 否 | 文件所归属相册名称 |
...@@ -1460,11 +1485,11 @@ async function example() { ...@@ -1460,11 +1485,11 @@ async function example() {
} }
``` ```
## FetchFileResult<sup>8+</sup> ## FetchFileResult<sup>7+</sup>
文件检索结果集。 文件检索结果集。
### getCount<sup>8+</sup> ### getCount<sup>7+</sup>
getCount(): number getCount(): number
...@@ -1493,7 +1518,7 @@ async function example() { ...@@ -1493,7 +1518,7 @@ async function example() {
} }
``` ```
### isAfterLast<sup>8+</sup> ### isAfterLast<sup>7+</sup>
isAfterLast(): boolean isAfterLast(): boolean
...@@ -1536,7 +1561,7 @@ async function example() { ...@@ -1536,7 +1561,7 @@ async function example() {
} }
``` ```
### close<sup>8+</sup> ### close<sup>7+</sup>
close(): void close(): void
...@@ -1560,7 +1585,7 @@ async function example() { ...@@ -1560,7 +1585,7 @@ async function example() {
} }
``` ```
### getFirstObject<sup>8+</sup> ### getFirstObject<sup>7+</sup>
getFirstObject(callback: AsyncCallback&lt;FileAsset&gt;): void getFirstObject(callback: AsyncCallback&lt;FileAsset&gt;): void
...@@ -1571,8 +1596,8 @@ getFirstObject(callback: AsyncCallback&lt;FileAsset&gt;): void ...@@ -1571,8 +1596,8 @@ getFirstObject(callback: AsyncCallback&lt;FileAsset&gt;): void
**参数** **参数**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | -------------------------- | | -------- | --------------------------------------------- | ---- | ------------------------------------------- |
| callback | AsyncCallback&lt;[FileAsset](#fileasset8)&gt; | 是 | 异步获取结果集中第一个FileAsset完成后的回调 | | callback | AsyncCallback&lt;[FileAsset](#fileasset7)&gt; | 是 | 异步获取结果集中第一个FileAsset完成后的回调 |
**示例** **示例**
...@@ -1596,7 +1621,7 @@ async function example() { ...@@ -1596,7 +1621,7 @@ async function example() {
} }
``` ```
### getFirstObject<sup>8+</sup> ### getFirstObject<sup>7+</sup>
getFirstObject(): Promise&lt;FileAsset&gt; getFirstObject(): Promise&lt;FileAsset&gt;
...@@ -1608,7 +1633,7 @@ getFirstObject(): Promise&lt;FileAsset&gt; ...@@ -1608,7 +1633,7 @@ getFirstObject(): Promise&lt;FileAsset&gt;
| 类型 | 说明 | | 类型 | 说明 |
| --------------------------------------- | -------------------------- | | --------------------------------------- | -------------------------- |
| Promise&lt;[FileAsset](#fileasset8)&gt; | Promise方式返回FileAsset。 | | Promise&lt;[FileAsset](#fileasset7)&gt; | Promise方式返回FileAsset。 |
**示例** **示例**
...@@ -1630,7 +1655,7 @@ async function example() { ...@@ -1630,7 +1655,7 @@ async function example() {
} }
``` ```
### getNextObject<sup>8+</sup> ### getNextObject<sup>7+</sup>
getNextObject(callback: AsyncCallback&lt;FileAsset&gt;): void getNextObject(callback: AsyncCallback&lt;FileAsset&gt;): void
...@@ -1643,8 +1668,8 @@ async function example() { ...@@ -1643,8 +1668,8 @@ async function example() {
**参数** **参数**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| --------- | ---------------------------------------- | ---- | ------------------------- | | --------- | --------------------------------------------- | ---- | ----------------------------------------- |
| callbacke | AsyncCallback&lt;[FileAsset](#fileasset8)&gt; | 是 | 异步返回结果集中下一个FileAsset之后的回调 | | callbacke | AsyncCallback&lt;[FileAsset](#fileasset7)&gt; | 是 | 异步返回结果集中下一个FileAsset之后的回调 |
**示例** **示例**
...@@ -1668,7 +1693,7 @@ async function example() { ...@@ -1668,7 +1693,7 @@ async function example() {
} }
``` ```
### getNextObject<sup>8+</sup> ### getNextObject<sup>7+</sup>
getNextObject(): Promise&lt;FileAsset&gt; getNextObject(): Promise&lt;FileAsset&gt;
...@@ -1681,8 +1706,8 @@ async function example() { ...@@ -1681,8 +1706,8 @@ async function example() {
**返回值** **返回值**
| 类型 | 说明 | | 类型 | 说明 |
| --------------------------------------- | ------------- | | --------------------------------------- | ----------------- |
| Promise&lt;[FileAsset](#fileasset8)&gt; | 返回FileAsset对象 | | Promise&lt;[FileAsset](#fileasset7)&gt; | 返回FileAsset对象 |
**示例** **示例**
...@@ -1702,7 +1727,7 @@ async function example() { ...@@ -1702,7 +1727,7 @@ async function example() {
} }
``` ```
### getLastObject<sup>8+</sup> ### getLastObject<sup>7+</sup>
getLastObject(callback: AsyncCallback&lt;FileAsset&gt;): void getLastObject(callback: AsyncCallback&lt;FileAsset&gt;): void
...@@ -1714,7 +1739,7 @@ getLastObject(callback: AsyncCallback&lt;FileAsset&gt;): void ...@@ -1714,7 +1739,7 @@ getLastObject(callback: AsyncCallback&lt;FileAsset&gt;): void
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------------- | ---- | --------------------------- | | -------- | --------------------------------------------- | ---- | --------------------------- |
| callback | AsyncCallback&lt;[FileAsset](#fileasset8)&gt; | 是 | 异步返回FileAsset之后的回调 | | callback | AsyncCallback&lt;[FileAsset](#fileasset7)&gt; | 是 | 异步返回FileAsset之后的回调 |
**示例** **示例**
...@@ -1738,7 +1763,7 @@ async function example() { ...@@ -1738,7 +1763,7 @@ async function example() {
} }
``` ```
### getLastObject<sup>8+</sup> ### getLastObject<sup>7+</sup>
getLastObject(): Promise&lt;FileAsset&gt; getLastObject(): Promise&lt;FileAsset&gt;
...@@ -1749,8 +1774,8 @@ getLastObject(): Promise&lt;FileAsset&gt; ...@@ -1749,8 +1774,8 @@ getLastObject(): Promise&lt;FileAsset&gt;
**返回值** **返回值**
| 类型 | 说明 | | 类型 | 说明 |
| --------------------------------------- | ------------- | | --------------------------------------- | ----------------- |
| Promise&lt;[FileAsset](#fileasset8)&gt; | 返回FileAsset对象 | | Promise&lt;[FileAsset](#fileasset7)&gt; | 返回FileAsset对象 |
**示例** **示例**
...@@ -1768,7 +1793,7 @@ async function example() { ...@@ -1768,7 +1793,7 @@ async function example() {
} }
``` ```
### getPositionObject<sup>8+</sup> ### getPositionObject<sup>7+</sup>
getPositionObject(index: number, callback: AsyncCallback&lt;FileAsset&gt;): void getPositionObject(index: number, callback: AsyncCallback&lt;FileAsset&gt;): void
...@@ -1781,7 +1806,7 @@ getPositionObject(index: number, callback: AsyncCallback&lt;FileAsset&gt;): void ...@@ -1781,7 +1806,7 @@ getPositionObject(index: number, callback: AsyncCallback&lt;FileAsset&gt;): void
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | ------------------ | | -------- | ---------------------------------------- | ---- | ------------------ |
| index | number | 是 | 要获取的文件的索引,从0开始 | | index | number | 是 | 要获取的文件的索引,从0开始 |
| callback | AsyncCallback&lt;[FileAsset](#fileasset8)&gt; | 是 | 异步返回FileAsset之后的回调 | | callback | AsyncCallback&lt;[FileAsset](#fileasset7)&gt; | 是 | 异步返回FileAsset之后的回调 |
**示例** **示例**
...@@ -1805,7 +1830,7 @@ async function example() { ...@@ -1805,7 +1830,7 @@ async function example() {
} }
``` ```
### getPositionObject<sup>8+</sup> ### getPositionObject<sup>7+</sup>
getPositionObject(index: number): Promise&lt;FileAsset&gt; getPositionObject(index: number): Promise&lt;FileAsset&gt;
...@@ -1824,8 +1849,8 @@ getPositionObject(index: number): Promise&lt;FileAsset&gt; ...@@ -1824,8 +1849,8 @@ getPositionObject(index: number): Promise&lt;FileAsset&gt;
**返回值** **返回值**
| 类型 | 说明 | | 类型 | 说明 |
| --------------------------------------- | ------------- | | --------------------------------------- | ----------------- |
| Promise&lt;[FileAsset](#fileasset8)&gt; | 返回FileAsset对象 | | Promise&lt;[FileAsset](#fileasset7)&gt; | 返回FileAsset对象 |
**示例** **示例**
...@@ -1849,7 +1874,7 @@ async function example() { ...@@ -1849,7 +1874,7 @@ async function example() {
} }
``` ```
### getAllObject<sup>8+</sup> ### getAllObject<sup>7+</sup>
getAllObject(callback: AsyncCallback&lt;Array&lt;FileAsset&gt;&gt;): void getAllObject(callback: AsyncCallback&lt;Array&lt;FileAsset&gt;&gt;): void
...@@ -1863,7 +1888,7 @@ getAllObject(callback: AsyncCallback&lt;Array&lt;FileAsset&gt;&gt;): void ...@@ -1863,7 +1888,7 @@ getAllObject(callback: AsyncCallback&lt;Array&lt;FileAsset&gt;&gt;): void
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | -------------------- | | -------- | ---------------------------------------- | ---- | -------------------- |
| callback | AsyncCallback<Array<[FileAsset](#fileasset8)>> | 是 | 异步返回FileAsset列表之后的回调 | | callback | AsyncCallback<Array<[FileAsset](#fileasset7)>> | 是 | 异步返回FileAsset列表之后的回调 |
**示例** **示例**
...@@ -1887,7 +1912,7 @@ async function example() { ...@@ -1887,7 +1912,7 @@ async function example() {
} }
``` ```
### getAllObject<sup>8+</sup> ### getAllObject<sup>7+</sup>
getAllObject(): Promise&lt;Array&lt;FileAsset&gt;&gt; getAllObject(): Promise&lt;Array&lt;FileAsset&gt;&gt;
...@@ -1898,8 +1923,8 @@ getAllObject(): Promise&lt;Array&lt;FileAsset&gt;&gt; ...@@ -1898,8 +1923,8 @@ getAllObject(): Promise&lt;Array&lt;FileAsset&gt;&gt;
**返回值** **返回值**
| 类型 | 说明 | | 类型 | 说明 |
| ---------------------------------------- | --------------- | | ---------------------------------------- | --------------------- |
| Promise<Array<[FileAsset](#fileasset8)>> | 返回FileAsset对象列表 | | Promise<Array<[FileAsset](#fileasset7)>> | 返回FileAsset对象列表 |
**示例** **示例**
...@@ -1917,7 +1942,7 @@ async function example() { ...@@ -1917,7 +1942,7 @@ async function example() {
} }
``` ```
## Album<sup>8+</sup> ## Album<sup>7+</sup>
实体相册 实体相册
...@@ -1929,11 +1954,11 @@ async function example() { ...@@ -1929,11 +1954,11 @@ async function example() {
| ------------ | ------ | ---- | ---- | ------- | | ------------ | ------ | ---- | ---- | ------- |
| albumId | number | 是 | 否 | 相册编号 | | albumId | number | 是 | 否 | 相册编号 |
| albumName | string | 是 | 是 | 相册名称 | | albumName | string | 是 | 是 | 相册名称 |
| albumUri | string | 是 | 否 | 相册Uri | | albumUri<sup>8+</sup> | string | 是 | 否 | 相册Uri |
| dateModified | number | 是 | 否 | 修改日期 | | dateModified | number | 是 | 否 | 修改日期 |
| count | number | 是 | 否 | 相册中文件数量 | | count<sup>8+</sup> | number | 是 | 否 | 相册中文件数量 |
| relativePath | string | 是 | 否 | 相对路径 | | relativePath<sup>8+</sup> | string | 是 | 否 | 相对路径 |
| coverUri | string | 是 | 否 | 封面文件Uri | | coverUri<sup>8+</sup> | string | 是 | 否 | 封面文件Uri |
### commitModify<sup>8+</sup> ### commitModify<sup>8+</sup>
...@@ -2007,7 +2032,7 @@ async function example() { ...@@ -2007,7 +2032,7 @@ async function example() {
} }
``` ```
### getFileAssets<sup>8+</sup> ### getFileAssets<sup>7+</sup>
getFileAssets(options: MediaFetchOptions, callback: AsyncCallback&lt;FetchFileResult&gt;): void getFileAssets(options: MediaFetchOptions, callback: AsyncCallback&lt;FetchFileResult&gt;): void
...@@ -2021,8 +2046,8 @@ getFileAssets(options: MediaFetchOptions, callback: AsyncCallback&lt;FetchFileRe ...@@ -2021,8 +2046,8 @@ getFileAssets(options: MediaFetchOptions, callback: AsyncCallback&lt;FetchFileRe
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------------------- | ---- | ----------------------------------- | | -------- | --------------------------------------------------- | ---- | ----------------------------------- |
| options | [MediaFetchOptions](#mediafetchoptions8) | 是 | 媒体检索选项。 | | options | [MediaFetchOptions](#mediafetchoptions7) | 是 | 媒体检索选项。 |
| callback | AsyncCallback<[FetchFileResult](#fetchfileresult8)> | 是 | 异步返回FetchFileResult之后的回调。 | | callback | AsyncCallback<[FetchFileResult](#fetchfileresult7)> | 是 | 异步返回FetchFileResult之后的回调。 |
**示例** **示例**
...@@ -2041,7 +2066,7 @@ async function example() { ...@@ -2041,7 +2066,7 @@ async function example() {
} }
``` ```
### getFileAssets<sup>8+</sup> ### getFileAssets<sup>7+</sup>
getFileAssets(options?: MediaFetchOptions): Promise&lt;FetchFileResult&gt; getFileAssets(options?: MediaFetchOptions): Promise&lt;FetchFileResult&gt;
...@@ -2055,13 +2080,13 @@ async function example() { ...@@ -2055,13 +2080,13 @@ async function example() {
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------- | ---------------------------------------- | ---- | -------------- | | ------- | ---------------------------------------- | ---- | -------------- |
| options | [MediaFetchOptions](#mediafetchoptions8) | 否 | 媒体检索选项。 | | options | [MediaFetchOptions](#mediafetchoptions7) | 否 | 媒体检索选项。 |
**返回值** **返回值**
| 类型 | 说明 | | 类型 | 说明 |
| --------------------------------------------- | ------------------------- | | --------------------------------------------- | ------------------------- |
| Promise<[FetchFileResult](#fetchfileresult8)> | 返回FetchFileResult对象。 | | Promise<[FetchFileResult](#fetchfileresult7)> | 返回FetchFileResult对象。 |
**示例** **示例**
...@@ -2088,15 +2113,15 @@ async function example() { ...@@ -2088,15 +2113,15 @@ async function example() {
**系统能力:** 以下各项对应的系统能力均为SystemCapability.Multimedia.MediaLibrary.Core **系统能力:** 以下各项对应的系统能力均为SystemCapability.Multimedia.MediaLibrary.Core
| 名称 | 类型 | 可读 | 可写 | 说明 | | 名称 | 类型 | 可读 | 可写 | 说明 |
| ---------- | ---------- | ---- | ---- | --------- | | ---------- | -------------------------- | ---- | ---- | ---------------- |
| deviceName | string | 是 | 否 | 注册设备的名称 | | deviceName | string | 是 | 否 | 注册设备的名称 |
| networkId | string | 是 | 否 | 注册设备的网络ID | | networkId | string | 是 | 否 | 注册设备的网络ID |
| deviceType | DeviceType | 是 | 否 | 设备类型 | | deviceType | [DeviceType](#devicetype8) | 是 | 否 | 设备类型 |
| isOnline | boolean | 是 | 否 | 是否在线 | | isOnline | boolean | 是 | 否 | 是否在线 |
## MediaType ## MediaType<sup>8+</sup>
枚举,媒体类型。 枚举,媒体类型。
...@@ -2109,7 +2134,7 @@ async function example() { ...@@ -2109,7 +2134,7 @@ async function example() {
| VIDEO | 2 | 视频 | | VIDEO | 2 | 视频 |
| AUDIO | 3 | 音频 | | AUDIO | 3 | 音频 |
## FileKey ## FileKey<sup>8+</sup>
枚举,文件关键信息。 枚举,文件关键信息。
...@@ -2137,7 +2162,7 @@ async function example() { ...@@ -2137,7 +2162,7 @@ async function example() {
| ALBUM_ID | bucket_id | 文件所归属的相册编号 | | ALBUM_ID | bucket_id | 文件所归属的相册编号 |
| ALBUM_NAME | bucket_display_name | 文件所归属相册名称 | | ALBUM_NAME | bucket_display_name | 文件所归属相册名称 |
## DirectoryType ## DirectoryType<sup>8+</sup>
枚举,目录类型。 枚举,目录类型。
...@@ -2152,7 +2177,7 @@ async function example() { ...@@ -2152,7 +2177,7 @@ async function example() {
| DIR_DOCUMENTS | 4 | 表示文档路径 | | DIR_DOCUMENTS | 4 | 表示文档路径 |
| DIR_DOWNLOAD | 5 | 表示下载路径 | | DIR_DOWNLOAD | 5 | 表示下载路径 |
## DeviceType ## DeviceType<sup>8+</sup>
枚举,设备类型。 枚举,设备类型。
...@@ -2168,20 +2193,20 @@ async function example() { ...@@ -2168,20 +2193,20 @@ async function example() {
| TYPE_CAR | 5 | 车载设备 | | TYPE_CAR | 5 | 车载设备 |
| TYPE_TV | 6 | 电视设备 | | TYPE_TV | 6 | 电视设备 |
## MediaFetchOptions<sup>8+</sup> ## MediaFetchOptions<sup>7+</sup>
检索条件。 检索条件。
**系统能力:** 以下各项对应的系统能力均为SystemCapability.Multimedia.MediaLibrary.Core **系统能力:** 以下各项对应的系统能力均为SystemCapability.Multimedia.MediaLibrary.Core
| 名称 | 类型 | 可读 | 可写 | 必填 | 说明 | | 名称 | 类型 | 可读 | 可写 | 必填 | 说明 |
| ------------- | ------------------- | ---- | ---- | ---- | ---------------------------------------- | | ----------------------- | ------------------- | ---- | ---- | ---- | ------------------------------------------------------------ |
| selections | string | 是 | 是 | 是 | 检索条件,使用[FileKey](#filekey)中的枚举值作为检索条件的列名。示例:<br />selections: mediaLibrary.FileKey.MEDIA_TYPE + '= ? OR' +mediaLibrary.FileKey.MEDIA_TYPE + '= ?‘, | | selections | string | 是 | 是 | 是 | 检索条件,使用[FileKey](#filekey8)中的枚举值作为检索条件的列名。示例:<br />selections: mediaLibrary.FileKey.MEDIA_TYPE + '= ? OR' +mediaLibrary.FileKey.MEDIA_TYPE + '= ?‘, |
| selectionArgs | Array&lt;string&gt; | 是 | 是 | 是 | 检索条件的值,对应selections中检索条件列的值。<br />示例:<br />selectionArgs: [mediaLibrary.MediaType.IMAGE.toString(), mediaLibrary.MediaType.VIDEO.toString()], | | selectionArgs | Array&lt;string&gt; | 是 | 是 | 是 | 检索条件的值,对应selections中检索条件列的值。<br />示例:<br />selectionArgs: [mediaLibrary.MediaType.IMAGE.toString(), mediaLibrary.MediaType.VIDEO.toString()], |
| order | string | 是 | 是 | 否 | 检索结果排序方式,使用[FileKey](#filekey)中的枚举值作为检索结果排序的列,可以用升序或降序排列。示例:<br />升序排列:order: mediaLibrary.FileKey.DATE_ADDED + " AESC"<br />降序排列:order: mediaLibrary.FileKey.DATE_ADDED + " DESC" | | order<sup>8+</sup> | string | 是 | 是 | 否 | 检索结果排序方式,使用[FileKey](#filekey8)中的枚举值作为检索结果排序的列,可以用升序或降序排列。示例:<br />升序排列:order: mediaLibrary.FileKey.DATE_ADDED + " AESC"<br />降序排列:order: mediaLibrary.FileKey.DATE_ADDED + " DESC" |
| uri | string | 是 | 是 | 否 | 文件URI | | uri<sup>8+</sup> | string | 是 | 是 | 否 | 文件URI |
| networkId | string | 是 | 是 | 否 | 注册设备网络ID | | networkId<sup>8+</sup> | string | 是 | 是 | 否 | 注册设备网络ID |
| extendArgs | string | 是 | 是 | 否 | 扩展的检索参数,目前没有扩展检索参数 | | extendArgs<sup>8+</sup> | string | 是 | 是 | 否 | 扩展的检索参数,目前没有扩展检索参数 |
## Size<sup>8+</sup> ## Size<sup>8+</sup>
......
...@@ -1734,22 +1734,22 @@ off(type: 'activate' | 'activating', name: string, callback?: Callback&lt;number ...@@ -1734,22 +1734,22 @@ off(type: 'activate' | 'activating', name: string, callback?: Callback&lt;number
**系统能力:** 以下各项对应的系统能力均为SystemCapability.Account.OsAccount。 **系统能力:** 以下各项对应的系统能力均为SystemCapability.Account.OsAccount。
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ----------------- | ------------------------------------------------------------ | ---- | --------------------------------- | | ------------------------------ | ------------------------------------------------------------ | ---- | --------------------------------- |
| localId | number | 是 | 系统帐号ID。 | | localId | number | 是 | 系统帐号ID。 |
| localName | string | 是 | 系统帐号名称。 | | localName | string | 是 | 系统帐号名称。 |
| type | [OsAccountType](#osaccounttype) | 是 | 系统帐号类型 | | type | [OsAccountType](#osaccounttype) | 是 | 系统帐号类型 |
| constraints | Array&lt;string&gt; | 否 | 系统帐号[约束](#系统帐号约束列表) | | constraints | Array&lt;string&gt; | 否 | 系统帐号[约束](#系统帐号约束列表) |
| isVerified | boolean | 是 | 帐号是否锁屏 | | isVerified<sup>8+</sup> | boolean | 是 | 帐号是否锁屏 |
| photo | string | 否 | 系统帐号头像 | | photo<sup>8+</sup> | string | 否 | 系统帐号头像 |
| createTime | number | 是 | 系统帐号创建时间 | | createTime<sup>8+</sup> | number | 是 | 系统帐号创建时间 |
| lastLoginTime | number | 否 | 系统帐号最后一次登录时间 | | lastLoginTime<sup>8+</sup> | number | 否 | 系统帐号最后一次登录时间 |
| serialNumber | number | 是 | 系统帐号SN码 | | serialNumber<sup>8+</sup> | number | 是 | 系统帐号SN码 |
| isActived | boolean | 是 | 系统帐号激活状态 | | isActived<sup>8+</sup> | boolean | 是 | 系统帐号激活状态 |
| isCreateCompleted | boolean | 是 | 系统帐号创建是否完整 | | isCreateCompleted<sup>8+</sup> | boolean | 是 | 系统帐号创建是否完整 |
| distributedInfo | [distributedAccount.DistributedInfo](js-apis-distributed-account.md) | 否 | 分布式帐号信息 | | distributedInfo | [distributedAccount.DistributedInfo](js-apis-distributed-account.md) | 否 | 分布式帐号信息 |
| domainInfo | [DomainAccountInfo](#domainaccountinfo) | 否 | 域帐号信息 | | domainInfo<sup>8+</sup> | [DomainAccountInfo](#domainaccountinfo) | 否 | 域帐号信息 |
## DomainAccountInfo ## DomainAccountInfo<sup>8+</sup>
域帐号信息。 域帐号信息。
......
...@@ -329,6 +329,8 @@ that.parse(options); ...@@ -329,6 +329,8 @@ that.parse(options);
xml解析选项。 xml解析选项。
### 属性
| 名称 | 参数类型 | 必填 | 说明 | | 名称 | 参数类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| supportDoctype | boolean | 否 | 是否忽略Doctype&nbsp;,&nbsp;默认false。 | | supportDoctype | boolean | 否 | 是否忽略Doctype&nbsp;,&nbsp;默认false。 |
...@@ -337,7 +339,6 @@ xml解析选项。 ...@@ -337,7 +339,6 @@ xml解析选项。
| attributeValueCallbackFunction | (name:&nbsp;string,&nbsp;value:&nbsp;string)=&gt;&nbsp;boolean | 否 | 获取attributeValue回调函数。 | | attributeValueCallbackFunction | (name:&nbsp;string,&nbsp;value:&nbsp;string)=&gt;&nbsp;boolean | 否 | 获取attributeValue回调函数。 |
| tokenValueCallbackFunction | (eventType:&nbsp;[EventType](#eventtype),&nbsp;value:&nbsp;[ParseInfo](#parseinfo))=&gt;&nbsp;boolean | 否 | 获取tokenValue回调函数。 | | tokenValueCallbackFunction | (eventType:&nbsp;[EventType](#eventtype),&nbsp;value:&nbsp;[ParseInfo](#parseinfo))=&gt;&nbsp;boolean | 否 | 获取tokenValue回调函数。 |
## ParseInfo ## ParseInfo
当前xml解析信息。 当前xml解析信息。
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册