From 16171dbddb519574c4aff9e1b17ae5579d4945da Mon Sep 17 00:00:00 2001 From: ql Date: Tue, 21 Jun 2022 15:10:50 +0800 Subject: [PATCH 01/15] Add distributed mission manager api Signed-off-by: ql Change-Id: I14d17421964de0c66bb86372688726d578b93403 --- api/@ohos.distributedMissionManager.d.ts | 80 ++++++++++++++++++++++++ api/application/MissionCallbacks.d.ts | 57 +++++++++++++++++ api/application/MissionDeviceInfo.d.ts | 32 ++++++++++ api/application/MissionParameter.d.ts | 48 ++++++++++++++ 4 files changed, 217 insertions(+) create mode 100755 api/@ohos.distributedMissionManager.d.ts create mode 100755 api/application/MissionCallbacks.d.ts create mode 100755 api/application/MissionDeviceInfo.d.ts create mode 100755 api/application/MissionParameter.d.ts diff --git a/api/@ohos.distributedMissionManager.d.ts b/api/@ohos.distributedMissionManager.d.ts new file mode 100755 index 0000000000..4ea8d0791f --- /dev/null +++ b/api/@ohos.distributedMissionManager.d.ts @@ -0,0 +1,80 @@ +/* + * 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 { MissionCallback } from './application/MissionCallbacks'; +import { MissionDeviceInfo } from './application/MissionDeviceInfo'; +import { MissionParameter } from './application/MissionParameter'; + +/** + * This module provides the capability to manage abilities and obtaining system task information for distributed + * scenario. + * @name distributedMissionManager + * @since 9 + * @syscap SystemCapability.Ability.AbilityRuntime.Mission + * @permission N/A + * @systemapi Hide this for inner system use. + */ +declare namespace distributedMissionManager { + /** + * Start sync missions from remote device. + * + * @since 9 + * @syscap SystemCapability.Ability.AbilityRuntime.Mission. + * @param parameter Parameters corresponding to mission. + * @return - + * @systemapi Hide this for inner system use. + */ + function startSyncRemoteMissions(parameter: MissionParameter, callback: AsyncCallback): void; + function startSyncRemoteMissions(parameter: MissionParameter): Promise; + + /** + * Stop sync missions from remote device. + * + * @since 9 + * @syscap SystemCapability.Ability.AbilityRuntime.Mission. + * @param parameter Parameters corresponding to mission. + * @return - + * @systemapi Hide this for inner system use. + */ + function stopSyncRemoteMissions(parameter: MissionDeviceInfo, callback: AsyncCallback): void; + function stopSyncRemoteMissions(parameter: MissionDeviceInfo): Promise; + + /** + * Register the missionListener to ams. + * @default - + * @since 9 + * @syscap SystemCapability.Ability.AbilityRuntime.Mission + * @param parameter Parameters corresponding to mission. + * @param options The callbacks for regist mission. + * @return - + * @systemapi Hide this for inner system use. + */ + function registerMissionListener(parameter: MissionDeviceInfo, options: MissionCallback, callback: AsyncCallback): void; + function registerMissionListener(parameter: MissionDeviceInfo, options: MissionCallback): Promise; + + /** + * Unrgister the missionListener to ams. + * @default - + * @since 9 + * @syscap SystemCapability.Ability.AbilityRuntime.Mission + * @param parameter Parameters corresponding to mission. + * @return - + * @systemapi Hide this for inner system use. + */ + function unRegisterMissionListener(parameter: MissionDeviceInfo, callback:AsyncCallback): void; + function unRegisterMissionListener(parameter: MissionDeviceInfo): Promise; +} +export default distributedMissionManager; diff --git a/api/application/MissionCallbacks.d.ts b/api/application/MissionCallbacks.d.ts new file mode 100755 index 0000000000..de4a16551b --- /dev/null +++ b/api/application/MissionCallbacks.d.ts @@ -0,0 +1,57 @@ +/* + * 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. + */ + +/** + * MissionCallback registered by app. + * + * @name MissionCallback + * @since 9 + * @syscap SystemCapability.Ability.AbilityRuntime.Mission + * @permission N/A + * @systemapi hide for inner use. + */ + export interface MissionCallback { + /** + * Called by system when mission changed. + * + * @since 9 + * @syscap SystemCapability.Ability.AbilityRuntime.Mission + * @param deviceId Indicates the deviceId mission changed. + * @return - + */ + notifyMissionsChanged(deviceId: string): void; + + /** + * Called by system when snapshop changed. + * + * @since 9 + * @syscap SystemCapability.Ability.AbilityRuntime.Mission + * @param deviceId Indicates the deviceId mission changed. + * @param mission Indicates the id of destroyed mission. + * @return - + */ + notifySnapshot(deviceId: string, mission: number): void; + + /** + * Called by system when network disconnect. + * + * @since 9 + * @syscap SystemCapability.Ability.AbilityRuntime.Mission + * @param deviceId Indicates the deviceId mission changed. + * @param state Indicates the state of network + * @return - + */ + notifyNetDisconnect(deviceId: string, state: number): void; +} \ No newline at end of file diff --git a/api/application/MissionDeviceInfo.d.ts b/api/application/MissionDeviceInfo.d.ts new file mode 100755 index 0000000000..d4ba0f2dbe --- /dev/null +++ b/api/application/MissionDeviceInfo.d.ts @@ -0,0 +1,32 @@ +/* + * 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. + */ + +/** + * Parameters corresponding to mission. + * + * @since 9 + * @syscap SystemCapability.Ability.AbilityRuntime.Mission + * @permission N/A + * @systemapi hide for inner use. + */ + export interface MissionDeviceInfo { + /** + * Indicates the deviceId to start sync. + * + * @since 9 + * @syscap SystemCapability.Ability.AbilityRuntime.Mission + */ + deviceId: string; + } \ No newline at end of file diff --git a/api/application/MissionParameter.d.ts b/api/application/MissionParameter.d.ts new file mode 100755 index 0000000000..6d0455f67b --- /dev/null +++ b/api/application/MissionParameter.d.ts @@ -0,0 +1,48 @@ +/* + * 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. + */ + +/** + * Parameters corresponding to mission. + * + * @since 9 + * @syscap SystemCapability.Ability.AbilityRuntime.Mission + * @permission N/A + * @systemapi hide for inner use. + */ +export interface MissionParameter { + /** + * Indicates the deviceId to start sync. + * + * @since 9 + * @syscap SystemCapability.Ability.AbilityRuntime.Mission + */ + deviceId: string; + + /** + * If needed to fix the versions confilct. + * + * @since 9 + * @syscap SystemCapability.Ability.AbilityRuntime.Mission + */ + fixConflict: boolean; + + /** + * Tag used to be specified. + * + * @since 9 + * @syscap SystemCapability.Ability.AbilityRuntime.Mission + */ + tag: number; +} \ No newline at end of file -- Gitee From 73c7b4d7d745005d4f5ad7c8d7f6ea09b53d3900 Mon Sep 17 00:00:00 2001 From: mr-yx <496043997@qq.com> Date: Wed, 29 Jun 2022 00:06:37 +0800 Subject: [PATCH 02/15] update line breaks Signed-off-by: mr-yx <496043997@qq.com> --- api/application/AbilityRunningInfo.d.ts | 148 ++-- api/application/EventHub.d.ts | 118 +-- api/application/ExtensionRunningInfo.d.ts | 164 ++-- api/application/MissionListener.d.ts | 154 ++-- api/application/PermissionRequestResult.d.ts | 84 +- api/application/ProcessRunningInfo.d.ts | 164 ++-- api/bundle/PermissionDef.d.ts | 102 +-- api/bundle/abilityInfo.d.ts | 562 ++++++------- api/bundle/applicationInfo.d.ts | 376 ++++----- api/bundle/bundleInfo.d.ts | 518 ++++++------ api/bundle/bundleInstaller.d.ts | 300 +++---- api/bundle/customizeData.d.ts | 86 +- api/bundle/elementName.d.ts | 160 ++-- api/bundle/hapModuleInfo.d.ts | 288 +++---- api/bundle/moduleInfo.d.ts | 84 +- api/bundle/shortcutInfo.d.ts | 236 +++--- api/common/full/dom.d.ts | 58 +- api/common/full/featureability.d.ts | 798 +++++++++---------- api/common/lite/console.d.ts | 92 +-- api/common/lite/featureability.d.ts | 294 +++---- api/common/lite/global.d.ts | 156 ++-- api/common/lite/index.d.ts | 36 +- api/common/lite/viewmodel.d.ts | 236 +++--- 23 files changed, 2607 insertions(+), 2607 deletions(-) diff --git a/api/application/AbilityRunningInfo.d.ts b/api/application/AbilityRunningInfo.d.ts index 6ffba2b824..864465c87b 100644 --- a/api/application/AbilityRunningInfo.d.ts +++ b/api/application/AbilityRunningInfo.d.ts @@ -1,75 +1,75 @@ -/* - * 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. - */ - -import { ElementName } from '../bundle/elementName'; -import abilityManager from '../@ohos.application.abilityManager'; - -/** - * The class of an ability running information. - * - * @since 8 - * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @systemapi hide this for inner system use - * @permission N/A - */ -export interface AbilityRunningInfo { - /** - * @default ability element name - * @since 8 - * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @systemapi hide this for inner system use - */ - ability: ElementName; - - /** - * @default process id - * @since 8 - * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @systemapi hide this for inner system use - */ - pid: number; - - /** - * @default user id - * @since 8 - * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @systemapi hide this for inner system use - */ - uid: number; - - /** - * @default the name of the process - * @since 8 - * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @systemapi hide this for inner system use - */ - processName: string; - - /** - * @default ability start time - * @since 8 - * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @systemapi hide this for inner system use - */ - startTime: number; - - /** - * @default Enumerates state of the ability state info - * @since 8 - * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @systemapi hide this for inner system use - */ - abilityState: abilityManager.AbilityState; +/* + * 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. + */ + +import { ElementName } from '../bundle/elementName'; +import abilityManager from '../@ohos.application.abilityManager'; + +/** + * The class of an ability running information. + * + * @since 8 + * @syscap SystemCapability.Ability.AbilityRuntime.Core + * @systemapi hide this for inner system use + * @permission N/A + */ +export interface AbilityRunningInfo { + /** + * @default ability element name + * @since 8 + * @syscap SystemCapability.Ability.AbilityRuntime.Core + * @systemapi hide this for inner system use + */ + ability: ElementName; + + /** + * @default process id + * @since 8 + * @syscap SystemCapability.Ability.AbilityRuntime.Core + * @systemapi hide this for inner system use + */ + pid: number; + + /** + * @default user id + * @since 8 + * @syscap SystemCapability.Ability.AbilityRuntime.Core + * @systemapi hide this for inner system use + */ + uid: number; + + /** + * @default the name of the process + * @since 8 + * @syscap SystemCapability.Ability.AbilityRuntime.Core + * @systemapi hide this for inner system use + */ + processName: string; + + /** + * @default ability start time + * @since 8 + * @syscap SystemCapability.Ability.AbilityRuntime.Core + * @systemapi hide this for inner system use + */ + startTime: number; + + /** + * @default Enumerates state of the ability state info + * @since 8 + * @syscap SystemCapability.Ability.AbilityRuntime.Core + * @systemapi hide this for inner system use + */ + abilityState: abilityManager.AbilityState; } \ No newline at end of file diff --git a/api/application/EventHub.d.ts b/api/application/EventHub.d.ts index cbc9cbdc8b..7fe3d203ca 100644 --- a/api/application/EventHub.d.ts +++ b/api/application/EventHub.d.ts @@ -1,60 +1,60 @@ -/* - * 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. - */ - -/** - * The event center of a context, support the subscription and publication of events. - * - * @since 9 - * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @permission N/A - * @StageModelOnly - */ -export default class EventHub { - /** - * Subscribe to an event. - * - * @since 9 - * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @param event Indicates the event. - * @param callback Indicates the callback. - * @return - - * @StageModelOnly - */ - on(event: string, callback: Function): void - - /** - * Unsubscribe from an event. - * - * @since 9 - * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @param event Indicates the event. - * @param callback Indicates the callback. - * @return - - * @StageModelOnly - */ - off(event: string, callback?: Function): void - - /** - * Trigger the event callbacks. - * - * @since 9 - * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @param event Indicates the event. - * @param args Indicates the callback arguments. - * @return - - * @StageModelOnly - */ - emit(event: string, ...args: Object[]): void +/* + * 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. + */ + +/** + * The event center of a context, support the subscription and publication of events. + * + * @since 9 + * @syscap SystemCapability.Ability.AbilityRuntime.Core + * @permission N/A + * @StageModelOnly + */ +export default class EventHub { + /** + * Subscribe to an event. + * + * @since 9 + * @syscap SystemCapability.Ability.AbilityRuntime.Core + * @param event Indicates the event. + * @param callback Indicates the callback. + * @return - + * @StageModelOnly + */ + on(event: string, callback: Function): void + + /** + * Unsubscribe from an event. + * + * @since 9 + * @syscap SystemCapability.Ability.AbilityRuntime.Core + * @param event Indicates the event. + * @param callback Indicates the callback. + * @return - + * @StageModelOnly + */ + off(event: string, callback?: Function): void + + /** + * Trigger the event callbacks. + * + * @since 9 + * @syscap SystemCapability.Ability.AbilityRuntime.Core + * @param event Indicates the event. + * @param args Indicates the callback arguments. + * @return - + * @StageModelOnly + */ + emit(event: string, ...args: Object[]): void } \ No newline at end of file diff --git a/api/application/ExtensionRunningInfo.d.ts b/api/application/ExtensionRunningInfo.d.ts index 5021e879d1..32abe9c264 100644 --- a/api/application/ExtensionRunningInfo.d.ts +++ b/api/application/ExtensionRunningInfo.d.ts @@ -1,83 +1,83 @@ -/* - * 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. - */ - -import { ElementName } from '../bundle/elementName'; -import bundle from '../@ohos.bundle'; - -/** - * The class of an extension running information. - * - * @since 9 - * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @systemapi hide this for inner system use - * @permission N/A - */ -export interface ExtensionRunningInfo { - /** - * @default Indicates the extension of the extension info - * @since 9 - * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @systemapi hide this for inner system use - */ - extension: ElementName; - - /** - * @default process id - * @since 9 - * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @systemapi hide this for inner system use - */ - pid: number; - - /** - * @default user id - * @since 9 - * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @systemapi hide this for inner system use - */ - uid: number; - - /** - * @default the name of the process - * @since 9 - * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @systemapi hide this for inner system use - */ - processName: string; - - /** - * @default ability start time - * @since 9 - * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @systemapi hide this for inner system use - */ - startTime: number; - - /** - * @default All package names under the current process - * @since 9 - * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @systemapi hide this for inner system use - */ - clientPackage: Array; - - /** - * @default Enumerates types of the entension info - * @since 9 - * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @systemapi hide this for inner system use - */ - type: bundle.ExtensionAbilityType; +/* + * 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. + */ + +import { ElementName } from '../bundle/elementName'; +import bundle from '../@ohos.bundle'; + +/** + * The class of an extension running information. + * + * @since 9 + * @syscap SystemCapability.Ability.AbilityRuntime.Core + * @systemapi hide this for inner system use + * @permission N/A + */ +export interface ExtensionRunningInfo { + /** + * @default Indicates the extension of the extension info + * @since 9 + * @syscap SystemCapability.Ability.AbilityRuntime.Core + * @systemapi hide this for inner system use + */ + extension: ElementName; + + /** + * @default process id + * @since 9 + * @syscap SystemCapability.Ability.AbilityRuntime.Core + * @systemapi hide this for inner system use + */ + pid: number; + + /** + * @default user id + * @since 9 + * @syscap SystemCapability.Ability.AbilityRuntime.Core + * @systemapi hide this for inner system use + */ + uid: number; + + /** + * @default the name of the process + * @since 9 + * @syscap SystemCapability.Ability.AbilityRuntime.Core + * @systemapi hide this for inner system use + */ + processName: string; + + /** + * @default ability start time + * @since 9 + * @syscap SystemCapability.Ability.AbilityRuntime.Core + * @systemapi hide this for inner system use + */ + startTime: number; + + /** + * @default All package names under the current process + * @since 9 + * @syscap SystemCapability.Ability.AbilityRuntime.Core + * @systemapi hide this for inner system use + */ + clientPackage: Array; + + /** + * @default Enumerates types of the entension info + * @since 9 + * @syscap SystemCapability.Ability.AbilityRuntime.Core + * @systemapi hide this for inner system use + */ + type: bundle.ExtensionAbilityType; } \ No newline at end of file diff --git a/api/application/MissionListener.d.ts b/api/application/MissionListener.d.ts index b7416ce23e..07c409538a 100644 --- a/api/application/MissionListener.d.ts +++ b/api/application/MissionListener.d.ts @@ -1,78 +1,78 @@ -/* - * 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 image from "../@ohos.multimedia.image"; - -/** - * MissionListener registered by app. - * - * @name MissionListener - * @since 8 - * @syscap SystemCapability.Ability.AbilityRuntime.Mission - * @permission N/A - * @systemapi hide for inner use. - */ - export interface MissionListener { - /** - * Called by system when mission created. - * - * @since 8 - * @syscap SystemCapability.Ability.AbilityRuntime.Mission - * @param mission Indicates the id of created mission. - * @return - - */ - onMissionCreated(mission: number): void; - - /** - * Called by system when mission destroyed. - * - * @since 8 - * @syscap SystemCapability.Ability.AbilityRuntime.Mission - * @param mission Indicates the id of destroyed mission. - * @return - - */ - onMissionDestroyed(mission: number): void; - - /** - * Called by system when mission shapshot changed. - * - * @since 8 - * @syscap SystemCapability.Ability.AbilityRuntime.Mission - * @param mission Indicates the id of the mission which the snapshot changes - * @return - - */ - onMissionSnapshotChanged(mission: number): void; - - /** - * Called by system when mission moved to fornt. - * - * @since 8 - * @syscap SystemCapability.Ability.AbilityRuntime.Mission - * @param mission Indicates the id of the mission being moved to the foreground. - * @return - - */ - onMissionMovedToFront(mission: number): void; - - /** - * Called by system when mission icon has changed. - * - * @since 9 - * @syscap SystemCapability.Ability.AbilityRuntime.Mission - * @param mission Indicates the id of the mission whose icon has changed. - * @param icon Indicates the icon of the mission whose icon has changed. - * @return - - */ - onMissionIconUpdated(mission: number, icon: image.PixelMap): void; +/* + * 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 image from "../@ohos.multimedia.image"; + +/** + * MissionListener registered by app. + * + * @name MissionListener + * @since 8 + * @syscap SystemCapability.Ability.AbilityRuntime.Mission + * @permission N/A + * @systemapi hide for inner use. + */ + export interface MissionListener { + /** + * Called by system when mission created. + * + * @since 8 + * @syscap SystemCapability.Ability.AbilityRuntime.Mission + * @param mission Indicates the id of created mission. + * @return - + */ + onMissionCreated(mission: number): void; + + /** + * Called by system when mission destroyed. + * + * @since 8 + * @syscap SystemCapability.Ability.AbilityRuntime.Mission + * @param mission Indicates the id of destroyed mission. + * @return - + */ + onMissionDestroyed(mission: number): void; + + /** + * Called by system when mission shapshot changed. + * + * @since 8 + * @syscap SystemCapability.Ability.AbilityRuntime.Mission + * @param mission Indicates the id of the mission which the snapshot changes + * @return - + */ + onMissionSnapshotChanged(mission: number): void; + + /** + * Called by system when mission moved to fornt. + * + * @since 8 + * @syscap SystemCapability.Ability.AbilityRuntime.Mission + * @param mission Indicates the id of the mission being moved to the foreground. + * @return - + */ + onMissionMovedToFront(mission: number): void; + + /** + * Called by system when mission icon has changed. + * + * @since 9 + * @syscap SystemCapability.Ability.AbilityRuntime.Mission + * @param mission Indicates the id of the mission whose icon has changed. + * @param icon Indicates the icon of the mission whose icon has changed. + * @return - + */ + onMissionIconUpdated(mission: number, icon: image.PixelMap): void; } \ No newline at end of file diff --git a/api/application/PermissionRequestResult.d.ts b/api/application/PermissionRequestResult.d.ts index e999115847..a3d8d6ae04 100755 --- a/api/application/PermissionRequestResult.d.ts +++ b/api/application/PermissionRequestResult.d.ts @@ -1,43 +1,43 @@ -/* - * 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. - */ - -/** - * The result of requestPermissionsFromUser with asynchronous callback. - * - * @since 9 - * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @permission N/A - * @StageModelOnly - */ -export default class PermissionRequestResult { - /** - * The permissions passed in by the user. - * - * @since 9 - * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @StageModelOnly - */ - permissions: Array; - - /** - * The results for the corresponding request permissions. The value 0 indicates that a - * permission is granted, and the value -1 indicates not. - * - * @since 9 - * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @StageModelOnly - */ - authResults: Array; +/* + * 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. + */ + +/** + * The result of requestPermissionsFromUser with asynchronous callback. + * + * @since 9 + * @syscap SystemCapability.Ability.AbilityRuntime.Core + * @permission N/A + * @StageModelOnly + */ +export default class PermissionRequestResult { + /** + * The permissions passed in by the user. + * + * @since 9 + * @syscap SystemCapability.Ability.AbilityRuntime.Core + * @StageModelOnly + */ + permissions: Array; + + /** + * The results for the corresponding request permissions. The value 0 indicates that a + * permission is granted, and the value -1 indicates not. + * + * @since 9 + * @syscap SystemCapability.Ability.AbilityRuntime.Core + * @StageModelOnly + */ + authResults: Array; } \ No newline at end of file diff --git a/api/application/ProcessRunningInfo.d.ts b/api/application/ProcessRunningInfo.d.ts index 2d489c1b14..3e1e689179 100644 --- a/api/application/ProcessRunningInfo.d.ts +++ b/api/application/ProcessRunningInfo.d.ts @@ -1,83 +1,83 @@ -/* - * 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. - */ - -/** - * The class of an process running information. - * - * @deprecated since 9 - * @since 8 - * @syscap SystemCapability.Ability.AbilityRuntime.Mission - * @permission N/A - */ -/** - * The class of an process running information. - * - * @since 9 - * @syscap SystemCapability.Ability.AbilityRuntime.Core - * @permission N/A - */ -export interface ProcessRunningInfo { - /** - * @default process id - * @deprecated since 9 - * @since 8 - * @syscap SystemCapability.Ability.AbilityRuntime.Mission - */ - /** - * @default process id - * @since 9 - * @syscap SystemCapability.Ability.AbilityRuntime.Core - */ - pid: number; - - /** - * @default user id - * @deprecated since 9 - * @since 8 - * @syscap SystemCapability.Ability.AbilityRuntime.Mission - */ - /** - * @default user id - * @since 9 - * @syscap SystemCapability.Ability.AbilityRuntime.Core - */ - uid: number; - - /** - * @default the name of the process - * @deprecated since 9 - * @since 8 - * @syscap SystemCapability.Ability.AbilityRuntime.Mission - */ - /** - * @default the name of the process - * @since 9 - * @syscap SystemCapability.Ability.AbilityRuntime.Core - */ - processName: string; - - /** - * @default an array of the bundleNames running in the process - * @deprecated since 9 - * @since 8 - * @syscap SystemCapability.Ability.AbilityRuntime.Mission - */ - /** - * @default an array of the bundleNames running in the process - * @since 9 - * @syscap SystemCapability.Ability.AbilityRuntime.Core - */ - bundleNames: Array; +/* + * 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. + */ + +/** + * The class of an process running information. + * + * @deprecated since 9 + * @since 8 + * @syscap SystemCapability.Ability.AbilityRuntime.Mission + * @permission N/A + */ +/** + * The class of an process running information. + * + * @since 9 + * @syscap SystemCapability.Ability.AbilityRuntime.Core + * @permission N/A + */ +export interface ProcessRunningInfo { + /** + * @default process id + * @deprecated since 9 + * @since 8 + * @syscap SystemCapability.Ability.AbilityRuntime.Mission + */ + /** + * @default process id + * @since 9 + * @syscap SystemCapability.Ability.AbilityRuntime.Core + */ + pid: number; + + /** + * @default user id + * @deprecated since 9 + * @since 8 + * @syscap SystemCapability.Ability.AbilityRuntime.Mission + */ + /** + * @default user id + * @since 9 + * @syscap SystemCapability.Ability.AbilityRuntime.Core + */ + uid: number; + + /** + * @default the name of the process + * @deprecated since 9 + * @since 8 + * @syscap SystemCapability.Ability.AbilityRuntime.Mission + */ + /** + * @default the name of the process + * @since 9 + * @syscap SystemCapability.Ability.AbilityRuntime.Core + */ + processName: string; + + /** + * @default an array of the bundleNames running in the process + * @deprecated since 9 + * @since 8 + * @syscap SystemCapability.Ability.AbilityRuntime.Mission + */ + /** + * @default an array of the bundleNames running in the process + * @since 9 + * @syscap SystemCapability.Ability.AbilityRuntime.Core + */ + bundleNames: Array; } \ No newline at end of file diff --git a/api/bundle/PermissionDef.d.ts b/api/bundle/PermissionDef.d.ts index f47217e547..6be050d5d9 100644 --- a/api/bundle/PermissionDef.d.ts +++ b/api/bundle/PermissionDef.d.ts @@ -1,51 +1,51 @@ -/* - * 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. - */ - -/** - * @name Indicates the defined permission details in file config.json - * @since 8 - * @syscap SystemCapability.BundleManager.BundleFramework - * @permission NA - * @systemapi - */ - export interface PermissionDef { - /** - * @default Indicates the name of this permission - * @since 8 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - permissionName: string; - - /** - * @default Indicates the grant mode of this permission - * @since 8 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - grantMode: number; - - /** - * @default Indicates the labelId of this permission - * @since 8 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - labelId: number; - - /** - * @default Indicates the descriptionId of this permission - * @since 8 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - descriptionId: number; -} +/* + * 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. + */ + +/** + * @name Indicates the defined permission details in file config.json + * @since 8 + * @syscap SystemCapability.BundleManager.BundleFramework + * @permission NA + * @systemapi + */ + export interface PermissionDef { + /** + * @default Indicates the name of this permission + * @since 8 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + permissionName: string; + + /** + * @default Indicates the grant mode of this permission + * @since 8 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + grantMode: number; + + /** + * @default Indicates the labelId of this permission + * @since 8 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + labelId: number; + + /** + * @default Indicates the descriptionId of this permission + * @since 8 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + descriptionId: number; +} diff --git a/api/bundle/abilityInfo.d.ts b/api/bundle/abilityInfo.d.ts index 7812efd172..b1ae1d907f 100644 --- a/api/bundle/abilityInfo.d.ts +++ b/api/bundle/abilityInfo.d.ts @@ -1,281 +1,281 @@ -/* - * 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. - */ - -import { ApplicationInfo } from './applicationInfo'; -import { CustomizeData } from './customizeData' -import { Metadata } from './metadata' -import bundle from './../@ohos.bundle'; - -/** - * @name Obtains configuration information about an ability - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - * @permission NA - */ -export interface AbilityInfo { - /** - * @default Indicates the name of the bundle containing the ability - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - readonly bundleName: string; - - /** - * @default Ability simplified class name - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - readonly name: string; - - /** - * @default Indicates the label of the ability - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - readonly label: string; - - /** - * @default Describes the ability - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - readonly description: string; - - /** - * @default Indicates the icon of the ability - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - readonly icon: string; - - /** - * @default Indicates the label id of the ability - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - readonly labelId: number; - - /** - * @default Indicates the description id of the ability - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - readonly descriptionId: number; - - /** - * @default Indicates the icon id of the ability - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - readonly iconId: number; - - /** - * @default Indicates the name of the .hap package to which the capability belongs - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - readonly moduleName: string; - - /** - * @default Process of ability, if user do not set it ,the value equal application process - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - readonly process: string; - - /** - * @default Info about which ability is this nick point to - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - * @FAModelOnly - */ - readonly targetAbility: string; - - /** - * @default Indicates the background service addressing a specific usage scenario - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - * @FAModelOnly - */ - readonly backgroundModes: number; - - /** - * @default Indicates whether an ability can be called by other abilities - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - readonly isVisible: boolean; - - /** - * @default Indicates whether the ability provides the embedded card capability - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - * @FAModelOnly - */ - readonly formEnabled: boolean; - - /** - * @default Enumerates types of templates that can be used by an ability - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - * @FAModelOnly - */ - readonly type: bundle.AbilityType; - - /** - * @default Enumerates the subType of templates used by an ability - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - * @FAModelOnly - */ - readonly subType: bundle.AbilitySubType; - - /** - * @default Enumerates ability display orientations - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - readonly orientation: bundle.DisplayOrientation; - - /** - * @default Enumerates ability launch modes - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - readonly launchMode: bundle.LaunchMode; - - /** - * @default The permissions that others need to launch this ability - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - readonly permissions: Array; - - /** - * @default The device types that this ability can run on - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - readonly deviceTypes: Array; - - /** - * @default The device capability that this ability needs - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - readonly deviceCapabilities: Array; - - /** - * @default Indicates the permission required for reading ability data - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - * @FAModelOnly - */ - readonly readPermission: string; - - /** - * @default Indicates the permission required for writing data to the ability - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - * @FAModelOnly - */ - readonly writePermission: string; - - /** - * @default Obtains configuration information about an application - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - readonly applicationInfo: ApplicationInfo; - - /** - * @default Uri of ability - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - * @FAModelOnly - */ - readonly uri: string; - - /** - * @default Indicates the metadata of ability - * @since 8 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - readonly metaData: Array; - - /** - * @default Indicates the metadata of ability - * @since 9 - * @syscap SystemCapability.BundleManager.BundleFramework - * - */ - readonly metadata: Array; - - /** - * @default Indicates whether the ability is enabled - * @since 8 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - readonly enabled: boolean; - - /** - * @default Indicates which window mode is supported - * @since 9 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - readonly supportWindowMode: Array; - - /** - * @default Indicates maximum ratio of width over height of window under free window status. - * @since 9 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - readonly maxWindowRatio: number; - - /** - * @default Indicates minimum ratio of width over height of window under free window status. - * @since 9 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - readonly minWindowRatio: number; - - /** - * @default Indicates maximum width of window under free window status. - * @since 9 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - readonly maxWindowWidth: number; - - /** - * @default Indicates minimum width of window under free window status. - * @since 9 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - readonly minWindowWidth: number; - - /** - * @default Indicates maximum height of window under free window status. - * @since 9 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - readonly maxWindowHeight: number; - - /** - * @default Indicates minimum height of window under free window status. - * @since 9 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - readonly minWindowHeight: number; -} +/* + * 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. + */ + +import { ApplicationInfo } from './applicationInfo'; +import { CustomizeData } from './customizeData' +import { Metadata } from './metadata' +import bundle from './../@ohos.bundle'; + +/** + * @name Obtains configuration information about an ability + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + * @permission NA + */ +export interface AbilityInfo { + /** + * @default Indicates the name of the bundle containing the ability + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + readonly bundleName: string; + + /** + * @default Ability simplified class name + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + readonly name: string; + + /** + * @default Indicates the label of the ability + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + readonly label: string; + + /** + * @default Describes the ability + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + readonly description: string; + + /** + * @default Indicates the icon of the ability + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + readonly icon: string; + + /** + * @default Indicates the label id of the ability + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + readonly labelId: number; + + /** + * @default Indicates the description id of the ability + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + readonly descriptionId: number; + + /** + * @default Indicates the icon id of the ability + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + readonly iconId: number; + + /** + * @default Indicates the name of the .hap package to which the capability belongs + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + readonly moduleName: string; + + /** + * @default Process of ability, if user do not set it ,the value equal application process + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + readonly process: string; + + /** + * @default Info about which ability is this nick point to + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + * @FAModelOnly + */ + readonly targetAbility: string; + + /** + * @default Indicates the background service addressing a specific usage scenario + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + * @FAModelOnly + */ + readonly backgroundModes: number; + + /** + * @default Indicates whether an ability can be called by other abilities + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + readonly isVisible: boolean; + + /** + * @default Indicates whether the ability provides the embedded card capability + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + * @FAModelOnly + */ + readonly formEnabled: boolean; + + /** + * @default Enumerates types of templates that can be used by an ability + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + * @FAModelOnly + */ + readonly type: bundle.AbilityType; + + /** + * @default Enumerates the subType of templates used by an ability + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + * @FAModelOnly + */ + readonly subType: bundle.AbilitySubType; + + /** + * @default Enumerates ability display orientations + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + readonly orientation: bundle.DisplayOrientation; + + /** + * @default Enumerates ability launch modes + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + readonly launchMode: bundle.LaunchMode; + + /** + * @default The permissions that others need to launch this ability + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + readonly permissions: Array; + + /** + * @default The device types that this ability can run on + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + readonly deviceTypes: Array; + + /** + * @default The device capability that this ability needs + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + readonly deviceCapabilities: Array; + + /** + * @default Indicates the permission required for reading ability data + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + * @FAModelOnly + */ + readonly readPermission: string; + + /** + * @default Indicates the permission required for writing data to the ability + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + * @FAModelOnly + */ + readonly writePermission: string; + + /** + * @default Obtains configuration information about an application + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + readonly applicationInfo: ApplicationInfo; + + /** + * @default Uri of ability + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + * @FAModelOnly + */ + readonly uri: string; + + /** + * @default Indicates the metadata of ability + * @since 8 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + readonly metaData: Array; + + /** + * @default Indicates the metadata of ability + * @since 9 + * @syscap SystemCapability.BundleManager.BundleFramework + * + */ + readonly metadata: Array; + + /** + * @default Indicates whether the ability is enabled + * @since 8 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + readonly enabled: boolean; + + /** + * @default Indicates which window mode is supported + * @since 9 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + readonly supportWindowMode: Array; + + /** + * @default Indicates maximum ratio of width over height of window under free window status. + * @since 9 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + readonly maxWindowRatio: number; + + /** + * @default Indicates minimum ratio of width over height of window under free window status. + * @since 9 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + readonly minWindowRatio: number; + + /** + * @default Indicates maximum width of window under free window status. + * @since 9 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + readonly maxWindowWidth: number; + + /** + * @default Indicates minimum width of window under free window status. + * @since 9 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + readonly minWindowWidth: number; + + /** + * @default Indicates maximum height of window under free window status. + * @since 9 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + readonly maxWindowHeight: number; + + /** + * @default Indicates minimum height of window under free window status. + * @since 9 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + readonly minWindowHeight: number; +} diff --git a/api/bundle/applicationInfo.d.ts b/api/bundle/applicationInfo.d.ts index 909aefb1eb..9340a7b83e 100644 --- a/api/bundle/applicationInfo.d.ts +++ b/api/bundle/applicationInfo.d.ts @@ -1,188 +1,188 @@ -/* - * 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. - */ - -import { ModuleInfo } from './moduleInfo'; -import { CustomizeData } from './customizeData' -import { Metadata } from './metadata' - -/** - * @name Obtains configuration information about an application - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - * @permission NA - * - */ -export interface ApplicationInfo { - /** - * @default Indicates the application name, which is the same as {@code bundleName} - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - readonly name: string; - - /** - * @default Description of application - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - readonly description: string; - - /** - * @default Indicates the description id of the application - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - readonly descriptionId: number; - - /** - * @default Indicates whether the application is a system application - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - readonly systemApp: boolean; - - /** - * @default Indicates whether or not this application may be instantiated - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - readonly enabled: boolean; - - /** - * @default Indicates the label of the application - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - readonly label: string; - - /** - * @default Indicates the label id of the application - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - readonly labelId: string; - - /** - * @default Indicates the icon of the application - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - readonly icon: string; - - /** - * @default Indicates the icon id of the application - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - readonly iconId: string; - - /** - * @default Process of application, if user do not set it ,the value equal bundleName - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - readonly process: string; - - /** - * @default Indicates the running mode supported by the application - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - readonly supportedModes: number; - - /** - * @default Indicates the path storing the module resources of the application - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - readonly moduleSourceDirs: Array; - - /** - * @default Indicates the permissions required for accessing the application. - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - readonly permissions: Array; - - /** - * @default Indicates module information about an application - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - readonly moduleInfos: Array; - - /** - * @default Indicates the path where the {@code Entry.hap} file of the application is saved - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - readonly entryDir: string; - - /** - * @default Indicates the application source code path - * @since 8 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - readonly codePath: string; - - /** - * @default Indicates the metadata of module - * @since 8 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - readonly metaData: Map>; - - /** - * @default Indicates the metadata of module - * @since 9 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - readonly metadata: Map>; - - /** - * @default Indicates whether or not this application may be removable - * @since 8 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - readonly removable: boolean; - - /** - * @default Indicates the access token of the application - * @since 8 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - readonly accessTokenId: number; - - /** - * @default Indicates the uid of the application - * @since 8 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - readonly uid: number; - - /** - * @default Indicates entity type of the application - * @since 8 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - readonly entityType: string; - - /** - * @default Indicates fingerprint of the certificate - * @since 9 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - readonly fingerprint: string; -} +/* + * 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. + */ + +import { ModuleInfo } from './moduleInfo'; +import { CustomizeData } from './customizeData' +import { Metadata } from './metadata' + +/** + * @name Obtains configuration information about an application + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + * @permission NA + * + */ +export interface ApplicationInfo { + /** + * @default Indicates the application name, which is the same as {@code bundleName} + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + readonly name: string; + + /** + * @default Description of application + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + readonly description: string; + + /** + * @default Indicates the description id of the application + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + readonly descriptionId: number; + + /** + * @default Indicates whether the application is a system application + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + readonly systemApp: boolean; + + /** + * @default Indicates whether or not this application may be instantiated + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + readonly enabled: boolean; + + /** + * @default Indicates the label of the application + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + readonly label: string; + + /** + * @default Indicates the label id of the application + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + readonly labelId: string; + + /** + * @default Indicates the icon of the application + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + readonly icon: string; + + /** + * @default Indicates the icon id of the application + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + readonly iconId: string; + + /** + * @default Process of application, if user do not set it ,the value equal bundleName + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + readonly process: string; + + /** + * @default Indicates the running mode supported by the application + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + readonly supportedModes: number; + + /** + * @default Indicates the path storing the module resources of the application + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + readonly moduleSourceDirs: Array; + + /** + * @default Indicates the permissions required for accessing the application. + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + readonly permissions: Array; + + /** + * @default Indicates module information about an application + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + readonly moduleInfos: Array; + + /** + * @default Indicates the path where the {@code Entry.hap} file of the application is saved + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + readonly entryDir: string; + + /** + * @default Indicates the application source code path + * @since 8 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + readonly codePath: string; + + /** + * @default Indicates the metadata of module + * @since 8 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + readonly metaData: Map>; + + /** + * @default Indicates the metadata of module + * @since 9 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + readonly metadata: Map>; + + /** + * @default Indicates whether or not this application may be removable + * @since 8 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + readonly removable: boolean; + + /** + * @default Indicates the access token of the application + * @since 8 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + readonly accessTokenId: number; + + /** + * @default Indicates the uid of the application + * @since 8 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + readonly uid: number; + + /** + * @default Indicates entity type of the application + * @since 8 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + readonly entityType: string; + + /** + * @default Indicates fingerprint of the certificate + * @since 9 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + readonly fingerprint: string; +} diff --git a/api/bundle/bundleInfo.d.ts b/api/bundle/bundleInfo.d.ts index 2f71c27b38..4da8310f43 100644 --- a/api/bundle/bundleInfo.d.ts +++ b/api/bundle/bundleInfo.d.ts @@ -1,259 +1,259 @@ -/* - * 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. - */ - -import { AbilityInfo } from './abilityInfo'; -import { ApplicationInfo } from './applicationInfo'; -import { ExtensionAbilityInfo } from './extensionAbilityInfo'; -import { HapModuleInfo } from './hapModuleInfo'; - -/** - * @name The scene which is used - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - * @permission NA - * - */ -export interface UsedScene { - /** - * @default Indicates the abilities that need the permission - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - abilities: Array; - - /** - * @default Indicates the time when the permission is used - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - when: string; -} - -/** - * @name Indicates the required permissions details defined in file config.json - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - * @permission NA - * - */ -export interface ReqPermissionDetail { - /** - * @default Indicates the name of this required permissions - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - name: string; - - /** - * @default Indicates the reason of this required permissions - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - reason: string; - - /** - * @default Indicates the reason id of this required permissions - * @since 9 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - reasonId: number; - - /** - * @default Indicates the used scene of this required permissions - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - usedScene: UsedScene; -} - -/** - * @name Obtains configuration information about a bundle - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - * @permission NA - * - */ -export interface BundleInfo { - /** - * @default Indicates the name of this bundle - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - readonly name: string; - - /** - * @default Indicates the name of this original bundle - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - readonly type: string; - - /** - * @default Indicates the ID of the application to which this bundle belongs - * The application ID uniquely identifies an application. It is determined by the bundle name and signature - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - readonly appId: string; - - /** - * @default Indicates the UID of the application to which this bundle belongs - * The UID uniquely identifies an application. It is determined by the process and user IDs of the application - * After an application is installed, its UID remains unchanged unless it is uninstalled and then reinstalled - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - readonly uid: number; - - /** - * @default Indicates the hap install time - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - readonly installTime: number; - - /** - * @default Indicates the hap update time - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - readonly updateTime: number; - - /** - * @default Obtains configuration information about an application - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - readonly appInfo: ApplicationInfo; - - /** - * @default Obtains configuration information about an ability - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - readonly abilityInfos: Array; - - /** - * @default Indicates the required permissions name defined in file config.json - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - readonly reqPermissions: Array; - - /** - * @default Indicates the required permissions details defined in file config.json - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - readonly reqPermissionDetails: Array; - - /** - * @default Describes the bundle vendor - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - readonly vendor: string; - - /** - * @default Indicates the version number of the bundle - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - readonly versionCode: number; - - /** - * @default Indicates the text description of the bundle version - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - readonly versionName: string; - - /** - * @default Indicates the compatible version number of the bundle - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - readonly compatibleVersion: number; - - /** - * @default Indicates the target version number of the bundle - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - readonly targetVersion: number; - - /** - * @default Indicates is compress native libs - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - readonly isCompressNativeLibs: boolean; - - /** - * @default Obtains configuration information about an module - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - readonly hapModuleInfos: Array; - - /** - * @default Indicates entry module name - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - readonly entryModuleName: string; - - /** - * @default Indicates the cpuAbi information of this bundle. - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - readonly cpuAbi: string; - - /** - * @default Indicates is silent installation - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - readonly isSilentInstallation: string; - - /** - * @default Indicates the earliest historical version compatible with the bundle - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - readonly minCompatibleVersionCode: number; - - /** - * @default Indicates whether free installation of the entry is supported - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - readonly entryInstallationFree: boolean; - - /** - * @default Indicates the grant status of required permissions - * @since 8 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - readonly reqPermissionStates: Array; - - /** - * @default Obtains configuration information about an ability - * @since 9 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - readonly extensionAbilityInfo: Array; -} +/* + * 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. + */ + +import { AbilityInfo } from './abilityInfo'; +import { ApplicationInfo } from './applicationInfo'; +import { ExtensionAbilityInfo } from './extensionAbilityInfo'; +import { HapModuleInfo } from './hapModuleInfo'; + +/** + * @name The scene which is used + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + * @permission NA + * + */ +export interface UsedScene { + /** + * @default Indicates the abilities that need the permission + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + abilities: Array; + + /** + * @default Indicates the time when the permission is used + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + when: string; +} + +/** + * @name Indicates the required permissions details defined in file config.json + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + * @permission NA + * + */ +export interface ReqPermissionDetail { + /** + * @default Indicates the name of this required permissions + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + name: string; + + /** + * @default Indicates the reason of this required permissions + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + reason: string; + + /** + * @default Indicates the reason id of this required permissions + * @since 9 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + reasonId: number; + + /** + * @default Indicates the used scene of this required permissions + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + usedScene: UsedScene; +} + +/** + * @name Obtains configuration information about a bundle + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + * @permission NA + * + */ +export interface BundleInfo { + /** + * @default Indicates the name of this bundle + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + readonly name: string; + + /** + * @default Indicates the name of this original bundle + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + readonly type: string; + + /** + * @default Indicates the ID of the application to which this bundle belongs + * The application ID uniquely identifies an application. It is determined by the bundle name and signature + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + readonly appId: string; + + /** + * @default Indicates the UID of the application to which this bundle belongs + * The UID uniquely identifies an application. It is determined by the process and user IDs of the application + * After an application is installed, its UID remains unchanged unless it is uninstalled and then reinstalled + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + readonly uid: number; + + /** + * @default Indicates the hap install time + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + readonly installTime: number; + + /** + * @default Indicates the hap update time + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + readonly updateTime: number; + + /** + * @default Obtains configuration information about an application + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + readonly appInfo: ApplicationInfo; + + /** + * @default Obtains configuration information about an ability + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + readonly abilityInfos: Array; + + /** + * @default Indicates the required permissions name defined in file config.json + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + readonly reqPermissions: Array; + + /** + * @default Indicates the required permissions details defined in file config.json + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + readonly reqPermissionDetails: Array; + + /** + * @default Describes the bundle vendor + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + readonly vendor: string; + + /** + * @default Indicates the version number of the bundle + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + readonly versionCode: number; + + /** + * @default Indicates the text description of the bundle version + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + readonly versionName: string; + + /** + * @default Indicates the compatible version number of the bundle + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + readonly compatibleVersion: number; + + /** + * @default Indicates the target version number of the bundle + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + readonly targetVersion: number; + + /** + * @default Indicates is compress native libs + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + readonly isCompressNativeLibs: boolean; + + /** + * @default Obtains configuration information about an module + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + readonly hapModuleInfos: Array; + + /** + * @default Indicates entry module name + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + readonly entryModuleName: string; + + /** + * @default Indicates the cpuAbi information of this bundle. + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + readonly cpuAbi: string; + + /** + * @default Indicates is silent installation + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + readonly isSilentInstallation: string; + + /** + * @default Indicates the earliest historical version compatible with the bundle + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + readonly minCompatibleVersionCode: number; + + /** + * @default Indicates whether free installation of the entry is supported + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + readonly entryInstallationFree: boolean; + + /** + * @default Indicates the grant status of required permissions + * @since 8 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + readonly reqPermissionStates: Array; + + /** + * @default Obtains configuration information about an ability + * @since 9 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + readonly extensionAbilityInfo: Array; +} diff --git a/api/bundle/bundleInstaller.d.ts b/api/bundle/bundleInstaller.d.ts index bdebfff218..cc45ed47ee 100644 --- a/api/bundle/bundleInstaller.d.ts +++ b/api/bundle/bundleInstaller.d.ts @@ -1,151 +1,151 @@ -/* - * 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. - */ - -import { AsyncCallback } from './../basic'; -import bundle from './../@ohos.bundle'; - -/** - * @name Provides parameters required for hashParam. - * @since 9 - * @syscap SystemCapability.BundleManager.BundleFramework - * @permission NA - * @systemapi Hide this for inner system use - */ - export interface HashParam { - /** - * @default Indicates the moduleName - * @since 9 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - moduleName: string; - - /** - * @default Indicates the hash value - * @since 9 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - hashValue: string; -} - -/** - * @name Provides parameters required for installing or uninstalling an application. - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - * @permission NA - * @systemapi Hide this for inner system use - */ -export interface InstallParam { - /** - * @default Indicates the user id - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - userId: number; - - /** - * @default Indicates the install flag - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - installFlag: number; - - /** - * @default Indicates whether the param has data - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - isKeepData: boolean; - - /** - * @default Indicates the hash params - * @since 9 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - hashParams?: Array; -} - -/** - * @name Indicates the install or uninstall status - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - * @permission NA - * @systemapi Hide this for inner system use - */ -export interface InstallStatus { - - /** - * @default Indicates the install or uninstall error code - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - status: bundle.InstallErrorCode; - - /** - * @default Indicates the install or uninstall result string message - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - statusMessage: string; -} - -/** - * @name Offers install, upgrade, and remove bundles on the devices. - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - * @permission NA - * @systemapi Hide this for inner system use - */ -export interface BundleInstaller { - /** - * Install an application in a HAP. - * - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - * - * @param bundleFilePaths Indicates the path where the bundle of the application is stored. The path should be the - * relative path to the data directory of the current application. - * @param installParam Indicates other parameters required for the installation. - * @return InstallStatus - * @permission ohos.permission.INSTALL_BUNDLE - */ - install(bundleFilePaths: Array, param: InstallParam, callback: AsyncCallback): void; - - /** - * Uninstall an application. - * - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - * - * @param bundleName Indicates the bundle name of the application to be uninstalled. - * @param installParam Indicates other parameters required for the uninstallation. - * @return InstallStatus - * @permission ohos.permission.INSTALL_BUNDLE - */ - uninstall(bundleName: string, param: InstallParam, callback: AsyncCallback): void; - - /** - * recover an application. - * - * @since 8 - * @syscap SystemCapability.BundleManager.BundleFramework - * - * @param bundleName Indicates the bundle name of the application to be recovered. - * @param installParam Indicates other parameters required for the recover. - * @return InstallStatus - * @permission ohos.permission.INSTALL_BUNDLE - * @systemapi Hide this for inner system use - */ - recover(bundleName: string, param: InstallParam, callback: AsyncCallback): void; +/* + * 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. + */ + +import { AsyncCallback } from './../basic'; +import bundle from './../@ohos.bundle'; + +/** + * @name Provides parameters required for hashParam. + * @since 9 + * @syscap SystemCapability.BundleManager.BundleFramework + * @permission NA + * @systemapi Hide this for inner system use + */ + export interface HashParam { + /** + * @default Indicates the moduleName + * @since 9 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + moduleName: string; + + /** + * @default Indicates the hash value + * @since 9 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + hashValue: string; +} + +/** + * @name Provides parameters required for installing or uninstalling an application. + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + * @permission NA + * @systemapi Hide this for inner system use + */ +export interface InstallParam { + /** + * @default Indicates the user id + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + userId: number; + + /** + * @default Indicates the install flag + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + installFlag: number; + + /** + * @default Indicates whether the param has data + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + isKeepData: boolean; + + /** + * @default Indicates the hash params + * @since 9 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + hashParams?: Array; +} + +/** + * @name Indicates the install or uninstall status + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + * @permission NA + * @systemapi Hide this for inner system use + */ +export interface InstallStatus { + + /** + * @default Indicates the install or uninstall error code + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + status: bundle.InstallErrorCode; + + /** + * @default Indicates the install or uninstall result string message + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + statusMessage: string; +} + +/** + * @name Offers install, upgrade, and remove bundles on the devices. + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + * @permission NA + * @systemapi Hide this for inner system use + */ +export interface BundleInstaller { + /** + * Install an application in a HAP. + * + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + * + * @param bundleFilePaths Indicates the path where the bundle of the application is stored. The path should be the + * relative path to the data directory of the current application. + * @param installParam Indicates other parameters required for the installation. + * @return InstallStatus + * @permission ohos.permission.INSTALL_BUNDLE + */ + install(bundleFilePaths: Array, param: InstallParam, callback: AsyncCallback): void; + + /** + * Uninstall an application. + * + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + * + * @param bundleName Indicates the bundle name of the application to be uninstalled. + * @param installParam Indicates other parameters required for the uninstallation. + * @return InstallStatus + * @permission ohos.permission.INSTALL_BUNDLE + */ + uninstall(bundleName: string, param: InstallParam, callback: AsyncCallback): void; + + /** + * recover an application. + * + * @since 8 + * @syscap SystemCapability.BundleManager.BundleFramework + * + * @param bundleName Indicates the bundle name of the application to be recovered. + * @param installParam Indicates other parameters required for the recover. + * @return InstallStatus + * @permission ohos.permission.INSTALL_BUNDLE + * @systemapi Hide this for inner system use + */ + recover(bundleName: string, param: InstallParam, callback: AsyncCallback): void; } \ No newline at end of file diff --git a/api/bundle/customizeData.d.ts b/api/bundle/customizeData.d.ts index 62cb31ea94..4427daf061 100644 --- a/api/bundle/customizeData.d.ts +++ b/api/bundle/customizeData.d.ts @@ -1,44 +1,44 @@ -/* - * 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. - */ - - /** - * @name Indicates the custom metadata - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - * @permission NA - * - */ - export interface CustomizeData { - /** - * @default Indicates the custom metadata name - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - name: string; - - /** - * @default Indicates the custom metadata value - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - value: string; - - /** - * @default Indicates the custom metadata resource - * @since 8 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - extra: string; +/* + * 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. + */ + + /** + * @name Indicates the custom metadata + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + * @permission NA + * + */ + export interface CustomizeData { + /** + * @default Indicates the custom metadata name + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + name: string; + + /** + * @default Indicates the custom metadata value + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + value: string; + + /** + * @default Indicates the custom metadata resource + * @since 8 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + extra: string; } \ No newline at end of file diff --git a/api/bundle/elementName.d.ts b/api/bundle/elementName.d.ts index 92f4628f8c..3eeff9218e 100644 --- a/api/bundle/elementName.d.ts +++ b/api/bundle/elementName.d.ts @@ -1,80 +1,80 @@ -/* - * 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. - */ - -/** - * Contains basic Ability information, which uniquely identifies an ability. - * You can use this class to obtain values of the fields set in an element, - * such as the device ID, bundle name, and ability name. - * @name Contains basic Ability information, which uniquely identifies an ability - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - * - * @permission N/A - */ - export interface ElementName { - /** - * device id - * @default - - * - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - deviceId?: string; - - /** - * bundle name - * @default - - * - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - bundleName: string; - - /** - * ability name - * @default ability class name. - * - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - abilityName: string; - - /** - * uri - * @default - - * - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - uri?: string; - - /** - * shortName - * @default - - * - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - shortName?: string; - - /** - * module name - * @default - - * - * @since 9 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - moduleName?: string; -} +/* + * 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. + */ + +/** + * Contains basic Ability information, which uniquely identifies an ability. + * You can use this class to obtain values of the fields set in an element, + * such as the device ID, bundle name, and ability name. + * @name Contains basic Ability information, which uniquely identifies an ability + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + * + * @permission N/A + */ + export interface ElementName { + /** + * device id + * @default - + * + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + deviceId?: string; + + /** + * bundle name + * @default - + * + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + bundleName: string; + + /** + * ability name + * @default ability class name. + * + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + abilityName: string; + + /** + * uri + * @default - + * + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + uri?: string; + + /** + * shortName + * @default - + * + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + shortName?: string; + + /** + * module name + * @default - + * + * @since 9 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + moduleName?: string; +} diff --git a/api/bundle/hapModuleInfo.d.ts b/api/bundle/hapModuleInfo.d.ts index 26c930161c..5ed5be922e 100644 --- a/api/bundle/hapModuleInfo.d.ts +++ b/api/bundle/hapModuleInfo.d.ts @@ -1,145 +1,145 @@ -/* - * 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. - */ - -import { AbilityInfo } from "./abilityInfo"; -import { ExtensionAbilityInfo } from "./extensionAbilityInfo"; -import { Metadata } from './metadata' - -/** - * @name Obtains configuration information about an module. - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - * @permission NA - * - */ -export interface HapModuleInfo { - /** - * @default Indicates the name of this hapmodule - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - readonly name: string; - /** - * @default Describes the hapmodule - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - readonly description: string; - /** - * @default Indicates the description of this hapmodule - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - readonly descriptionId: number; - /** - * @default Indicates the icon of this hapmodule - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - readonly icon: string; - /** - * @default Indicates the label of this hapmodule - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - readonly label: string; - /** - * @default Indicates the label id of this hapmodule - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - readonly labelId: number; - /** - * @default Indicates the icon id of this hapmodule - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - readonly iconId: number; - /** - * @default Indicates the background img of this hapmodule - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - readonly backgroundImg: string; - /** - * @default Indicates the supported modes of this hapmodule - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - readonly supportedModes: number; - /** - * @default Indicates the req capabilities of this hapmodule - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - readonly reqCapabilities: Array; - /** - * @default The device types that this hapmodule can run on - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - readonly deviceTypes: Array; - /** - * @default Obtains configuration information about ability - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - readonly abilityInfo: Array; - /** - * @default Indicates the name of the .hap package to which the capability belongs - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - readonly moduleName: string; - /** - * @default Indicates the main ability name of this hapmodule - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - readonly mainAbilityName: string; - /** - * @default Indicates whether free installation of the hapmodule is supported - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - readonly installationFree: boolean; - - /** - * @default Indicates main elementName of the module - * @since 9 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - readonly mainElementName: string; - - /** - * @default Obtains configuration information about extension ability - * @since 9 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - readonly extensionAbilityInfo: Array; - /** - * @default Indicates the metadata of ability - * @since 9 - * @syscap SystemCapability.BundleManager.BundleFramework - * - */ - readonly metadata: Array; - /** - * @default Indicates the hash value of the module - * @since 9 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - readonly hashValue: string; +/* + * 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. + */ + +import { AbilityInfo } from "./abilityInfo"; +import { ExtensionAbilityInfo } from "./extensionAbilityInfo"; +import { Metadata } from './metadata' + +/** + * @name Obtains configuration information about an module. + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + * @permission NA + * + */ +export interface HapModuleInfo { + /** + * @default Indicates the name of this hapmodule + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + readonly name: string; + /** + * @default Describes the hapmodule + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + readonly description: string; + /** + * @default Indicates the description of this hapmodule + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + readonly descriptionId: number; + /** + * @default Indicates the icon of this hapmodule + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + readonly icon: string; + /** + * @default Indicates the label of this hapmodule + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + readonly label: string; + /** + * @default Indicates the label id of this hapmodule + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + readonly labelId: number; + /** + * @default Indicates the icon id of this hapmodule + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + readonly iconId: number; + /** + * @default Indicates the background img of this hapmodule + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + readonly backgroundImg: string; + /** + * @default Indicates the supported modes of this hapmodule + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + readonly supportedModes: number; + /** + * @default Indicates the req capabilities of this hapmodule + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + readonly reqCapabilities: Array; + /** + * @default The device types that this hapmodule can run on + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + readonly deviceTypes: Array; + /** + * @default Obtains configuration information about ability + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + readonly abilityInfo: Array; + /** + * @default Indicates the name of the .hap package to which the capability belongs + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + readonly moduleName: string; + /** + * @default Indicates the main ability name of this hapmodule + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + readonly mainAbilityName: string; + /** + * @default Indicates whether free installation of the hapmodule is supported + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + readonly installationFree: boolean; + + /** + * @default Indicates main elementName of the module + * @since 9 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + readonly mainElementName: string; + + /** + * @default Obtains configuration information about extension ability + * @since 9 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + readonly extensionAbilityInfo: Array; + /** + * @default Indicates the metadata of ability + * @since 9 + * @syscap SystemCapability.BundleManager.BundleFramework + * + */ + readonly metadata: Array; + /** + * @default Indicates the hash value of the module + * @since 9 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + readonly hashValue: string; } \ No newline at end of file diff --git a/api/bundle/moduleInfo.d.ts b/api/bundle/moduleInfo.d.ts index 434eacc5dc..f961a10b9d 100644 --- a/api/bundle/moduleInfo.d.ts +++ b/api/bundle/moduleInfo.d.ts @@ -1,43 +1,43 @@ -/* - * 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. - */ - -/** - * @name Stores module information about an application. - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - * @permission NA - * - */ - export interface ModuleInfo { - /** - * The module name. - * - * @default Indicates the name of the .hap package to which the capability belongs - * - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - readonly moduleName: string; - - /** - * The module source path. - * - * @default Indicates the module source dir of this module - * - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - readonly moduleSourceDir: string; +/* + * 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. + */ + +/** + * @name Stores module information about an application. + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + * @permission NA + * + */ + export interface ModuleInfo { + /** + * The module name. + * + * @default Indicates the name of the .hap package to which the capability belongs + * + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + readonly moduleName: string; + + /** + * The module source path. + * + * @default Indicates the module source dir of this module + * + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + readonly moduleSourceDir: string; } \ No newline at end of file diff --git a/api/bundle/shortcutInfo.d.ts b/api/bundle/shortcutInfo.d.ts index 78d78ce8d9..fbcc1baadd 100644 --- a/api/bundle/shortcutInfo.d.ts +++ b/api/bundle/shortcutInfo.d.ts @@ -1,119 +1,119 @@ -/* - * 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. - */ - - /** - * @name Provides methods for obtaining information about the ability that a shortcut will start, including the target - * bundle name and ability class name. - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - * @permission NA - * @systemapi Hide this for inner system use - */ - export interface ShortcutWant{ - /** - * @default Indicates the target bundle of the shortcut want - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - readonly targetBundle: string; - /** - * @default Indicates the target class of the shortcut want - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - readonly targetClass: string; - } - - /** - * @name Provides information about a shortcut, including the shortcut ID and label. - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - * @permission NA - * - */ - export interface ShortcutInfo { - /** - * @default Indicates the ID of the application to which this shortcut belongs - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - readonly id: string; - /** - * @default Indicates the name of the bundle containing the shortcut - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - readonly bundleName: string; - /** - * @default Indicates the host ability of the shortcut - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - readonly hostAbility: string; - /** - * @default Indicates the icon of the shortcut - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - readonly icon: string; - /** - * @default Indicate s the icon id of the shortcut - * @since 8 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - readonly iconId: number; - /** - * @default Indicates the label of the shortcut - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - readonly label: string; - /** - * @default Indicates the label id of the shortcut - * @since 8 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - readonly labelId: number; - /** - * @default Indicates the disableMessage of the shortcut - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - readonly disableMessage: string; - /** - * @default Indicates the wants of the shortcut - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - readonly wants: Array; - /** - * @default Indicates whether the shortcut is static - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - readonly isStatic?: boolean - /** - * @default Indicates whether the shortcut is homeshortcut - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - readonly isHomeShortcut?: boolean; - /** - * @default Indicates whether the shortcut is enabled - * @since 7 - * @syscap SystemCapability.BundleManager.BundleFramework - */ - readonly isEnabled?: boolean; +/* + * 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. + */ + + /** + * @name Provides methods for obtaining information about the ability that a shortcut will start, including the target + * bundle name and ability class name. + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + * @permission NA + * @systemapi Hide this for inner system use + */ + export interface ShortcutWant{ + /** + * @default Indicates the target bundle of the shortcut want + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + readonly targetBundle: string; + /** + * @default Indicates the target class of the shortcut want + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + readonly targetClass: string; + } + + /** + * @name Provides information about a shortcut, including the shortcut ID and label. + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + * @permission NA + * + */ + export interface ShortcutInfo { + /** + * @default Indicates the ID of the application to which this shortcut belongs + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + readonly id: string; + /** + * @default Indicates the name of the bundle containing the shortcut + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + readonly bundleName: string; + /** + * @default Indicates the host ability of the shortcut + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + readonly hostAbility: string; + /** + * @default Indicates the icon of the shortcut + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + readonly icon: string; + /** + * @default Indicate s the icon id of the shortcut + * @since 8 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + readonly iconId: number; + /** + * @default Indicates the label of the shortcut + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + readonly label: string; + /** + * @default Indicates the label id of the shortcut + * @since 8 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + readonly labelId: number; + /** + * @default Indicates the disableMessage of the shortcut + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + readonly disableMessage: string; + /** + * @default Indicates the wants of the shortcut + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + readonly wants: Array; + /** + * @default Indicates whether the shortcut is static + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + readonly isStatic?: boolean + /** + * @default Indicates whether the shortcut is homeshortcut + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + readonly isHomeShortcut?: boolean; + /** + * @default Indicates whether the shortcut is enabled + * @since 7 + * @syscap SystemCapability.BundleManager.BundleFramework + */ + readonly isEnabled?: boolean; } \ No newline at end of file diff --git a/api/common/full/dom.d.ts b/api/common/full/dom.d.ts index 39f358f314..2efda42009 100644 --- a/api/common/full/dom.d.ts +++ b/api/common/full/dom.d.ts @@ -1,29 +1,29 @@ -/* - * Copyright (c) 2020 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. - */ - -export { Element } from './viewmodel'; - -/** - * global dom - * @since 8 - */ -export declare class dom { - /** - * create a dynamic dom by tag, rturn element - * @param tag dom tag - * @since 8 - */ - static createElement(tag: string): Element -} +/* + * Copyright (c) 2020 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. + */ + +export { Element } from './viewmodel'; + +/** + * global dom + * @since 8 + */ +export declare class dom { + /** + * create a dynamic dom by tag, rturn element + * @param tag dom tag + * @since 8 + */ + static createElement(tag: string): Element +} diff --git a/api/common/full/featureability.d.ts b/api/common/full/featureability.d.ts index e37966a993..bc825a0587 100644 --- a/api/common/full/featureability.d.ts +++ b/api/common/full/featureability.d.ts @@ -1,399 +1,399 @@ -/* - * Copyright (c) 2020 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. - */ - -/** - * @since 5 - * @deprecated since 8 - */ -export interface Result { - /** - * Result code. - * @since 5 - */ - code: number; - - /** - * Returned data. - * @since 5 - */ - data: object; -} - -/** - * @since 5 - * @systemapi - * @deprecated since 8 - */ -export interface SubscribeMessageResponse { - /** - * Peer device ID. - * @since 5 - */ - deviceId: string; - - /** - * Name of the bundle where the peer ability locates. The name is case sensitive. - * @since 5 - */ - bundleName: string; - - /** - * Peer ability name, which is case sensitive. - * @since 5 - */ - abilityName: string; - - /** - * Messages received from the device. - * @since 5 - */ - message: string; -} - -/** - * @since 5 - * @deprecated since 8 - */ -export interface CallAbilityParam { - /** - * Name of the bundle where the ability locates. The name is case sensitive and must be the same as that on the AA side. - * @since 5 - */ - bundleName: string; - - /** - * Ability name, which is case sensitive and must be the same as that on the AA side. - * @since 5 - */ - abilityName: string; - - /** - * Ability operation code, which defines the service function of an AA and must be consistent with the AA side. - * @since 5 - */ - messageCode: number; - - /** - * Ability type. Different types of abilities have different implementation on the AA side. - * 0: Ability, which has an independent lifecycle. The FA starts and requests an AA through an RPC. Such type of abilities are used to provide basic services for multiple FAs to call or are used when the abilities should run in the background. - * 1: Internal ability, which shares the same process with the FA and communicates with it by calling internal functions. Such type of abilities are used in scenarios that require low response latency and cannot be called by other FAs. - * @since 5 - */ - abilityType: number; - - /** - * Data sent to the ability. The data to carry differs depending on the service to be processed and its field name must be consistent with the AA side. - * @since 5 - */ - data?: object; - - /** - * Whether the request is synchronous or asynchronous. The synchronous mode is used by default. Currently, the asynchronous mode is available only for internal abilities. - * 0: Synchronous mode (default value) - * 1: Asynchronous mode - * @since 5 - */ - syncOption?: number; -} - -/** - * @since 5 - * @deprecated since 8 - */ -export interface SubscribeAbilityEventParam { - /** - * Name of the bundle where the ability locates. The name is case sensitive and must be the same as that on the AA side. - * @since 5 - */ - bundleName: string; - - /** - * Ability name, which is case sensitive and must be the same as that on the AA side. - * @since 5 - */ - abilityName: string; - - /** - * Ability operation code, which defines the service function of an AA and must be consistent with the AA side. - * @since 5 - */ - messageCode: number; - - /** - * Ability type. Different types of abilities have different implementation on the AA side. - * 0: Ability, which has an independent lifecycle. The FA starts and requests an AA through an RPC. Such type of abilities are used to provide basic services for multiple FAs to call or are used when the abilities should run in the background. - * 1: Internal ability, which shares the same process with the FA and communicates with it by calling internal functions. Such type of abilities are used in scenarios that require low response latency and cannot be called by other FAs. - * @since 5 - */ - abilityType: number; - - /** - * Whether the request is synchronous or asynchronous. The synchronous mode is used by default. Currently, the asynchronous mode is available only for internal abilities. - * 0: Synchronous mode (default value) - * 1: Asynchronous mode - * @since 5 - */ - syncOption?: number; -} - -/** - * @since 5 - * @systemapi - * @deprecated since 8 - */ -export interface SendMessageOptions { - /** - * Destination device ID. - * @since 5 - */ - deviceId: string; - - /** - * Name of the destination bundle where the ability locates. The name is case sensitive. - * @since 5 - */ - bundleName: string; - - /** - * Destination ability name, which is case sensitive. - * @since 5 - */ - abilityName: string; - - /** - * Messages sent to the destination device. - * A maximum of 1 KB of data can be transmitted at a time. - * If more than 1 KB of data needs to be transmitted, split the messages into multiple parts to transmit. - * @since 5 - */ - message?: string; - - /** - * Called when the messages are sent successfully. - * @since 5 - */ - success?: () => void; - - /** - * Called when the messages fail to be sent. - * @since 5 - */ - fail?: (data: string, code: number) => void; - - /** - * Called when the execution is completed. - * @since 5 - */ - complete?: () => void; -} - -/** - * @since 5 - * @systemapi - * @deprecated since 8 - */ -export interface SubscribeMessageOptions { - /** - * Called when the messages are sent successfully. - * @since 5 - */ - success?: (data: SubscribeMessageResponse) => void; - - /** - * Called when the messages fail to be sent. - * @since 5 - */ - fail?: (data: string, code: number) => void; -} - -/** - * @since 5 - * @deprecated since 8 - */ -export interface RequestParams { - /** - * The name of the bundle to start. It should be used with abilityname and case sensitive. - * @since 5 - */ - bundleName?: string; - - /** - * Ability name, which is case sensitive. - * @since 5 - */ - abilityName?: string; - - /** - * The list of entities to which the FA to be called. If it is not filled in, all entity lists will be found by default. It should be used with action. - * @since 5 - */ - entities?: Array; - - /** - * Without specifying the bundle name and ability name, you can start the application according to other properties with action. - * @since 5 - */ - action?: string; - - /** - * If more than one FA meets the conditions, the user can select the device from the popup. - * 0: Default. Select the FA to start from the local and remote devices. - * 1: start FA from the local device. - * @since 5 - */ - deviceType?: number; - - /** - * Data sent to the ability which need to be serializable. - * @since 5 - */ - data?: object; - - /** - * Configuration switch when start FA. - * @since 5 - */ - flag?: number; - - /** - * Specify the url of the page which the FA to be called. Use home page directly by default. - * @since 5 - */ - url?: string; -} - -/** - * @since 5 - * @deprecated since 8 - */ -export interface FinishWithResultParams { - /** - * Result code. - * @since 5 - */ - code: number; - - /** - * Returned data. - * @since 5 - */ - result: object; -} - -/** - * @since 5 - * @deprecated since 8 - */ -export declare class FeatureAbility { - /** - * Start a FA without callback result. - * @param request Indicates the request param. - * @returns A Promise object is returned, which contains the result of whether to call Ability's interface successfully. - * @since 5 - * @deprecated since 8 - */ - static startAbility(request: RequestParams): Promise; - - /** - * Start a FA with callback result. - * @param request Indicates the request param. - * @returns A Promise object is returned, which contains the result of the data FA returned. - * @since 5 - * @deprecated since 8 - */ - static startAbilityForResult(request: RequestParams): Promise; - - /** - * FA call the interface to destory itself and set the result as parameters. - * @param request Indicates the request param. - * @returns A Promise object is returned, which contains the result whether to callback successfully. - * @since 5 - * @deprecated since 8 - */ - static finishWithResult(param: FinishWithResultParams): Promise; - - /** - - * Get device information list. - * @param flag Default 0, get the information list of all devices in the network. - * @returns A Promise object is returned, which contains the result whether the device information list is obtained successfully. - * @since 5 - * @deprecated since 8 - */ - static getDeviceList(flag: number): Promise; - - /** - - * Calls an AA. - * @param param Indicates the request param. - * @returns A Promise object is returned, which contains the result data returned by the AA. The result is a JSON string. - * @since 5 - * @deprecated since 8 - */ - static callAbility(param: CallAbilityParam): Promise; - - /** - * Start FA migration. - * @returns A Promise object is returned, which contains the result data returned by the AA. The result is a JSON string. - * @since 5 - * @deprecated since 8 - */ - static continueAbility(): Promise; - - /** - * Subscribes to events of an AA. - * @param param Indicates the request param. - * @param func Indicates the event reporting callback. - * @returns A Promise object is returned, which contains the result data returned by the AA. The result is a JSON string. - * @since 5 - * @deprecated since 8 - */ - static subscribeAbilityEvent(param: SubscribeAbilityEventParam, func: Function): Promise; - - /** - * Unsubscribes from events of an AA. - * @param param Indicates the request param. - * @returns A Promise object is returned, which contains the result data returned by the AA. The result is a JSON string. - * @since 5 - * @deprecated since 8 - */ - static unsubscribeAbilityEvent(param: SubscribeAbilityEventParam): Promise; - - /** - * Sends messages to the destination device. - * @param options Options. - * @since 5 - * @systemapi - * @deprecated since 8 - */ - static sendMsg(options: SendMessageOptions): void; - - /** - * Listens for messages sent from other devices. - * @param options Options. - * @since 5 - * @systemapi - * @deprecated since 8 - */ - static subscribeMsg(options: SubscribeMessageOptions): void; - - /** - * Cancels the listening for messages sent from other devices. - * @since 5 - * @systemapi - * @deprecated since 8 - */ - static unsubscribeMsg(): void; -} +/* + * Copyright (c) 2020 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. + */ + +/** + * @since 5 + * @deprecated since 8 + */ +export interface Result { + /** + * Result code. + * @since 5 + */ + code: number; + + /** + * Returned data. + * @since 5 + */ + data: object; +} + +/** + * @since 5 + * @systemapi + * @deprecated since 8 + */ +export interface SubscribeMessageResponse { + /** + * Peer device ID. + * @since 5 + */ + deviceId: string; + + /** + * Name of the bundle where the peer ability locates. The name is case sensitive. + * @since 5 + */ + bundleName: string; + + /** + * Peer ability name, which is case sensitive. + * @since 5 + */ + abilityName: string; + + /** + * Messages received from the device. + * @since 5 + */ + message: string; +} + +/** + * @since 5 + * @deprecated since 8 + */ +export interface CallAbilityParam { + /** + * Name of the bundle where the ability locates. The name is case sensitive and must be the same as that on the AA side. + * @since 5 + */ + bundleName: string; + + /** + * Ability name, which is case sensitive and must be the same as that on the AA side. + * @since 5 + */ + abilityName: string; + + /** + * Ability operation code, which defines the service function of an AA and must be consistent with the AA side. + * @since 5 + */ + messageCode: number; + + /** + * Ability type. Different types of abilities have different implementation on the AA side. + * 0: Ability, which has an independent lifecycle. The FA starts and requests an AA through an RPC. Such type of abilities are used to provide basic services for multiple FAs to call or are used when the abilities should run in the background. + * 1: Internal ability, which shares the same process with the FA and communicates with it by calling internal functions. Such type of abilities are used in scenarios that require low response latency and cannot be called by other FAs. + * @since 5 + */ + abilityType: number; + + /** + * Data sent to the ability. The data to carry differs depending on the service to be processed and its field name must be consistent with the AA side. + * @since 5 + */ + data?: object; + + /** + * Whether the request is synchronous or asynchronous. The synchronous mode is used by default. Currently, the asynchronous mode is available only for internal abilities. + * 0: Synchronous mode (default value) + * 1: Asynchronous mode + * @since 5 + */ + syncOption?: number; +} + +/** + * @since 5 + * @deprecated since 8 + */ +export interface SubscribeAbilityEventParam { + /** + * Name of the bundle where the ability locates. The name is case sensitive and must be the same as that on the AA side. + * @since 5 + */ + bundleName: string; + + /** + * Ability name, which is case sensitive and must be the same as that on the AA side. + * @since 5 + */ + abilityName: string; + + /** + * Ability operation code, which defines the service function of an AA and must be consistent with the AA side. + * @since 5 + */ + messageCode: number; + + /** + * Ability type. Different types of abilities have different implementation on the AA side. + * 0: Ability, which has an independent lifecycle. The FA starts and requests an AA through an RPC. Such type of abilities are used to provide basic services for multiple FAs to call or are used when the abilities should run in the background. + * 1: Internal ability, which shares the same process with the FA and communicates with it by calling internal functions. Such type of abilities are used in scenarios that require low response latency and cannot be called by other FAs. + * @since 5 + */ + abilityType: number; + + /** + * Whether the request is synchronous or asynchronous. The synchronous mode is used by default. Currently, the asynchronous mode is available only for internal abilities. + * 0: Synchronous mode (default value) + * 1: Asynchronous mode + * @since 5 + */ + syncOption?: number; +} + +/** + * @since 5 + * @systemapi + * @deprecated since 8 + */ +export interface SendMessageOptions { + /** + * Destination device ID. + * @since 5 + */ + deviceId: string; + + /** + * Name of the destination bundle where the ability locates. The name is case sensitive. + * @since 5 + */ + bundleName: string; + + /** + * Destination ability name, which is case sensitive. + * @since 5 + */ + abilityName: string; + + /** + * Messages sent to the destination device. + * A maximum of 1 KB of data can be transmitted at a time. + * If more than 1 KB of data needs to be transmitted, split the messages into multiple parts to transmit. + * @since 5 + */ + message?: string; + + /** + * Called when the messages are sent successfully. + * @since 5 + */ + success?: () => void; + + /** + * Called when the messages fail to be sent. + * @since 5 + */ + fail?: (data: string, code: number) => void; + + /** + * Called when the execution is completed. + * @since 5 + */ + complete?: () => void; +} + +/** + * @since 5 + * @systemapi + * @deprecated since 8 + */ +export interface SubscribeMessageOptions { + /** + * Called when the messages are sent successfully. + * @since 5 + */ + success?: (data: SubscribeMessageResponse) => void; + + /** + * Called when the messages fail to be sent. + * @since 5 + */ + fail?: (data: string, code: number) => void; +} + +/** + * @since 5 + * @deprecated since 8 + */ +export interface RequestParams { + /** + * The name of the bundle to start. It should be used with abilityname and case sensitive. + * @since 5 + */ + bundleName?: string; + + /** + * Ability name, which is case sensitive. + * @since 5 + */ + abilityName?: string; + + /** + * The list of entities to which the FA to be called. If it is not filled in, all entity lists will be found by default. It should be used with action. + * @since 5 + */ + entities?: Array; + + /** + * Without specifying the bundle name and ability name, you can start the application according to other properties with action. + * @since 5 + */ + action?: string; + + /** + * If more than one FA meets the conditions, the user can select the device from the popup. + * 0: Default. Select the FA to start from the local and remote devices. + * 1: start FA from the local device. + * @since 5 + */ + deviceType?: number; + + /** + * Data sent to the ability which need to be serializable. + * @since 5 + */ + data?: object; + + /** + * Configuration switch when start FA. + * @since 5 + */ + flag?: number; + + /** + * Specify the url of the page which the FA to be called. Use home page directly by default. + * @since 5 + */ + url?: string; +} + +/** + * @since 5 + * @deprecated since 8 + */ +export interface FinishWithResultParams { + /** + * Result code. + * @since 5 + */ + code: number; + + /** + * Returned data. + * @since 5 + */ + result: object; +} + +/** + * @since 5 + * @deprecated since 8 + */ +export declare class FeatureAbility { + /** + * Start a FA without callback result. + * @param request Indicates the request param. + * @returns A Promise object is returned, which contains the result of whether to call Ability's interface successfully. + * @since 5 + * @deprecated since 8 + */ + static startAbility(request: RequestParams): Promise; + + /** + * Start a FA with callback result. + * @param request Indicates the request param. + * @returns A Promise object is returned, which contains the result of the data FA returned. + * @since 5 + * @deprecated since 8 + */ + static startAbilityForResult(request: RequestParams): Promise; + + /** + * FA call the interface to destory itself and set the result as parameters. + * @param request Indicates the request param. + * @returns A Promise object is returned, which contains the result whether to callback successfully. + * @since 5 + * @deprecated since 8 + */ + static finishWithResult(param: FinishWithResultParams): Promise; + + /** + + * Get device information list. + * @param flag Default 0, get the information list of all devices in the network. + * @returns A Promise object is returned, which contains the result whether the device information list is obtained successfully. + * @since 5 + * @deprecated since 8 + */ + static getDeviceList(flag: number): Promise; + + /** + + * Calls an AA. + * @param param Indicates the request param. + * @returns A Promise object is returned, which contains the result data returned by the AA. The result is a JSON string. + * @since 5 + * @deprecated since 8 + */ + static callAbility(param: CallAbilityParam): Promise; + + /** + * Start FA migration. + * @returns A Promise object is returned, which contains the result data returned by the AA. The result is a JSON string. + * @since 5 + * @deprecated since 8 + */ + static continueAbility(): Promise; + + /** + * Subscribes to events of an AA. + * @param param Indicates the request param. + * @param func Indicates the event reporting callback. + * @returns A Promise object is returned, which contains the result data returned by the AA. The result is a JSON string. + * @since 5 + * @deprecated since 8 + */ + static subscribeAbilityEvent(param: SubscribeAbilityEventParam, func: Function): Promise; + + /** + * Unsubscribes from events of an AA. + * @param param Indicates the request param. + * @returns A Promise object is returned, which contains the result data returned by the AA. The result is a JSON string. + * @since 5 + * @deprecated since 8 + */ + static unsubscribeAbilityEvent(param: SubscribeAbilityEventParam): Promise; + + /** + * Sends messages to the destination device. + * @param options Options. + * @since 5 + * @systemapi + * @deprecated since 8 + */ + static sendMsg(options: SendMessageOptions): void; + + /** + * Listens for messages sent from other devices. + * @param options Options. + * @since 5 + * @systemapi + * @deprecated since 8 + */ + static subscribeMsg(options: SubscribeMessageOptions): void; + + /** + * Cancels the listening for messages sent from other devices. + * @since 5 + * @systemapi + * @deprecated since 8 + */ + static unsubscribeMsg(): void; +} diff --git a/api/common/lite/console.d.ts b/api/common/lite/console.d.ts index fa2c5cc33e..2d8d27582d 100644 --- a/api/common/lite/console.d.ts +++ b/api/common/lite/console.d.ts @@ -1,46 +1,46 @@ -/* - * Copyright (c) 2020 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. - */ - -export declare class console { - /** - * Prints "debug" logs. - * @param message Text to print - */ - static debug(message: string): void; - - /** - * Prints "log" logs. - * @param message Text to print - */ - static log(message: string): void; - - /** - * Prints "info" logs. - * @param message Text to print - */ - static info(message: string): void; - - /** - * Prints "warn" logs. - * @param message Text to print - */ - static warn(message: string): void; - - /** - * Prints "error" logs. - * @param message Text to print - */ - static error(message: string): void; -} +/* + * Copyright (c) 2020 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. + */ + +export declare class console { + /** + * Prints "debug" logs. + * @param message Text to print + */ + static debug(message: string): void; + + /** + * Prints "log" logs. + * @param message Text to print + */ + static log(message: string): void; + + /** + * Prints "info" logs. + * @param message Text to print + */ + static info(message: string): void; + + /** + * Prints "warn" logs. + * @param message Text to print + */ + static warn(message: string): void; + + /** + * Prints "error" logs. + * @param message Text to print + */ + static error(message: string): void; +} diff --git a/api/common/lite/featureability.d.ts b/api/common/lite/featureability.d.ts index cbe4af8797..014cbb7538 100644 --- a/api/common/lite/featureability.d.ts +++ b/api/common/lite/featureability.d.ts @@ -1,147 +1,147 @@ -/* - * Copyright (c) 2020 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. - */ - -/** - * @since 5 - * @systemapi - * @deprecated since 8 - */ -export interface SubscribeMessageResponse { - /** - * Peer device ID. - * @since 5 - */ - deviceId: string; - - /** - * Name of the bundle where the peer ability locates. The name is case sensitive. - * @since 5 - */ - bundleName: string; - - /** - * Peer ability name, which is case sensitive. - * @since 5 - */ - abilityName: string; - - /** - * Messages received from the device. - * @since 5 - */ - message: string; -} - -/** - * @since 5 - * @systemapi - * @deprecated since 8 - */ -export interface SendMessageOptions { - /** - * Destination device ID. - * @since 5 - */ - deviceId: string; - - /** - * Name of the destination bundle where the ability locates. The name is case sensitive. - * @since 5 - */ - bundleName: string; - - /** - * Destination ability name, which is case sensitive. - * @since 5 - */ - abilityName: string; - - /** - * Messages sent to the destination device. - * A maximum of 1 KB of data can be transmitted at a time. - * If more than 1 KB of data needs to be transmitted, split the messages into multiple parts to transmit. - * @since 5 - */ - message?: string; - - /** - * Called when the messages are sent successfully. - * @since 5 - */ - success?: () => void; - - /** - * Called when the messages fail to be sent. - * @since 5 - */ - fail?: (data: string, code: number) => void; - - /** - * Called when the execution is completed. - * @since 5 - */ - complete?: () => void; -} - -/** - * @since 5 - * @systemapi - * @deprecated since 8 - */ -export interface SubscribeMessageOptions { - /** - * Called when the messages are sent successfully. - * @since 5 - */ - success?: (data: SubscribeMessageResponse) => void; - - /** - * Called when the messages fail to be sent. - * @since 5 - */ - fail?: (data: string, code: number) => void; -} - -/** - * @since 5 - * @deprecated since 8 - */ -export declare class FeatureAbility { - /** - * Sends messages to the destination device. - * @param options Options. - * @since 5 - * @systemapi - * @deprecated since 8 - */ - static sendMsg(options: SendMessageOptions): void; - - /** - * Listens for messages sent from other devices. - * @param options Options. - * @since 5 - * @systemapi - * @deprecated since 8 - */ - static subscribeMsg(options: SubscribeMessageOptions): void; - - /** - * Cancels the listening for messages sent from other devices. - * @since 5 - * @systemapi - * @deprecated since 8 - */ - static unsubscribeMsg(): void; -} +/* + * Copyright (c) 2020 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. + */ + +/** + * @since 5 + * @systemapi + * @deprecated since 8 + */ +export interface SubscribeMessageResponse { + /** + * Peer device ID. + * @since 5 + */ + deviceId: string; + + /** + * Name of the bundle where the peer ability locates. The name is case sensitive. + * @since 5 + */ + bundleName: string; + + /** + * Peer ability name, which is case sensitive. + * @since 5 + */ + abilityName: string; + + /** + * Messages received from the device. + * @since 5 + */ + message: string; +} + +/** + * @since 5 + * @systemapi + * @deprecated since 8 + */ +export interface SendMessageOptions { + /** + * Destination device ID. + * @since 5 + */ + deviceId: string; + + /** + * Name of the destination bundle where the ability locates. The name is case sensitive. + * @since 5 + */ + bundleName: string; + + /** + * Destination ability name, which is case sensitive. + * @since 5 + */ + abilityName: string; + + /** + * Messages sent to the destination device. + * A maximum of 1 KB of data can be transmitted at a time. + * If more than 1 KB of data needs to be transmitted, split the messages into multiple parts to transmit. + * @since 5 + */ + message?: string; + + /** + * Called when the messages are sent successfully. + * @since 5 + */ + success?: () => void; + + /** + * Called when the messages fail to be sent. + * @since 5 + */ + fail?: (data: string, code: number) => void; + + /** + * Called when the execution is completed. + * @since 5 + */ + complete?: () => void; +} + +/** + * @since 5 + * @systemapi + * @deprecated since 8 + */ +export interface SubscribeMessageOptions { + /** + * Called when the messages are sent successfully. + * @since 5 + */ + success?: (data: SubscribeMessageResponse) => void; + + /** + * Called when the messages fail to be sent. + * @since 5 + */ + fail?: (data: string, code: number) => void; +} + +/** + * @since 5 + * @deprecated since 8 + */ +export declare class FeatureAbility { + /** + * Sends messages to the destination device. + * @param options Options. + * @since 5 + * @systemapi + * @deprecated since 8 + */ + static sendMsg(options: SendMessageOptions): void; + + /** + * Listens for messages sent from other devices. + * @param options Options. + * @since 5 + * @systemapi + * @deprecated since 8 + */ + static subscribeMsg(options: SubscribeMessageOptions): void; + + /** + * Cancels the listening for messages sent from other devices. + * @since 5 + * @systemapi + * @deprecated since 8 + */ + static unsubscribeMsg(): void; +} diff --git a/api/common/lite/global.d.ts b/api/common/lite/global.d.ts index 6594563f79..4c2f3f0193 100644 --- a/api/common/lite/global.d.ts +++ b/api/common/lite/global.d.ts @@ -1,78 +1,78 @@ -/* - * Copyright (c) 2020 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. - */ - -/** - * Sets the interval for repeatedly calling a function. - * @param handler Indicates the function to be called repeatedly at the interval. - * @param delay Indicates the interval between each two calls, in milliseconds. The function will be called after this delay. - * @param arguments Indicates additional arguments to pass to "handler" when the timer goes off. - * @returns Returns the timer ID. - */ -export declare function setInterval( - handler: Function, - delay: number, - ...arguments: any[] -): number; - -/** - * Sets a timer after which a function will be executed. - * @param handler Indicates the function to be called after the timer goes off. - * @param delay Indicates the delay (in milliseconds) after which the function will be called. If this parameter is left empty, default value "0" will be used, which means that the function will be called immediately or as soon as possible. - * @param arguments Indicates additional arguments to pass to "handler" when the timer goes off. - * @returns Returns the timer ID. - */ -export declare function setTimeout( - handler: Function, - delay?: number, - ...arguments: any[] -): number; - -/** - * Cancels the interval set by " setInterval()". - * @param intervalID Indicates the timer ID returned by "setInterval()". - */ -export declare function clearInterval(intervalID?: number): void; - -/** - * Cancels the timer set by " setTimeout()". - * @param timeoutID Indicates the timer ID returned by "setTimeout()". - */ -export declare function clearTimeout(timeoutID?: number): void; - -/** - * Get the java interface instance. The java instance needs to register, otherwise it cannot be obtained. - * After obtaining the instance, you can call the function with the same name on the Java side. - * @param name Java interface name, including package path, such as com.example.test.timeinterfaceimpl. - * @returns A promise object is returned. The resolve callback is the object of PA. The reject callback returns the object containing code and error data. - * @since 5 - * @deprecated since 8 - */ -export declare function createLocalParticleAbility(name?: string): any; - -/** - * Conditional compilation for rich equipment - */ -export declare const STANDARD: string; - -/** - * Conditional compilation for lite equipment - */ -export declare const LITE: string; - -/** - * Defining syscap function. - * @since 8 - */ -export declare function canIUse(syscap: string): boolean; +/* + * Copyright (c) 2020 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. + */ + +/** + * Sets the interval for repeatedly calling a function. + * @param handler Indicates the function to be called repeatedly at the interval. + * @param delay Indicates the interval between each two calls, in milliseconds. The function will be called after this delay. + * @param arguments Indicates additional arguments to pass to "handler" when the timer goes off. + * @returns Returns the timer ID. + */ +export declare function setInterval( + handler: Function, + delay: number, + ...arguments: any[] +): number; + +/** + * Sets a timer after which a function will be executed. + * @param handler Indicates the function to be called after the timer goes off. + * @param delay Indicates the delay (in milliseconds) after which the function will be called. If this parameter is left empty, default value "0" will be used, which means that the function will be called immediately or as soon as possible. + * @param arguments Indicates additional arguments to pass to "handler" when the timer goes off. + * @returns Returns the timer ID. + */ +export declare function setTimeout( + handler: Function, + delay?: number, + ...arguments: any[] +): number; + +/** + * Cancels the interval set by " setInterval()". + * @param intervalID Indicates the timer ID returned by "setInterval()". + */ +export declare function clearInterval(intervalID?: number): void; + +/** + * Cancels the timer set by " setTimeout()". + * @param timeoutID Indicates the timer ID returned by "setTimeout()". + */ +export declare function clearTimeout(timeoutID?: number): void; + +/** + * Get the java interface instance. The java instance needs to register, otherwise it cannot be obtained. + * After obtaining the instance, you can call the function with the same name on the Java side. + * @param name Java interface name, including package path, such as com.example.test.timeinterfaceimpl. + * @returns A promise object is returned. The resolve callback is the object of PA. The reject callback returns the object containing code and error data. + * @since 5 + * @deprecated since 8 + */ +export declare function createLocalParticleAbility(name?: string): any; + +/** + * Conditional compilation for rich equipment + */ +export declare const STANDARD: string; + +/** + * Conditional compilation for lite equipment + */ +export declare const LITE: string; + +/** + * Defining syscap function. + * @since 8 + */ +export declare function canIUse(syscap: string): boolean; diff --git a/api/common/lite/index.d.ts b/api/common/lite/index.d.ts index 8712a2be0c..2b74cea7b7 100644 --- a/api/common/lite/index.d.ts +++ b/api/common/lite/index.d.ts @@ -1,19 +1,19 @@ -/* - * Copyright (c) 2020 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. - */ - -export * from './viewmodel'; -export * from './featureability'; -export * from './console'; +/* + * Copyright (c) 2020 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. + */ + +export * from './viewmodel'; +export * from './featureability'; +export * from './console'; export * from './global'; \ No newline at end of file diff --git a/api/common/lite/viewmodel.d.ts b/api/common/lite/viewmodel.d.ts index cc51a0bd26..bd23458986 100644 --- a/api/common/lite/viewmodel.d.ts +++ b/api/common/lite/viewmodel.d.ts @@ -1,118 +1,118 @@ -/* - * Copyright (c) 2020 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. - */ - -export interface ViewModel { - /** - * Displays content based on the current system language and a path of the language resource key specified through $t. - * @param path Path of the language resource key - * @param param Content used to replace placeholders during runtime. There are two types of placeholders available: - * 1. Named placeholder, for example, {name}. The actual content must be of the object type, for example, $t('strings.object', {name: 'Hello world'}). - * 2. Digit placeholder, for example, {0}. The actual content must be of the array type, for example, $t('strings.array', ['Hello world']). - * @returns content to display - */ - $t(path: string, param?: object | Array): string; - - /** - * An object that holds all DOM elements and component instances that have been registered with the refs attribute - */ - $refs: ElementReferences; -} - -export interface ListScrollToOptions { - /** - * specified position. - */ - index: number; -} - -export interface ListElement { - /** - * Scrolls the list to the position of the item at the specified index. - */ - scrollTo(position: ListScrollToOptions): void; -} - -export interface ImageAnimatorElement { - /** - * Starts to play the frame animation of an image. If this method is called again, the playback starts from the first frame. - */ - start(): void; - /** - * Pauses the frame animation playback of an image. - */ - pause(): void; - /** - * Stops the frame animation playback of an image. - */ - stop(): void; - /** - * Resumes the frame animation playback of an image. - */ - resume(): void; - /** - * Obtains the playback state. Available values are as follows: - * Playing - * Paused - * Stopped - */ - getState(): "Playing" | "Paused" | "Stopped"; -} - -export interface ElementReferences { - [k: string]: object & ListElement & ImageAnimatorElement; -} - -export interface Options> { - /** - * Data model of the page that can be converted into a JSON object. - * The attribute name cannot start with $ or an underscore (_) or contain the reserved words such as for, if, show, and tid. - * For a function, the return value must be an object. - * Set the value of data to the return value of the function during page initialization. - */ - data?: Data; - - /** - * Called when the page is initialized. This function can be called only once in a lifecycle. - */ - onInit?(): void; - - /** - * Called when the page is created. This function can be called only once in a lifecycle. - */ - onReady?(): void; - - /** - * Called when the page is displayed. - */ - onShow?(): void; - - /** - * Called when the application is created - */ - onCreate?(): void; - - /** - * Called when the application is destroyed or called when the page is redirected to another one (without entering the navigation stack). - */ - onDestroy?(): void; -} - -type DefaultData = object; -type CombinedOptions = object & - Options & - ThisType; -export declare function extendViewModel( - options: CombinedOptions -): ViewModel & Data; +/* + * Copyright (c) 2020 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. + */ + +export interface ViewModel { + /** + * Displays content based on the current system language and a path of the language resource key specified through $t. + * @param path Path of the language resource key + * @param param Content used to replace placeholders during runtime. There are two types of placeholders available: + * 1. Named placeholder, for example, {name}. The actual content must be of the object type, for example, $t('strings.object', {name: 'Hello world'}). + * 2. Digit placeholder, for example, {0}. The actual content must be of the array type, for example, $t('strings.array', ['Hello world']). + * @returns content to display + */ + $t(path: string, param?: object | Array): string; + + /** + * An object that holds all DOM elements and component instances that have been registered with the refs attribute + */ + $refs: ElementReferences; +} + +export interface ListScrollToOptions { + /** + * specified position. + */ + index: number; +} + +export interface ListElement { + /** + * Scrolls the list to the position of the item at the specified index. + */ + scrollTo(position: ListScrollToOptions): void; +} + +export interface ImageAnimatorElement { + /** + * Starts to play the frame animation of an image. If this method is called again, the playback starts from the first frame. + */ + start(): void; + /** + * Pauses the frame animation playback of an image. + */ + pause(): void; + /** + * Stops the frame animation playback of an image. + */ + stop(): void; + /** + * Resumes the frame animation playback of an image. + */ + resume(): void; + /** + * Obtains the playback state. Available values are as follows: + * Playing + * Paused + * Stopped + */ + getState(): "Playing" | "Paused" | "Stopped"; +} + +export interface ElementReferences { + [k: string]: object & ListElement & ImageAnimatorElement; +} + +export interface Options> { + /** + * Data model of the page that can be converted into a JSON object. + * The attribute name cannot start with $ or an underscore (_) or contain the reserved words such as for, if, show, and tid. + * For a function, the return value must be an object. + * Set the value of data to the return value of the function during page initialization. + */ + data?: Data; + + /** + * Called when the page is initialized. This function can be called only once in a lifecycle. + */ + onInit?(): void; + + /** + * Called when the page is created. This function can be called only once in a lifecycle. + */ + onReady?(): void; + + /** + * Called when the page is displayed. + */ + onShow?(): void; + + /** + * Called when the application is created + */ + onCreate?(): void; + + /** + * Called when the application is destroyed or called when the page is redirected to another one (without entering the navigation stack). + */ + onDestroy?(): void; +} + +type DefaultData = object; +type CombinedOptions = object & + Options & + ThisType; +export declare function extendViewModel( + options: CombinedOptions +): ViewModel & Data; -- Gitee From ba5d9913f22cc5477364239b8fb955d56be27e09 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E8=82=96=E5=B8=85?= Date: Fri, 1 Jul 2022 16:37:48 +0800 Subject: [PATCH 03/15] =?UTF-8?q?Signed-off-by:=20=E8=82=96=E5=B8=85=20?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Changes to be committed: modified: api/@ohos.uitest.d.ts --- api/@ohos.uitest.d.ts | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/api/@ohos.uitest.d.ts b/api/@ohos.uitest.d.ts index f1dd392982..b35917fbaa 100755 --- a/api/@ohos.uitest.d.ts +++ b/api/@ohos.uitest.d.ts @@ -471,6 +471,24 @@ class UiComponent{ * @test */ dragTo(target: UiComponent): Promise; + + /** + * Pinch enlarge this {@link UiComponent} to the target scale. + * @syscap SystemCapability.Test.UiTest + * @param scale the scale of the pinch enlarge this {@link UiComponent}'s size. + * @since 9 + * @test + */ + pinchOut(scale: number): Promise; + + /** + * Pinch shrink this {@link UiComponent} to the target scale. + * @syscap SystemCapability.Test.UiTest + * @param scale the scale of the pinch shrink this {@link UiComponent}'s size. + * @since 9 + * @test + */ + pinchIn(scale: number): Promise; } /** -- Gitee From 86ea1c11bdb3cba8d4063a4c773f303415fbe7b7 Mon Sep 17 00:00:00 2001 From: shikai-123 Date: Mon, 4 Jul 2022 12:39:56 +0800 Subject: [PATCH 04/15] Modify the return value type of promisewrapper Change the return value from object to function issues: https://gitee.com/openharmony/js_util_module/issues/I5DVPV Signed-off-by: zhoufei --- api/@ohos.util.d.ts | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/api/@ohos.util.d.ts b/api/@ohos.util.d.ts index ea00afe070..f3f42ea249 100644 --- a/api/@ohos.util.d.ts +++ b/api/@ohos.util.d.ts @@ -64,10 +64,21 @@ declare namespace util { */ function callbackWrapper(original: Function): (err: Object, value: Object) => void; + /** + * Takes a function following the common error-first callback style, i.e taking an (err, value) => + * callback as the last argument, and return a function that returns promises. + * @since 9 + * @syscap SystemCapability.Utils.Lang + * @param original asynchronous function + * @return return a version that returns promises + */ + function promiseWrapper(original: (err: Object, value: Object) => void): Function; + /** * Takes a function following the common error-first callback style, i.e taking an (err, value) => * callback as the last argument, and return a version that returns promises. * @since 7 + * @deprecated since 9 * @syscap SystemCapability.Utils.Lang * @param original asynchronous function * @return return a version that returns promises -- Gitee From 19b98cac0e444b20db4b68b326f8c4fc6cbff2bb Mon Sep 17 00:00:00 2001 From: ql Date: Mon, 4 Jul 2022 06:18:22 +0000 Subject: [PATCH 05/15] update api/@ohos.distributedMissionManager.d.ts. Signed-off-by: ql --- api/@ohos.distributedMissionManager.d.ts | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/api/@ohos.distributedMissionManager.d.ts b/api/@ohos.distributedMissionManager.d.ts index 4ea8d0791f..5bd5e2f7e0 100755 --- a/api/@ohos.distributedMissionManager.d.ts +++ b/api/@ohos.distributedMissionManager.d.ts @@ -24,7 +24,7 @@ import { MissionParameter } from './application/MissionParameter'; * @name distributedMissionManager * @since 9 * @syscap SystemCapability.Ability.AbilityRuntime.Mission - * @permission N/A + * @permission ohos.permission.MANAGE_MISSIONS * @systemapi Hide this for inner system use. */ declare namespace distributedMissionManager { @@ -34,7 +34,6 @@ declare namespace distributedMissionManager { * @since 9 * @syscap SystemCapability.Ability.AbilityRuntime.Mission. * @param parameter Parameters corresponding to mission. - * @return - * @systemapi Hide this for inner system use. */ function startSyncRemoteMissions(parameter: MissionParameter, callback: AsyncCallback): void; @@ -46,7 +45,6 @@ declare namespace distributedMissionManager { * @since 9 * @syscap SystemCapability.Ability.AbilityRuntime.Mission. * @param parameter Parameters corresponding to mission. - * @return - * @systemapi Hide this for inner system use. */ function stopSyncRemoteMissions(parameter: MissionDeviceInfo, callback: AsyncCallback): void; @@ -59,7 +57,6 @@ declare namespace distributedMissionManager { * @syscap SystemCapability.Ability.AbilityRuntime.Mission * @param parameter Parameters corresponding to mission. * @param options The callbacks for regist mission. - * @return - * @systemapi Hide this for inner system use. */ function registerMissionListener(parameter: MissionDeviceInfo, options: MissionCallback, callback: AsyncCallback): void; @@ -71,7 +68,6 @@ declare namespace distributedMissionManager { * @since 9 * @syscap SystemCapability.Ability.AbilityRuntime.Mission * @param parameter Parameters corresponding to mission. - * @return - * @systemapi Hide this for inner system use. */ function unRegisterMissionListener(parameter: MissionDeviceInfo, callback:AsyncCallback): void; -- Gitee From 03c3f5a9c0cdb6e43e7c4ce8c3f8f7b653568c18 Mon Sep 17 00:00:00 2001 From: ql Date: Mon, 4 Jul 2022 06:19:20 +0000 Subject: [PATCH 06/15] update api/application/MissionCallbacks.d.ts. Signed-off-by: ql --- api/application/MissionCallbacks.d.ts | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/api/application/MissionCallbacks.d.ts b/api/application/MissionCallbacks.d.ts index de4a16551b..02a4962069 100755 --- a/api/application/MissionCallbacks.d.ts +++ b/api/application/MissionCallbacks.d.ts @@ -19,7 +19,7 @@ * @name MissionCallback * @since 9 * @syscap SystemCapability.Ability.AbilityRuntime.Mission - * @permission N/A + * @permission ohos.permission.MANAGE_MISSIONS * @systemapi hide for inner use. */ export interface MissionCallback { @@ -29,7 +29,6 @@ * @since 9 * @syscap SystemCapability.Ability.AbilityRuntime.Mission * @param deviceId Indicates the deviceId mission changed. - * @return - */ notifyMissionsChanged(deviceId: string): void; @@ -40,7 +39,6 @@ * @syscap SystemCapability.Ability.AbilityRuntime.Mission * @param deviceId Indicates the deviceId mission changed. * @param mission Indicates the id of destroyed mission. - * @return - */ notifySnapshot(deviceId: string, mission: number): void; @@ -51,7 +49,6 @@ * @syscap SystemCapability.Ability.AbilityRuntime.Mission * @param deviceId Indicates the deviceId mission changed. * @param state Indicates the state of network - * @return - */ notifyNetDisconnect(deviceId: string, state: number): void; } \ No newline at end of file -- Gitee From d89ad6a6a52ba9f257c24182ea4556fdc411349d Mon Sep 17 00:00:00 2001 From: ql Date: Mon, 4 Jul 2022 06:19:55 +0000 Subject: [PATCH 07/15] update api/application/MissionDeviceInfo.d.ts. Signed-off-by: ql --- api/application/MissionDeviceInfo.d.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/api/application/MissionDeviceInfo.d.ts b/api/application/MissionDeviceInfo.d.ts index d4ba0f2dbe..911a7455b4 100755 --- a/api/application/MissionDeviceInfo.d.ts +++ b/api/application/MissionDeviceInfo.d.ts @@ -18,7 +18,7 @@ * * @since 9 * @syscap SystemCapability.Ability.AbilityRuntime.Mission - * @permission N/A + * @permission ohos.permission.MANAGE_MISSIONS * @systemapi hide for inner use. */ export interface MissionDeviceInfo { -- Gitee From 15384df73a870f97b329ab9b12dd80dfaead61b5 Mon Sep 17 00:00:00 2001 From: ql Date: Mon, 4 Jul 2022 06:20:24 +0000 Subject: [PATCH 08/15] update api/application/MissionParameter.d.ts. Signed-off-by: ql --- api/application/MissionParameter.d.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/api/application/MissionParameter.d.ts b/api/application/MissionParameter.d.ts index 6d0455f67b..e1b67f209e 100755 --- a/api/application/MissionParameter.d.ts +++ b/api/application/MissionParameter.d.ts @@ -18,7 +18,7 @@ * * @since 9 * @syscap SystemCapability.Ability.AbilityRuntime.Mission - * @permission N/A + * @permission ohos.permission.MANAGE_MISSIONS * @systemapi hide for inner use. */ export interface MissionParameter { -- Gitee From 6874b87a254e310a2304b01eac48c473006b4b5d Mon Sep 17 00:00:00 2001 From: ql Date: Mon, 4 Jul 2022 06:33:03 +0000 Subject: [PATCH 09/15] update api/@ohos.distributedMissionManager.d.ts. Signed-off-by: ql --- api/@ohos.distributedMissionManager.d.ts | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/api/@ohos.distributedMissionManager.d.ts b/api/@ohos.distributedMissionManager.d.ts index 5bd5e2f7e0..fb832ffd22 100755 --- a/api/@ohos.distributedMissionManager.d.ts +++ b/api/@ohos.distributedMissionManager.d.ts @@ -52,7 +52,7 @@ declare namespace distributedMissionManager { /** * Register the missionListener to ams. - * @default - + * * @since 9 * @syscap SystemCapability.Ability.AbilityRuntime.Mission * @param parameter Parameters corresponding to mission. @@ -64,7 +64,7 @@ declare namespace distributedMissionManager { /** * Unrgister the missionListener to ams. - * @default - + * * @since 9 * @syscap SystemCapability.Ability.AbilityRuntime.Mission * @param parameter Parameters corresponding to mission. -- Gitee From 796e2a794ff0ec08ac498c32b852202b8a5eeb1c Mon Sep 17 00:00:00 2001 From: dy Date: Mon, 4 Jul 2022 15:26:39 +0800 Subject: [PATCH 10/15] =?UTF-8?q?IssueNo:#I5FB6=20GsetModuleUpgradeFlag?= =?UTF-8?q?=E6=8E=A5=E5=8F=A3=E7=9A=84=E5=8F=82=E6=95=B0isNeedUpdate?= =?UTF-8?q?=E4=B8=8D=E5=AF=B9=20Description:=E4=BF=AE=E6=94=B9upgradeFlag?= =?UTF-8?q?=E7=9A=84=E6=B3=A8=E9=87=8A=20Sig:SIG=5FApplicaitonFramework=20?= =?UTF-8?q?Feature=20or=20Bugfix:Bugfix=20Binary=20Source:No?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: dy --- api/@ohos.bundle.d.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/api/@ohos.bundle.d.ts b/api/@ohos.bundle.d.ts index 005100ea3b..9c18952094 100644 --- a/api/@ohos.bundle.d.ts +++ b/api/@ohos.bundle.d.ts @@ -704,7 +704,7 @@ declare namespace bundle { * @syscap SystemCapability.BundleManager.BundleFramework * @param bundleName Indicates the bundle name of the application. * @param moduleName Indicates the module name of the application. - * @param isNeedUpdate Indicates isNeedUpdate of the application. + * @param upgradeFlag Indicates upgradeFlag of the application. * @systemapi Hide this for inner system use */ function setModuleUpgradeFlag(bundleName: string, moduleName: string, upgradeFlag: UpgradeFlag, callback: AsyncCallback):void; -- Gitee From 9639f8a6207bdda09336bc7616a16f6786529d42 Mon Sep 17 00:00:00 2001 From: zhangqiang183 Date: Tue, 5 Jul 2022 19:53:41 +0800 Subject: [PATCH 11/15] add image dts Signed-off-by: zhangqiang183 --- api/@ohos.multimedia.image.d.ts | 206 ++++++++++++++++++++++++++++++++ 1 file changed, 206 insertions(+) diff --git a/api/@ohos.multimedia.image.d.ts b/api/@ohos.multimedia.image.d.ts index 17ec79142e..682810e42a 100644 --- a/api/@ohos.multimedia.image.d.ts +++ b/api/@ohos.multimedia.image.d.ts @@ -503,6 +503,34 @@ declare namespace image { scaleMode?: ScaleMode; } + /** + * Initialization options for ImageSource. + * @since 9 + * @syscap SystemCapability.Multimedia.Image.Core + */ + interface SourceOptions { + /** + * The density for ImageSource. + * @since 9 + * @syscap SystemCapability.Multimedia.Image.Core + */ + sourceDensity: number; + + /** + * PixelMap expected format. + * @since 8 + * @syscap SystemCapability.Multimedia.Image.Core + */ + sourcePixelFormat?: PixelMapFormat; + + /** + * PixelMap size. + * @since 8 + * @syscap SystemCapability.Multimedia.Image.Core + */ + sourceSize?: Size; + } + /** * Create pixelmap by data buffer. * @since 8 @@ -526,6 +554,16 @@ declare namespace image { */ function createImageSource(uri: string): ImageSource; + /** + * Creates an ImageSource instance based on the URI. + * @since 9 + * @syscap SystemCapability.Multimedia.Image.ImageSource + * @param uri Image source URI. + * @param options The config of Image source. + * @return Returns the ImageSource instance if the operation is successful; returns null otherwise. + */ + function createImageSource(uri: string, options: SourceOptions): ImageSource; + /** * Creates an ImageSource instance based on the file descriptor. * @since 7 @@ -535,6 +573,16 @@ declare namespace image { */ function createImageSource(fd: number): ImageSource; + /** + * Creates an ImageSource instance based on the file descriptor. + * @since 9 + * @syscap SystemCapability.Multimedia.Image.ImageSource + * @param fd ID of a file descriptor. + * @param options The config of Image source. + * @return Returns the ImageSource instance if the operation is successful; returns null otherwise. + */ + function createImageSource(fd: number, options: SourceOptions): ImageSource; + /** * Creates an ImageSource instance based on the buffer. * @since 9 @@ -544,6 +592,16 @@ declare namespace image { */ function createImageSource(buf: ArrayBuffer): ImageSource; + /** + * Creates an ImageSource instance based on the buffer. + * @since 9 + * @syscap SystemCapability.Multimedia.Image.ImageSource + * @param buf The buffer of the iamge. + * @param options The config of Image source. + * @return Returns the ImageSource instance if the operation is successful; returns null otherwise. + */ + function createImageSource(buf: ArrayBuffer, options: SourceOptions): ImageSource; + /** * Creates an ImageSource instance based on the buffer in incremental. * @since 9 @@ -553,6 +611,16 @@ declare namespace image { */ function CreateIncrementalSource(buf: ArrayBuffer): ImageSource; + /** + * Creates an ImageSource instance based on the buffer in incremental. + * @since 9 + * @syscap SystemCapability.Multimedia.Image.ImageSource + * @param buf The buffer of the iamge. + * @param options The config of source. + * @return Returns the ImageSource instance if the operation is successful; returns null otherwise. + */ + function CreateIncrementalSource(buf: ArrayBuffer, options?: SourceOptions): ImageSource; + /** * Creates an ImagePacker instance. * @since 6 @@ -697,6 +765,144 @@ declare namespace image { */ getPixelBytesNumber(): number; + /** + * Obtains the density of the image pixel map. + * @since 9 + * @syscap SystemCapability.Multimedia.Image.Core + * @return The number of density. + */ + getDensity():number; + + /** + * Set the transparent rate of pixel map. This method uses a callback to return the operation result. + * @since 9 + * @syscap SystemCapability.Multimedia.Image.Core + * @param rate The value of transparent rate. + * @param callback Callback used to return the operation result. If the operation fails, an error message is returned. + */ + opacity(rate: number, callback: AsyncCallback): void; + + /** + * Set the transparent rate of pixel map. This method uses a promise to return the result. + * @since 9 + * @syscap SystemCapability.Multimedia.Image.Core + * @param rate The value of transparent rate. + * @return A Promise instance used to return the operation result. If the operation fails, an error message is returned. + */ + opacity(rate: number): Promise; + + /** + * Obtains new pixel map with allpha information. This method uses a promise to return the information. + * @since 9 + * @syscap SystemCapability.Multimedia.Image.Core + * @return A Promise instance used to return the new image pixel map. If the operation fails, an error message is returned. + */ + createAlphaPixelmap(): Promise; + + /** + * Obtains new pixel map with allpha information. This method uses a callback to return the information. + * @since 9 + * @syscap SystemCapability.Multimedia.Image.Core + * @param callback Callback used to return the new image pixel map. If the operation fails, an error message is returned. + */ + createAlphaPixelmap(callback: AsyncCallback): void; + + /** + * Image zoom in width and height. This method uses a callback to return the operation result. + * @since 9 + * @syscap SystemCapability.Multimedia.Image.Core + * @param x The zoom value of width. + * @param y The zoom value of height. + * @param callback Callback used to return the operation result. If the operation fails, an error message is returned. + */ + scale(x: number, y: number, callback: AsyncCallback): void; + + /** + * Image zoom in width and height. This method uses a promise to return the result. + * @since 9 + * @syscap SystemCapability.Multimedia.Image.Core + * @param x The zoom value of width. + * @param y The zoom value of height. + * @return A Promise instance used to return the operation result. If the operation fails, an error message is returned. + */ + scale(x: number, y: number): Promise; + + /** + * Image position transformation. This method uses a callback to return the operation result. + * @since 9 + * @syscap SystemCapability.Multimedia.Image.Core + * @param x The position value of width. + * @param y The position value of height. + * @param callback Callback used to return the operation result. If the operation fails, an error message is returned. + */ + translate(x: number, y: number, callback: AsyncCallback): void; + + /** + * Image position transformation. This method uses a promise to return the result. + * @since 9 + * @syscap SystemCapability.Multimedia.Image.Core + * @param x The position value of width. + * @param y The position value of height. + * @return A Promise instance used to return the operation result. If the operation fails, an error message is returned. + */ + translate(x: number, y: number): Promise; + + /** + * Image rotation. This method uses a callback to return the operation result. + * @since 9 + * @syscap SystemCapability.Multimedia.Image.Core + * @param angle The rotation angle. + * @param callback Callback used to return the operation result. If the operation fails, an error message is returned. + */ + rotate(angle: number, callback: AsyncCallback): void; + + /** + * Image rotation. This method uses a promise to return the result. + * @since 9 + * @syscap SystemCapability.Multimedia.Image.Core + * @param angle The rotation angle. + * @return A Promise instance used to return the operation result. If the operation fails, an error message is returned. + */ + rotate(angle: number): Promise; + + /** + * Image flipping. This method uses a callback to return the operation result. + * @since 9 + * @syscap SystemCapability.Multimedia.Image.Core + * @param horizontal Is flip in horizontal. + * @param vertical Is flip in vertical. + * @param callback Callback used to return the operation result. If the operation fails, an error message is returned. + */ + flip(horizontal: boolean, vertical: boolean, callback: AsyncCallback): void; + + /** + * Image flipping. This method uses a promise to return the result. + * @since 9 + * @syscap SystemCapability.Multimedia.Image.Core + * @param horizontal Is flip in horizontal. + * @param vertical Is flip in vertical. + * @return A Promise instance used to return the operation result. If the operation fails, an error message is returned. + */ + flip(horizontal: boolean, vertical: boolean): Promise; + + /** + * Crop the image. This method uses a callback to return the operation result. + * @since 9 + * @syscap SystemCapability.Multimedia.Image.Core + * @param region The region to crop. + * @param callback Callback used to return the operation result. If the operation fails, an error message is returned. + */ + crop(region: Region, callback: AsyncCallback): void; + + /** + * Crop the image. This method uses a promise to return the result. + * @since 9 + * @syscap SystemCapability.Multimedia.Image.Core + * @param region The region to crop. + * @return A Promise instance used to return the operation result. If the operation fails, an error message is returned. + */ + crop(region: Region): Promise; + /** * Releases this PixelMap object. This method uses a callback to return the result. * @since 7 -- Gitee From a370fd72330bfee6d3a3e2ab6ca745d6f6ab5785 Mon Sep 17 00:00:00 2001 From: yangbo <1442420648@qq.com> Date: Tue, 5 Jul 2022 20:21:48 +0800 Subject: [PATCH 12/15] add delete_systemapi_plugin.js Signed-off-by: yangbo <1442420648@qq.com> Change-Id: Ibbf5dcaf9bd6bafc972653c9dcd08a9e7193e594 --- build-tools/delete_systemapi_plugin.js | 191 +++++++++++++++++++++++++ build-tools/package.json | 16 +++ 2 files changed, 207 insertions(+) create mode 100644 build-tools/delete_systemapi_plugin.js create mode 100644 build-tools/package.json diff --git a/build-tools/delete_systemapi_plugin.js b/build-tools/delete_systemapi_plugin.js new file mode 100644 index 0000000000..fcf3223a4f --- /dev/null +++ b/build-tools/delete_systemapi_plugin.js @@ -0,0 +1,191 @@ +/* + * 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. + */ +const path = require('path'); +const fs = require('fs'); +const ts = require('typescript'); + +let sourceFile = null; +let lastNoteStr = ''; +let lastNodeName = ''; + +function collectDeclaration(url) { + const utPath = path.resolve(__dirname, url); + const utFiles = []; + readFile(utPath, utFiles); + tsTransform(utFiles, deleteSystemApi); +} + +function tsTransform(utFiles, callback) { + utFiles.forEach((url) => { + if (/\.json/.test(url) || /index\-full\.d\.ts/.test(url) || /common\.d\.ts/.test(url)) { + const content = fs.readFileSync(url, 'utf-8'); + writeFile(url, content); + } else if (/\.d\.ts/.test(url)) { + const content = fs.readFileSync(url, 'utf-8'); + const fileName = path.basename(url).replace(/.d.ts/g, '.ts'); + ts.transpileModule(content, { + compilerOptions: { + "target": ts.ScriptTarget.ES2017 + }, + fileName: fileName, + transformers: { before: [callback(url)] } + }); + } + }); +} + +function readFile(dir, utFiles) { + try { + const files = fs.readdirSync(dir); + files.forEach((element) => { + const filePath = path.join(dir, element); + const status = fs.statSync(filePath); + if (status.isDirectory()) { + readFile(filePath, utFiles); + } else { + utFiles.push(filePath); + } + }) + } catch (e) { + console.log('ETS ERROR: ' + e); + } +} + +function writeFile(url, data, option) { + if (fs.existsSync(outputPath)) { + fs.rmdirSync(outputPath, { recursive: true }); + } + const newFilePath = path.resolve(outputPath, path.relative(__dirname, url)); + fs.mkdir(path.relative(__dirname, path.dirname(newFilePath)), { recursive: true }, (err) => { + if (err) { + console.log(`ERROR FOR CREATE PATH ${err}`); + } else { + fs.writeFile(newFilePath, data, option, (err) => { + if (err) { + console.log(`ERROR FOR CREATE FILE ${err}`); + } + }) + } + }) +} +function deleteSystemApi(url) { + return (context) => { + return (node) => { + sourceFile = node; + node = processSourceFile(node); + node = ts.visitEachChild(node, processAllNodes, context); + if (!isEmptyFile(node)) { + const printer = ts.createPrinter({ newLine: ts.NewLineKind.LineFeed }); + const result = printer.printNode(ts.EmitHint.Unspecified, node, sourceFile); + writeFile(url, result); + } + return node; + } + function processAllNodes(node) { + if (ts.isInterfaceDeclaration(node)) { + const newMembers = []; + node.members.forEach(member => { + if (!isSystemapi(member)) { + newMembers.push(member); + } + }); + node = ts.factory.updateInterfaceDeclaration(node, node.decorators, node.modifiers, node.name, + node.typeParameters, node.heritageClauses, newMembers); + } else if (ts.isClassDeclaration(node)) { + const newMembers = []; + node.members.forEach(member => { + if (!isSystemapi(member)) { + newMembers.push(member); + } + }); + node = ts.factory.updateClassDeclaration(node, node.decorators, node.modifiers, node.name, + node.typeParameters, node.heritageClauses, newMembers); + } else if (ts.isModuleDeclaration(node) && node.body && ts.isModuleBlock(node.body)) { + const newStatements = []; + node.body.statements.forEach(statement => { + if (!isSystemapi(statement)) { + newStatements.push(statement); + } + }); + const newModuleBody = ts.factory.updateBlock(node.body, newStatements); + node = ts.factory.updateModuleDeclaration(node, node.decorators, node.modifiers, node.name, newModuleBody); + } else if (ts.isEnumDeclaration(node)) { + const newMembers = []; + node.members.forEach(member => { + if (!isSystemapi(member)) { + newMembers.push(member); + } + }); + node = ts.factory.updateEnumDeclaration(node, node.decorators, node.modifiers, node.name, newMembers); + } + return ts.visitEachChild(node, processAllNodes, context); + } + function processSourceFile(node) { + const stateNamesSet = new Set([]); + const newStatements = []; + const newStatementsWithoutExport = []; + node.statements.forEach(statement => { + if (!isSystemapi(statement)) { + newStatements.push(statement); + } else if (ts.isModuleDeclaration(statement) && statement.name && ts.isIdentifier(statement.name)) { + stateNamesSet.add(statement.name.escapedText.toString()); + } + }); + newStatements.forEach(statement => { + if (!(ts.isExportAssignment(statement) && statement.expression && ts.isIdentifier(statement.expression) && + stateNamesSet.has(statement.expression.escapedText.toString()))) { + newStatementsWithoutExport.push(statement); + } + }); + return ts.factory.updateSourceFile(node, newStatementsWithoutExport, node.isDeclarationFile, + node.referencedFiles); + } + } +} +exports.deleteSystemApi = deleteSystemApi; + +function isSystemapi(node) { + const notesStr = node.getFullText().replace(node.getText(), "").replace(/[\s]/g, ""); + if (notesStr.length !== 0) { + if (ts.isFunctionDeclaration(node) || ts.isMethodSignature(node) || ts.isMethodDeclaration(node)) { + lastNodeName = node.name && node.name.escapedText ? node.name.escapedText.toString() : ""; + lastNoteStr = notesStr; + } + return /\@systemapi/g.test(notesStr); + } else { + if ((ts.isFunctionDeclaration(node) || ts.isMethodSignature(node) || ts.isMethodDeclaration(node)) && node.name && + node.name.escapedText.toString() !== "" && node.name.escapedText.toString() === lastNodeName) { + return /\@systemapi/g.test(lastNoteStr); + } else { + return false; + } + } +} + +function isEmptyFile(node) { + if (ts.isSourceFile(node) && node.statements) { + for (let i = 0; i < node.statements.length; i++) { + const statement = node.statements[i]; + if (!ts.isImportDeclaration(statement)) { + return false + } + } + } + return true; +} + +const apiSourcePath = '../api'; +const outputPath = path.resolve(__dirname, 'output'); +collectDeclaration(apiSourcePath); \ No newline at end of file diff --git a/build-tools/package.json b/build-tools/package.json new file mode 100644 index 0000000000..738d7b4037 --- /dev/null +++ b/build-tools/package.json @@ -0,0 +1,16 @@ +{ + "name": "delete", + "version": "1.0.0", + "description": "", + "main": "delete_systemapi_plugin.js", + "scripts": { + "test": "echo \"Error: no test specified\" && exit 1" + }, + "author": "", + "license": "ISC", + "dependencies": { + "fs": "^0.0.1-security", + "path": "^0.12.7", + "typescript": "^4.7.4" + } +} -- Gitee From 585150b4a90b17b2d89ad4af3b8b95a26e3db3fb Mon Sep 17 00:00:00 2001 From: YOUR_NAME Date: Wed, 6 Jul 2022 10:28:31 +0800 Subject: [PATCH 13/15] fix commonevent Signed-off-by: liujiandong --- api/@ohos.commonEvent.d.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/api/@ohos.commonEvent.d.ts b/api/@ohos.commonEvent.d.ts index 7b732362cc..9b00d6108b 100644 --- a/api/@ohos.commonEvent.d.ts +++ b/api/@ohos.commonEvent.d.ts @@ -965,7 +965,7 @@ declare namespace commonEvent { * This is a protected common event that can only be sent by system. * @since 9 */ - COMMON_EVENT_SLOT_CHANGE = "usual.event.SLOT_CHANGE" + COMMON_EVENT_SLOT_CHANGE = "usual.event.SLOT_CHANGE", /** * Indicate the action of a common event that the spn display information has been updated. -- Gitee From 1dcc90040d1c7377f7ee5eb6664f2b189188de3a Mon Sep 17 00:00:00 2001 From: laiguizhong Date: Wed, 6 Jul 2022 15:29:52 +0800 Subject: [PATCH 14/15] modify GesturePath class to interface Signed-off-by: laiguizhong Change-Id: Ic8db093ec308cd8e84369780981f69d317af96bf --- api/@ohos.application.AccessibilityExtensionAbility.d.ts | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/api/@ohos.application.AccessibilityExtensionAbility.d.ts b/api/@ohos.application.AccessibilityExtensionAbility.d.ts index 14fff65e81..12add9c4fa 100644 --- a/api/@ohos.application.AccessibilityExtensionAbility.d.ts +++ b/api/@ohos.application.AccessibilityExtensionAbility.d.ts @@ -71,8 +71,7 @@ declare interface AccessibilityEvent { * @since 9 * @syscap SystemCapability.BarrierFree.Accessibility.Core */ - declare class GesturePath { - constructor(durationTime: number) + declare interface GesturePath { /** * Indicates the position of the points that make up the gesture. */ @@ -88,8 +87,7 @@ declare interface AccessibilityEvent { * @since 9 * @syscap SystemCapability.BarrierFree.Accessibility.Core */ -declare class GesturePoint { - constructor(positionX: number, positionY: number) +declare interface GesturePoint { /** * Indicates the X coordinate of point. */ -- Gitee From 2bbb76a016343bb7e201bfb72566ddc0e546857b Mon Sep 17 00:00:00 2001 From: sunyaozu Date: Thu, 7 Jul 2022 13:01:15 +0800 Subject: [PATCH 15/15] remove static of getLocationName method Signed-off-by: sunyaozu --- api/@ohos.i18n.d.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/api/@ohos.i18n.d.ts b/api/@ohos.i18n.d.ts index 3693f83823..d7dafe4aed 100644 --- a/api/@ohos.i18n.d.ts +++ b/api/@ohos.i18n.d.ts @@ -246,7 +246,7 @@ export class PhoneNumberFormat { * @return Returns a string represents phone number's location. * @since 9 */ - static getLocationName(number: string, locale: string): string; + getLocationName(number: string, locale: string): string; } /** -- Gitee