openharmony/interface_sdk-js
1
0
Fork 0
mirror of https://gitee.com/openharmony/interface_sdk-js synced 2025-04-17 12:41:05 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

IssueNo: #I5X5NZ

Browse Source 
Description: remove deprecated api9
Sig: SIG_ApplicationFramework
Feature or Bugfix: Feature
Binary Source: No

Signed-off-by: yangzk <yangzhongkai@huawei.com>
Change-Id: I2249e8978ab7dafc6b7128f23471b27147763f82
This commit is contained in:
yangzk 2022-12-14 11:13:53 +08:00
parent f35e23b4c6
commit 3c2adce7e8
45 changed files with 32 additions and 2341 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
api/@internal/component/ets/ability_component.d.ts vendored
View File

@ -25,7 +25,7 @@ interface AbilityComponentInterface {
* @since 9
* @systemapi
*/
(value: {want: import('../api/@ohos.application.Want').default}): AbilityComponentAttribute;
(value: {want: import('../api/@ohos.app.ability.Want').default}): AbilityComponentAttribute;
}
/**

2
api/@internal/component/ets/form_component.d.ts vendored
View File

@ -94,7 +94,7 @@ interface FormComponentInterface {
module: string;
dimension?: FormDimension;
temporary?: boolean;
want?: import('../api/@ohos.application.Want').default;
want?: import('../api/@ohos.app.ability.Want').default;
}): FormComponentAttribute;
}

4
api/@internal/ets/lifecycle.d.ts vendored
View File

@ -13,14 +13,14 @@
* limitations under the License.
*/
import Want from "../../@ohos.application.Want";
import Want from "../../@ohos.app.ability.Want";
import { ResultSet } from "../../data/rdb/resultSet";
import { AbilityInfo } from "../../bundle/abilityInfo";
import { DataAbilityResult } from "../../ability/dataAbilityResult";
import { DataAbilityOperation } from "../../ability/dataAbilityOperation";
import dataAbility from "../../@ohos.data.dataAbility";
import formBindingData from "../../@ohos.application.formBindingData";
import formInfo from "../../@ohos.application.formInfo";
import formInfo from "../../@ohos.app.form.formInfo";
import rdb from "../../@ohos.data.rdb";
import rpc from "../../@ohos.rpc";
import resourceManager from "../../@ohos.resourceManager";

2
api/@ohos.ability.featureAbility.d.ts vendored
View File

@ -15,7 +15,7 @@
import { AsyncCallback } from './basic';
import { Callback } from './basic';
import Want from './@ohos.application.Want';
import Want from './@ohos.app.ability.Want';
import { StartAbilityParameter } from './ability/startAbilityParameter';
import { AbilityResult } from './ability/abilityResult';
import { AppVersionInfo as _AppVersionInfo } from './app/appVersionInfo';

2
api/@ohos.ability.particleAbility.d.ts vendored
View File

@ -18,7 +18,7 @@ import { StartAbilityParameter } from './ability/startAbilityParameter';
import { DataAbilityHelper } from './ability/dataAbilityHelper';
import { NotificationRequest } from './notification/notificationRequest';
import { ConnectOptions } from './ability/connectOptions';
import Want from './@ohos.application.Want';
import Want from './@ohos.app.ability.Want';
/**
* A Particle Ability represents an ability with service.

2
api/@ohos.account.appAccount.d.ts vendored
View File

@ -14,7 +14,7 @@
*/
import { AsyncCallback, Callback } from './basic';
import Want from './@ohos.application.Want';
import Want from './@ohos.app.ability.Want';
import rpc from './@ohos.rpc'
/**

339
api/@ohos.application.Ability.d.ts vendored
View File

@ -1,339 +0,0 @@
/*
* 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 AbilityConstant from "./@ohos.app.ability.AbilityConstant";
import AbilityContext from "./application/AbilityContext";
import Want from './@ohos.application.Want';
import window from './@ohos.window';
import { Configuration } from './@ohos.application.Configuration';
import rpc from './@ohos.rpc';
/**
* The prototype of the listener function interface registered by the Caller.
*
* @since 9
* @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore
* @permission N/A
* @param msg Monitor status notification information.
* @returns -
* @StageModelOnly
* @deprecated since 9
* @useinstead ohos.app.ability.UIAbility
*/
export interface OnReleaseCallBack {
(msg: string): void;
}
/**
* The prototype of the message listener function interface registered by the Callee.
*
* @since 9
* @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore
* @permission N/A
* @param indata Notification data notified from the caller.
* @returns rpc.Sequenceable
* @StageModelOnly
* @deprecated since 9
* @useinstead ohos.app.ability.UIAbility
*/
export interface CalleeCallBack {
(indata: rpc.MessageParcel): rpc.Sequenceable;
}
/**
* The interface of a Caller.
*
* @since 9
* @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore
* @permission N/A
* @StageModelOnly
* @deprecated since 9
* @useinstead ohos.app.ability.UIAbility
*/
export interface Caller {
/**
* Notify the server of Sequenceable type data.
*
* @since 9
* @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore
* @param method The notification event string listened to by the callee.
* @param data Notification data to the callee.
* @returns -
* @StageModelOnly
*/
call(method: string, data: rpc.Sequenceable): Promise<void>;
/**
* Notify the server of Sequenceable type data and return the notification result.
*
* @since 9
* @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore
* @param method The notification event string listened to by the callee.
* @param data Notification data to the callee.
* @returns Returns the callee's notification result data on success, and returns undefined on failure.
* @StageModelOnly
*/
callWithResult(method: string, data: rpc.Sequenceable): Promise<rpc.MessageParcel>;
/**
* Clear service records.
*
* @since 9
* @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore
* @returns -
* @StageModelOnly
*/
release(): void;
/**
* Register death listener notification callback.
*
* @since 9
* @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore
* @param callback Register a callback function for listening for notifications.
* @returns -
* @StageModelOnly
*/
onRelease(callback: OnReleaseCallBack): void;
}
/**
* The interface of a Callee.
*
* @since 9
* @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore
* @permission N/A
* @StageModelOnly
* @deprecated since 9
* @useinstead ohos.app.ability.UIAbility
*/
export interface Callee {
/**
* Register data listener callback.
*
* @since 9
* @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore
* @param method A string registered to listen for notification events.
* @param callback Register a callback function that listens for notification events.
* @returns -
* @StageModelOnly
*/
on(method: string, callback: CalleeCallBack): void;
/**
* Unregister data listener callback.
*
* @since 9
* @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore
* @param method A string registered to listen for notification events.
* @returns -
* @StageModelOnly
*/
off(method: string): void;
}
/**
* The class of an ability.
*
* @since 9
* @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore
* @permission N/A
* @StageModelOnly
* @deprecated since 9
* @useinstead ohos.app.ability.UIAbility
*/
export default class Ability {
/**
* Indicates configuration information about an ability context.
*
* @since 9
* @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore
* @StageModelOnly
*/
context: AbilityContext;
/**
* Indicates ability launch want.
*
* @since 9
* @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore
* @StageModelOnly
*/
launchWant: Want;
/**
* Indicates ability last request want.
*
* @since 9
* @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore
* @StageModelOnly
*/
lastRequestWant: Want;
/**
* Call Service Stub Object.
*
* @since 9
* @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore
* @StageModelOnly
*/
callee: Callee;
/**
* Called back when an ability is started for initialization.
*
* @since 9
* @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore
* @param want Indicates the want info of the created ability.
* @param param Indicates the launch param.
* @returns -
* @StageModelOnly
*/
onCreate(want: Want, param: AbilityConstant.LaunchParam): void;
/**
* Called back when an ability window stage is created.
*
* @since 9
* @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore
* @param windowStage Indicates the created WindowStage.
* @returns -
* @StageModelOnly
*/
onWindowStageCreate(windowStage: window.WindowStage): void;
/**
* Called back when an ability window stage is destroyed.
*
* @since 9
* @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore
* @returns -
* @StageModelOnly
*/
onWindowStageDestroy(): void;
/**
* Called back when an ability window stage is restored.
*
* @since 9
* @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore
* @param windowStage window stage to restore
* @returns -
* @StageModelOnly
*/
onWindowStageRestore(windowStage: window.WindowStage): void;
/**
* Called back before an ability is destroyed.
*
* @since 9
* @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore
* @returns -
* @StageModelOnly
*/
onDestroy(): void;
/**
* Called back when the state of an ability changes to foreground.
*
* @since 9
* @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore
* @returns -
* @StageModelOnly
*/
onForeground(): void;
/**
* Called back when the state of an ability changes to background.
*
* @since 9
* @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore
* @returns -
* @StageModelOnly
*/
onBackground(): void;
/**
* Called back when an ability prepares to continue.
*
* @since 9
* @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore
* @param wantParam Indicates the want parameter.
* @returns 0 if ability agrees to continue and saves data successfully, otherwise errcode.
* @StageModelOnly
*/
onContinue(wantParam : {[key: string]: any}): AbilityConstant.OnContinueResult;
/**
* Called when the launch mode of an ability is set to singleton.
* This happens when you re-launch an ability that has been at the top of the ability stack.
*
* @since 9
* @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore
* @param want Indicates the want info of ability.
* @param launchParams Indicates the launch parameters.
* @returns -
* @StageModelOnly
*/
onNewWant(want: Want, launchParams: AbilityConstant.LaunchParam): void;
/**
* Called when the system configuration is updated.
*
* @since 9
* @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore
* @param config Indicates the updated configuration.
* @returns -
* @StageModelOnly
*/
onConfigurationUpdated(config: Configuration): void;
/**
* Called when dump client information is required.
* It is recommended that developers don't DUMP sensitive information.
*
* @since 9
* @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore
* @param params Indicates the params from command.
* @returns The dump info array.
* @StageModelOnly
*/
dump(params: Array<string>): Array<string>;
/**
* Called when the system has determined to trim the memory, for example, when the ability is running in the
* background and there is no enough memory for running as many background processes as possible.
*
* @since 9
* @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore
* @param level Indicates the memory trim level, which shows the current memory usage status.
* @returns -
* @StageModelOnly
*/
onMemoryLevel(level: AbilityConstant.MemoryLevel): void;
/**
* Called back when an ability prepares to save.
*
* @since 9
* @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore
* @param reason state type when save.
* @param wantParam Indicates the want parameter.
* @returns 0 if ability agrees to save data successfully, otherwise errcode.
* @StageModelOnly
*/
onSaveState(reason: AbilityConstant.StateType, wantParam : {[key: string]: any}): AbilityConstant.OnSaveResult;
}

