diff --git a/api/@ohos.filemanagement.userfile_manager.d.ts b/api/@ohos.filemanagement.userfile_manager.d.ts new file mode 100644 index 0000000000000000000000000000000000000000..5fdd82edc05b355e7dda0ba88a7ae303b4128604 --- /dev/null +++ b/api/@ohos.filemanagement.userfile_manager.d.ts @@ -0,0 +1,1001 @@ +/* + * Copyright (C) 2022 Huawei Device Co., Ltd. + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import { AsyncCallback, Callback } from './basic'; +import Context from './application/Context'; +import image from './@ohos.multimedia.image'; + +/** + * @name userfile_manager + * @since 9 + * @syscap SystemCapability.FileManagement.UserFileManager.Core + * @import Import userfile_manager from '@ohos.filemanagement.userfile_manager' + */ +declare namespace userfile_manager { + /** + * Obtains a UserFileManager instance. + * @since 9 + * @syscap SystemCapability.FileManagement.UserFileManager.Core + * @import Import userfile_manager from '@ohos.filemanagement.userfile_manager' + * @FAModelOnly + * @return Returns a UserFileManager instance if the operation is successful; returns null otherwise. + */ + function getUserFileMgr(): UserFileManager; + /** + * Returns an instance of UserFileManager + * @since 9 + * @syscap SystemCapability.FileManagement.UserFileManager.Core + * @StageModelOnly + * @param context hap context information + * @return Instance of UserFileManager + */ + function getUserFileMgr(context: Context): UserFileManager; + + /** + * Enumeration types for different kinds of Media Files + * @since 9 + * @syscap SystemCapability.FileManagement.UserFileManager.Core + */ + enum MediaType { + /** + * File media type + * @since 9 + * @syscap SystemCapability.FileManagement.UserFileManager.Core + */ + FILE = 0, + /** + * Image media type + * @since 9 + * @syscap SystemCapability.FileManagement.UserFileManager.Core + */ + IMAGE, + /** + * Video media type + * @since 9 + * @syscap SystemCapability.FileManagement.UserFileManager.Core + */ + VIDEO, + /** + * Audio media type + * @since 9 + * @syscap SystemCapability.FileManagement.UserFileManager.Core + */ + AUDIO + } + + /** + * Provides methods to encapsulate file attributes. + * @since 9 + * @syscap SystemCapability.FileManagement.UserFileManager.Core + * @import Import userfilemgr from '@ohos.filemanagement.userfile_manager' + */ + interface FileAsset { + /** + * URI of the file. + * @since 9 + * @syscap SystemCapability.FileManagement.UserFileManager.Core + */ + readonly uri: string; + /** + * Media type, for example, IMAGE, VIDEO, FILE, AUDIO + * @since 9 + * @syscap SystemCapability.FileManagement.UserFileManager.Core + */ + readonly mediaType: MediaType; + /** + * Display name (with a file name extension) of the file. + * @since 9 + * @syscap SystemCapability.FileManagement.UserFileManager.Core + */ + displayName: string; + /** + * If it is a directory where the file is located. + * @since 9 + * @syscap SystemCapability.FileManagement.UserFileManager.Core + * @param callback Callback return the result of isDerectory. + */ + isDirectory(callback: AsyncCallback): void; + /** + * If it is a directory where the file is located. + * @since 9 + * @syscap SystemCapability.FileManagement.UserFileManager.Core + */ + isDirectory():Promise; + /** + * Modify meta data where the file is located. + * @since 9 + * @syscap SystemCapability.FileManagement.UserFileManager.Core + * @permission ohos.permission.WRITE_IMAGEVIDEO or ohos.permission.WRITE_AUDIO or ohos.permission.WRITE_DOCUMENT + * @param callback no value will be returned. + */ + commitModify(callback: AsyncCallback): void; + /** + * Modify meta data where the file is located. + * @since 9 + * @syscap SystemCapability.FileManagement.UserFileManager.Core + * @permission ohos.permission.WRITE_IMAGEVIDEO or ohos.permission.WRITE_AUDIO or ohos.permission.WRITE_DOCUMENT + */ + commitModify(): Promise; + /** + * Open the file is located. + * @since 9 + * @syscap SystemCapability.FileManagement.UserFileManager.Core + * @permission ohos.permission.READ_IMAGEVIDEO or ohos.permission.READ_AUDIO or ohos.permission.READ_DOCUMENT or ohos.permission.WRITE_MEDIA or ohos.permission.WRITE_IMAGEVIDEO or ohos.permission.WRITE_AUDIO or ohos.permission.WRITE_DOCUMENT + * @param mode mode for open, for example: rw, r, w. + * @param callback Callback return the fd of the file. + */ + open(mode: string, callback: AsyncCallback): void; + /** + * Open the file is located. + * @since 9 + * @syscap SystemCapability.FileManagement.UserFileManager.Core + * @permission ohos.permission.READ_IMAGEVIDEO or ohos.permission.READ_AUDIO or ohos.permission.READ_DOCUMENT or ohos.permission.WRITE_MEDIA or ohos.permission.WRITE_IMAGEVIDEO or ohos.permission.WRITE_AUDIO or ohos.permission.WRITE_DOCUMENT + * @param mode mode for open, for example: rw, r, w. + */ + open(mode: string): Promise; + /** + * Close the file is located. + * @since 9 + * @syscap SystemCapability.FileManagement.UserFileManager.Core + * @param fd fd of the file which had been opened + * @param callback no value will be returned. + */ + close(fd: number, callback: AsyncCallback): void; + /** + * Close the file is located. + * @since 9 + * @syscap SystemCapability.FileManagement.UserFileManager.Core + * @param fd fd of the file which had been opened + */ + close(fd: number): Promise; + /** + * Get thumbnail of the file when the file is located. + * @since 9 + * @syscap SystemCapability.FileManagement.UserFileManager.Core + * @permission ohos.permission.READ_IMAGEVIDEO or ohos.permission.READ_AUDIO or ohos.permission.READ_DOCUMENT + * @param callback Callback used to return the thumbnail's pixelmap. + */ + getThumbnail(callback: AsyncCallback): void; + /** + * Get thumbnail of the file when the file is located. + * @since 9 + * @syscap SystemCapability.FileManagement.UserFileManager.Core + * @permission ohos.permission.READ_IMAGEVIDEO or ohos.permission.READ_AUDIO or ohos.permission.READ_DOCUMENT + * @param size thumbnail's size + * @param callback Callback used to return the thumbnail's pixelmap. + */ + getThumbnail(size: Size, callback: AsyncCallback): void; + /** + * Get thumbnail of the file when the file is located. + * @since 9 + * @syscap SystemCapability.FileManagement.UserFileManager.Core + * @permission ohos.permission.READ_IMAGEVIDEO or ohos.permission.READ_AUDIO or ohos.permission.READ_DOCUMENT + * @param size thumbnail's size + */ + getThumbnail(size?: Size): Promise; + /** + * Set favorite for the file when the file is located. + * @since 9 + * @syscap SystemCapability.FileManagement.UserFileManager.Core + * @permission ohos.permission.WRITE_IMAGEVIDEO or ohos.permission.WRITE_AUDIO or ohos.permission.WRITE_DOCUMENT + * @param isFavorite ture is favorite file, false is not favorite file + * @param callback Callback used to return, No value is returned. + */ + favorite(isFavorite: boolean, callback: AsyncCallback): void; + /** + * Set favorite for the file when the file is located. + * @since 9 + * @syscap SystemCapability.FileManagement.UserFileManager.Core + * @permission ohos.permission.WRITE_IMAGEVIDEO or ohos.permission.WRITE_AUDIO or ohos.permission.WRITE_DOCUMENT + * @param isFavorite ture is favorite file, false is not favorite file + */ + favorite(isFavorite: boolean): Promise; + /** + * If the file is favorite when the file is located. + * @since 9 + * @syscap SystemCapability.FileManagement.UserFileManager.Core + * @param callback Callback used to return true or false. + */ + isFavorite(callback: AsyncCallback): void; + /** + * If the file is favorite when the file is located. + * @since 9 + * @syscap SystemCapability.FileManagement.UserFileManager.Core + */ + isFavorite():Promise; + /** + * Set trash for the file when the file is located. + * @since 9 + * @syscap SystemCapability.FileManagement.UserFileManager.Core + * @permission ohos.permission.WRITE_IMAGEVIDEO or ohos.permission.WRITE_AUDIO or ohos.permission.WRITE_DOCUMENT + * @param isTrash true is trashed file, false is not trashed file + * @param callback Callback used to return, No value is returned. + */ + trash(isTrash: boolean, callback: AsyncCallback): void; + /** + * Set trash for the file when the file is located. + * @since 9 + * @syscap SystemCapability.FileManagement.UserFileManager.Core + * @permission ohos.permission.WRITE_IMAGEVIDEO or ohos.permission.WRITE_AUDIO or ohos.permission.WRITE_DOCUMENT + * @param isTrash true is trashed file, false is not trashed file + */ + trash(isTrash: boolean): Promise; + /** + * If the file is in trash when the file is located. + * @since 9 + * @syscap SystemCapability.FileManagement.UserFileManager.Core + * @param callback Callback used to return true or false. + */ + isTrash(callback: AsyncCallback): void; + /** + * If the file is in trash when the file is located. + * @since 9 + * @syscap SystemCapability.FileManagement.UserFileManager.Core + */ + isTrash():Promise; + } + + /** + * Describes MediaFetchOptions's selection + * @since 9 + * @syscap SystemCapability.FileManagement.UserFileManager.Core + */ + enum FileKey { + /** + * File uri + * @since 9 + * @syscap SystemCapability.FileManagement.UserFileManager.Core + */ + URI = "uri", + /** + * Relative Path + * @since 9 + * @syscap SystemCapability.FileManagement.UserFileManager.Core + */ + RELATIVE_PATH = "relative_path", + /** + * File name + * @since 9 + * @syscap SystemCapability.FileManagement.UserFileManager.Core + */ + DISPLAY_NAME = "display_name", + /** + * Date of the file creation + * @since 9 + * @syscap SystemCapability.FileManagement.UserFileManager.Core + */ + DATE_ADDED = "date_added", + /** + * Modify date of the file + * @since 9 + * @syscap SystemCapability.FileManagement.UserFileManager.Core + */ + DATE_MODIFIED = "date_modified", + /** + * Title of the file + * @since 9 + * @syscap SystemCapability.FileManagement.UserFileManager.Core + */ + TITLE = "title", + } + + /** + * Describes AUDIO TYPE MediaFetchOptions's predicate + * @since 9 + * @syscap SystemCapability.FileManagement.UserFileManager.Core + */ + enum AudioKey { + /** + * File uri + * @since 9 + * @syscap SystemCapability.FileManagement.UserFileManager.Core + */ + URI = "uri", + /** + * Relative Path + * @since 9 + * @syscap SystemCapability.FileManagement.UserFileManager.Core + */ + RELATIVE_PATH = "relative_path", + /** + * File name + * @since 9 + * @syscap SystemCapability.FileManagement.UserFileManager.Core + */ + DISPLAY_NAME = "display_name", + /** + * Date of the file creation + * @since 9 + * @syscap SystemCapability.FileManagement.UserFileManager.Core + */ + DATE_ADDED = "date_added", + /** + * Modify date of the file + * @since 9 + * @syscap SystemCapability.FileManagement.UserFileManager.Core + */ + DATE_MODIFIED = "date_modified", + /** + * Title of the file + * @since 9 + * @syscap SystemCapability.FileManagement.UserFileManager.Core + */ + TITLE = "title", + /** + * Artist of the audio file + * @since 9 + * @syscap SystemCapability.FileManagement.UserFileManager.Core + */ + ARTIST = "artist", + /** + * Audio album of the audio file + * @since 9 + * @syscap SystemCapability.FileManagement.UserFileManager.Core + */ + AUDIOALBUM = "audio_album", + /** + * Duration of the audio and video file + * @since 9 + * @syscap SystemCapability.FileManagement.UserFileManager.Core + */ + DURATION = "duration", + } + + /** + * Describes Image, Video TYPE MediaFetchOptions's predicate + * @since 9 + * @syscap SystemCapability.FileManagement.UserFileManager.Core + */ + enum ImageVideoKey { + /** + * File uri + * @since 9 + * @syscap SystemCapability.FileManagement.UserFileManager.Core + */ + URI = "uri", + /** + * Relative Path + * @since 9 + * @syscap SystemCapability.FileManagement.UserFileManager.Core + */ + RELATIVE_PATH = "relative_path", + /** + * File name + * @since 9 + * @syscap SystemCapability.FileManagement.UserFileManager.Core + */ + DISPLAY_NAME = "display_name", + /** + * Date of the file creation + * @since 9 + * @syscap SystemCapability.FileManagement.UserFileManager.Core + */ + DATE_ADDED = "date_added", + /** + * Modify date of the file + * @since 9 + * @syscap SystemCapability.FileManagement.UserFileManager.Core + */ + DATE_MODIFIED = "date_modified", + /** + * Title of the file + * @since 9 + * @syscap SystemCapability.FileManagement.UserFileManager.Core + */ + TITLE = "title", + /** + * Duration of the audio and video file + * @since 9 + * @syscap SystemCapability.FileManagement.UserFileManager.Core + */ + DURATION = "duration", + /** + * Width of the image file + * @since 9 + * @syscap SystemCapability.FileManagement.UserFileManager.Core + */ + WIDTH = "width", + /** + * Height of the image file + * @since 9 + * @syscap SystemCapability.FileManagement.UserFileManager.Core + */ + HEIGHT = "height", + /** + * Date taken of the file + * @since 9 + * @syscap SystemCapability.FileManagement.UserFileManager.Core + */ + DATE_TAKEN = "date_taken", + } + + /** + * Describes Album TYPE predicate + * @since 9 + * @syscap SystemCapability.FileManagement.UserFileManager.Core + */ + enum AlbumKey { + /** + * File uri + * @since 9 + * @syscap SystemCapability.FileManagement.UserFileManager.Core + */ + URI = "uri", + /** + * Relative Path + * @since 9 + * @syscap SystemCapability.FileManagement.UserFileManager.Core + */ + RELATIVE_PATH = "relative_path", + /** + * File name + * @since 9 + * @syscap SystemCapability.FileManagement.UserFileManager.Core + */ + DISPLAY_NAME = "display_name", + /** + * Date of the file creation + * @since 9 + * @syscap SystemCapability.FileManagement.UserFileManager.Core + */ + DATE_ADDED = "date_added", + /** + * Modify date of the file + * @since 9 + * @syscap SystemCapability.FileManagement.UserFileManager.Core + */ + DATE_MODIFIED = "date_modified", + } + + /** + * Fetch parameters applicable on images, videos, audios, albums and other media + * @syscap SystemCapability.FileManagement.UserFileManager.Core + * @since 9 + */ + interface MediaFetchOptions { + /** + * Fields to retrieve, for example, selections: "media_type =? OR media_type =?". + * @since 9 + * @syscap SystemCapability.FileManagement.UserFileManager.Core + */ + selections: string; + /** + * Conditions for retrieval, for example, selectionArgs: [IMAGE, VIDEO]. + * @since 9 + * @syscap SystemCapability.FileManagement.UserFileManager.Core + */ + selectionArgs: Array; + } + + /** + * Implements file retrieval. + * @since 9 + * @syscap SystemCapability.FileManagement.UserFileManager.Core + * @import Import userfilemgr from '@ohos.filemanagement.userfile_manager' + */ + interface FetchFileResult { + /** + * Obtains the total number of files in the file retrieval result. + * @since 9 + * @syscap SystemCapability.FileManagement.UserFileManager.Core + * @return Total number of files. + */ + getCount(): number; + /** + * Checks whether the result set points to the last row. + * @since 9 + * @syscap SystemCapability.FileManagement.UserFileManager.Core + * @return Whether the file is the last one. + * You need to check whether the file is the last one before calling getNextObject, + * which returns the next file only when True is returned for this method. + */ + isAfterLast(): boolean; + /** + * Releases the FetchFileResult instance and invalidates it. Other methods cannot be called. + * @since 9 + * @syscap SystemCapability.FileManagement.UserFileManager.Core + */ + close(): void; + /** + * Obtains the first FileAsset in the file retrieval result. This method uses a callback to return the file. + * @since 9 + * @syscap SystemCapability.FileManagement.UserFileManager.Core + * @param callback Callback used to return the file in the format of a FileAsset instance. + */ + getFirstObject(callback: AsyncCallback): void; + /** + * Obtains the first FileAsset in the file retrieval result. This method uses a promise to return the file. + * @since 9 + * @syscap SystemCapability.FileManagement.UserFileManager.Core + * @return A Promise instance used to return the file in the format of a FileAsset instance. + */ + getFirstObject(): Promise; + /** + * Obtains the next FileAsset in the file retrieval result. + * This method uses a callback to return the file. + * Before calling this method, you must use isAfterLast() to check whether the result set points to the last row. + * This method returns the next file only when True is returned for isAfterLast(). + * @since 9 + * @syscap SystemCapability.FileManagement.UserFileManager.Core + * @param callback Callback used to return the file in the format of a FileAsset instance. + */ + getNextObject(callback: AsyncCallback): void; + /** + * Obtains the next FileAsset in the file retrieval result. + * This method uses a promise to return the file. + * Before calling this method, you must use isAfterLast() to check whether the result set points to the last row. + * This method returns the next file only when True is returned for isAfterLast(). + * @since 9 + * @syscap SystemCapability.FileManagement.UserFileManager.Core + * @return A Promise instance used to return the file in the format of a FileAsset instance. + */ + getNextObject(): Promise; + /** + * Obtains the last FileAsset in the file retrieval result. This method uses a callback to return the file. + * @since 9 + * @syscap SystemCapability.FileManagement.UserFileManager.Core + * @param callback Callback used to return the file in the format of a FileAsset instance. + */ + getLastObject(callback: AsyncCallback): void; + /** + * Obtains the last FileAsset in the file retrieval result. This method uses a promise to return the file. + * @since 9 + * @syscap SystemCapability.FileManagement.UserFileManager.Core + * @return A Promise instance used to return the file in the format of a FileAsset instance. + */ + getLastObject(): Promise; + /** + * Obtains the FileAsset with the specified index in the file retrieval result. + * This method uses a callback to return the file. + * @since 9 + * @syscap SystemCapability.FileManagement.UserFileManager.Core + * @param index Index of the file to obtain. + * @param callback Callback used to return the file in the format of a FileAsset instance. + */ + getPositionObject(index: number, callback: AsyncCallback): void; + /** + * Obtains the FileAsset with the specified index in the file retrieval result. + * This method uses a promise to return the file. + * @since 9 + * @syscap SystemCapability.FileManagement.UserFileManager.Core + * @param index Index of the file to obtain. + * @return A Promise instance used to return the file in the format of a FileAsset instance. + */ + getPositionObject(index: number): Promise; + } + + /** + * Defines the album. + * + * @syscap SystemCapability.FileManagement.UserFileManager.Core + * @since 9 + */ + interface Album { + /** + * Album name. + * @since 9 + * @syscap SystemCapability.FileManagement.UserFileManager.Core + */ + albumName: string; + /** + * Album uri. + * @since 9 + * @syscap SystemCapability.FileManagement.UserFileManager.Core + */ + readonly albumUri: string; + /** + * Date (timestamp) when the album was last modified. + * @since 9 + * @syscap SystemCapability.FileManagement.UserFileManager.Core + */ + readonly dateModified: number; + /** + * File count for the album + * @since 9 + * @syscap SystemCapability.FileManagement.UserFileManager.Core + */ + readonly count: number; + /** + * Relative path for the album + * @since 9 + * @syscap SystemCapability.FileManagement.UserFileManager.Core + */ + readonly relativePath: string; + /** + * coverUri for the album + * @since 9 + * @syscap SystemCapability.FileManagement.UserFileManager.Core + */ + readonly coverUri: string; + + /** + * Modify the meta data for the album + * @since 9 + * @syscap SystemCapability.FileManagement.UserFileManager.Core + * @permission ohos.permission.WRITE_IMAGEVIDEO or ohos.permission.WRITE_AUDIO or ohos.permission.WRITE_DOCUMENT + * @param callback, no value will be returned. + */ + commitModify(callback: AsyncCallback): void; + /** + * Modify the meta data for the album + * @since 9 + * @syscap SystemCapability.FileManagement.UserFileManager.Core + * @permission ohos.permission.WRITE_IMAGEVIDEO or ohos.permission.WRITE_AUDIO or ohos.permission.WRITE_DOCUMENT + */ + commitModify(): Promise; + /** + * SObtains files in an album. This method uses an asynchronous callback to return the files. + * @since 9 + * @syscap SystemCapability.FileManagement.UserFileManager.Core + * @permission ohos.permission.READ_IMAGEVIDEO or ohos.permission.READ_AUDIO or ohos.permission.READ_DOCUMENT + * @param callback Callback used to return the files in the format of a FetchFileResult instance. + */ + getFileAssets(type: Array, callback: AsyncCallback): void; + /** + * SObtains files in an album. This method uses an asynchronous callback to return the files. + * @since 9 + * @syscap SystemCapability.FileManagement.UserFileManager.Core + * @permission ohos.permission.READ_IMAGEVIDEO or ohos.permission.READ_AUDIO or ohos.permission.READ_DOCUMENT + * @param options Media retrieval options. + * @param callback Callback used to return the files in the format of a FetchFileResult instance. + */ + getFileAssets(type: Array, options: MediaFetchOptions, callback: AsyncCallback): void; + /** + * Obtains files in an album. This method uses a promise to return the files. + * @since 9 + * @syscap SystemCapability.FileManagement.UserFileManager.Core + * @permission ohos.permission.READ_IMAGEVIDEO or ohos.permission.READ_AUDIO or ohos.permission.READ_DOCUMENT + * @param options Media retrieval options. + * @return A Promise instance used to return the files in the format of a FetchFileResult instance. + */ + getFileAssets(type: Array, options?: MediaFetchOptions): Promise; + } + + /** + * Enumeration public directory that predefined + * @since 9 + * @syscap SystemCapability.FileManagement.UserFileManager.Core + */ + enum DirectoryType { + /** + * predefined public directory for files token by Camera. + * @since 9 + * @syscap SystemCapability.FileManagement.UserFileManager.Core + */ + DIR_CAMERA = 0, + /** + * predefined public directory for VIDEO files. + * @since 9 + * @syscap SystemCapability.FileManagement.UserFileManager.Core + */ + DIR_VIDEO, + /** + * predefined public directory for IMAGE files. + * @since 9 + * @syscap SystemCapability.FileManagement.UserFileManager.Core + */ + DIR_IMAGE, + /** + * predefined public directory for AUDIO files. + * @since 9 + * @syscap SystemCapability.FileManagement.UserFileManager.Core + */ + DIR_AUDIO, + /** + * predefined public directory for DOCUMENTS files. + * @since 9 + * @syscap SystemCapability.FileManagement.UserFileManager.Core + */ + DIR_DOCUMENTS, + /** + * predefined public directory for DOWNLOAD files. + * @since 9 + * @syscap SystemCapability.FileManagement.UserFileManager.Core + */ + DIR_DOWNLOAD + } + + /** + * Defines the UserFileManager class and provides functions to access the data in user file storage. + * + * @syscap SystemCapability.FileManagement.UserFileManager.Core + * @since 9 + */ + interface UserFileManager { + /** + * get system predefined root dir, use to create file asset by relative path + * @since 9 + * @syscap SystemCapability.FileManagement.UserFileManager.Core + * @param type, public directory predefined in DirectoryType. + * @param callback Callback return the FetchFileResult. + */ + getPublicDirectory(type: DirectoryType, callback: AsyncCallback): void; + /** + * get system predefined root dir, use to create file asset by relative path + * @since 9 + * @syscap SystemCapability.FileManagement.UserFileManager.Core + * @param type public directory predefined in DirectoryType. + * @return A promise instance used to return the public directory in the format of string + */ + getPublicDirectory(type: DirectoryType): Promise; + /** + * query all assets just for count & first cover + * if need all data, getAllObject from FetchFileResult + * @since 9 + * @syscap SystemCapability.FileManagement.UserFileManager.Core + * @permission ohos.permission.READ_IMAGEVIDEO or ohos.permission.READ_AUDIO or ohos.permission.READ_DOCUMENT + * @param options, Media retrieval options. + * @param callback, Callback return the FetchFileResult. + */ + getFileAssets(type: Array, options: MediaFetchOptions, callback: AsyncCallback): void; + /** + * query all assets just for count & first cover + * if need all data, getAllObject from FetchFileResult + * @since 9 + * @syscap SystemCapability.FileManagement.UserFileManager.Core + * @permission ohos.permission.READ_IMAGEVIDEO or ohos.permission.READ_AUDIO or ohos.permission.READ_DOCUMENT + * @param options Media retrieval options. + * @return A promise instance used to return the files in the format of a FetchFileResult instance + */ + getFileAssets(type: Array, options: MediaFetchOptions): Promise; + /** + * Turn on mornitor the data changes by media type + * @since 9 + * @syscap SystemCapability.FileManagement.UserFileManager.Core + * @param type one of 'deviceChange','albumChange','imageChange','audioChange','videoChange','fileChange','remoteFileChange' + * @param callback no value returned + */ + on(type: 'deviceChange'|'albumChange'|'imageChange'|'audioChange'|'videoChange'|'fileChange'|'remoteFileChange', callback: Callback): void; + /** + * Turn off mornitor the data changes by media type + * @since 9 + * @syscap SystemCapability.FileManagement.UserFileManager.Core + * @param type one of 'deviceChange','albumChange','imageChange','audioChange','videoChange','fileChange','remoteFileChange' + * @param callback no value returned + */ + off(type: 'deviceChange'|'albumChange'|'imageChange'|'audioChange'|'videoChange'|'fileChange'|'remoteFileChange', callback?: Callback): void; + /** + * Create File Asset + * @syscap SystemCapability.FileManagement.UserFileManager.Core + * @permission ohos.permission.WRITE_IMAGEVIDEO or ohos.permission.WRITE_AUDIO or ohos.permission.WRITE_DOCUMENT + * @param mediaType mediaType for example:IMAGE, VIDEO, AUDIO, FILE + * @param displayName file name + * @param relativePath relative path + * @param callback Callback used to return the FileAsset + * @systemapi + * @since 9 + */ + createAsset(mediaType: MediaType, displayName: string, relativePath: string, callback: AsyncCallback): void; + /** + * Create File Asset + * @syscap SystemCapability.FileManagement.UserFileManager.Core + * @permission ohos.permission.WRITE_IMAGEVIDEO or ohos.permission.WRITE_AUDIO or ohos.permission.WRITE_DOCUMENT + * @param mediaType mediaType for example:IMAGE, VIDEO, AUDIO, FILE + * @param displayName file name + * @param relativePath relative path + * @return A Promise instance used to return the FileAsset + * @systemapi + * @since 9 + */ + createAsset(mediaType: MediaType, displayName: string, relativePath: string): Promise; + /** + * Delete File Asset + * @since 9 + * @syscap SystemCapability.FileManagement.UserFileManager.Core + * @permission ohos.permission.WRITE_IMAGEVIDEO or ohos.permission.WRITE_AUDIO or ohos.permission.WRITE_DOCUMENT + * @param uri FileAsset's URI + * @param callback no value returned + * @systemapi + */ + deleteAsset(uri: string, callback: AsyncCallback): void; + /** + * Delete File Asset + * @since 9 + * @syscap SystemCapability.FileManagement.UserFileManager.Core + * @permission ohos.permission.WRITE_IMAGEVIDEO or ohos.permission.WRITE_AUDIO or ohos.permission.WRITE_DOCUMENT + * @param uri, FileAsset's URI + * @return A Promise instance, no value returned + * @systemapi + */ + deleteAsset(uri: string): Promise; + /** + * Obtains albums based on the media retrieval options. This method uses an asynchronous callback to return. + * @since 9 + * @syscap SystemCapability.FileManagement.UserFileManager.Core + * @permission ohos.permission.READ_IMAGEVIDEO or ohos.permission.READ_AUDIO or ohos.permission.READ_DOCUMENT + * @param options Media retrieval options. + * @param callback Callback used to return an album array. + */ + getAlbums(type: Array, options: MediaFetchOptions, callback: AsyncCallback>): void; + /** + * Obtains albums based on the media retrieval options. This method uses a promise to return the albums. + * @since 9 + * @syscap SystemCapability.FileManagement.UserFileManager.Core + * @permission ohos.permission.READ_IMAGEVIDEO or ohos.permission.READ_AUDIO or ohos.permission.READ_DOCUMENT + * @param option Media retrieval options. + * @return A Promise instance used to return an album array. + */ + getAlbums(type: Array, options: MediaFetchOptions): Promise>; + /** + * Obtains system private albums based on the virtual album type. This method uses an asynchronous callback to return. + * @syscap SystemCapability.FileManagement.UserFileManager.Core + * @permission ohos.permission.READ_IMAGEVIDEO or ohos.permission.READ_AUDIO or ohos.permission.READ_DOCUMENTS + * @param type virtual album type + * @param callback used to return a virtual album array. + * @systemapi + * @since 9 + */ + getPrivateAlbum(type: VirtualAlbumType, callback: AsyncCallback>): void; + /** + * Obtains system private albums based on the virtual album type. This method uses a promise to return. + * @syscap SystemCapability.FileManagement.UserFileManager.Core + * @permission ohos.permission.READ_IMAGEVIDEO or ohos.permission.READ_AUDIO or ohos.permission.READ_DOCUMENTS + * @param type virtual album type + * @return A Promise instance used to return a virtual album array. + * @systemapi + * @since 9 + */ + getPrivateAlbum(type: VirtualAlbumType): Promise>; + /** + * Get Active Peer device information + * @since 9 + * @syscap SystemCapability.FileManagement.UserFileManager.DistributedCore + * @systemapi + * @param callback, Callback return the list of the active peer devices' information + */ + getActivePeers(callback: AsyncCallback>): void; + /** + * Get Active Peer device information + * @since 9 + * @syscap SystemCapability.FileManagement.UserFileManager.DistributedCore + * @systemapi + * @return Promise used to return the list of the active peer devices' information + */ + getActivePeers(): Promise>; + /** + * Get all the peer devices' information + * @since 9 + * @syscap SystemCapability.FileManagement.UserFileManager.DistributedCore + * @systemapi + * @param callback Callback return the list of the all the peer devices' information + */ + getAllPeers(callback: AsyncCallback>): void; + /** + * Get all the peer devices' information + * @since 9 + * @syscap SystemCapability.FileManagement.UserFileManager.DistributedCore + * @systemapi + * @return Promise used to return the list of the all the peer devices' information + */ + getAllPeers(): Promise>; + /** + * Release UserFileManager instance + * @since 9 + * @syscap SystemCapability.FileManagement.UserFileManager.Core + * @param callback no value returned + */ + release(callback: AsyncCallback): void; + /** + * Release UserFileManager instance + * @since 9 + * @syscap SystemCapability.FileManagement.UserFileManager.Core + */ + release(): Promise; + } + + /** + * thumbnail's size which have width and heigh + * @syscap SystemCapability.FileManagement.UserFileManager.Core + * @since 9 + */ + interface Size { + /** + * Width of image file + * @since 9 + * @syscap SystemCapability.FileManagement.UserFileManager.Core + */ + width: number; + /** + * Height of image file + * @since 9 + * @syscap SystemCapability.FileManagement.UserFileManager.Core + */ + height: number; + } + + /** + * peer devices' information + * @syscap SystemCapability.FileManagement.UserFileManager.DistributedCore + * @systemapi + * @since 9 + */ + interface PeerInfo { + /** + * Peer device name + * @since 9 + * @syscap SystemCapability.FileManagement.UserFileManager.DistributedCore + * @systemapi + */ + readonly deviceName: string; + /** + * Peer device network id + * @since 9 + * @syscap SystemCapability.FileManagement.UserFileManager.DistributedCore + * @systemapi + */ + readonly networkId: string; + /** + * Peer device online status + * @since 9 + * @syscap SystemCapability.FileManagement.UserFileManager.DistributedCore + * @systemapi + */ + readonly isOnline: boolean; + } + + /** + * Virtual album type + * @syscap SystemCapability.FileManagement.UserFileManager.Core + * @systemapi + * @since 9 + */ + enum VirtualAlbumType { + /** + * System Private Album: Favorite album + * @syscap SystemCapability.FileManagement.UserFileManager.Core + * @systemapi + * @since 9 + */ + TYPE_FAVORITE, + /** + * System Private Album: Trash album + * @syscap SystemCapability.FileManagement.UserFileManager.Core + * @systemapi + * @since 9 + */ + TYPE_TRASH, + } + /** + * Defines the virtual album + * + * @syscap SystemCapability.FileManagement.UserFileManager.Core + * @systemapi + * @since 9 + */ + interface VirtualAlbum { + /** + * Obtains files in an virtual album. This method uses an asynchronous callback to return the files. + * @syscap SystemCapability.FileManagement.UserFileManager.Core + * @permission ohos.permission.READ_IMAGEVIDEO or ohos.permission.READ_AUDIO or ohos.permission.READ_DOCUMENTS + * @param options Media retrieval options. + * @param callback Callback used to return the files in the format of a FetchFileResult instance. + * @systemapi + * @since 9 + */ + getFileAssets(type: Array, options: MediaFetchOptions, callback: AsyncCallback): void; + /** + * Obtains files in an virtual album. This method uses a promise to return the files. + * @syscap SystemCapability.FileManagement.UserFileManager.Core + * @permission ohos.permission.READ_IMAGEVIDEO or ohos.permission.READ_AUDIO or ohos.permission.READ_DOCUMENTS + * @param options Media retrieval options. + * @return A Promise instance used to return the files in the format of a FetchFileResult instance. + * @systemapi + * @since 9 + */ + getFileAssets(type: Array, options: MediaFetchOptions): Promise; + } +} + +export default userfile_manager; diff --git a/api/@ohos.multimedia.mediaLibrary.d.ts b/api/@ohos.multimedia.mediaLibrary.d.ts index cdd692b8fe8db0165fa1f2c461d4ad4af44d8189..bc5b5a6102a1226ab800b57d4ff8b91620c181d6 100644 --- a/api/@ohos.multimedia.mediaLibrary.d.ts +++ b/api/@ohos.multimedia.mediaLibrary.d.ts @@ -22,6 +22,8 @@ import image from './@ohos.multimedia.image'; * @since 6 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @import import media from '@ohos.multimedia.mediaLibrary' + * @deprecated since 9 + * @useinstead ohos.filemanagement.UserFileManager */ declare namespace mediaLibrary { /** @@ -31,6 +33,8 @@ declare namespace mediaLibrary { * @import import mediaLibrary from '@ohos.multimedia.mediaLibrary' * @FAModelOnly * @return Returns a MediaLibrary instance if the operation is successful; returns null otherwise. + * @deprecated since 9 + * @useinstead ohos.filemanagement.UserFileManager.getUserFileMgr */ function getMediaLibrary(): MediaLibrary; /** @@ -40,6 +44,8 @@ declare namespace mediaLibrary { * @StageModelOnly * @param context hap context information * @return Instance of MediaLibrary + * @deprecated since 9 + * @useinstead ohos.filemanagement.UserFileManager.getUserFileMgr */ function getMediaLibrary(context: Context): MediaLibrary; @@ -47,30 +53,40 @@ declare namespace mediaLibrary { * Enumeration types for different kind of Media Files * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core + * @deprecated since 9 + * @useinstead ohos.filemanagement.UserFileManager.MediaType */ enum MediaType { /** * File media type * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core + * @deprecated since 9 + * @useinstead ohos.filemanagement.UserFileManager.MediaType.FILE */ FILE = 0, /** * Image media type * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core + * @deprecated since 9 + * @useinstead ohos.filemanagement.UserFileManager.MediaType.IMAGE */ IMAGE, /** * Video media type * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core + * @deprecated since 9 + * @useinstead ohos.filemanagement.UserFileManager.MediaType.VIDEO */ VIDEO, /** * Audio media type * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core + * @deprecated since 9 + * @useinstead ohos.filemanagement.UserFileManager.MediaType.AUDIO */ AUDIO } @@ -135,102 +151,123 @@ declare namespace mediaLibrary { * @since 7 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @import import mediaLibrary from '@ohos.multimedia.mediaLibrary' + * @deprecated since 9 + * @useinstead ohos.filemanagement.UserFileManager.FileAsset */ interface FileAsset { /** * File ID. * @since 7 * @syscap SystemCapability.Multimedia.MediaLibrary.Core + * @deprecated since 9 */ readonly id: number; /** * URI of the file. * @since 7 * @syscap SystemCapability.Multimedia.MediaLibrary.Core + * @deprecated since 9 + * @useinstead ohos.filemanagement.UserFileManager.FileAsset.uri */ readonly uri: string; /** * MIME type, for example, video/mp4, audio/mp4, or audio/amr-wb. * @since 7 * @syscap SystemCapability.Multimedia.MediaLibrary.Core + * @deprecated since 9 + * @useinstead ohos.filemanagement.UserFileManager.FileAsset.mimeType */ readonly mimeType: string; /** * Media type, for example, IMAGE, VIDEO, FILE, AUDIO * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core + * @deprecated since 9 */ readonly mediaType: MediaType; /** * Display name (with a file name extension) of the file. * @since 7 * @syscap SystemCapability.Multimedia.MediaLibrary.Core + * @deprecated since 9 + * @useinstead ohos.filemanagement.UserFileManager.FileAsset.displayName */ displayName: string; /** * File name title (without the file name extension). * @since 7 * @syscap SystemCapability.Multimedia.MediaLibrary.Core + * @deprecated since 9 */ title: string; /** * Relative Path of the file. * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core + * @deprecated since 9 */ relativePath: string; /** * Parent folder's file_id of the file. * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core + * @deprecated since 9 */ readonly parent: number; /** * Data size of the file. * @since 7 * @syscap SystemCapability.Multimedia.MediaLibrary.Core + * @deprecated since 9 */ readonly size: number; /** * Date (timestamp) when the file was added. * @since 7 * @syscap SystemCapability.Multimedia.MediaLibrary.Core + * @deprecated since 9 */ readonly dateAdded: number; /** * Date (timestamp) when the file was modified. * @since 7 * @syscap SystemCapability.Multimedia.MediaLibrary.Core + * @deprecated since 9 */ readonly dateModified: number; /** * Date (timestamp) when the file was taken. * @since 7 * @syscap SystemCapability.Multimedia.MediaLibrary.Core + * @deprecated since 9 */ readonly dateTaken: number; /** * Artist of the audio file. * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core + * @deprecated since 9 */ readonly artist: string; /** * audioAlbum of the audio file. * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core + * @deprecated since 9 */ readonly audioAlbum: string; /** * Display width of the file. This is valid only for videos and images. * @since 7 * @syscap SystemCapability.Multimedia.MediaLibrary.Core + * @deprecated since 9 */ readonly width: number; /** * Display height of the file. This is valid only for videos and images. * @since 7 * @syscap SystemCapability.Multimedia.MediaLibrary.Core + * @deprecated since 9 */ readonly height: number; /** @@ -238,30 +275,35 @@ declare namespace mediaLibrary { * The rotation angle can be 0, 90, 180, or 270 degrees. This is valid only for videos. * @since 7 * @syscap SystemCapability.Multimedia.MediaLibrary.Core + * @deprecated since 9 */ orientation: number; /** * duration of the audio and video file. * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core + * @deprecated since 9 */ readonly duration: number; /** * ID of the album where the file is located. * @since 7 * @syscap SystemCapability.Multimedia.MediaLibrary.Core + * @deprecated since 9 */ readonly albumId: number; /** * URI of the album where the file is located. * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core + * @deprecated since 9 */ readonly albumUri: string; /** * Name of the album where the file is located. * @since 7 * @syscap SystemCapability.Multimedia.MediaLibrary.Core + * @deprecated since 9 */ readonly albumName: string; @@ -271,6 +313,8 @@ declare namespace mediaLibrary { * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @permission ohos.permission.READ_MEDIA * @param callback Callback return the result of isDerectory. + * @deprecated since 9 + * @useinstead ohos.filemanagement.UserFileManager.FileAsset.isDirectory */ isDirectory(callback: AsyncCallback): void; /** @@ -278,6 +322,8 @@ declare namespace mediaLibrary { * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @permission ohos.permission.READ_MEDIA + * @deprecated since 9 + * @useinstead ohos.filemanagement.UserFileManager.FileAsset.isDirectory */ isDirectory():Promise; /** @@ -286,6 +332,8 @@ declare namespace mediaLibrary { * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @permission ohos.permission.READ_MEDIA and ohos.permission.WRITE_MEDIA * @param callback no value will be returned. + * @deprecated since 9 + * @useinstead ohos.filemanagement.UserFileManager.FileAsset.commitModify */ commitModify(callback: AsyncCallback): void; /** @@ -293,6 +341,8 @@ declare namespace mediaLibrary { * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @permission ohos.permission.READ_MEDIA and ohos.permission.WRITE_MEDIA + * @deprecated since 9 + * @useinstead ohos.filemanagement.UserFileManager.FileAsset.commitModify */ commitModify(): Promise; /** @@ -302,6 +352,8 @@ declare namespace mediaLibrary { * @permission ohos.permission.READ_MEDIA or ohos.permission.WRITE_MEDIA * @param mode mode for open, for example: rw, r, w. * @param callback Callback return the fd of the file. + * @deprecated since 9 + * @useinstead ohos.filemanagement.UserFileManager.FileAsset.open */ open(mode: string, callback: AsyncCallback): void; /** @@ -310,6 +362,8 @@ declare namespace mediaLibrary { * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @permission ohos.permission.READ_MEDIA or ohos.permission.WRITE_MEDIA * @param mode mode for open, for example: rw, r, w. + * @deprecated since 9 + * @useinstead ohos.filemanagement.UserFileManager.FileAsset.open */ open(mode: string): Promise; /** @@ -319,6 +373,8 @@ declare namespace mediaLibrary { * @permission ohos.permission.READ_MEDIA or ohos.permission.WRITE_MEDIA * @param fd fd of the file which had been opened * @param callback no value will be returned. + * @deprecated since 9 + * @useinstead ohos.filemanagement.UserFileManager.FileAsset.close */ close(fd: number, callback: AsyncCallback): void; /** @@ -327,6 +383,8 @@ declare namespace mediaLibrary { * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @permission ohos.permission.READ_MEDIA or ohos.permission.WRITE_MEDIA * @param fd fd of the file which had been opened + * @deprecated since 9 + * @useinstead ohos.filemanagement.UserFileManager.FileAsset.close */ close(fd: number): Promise; /** @@ -335,6 +393,8 @@ declare namespace mediaLibrary { * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @permission ohos.permission.READ_MEDIA * @param callback Callback used to return the thumbnail's pixelmap. + * @deprecated since 9 + * @useinstead ohos.filemanagement.UserFileManager.FileAsset.getThumbnail */ getThumbnail(callback: AsyncCallback): void; /** @@ -344,6 +404,8 @@ declare namespace mediaLibrary { * @permission ohos.permission.READ_MEDIA * @param size thumbnail's size * @param callback Callback used to return the thumbnail's pixelmap. + * @deprecated since 9 + * @useinstead ohos.filemanagement.UserFileManager.FileAsset.getThumbnail */ getThumbnail(size: Size, callback: AsyncCallback): void; /** @@ -352,6 +414,8 @@ declare namespace mediaLibrary { * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @permission ohos.permission.READ_MEDIA * @param size thumbnail's size + * @deprecated since 9 + * @useinstead ohos.filemanagement.UserFileManager.FileAsset.getThumbnail */ getThumbnail(size?: Size): Promise; /** @@ -361,6 +425,8 @@ declare namespace mediaLibrary { * @permission ohos.permission.READ_MEDIA and ohos.permission.WRITE_MEDIA * @param isFavorite ture is favorite file, false is not favorite file * @param callback Callback used to return, No value is returned. + * @deprecated since 9 + * @useinstead ohos.filemanagement.UserFileManager.FileAsset.favorite */ favorite(isFavorite: boolean, callback: AsyncCallback): void; /** @@ -369,6 +435,8 @@ declare namespace mediaLibrary { * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @permission ohos.permission.READ_MEDIA and ohos.permission.WRITE_MEDIA * @param isFavorite ture is favorite file, false is not favorite file + * @deprecated since 9 + * @useinstead ohos.filemanagement.UserFileManager.FileAsset.favorite */ favorite(isFavorite: boolean): Promise; /** @@ -377,6 +445,8 @@ declare namespace mediaLibrary { * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @permission ohos.permission.READ_MEDIA * @param callback Callback used to return true or false. + * @deprecated since 9 + * @useinstead ohos.filemanagement.UserFileManager.FileAsset.isFavorite */ isFavorite(callback: AsyncCallback): void; /** @@ -384,6 +454,8 @@ declare namespace mediaLibrary { * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @permission ohos.permission.READ_MEDIA + * @deprecated since 9 + * @useinstead ohos.filemanagement.UserFileManager.FileAsset.isFavorite */ isFavorite():Promise; /** @@ -393,6 +465,8 @@ declare namespace mediaLibrary { * @permission ohos.permission.READ_MEDIA and ohos.permission.WRITE_MEDIA * @param isTrash true is trashed file, false is not trashed file * @param callback Callback used to return, No value is returned. + * @deprecated since 9 + * @useinstead ohos.filemanagement.UserFileManager.FileAsset.trash */ trash(isTrash: boolean, callback: AsyncCallback): void; /** @@ -401,6 +475,8 @@ declare namespace mediaLibrary { * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @permission ohos.permission.READ_MEDIA and ohos.permission.WRITE_MEDIA * @param isTrash true is trashed file, false is not trashed file + * @deprecated since 9 + * @useinstead ohos.filemanagement.UserFileManager.FileAsset.trash */ trash(isTrash: boolean): Promise; /** @@ -409,6 +485,8 @@ declare namespace mediaLibrary { * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @permission ohos.permission.READ_MEDIA * @param callback Callback used to return true or false. + * @deprecated since 9 + * @useinstead ohos.filemanagement.UserFileManager.FileAsset.isTrash */ isTrash(callback: AsyncCallback): void; /** @@ -416,6 +494,8 @@ declare namespace mediaLibrary { * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @permission ohos.permission.READ_MEDIA + * @deprecated since 9 + * @useinstead ohos.filemanagement.UserFileManager.FileAsset.isTrash */ isTrash():Promise; } @@ -424,120 +504,146 @@ declare namespace mediaLibrary { * Describes MediaFetchOptions's selection * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core + * @deprecated since 9 + * @useinstead ohos.filemanagement.UserFileManager.FileKey */ enum FileKey { /** * File ID * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core + * @deprecated since 9 */ ID = "file_id", /** * Relative Path * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core + * @deprecated since 9 + * @useinstead ohos.filemanagement.UserFileManager.FileKey.RELATIVE_PATH */ RELATIVE_PATH = "relative_path", /** * File name * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core + * @deprecated since 9 + * @useinstead ohos.filemanagement.UserFileManager.FileKey.DISPLAY_NAME */ DISPLAY_NAME = "display_name", /** * Parent folder file id * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core + * @deprecated since 9 */ PARENT = "parent", /** * Mime type of the file * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core + * @deprecated since 9 */ MIME_TYPE = "mime_type", /** * Media type of the file * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core + * @deprecated since 9 */ MEDIA_TYPE = "media_type", /** * Size of the file * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core + * @deprecated since 9 */ SIZE = "size", /** * Date of the file creation * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core + * @deprecated since 9 + * @useinstead ohos.filemanagement.UserFileManager.FileKey.DATE_ADDED */ DATE_ADDED = "date_added", /** * Modify date of the file * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core + * @deprecated since 9 + * @useinstead ohos.filemanagement.UserFileManager.FileKey.DATE_MODIFIED */ DATE_MODIFIED = "date_modified", /** * Date taken of the file * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core + * @deprecated since 9 */ DATE_TAKEN = "date_taken", /** * Title of the file * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core + * @deprecated since 9 + * @useinstead ohos.filemanagement.UserFileManager.FileKey.TITLE */ TITLE = "title", /** * Artist of the audio file * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core + * @deprecated since 9 */ ARTIST = "artist", /** * Audio album of the audio file * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core + * @deprecated since 9 */ AUDIOALBUM = "audio_album", /** * Duration of the audio and video file * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core + * @deprecated since 9 */ DURATION = "duration", /** * Width of the image file * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core + * @deprecated since 9 */ WIDTH = "width", /** * Height of the image file * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core + * @deprecated since 9 */ HEIGHT = "height", /** * Orientation of the image file * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core + * @deprecated since 9 */ ORIENTATION = "orientation", /** * Album id of the file * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core + * @deprecated since 9 */ ALBUM_ID = "bucket_id", /** * Album name of the file * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core + * @deprecated since 9 */ ALBUM_NAME = "bucket_display_name", } @@ -546,42 +652,52 @@ declare namespace mediaLibrary { * Fetch parameters applicable on images, videos, audios, albums and other media * @since 7 * @syscap SystemCapability.Multimedia.MediaLibrary.Core + * @deprecated since 9 + * @useinstead ohos.filemanagement.UserFileManager.MediaFetchOptions */ interface MediaFetchOptions { /** * Fields to retrieve, for example, selections: "media_type =? OR media_type =?". * @since 7 * @syscap SystemCapability.Multimedia.MediaLibrary.Core + * @deprecated since 9 + * @useinstead ohos.filemanagement.UserFileManager.MediaFetchOptions.selections */ selections: string; /** * Conditions for retrieval, for example, selectionArgs: [IMAGE, VIDEO]. * @since 7 * @syscap SystemCapability.Multimedia.MediaLibrary.Core + * @deprecated since 9 + * @useinstead ohos.filemanagement.UserFileManager.MediaFetchOptions.selectionArgs */ selectionArgs: Array; /** * Sorting criterion of the retrieval results, for example, order: "datetaken DESC,display_name DESC, file_id DESC". * @since 7 * @syscap SystemCapability.Multimedia.MediaLibrary.Core + * @deprecated since 9 */ order?: string; /** * uri for retrieval * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core + * @deprecated since 9 */ uri?: string; /** * networkId for retrieval * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core + * @deprecated since 9 */ networkId?: string; /** * extendArgs for retrieval * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core + * @deprecated since 9 */ extendArgs?: string; } @@ -591,6 +707,8 @@ declare namespace mediaLibrary { * @since 7 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @import import mediaLibrary from '@ohos.multimedia.mediaLibrary' + * @deprecated since 9 + * @useinstead ohos.filemanagement.UserFileManager.FetchFileResult */ interface FetchFileResult { /** @@ -598,6 +716,8 @@ declare namespace mediaLibrary { * @since 7 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @return Total number of files. + * @deprecated since 9 + * @useinstead ohos.filemanagement.UserFileManager.FetchFileResult.getCount */ getCount(): number; /** @@ -605,6 +725,8 @@ declare namespace mediaLibrary { * @since 7 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @return Whether the file is the last one. + * @deprecated since 9 + * @useinstead ohos.filemanagement.UserFileManager.FetchFileResult.isAfterLast * You need to check whether the file is the last one before calling getNextObject, * which returns the next file only when True is returned for this method. */ @@ -613,6 +735,8 @@ declare namespace mediaLibrary { * Releases the FetchFileResult instance and invalidates it. Other methods cannot be called. * @since 7 * @syscap SystemCapability.Multimedia.MediaLibrary.Core + * @deprecated since 9 + * @useinstead ohos.filemanagement.UserFileManager.FetchFileResult.close */ close(): void; /** @@ -620,6 +744,8 @@ declare namespace mediaLibrary { * @since 7 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @param callback Callback used to return the file in the format of a FileAsset instance. + * @deprecated since 9 + * @useinstead ohos.filemanagement.UserFileManager.FetchFileResult.getFirstObject */ getFirstObject(callback: AsyncCallback): void; /** @@ -627,6 +753,8 @@ declare namespace mediaLibrary { * @since 7 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @return A Promise instance used to return the file in the format of a FileAsset instance. + * @deprecated since 9 + * @useinstead ohos.filemanagement.UserFileManager.FetchFileResult.getFirstObject */ getFirstObject(): Promise; /** @@ -637,6 +765,8 @@ declare namespace mediaLibrary { * @since 7 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @param callback Callback used to return the file in the format of a FileAsset instance. + * @deprecated since 9 + * @useinstead ohos.filemanagement.UserFileManager.FetchFileResult.getNextObject */ getNextObject(callback: AsyncCallback): void; /** @@ -647,6 +777,8 @@ declare namespace mediaLibrary { * @since 7 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @return A Promise instance used to return the file in the format of a FileAsset instance. + * @deprecated since 9 + * @useinstead ohos.filemanagement.UserFileManager.FetchFileResult.getNextObject */ getNextObject(): Promise; /** @@ -654,6 +786,8 @@ declare namespace mediaLibrary { * @since 7 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @param callback Callback used to return the file in the format of a FileAsset instance. + * @deprecated since 9 + * @useinstead ohos.filemanagement.UserFileManager.FetchFileResult.getLastObject */ getLastObject(callback: AsyncCallback): void; /** @@ -661,6 +795,8 @@ declare namespace mediaLibrary { * @since 7 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @return A Promise instance used to return the file in the format of a FileAsset instance. + * @deprecated since 9 + * @useinstead ohos.filemanagement.UserFileManager.FetchFileResult.getLastObject */ getLastObject(): Promise; /** @@ -670,6 +806,8 @@ declare namespace mediaLibrary { * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @param index Index of the file to obtain. * @param callback Callback used to return the file in the format of a FileAsset instance. + * @deprecated since 9 + * @useinstead ohos.filemanagement.UserFileManager.FetchFileResult.getPositionObject */ getPositionObject(index: number, callback: AsyncCallback): void; /** @@ -679,6 +817,8 @@ declare namespace mediaLibrary { * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @param index Index of the file to obtain. * @return A Promise instance used to return the file in the format of a FileAsset instance. + * @deprecated since 9 + * @useinstead ohos.filemanagement.UserFileManager.FetchFileResult.getPositionObject */ getPositionObject(index: number): Promise; /** @@ -689,6 +829,7 @@ declare namespace mediaLibrary { * @since 7 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @param callback Callback used to return a FileAsset array. + * @deprecated since 9 */ getAllObject(callback: AsyncCallback>): void; /** @@ -699,6 +840,7 @@ declare namespace mediaLibrary { * @since 7 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @return A Promise instance used to return a FileAsset array. + * @deprecated since 9 */ getAllObject(): Promise>; } @@ -708,48 +850,63 @@ declare namespace mediaLibrary { * * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @since 7 + * @deprecated since 9 + * @useinstead ohos.filemanagement.UserFileManager.Album */ interface Album { /** * Album ID. * @since 7 * @syscap SystemCapability.Multimedia.MediaLibrary.Core + * @deprecated since 9 */ readonly albumId: number; /** * Album name. * @since 7 * @syscap SystemCapability.Multimedia.MediaLibrary.Core + * @deprecated since 9 + * @useinstead ohos.filemanagement.UserFileManager.Album.albumName */ albumName: string; /** * Album uri. * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core + * @deprecated since 9 + * @useinstead ohos.filemanagement.UserFileManager.Album.albumUri */ readonly albumUri: string; /** * Date (timestamp) when the album was last modified. * @since 7 * @syscap SystemCapability.Multimedia.MediaLibrary.Core + * @deprecated since 9 + * @useinstead ohos.filemanagement.UserFileManager.Album.dateModified */ readonly dateModified: number; /** * File count for the album * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core + * @deprecated since 9 + * @useinstead ohos.filemanagement.UserFileManager.Album.count */ readonly count: number; /** * Relative path for the album * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core + * @deprecated since 9 + * @useinstead ohos.filemanagement.UserFileManager.Album.relativePath */ readonly relativePath: string; /** * coverUri for the album * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core + * @deprecated since 9 + * @useinstead ohos.filemanagement.UserFileManager.Album.coverUri */ readonly coverUri: string; @@ -759,6 +916,8 @@ declare namespace mediaLibrary { * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @permission ohos.permission.READ_MEDIA and ohos.permission.WRITE_MEDIA * @param callback, no value will be returned. + * @deprecated since 9 + * @useinstead ohos.filemanagement.UserFileManager.Album.commitModify */ commitModify(callback: AsyncCallback): void; /** @@ -766,6 +925,8 @@ declare namespace mediaLibrary { * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @permission ohos.permission.READ_MEDIA and ohos.permission.WRITE_MEDIA + * @deprecated since 9 + * @useinstead ohos.filemanagement.UserFileManager.Album.commitModify */ commitModify(): Promise; /** @@ -774,6 +935,8 @@ declare namespace mediaLibrary { * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @permission ohos.permission.READ_MEDIA * @param callback Callback used to return the files in the format of a FetchFileResult instance. + * @deprecated since 9 + * @useinstead ohos.filemanagement.UserFileManager.Album.getFileAssets */ getFileAssets(callback: AsyncCallback): void; /** @@ -783,6 +946,8 @@ declare namespace mediaLibrary { * @permission ohos.permission.READ_MEDIA * @param option Media retrieval options. * @param callback Callback used to return the files in the format of a FetchFileResult instance. + * @deprecated since 9 + * @useinstead ohos.filemanagement.UserFileManager.Album.getFileAssets */ getFileAssets(options: MediaFetchOptions, callback: AsyncCallback): void; /** @@ -792,6 +957,8 @@ declare namespace mediaLibrary { * @permission ohos.permission.READ_MEDIA * @param option Media retrieval options. * @return A Promise instance used to return the files in the format of a FetchFileResult instance. + * @deprecated since 9 + * @useinstead ohos.filemanagement.UserFileManager.Album.getFileAssets */ getFileAssets(options?: MediaFetchOptions): Promise; } @@ -800,42 +967,56 @@ declare namespace mediaLibrary { * Enumeration public directory that predefined * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core + * @deprecated since 9 + * @useinstead ohos.filemanagement.UserFileManager.DirectoryType */ enum DirectoryType { /** * predefined public directory for files token by Camera. * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core + * @deprecated since 9 + * @useinstead ohos.filemanagement.UserFileManager.DirectoryType.DIR_CAMERA */ DIR_CAMERA = 0, /** * predefined public directory for VIDEO files. * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core + * @deprecated since 9 + * @useinstead ohos.filemanagement.UserFileManager.DirectoryType.DIR_VIDEO */ DIR_VIDEO, /** * predefined public directory for IMAGE files. * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core + * @deprecated since 9 + * @useinstead ohos.filemanagement.UserFileManager.DirectoryType.DIR_IMAGE */ DIR_IMAGE, /** * predefined public directory for AUDIO files. * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core + * @deprecated since 9 + * @useinstead ohos.filemanagement.UserFileManager.DirectoryType.DIR_AUDIO */ DIR_AUDIO, /** * predefined public directory for DOCUMENTS files. * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core + * @deprecated since 9 + * @useinstead ohos.filemanagement.UserFileManager.DirectoryType.DIR_DOCUMENTS */ DIR_DOCUMENTS, /** * predefined public directory for DOWNLOAD files. * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core + * @deprecated since 9 + * @useinstead ohos.filemanagement.UserFileManager.DirectoryType.DIR_DOWNLOAD */ DIR_DOWNLOAD } @@ -845,6 +1026,8 @@ declare namespace mediaLibrary { * * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @since 6 + * @deprecated since 9 + * @useinstead ohos.filemanagement.UserFileManager.UserFileManager */ interface MediaLibrary { /** @@ -853,6 +1036,8 @@ declare namespace mediaLibrary { * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @param type, public directory predefined in DirectoryType. * @param callback Callback return the FetchFileResult. + * @deprecated since 9 + * @useinstead ohos.filemanagement.UserFileManager.UserFileManager.getPublicDirectory */ getPublicDirectory(type: DirectoryType, callback: AsyncCallback): void; /** @@ -861,6 +1046,8 @@ declare namespace mediaLibrary { * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @param type public directory predefined in DirectoryType. * @return A promise instance used to return the public directory in the format of string + * @deprecated since 9 + * @useinstead ohos.filemanagement.UserFileManager.UserFileManager.getPublicDirectory */ getPublicDirectory(type: DirectoryType): Promise; /** @@ -871,6 +1058,8 @@ declare namespace mediaLibrary { * @permission ohos.permission.READ_MEDIA * @param options, Media retrieval options. * @param callback, Callback return the FetchFileResult. + * @deprecated since 9 + * @useinstead ohos.filemanagement.UserFileManager.UserFileManager.getFileAssets */ getFileAssets(options: MediaFetchOptions, callback: AsyncCallback): void; /** @@ -881,6 +1070,8 @@ declare namespace mediaLibrary { * @permission ohos.permission.READ_MEDIA * @param options Media retrieval options. * @return A promise instance used to return the files in the format of a FetchFileResult instance + * @deprecated since 9 + * @useinstead ohos.filemanagement.UserFileManager.UserFileManager.getFileAssets */ getFileAssets(options: MediaFetchOptions): Promise; /** @@ -889,6 +1080,8 @@ declare namespace mediaLibrary { * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @param type one of 'deviceChange','albumChange','imageChange','audioChange','videoChange','fileChange','remoteFileChange' * @param callback no value returned + * @deprecated since 9 + * @useinstead ohos.filemanagement.UserFileManager.UserFileManager.on */ on(type: 'deviceChange'|'albumChange'|'imageChange'|'audioChange'|'videoChange'|'fileChange'|'remoteFileChange', callback: Callback): void; /** @@ -897,6 +1090,8 @@ declare namespace mediaLibrary { * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @param type one of 'deviceChange','albumChange','imageChange','audioChange','videoChange','fileChange','remoteFileChange' * @param callback no value returned + * @deprecated since 9 + * @useinstead ohos.filemanagement.UserFileManager.UserFileManager.off */ off(type: 'deviceChange'|'albumChange'|'imageChange'|'audioChange'|'videoChange'|'fileChange'|'remoteFileChange', callback?: Callback): void; /** @@ -908,6 +1103,8 @@ declare namespace mediaLibrary { * @param displayName file name * @param relativePath relative path * @param callback Callback used to return the FileAsset + * @deprecated since 9 + * @useinstead ohos.filemanagement.UserFileManager.UserFileManager.createAsset */ createAsset(mediaType: MediaType, displayName: string, relativePath: string, callback: AsyncCallback): void; /** @@ -919,6 +1116,8 @@ declare namespace mediaLibrary { * @param displayName file name * @param relativePath relative path * @return A Promise instance used to return the FileAsset + * @deprecated since 9 + * @useinstead ohos.filemanagement.UserFileManager.UserFileManager.createAsset */ createAsset(mediaType: MediaType, displayName: string, relativePath: string): Promise; /** @@ -929,6 +1128,8 @@ declare namespace mediaLibrary { * @param uri FileAsset's URI * @param callback no value returned * @systemapi + * @deprecated since 9 + * @useinstead ohos.filemanagement.UserFileManager.UserFileManager.deleteAsset */ deleteAsset(uri: string, callback: AsyncCallback): void; /** @@ -939,6 +1140,8 @@ declare namespace mediaLibrary { * @param uri, FileAsset's URI * @return A Promise instance, no value returned * @systemapi + * @deprecated since 9 + * @useinstead ohos.filemanagement.UserFileManager.UserFileManager.deleteAsset */ deleteAsset(uri: string): Promise; /** @@ -948,6 +1151,8 @@ declare namespace mediaLibrary { * @permission ohos.permission.READ_MEDIA * @param option Media retrieval options. * @param callback Callback used to return an album array. + * @deprecated since 9 + * @useinstead ohos.filemanagement.UserFileManager.UserFileManager.getAlbums */ getAlbums(options: MediaFetchOptions, callback: AsyncCallback>): void; /** @@ -957,6 +1162,8 @@ declare namespace mediaLibrary { * @permission ohos.permission.READ_MEDIA * @param option Media retrieval options. * @return A Promise instance used to return an album array. + * @deprecated since 9 + * @useinstead ohos.filemanagement.UserFileManager.UserFileManager.getAlbums */ getAlbums(options: MediaFetchOptions): Promise>; /** @@ -1036,6 +1243,8 @@ declare namespace mediaLibrary { * @permission ohos.permission.READ_MEDIA * @systemapi * @param callback, Callback return the list of the active peer devices' information + * @deprecated since 9 + * @useinstead ohos.filemanagement.UserFileManager.UserFileManager.getActivePeers */ getActivePeers(callback: AsyncCallback>): void; /** @@ -1045,6 +1254,8 @@ declare namespace mediaLibrary { * @permission ohos.permission.READ_MEDIA * @systemapi * @return Promise used to return the list of the active peer devices' information + * @deprecated since 9 + * @useinstead ohos.filemanagement.UserFileManager.UserFileManager.getActivePeers */ getActivePeers(): Promise>; /** @@ -1054,6 +1265,8 @@ declare namespace mediaLibrary { * @permission ohos.permission.READ_MEDIA * @systemapi * @param callback Callback return the list of the all the peer devices' information + * @deprecated since 9 + * @useinstead ohos.filemanagement.UserFileManager.UserFileManager.getAllPeers */ getAllPeers(callback: AsyncCallback>): void; /** @@ -1063,6 +1276,8 @@ declare namespace mediaLibrary { * @permission ohos.permission.READ_MEDIA * @systemapi * @return Promise used to return the list of the all the peer devices' information + * @deprecated since 9 + * @useinstead ohos.filemanagement.UserFileManager.UserFileManager.getAllPeers */ getAllPeers(): Promise>; /** @@ -1070,12 +1285,16 @@ declare namespace mediaLibrary { * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @param callback no value returned + * @deprecated since 9 + * @useinstead ohos.filemanagement.UserFileManager.UserFileManager.release */ release(callback: AsyncCallback): void; /** * Release MediaLibrary instance * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core + * @deprecated since 9 + * @useinstead ohos.filemanagement.UserFileManager.UserFileManager.release */ release(): Promise; } @@ -1084,18 +1303,24 @@ declare namespace mediaLibrary { * thumbnail's size which have width and heigh * @syscap SystemCapability.Multimedia.MediaLibrary.Core * @since 8 + * @deprecated since 9 + * @useinstead ohos.filemanagement.UserFileManager.Size */ interface Size { /** * Width of image file * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core + * @deprecated since 9 + * @useinstead ohos.filemanagement.UserFileManager.Size.width */ width: number; /** * Height of image file * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.Core + * @deprecated since 9 + * @useinstead ohos.filemanagement.UserFileManager.Size.height */ height: number; } @@ -1105,12 +1330,16 @@ declare namespace mediaLibrary { * @syscap SystemCapability.Multimedia.MediaLibrary.DistributedCore * @systemapi * @since 8 + * @deprecated since 9 + * @useinstead ohos.filemanagement.UserFileManager.PeerInfo */ interface PeerInfo { /** * Peer device name * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.DistributedCore + * @deprecated since 9 + * @useinstead ohos.filemanagement.UserFileManager.PeerInfo.deviceName * @systemapi */ readonly deviceName: string; @@ -1118,6 +1347,8 @@ declare namespace mediaLibrary { * Peer device network id * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.DistributedCore + * @deprecated since 9 + * @useinstead ohos.filemanagement.UserFileManager.PeerInfo.networkId * @systemapi */ readonly networkId: string; @@ -1125,6 +1356,7 @@ declare namespace mediaLibrary { * Peer device type * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.DistributedCore + * @deprecated since 9 * @systemapi */ readonly deviceType: DeviceType; @@ -1133,6 +1365,8 @@ declare namespace mediaLibrary { * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.DistributedCore * @systemapi + * @deprecated since 9 + * @useinstead ohos.filemanagement.UserFileManager.PeerInfo.isOnline */ readonly isOnline: boolean; } @@ -1142,6 +1376,7 @@ declare namespace mediaLibrary { * @syscap SystemCapability.Multimedia.MediaLibrary.DistributedCore * @systemapi * @since 8 + * @deprecated since 9 */ enum DeviceType { /** @@ -1149,6 +1384,7 @@ declare namespace mediaLibrary { * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.DistributedCore * @systemapi + * @deprecated since 9 */ TYPE_UNKNOWN = 0, /** @@ -1156,6 +1392,7 @@ declare namespace mediaLibrary { * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.DistributedCore * @systemapi + * @deprecated since 9 */ TYPE_LAPTOP, /** @@ -1163,6 +1400,7 @@ declare namespace mediaLibrary { * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.DistributedCore * @systemapi + * @deprecated since 9 */ TYPE_PHONE, /** @@ -1170,6 +1408,7 @@ declare namespace mediaLibrary { * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.DistributedCore * @systemapi + * @deprecated since 9 */ TYPE_TABLET, /** @@ -1177,6 +1416,7 @@ declare namespace mediaLibrary { * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.DistributedCore * @systemapi + * @deprecated since 9 */ TYPE_WATCH, /** @@ -1184,6 +1424,7 @@ declare namespace mediaLibrary { * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.DistributedCore * @systemapi + * @deprecated since 9 */ TYPE_CAR, /** @@ -1191,6 +1432,7 @@ declare namespace mediaLibrary { * @since 8 * @syscap SystemCapability.Multimedia.MediaLibrary.DistributedCore * @systemapi + * @deprecated since 9 */ TYPE_TV }