interface_sdk-js/api/application/PhotoEditorExtensionContext.d.ts
吴鸿 c75be508db IssueNo: #IAAJSZ
Description: kits补充图片编辑的context

Signed-off-by: 吴鸿 <wh584221@163.com>
2024-07-04 13:51:49 +08:00

64 lines
2.5 KiB
TypeScript

/*
* Copyright (c) 2024 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.
*/
/**
* @file
* @kit AbilityKit
*/
import ExtensionContext from './ExtensionContext';
import type { AbilityResult } from '../ability/abilityResult';
import image from '../@ohos.multimedia.image';
/**
* The context of Photo Editor extension. It allows access to PhotoEditorExtension-specific resources.
*
* @extends ExtensionContext
* @syscap SystemCapability.Ability.AppExtension.PhotoEditorExtension
* @StageModelOnly
* @since 12
*/
export default class PhotoEditorExtensionContext extends ExtensionContext {
/**
* Save image data by uri.
*
* @param { string } uri Image editing URI.
* @returns { Promise<AbilityResult> } Returns the result of save.
* @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified.
* <br>2.Incorrect parameter types.
* @throws { BusinessError } 29600001 - Internal error.
* @throws { BusinessError } 29600002 - Image input error.
* @throws { BusinessError } 29600003 - Image too big.
* @syscap SystemCapability.Ability.AppExtension.PhotoEditorExtension
* @since 12
*/
saveEditedContentWithUri(uri: string): Promise<AbilityResult>;
/**
* Save image data by image pixmap.
*
* @param { image.PixelMap } pixeMap Image pixmap.
* @param { image.PackingOption } option Option for image packing.
* @returns { Promise<AbilityResult> } Returns the result of save.
* @throws { BusinessError } 401 - Params error. Possible causes: 1.Mandatory parameters are left unspecified.
* <br>2.Incorrect parameter types.
* @throws { BusinessError } 29600001 - Internal error.
* @throws { BusinessError } 29600002 - Image input error.
* @throws { BusinessError } 29600003 - Image too big.
* @syscap SystemCapability.Ability.AppExtension.PhotoEditorExtension
* @since 12
*/
saveEditedContentWithImage(pixeMap: image.PixelMap, option: image.PackingOption): Promise<AbilityResult>;
}