1# NotificationContent
2
3描述通知类型。
4
5> **说明:**
6>
7> 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
8
9## NotificationContent
10
11**系统能力**:以下各项对应的系统能力均为SystemCapability.Notification.Notification
12
13| 名称           | 类型                                                                        | 只读 | 可选 | 说明               |
14| -----------   | --------------------------------------------------------------------------- | ---- | --- | ------------------ |
15| contentType<sup>(deprecated)</sup> | [notification.ContentType](./js-apis-notification.md#contenttype)  | 否  | 是  | 通知内容类型。<br>从API version 11开始不再维护,建议使用notificationContentType代替。       |
16| notificationContentType<sup>11+</sup>    | [notificationManager.ContentType](./js-apis-notificationManager.md#contenttype)                | 否  | 是  | 通知内容类型。       |
17| normal         | [NotificationBasicContent](#notificationbasiccontent)                      | 否  | 是  | 基本类型通知内容。   |
18| longText       | [NotificationLongTextContent](#notificationlongtextcontent)                | 否  | 是  | 长文本类型通知内容。 |
19| multiLine      | [NotificationMultiLineContent](#notificationmultilinecontent)              | 否  | 是  | 多行类型通知内容。   |
20| picture        | [NotificationPictureContent](#notificationpicturecontent)                  | 否  | 是  | 图片类型通知内容。   |
21| systemLiveView<sup>11+</sup> | [NotificationSystemLiveViewContent](#notificationsystemliveviewcontent)    | 否  | 是  | 系统实况窗类型通知内容。不支持三方应用直接创建该类型通知,可以由系统代理创建系统实况窗类型通知后,三方应用发布同ID的通知来更新指定内容。|
22
23## NotificationBasicContent
24
25描述普通文本通知。
26
27**系统能力**:以下各项对应的系统能力均为SystemCapability.Notification.Notification
28
29| 名称           | 类型    | 只读 | 可选 | 说明                               |
30| -------------- | ------ | ---- |-----| ---------------------------------- |
31| title          | string |  否  |  否  | 通知标题(不可为空字符串,大小不超过200字节,超出部分会被截断)。         |
32| text           | string |  否  |  否  | 通知内容(不可为空字符串,大小不超过200字节,超出部分会被截断)。         |
33| additionalText | string |  否  |  是  | 通知附加内容,是对通知内容的补充(大小不超过200字节,超出部分会被截断)。   |
34| lockscreenPicture<sup>12+</sup> | [image.PixelMap](../apis-image-kit/js-apis-image.md#pixelmap7) |  否  |  是  | 通知在锁屏界面显示的图片。当前仅支持实况窗类型通知。图标像素的总字节数不超过192KB(图标像素的总字节数通过[getPixelBytesNumber](../apis-image-kit/js-apis-image.md#getpixelbytesnumber7)获取),建议图标像素长宽为128*128。实际显示效果依赖于设备能力和通知中心UI样式。   |
35
36## NotificationLongTextContent
37
38描述长文本通知。继承自[NotificationBasicContent](#notificationbasiccontent)。
39
40> **说明:**
41>
42> 实际显示效果依赖于设备能力和通知中心UI样式。
43
44**系统能力**:以下各项对应的系统能力均为SystemCapability.Notification.Notification
45
46| 名称           | 类型    | 只读 | 可选 | 说明                             |
47| -------------- | ------ | ---- | --- | -------------------------------- |
48| longText       | string |  否  | 否  | 通知的长文本(不可为空字符串,大小不超过1024字节,超出部分会被截断)。                     |
49| briefText      | string |  否  | 否  | 通知概要内容,是对通知内容的总结(不可为空字符串,大小不超过200字节,超出部分会被截断)。   |
50| expandedTitle  | string |  否  | 否  | 通知展开时的标题(不可为空字符串,大小不超过200字节,超出部分会被截断)。                 |
51
52
53## NotificationMultiLineContent
54
55描述多行文本通知。继承自[NotificationBasicContent](#notificationbasiccontent)。
56
57> **说明:**
58>
59> 实际显示效果依赖于设备能力和通知中心UI样式。
60
61**系统能力**:以下各项对应的系统能力均为SystemCapability.Notification.Notification
62
63| 名称           | 类型            | 只读 | 可选 | 说明                             |
64| -------------- | --------------- | --- | --- | -------------------------------- |
65| briefText      | string          | 否  | 否  | 通知概要内容,是对通知内容的总结(不可为空字符串,大小不超过200字节,超出部分会被截断)。 |
66| longTitle      | string          | 否  | 否  | 通知展开时的标题(不可为空字符串,大小不超过200字节,超出部分会被截断)。|
67| lines          | Array\<string\> | 否  | 否  | 通知的多行文本(大小不超过200字节,超出部分会被截断)。                  |
68
69
70## NotificationPictureContent
71
72描述附有图片的通知。继承自[NotificationBasicContent](#notificationbasiccontent)。
73
74> **说明:**
75>
76> 实际显示效果依赖于设备能力和通知中心UI样式。
77
78**系统能力**:以下各项对应的系统能力均为SystemCapability.Notification.Notification
79
80| 名称           | 类型                                          | 只读 | 可选 | 说明                               |
81| -------------- | -------------------------------------------- | ---- | --- |------------------------------------|
82| briefText      | string                                       |  否  | 否  | 通知概要内容,是对通知内容的总结(不可为空字符串,大小不超过200字节,超出部分会被截断)。 |
83| expandedTitle  | string                                       |  否  | 否  | 通知展开时的标题(不可为空字符串,大小不超过200字节,超出部分会被截断)。    |
84| picture        | [image.PixelMap](../apis-image-kit/js-apis-image.md#pixelmap7) |  否  | 否  | 通知的图片内容(图像像素的总字节数不能超过2MB)。|
85
86
87## NotificationSystemLiveViewContent
88
89描述系统实况窗通知内容。不支持三方应用直接创建该类型通知,可以由系统代理创建系统实况窗类型通知后,三方应用发布同ID的通知来更新指定内容。继承自[NotificationBasicContent](#notificationbasiccontent)。
90
91**系统能力**:以下各项对应的系统能力均为SystemCapability.Notification.Notification
92
93| 名称                         | 类型                                             | 只读| 可选 | 说明                               |
94| ---------------------------- | ----------------------------------------------- | --- | --- | -----------------------------------|
95| typeCode<sup>11+</sup>       | number                                          | 否  | 否  | 类型标识符,标记调用方业务类型。       |
96| capsule<sup>11+</sup>        | [NotificationCapsule](#notificationcapsule11)   | 否  | 是  | 实况通知的胶囊。                     |
97| button<sup>11+</sup>         | [NotificationButton](#notificationbutton11)     | 否  | 是  | 实况通知的按钮。                     |
98| time<sup>11+</sup>           | [NotificationTime](#notificationtime11)         | 否  | 是  | 实况通知的时间。                     |
99| progress<sup>11+</sup>       | [NotificationProgress](#notificationprogress11) | 否  | 是  | 实况内容的进度。                     |
100
101
102## NotificationCapsule<sup>11+</sup>
103
104描述通知胶囊。
105
106**系统能力**:以下各项对应的系统能力均为SystemCapability.Notification.Notification
107
108| 名称            | 类型                                          | 只读 | 可选 | 说明                            |
109| --------------- | -------------------------------------------- | --- | --- | -------------------------------- |
110| title           | string                                       | 否  | 是  | 胶囊标题。                        |
111| icon            | [image.PixelMap](../apis-image-kit/js-apis-image.md#pixelmap7) | 否  | 是  | 胶囊图片。                        |
112| backgroundColor | string                                       | 否  | 是  | 背景颜色。                        |
113
114
115## NotificationButton<sup>11+</sup>
116
117描述通知按钮。
118
119**系统能力**:以下各项对应的系统能力均为SystemCapability.Notification.Notification
120
121| 名称  | 类型                                                   | 只读 | 可选 | 说明             |
122| ----- | ----------------------------------------------------- | --- | --- | ----------------- |
123| names | Array\<string\>                                       | 否  |  是 | 按钮名称(最多支持3个)。   |
124| icons | Array\<[image.PixelMap](../apis-image-kit/js-apis-image.md#pixelmap7)\> | 否  |  是 | 按钮图片(最多支持3个)。   |
125| iconsResource<sup>12+</sup> | Array\<[Resource](../apis-arkui/arkui-ts/ts-types.md#resource)\> | 否  |  是 | 按钮资源(最多支持3个)。   |
126
127## NotificationTime<sup>11+</sup>
128
129描述通知计时信息。
130
131**系统能力**:以下各项对应的系统能力均为SystemCapability.Notification.Notification
132
133| 名称           | 类型              | 只读 | 可选 | 说明                             |
134| -------------- | ---------------- | --- | --- | -------------------------------- |
135| initialTime    | number           | 否  | 是  | 计时起始时间。单位:ms。                |
136| isCountDown    | boolean          | 否  | 是  | 是否倒计时。                     |
137| isPaused       | boolean          | 否  | 是  | 是否暂停。                       |
138| isInTitle      | boolean          | 否  | 是  | 时间是否展示在title中。           |
139
140**示例:**
141
142```ts
143// 该通知从3秒开始倒计时,并且时间展示在title中。
144time: {
145    initialTime: 3000,
146    isCountDown: true,
147    isPaused: false,
148    isInTitle: true,
149}
150```
151
152
153## NotificationProgress<sup>11+</sup>
154
155描述通知进度。
156
157**系统能力**:以下各项对应的系统能力均为SystemCapability.Notification.Notification
158
159| 名称           | 类型            | 只读 | 可选 | 说明                             |
160| -------------- | --------------- | --- | --- | -------------------------------- |
161| maxValue        | number         | 否  | 是  | 进度最大值。                       |
162| currentValue    | number         | 否  | 是  | 进度当前值。                       |
163| isPercentage    | boolean        | 否  | 是  | 是否按百分比展示。                   |
164