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