• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1/*
2 * Copyright (c) 2022 Huawei Device Co., Ltd.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at
6 *
7 *     http://www.apache.org/licenses/LICENSE-2.0
8 *
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
14 */
15
16/**
17 * @file
18 * @kit IMEKit
19 */
20
21import Want from './@ohos.app.ability.Want';
22import type InputMethodExtensionContext from './@ohos.InputMethodExtensionContext';
23
24/**
25 * The extension ability class of input method.
26 *
27 * @syscap SystemCapability.MiscServices.InputMethodFramework
28 * @StageModelOnly
29 * @since 9
30 */
31export default class InputMethodExtensionAbility {
32  /**
33   * Indicates input method extension ability context.
34   *
35   * @type { InputMethodExtensionContext }
36   * @syscap SystemCapability.MiscServices.InputMethodFramework
37   * @StageModelOnly
38   * @since 9
39   */
40  context: InputMethodExtensionContext;
41
42  /**
43   * Called back when a input method extension is started for initialization.
44   *
45   * @param { Want } want - Indicates the want of created service extension.
46   * @syscap SystemCapability.MiscServices.InputMethodFramework
47   * @StageModelOnly
48   * @since 9
49   */
50  onCreate(want: Want): void;
51
52  /**
53   * Called back before a input method extension is destroyed.
54   *
55   * @syscap SystemCapability.MiscServices.InputMethodFramework
56   * @StageModelOnly
57   * @since 9
58   */
59  onDestroy(): void;
60}
61