• 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
16/**
17 * @file The NotificationTemplate module describes the notification template.
18 * @kit NotificationKit
19 */
20
21/**
22 * The NotificationTemplate module describes the notification template.
23 *
24 * @typedef NotificationTemplate
25 * @syscap SystemCapability.Notification.Notification
26 * @since arkts {'1.1':'8', '1.2':'20'}
27 * @arkts 1.1&1.2
28 */
29export interface NotificationTemplate {
30  /**
31   * Template name. Currently, only downloadTemplate is supported.
32   *
33   * @type { string }
34   * @syscap SystemCapability.Notification.Notification
35   * @since arkts {'1.1':'8', '1.2':'20'}
36   * @arkts 1.1&1.2
37   */
38  name: string;
39
40  /**
41   * Template data.
42   * - title: title of the file. This parameter is mandatory, and the value is of the string type.
43   * - fileName: name of the file to be downloaded. This parameter is mandatory, and the value is of the string type.
44   * - progressValue: download progress. The value is a number.
45   *
46   * @type { Record<string, Object> }
47   * @syscap SystemCapability.Notification.Notification
48   * @since arkts {'1.1':'8', '1.2':'20'}
49   * @arkts 1.1&1.2
50   */
51  data: Record<string, Object>;
52}
53