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