Summary
Triggers a toast notification
Syntax
Invoke-HPNotification [-Title] <String> [-Message] <String> [[-LogoImage] <FileInfo>] [[-Expiration] <Int32>] [[-TitleBarHeader] <String>] [[-TitleBarIcon] <FileInfo>] [[-Signature] <String>] [[-Dismiss] <Boolean>] [<CommonParameters>]
Description
This command triggers a toast notification.
Parameters
| Name | Argument | Description |
|---|---|---|
| Title | <String> | Specifies the title to display. This parameter is mandatory. Please note, an empty string is not allowed. |
| Message | <String> | Specifies the message to display. This parameter is mandatory. Please note, an empty string is not allowed. |
| LogoImage | <FileInfo> | Specifies the image file path to be displayed |
| Expiration | <Int32> | Specifies the life of the toast notification in minutes whether toast notification is on the screen or in the Action Center. If not specified, the invoked toast notification remains on screen until dismissed. |
| TitleBarHeader | <String> | Specifies the text of the toast notification in the title bar. If not specified, the text will default to "HP System Notification". |
| TitleBarIcon | <FileInfo> | Specifies the icon of the toast notification in the title bar. If not specified, the icon will default to the HP logo. Please note that the color of the icon might be inverted depending on the background color of the title bar. |
| Signature | <String> | Specifies the text to display below the message at the bottom of the toast notification in a smaller font. Please note that on older versions of Windows that don't support attribution text, the signature will just be displayed as another text element in the same font as the message. |
| Dismiss | <Boolean> | If set to true or not specified, the toast notification will show a Dismiss button to dismiss the notification. If set to false, the toast notification will not show a Dismiss button and will disappear from the screen and go to the Action Center after 5-7 seconds of invocation. Please note that dismissing the notification overrides any specified Expiration time as the notification will not go to the Action Center once dismissed. |
Examples
PS C:\> Invoke-HPNotification -Title "My title" -Message "My message" -Dismiss $false
PS C:\> Invoke-HPNotificataion -Title "My title" -Message "My message" -Signature "Foo Bar" -Expiration 5