Show-BTNotification

SYNOPSIS

Shows a new toast notification.

SYNTAX

Show-BTNotification [-ContentBuilder] <ToastContentBuilder[]> [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

The Show-BTNotification function shows a new toast notification with its configured content.

EXAMPLES

EXAMPLE 1

Show-BTNotification -ContentBuilder $ToastContentBuilder
This command displays a toast notification with the content of the ToastContentBuilder object.

EXAMPLE 2

$ToastContentBuilder | Show-BTNotification
This command displays a toast notification with the content of the ToastContentBuilder object supplied via the pipeline.

EXAMPLE 3

$Builder = New-BTContentBuilder
$Builder | Add-BTText -Text 'First Line of Text', 'Second Line of Text'
Show-BTNotification -ContentBuilder $Builder
This example demonstrates the full life cycle of a ToastContentBuilder object from creation to display.

PARAMETERS

-ContentBuilder

{{ Fill ContentBuilder Description }}
Type: ToastContentBuilder[]
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Confirm

Prompts you for confirmation before running the cmdlet.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

Microsoft.Toolkit.Uwp.Notifications.ToastContentBuilder

You can pipe a toast content builder object to Show-BTNotification.

OUTPUTS

None

NOTES

RELATED LINKS

Copy link
Edit on GitHub
Outline
SYNOPSIS
SYNTAX
DESCRIPTION
EXAMPLES
EXAMPLE 1
EXAMPLE 2
EXAMPLE 3
PARAMETERS
-ContentBuilder
-WhatIf
-Confirm
CommonParameters
INPUTS
Microsoft.Toolkit.Uwp.Notifications.ToastContentBuilder
OUTPUTS
None
NOTES
RELATED LINKS