< Back
Submit-BTNotification
Post
NAME Submit-BTNotification
SYNOPSIS
Submits a completed toast notification for display.
SYNTAX
Submit-BTNotification [[-Content] <ToastContent>] [[-SequenceNumber] <UInt64>] [[-UniqueIdentifier] <String>]
[[-AppId] <String>] [[-DataBinding] <Hashtable>] [[-ExpirationTime] <DateTime>] [-SuppressPopup] [-WhatIf]
[-Confirm] [<CommonParameters>]
DESCRIPTION
The Submit-BTNotification function submits a completed toast notification to the operating systems' notification
manager for display.
PARAMETERS
-Content <ToastContent>
A Toast Content object which is the Base Toast element, created using the New-BTContent function.
Required? false
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-SequenceNumber <UInt64>
When updating toasts (not curently working) rapidly, the sequence number helps to ensure that toasts recieved
out of order will not be displayed in a manner that may confuse.
A higher sequence number indicates a newer toast.
Required? false
Position? 2
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-UniqueIdentifier <String>
A string that uniquely identifies a toast notification. Submitting a new toast with the same identifier as a
previous toast will replace the previous toast.
This is useful when updating the progress of a process, using a progress bar, or otherwise correcting/updating
the information on a toast.
Required? false
Position? 3
Default value
Accept pipeline input? false
Accept wildcard characters? false
-AppId <String>
Specifies the AppId of the 'application' or process that spawned the toast notification.
Required? false
Position? 4
Default value $Script:Config.AppId
Accept pipeline input? false
Accept wildcard characters? false
-DataBinding <Hashtable>
A hashtable that binds strings to keys in a toast notification. In order to update a toast, the original toast
needs to include a databinding hashtable.
Required? false
Position? 5
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ExpirationTime <DateTime>
The time after which the notification is no longer relevant and should be removed from the Action Center.
Required? false
Position? 6
Default value
Accept pipeline input? false
Accept wildcard characters? false
-SuppressPopup [<SwitchParameter>]
Bypasses display to the screen and sends the notification directly to the Action Center.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None
OUTPUTS
None
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Submit-BTNotification -Content $Toast1 -UniqueIdentifier 'Toast001'
This command submits the complete toast content object $Toast1, from the New-BTContent function, and tags it with
a unique identifier so that it can be replaced/updated.
RELATED LINKS
https://github.com/Windos/BurntToast/bl ... ication.md
SYNOPSIS
Submits a completed toast notification for display.
SYNTAX
Submit-BTNotification [[-Content] <ToastContent>] [[-SequenceNumber] <UInt64>] [[-UniqueIdentifier] <String>]
[[-AppId] <String>] [[-DataBinding] <Hashtable>] [[-ExpirationTime] <DateTime>] [-SuppressPopup] [-WhatIf]
[-Confirm] [<CommonParameters>]
DESCRIPTION
The Submit-BTNotification function submits a completed toast notification to the operating systems' notification
manager for display.
PARAMETERS
-Content <ToastContent>
A Toast Content object which is the Base Toast element, created using the New-BTContent function.
Required? false
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-SequenceNumber <UInt64>
When updating toasts (not curently working) rapidly, the sequence number helps to ensure that toasts recieved
out of order will not be displayed in a manner that may confuse.
A higher sequence number indicates a newer toast.
Required? false
Position? 2
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-UniqueIdentifier <String>
A string that uniquely identifies a toast notification. Submitting a new toast with the same identifier as a
previous toast will replace the previous toast.
This is useful when updating the progress of a process, using a progress bar, or otherwise correcting/updating
the information on a toast.
Required? false
Position? 3
Default value
Accept pipeline input? false
Accept wildcard characters? false
-AppId <String>
Specifies the AppId of the 'application' or process that spawned the toast notification.
Required? false
Position? 4
Default value $Script:Config.AppId
Accept pipeline input? false
Accept wildcard characters? false
-DataBinding <Hashtable>
A hashtable that binds strings to keys in a toast notification. In order to update a toast, the original toast
needs to include a databinding hashtable.
Required? false
Position? 5
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ExpirationTime <DateTime>
The time after which the notification is no longer relevant and should be removed from the Action Center.
Required? false
Position? 6
Default value
Accept pipeline input? false
Accept wildcard characters? false
-SuppressPopup [<SwitchParameter>]
Bypasses display to the screen and sends the notification directly to the Action Center.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None
OUTPUTS
None
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Submit-BTNotification -Content $Toast1 -UniqueIdentifier 'Toast001'
This command submits the complete toast content object $Toast1, from the New-BTContent function, and tags it with
a unique identifier so that it can be replaced/updated.
RELATED LINKS
https://github.com/Windos/BurntToast/bl ... ication.md