123
api/@ohos.application.AbilityLifecycleCallback.d.ts vendored
View File

@ -1,123 +0,0 @@
/*
* 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 Ability from "./@ohos.application.Ability";
import dataAbility from "./@ohos.data.dataAbility";
import window from './@ohos.window';
/**
* The ability lifecycle callback.
*
* @since 9
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @permission N/A
* @deprecated since 9
* @useinstead ohos.app.ability.AbilityLifecycleCallback
*/
export default class AbilityLifecycleCallback {
/**
* Called back when an ability is started for initialization.
*
* @since 9
* @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore
* @param ability: Indicates the ability to register for listening.
* @StageModelOnly
*/
onAbilityCreate(ability: Ability): void;
/**
* Called back when a window stage is created.
*
* @since 9
* @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore
* @param ability: Indicates the ability to register for listening.
* @param windowStage window stage to create
* @StageModelOnly
*/
onWindowStageCreate(ability: Ability, windowStage: window.WindowStage): void;
/**
* Called back when a window stage is actived.
*
* @since 9
* @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore
* @param ability: Indicates the ability to register for listening.
* @param windowStage window stage to active
* @StageModelOnly
*/
onWindowStageActive(ability: Ability, windowStage: window.WindowStage): void;
/**
* Called back when a window stage is inactived.
*
* @since 9
* @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore
* @param ability: Indicates the ability to register for listening.
* @param windowStage window stage to inactive
* @StageModelOnly
*/
onWindowStageInactive(ability: Ability, windowStage: window.WindowStage): void;
/**
* Called back when a window stage is destroyed.
*
* @since 9
* @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore
* @param ability: Indicates the ability to register for listening.
* @param windowStage window stage to destroy
* @StageModelOnly
*/
onWindowStageDestroy(ability: Ability, windowStage: window.WindowStage): void;
/**
* Called back when an ability is destroyed.
*
* @since 9
* @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore
* @param ability: Indicates the ability to register for listening.
* @StageModelOnly
*/
onAbilityDestroy(ability: Ability): void;
/**
* Called back when the state of an ability changes to foreground.
*
* @since 9
* @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore
* @param ability: Indicates the ability to register for listening.
* @StageModelOnly
*/
onAbilityForeground(ability: Ability): void;
/**
* Called back when the state of an ability changes to background.
*
* @since 9
* @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore
* @param ability: Indicates the ability to register for listening.
* @StageModelOnly
*/
onAbilityBackground(ability: Ability): void;
/**
* Called back when an ability prepares to continue.
*
* @since 9
* @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore
* @param ability: Indicates the ability to register for listening.
* @StageModelOnly
*/
onAbilityContinue(ability: Ability): void;
}

86
api/@ohos.application.AbilityStage.d.ts vendored
View File

@ -1,86 +0,0 @@
/*
* 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 AbilityConstant from "./@ohos.app.ability.AbilityConstant";
import AbilityStageContext from "./application/AbilityStageContext";
import Want from './@ohos.application.Want';
import { Configuration } from './@ohos.application.Configuration';
/**
* The class of an ability stage.
*
* @since 9
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @permission N/A
* @StageModelOnly
* @deprecated since 9
* @useinstead ohos.app.ability.AbilityStage
*/
export default class AbilityStage {
/**
* Indicates configuration information about context.
*
* @since 9
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @StageModelOnly
*/
context: AbilityStageContext;
/**
* Called back when an ability stage is started for initialization.
*
* @since 9
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @returns -
* @StageModelOnly
*/
onCreate(): void;
/**
* Called back when start specified ability.
*
* @since 9
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @param want Indicates the want info of started ability.
* @returns The user returns an ability string ID. If the ability of this ID has been started before,
* do not create a new instance and pull it back to the top of the stack.
* Otherwise, create a new instance and start it.
* @StageModelOnly
*/
onAcceptWant(want: Want): string;
/**
* Called when the system configuration is updated.
*
* @since 9
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @param config Indicates the updated configuration.
* @returns -
* @StageModelOnly
*/
onConfigurationUpdated(config: Configuration): void;
/**
* Called when the system has determined to trim the memory, for example, when the ability is running in the
* background and there is no enough memory for running as many background processes as possible.
*
* @since 9
* @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore
* @param level Indicates the memory trim level, which shows the current memory usage status.
* @returns -
* @StageModelOnly
*/
onMemoryLevel(level: AbilityConstant.MemoryLevel): void;
}

32
api/@ohos.application.Configuration.d.ts vendored
View File

@ -41,36 +41,4 @@ export interface Configuration {
* @syscap SystemCapability.Ability.AbilityBase
*/
colorMode?: ConfigurationConstant.ColorMode;
/**
* Indicates the screen direction of the current device.
*
* @since 9
* @syscap SystemCapability.Ability.AbilityBase
*/
direction?: ConfigurationConstant.Direction;
/**
* Indicates the screen density of the current device.
*
* @since 9
* @syscap SystemCapability.Ability.AbilityBase
*/
screenDensity?: ConfigurationConstant.ScreenDensity;
/**
* Indicates the displayId of the current device.
*
* @since 9
* @syscap SystemCapability.Ability.AbilityBase
*/
displayId?: number;
/**
* Indicates whether a pointer type device has connected.
*
* @since 9
* @syscap SystemCapability.Ability.AbilityBase
*/
hasPointerDevice?: boolean;
}

28
api/@ohos.application.ConfigurationConstant.d.ts vendored
View File

@ -34,34 +34,6 @@
COLOR_MODE_DARK = 0,
COLOR_MODE_LIGHT = 1,
}
/**
* @name Direction
* @since 9
* @syscap SystemCapability.Ability.AbilityBase
* @permission N/A
*/
export enum Direction {
DIRECTION_NOT_SET = -1,
DIRECTION_VERTICAL = 0,
DIRECTION_HORIZONTAL = 1,
}
/**
* @name ScreenDensity
* @since 9
* @syscap SystemCapability.Ability.AbilityBase
* @permission N/A
*/
export enum ScreenDensity {
SCREEN_DENSITY_NOT_SET = 0,
SCREEN_DENSITY_SDPI = 120,
SCREEN_DENSITY_MDPI = 160,
SCREEN_DENSITY_LDPI = 240,
SCREEN_DENSITY_XLDPI = 320,
SCREEN_DENSITY_XXLDPI = 480,
SCREEN_DENSITY_XXXLDPI = 640,
}
}
export default ConfigurationConstant

2
api/@ohos.application.DataShareExtensionAbility.d.ts vendored
View File

@ -15,7 +15,7 @@
import { AsyncCallback } from "./basic";
import ExtensionContext from "./application/ExtensionContext";
import Want from './@ohos.application.Want';
import Want from './@ohos.app.ability.Want';
import dataSharePredicates from './@ohos.data.dataSharePredicates';
import { ValuesBucket } from './@ohos.data.ValuesBucket';

37
api/@ohos.application.EnvironmentCallback.d.ts vendored
View File

@ -1,37 +0,0 @@
/*
* 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 { Configuration } from './@ohos.application.Configuration';
/**
* The environment callback.
*
* @since 9
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @permission N/A
* @deprecated since 9
* @useinstead ohos.app.ability.EnvironmentCallback
*/
export default class EnvironmentCallback {
/**
* Called when the system configuration is updated.
*
* @since 9
* @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore
* @param config: Indicates the updated configuration.
* @StageModelOnly
*/
onConfigurationUpdated(config: Configuration): void;
}

51
api/@ohos.application.ExtensionAbility.d.ts vendored
View File

