Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
b8f6848f
D
Docs
项目概览
OpenHarmony
/
Docs
1 年多 前同步成功
通知
159
Star
292
Fork
28
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
D
Docs
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
提交
Issue看板
提交
b8f6848f
编写于
1年前
作者:
X
xuzhihao
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
Feature: fix format issue of notification
Signed-off-by:
N
xuzhihao
<
xuzhihao16@huawei.com
>
上级
283b8557
无相关合并请求
变更
9
展开全部
隐藏空白更改
内联
并排
Showing
9 changed file
with
301 addition
and
282 deletion
+301
-282
zh-cn/application-dev/reference/apis/js-apis-inner-notification-bundleOption.md
...reference/apis/js-apis-inner-notification-bundleOption.md
+14
-0
zh-cn/application-dev/reference/apis/js-apis-inner-notification-notificationActionButton.md
...is/js-apis-inner-notification-notificationActionButton.md
+16
-0
zh-cn/application-dev/reference/apis/js-apis-inner-notification-notificationContent.md
...ce/apis/js-apis-inner-notification-notificationContent.md
+77
-0
zh-cn/application-dev/reference/apis/js-apis-inner-notification-notificationFlags.md
...ence/apis/js-apis-inner-notification-notificationFlags.md
+29
-0
zh-cn/application-dev/reference/apis/js-apis-inner-notification-notificationRequest.md
...ce/apis/js-apis-inner-notification-notificationRequest.md
+63
-0
zh-cn/application-dev/reference/apis/js-apis-inner-notification-notificationSlot.md
...rence/apis/js-apis-inner-notification-notificationSlot.md
+24
-0
zh-cn/application-dev/reference/apis/js-apis-inner-notification-notificationTemplate.md
...e/apis/js-apis-inner-notification-notificationTemplate.md
+14
-0
zh-cn/application-dev/reference/apis/js-apis-inner-notification-notificationUserInput.md
.../apis/js-apis-inner-notification-notificationUserInput.md
+13
-0
zh-cn/application-dev/reference/apis/js-apis-notificationManager.md
...ication-dev/reference/apis/js-apis-notificationManager.md
+51
-282
未找到文件。
zh-cn/application-dev/reference/apis/js-apis-inner-notification-bundleOption.md
0 → 100644
浏览文件 @
b8f6848f
# BundleOption
BundleOption模块为指定应用的包信息。
> **说明:**
>
> 本模块首批接口从API version 9开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
**系统能力**
:以下各项对应的系统能力均为SystemCapability.Notification.Notification
| 名称 | 类型 | 必填 | 说明 |
| ------ | ------ |---- | ------ |
| bundle | string | 是 | 应用的包信息。 |
| uid | number | 否 | 用户ID。 |
This diff is collapsed.
Click to expand it.
zh-cn/application-dev/reference/apis/js-apis-inner-notification-notificationActionButton.md
0 → 100644
浏览文件 @
b8f6848f
# NotificationActionButton
描述通知中显示的操作按钮。
> **说明:**
>
> 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
**系统能力**
:以下各项对应的系统能力均为SystemCapability.Notification.Notification
| 名称 | 类型 | 可读 | 可写 | 说明 |
| --------- | ----------------------------------------------- | --- | ---- | ------------------------- |
| title | string | 是 | 是 | 按钮标题。 |
| wantAgent |
[
WantAgent
](
js-apis-app-ability-wantAgent.md
)
| 是 | 是 | 点击按钮时触发的WantAgent。 |
| extras | { [key: string]: any } | 是 | 是 | 按钮扩展信息。 |
| userInput
<sup>
8+
</sup>
|
[
NotificationUserInput
](
js-apis-inner-notification-notificationUserInput.md
)
| 是 | 是 | 用户输入对象实例。 |
This diff is collapsed.
Click to expand it.
zh-cn/application-dev/reference/apis/js-apis-inner-notification-notificationContent.md
0 → 100644
浏览文件 @
b8f6848f
# NotificationContent
描述通知类型。
> **说明:**
>
> 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
**系统能力**
:以下各项对应的系统能力均为SystemCapability.Notification.Notification
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ----------- | ------------------------------------------------------------ | ---- | --- | ------------------ |
| contentType |
[
ContentType
](
./js-apis-notificationManager.md#contenttype
)
| 是 | 是 | 通知内容类型。 |
| normal |
[
NotificationBasicContent
](
#notificationbasiccontent
)
| 是 | 是 | 基本类型通知内容。 |
| longText |
[
NotificationLongTextContent
](
#notificationlongtextcontent
)
| 是 | 是 | 长文本类型通知内容。 |
| multiLine |
[
NotificationMultiLineContent
](
#notificationmultilinecontent
)
| 是 | 是 | 多行类型通知内容。 |
| picture |
[
NotificationPictureContent
](
#notificationpicturecontent
)
| 是 | 是 | 图片类型通知内容。 |
## NotificationBasicContent
描述普通文本通知。
**系统能力**
:以下各项对应的系统能力均为SystemCapability.Notification.Notification
| 名称 | 类型 | 可读 | 可写 | 说明 |
| -------------- | ------ | ---- | ---- | ---------------------------------- |
| title | string | 是 | 是 | 通知标题。 |
| text | string | 是 | 是 | 通知内容。 |
| additionalText | string | 是 | 是 | 通知附加内容,是对通知内容的补充。 |
## NotificationLongTextContent
描述长文本通知。
**系统能力**
:以下各项对应的系统能力均为SystemCapability.Notification.Notification
| 名称 | 类型 | 可读 | 可写 | 说明 |
| -------------- | ------ | ---- | --- | -------------------------------- |
| title | string | 是 | 是 | 通知标题。 |
| text | string | 是 | 是 | 通知内容。 |
| additionalText | string | 是 | 是 | 通知附加内容,是对通知内容的补充。 |
| longText | string | 是 | 是 | 通知的长文本。 |
| briefText | string | 是 | 是 | 通知概要内容,是对通知内容的总结。 |
| expandedTitle | string | 是 | 是 | 通知展开时的标题。 |
## NotificationMultiLineContent
描述多行文本通知。
**系统能力**
:以下各项对应的系统能力均为SystemCapability.Notification.Notification
| 名称 | 类型 | 可读 | 可写 | 说明 |
| -------------- | --------------- | --- | --- | -------------------------------- |
| title | string | 是 | 是 | 通知标题。 |
| text | string | 是 | 是 | 通知内容。 |
| additionalText | string | 是 | 是 | 通知附加内容,是对通知内容的补充。 |
| briefText | string | 是 | 是 | 通知概要内容,是对通知内容的总结。 |
| longTitle | string | 是 | 是 | 通知展开时的标题。 |
| lines | Array
\<
string
\>
| 是 | 是 | 通知的多行文本。 |
## NotificationPictureContent
描述附有图片的通知。
**系统能力**
:以下各项对应的系统能力均为SystemCapability.Notification.Notification
| 名称 | 类型 | 可读 | 可写 | 说明 |
| -------------- | -------------- | ---- | --- | -------------------------------- |
| title | string | 是 | 是 | 通知标题。 |
| text | string | 是 | 是 | 通知内容。 |
| additionalText | string | 是 | 是 | 通知附加内容,是对通知内容的补充。 |
| briefText | string | 是 | 是 | 通知概要内容,是对通知内容的总结。 |
| expandedTitle | string | 是 | 是 | 通知展开时的标题。 |
| picture |
[
image.PixelMap
](
js-apis-image.md#pixelmap7
)
| 是 | 是 | 通知的图片内容。 |
This diff is collapsed.
Click to expand it.
zh-cn/application-dev/reference/apis/js-apis-inner-notification-notificationFlags.md
0 → 100644
浏览文件 @
b8f6848f
# NotificationFlags
描述通知标志的实例。
> **说明:**
>
> 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
**系统能力**
:以下各项对应的系统能力均为SystemCapability.Notification.Notification
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ---------------- | ---------------------- | ---- | ---- | --------------------------------- |
| soundEnabled |
[
NotificationFlagStatus
](
#notificationflagstatus
)
| 是 | 否 | 是否启用声音提示。 |
| vibrationEnabled |
[
NotificationFlagStatus
](
#notificationflagstatus
)
| 是 | 否 | 是否启用振动提醒功能。 |
## NotificationFlagStatus
描述通知标志状态。
**系统能力**
:以下各项对应的系统能力均为SystemCapability.Notification.Notification
**系统接口**
:此接口为系统接口,三方应用不支持调用。
| 名称 | 值 | 说明 |
| -------------- | --- | --------------------------------- |
| TYPE_NONE | 0 | 默认标志。 |
| TYPE_OPEN | 1 | 通知标志打开。 |
| TYPE_CLOSE | 2 | 通知标志关闭。 |
This diff is collapsed.
Click to expand it.
zh-cn/application-dev/reference/apis/js-apis-inner-notification-notificationRequest.md
0 → 100644
浏览文件 @
b8f6848f
# NotificationRequest
描述通知的请求。
> **说明:**
>
> 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
**系统能力**
:以下各项对应的系统能力均为SystemCapability.Notification.Notification
| 名称 | 类型 | 可读 | 可写 | 说明 |
| --------------------- | --------------------------------------------- | ---- | --- | -------------------------- |
| content |
[
NotificationContent
](
js-apis-inner-notification-notificationContent.md#notificationcontent
)
| 是 | 是 | 通知内容。 |
| id | number | 是 | 是 | 通知ID。 |
| slotType |
[
SlotType
](
js-apis-notificationManager.md#slottype
)
| 是 | 是 | 通道类型。 |
| isOngoing | boolean | 是 | 是 | 是否进行时通知。 |
| isUnremovable | boolean | 是 | 是 | 是否可移除。 |
| deliveryTime | number | 是 | 是 | 通知发送时间。 |
| tapDismissed | boolean | 是 | 是 | 通知是否自动清除。 |
| autoDeletedTime | number | 是 | 是 | 自动清除的时间。 |
| wantAgent |
[
WantAgent
](
js-apis-app-ability-wantAgent.md
)
| 是 | 是 | WantAgent封装了应用的行为意图,点击通知时触发该行为。 |
| extraInfo | {[key: string]: any} | 是 | 是 | 扩展参数。 |
| color | number | 是 | 是 | 通知背景颜色。预留能力,暂未支持。 |
| colorEnabled | boolean | 是 | 是 | 通知背景颜色是否使能。预留能力,暂未支持。 |
| isAlertOnce | boolean | 是 | 是 | 设置是否仅有一次此通知提醒。 |
| isStopwatch | boolean | 是 | 是 | 是否显示已用时间。 |
| isCountDown | boolean | 是 | 是 | 是否显示倒计时时间。 |
| isFloatingIcon | boolean | 是 | 是 | 是否显示状态栏图标。 |
| label | string | 是 | 是 | 通知标签。 |
| badgeIconStyle | number | 是 | 是 | 通知角标类型。 |
| showDeliveryTime | boolean | 是 | 是 | 是否显示分发时间。 |
| actionButtons | Array
\<
[
NotificationActionButton
](
js-apis-inner-notification-notificationActionButton.md
)
\>
| 是 | 是 | 通知按钮,最多三个按钮。 |
| smallIcon |
[
image.PixelMap
](
js-apis-image.md#pixelmap7
)
| 是 | 是 | 通知小图标。可选字段,大小不超过30KB。 |
| largeIcon |
[
image.PixelMap
](
js-apis-image.md#pixelmap7
)
| 是 | 是 | 通知大图标。可选字段,大小不超过30KB。 |
| creatorBundleName | string | 是 | 否 | 创建通知的包名。 |
| creatorUid
<sup>
8+
<sup>
| number | 是 | 否 | 创建通知的UID。 |
| creatorPid | number | 是 | 否 | 创建通知的PID。 |
| creatorUserId| number | 是 | 否 | 创建通知的UserId。 |
| hashCode | string | 是 | 否 | 通知唯一标识。 |
| classification | string | 是 | 是 | 通知分类。
<br>
**系统API**
: 此接口为系统接口,三方应用不支持调用。 |
| groupName
<sup>
8+
<sup>
| string | 是 | 是 | 组通知名称。 |
| template
<sup>
8+
<sup>
|
[
NotificationTemplate
](
./js-apis-inner-notification-notificationTemplate.md
)
| 是 | 是 | 通知模板。 |
| isRemoveAllowed
<sup>
8+
<sup>
| boolean | 是 | 否 | 通知是否能被移除。
<br>
**系统API**
: 此接口为系统接口,三方应用不支持调用。 |
| source
<sup>
8+
<sup>
| number | 是 | 否 | 通知源。
<br>
**系统API**
: 此接口为系统接口,三方应用不支持调用。 |
| distributedOption
<sup>
8+
<sup>
|
[
DistributedOptions
](
#distributedoptions
)
| 是 | 是 | 分布式通知的选项。 |
| deviceId
<sup>
8+
<sup>
| string | 是 | 否 | 通知源的deviceId。
<br>
**系统API**
: 此接口为系统接口,三方应用不支持调用。 |
| notificationFlags
<sup>
8+
<sup>
|
[
NotificationFlags
](
js-apis-inner-notification-notificationflags#notificationFlags
)
| 是 | 否 | 获取NotificationFlags。 |
| removalWantAgent
<sup>
9+
<sup>
|
[
WantAgent
](
js-apis-app-ability-wantAgent.md
)
| 是 | 是 | 当移除通知时,通知将被重定向到的WantAgent实例。 |
| badgeNumber
<sup>
9+
<sup>
| number | 是 | 是 | 应用程序图标上显示的通知数。 |
## DistributedOptions
描述分布式选项。
**系统能力**
:以下各项对应的系统能力均为SystemCapability.Notification.Notification
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ---------------------- | -------------- | ---- | ---- | ---------------------------------- |
| isDistributed
<sup>
8+
<sup>
| boolean | 是 | 是 | 是否为分布式通知。 |
| supportDisplayDevices
<sup>
8+
<sup>
| Array
\<
string> | 是 | 是 | 可以同步通知到的设备列表。 |
| supportOperateDevices
<sup>
8+
<sup>
| Array
\<
string> | 是 | 是 | 可以打开通知的设备列表。 |
| remindType
<sup>
8+
<sup>
| number | 是 | 否 | 通知的提醒方式。
<br>
**系统API**
: 此接口为系统接口,三方应用不支持调用。 |
This diff is collapsed.
Click to expand it.
zh-cn/application-dev/reference/apis/js-apis-inner-notification-notificationSlot.md
0 → 100644
浏览文件 @
b8f6848f
# NotificationSlot
描述通知槽
> **说明:**
>
> 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
**系统能力**
:以下各项对应的系统能力均为SystemCapability.Notification.Notification
| 名称 | 类型 | 可读 | 可写 | 说明 |
| -------------------- | --------------------- | ---- | --- | ------------------------------------------ |
| type |
[
SlotType
](
js-apis-notificationManager.md#slottype
)
| 是 | 是 | 通道类型。 |
| level | number | 是 | 是 | 通知级别,不设置则根据通知渠道类型有默认值。 |
| desc | string | 是 | 是 | 通知渠道描述信息。 |
| badgeFlag | boolean | 是 | 是 | 是否显示角标。 |
| bypassDnd | boolean | 是 | 是 | 置是否在系统中绕过免打扰模式。 |
| lockscreenVisibility | number | 是 | 是 | 在锁定屏幕上显示通知的模式。 |
| vibrationEnabled | boolean | 是 | 是 | 是否可振动。 |
| sound | string | 是 | 是 | 通知提示音。 |
| lightEnabled | boolean | 是 | 是 | 是否闪灯。 |
| lightColor | number | 是 | 是 | 通知灯颜色。 |
| vibrationValues | Array
\<
number
\>
| 是 | 是 | 通知振动样式。 |
| enabled
<sup>
9+
</sup>
| boolean | 是 | 否 | 此通知插槽中的启停状态。 |
This diff is collapsed.
Click to expand it.
zh-cn/application-dev/reference/apis/js-apis-inner-notification-notificationTemplate.md
0 → 100644
浏览文件 @
b8f6848f
# NotificationTemplate
通知模板。
> **说明:**
>
> 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
**系统能力**
:以下各项对应的系统能力均为SystemCapability.Notification.Notification
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ---- | ---------------------- | ---- | ---- | ---------- |
| name | string | 是 | 是 | 模板名称。 |
| data | {[key:string]: Object} | 是 | 是 | 模板数据。 |
This diff is collapsed.
Click to expand it.
zh-cn/application-dev/reference/apis/js-apis-inner-notification-notificationUserInput.md
0 → 100644
浏览文件 @
b8f6848f
# NotificationUserInput
保存用户输入的通知消息。
> **说明:**
>
> 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
**系统能力**
:SystemCapability.Notification.Notification
| 名称 | 类型 | 可读 | 可写 | 说明 |
| -------- | ------ | --- | ---- | ----------------------------- |
| inputKey | string | 是 | 是 | 用户输入时用于标识此输入的key。 |
This diff is collapsed.
Click to expand it.
zh-cn/application-dev/reference/apis/js-apis-notificationManager.md
浏览文件 @
b8f6848f
此差异已折叠。
点击以展开。
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录
反馈
建议
客服
返回
顶部