图库PhotoPicker类photoAcsessHelper.PhotoViewPicker加标签

Signed-off-by: zhouwenjun1031 <zhouwenjun6@huawei.com>
This commit is contained in:
zhouwenjun1031 2024-01-23 14:48:50 +08:00
parent 0fc9ca1c6a
commit d6f8f80132

View File

@ -265,6 +265,7 @@ declare namespace photoAccessHelper {
* QR_OR_BAR_CODE indicates that QR code or barcode photos can be recommended
*
* @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core
* @atomicservice
* @since 11
*/
QR_OR_BAR_CODE = 1,
@ -273,6 +274,7 @@ declare namespace photoAccessHelper {
* QR_CODE indicates that QR code photos can be recommended
*
* @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core
* @atomicservice
* @since 11
*/
QR_CODE = 2,
@ -281,6 +283,7 @@ declare namespace photoAccessHelper {
* BAR_CODE indicates that barcode photos can be recommended
*
* @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core
* @atomicservice
* @since 11
*/
BAR_CODE = 3,
@ -289,6 +292,7 @@ declare namespace photoAccessHelper {
* ID_CARD indicates that QR code or barcode photos can be recommended
*
* @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core
* @atomicservice
* @since 11
*/
ID_CARD = 4,
@ -297,6 +301,7 @@ declare namespace photoAccessHelper {
* PROFILE_PICTURE indicates that profile picture photos can be recommended
*
* @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core
* @atomicservice
* @since 11
*/
PROFILE_PICTURE = 5
@ -2886,6 +2891,14 @@ declare namespace photoAccessHelper {
* @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core
* @since 10
*/
/**
* PhotoViewMIMETypes represents the type of media resource that photo picker selects.
*
* @enum { string } PhotoViewMIMETypes
* @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core
* @atomicservice
* @since 11
*/
export enum PhotoViewMIMETypes {
/**
* IMAGE_TYPE indicates that the selected media resources are images.
@ -2893,6 +2906,13 @@ declare namespace photoAccessHelper {
* @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core
* @since 10
*/
/**
* IMAGE_TYPE indicates that the selected media resources are images.
*
* @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core
* @atomicservice
* @since 11
*/
IMAGE_TYPE = 'image/*',
/**
* VIDEO_TYPE indicates that the selected media resources are videos.
@ -2900,6 +2920,13 @@ declare namespace photoAccessHelper {
* @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core
* @since 10
*/
/**
* VIDEO_TYPE indicates that the selected media resources are videos.
*
* @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core
* @atomicservice
* @since 11
*/
VIDEO_TYPE = 'video/*',
/**
* IMAGE_VIDEO_TYPE indicates that the selected media resources are images and videos.
@ -2907,6 +2934,13 @@ declare namespace photoAccessHelper {
* @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core
* @since 10
*/
/**
* IMAGE_VIDEO_TYPE indicates that the selected media resources are images and videos.
*
* @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core
* @atomicservice
* @since 11
*/
IMAGE_VIDEO_TYPE = '*/*'
}
@ -2916,6 +2950,13 @@ declare namespace photoAccessHelper {
* @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core
* @since 10
*/
/**
* PhotoSelectOptions Object
*
* @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core
* @atomicservice
* @since 11
*/
class PhotoSelectOptions {
/**
* The Type of the file in the picker window.
@ -2924,6 +2965,14 @@ declare namespace photoAccessHelper {
* @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core
* @since 10
*/
/**
* The Type of the file in the picker window.
*
* @type { ?PhotoViewMIMETypes }
* @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core
* @atomicservice
* @since 11
*/
MIMEType?: PhotoViewMIMETypes;
/**
@ -2933,6 +2982,14 @@ declare namespace photoAccessHelper {
* @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core
* @since 10
*/
/**
* Maximum number of images for a single selection.
*
* @type { ?number }
* @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core
* @atomicservice
* @since 11
*/
maxSelectNumber?: number;
/**
@ -2940,6 +2997,7 @@ declare namespace photoAccessHelper {
*
* @type { ?boolean }
* @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core
* @atomicservice
* @since 11
*/
isSearchSupported?: boolean;
@ -2949,6 +3007,7 @@ declare namespace photoAccessHelper {
*
* @type { ?boolean }
* @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core
* @atomicservice
* @since 11
*/
isPhotoTakingSupported?: boolean;
@ -2958,6 +3017,7 @@ declare namespace photoAccessHelper {
*
* @type { ?boolean }
* @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core
* @atomicservice
* @since 11
*/
isEditSupported?: boolean;
@ -2967,6 +3027,7 @@ declare namespace photoAccessHelper {
*
* @type { ?RecommendationOptions }
* @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core
* @atomicservice
* @since 11
*/
recommendationOptions?: RecommendationOptions;
@ -2976,6 +3037,7 @@ declare namespace photoAccessHelper {
*
* @type { ?Array<string> }
* @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core
* @atomicservice
* @since 11
*/
preselectedUris?: Array<string>;
@ -2985,6 +3047,7 @@ declare namespace photoAccessHelper {
* Options for recommend photos
*
* @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core
* @atomicservice
* @since 11
*/
class RecommendationOptions {
@ -2993,6 +3056,7 @@ declare namespace photoAccessHelper {
*
* @type { ?RecommendationType }
* @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core
* @atomicservice
* @since 11
*/
recommendationType?: RecommendationType;
@ -3004,6 +3068,13 @@ declare namespace photoAccessHelper {
* @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core
* @since 10
*/
/**
* PhotoSelectResult Object
*
* @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core
* @atomicservice
* @since 11
*/
class PhotoSelectResult {
/**
* The uris for the selected files.
@ -3012,6 +3083,14 @@ declare namespace photoAccessHelper {
* @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core
* @since 10
*/
/**
* The uris for the selected files.
*
* @type { Array<string> }
* @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core
* @atomicservice
* @since 11
*/
photoUris: Array<string>;
/**
@ -3021,6 +3100,14 @@ declare namespace photoAccessHelper {
* @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core
* @since 10
*/
/**
* Original option.
*
* @type { boolean }
* @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core
* @atomicservice
* @since 11
*/
isOriginalPhoto: boolean;
}
@ -3030,6 +3117,13 @@ declare namespace photoAccessHelper {
* @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core
* @since 10
*/
/**
* PhotoViewPicker Object
*
* @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core
* @atomicservice
* @since 11
*/
class PhotoViewPicker {
/**
* Pull up the photo picker based on the selection mode.
@ -3041,6 +3135,17 @@ declare namespace photoAccessHelper {
* @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core
* @since 10
*/
/**
* Pull up the photo picker based on the selection mode.
*
* @param { PhotoSelectOptions } [option] - represents the options provided in select mode.
* @returns { Promise<PhotoSelectResult> } Returns the uris for the selected files.
* @throws { BusinessError } 401 - if parameter is invalid
* @throws { BusinessError } 13900042 - Unknown error
* @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core
* @atomicservice
* @since 11
*/
select(option?: PhotoSelectOptions): Promise<PhotoSelectResult>;
/**
@ -3053,6 +3158,17 @@ declare namespace photoAccessHelper {
* @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core
* @since 10
*/
/**
* Pull up the photo picker based on the selection mode.
*
* @param { PhotoSelectOptions } option - represents the options provided in select mode.
* @param { AsyncCallback<PhotoSelectResult> } callback - Returns the PhotoSelectResult by photo picker
* @throws { BusinessError } 401 - if parameter is invalid
* @throws { BusinessError } 13900042 - Unknown error
* @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core
* @atomicservice
* @since 11
*/
select(option: PhotoSelectOptions, callback: AsyncCallback<PhotoSelectResult>): void;
/**
@ -3064,6 +3180,16 @@ declare namespace photoAccessHelper {
* @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core
* @since 10
*/
/**
* Pull up the photo picker based on the selection mode.
*
* @param { AsyncCallback<PhotoSelectResult> } callback - Returns the PhotoSelectResult by photo picker
* @throws { BusinessError } 401 - if parameter is invalid
* @throws { BusinessError } 13900042 - Unknown error
* @syscap SystemCapability.FileManagement.PhotoAccessHelper.Core
* @atomicservice
* @since 11
*/
select(callback: AsyncCallback<PhotoSelectResult>): void;
}