quickshell-web/modules/Quickshell.Services.Notifications/Notification.json

{
  "name": "Notification",
  "module": "Quickshell.Services.Notifications",
  "type": "class",
  "super": {
    "type": "qt",
    "module": "qml.QtQml",
    "name": "QtObject"
  },
  "description": "A notification emitted by a NotificationServer.",
  "details": "A notification emitted by a NotificationServer.\n\n> [!NOTE] This type is TYPE99MQS_Quickshell99NRetainable99TYPE. It\n> can be retained after destruction if necessary.\n",
  "flags": [
    "uncreatable"
  ],
  "properties": {
    "hasActionIcons": {
      "type": {
        "type": "qt",
        "module": "qml",
        "name": "bool"
      },
      "details": "If actions associated with this notification have icons available.\n\nSee TYPE99MQS_Quickshell_Services_Notifications99NNotificationAction99Videntifier99Tprop99TYPE for details.\n",
      "flags": [
        "readonly"
      ]
    },
    "expireTimeout": {
      "type": {
        "type": "qt",
        "module": "qml",
        "name": "real"
      },
      "details": "Time in seconds the notification should be valid for\n",
      "flags": [
        "readonly"
      ]
    },
    "id": {
      "type": {
        "type": "qt",
        "module": "qml",
        "name": "int"
      },
      "details": "Id of the notification as given to the client.\n",
      "flags": [
        "readonly"
      ]
    },
    "hints": {
      "type": {
        "type": "unknown",
        "module": "",
        "name": ""
      },
      "details": "All hints sent by the client application as a javascript object.\nMany common hints are exposed via other properties.\n",
      "flags": [
        "readonly"
      ]
    },
    "transient": {
      "type": {
        "type": "qt",
        "module": "qml",
        "name": "bool"
      },
      "details": "If true, the notification should skip any kind of persistence function like a notification area.\n",
      "flags": [
        "readonly"
      ]
    },
    "appName": {
      "type": {
        "type": "qt",
        "module": "qml",
        "name": "string"
      },
      "details": "The sending application's name.\n",
      "flags": [
        "readonly"
      ]
    },
    "body": {
      "type": {
        "type": "qt",
        "module": "qml",
        "name": "string"
      },
      "details": null,
      "flags": [
        "readonly"
      ]
    },
    "lastGeneration": {
      "type": {
        "type": "qt",
        "module": "qml",
        "name": "bool"
      },
      "details": "If this notification was carried over from the last generation\nwhen quickshell reloaded.\n\nNotifications from the last generation will only be emitted\nif TYPE99MQS_Quickshell_Services_Notifications99NNotificationServer99VkeepOnReload99Tprop99TYPE is true.\n",
      "flags": [
        "readonly"
      ]
    },
    "resident": {
      "type": {
        "type": "qt",
        "module": "qml",
        "name": "bool"
      },
      "details": "If true, the notification will not be destroyed after an action is invoked.\n",
      "flags": [
        "readonly"
      ]
    },
    "summary": {
      "type": {
        "type": "qt",
        "module": "qml",
        "name": "string"
      },
      "details": "The image associated with this notification, or \"\" if none.\n",
      "flags": [
        "readonly"
      ]
    },
    "appIcon": {
      "type": {
        "type": "qt",
        "module": "qml",
        "name": "string"
      },
      "details": "The sending application's icon. If none was provided, then the icon from an associated\ndesktop entry will be retrieved. If none was found then \"\".\n",
      "flags": [
        "readonly"
      ]
    },
    "actions": {
      "type": {
        "type": "qt",
        "module": "qml",
        "name": "list",
        "of": {
          "type": "local",
          "module": "Quickshell.Services.Notifications",
          "name": "NotificationAction"
        }
      },
      "details": "Actions that can be taken for this notification.\n",
      "flags": [
        "readonly"
      ]
    },
    "tracked": {
      "type": {
        "type": "qt",
        "module": "qml",
        "name": "bool"
      },
      "details": "If the notification is tracked by the notification server.\n\nSetting this property to false is equivalent to calling TYPE99Vdismiss99Tfunc99TYPE.\n"
    },
    "urgency": {
      "type": {
        "type": "local",
        "module": "Quickshell.Services.Notifications",
        "name": "NotificationUrgency"
      },
      "details": null,
      "flags": [
        "readonly"
      ]
    },
    "desktopEntry": {
      "type": {
        "type": "qt",
        "module": "qml",
        "name": "string"
      },
      "details": "The name of the sender's desktop entry or \"\" if none was supplied.\n",
      "flags": [
        "readonly"
      ]
    },
    "image": {
      "type": {
        "type": "qt",
        "module": "qml",
        "name": "string"
      },
      "details": "An image associated with the notification.\n\nThis image is often something like a profile picture in instant messaging applications.\n",
      "flags": [
        "readonly"
      ]
    }
  },
  "functions": [
    {
      "ret": {
        "type": "qt",
        "module": "qml",
        "name": "void"
      },
      "name": "dismiss",
      "id": "dismiss",
      "details": "Destroy the notification and hint to the remote application that it was\nexplicitly closed by the user.\n",
      "params": []
    },
    {
      "ret": {
        "type": "qt",
        "module": "qml",
        "name": "void"
      },
      "name": "expire",
      "id": "expire",
      "details": "Destroy the notification and hint to the remote application that it has\ntimed out an expired.\n",
      "params": []
    }
  ],
  "signals": {
    "closed": {
      "name": "closed",
      "details": "Sent when a notification has been closed.\n\nThe notification object will be destroyed as soon as all signal handlers exit.\n",
      "params": [
        {
          "name": "reason",
          "type": {
            "type": "local",
            "module": "Quickshell.Services.Notifications",
            "name": "NotificationCloseReason"
          }
        }
      ]
    }
  },
  "variants": {}
}