@ -1,51 +0,0 @@
/*
* 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 AbilityConstant from "./@ohos.app.ability.AbilityConstant";
import { Configuration } from './@ohos.application.Configuration';
/**
* class of extension.
*
* @since 9
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @StageModelOnly
* @deprecated since 9
* @useinstead ohos.app.ability.ExtensionAbility
*/
export default class ExtensionAbility {
/**
* Called when the system configuration is updated.
*
* @since 9
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @param newConfig Indicates the updated configuration.
* @returns -
* @StageModelOnly
*/
onConfigurationUpdated(newConfig: Configuration): void;
/**
* Called when the system has determined to trim the memory, for example, when the ability is running in the
* background and there is no enough memory for running as many background processes as possible.
*
* @since 9
* @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore
* @param level Indicates the memory trim level, which shows the current memory usage status.
* @returns -
* @StageModelOnly
*/
onMemoryLevel(level: AbilityConstant.MemoryLevel): void;
}

156
api/@ohos.application.FormExtension.d.ts vendored
View File

@ -1,156 +0,0 @@
/*
* 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 formBindingData from './@ohos.app.form.formBindingData';
import formInfo from "./@ohos.application.formInfo";
import FormExtensionContext from "./application/FormExtensionContext";
import Want from './@ohos.application.Want';
import { Configuration } from './@ohos.application.Configuration';
/**
* class of form extension.
*
* @since 9
* @syscap SystemCapability.Ability.Form
* @StageModelOnly
* @deprecated since 9
* @useinstead ohos.app.form.FormExtensionAbility
*/
export default class FormExtension {
/**
* Indicates form extension context.
*
* @since 9
* @syscap SystemCapability.Ability.Form
* @StageModelOnly
*/
context: FormExtensionContext;
/**
* Called to return a {@link formBindingData#FormBindingData} object.
*
* @since 9
* @syscap SystemCapability.Ability.Form
* @param want Indicates the detailed information for creating a {@link formBindingData#FormBindingData}.
* The {@code Want} object must include the form ID, form name, and grid style of the form.
* Such form information must be managed as persistent data for further form
* acquisition, update, and deletion.
* @returns Returns the created {@link formBindingData#FormBindingData} object.
* @StageModelOnly
*/
onCreate(want: Want): formBindingData.FormBindingData;
/**
* Called when the form provider is notified that a temporary form is successfully converted to a normal form.
*
* @since 9
* @syscap SystemCapability.Ability.Form
* @param formId Indicates the ID of the form.
* @returns -
* @StageModelOnly
*/
onCastToNormal(formId: string): void;
/**
* Called to notify the form provider to update a specified form.
*
* @since 9
* @syscap SystemCapability.Ability.Form
* @param formId Indicates the ID of the form to update.
* @returns -
* @StageModelOnly
*/
onUpdate(formId: string): void;
/**
* Called when the form provider receives form events from the system.
*
* @since 9
* @syscap SystemCapability.Ability.Form
* @param newStatus Indicates the form events occurred. The key in the {@code Map} object indicates the form ID,
* and the value indicates the event type, which can be either {@link formInfo#VisibilityType#FORM_VISIBLE}
* or {@link formInfo#VisibilityType#FORM_INVISIBLE}. {@link formInfo#VisibilityType#FORM_VISIBLE}
* means that the form becomes visible, and {@link formInfo#VisibilityType#FORM_INVISIBLE}
* means that the form becomes invisible.
* @returns -
* @StageModelOnly
*/
onVisibilityChange(newStatus: { [key: string]: number }): void;
/**
* Called when a specified message event defined by the form provider is triggered. This method is valid only for
* JS forms.
*
* @since 9
* @syscap SystemCapability.Ability.Form
* @param formId Indicates the ID of the form on which the message event is triggered, which is provided by
* the client to the form provider.
* @param message Indicates the value of the {@code params} field of the message event. This parameter is
* used to identify the specific component on which the event is triggered.
* @returns -
* @StageModelOnly
*/
onEvent(formId: string, message: string): void;
/**
* Called to notify the form provider that a specified form has been destroyed. Override this method if
* you want your application, as the form provider, to be notified of form deletion.
*
* @since 9
* @syscap SystemCapability.Ability.Form
* @param formId Indicates the ID of the destroyed form.
* @returns -
* @StageModelOnly
*/
onDestroy(formId: string): void;
/**
* Called when the system configuration is updated.
*
* @since 9
* @syscap SystemCapability.Ability.Form
* @param configuration Indicates the system configuration, such as language and color mode.
* @returns -
* @StageModelOnly
*/
onConfigurationUpdated(config: Configuration): void;
/**
* Called to return a {@link FormState} object.
*
* <p>You must override this callback if you want this ability to return the actual form state. Otherwise,
* this method returns {@link FormState#DEFAULT} by default.</p>
*
* @since 9
* @syscap SystemCapability.Ability.Form
* @param want Indicates the description of the form for which the {@link formInfo#FormState} is obtained.
* The description covers the bundle name, ability name, module name, form name, and form dimensions.
* @returns Returns the {@link formInfo#FormState} object.
* @StageModelOnly
*/
onAcquireFormState?(want: Want): formInfo.FormState;
/**
* Called when the system shares the form.
*
* @since 9
* @syscap SystemCapability.Ability.Form
* @param formId Indicates the ID of the form.
* @systemapi hide for inner use.
* @returns Returns the wantParams object.
* @StageModelOnly
*/
onShare?(formId: string): {[key: string]: any};
}

140
api/@ohos.application.ServiceExtensionAbility.d.ts vendored
View File

@ -1,140 +0,0 @@
/*
* 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 rpc from "./@ohos.rpc";
import ServiceExtensionContext from "./application/ServiceExtensionContext";
import Want from './@ohos.application.Want';
import { Configuration } from './@ohos.application.Configuration';
/**
* class of service extension ability.
*
* @since 9
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @systemapi hide for inner use.
* @StageModelOnly
* @deprecated since 9
* @useinstead ohos.app.ability.ServiceExtensionAbility
*/
export default class ServiceExtensionAbility {
/**
* Indicates service extension ability context.
*
* @since 9
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @systemapi hide for inner use.
* @StageModelOnly
*/
context: ServiceExtensionContext;
/**
* Called back when a service extension is started for initialization.
*
* @since 9
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @param want Indicates the want of created service extension.
* @systemapi hide for inner use.
* @returns -
* @StageModelOnly
*/
onCreate(want: Want): void;
/**
* Called back before a service extension is destroyed.
*
* @since 9
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @systemapi hide for inner use.
* @returns -
* @StageModelOnly
*/
onDestroy(): void;
/**
* Called back when a service extension is started.
*
* @since 9
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @param want Indicates the want of service extension to start.
* @param startId Indicates the number of times the service extension has been started. The {@code startId} is
* incremented by 1 every time the service extension is started. For example, if the service extension
* has been started for six times.
* @systemapi hide for inner use.
* @returns -
* @StageModelOnly
*/
onRequest(want: Want, startId: number): void;
/**
* Called back when a service extension is first connected to an ability.
*
* @since 9
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @param want Indicates connection information about the Service ability.
* @systemapi hide for inner use.
* @returns Returns the proxy of the Service ability.
* @StageModelOnly
*/
onConnect(want: Want): rpc.RemoteObject;
/**
* Called back when all abilities connected to a service extension are disconnected.
*
* @since 9
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @param want Indicates disconnection information about the service extension.
* @systemapi hide for inner use.
* @returns -
* @StageModelOnly
*/
onDisconnect(want: Want): void;
/**
* Called when a new client attempts to connect to a service extension after all previous client connections to it
* are disconnected.
*
* @since 9
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @param want Indicates the want of the service extension being connected.
* @systemapi hide for inner use.
* @returns -
* @StageModelOnly
*/
onReconnect(want: Want): void;
/**
* Called when the system configuration is updated.
*
* @since 9
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @param config Indicates the updated configuration.
* @returns -
* @StageModelOnly
*/
onConfigurationUpdated(config: Configuration): void;
/**
* Called when dump client information is required.
* It is recommended that developers don't DUMP sensitive information.
*
* @since 9
* @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore
* @param params Indicates the params from command.
* @returns The dump info array.
* @StageModelOnly
*/
dump(params: Array<string>): Array<string>;
}

45
api/@ohos.application.StartOptions.d.ts vendored
View File

@ -1,45 +0,0 @@
/*
* Copyright (c) 2021 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.
*/
/**
* StartOptions is the basic communication component of the system.
*
* @name StartOptions
* @since 9
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @permission N/A
* @StageModelOnly
* @deprecated since 9
* @useinstead ohos.app.ability.StartOptions
*/
export default class StartOptions {
/**
* windowMode
* @default -
* @since 9
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @StageModelOnly
*/
windowMode?: number;
/**
* displayId
* @default -
* @since 9
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @StageModelOnly
*/
displayId?: number;
}

8
api/@ohos.application.Want.d.ts vendored
View File

@ -95,12 +95,4 @@ export default class Want {
* @default -
*/
entities?: Array<string>;
/**
* The description of an module name in an want.
* @since 9
* @syscap SystemCapability.Ability.AbilityBase
* @default -
*/
moduleName?: string;
}

2
api/@ohos.application.WindowExtensionAbility.d.ts vendored
View File

