IssueNo: #I5RT32

Description: add ServiceExtensionAbility Sig: SIG_ApplicationFramework Feature or Bugfix: Feature Binary Source: No Signed-off-by: yangzk <yangzhongkai@huawei.com> Change-Id: Ia3092286b30f36e05eba91bc756e84cb48a55b14
2024-11-27 01:11:35 +00:00 · 2022-10-17 19:06:52 +08:00 · 2022-10-17 19:06:52 +08:00 · 7d6964f0c9
commit 7d6964f0c9
parent 8715487baf
1 changed files with 137 additions and 0 deletions
--- a/api/@ohos.app.ability.ServiceExtensionAbility.d.ts
+++ b/api/@ohos.app.ability.ServiceExtensionAbility.d.ts
@ -0,0 +1,137 @@
+/*
+ * Copyright (c) 2021-2022 Huawei Device Co., Ltd.
+ * Licensed under the Apache License, Version 2.0 (the "License"),
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import rpc from "./@ohos.rpc";
+import ServiceExtensionContext from "./application/ServiceExtensionContext";
+import Want from './@ohos.application.Want';
+import { Configuration } from './@ohos.application.Configuration';
+
+/**
+ * class of service extension ability.
+ *
+ * @since 9
+ * @syscap SystemCapability.Ability.AbilityRuntime.Core
+ * @systemapi hide for inner use.
+ * @StageModelOnly
+ */
+export default class ServiceExtensionAbility {
+    /**
+     * Indicates service extension ability context.
+     *
+     * @since 9
+     * @syscap SystemCapability.Ability.AbilityRuntime.Core
+     * @systemapi hide for inner use.
+     * @StageModelOnly
+     */
+    context: ServiceExtensionContext;
+
+    /**
+     * Called back when a service extension is started for initialization.
+     *
+     * @since 9
+     * @syscap SystemCapability.Ability.AbilityRuntime.Core
+     * @param want Indicates the want of created service extension.
+     * @systemapi hide for inner use.
+     * @return -
+     * @StageModelOnly
+     */
+    onCreate(want: Want): void;
+
+    /**
+     * Called back before a service extension is destroyed.
+     *
+     * @since 9
+     * @syscap SystemCapability.Ability.AbilityRuntime.Core
+     * @systemapi hide for inner use.
+     * @return -
+     * @StageModelOnly
+     */
+    onDestroy(): void;
+
+    /**
+     * Called back when a service extension is started.
+     *
+     * @since 9
+     * @syscap SystemCapability.Ability.AbilityRuntime.Core
+     * @param want Indicates the want of service extension to start.
+     * @param startId Indicates the number of times the service extension has been started. The {@code startId} is
+     *     incremented by 1 every time the service extension is started. For example, if the service extension
+     *     has been started for six times.
+     * @systemapi hide for inner use.
+     * @return -
+     * @StageModelOnly
+     */
+    onRequest(want: Want, startId: number): void;
+
+    /**
+     * Called back when a service extension is first connected to an ability.
+     *
+     * @since 9
+     * @syscap SystemCapability.Ability.AbilityRuntime.Core
+     * @param want Indicates connection information about the Service ability.
+     * @systemapi hide for inner use.
+     * @return Returns the proxy of the Service ability.
+     * @StageModelOnly
+     */
+    onConnect(want: Want): rpc.RemoteObject;
+
+    /**
+     * Called back when all abilities connected to a service extension are disconnected.
+     *
+     * @since 9
+     * @syscap SystemCapability.Ability.AbilityRuntime.Core
+     * @param want Indicates disconnection information about the service extension.
+     * @systemapi hide for inner use.
+     * @return -
+     * @StageModelOnly
+     */
+    onDisconnect(want: Want): void;
+
+    /**
+     * Called when a new client attempts to connect to a service extension after all previous client connections to it
+     * are disconnected.
+     *
+     * @since 9
+     * @syscap SystemCapability.Ability.AbilityRuntime.Core
+     * @param want Indicates the want of the service extension being connected.
+     * @systemapi hide for inner use.
+     * @return -
+     * @StageModelOnly
+     */
+    onReconnect(want: Want): void;
+
+    /**
+     * Called when the system configuration is updated.
+     *
+     * @since 9
+     * @syscap SystemCapability.Ability.AbilityRuntime.Core
+     * @param config Indicates the updated configuration.
+     * @return -
+     * @StageModelOnly
+     */
+    onConfigurationUpdated(config: Configuration): void;
+
+    /**
+     * Called when dump client information is required.
+     * It is recommended that developers don't DUMP sensitive information.
+     *
+     * @since 9
+     * @syscap SystemCapability.Ability.AbilityRuntime.AbilityCore
+     * @param params Indicates the params from command.
+     * @return The dump info array.
+     * @StageModelOnly
+     */
+    onDump(params: Array<string>): Array<string>;
+}