mirror of
https://gitee.com/openharmony/interface_sdk-js
synced 2024-11-27 17:31:12 +00:00
249 lines
9.2 KiB
TypeScript
Executable File
249 lines
9.2 KiB
TypeScript
Executable File
/*
|
|
* Copyright (c) 2021-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 { AbilityInfo } from "../bundle/abilityInfo";
|
|
import { AbilityResult } from "../ability/abilityResult";
|
|
import { AsyncCallback } from "../basic";
|
|
import { ConnectOptions } from "../ability/connectOptions";
|
|
import { HapModuleInfo } from "../bundle/hapModuleInfo";
|
|
import Context from "./Context";
|
|
import Want from "../@ohos.application.Want";
|
|
import StartOptions from "../@ohos.application.StartOptions";
|
|
import PermissionRequestResult from "./PermissionRequestResult";
|
|
import { Configuration } from '../@ohos.application.Configuration';
|
|
import Caller from '../@ohos.application.Ability';
|
|
import { ContentStorage } from '../@internal/component/ets/state_management';
|
|
import image from '../@ohos.multimedia.image';
|
|
|
|
/**
|
|
* The context of an ability. It allows access to ability-specific resources.
|
|
*
|
|
* @since 9
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
|
* @permission N/A
|
|
* @StageModelOnly
|
|
*/
|
|
export default class AbilityContext extends Context {
|
|
/**
|
|
* Indicates configuration information about an ability.
|
|
*
|
|
* @since 9
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
|
* @StageModelOnly
|
|
*/
|
|
abilityInfo: AbilityInfo;
|
|
|
|
/**
|
|
* Indicates configuration information about an module.
|
|
*
|
|
* @since 9
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
|
* @StageModelOnly
|
|
*/
|
|
currentHapModuleInfo: HapModuleInfo;
|
|
|
|
/**
|
|
* Indicates configuration information.
|
|
*
|
|
* @since 9
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
|
* @StageModelOnly
|
|
*/
|
|
config: Configuration;
|
|
|
|
/**
|
|
* Starts a new ability.
|
|
*
|
|
* @since 9
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
|
* @param want Indicates the ability to start.
|
|
* @param options Indicates the start options.
|
|
* @return -
|
|
* @StageModelOnly
|
|
*/
|
|
startAbility(want: Want, callback: AsyncCallback<void>): void;
|
|
startAbility(want: Want, options: StartOptions, callback: AsyncCallback<void>): void;
|
|
startAbility(want: Want, options?: StartOptions): Promise<void>;
|
|
|
|
/**
|
|
* Get the caller object of the startup capability
|
|
*
|
|
* @since 9
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
|
* @param want Indicates the ability to start.
|
|
* @return Returns to the Caller interface on success Returns empty or undefined on failure
|
|
* @StageModelOnly
|
|
*/
|
|
startAbilityByCall(want: Want): Promise<Caller>;
|
|
|
|
/**
|
|
* Starts a new ability with account.
|
|
*
|
|
* @since 9
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
|
* @param want Indicates the want info to start.
|
|
* @param accountId Indicates the account to start.
|
|
* @param options Indicates the start options.
|
|
* @systemapi hide for inner use.
|
|
* @return -
|
|
* @permission ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS
|
|
* @StageModelOnly
|
|
*/
|
|
startAbilityWithAccount(want: Want, accountId: number, callback: AsyncCallback<void>): void;
|
|
startAbilityWithAccount(want: Want, accountId: number, options: StartOptions, callback: AsyncCallback<void>): void;
|
|
startAbilityWithAccount(want: Want, accountId: number, options?: StartOptions): Promise<void>;
|
|
|
|
/**
|
|
* Starts an ability and returns the execution result when the ability is destroyed.
|
|
*
|
|
* @since 9
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
|
* @param want Indicates the ability to start.
|
|
* @param options Indicates the start options.
|
|
* @return Returns the {@link AbilityResult}.
|
|
* @StageModelOnly
|
|
*/
|
|
startAbilityForResult(want: Want, callback: AsyncCallback<AbilityResult>): void;
|
|
startAbilityForResult(want: Want, options: StartOptions, callback: AsyncCallback<AbilityResult>): void;
|
|
startAbilityForResult(want: Want, options?: StartOptions): Promise<AbilityResult>;
|
|
|
|
/**
|
|
* Starts an ability and returns the execution result when the ability is destroyed with account.
|
|
*
|
|
* @since 9
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
|
* @param want Indicates the want info to start.
|
|
* @param accountId Indicates the account to start.
|
|
* @param options Indicates the start options.
|
|
* @systemapi hide for inner use.
|
|
* @return Returns the {@link AbilityResult}.
|
|
* @permission ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS
|
|
* @StageModelOnly
|
|
*/
|
|
startAbilityForResultWithAccount(want: Want, accountId: number, callback: AsyncCallback<AbilityResult>): void;
|
|
startAbilityForResultWithAccount(want: Want, accountId: number, options: StartOptions, callback: AsyncCallback<void>): void;
|
|
startAbilityForResultWithAccount(want: Want, accountId: number, options?: StartOptions): Promise<AbilityResult>;
|
|
|
|
/**
|
|
* Destroys this Page ability.
|
|
*
|
|
* @since 9
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
|
* @return -
|
|
* @StageModelOnly
|
|
*/
|
|
terminateSelf(callback: AsyncCallback<void>): void;
|
|
terminateSelf(): Promise<void>;
|
|
|
|
/**
|
|
* Sets the result code and data to be returned by this Page ability to the caller
|
|
* and destroys this Page ability.
|
|
*
|
|
* @since 9
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
|
* @param parameter Indicates the result to return.
|
|
* @return -
|
|
* @StageModelOnly
|
|
*/
|
|
terminateSelfWithResult(parameter: AbilityResult, callback: AsyncCallback<void>): void;
|
|
terminateSelfWithResult(parameter: AbilityResult): Promise<void>;
|
|
|
|
/**
|
|
* Connects the current ability to an ability using the AbilityInfo.AbilityType.SERVICE template.
|
|
*
|
|
* @since 9
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
|
* @param want The element name of the service ability
|
|
* @param options The remote object instance
|
|
* @systemapi Hide this for inner system use.
|
|
* @return Returns the number code of the ability connected
|
|
* @StageModelOnly
|
|
*/
|
|
connectAbility(want: Want, options: ConnectOptions): number;
|
|
|
|
/**
|
|
* Connects the current ability to an ability using the AbilityInfo.AbilityType.SERVICE template with account.
|
|
*
|
|
* @since 9
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
|
* @param want The element name of the service ability
|
|
* @param accountId The account to connect
|
|
* @param options The remote object instance
|
|
* @systemapi hide for inner use.
|
|
* @return Returns the number code of the ability connected
|
|
* @permission ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS
|
|
* @StageModelOnly
|
|
*/
|
|
connectAbilityWithAccount(want: Want, accountId: number, options: ConnectOptions): number;
|
|
|
|
/**
|
|
* The callback interface was connect successfully.
|
|
*
|
|
* @since 9
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
|
* @param connection The number code of the ability connected
|
|
* @systemapi Hide this for inner system use.
|
|
* @StageModelOnly
|
|
*/
|
|
disconnectAbility(connection: number, callback:AsyncCallback<void>): void;
|
|
disconnectAbility(connection: number): Promise<void>;
|
|
|
|
/**
|
|
* Set mission label of current ability.
|
|
*
|
|
* @since 9
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
|
* @param label The label of ability that showed in recent missions.
|
|
* @StageModelOnly
|
|
*/
|
|
setMissionLabel(label: string, callback:AsyncCallback<void>): void;
|
|
setMissionLabel(label: string): Promise<void>;
|
|
|
|
/**
|
|
* Set mission icon of current ability.
|
|
*
|
|
* @since 9
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
|
* @param icon The icon of ability that showed in recent missions.
|
|
* @systemapi hide for inner use.
|
|
* @return -
|
|
* @StageModelOnly
|
|
*/
|
|
setMissionIcon(icon: image.PixelMap, callback:AsyncCallback<void>): void;
|
|
setMissionIcon(icon: image.PixelMap): Promise<void>;
|
|
|
|
/**
|
|
* Requests certain permissions from the system.
|
|
*
|
|
* @since 9
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
|
* @param permissions Indicates the list of permissions to be requested. This parameter cannot be null or empty.
|
|
* @return Returns the {@link PermissionRequestResult}.
|
|
* @StageModelOnly
|
|
*/
|
|
requestPermissionsFromUser(permissions: Array<string>, requestCallback: AsyncCallback<PermissionRequestResult>) : void;
|
|
requestPermissionsFromUser(permissions: Array<string>) : Promise<PermissionRequestResult>;
|
|
|
|
/**
|
|
* Restore window stage data in ability continuation
|
|
*
|
|
* @since 9
|
|
* @syscap SystemCapability.Ability.AbilityRuntime.Core
|
|
* @param contentStorage the storage data used to restore window stage
|
|
* @StageModelOnly
|
|
*/
|
|
restoreWindowStage(contentStorage: ContentStorage) : void;
|
|
|
|
} |