@ -15,7 +15,7 @@
import rpc from "./@ohos.rpc";
import ExtensionContext from "./application/ExtensionContext";
import Want from './@ohos.application.Want';
import Want from './@ohos.app.ability.Want';
import window from './@ohos.window';
/**

24
api/@ohos.application.abilityManager.d.ts vendored
View File

@ -70,30 +70,6 @@ declare namespace abilityManager {
function getAbilityRunningInfos(): Promise<Array<AbilityRunningInfo>>;
function getAbilityRunningInfos(callback: AsyncCallback<Array<AbilityRunningInfo>>): void;
/**
* Get information about running extensions
*
* @since 9
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @param upperLimit Get the maximum limit of the number of messages
* @systemapi Hide this for inner system use.
* @returns Returns the array of {@link ExtensionRunningInfo}.
* @permission ohos.permission.GET_RUNNING_INFO
*/
function getExtensionRunningInfos(upperLimit: number): Promise<Array<ExtensionRunningInfo>>;
function getExtensionRunningInfos(upperLimit: number, callback: AsyncCallback<Array<ExtensionRunningInfo>>): void;
/**
* Get the top ability information of the display.
*
* @since 9
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @systemapi Hide this for inner system use.
* @returns Returns the {@link ElementName} info of the top ability.
*/
function getTopAbility(): Promise<ElementName>;
function getTopAbility(callback: AsyncCallback<ElementName>): void;
/**
* The class of an ability running information.
*

56
api/@ohos.application.appManager.d.ts vendored
View File

@ -30,37 +30,6 @@ import { ProcessRunningInformation as _ProcessRunningInformation } from './appli
* @useinstead ohos.app.ability.appManager
*/
declare namespace appManager {
/**
* @name ApplicationState
* @since 9
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @systemapi Hide this for inner system use.
* @permission N/A
*/
export enum ApplicationState {
STATE_CREATE,
STATE_FOREGROUND,
STATE_ACTIVE,
STATE_BACKGROUND,
STATE_DESTROY
}
/**
* @name ProcessState
* @since 9
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @systemapi Hide this for inner system use.
* @permission N/A
*/
export enum ProcessState {
STATE_CREATE,
STATE_FOREGROUND,
STATE_ACTIVE,
STATE_BACKGROUND,
STATE_DESTROY
}
/**
* Register application state observer.
*
@ -74,20 +43,6 @@ declare namespace appManager {
*/
function registerApplicationStateObserver(observer: ApplicationStateObserver): number;
/**
* Register application state observer.
*
* @default -
* @since 9
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @param observer The application state observer.
* @param bundleNameList The list of bundleName. The max length is 128.
* @systemapi
* @returns Returns the number code of the observer.
* @permission ohos.permission.RUNNING_STATE_OBSERVER
*/
function registerApplicationStateObserver(observer: ApplicationStateObserver, bundleNameList: Array<string>): number;
/**
* Unregister application state observer.
*
@ -190,17 +145,6 @@ declare namespace appManager {
function getAppMemorySize(): Promise<number>;
function getAppMemorySize(callback: AsyncCallback<number>): void;
/**
* Get information about running processes
*
* @since 9
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @returns Returns the array of {@link ProcessRunningInformation}.
* @permission ohos.permission.GET_RUNNING_INFO
*/
function getProcessRunningInformation(): Promise<Array<ProcessRunningInformation>>;
function getProcessRunningInformation(callback: AsyncCallback<Array<ProcessRunningInformation>>): void;
/**
* The ability or extension state data.
*

122
api/@ohos.application.context.d.ts vendored
View File

@ -1,122 +0,0 @@
/*
* 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 * as _AbilityContext from './application/AbilityContext';
import * as _AbilityStageContext from './application/AbilityStageContext';
import * as _ApplicationContext from './application/ApplicationContext';
import * as _BaseContext from './application/BaseContext';
import * as _Context from './application/Context';
import * as _ExtensionContext from './application/ExtensionContext';
import * as _FormExtensionContext from './application/FormExtensionContext';
import * as _EventHub from './application/EventHub';
import * as _PermissionRequestResult from './application/PermissionRequestResult';
/**
* The context of an application. It allows access to application-specific resources.
*
* @since 9
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @StageModelOnly
* @deprecated since 9
* @useinstead ohos.app.ability.common
*/
declare namespace context {
/**
* The context of an ability. It allows access to ability-specific resources.
*
* @since 9
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @StageModelOnly
*/
export type AbilityContext = _AbilityContext.default
/**
* The context of an abilityStage. It allows access to abilityStage-specific resources.
*
* @since 9
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @StageModelOnly
*/
export type AbilityStageContext = _AbilityStageContext.default
/**
* The context of an application. It allows access to application-specific resources.
*
* @since 9
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @StageModelOnly
*/
export type ApplicationContext = _ApplicationContext.default
/**
* The base context of 'app.Context' for FA Mode or
* 'application.Context' for Stage Mode.
*
* @since 9
* @syscap SystemCapability.Ability.AbilityRuntime.Core
*/
export type BaseContext = _BaseContext.default
/**
* The base context of an ability or an application. It allows access to
* application-specific resources.
*
* @since 9
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @StageModelOnly
*/
export type Context = _Context.default
/**
* The context of an extension. It allows access to extension-specific resources.
*
* @since 9
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @StageModelOnly
*/
export type ExtensionContext = _ExtensionContext.default
/**
* The context of form extension. It allows access to
* formExtension-specific resources.
*
* @since 9
* @syscap SystemCapability.Ability.Form
* @StageModelOnly
*/
export type FormExtensionContext = _FormExtensionContext.default
/**
* The event center of a context, support the subscription and publication of events.
*
* @since 9
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @StageModelOnly
*/
export type EventHub = _EventHub.default
/**
* The result of requestPermissionsFromUser with asynchronous callback.
*
* @since 9
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @StageModelOnly
* @deprecated since 9
*/
export type PermissionRequestResult = _PermissionRequestResult.default
}
export default context;

60
api/@ohos.application.errorManager.d.ts vendored
View File

@ -1,60 +0,0 @@
/*
* 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 } from './basic';
import * as _ErrorObserver from './application/ErrorObserver';
/**
* This module provides the function of error manager.
*
* @since 9
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @permission N/A
* @deprecated since 9
* @useinstead ohos.app.ability.errorManager
*/
declare namespace errorManager {
/**
* Register error observer.
*
* @default -
* @since 9
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @param observer The error observer.
* @returns Returns the number code of the observer.
*/
function registerErrorObserver(observer: ErrorObserver): number;
/**
* Unregister error observer.
*
* @since 9
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @param observerId Indicates the number code of the observer.
* @returns -
*/
function unregisterErrorObserver(observerId: number, callback: AsyncCallback<void>): void;
function unregisterErrorObserver(observerId: number): Promise<void>;
/**
* The observer will be called by system when an error occurs.
*
* @since 9
* @syscap SystemCapability.Ability.AbilityRuntime.Core
*/
export type ErrorObserver = _ErrorObserver.default
}
export default errorManager;

32
api/@ohos.application.formHost.d.ts vendored
View File

@ -15,8 +15,8 @@
import { AsyncCallback } from "./basic";
import { Callback } from "./basic";
import Want from './@ohos.application.Want';
import formInfo from './@ohos.application.formInfo'
import Want from './@ohos.app.ability.Want';
import formInfo from './@ohos.app.form.formInfo'
/**
* interface of formHost.
@ -269,33 +269,5 @@ declare namespace formHost {
*/
function notifyFormsEnableUpdate(formIds: Array<string>, isEnableUpdate: boolean, callback: AsyncCallback<void>): void;
function notifyFormsEnableUpdate(formIds: Array<string>, isEnableUpdate: boolean): Promise<void>;
/**
* Share form by formId and deviceId.
*
* @since 9
* @syscap SystemCapability.Ability.Form
* @param formId Indicates the form ID
* @param deviceId Indicates the remote device ID
* @systemapi hide for inner use.
* @returns -
* @permission ohos.permission.REQUIRE_FORM
*/
function shareForm(formId: string, deviceId: string, callback: AsyncCallback<void>): void;
function shareForm(formId: string, deviceId: string): Promise<void>;
/**
* Notify form that privacy wether need to be protected.
*
* @since 9
* @syscap SystemCapability.Ability.Form
* @param formIds Indicates the specified form id.
* @param isProtected Indicates whether enable update.
* @systemapi hide for inner use.
* @returns -
* @permission ohos.permission.REQUIRE_FORM
*/
function notifyFormsPrivacyProtected(formIds: Array<string>, isProtected: boolean, callback: AsyncCallback<void>): void;
function notifyFormsPrivacyProtected(formIds: Array<string>, isProtected: boolean): Promise<void>;
}
export default formHost;

145
api/@ohos.application.formInfo.d.ts vendored
View File

