interface_sdk-js/api/@ohos.app.ability.UIServiceExtensionAbility.d.ts
zhubingwei 77edc53d55 fix uiservice sdk bug
Signed-off-by: zhubingwei <zhubingwei@huawei.com>
Change-Id: I3ce735de0c0f64a70cae99feffd4c93dc51a6c3a
2024-08-19 09:45:09 +08:00

141 lines
4.5 KiB
TypeScript

/*
* Copyright (c) 2024 Huawei Device Co., Ltd.
* Licensed under the Apache License, Version 2.0 (the "License"),
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* @file
* @kit AbilityKit
*/
import ExtensionAbility from './@ohos.app.ability.ExtensionAbility';
import type Want from './@ohos.app.ability.Want';
import type UIServiceExtensionContext from './application/UIServiceExtensionContext';
import type UIServiceHostProxy from './application/UIServiceHostProxy';
import window from './@ohos.window';
/**
* The class of UI service extension ability.
*
* @extends ExtensionAbility
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @systemapi
* @stagemodelonly
* @since 13
*/
export default class UIServiceExtensionAbility extends ExtensionAbility {
/**
* Indicates configuration information about an UI service extension ability context.
*
* @type { UIServiceExtensionContext }
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @systemapi
* @stagemodelonly
* @since 13
*/
context: UIServiceExtensionContext;
/**
* Called back when an UI service extension is started for initialization.
*
* @param { Want } want - Indicates the want of created UI service extension.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @systemapi
* @stagemodelonly
* @since 13
*/
onCreate(want: Want): void;
/**
* Called back when a UI service extension is started.
*
* @param { Want } want - Indicates the want of UI service extension to start.
* @param { number } startId - Indicates the number of times the UI service extension has been started.
* The {@code startId} is incremented by 1 every time the UI service extension is started.
* For example, if the UI service extension has been started for six times.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @systemapi
* @stagemodelonly
* @since 13
*/
onRequest(want: Want, startId: number): void;
/**
* Called back when a UI service extension is connected to an ability.
*
* @param { Want } want - Indicates connection information about the UI service ability.
* @param { UIServiceHostProxy } proxy - Indicates the UI service host proxy.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @systemapi
* @stagemodelonly
* @since 13
*/
onConnect(want: Want, proxy: UIServiceHostProxy): void;
/**
* Called back when ability connected to a UI service extension is disconnected.
*
* @param { Want } want - Indicates disconnection information about the UI service extension.
* @param { UIServiceHostProxy } proxy - Indicates the UI service host proxy.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @systemapi
* @stagemodelonly
* @since 13
*/
onDisconnect(want: Want, proxy: UIServiceHostProxy): void;
/**
* Called back when a window will create.
*
* @param { window.ExtensionWindowConfig } config - Indicates the extension window config.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @systemapi
* @stagemodelonly
* @since 13
*/
onWindowWillCreate(config: window.ExtensionWindowConfig): void;
/**
* Called back when a window is created.
*
* @param { window.Window } window - Indicates the created Window.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @systemapi
* @stagemodelonly
* @since 13
*/
onWindowDidCreate(window: window.Window): void;
/**
* Called back when data is sent.
*
* @param { UIServiceHostProxy } proxy - Indicates the UI service host proxy.
* @param { Record<string, Object> } data - Indicates the received data.
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @systemapi
* @stagemodelonly
* @since 13
*/
onData(proxy: UIServiceHostProxy, data: Record<string, Object>): void;
/**
* Called back before a UI service extension is destroyed.
*
* @syscap SystemCapability.Ability.AbilityRuntime.Core
* @systemapi
* @stagemodelonly
* @since 13
*/
onDestroy(): void;
}