Show-BTNotification

SYNOPSIS

Shows a new toast notification.

SYNTAX

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

DESCRIPTION

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

EXAMPLES

EXAMPLE 1

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

EXAMPLE 2

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

EXAMPLE 3

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

PARAMETERS

-ContentBuilder

{{ Fill ContentBuilder Description }}
1
Type: ToastContentBuilder[]
2
Parameter Sets: (All)
3
Aliases:
4
5
Required: True
6
Position: 1
7
Default value: None
8
Accept pipeline input: True (ByValue)
9
Accept wildcard characters: False
Copied!

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.
1
Type: SwitchParameter
2
Parameter Sets: (All)
3
Aliases: wi
4
5
Required: False
6
Position: Named
7
Default value: None
8
Accept pipeline input: False
9
Accept wildcard characters: False
Copied!

-Confirm

Prompts you for confirmation before running the cmdlet.
1
Type: SwitchParameter
2
Parameter Sets: (All)
3
Aliases: cf
4
5
Required: False
6
Position: Named
7
Default value: None
8
Accept pipeline input: False
9
Accept wildcard characters: False
Copied!

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