@ -13,7 +13,7 @@
* limitations under the License.
*/
import Want from './@ohos.application.Want';
import Want from './@ohos.app.ability.Want';
/**
* interface of formInfo.
@ -192,15 +192,7 @@ declare namespace formInfo {
* @since 8
* @syscap SystemCapability.Ability.Form
*/
JS = 1,
/**
* eTS form.
*
* @since 9
* @syscap SystemCapability.Ability.Form
*/
eTS = 2
JS = 1
}
/**
@ -314,17 +306,6 @@ declare namespace formInfo {
* @syscap SystemCapability.Ability.Form
* @systemapi hide for inner use.
*/
/**
* Indicates the key specifying the ID of the form to be obtained, which is represented as
* want: {
* "parameters": {
* IDENTITY_KEY: "119476135"
* }
* }.
*
* @since 9
* @syscap SystemCapability.Ability.Form
*/
IDENTITY_KEY = "ohos.extra.param.key.form_identity",
/**
@ -405,127 +386,7 @@ declare namespace formInfo {
* @since 8
* @syscap SystemCapability.Ability.Form
*/
TEMPORARY_KEY = "ohos.extra.param.key.form_temporary",
/**
* Indicates the key specifying the name of the bundle to be obtained, which is represented as
* want: {
* "parameters": {
* BUNDLE_NAME_KEY: "bundleName"
* }
* }
*
* @since 9
* @syscap SystemCapability.Ability.Form
*/
BUNDLE_NAME_KEY = "ohos.extra.param.key.bundle_name",
/**
* Indicates the key specifying the name of the ability to be obtained, which is represented as
* want: {
* "parameters": {
* ABILITY_NAME_KEY: "abilityName"
* }
* }
*
* @since 9
* @syscap SystemCapability.Ability.Form
*/
ABILITY_NAME_KEY = "ohos.extra.param.key.ability_name",
/**
* Indicates the key specifying the the device ID, which is represented as
* want: {
* "parameters": {
* DEVICE_ID_KEY : "EFC11C0C53628D8CC2F8CB5052477E130D075917034613B9884C55CD22B3DEF2"
* }
* }
*
* @since 9
* @syscap SystemCapability.Ability.Form
* @systemapi hide for inner use.
*/
DEVICE_ID_KEY = "ohos.extra.param.key.device_id"
}
/**
* The optional options used as filters to ask
* getFormsInfo to return formInfos from only forms that match the options.
*
* @name FormInfoFilter
*
* @since 9
* @syscap SystemCapability.Ability.Form
*/
interface FormInfoFilter {
/**
* optional moduleName that used to ask getFormsInfo to return
* form infos with the same moduleName.
*
* @since 9
* @syscap SystemCapability.Ability.Form
*/
moduleName?: string;
}
/**
* Defines the FormDimension enum.
*
* @since 9
* @syscap SystemCapability.Ability.Form
*/
enum FormDimension {
/**
* 1 x 2 form
* @since 9
*/
Dimension_1_2 = 1,
/**
* 2 x 2 form
* @since 9
*/
Dimension_2_2,
/**
* 2 x 4 form
* @since 9
*/
Dimension_2_4,
/**
* 4 x 4 form
* @since 9
*/
Dimension_4_4,
/**
* 2 x 1 form
* @since 9
*/
Dimension_2_1,
}
/**
* The visibility of a form.
*
* @since 9
* @syscap SystemCapability.Ability.Form
*/
enum VisibilityType {
/**
* Indicates the type of the form is visible.
* Often used as a condition variable in function OnVisibilityChange() to specify actions only on forms that are
* changing to visible.
* @since 9
*/
FORM_VISIBLE = 1,
/**
* Indicates the type of the form is invisible.
* Often used as a condition variable in function OnVisibilityChange() to specify actions only on forms that are
* changing to invisible.
* @since 9
*/
FORM_INVISIBLE,
TEMPORARY_KEY = "ohos.extra.param.key.form_temporary"
}
}
export default formInfo;

44
api/@ohos.application.formProvider.d.ts vendored
View File

@ -15,8 +15,8 @@
import { AsyncCallback } from "./basic";
import formBindingData from "./@ohos.application.formBindingData";
import formInfo from "./@ohos.application.formInfo";
import Want from './@ohos.application.Want';
import formInfo from "./@ohos.app.form.formInfo";
import Want from './@ohos.app.ability.Want';
/**
* interface of formProvider.
@ -55,45 +55,5 @@ declare namespace formProvider {
callback: AsyncCallback<void>): void;
function updateForm(formId: string, formBindingData: formBindingData.FormBindingData): Promise<void>;
/**
* Get infos of all forms belonging to current bundle.
*
* Client to communication with FormManagerService.
*
* @since 9
* @syscap SystemCapability.Ability.Form
* @param filter Indicates the requirements the forms that the formInfos belong to have to meet.
* @returns Infos of all forms.
*/
function getFormsInfo(filter: formInfo.FormInfoFilter, callback: AsyncCallback<Array<formInfo.FormInfo>>): void;
function getFormsInfo(callback: AsyncCallback<Array<formInfo.FormInfo>>): void;
function getFormsInfo(filter?: formInfo.FormInfoFilter): Promise<Array<formInfo.FormInfo>>;
/**
* Request to publish a form to the form host.
*
* @since 9
* @syscap SystemCapability.Ability.Form
* @param want The want of the form to publish
* @param formBindingData Indicates the form data
* @systemapi hide for inner use
* @returns Returns form id
*/
function requestPublishForm(want: Want, formBindingData: formBindingData.FormBindingData,
callback: AsyncCallback<string>): void;
function requestPublishForm(want: Want, callback: AsyncCallback<string>): void;
function requestPublishForm(want: Want, formBindingData?: formBindingData.FormBindingData): Promise<string>;
/**
* Check if the request of publishing a form is supported by the host
*
* @since 9
* @syscap SystemCapability.Ability.Form
* @systemapi hide for inner use
* @returns Returns true if the request is supported and false otherwise
*/
function isRequestPublishFormSupported(callback: AsyncCallback<boolean>): void;
function isRequestPublishFormSupported(): Promise<boolean>;
}
export default formProvider;

14
api/@ohos.application.missionManager.d.ts vendored
View File

@ -17,7 +17,7 @@ import { AsyncCallback } from './basic';
import { MissionInfo as _MissionInfo } from './application/MissionInfo';
import { MissionListener as _MissionListener } from './application/MissionListener';
import { MissionSnapshot as _MissionSnapshot } from './application/MissionSnapshot';
import StartOptions from "./@ohos.application.StartOptions";
import StartOptions from "./@ohos.app.ability.StartOptions";
/**
* This module provides the capability to manage abilities and obtaining system task information.
@ -88,18 +88,6 @@ declare namespace missionManager {
function getMissionSnapShot(deviceId: string, missionId: number, callback: AsyncCallback<MissionSnapshot>): void;
function getMissionSnapShot(deviceId: string, missionId: number): Promise<MissionSnapshot>;
/**
* Get the mission low resolution snapshot with the given missionId.
*
* @since 9
* @syscap SystemCapability.Ability.AbilityRuntime.Mission
* @param deviceId Indicates the device to be queried.
* @param missionId Indicates mission id to be queried.
* @returns The {@link MissionSnapshot} of the given id.
*/
function getLowResolutionMissionSnapShot(deviceId: string, missionId: number, callback: AsyncCallback<MissionSnapshot>): void;
function getLowResolutionMissionSnapShot(deviceId: string, missionId: number): Promise<MissionSnapshot>;
/**
* Lock the mission.
*

2
api/@ohos.bundle.d.ts vendored
View File

@ -17,7 +17,7 @@ import { AsyncCallback } from './basic';
import { ApplicationInfo } from './bundle/applicationInfo';
import { AbilityInfo } from './bundle/abilityInfo';
import { PermissionDef } from './bundle/PermissionDef';
import Want from './@ohos.application.Want';
import Want from './@ohos.app.ability.Want';
import image from './@ohos.multimedia.image';
import { BundleInfo } from './bundle/bundleInfo';
import { BundleInstaller } from './bundle/bundleInstaller';

2
api/@ohos.data.fileAccess.d.ts vendored
View File

@ -14,7 +14,7 @@
*/
import { AsyncCallback, Callback } from "./basic";
import Want from './@ohos.application.Want';
import Want from './@ohos.app.ability.Want';
import Context from './application/Context';
import { Filter } from './@ohos.fileio';

81
api/@ohos.notification.d.ts vendored
View File

