通知 QML 类型

提供了一个抽象层，使 QML 应用程序能够向系统 UI 发送通知。 更多...

导入声明import QtApplicationManager 2.0

属性

  • acknowledgeable : bool
  • actions : list
  • body : string
  • category : string
  • dismissOnAction : bool
  • extended : object
  • icon : url
  • image : url
  • notificationId : int
  • priority : int
  • progress : qreal
  • showActionsAsIcons : bool
  • showProgress : bool
  • sticky : bool
  • summary : string
  • timeout : int
  • visible : bool

    • 信号

    方法

    详细描述

    通知类型可以通过创建静态的 Notification 项目，或者通过动态调用 ApplicationInterface::createNotification 方法在 QML 应用程序中使用。系统 UI 也可以创建通知实例。对于所有其他应用程序和服务，可以通过 freedesktop.org 兼容的 org.freedesktop.Notifications D-Bus 接口访问应用程序管理器的通知服务。

    注意：大部分属性文档文本直接复制自 org.freedesktop.Notifications 规范，因为无法直接链接到特定属性的文档。

    通知基础设施的服务端/系统 UI 部分由 NotificationManager 实现。

    属性文档

    acknowledgeable : bool

    包含通知是否可以被用户确认 - 通常是通过点击它来确认。此动作通过 acknowledged() 信号报告。

    默认值是 false。


    actions : list<object>

    包含用户可以选择的所有可能动作的列表。此映射中的每个键都是 actionId，对应的值是 actionText。根据 showActionsAsIcons 属性，通知管理器应显示 actionText 或图标。

    另请参阅：actionTriggered()。


    body : 字符串

    包含多行文本正文。每行都是一个段落，服务器实现可以自由地进行换行。

    正文可以包含简单的HTML标记。如果省略正文，则仅显示摘要。


    category : 字符串

    持有此通知类型（可选）。

    通知可以可选地有类别指示符。尽管客户端和服务器不必须支持此，但有些人可能会选择这样做。实现类别的服务器可以使用它们以特定的方式智能显示通知，或将类似类型的通知分组在一起。


    dismissOnAction : 布尔值

    持有通知管理器在用户操作后（例如，单击提供的行为文本或图像）是否应取消通知。

    默认值是 false。


    extended : 对象

    持有自定义属性，允许用户将任意元数据附加到此通知。

    注意：这是针对应用管理器的协议特定扩展：它使用x-pelagicore-extended提示来传递此值。


    icon : URL

    持有与该通知关联的图标URL（可选）。

    图标应识别创建此通知的应用程序。

    另请参阅：image。


    image : URL

    持有与通知关联的图像URL（可选）。

    不应使用图像来识别应用程序（有关此内容，请参阅icon），而应将其用于通知本身可以被分配图像的情况（例如，在“正在播放”通知中显示专辑封面）。

    另请参阅：icon。


    [只读] notificationId : 整数

    持有此通知的系统全局唯一id。

    此id在通知被设置为可见（因此发布到服务器）之前是0。该属性是只读的，因为id是由服务器分配的。


    priority : 整数

    持有此通知的优先级。实际值是特定于实现的，但理想情况下，任何实现都应该使用freedesktop.org规范中定义的值，可通过Priority枚举获取。

    名称值
    低0
    普通1
    关键2

    默认值是普通。


    progress : 浮点数

    持有介于[0.0 ... 1.0]之间的浮点数，可用于在通知上显示进度条。特殊值-1可用于请求忙碌指示器。默认值为-1。

    注意：这是针对应用管理器的协议特定扩展：它使用x-pelagicore-progress提示来传递此值。


    showActionsAsIcons : 布尔

    存储客户端提供的有关如何呈现 actions 的提示。如果此属性为 false，则将在文本形式中显示通知操作。否则，应将 actionText 作为符合 freedesktop.org 图标命名规范的图标名称处理（在封闭系统中，这些也可以是通知服务器理解的任何图标规范字符串）。

    默认值是 false。

    另请参阅：icon。


    showProgress : 布尔

    一个布尔值，描述是否在通知中显示进度条/忙碌指示器。

    默认值是 false。

    注意：这是协议针对应用程序管理器的一个特定扩展：它使用 x-pelagicore-show-progress 提示来传递此值。


    sticky : 布尔

    如果此属性设置為 false，则通知应在 超时 毫秒后移除。否则，通知将是 "粘性的" 并且应保持可见，直到用户确认。

    默认值是 false。


    summary : 字符串

    包含通知的单一行概述。

    例如，"您有邮件" 或 "一位朋友已经上线"。通常，它不应超过 40 个字符，尽管这不是强制要求（服务器实现应必要时进行单词换行）。


    timeout : 整型

    对于非粘性通知，此值指定通知应在屏幕上保留多少毫秒后才移除。

    默认值是 2000。

    另请参阅：sticky。


    visible : 布尔

    指示系统通知管理器是显示还是隐藏此通知。即使之后的属性有变化，通知也需要设置仅一次可见 - 这些更改会自动通知服务器。

    注意：此属性仅是给通知管理器的提示；通知实际何时以及如何显示在屏幕上则取决于服务器端实现。

    默认值是 false。

    另请参阅：show() 和 hide()。


    信号文档

    acknowledge()

    在此通知在服务器端被确认时发出此信号，最可能是由于用户单击通知。

    注意：相应的处理器是 onAcknowledged。


    actionTriggered(字符串 actionId)

    当通知中由 actionId 指定的操作在服务器端被触发时，发出此信号。

    注意：actionId 可以是任意字符串：它可能代表注册的 操作 之一，也可能不是，需要显式检查。

    注意：相应的处理器是 onActionTriggered。


    方法文档

    hide()

    是 visible = false 的别称。

    另请参阅 visible。


    show()

    是 visible = true 的别称。

    另请参阅 visible。


    update()

    更新已显示的通知。

    另请参阅 show。


    ©2019 Luxoft Sweden AB。本文件中包含的文档贡献归各自所有者所有版权。本文件提供的文档是根据由自由软件基金会发布的GNU自由文档许可协议版本1.3的条款授予的。Qt及其相关标志是芬兰Qt公司及其/或世界其他地区的商标。所有其他商标均为其各自所有者的财产。