• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1/*
2 * Copyright (c) 2021-2023 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
16import { NotificationUserInput } from './notificationUserInput';
17import { WantAgent } from '../@ohos.wantAgent';
18
19/**
20 * Describes an action button displayed in a notification.
21 *
22 * @typedef NotificationActionButton
23 * @syscap SystemCapability.Notification.Notification
24 * @since 7
25 */
26export interface NotificationActionButton {
27  /**
28   * Button title.
29   *
30   * @type { string }
31   * @syscap SystemCapability.Notification.Notification
32   * @since 7
33   */
34  title: string;
35
36  /**
37   * WantAgent of the button.
38   *
39   * @type { WantAgent }
40   * @syscap SystemCapability.Notification.Notification
41   * @since 7
42   */
43  wantAgent: WantAgent;
44
45  /**
46   * Extra information of the button.
47   *
48   * @type { ?object }
49   * @syscap SystemCapability.Notification.Notification
50   * @since 7
51   */
52  extras?: { [key: string]: any };
53
54  /**
55   * User input
56   *
57   * @type { ?NotificationUserInput }
58   * @syscap SystemCapability.Notification.Notification
59   * @since 8
60   */
61  userInput?: NotificationUserInput;
62}
63