@ -81,22 +81,6 @@ declare namespace notification {
function publish(request: NotificationRequest, userId: number, callback: AsyncCallback<void>): void;
function publish(request: NotificationRequest, userId: number): Promise<void>;
/**
* Publishes a representative notification.
*
* @since 9
* @param request a notification.
* @param representativeBundle bundle name of the representative
* @param userId userid of the representative
* @systemapi Hide this for inner system use.
* @permission ohos.permission.NOTIFICATION_CONTROLLER and ohos.permission.NOTIFICATION_AGENT_CONTROLLER
* @deprecated since 9
* @useinstead ohos.notificationManager.publishAsBundle
*
*/
function publishAsBundle(request: NotificationRequest, representativeBundle: string, userId: number, callback: AsyncCallback<void>): void;
function publishAsBundle(request: NotificationRequest, representativeBundle: string, userId: number): Promise<void>;
/**
* Cancel a notification with the specified ID.
*
@ -119,22 +103,6 @@ declare namespace notification {
function cancel(id: number, label: string, callback: AsyncCallback<void>): void;
function cancel(id: number, label?: string): Promise<void>;
/**
* Cancel a representative notification.
*
* @since 9
* @param id ID of the notification to cancel, which must be unique in the application.
* @param representativeBundle bundle name of the representative
* @param userId userid of the representative
* @param callback callback function
* @systemapi Hide this for inner system use.
* @permission ohos.permission.NOTIFICATION_CONTROLLER and ohos.permission.NOTIFICATION_AGENT_CONTROLLER
* @deprecated since 9
* @useinstead ohos.notificationManager.cancelAsBundle
*/
function cancelAsBundle(id: number, representativeBundle: string, userId: number, callback: AsyncCallback<void>): void;
function cancelAsBundle(id: number, representativeBundle: string, userId: number): Promise<void>;
/**
* Cancels all notifications of the current application.
* @deprecated since 9
@ -859,54 +827,6 @@ declare namespace notification {
function getDeviceRemindType(callback: AsyncCallback<DeviceRemindType>): void;
function getDeviceRemindType(): Promise<DeviceRemindType>;
/**
* Set whether the application slot is enabled.
*
* @since 9
* @systemapi Hide this for inner system use.
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @deprecated since 9
* @useinstead ohos.notificationManager.setNotificationEnableSlot
*/
function enableNotificationSlot(bundle: BundleOption, type: SlotType, enable: boolean, callback: AsyncCallback<void>): void;
function enableNotificationSlot(bundle: BundleOption, type: SlotType, enable: boolean): Promise<void>;
/**
* Obtains whether the application slot is enabled.
*
* @since 9
* @systemapi Hide this for inner system use.
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @deprecated since 9
* @useinstead ohos.notificationManager.isNotificationSlotEnabled
*/
function isNotificationSlotEnabled(bundle: BundleOption, type: SlotType, callback: AsyncCallback<boolean>): void;
function isNotificationSlotEnabled(bundle: BundleOption, type: SlotType): Promise<boolean>;
/**
* Set whether to sync notifications to devices that do not have the app installed.
*
* @since 9
* @systemapi Hide this for inner system use.
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @deprecated since 9
* @useinstead ohos.notificationManager.setSyncNotificationEnabledWithoutApp
*/
function setSyncNotificationEnabledWithoutApp(userId: number, enable: boolean, callback: AsyncCallback<void>): void;
function setSyncNotificationEnabledWithoutApp(userId: number, enable: boolean): Promise<void>;
/**
* Obtains whether to sync notifications to devices that do not have the app installed.
*
* @since 9
* @systemapi Hide this for inner system use.
* @permission ohos.permission.NOTIFICATION_CONTROLLER
* @deprecated since 9
* @useinstead ohos.notificationManager.getSyncNotificationEnabledWithoutApp
*/
function getSyncNotificationEnabledWithoutApp(userId: number, callback: AsyncCallback<boolean>): void;
function getSyncNotificationEnabledWithoutApp(userId: number): Promise<boolean>;
/**
* Describes a BundleOption.
*
@ -1047,7 +967,6 @@ declare namespace notification {
/**
* Reason for remove a notification
*
* @since 9
* @systemapi Hide this for inner system use.
* @deprecated since 9
* @useinstead ohos.notificationManager.RemoveReason

2
api/@ohos.pasteboard.d.ts vendored
View File

@ -13,7 +13,7 @@
* limitations under the License.
*/
import { AsyncCallback } from './basic';
import Want from './@ohos.application.Want';
import Want from './@ohos.app.ability.Want';
import image from './@ohos.multimedia.image';
/**

2
api/@ohos.pluginComponent.d.ts vendored
View File

@ -14,7 +14,7 @@
*/
import { AsyncCallback } from './basic';
import Want from './@ohos.application.Want';
import Want from './@ohos.app.ability.Want';
/**
* Plugin component template property.

22
api/@ohos.wantAgent.d.ts vendored
View File

@ -14,7 +14,7 @@
*/
import { AsyncCallback , Callback} from './basic';
import Want from './@ohos.application.Want';
import Want from './@ohos.app.ability.Want';
import { WantAgentInfo as _WantAgentInfo } from './wantAgent/wantAgentInfo';
import { TriggerInfo as _TriggerInfo } from './wantAgent/triggerInfo';
@ -83,16 +83,6 @@ declare namespace wantAgent {
*/
function trigger(agent: WantAgent, triggerInfo: TriggerInfo, callback?: Callback<CompleteData>): void;
/**
* Triggers a WantAgent.
*
* @since 9
* @param WantAgent to trigger.
* @param Trigger parameters.
* @param callback Indicates the AsyncCallback method to be called after the {@link WantAgent} is triggered.
*/
function trigger(agent: WantAgent, triggerInfo: TriggerInfo, callback?: AsyncCallback<CompleteData>): void;
/**
* Checks whether two WantAgent objects are equal.
*
@ -112,16 +102,6 @@ declare namespace wantAgent {
function getWantAgent(info: WantAgentInfo, callback: AsyncCallback<WantAgent>): void;
function getWantAgent(info: WantAgentInfo): Promise<WantAgent>;
/**
* Obtains the {@link OperationType} of a {@link WantAgent}.
*
* @since 9
* @param agent Indicates the {@link WantAgent} whose {@link OperationType} is to be obtained.
* @returns Returns the {@link OperationType} of the {@link WantAgent}.
*/
function getOperationType(agent: WantAgent, callback: AsyncCallback<number>): void;
function getOperationType(agent: WantAgent): Promise<number>;
/**
* Enumerates flags for using a WantAgent.
*/

2
api/ability/abilityResult.d.ts vendored
View File

@ -13,7 +13,7 @@
* limitations under the License.
*/
import Want from '../@ohos.application.Want';
import Want from '../@ohos.app.ability.Want';
/**
* @since 7

2
api/ability/startAbilityParameter.d.ts vendored
View File

@ -13,7 +13,7 @@
* limitations under the License.
*/
import Want from '../@ohos.application.Want';
import Want from '../@ohos.app.ability.Want';
/**
* @since 6

2
api/ability/want.d.ts vendored
View File

@ -20,7 +20,7 @@
* @syscap SystemCapability.Ability.AbilityBase
* @permission N/A
* @deprecated since 9
* @useinstead ohos.application.Want
* @useinstead ohos.app.ability.Want
*/
export declare interface Want {
/**

573
api/application/AbilityContext.d.ts vendored
View File

@ -1,573 +0,0 @@
/*
* 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.
*/
/// <reference path="../../component/common_ts_ets_api.d.ts"/>
import { AbilityInfo } from "../bundleManager/abilityInfo";
import { AbilityResult } from "../ability/abilityResult";
import { AsyncCallback } from "../basic";
import { ConnectOptions } from "../ability/connectOptions";
import { HapModuleInfo } from "../bundleManager/hapModuleInfo";
import Context from "./Context";
import Want from "../@ohos.application.Want";
import StartOptions from "../@ohos.app.ability.StartOptions";
import PermissionRequestResult from "./PermissionRequestResult";
import { Configuration } from '../@ohos.app.ability.Configuration';
import { Caller } from '../@ohos.app.ability.UIAbility';
import { LocalStorage } from 'StateManagement';
import image from '../@ohos.multimedia.image';
/**
* The context of an ability. It allows access to ability-specific resources.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @StageModelOnly
* @since 9
*/
export default class AbilityContext extends Context {
/**
* Indicates configuration information about an ability.
* @type { AbilityInfo }
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @StageModelOnly
* @since 9
*/
abilityInfo: AbilityInfo;
/**
* Indicates configuration information about the module.
* @type { HapModuleInfo }
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @StageModelOnly
* @since 9
*/
currentHapModuleInfo: HapModuleInfo;
/**
* Indicates configuration information.
* @type { Configuration }
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @StageModelOnly
* @since 9
*/
config: Configuration;
/**
* Starts a new ability.
* @param want { Want } - Indicates the ability to start.
* @param { AsyncCallback<void> } callback - The callback of startAbility.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @StageModelOnly
* @since 9
*/
startAbility(want: Want, callback: AsyncCallback<void>): void;
/**
* Starts a new ability.
* @param { Want } want - Indicates the ability to start.
* @param { StartOptions } options - Indicates the start options.
* @param { AsyncCallback<void> } callback - The callback of startAbility.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @StageModelOnly
* @since 9
*/
startAbility(want: Want, options: StartOptions, callback: AsyncCallback<void>): void;
/**
* Starts a new ability.
* @param { Want } want - Indicates the ability to start.
* @param { StartOptions } options - Indicates the start options.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @StageModelOnly
* @since 9
*/
startAbility(want: Want, options?: StartOptions): Promise<void>;
/**
* Get the caller object of the startup capability
* @permission ohos.permission.ABILITY_BACKGROUND_COMMUNICATION
* @param { Want } want - Indicates the ability to start.
* @returns { Promise<Caller> } Returns the Caller interface.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @systemapi
* @StageModelOnly
* @since 9
*/
startAbilityByCall(want: Want): Promise<Caller>;
/**
* Starts a new ability with account.
* @permission ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS
* @param { Want } want - Indicates the want info to start.
* @param { number } accountId - Indicates the account to start.
* @param { AsyncCallback<void> } callback - The callback of startAbilityWithAccount.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @systemapi
* @StageModelOnly
* @since 9
*/
startAbilityWithAccount(want: Want, accountId: number, callback: AsyncCallback<void>): void;
/**
* Starts a new ability with account.
* @permission ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS
* @param { Want } want - Indicates the want info to start.
* @param { number } accountId - Indicates the account to start.
* @param { StartOptions } options - Indicates the start options.
* @param { AsyncCallback<void> } callback - The callback of startAbilityWithAccount.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @systemapi
* @StageModelOnly
* @since 9
*/
startAbilityWithAccount(want: Want, accountId: number, options: StartOptions, callback: AsyncCallback<void>): void;
/**
* Starts a new ability with account.
* @permission ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS
* @param { Want } want - Indicates the want info to start.
* @param { number } accountId - Indicates the account to start.
* @param { StartOptions } options - Indicates the start options.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @systemapi
* @StageModelOnly
* @since 9
*/
startAbilityWithAccount(want: Want, accountId: number, options?: StartOptions): Promise<void>;
/**
* Starts an ability and returns the execution result when the ability is destroyed.
* @param { Want } want - Indicates the ability to start.
* @param { AsyncCallback<AbilityResult> } callback - The callback is used to return the result of startAbility.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @StageModelOnly
* @since 9
*/
startAbilityForResult(want: Want, callback: AsyncCallback<AbilityResult>): void;
/**
* Starts an ability and returns the execution result when the ability is destroyed.
* @param { Want } want - Indicates the ability to start.
* @param { StartOptions } options - Indicates the start options.
* @param { AsyncCallback<AbilityResult> } callback - The callback is used to return the result of startAbility.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @StageModelOnly
* @since 9
*/
startAbilityForResult(want: Want, options: StartOptions, callback: AsyncCallback<AbilityResult>): void;
/**
* Starts an ability and returns the execution result when the ability is destroyed.
* @param { Want } want - Indicates the ability to start.
* @param { StartOptions } options - Indicates the start options.
* @returns { Promise<AbilityResult> } Returns the result of startAbility.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @StageModelOnly
* @since 9
*/
startAbilityForResult(want: Want, options?: StartOptions): Promise<AbilityResult>;
/**
* Starts an ability and returns the execution result when the ability is destroyed with account.
* @permission ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS
* @param { Want } want - Indicates the want info to start.
* @param { number } accountId - Indicates the account to start.
* @param { AsyncCallback<AbilityResult> } callback - The callback is used to return the result of startAbility.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @systemapi
* @StageModelOnly
* @since 9
*/
startAbilityForResultWithAccount(want: Want, accountId: number, callback: AsyncCallback<AbilityResult>): void;
/**
* Starts an ability and returns the execution result when the ability is destroyed with account.
* @permission ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS
* @param { Want } want - Indicates the want info to start.
* @param { number } accountId - Indicates the account to start.
* @param { StartOptions } options - Indicates the start options.
* @param { AsyncCallback<AbilityResult> } callback - The callback is used to return the result of startAbility.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @systemapi
* @StageModelOnly
* @since 9
*/
startAbilityForResultWithAccount(want: Want, accountId: number, options: StartOptions, callback: AsyncCallback<void>): void;
/**
* Starts an ability and returns the execution result when the ability is destroyed with account.
* @permission ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS
* @param { Want } want - Indicates the want info to start.
* @param { number } accountId - Indicates the account to start.
* @param { StartOptions } options - Indicates the start options.
* @returns { Promise<AbilityResult> } Returns the result of startAbility.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @systemapi
* @StageModelOnly
* @since 9
*/
startAbilityForResultWithAccount(want: Want, accountId: number, options?: StartOptions): Promise<AbilityResult>;
/**
* Starts a new service extension ability.
* @param { Want } want - Indicates the want info to start.
* @param { AsyncCallback<void> } callback - The callback of startServiceExtensionAbility.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @systemapi
* @StageModelOnly
* @since 9
*/
startServiceExtensionAbility(want: Want, callback: AsyncCallback<void>): void;
/**
* Starts a new service extension ability.
* @param { Want } want - Indicates the want info to start.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @systemapi
* @StageModelOnly
* @since 9
*/
startServiceExtensionAbility(want: Want): Promise<void>;
/**
* Starts a new service extension ability with account.
* @permission ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS
* @param { Want } want - Indicates the want info to start.
* @param { number } accountId - Indicates the account to start.
* @param { AsyncCallback<void> } callback - The callback of startServiceExtensionAbilityWithAccount.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @systemapi
* @StageModelOnly
* @since 9
*/
startServiceExtensionAbilityWithAccount(want: Want, accountId: number, callback: AsyncCallback<void>): void;
/**
* Starts a new service extension ability with account.
* @permission ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS
* @param { Want } want - Indicates the want info to start.
* @param { number } accountId - Indicates the account to start.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @systemapi
* @StageModelOnly
* @since 9
*/
startServiceExtensionAbilityWithAccount(want: Want, accountId: number): Promise<void>;
/**
* Stops a service within the same application.
* @param { Want } want - Indicates the want info to start.
* @param { AsyncCallback<void> } callback - The callback of stopServiceExtensionAbility.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @systemapi
* @StageModelOnly
* @since 9
*/
stopServiceExtensionAbility(want: Want, callback: AsyncCallback<void>): void;
/**
* Stops a service within the same application.
* @param { Want } want - Indicates the want info to start.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @systemapi
* @StageModelOnly
* @since 9
*/
stopServiceExtensionAbility(want: Want): Promise<void>;
/**
* Stops a service within the same application with account.
* @permission ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS
* @param { Want } want - Indicates the want info to start.
* @param { number } accountId - Indicates the accountId to start.
* @param { AsyncCallback<void> } callback - The callback of stopServiceExtensionAbilityWithAccount.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @systemapi
* @StageModelOnly
* @since 9
*/
stopServiceExtensionAbilityWithAccount(want: Want, accountId: number, callback: AsyncCallback<void>): void;
/**
* Stops a service within the same application with account.
* @permission ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS
* @param { Want } want - Indicates the want info to start.
* @param { number } accountId - Indicates the accountId to start.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @systemapi
* @StageModelOnly
* @since 9
*/
stopServiceExtensionAbilityWithAccount(want: Want, accountId: number): Promise<void>;
/**
* Destroys this Page ability.
* @param { AsyncCallback<void> } callback - The callback of terminateSelf.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @StageModelOnly
* @since 9
*/
terminateSelf(callback: AsyncCallback<void>): void;
/**
* Destroys this Page ability.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @StageModelOnly
* @since 9
*/
terminateSelf(): Promise<void>;
/**
* Sets the result code and data to be returned by this Page ability to the caller
* and destroys this Page ability.
* @param { AbilityResult } parameter - Indicates the result to return.
* @param { AsyncCallback<void> } callback - The callback of terminateSelfWithResult.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @StageModelOnly
* @since 9
*/
terminateSelfWithResult(parameter: AbilityResult, callback: AsyncCallback<void>): void;
/**
* Sets the result code and data to be returned by this Page ability to the caller
* and destroys this Page ability.
* @param { AbilityResult } parameter - Indicates the result to return.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @StageModelOnly
* @since 9
*/
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.
* @returns Returns the number code of the ability connected
* @StageModelOnly
* @deprecated since 9
* @useinstead connectServiceExtensionAbility
*/
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.
* @returns Returns the number code of the ability connected
* @permission ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS
* @StageModelOnly
* @deprecated since 9
* @useinstead connectServiceExtensionAbilityWithAccount
*/
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
* @deprecated since 9
* @useinstead disconnectServiceExtensionAbility
*/
disconnectAbility(connection: number, callback:AsyncCallback<void>): void;
disconnectAbility(connection: number): Promise<void>;
/**
* Connects the current ability to an ability using the AbilityInfo.AbilityType.SERVICE template.
* @param { Want } want - The element name of the service ability
* @param { ConnectOptions } options - The remote object instance
* @returns { number } Returns the number code of the ability connected
* @throws { BusinessError } 401 - If the input parameter is not valid parameter.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @StageModelOnly
* @since 9
*/
connectServiceExtensionAbility(want: Want, options: ConnectOptions): number;
/**
* Connects the current ability to an ability using the AbilityInfo.AbilityType.SERVICE template with account.
* @permission ohos.permission.INTERACT_ACROSS_LOCAL_ACCOUNTS
* @param { Want } want - The element name of the service ability
* @param { number } accountId - The account to connect
* @param { ConnectOptions } options - The remote object instance
* @returns { number } Returns the number code of the ability connected
* @throws { BusinessError } 401 - If the input parameter is not valid parameter.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @systemapi
* @StageModelOnly
* @since 9
*/
connectServiceExtensionAbilityWithAccount(want: Want, accountId: number, options: ConnectOptions): number;
/**
* The callback interface was connect successfully.
* @param { number } connection - The number code of the ability connected
* @param { AsyncCallback<void> } callback - The callback of disconnectAbility.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @StageModelOnly
* @since 9
*/
disconnectServiceExtensionAbility(connection: number, callback: AsyncCallback<void>): void;
/**
* The callback interface was connect successfully.
* @param { number } connection - The number code of the ability connected
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @StageModelOnly
* @since 9
*/
disconnectServiceExtensionAbility(connection: number): Promise<void>;
/**
* Set mission label of current ability.
* @param { string } label - The label of ability that showed in recent missions.
* @param { AsyncCallback<void> } callback - The callback of setMissionLabel.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @StageModelOnly
* @since 9
*/
setMissionLabel(label: string, callback: AsyncCallback<void>): void;
/**
* Set mission label of current ability.
* @param { string } label - The label of ability that showed in recent missions.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @StageModelOnly
* @since 9
*/
setMissionLabel(label: string): Promise<void>;
/**
* Set mission icon of current ability.
* @param { image.PixelMap } icon - The icon of ability that showed in recent missions.
* @param { AsyncCallback<void> } callback - The callback of setMissionIcon.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @systemapi
* @StageModelOnly
* @since 9
*/
setMissionIcon(icon: image.PixelMap, callback: AsyncCallback<void>): void;
/**
* Set mission icon of current ability.
* @param { image.PixelMap } icon - The icon of ability that showed in recent missions.
* @returns { Promise<void> } The promise returned by the function.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @systemapi
* @StageModelOnly
* @since 9
*/
setMissionIcon(icon: image.PixelMap): Promise<void>;
/**
* Requests certain permissions from the system.
* @param { Array<string> } permissions - Indicates the list of permissions to be requested. This parameter
* cannot be null or empty.
* @param { AsyncCallback<PermissionRequestResult> } requestCallback - The callback is used to return the permission
* request result.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @StageModelOnly
* @since 9
* @deprecated since 9
* @useinstead @ohos.abilityAccessCtrl.requestPermissionsFromUser
*/
requestPermissionsFromUser(permissions: Array<string>, requestCallback: AsyncCallback<PermissionRequestResult>): void;
/**
* Requests certain permissions from the system.
* @param { Array<string> } permissions - Indicates the list of permissions to be requested. This parameter
* cannot be null or empty.
* @returns { Promise<PermissionRequestResult> } Returns the permission request result.
* @throws { BusinessError } 401 - If the input parameter is not valid parameter.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @StageModelOnly
* @since 9
* @deprecated since 9
* @useinstead @ohos.abilityAccessCtrl.requestPermissionsFromUser
*/
requestPermissionsFromUser(permissions: Array<string>): Promise<PermissionRequestResult>;
/**
* Restore window stage data in ability continuation
* @param { LocalStorage } localStorage - the storage data used to restore window stage
* @throws { BusinessError } 401 - If the input parameter is not valid parameter.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @StageModelOnly
* @since 9
*/
restoreWindowStage(localStorage: LocalStorage): void;
/**
* check to see ability is in terminating state.
* @returns { boolean } Returns true when ability is in terminating state, else returns false.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @StageModelOnly
* @since 9
*/
isTerminating(): boolean;
}

54
api/application/ApplicationContext.d.ts vendored
View File

@ -26,60 +26,6 @@ import { ProcessRunningInformation } from "./ProcessRunningInformation";
* @since 9
*/
export default class ApplicationContext extends Context {
/**
* Register ability lifecycle callback.
*
* @since 9
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @param callback The ability lifecycle callback.
* @returns Returns the number code of the callback.
* @StageModelOnly
* @deprecated since 9
* @useinstead on
*/
registerAbilityLifecycleCallback(callback: AbilityLifecycleCallback): number;
/**
* Unregister ability lifecycle callback.
*
* @since 9
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @param callbackId Indicates the number code of the callback.
* @returns -
* @StageModelOnly
* @deprecated since 9
* @useinstead off
*/
unregisterAbilityLifecycleCallback(callbackId: number, callback: AsyncCallback<void>): void;
unregisterAbilityLifecycleCallback(callbackId: number): Promise<void>;
/**
* Register environment callback.
*
* @since 9
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @param callback The environment callback.
* @returns Returns the number code of the callback.
* @StageModelOnly
* @deprecated since 9
* @useinstead on
*/
registerEnvironmentCallback(callback: EnvironmentCallback): number;
/**
* Unregister environment callback.
*
* @since 9
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @param callbackId Indicates the number code of the callback.
* @returns -
* @StageModelOnly
* @deprecated since 9
* @useinstead off
*/
unregisterEnvironmentCallback(callbackId: number, callback: AsyncCallback<void>): void;
unregisterEnvironmentCallback(callbackId: number): Promise<void>;
/**
* Register ability lifecycle callback.
* @param { string } type - abilityLifecycle.

2
api/application/FormExtensionContext.d.ts vendored
View File

@ -16,7 +16,7 @@
import { AsyncCallback } from "../basic";
import ExtensionContext from "./ExtensionContext";
import formBindingData from '../@ohos.app.form.formBindingData';
import Want from '../@ohos.application.Want';
import Want from '../@ohos.app.ability.Want';
/**
* The context of form extension. It allows access to

2
api/application/MissionInfo.d.ts vendored
View File

@ -13,7 +13,7 @@
* limitations under the License.
*/
import Want from "../@ohos.application.Want";
import Want from "../@ohos.app.ability.Want";
/**
* Mission information corresponding to ability.

57
api/application/ServiceExtensionContext.d.ts vendored
View File

@ -17,7 +17,7 @@ import { AsyncCallback } from "../basic";
import { ConnectOptions } from "../ability/connectOptions";
import { Caller } from '../@ohos.app.ability.UIAbility';
import ExtensionContext from "./ExtensionContext";
import Want from "../@ohos.application.Want";
import Want from "../@ohos.app.ability.Want";
import StartOptions from "../@ohos.app.ability.StartOptions";
/**
@ -234,61 +234,6 @@ export default class ServiceExtensionContext extends ExtensionContext {
*/
terminateSelf(): Promise<void>;
/**
* Connects an ability to a Service extension.
*
* <p>This method can be called by an ability or service extension, but the destination of the connection must be a
* service extension. You must implement the {@link ConnectOptions} interface to obtain the proxy of the target
* service extension when the Service extension is connected.</p>
*
* @since 9
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @param want Indicates the service extension to connect.
* @param options Indicates the callback of connection.
* @systemapi hide for inner use.
* @returns connection id, int value.
* @StageModelOnly
* @deprecated since 9
* @useinstead connectServiceExtensionAbility
*/
connectAbility(want: Want, options: ConnectOptions): number;
/**
* Connects an ability to a Service extension with account.
*
* <p>This method can be called by an ability or service extension, but the destination of the connection must be a
* service extension. You must implement the {@link ConnectOptions} interface to obtain the proxy of the target
* service extension when the Service extension is connected.</p>
*
* @since 9
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @param want Indicates the service extension to connect.
* @param accountId Indicates the account to connect.
* @param options Indicates the callback of connection.
* @systemapi hide for inner use.
* @returns connection id, int value.
* @StageModelOnly
* @deprecated since 9
* @useinstead connectServiceExtensionAbilityWithAccount
*/
connectAbilityWithAccount(want: Want, accountId: number, options: ConnectOptions): number;
/**
* Disconnect an ability to a service extension, in contrast to
* {@link connectAbility}.
*
* @since 9
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @param connection the connection id returned from connectAbility api.
* @systemapi hide for inner use.
* @returns -
* @StageModelOnly
* @deprecated since 9
* @useinstead disconnectServiceExtensionAbility
*/
disconnectAbility(connection: number, callback:AsyncCallback<void>): void;
disconnectAbility(connection: number): Promise<void>;
/**
* Connects an ability to a Service extension.
* <p>This method can be called by an ability or service extension, but the destination of the connection must be a

2
api/application/UIAbilityContext.d.ts vendored
View File

@ -21,7 +21,7 @@ import { AsyncCallback } from "../basic";
import { ConnectOptions } from "../ability/connectOptions";
import { HapModuleInfo } from "../bundleManager/hapModuleInfo";
import Context from "./Context";
import Want from "../@ohos.application.Want";
import Want from "../@ohos.app.ability.Want";
import StartOptions from "../@ohos.app.ability.StartOptions";
import PermissionRequestResult from "./PermissionRequestResult";
import { Configuration } from '../@ohos.app.ability.Configuration';

2
api/application/abilityDelegator.d.ts vendored
View File

@ -19,7 +19,7 @@ import AbilityStage from '../@ohos.app.ability.AbilityStage';
import { AbilityMonitor } from './abilityMonitor';
import { AbilityStageMonitor } from './abilityStageMonitor';
import Context from './Context';
import Want from "../@ohos.application.Want";
import Want from "../@ohos.app.ability.Want";
import { ShellCmdResult } from './shellCmdResult';
/**

2
api/wantAgent/triggerInfo.d.ts vendored
View File

@ -13,7 +13,7 @@
* limitations under the License.
*/
import Want from '../@ohos.application.Want';
import Want from '../@ohos.app.ability.Want';
/**
* Provides the information required for triggering a WantAgent.

2
api/wantAgent/wantAgentInfo.d.ts vendored
View File

@ -13,7 +13,7 @@
* limitations under the License.
*/
import Want from '../@ohos.application.Want';
import Want from '../@ohos.app.ability.Want';
import wantAgent from '../@ohos.wantAgent'
/**