通知 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 : string

    包含多行文本主体。每行是一个段落，服务器实现可以根据需要进行自动换行。

    主体可能包含简单的HTML标记。如果省略主体，则只显示summary。


    category : string

    包含此通知的类型（可选）。

    通知可以包含可选的分类指示符。虽然客户端或服务器不必支持此功能，但有些人可能会选择支持。实现了分类的服务器可以使用它们以特定方式智能显示通知，或将相似类型的通知分组在一起。


    dismissOnAction : bool

    表示通知管理器在用户操作后将是否取消通知（例如，点击提供的操作文本或图像）。

    默认值是false。


    extended : object

    包含一个自定义混合属性，允许用户将任意元数据附加到此通知。

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


    icon : url

    包含与此通知关联的图标的URL（可选）。

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

    另请参阅image。


    image : url

    包含与此通知关联的图像的URL（可选）。

    不应使用图像来标识应用程序（有关此内容，请参阅icon），而应使用当通知本身可以分配图像时（例如，在“现在播放”通知中显示专辑封面）。

    另请参阅icon。


    notificationId : int [read-only]

    包含此通知的全局唯一id。

    在将此通知设置为visible（并且因此发布到服务器）之前，id为0。此属性为只读，因为id由服务器分配。


    priority : int

    包含此通知的优先级。实际值由实现具体定义，但理想情况下，任何实现都应该使用从Priority枚举中定义的、通过freedesktop.org规范提供的值

    名称值
    低0
    正常1
    关键2

    默认值是Normal。


    progress : qreal

    包含一个介于 [0.0 ... 1.0] 的浮点值，可用来在通知中显示进度条。特殊值 -1 可以用于请求忙状态指示器。默认值为 -1。

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


    showActionsAsIcons : bool

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

    默认值是false。

    另请参阅icon。


    showProgress : bool

    一个布尔值，描述是否应将进度条/忙状态指示器作为通知的一部分显示。

    默认值是false。

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


    sticky : bool

    如果此属性设置为 false，则通知应在 timeout 毫秒后删除。否则，通知将被“粘性”并应保持可见，直到用户确认。

    默认值是false。


    summary : string

    包含通知的概述。

    例如，“你有邮件”或“一个朋友上线”。通常，它不应超过 40 个字符，尽管这不是强制要求（服务器实现应在其必要时换行）。


    timeout : int

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

    默认值为 2000。

    另请参阅 sticky。


    visible : bool

    指示系统通知管理器是显示还是隐藏此通知。即使其在之后更改了属性，通知也只需要设置一次可见 - 这些更改将自动传达给服务器。

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

    默认值是false。

    另请参阅 show() 和 hide。


    信号文档

    acknowledged()

    当此通知在服务器端被确认时，将发出此信号 - 很可能是由于用户点击了通知。

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


    actionTriggered(string actionId)

    当在服务器端触发此通知中通过 actionId 识别的操作时，将发出此信号。

    注意： actionId 可以是任意字符串：它可能或可能不表示已注册的 actions 之一，并需要显式检查。

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


    方法文档

    hide()

    是 visible = false 的别名。

    参见 visible。


    show()

    是 visible = true 的别名。

    参见 visible。


    update()

    更新已经显示的提醒。

    参见 show。


    © 2024 Qt公司有限公司。此处包含的文档贡献的版权归其各自所有者。此处提供的文档根据由自由软件基金会发布的GNU自由文档许可版本1.3条款进行许可。Qt及其标志是芬兰及其它全球范围内Qt公司的商标。所有其他商标均为其各自所有者的财产。