This example adds an image from the internet as the hero image on the toast notification being constructed, it downloads the image from the internet regardless of if it has been previously cached.
EXAMPLE 5
$Builder = New-BTContentBuilder
$Builder|Add-BTHeroImage-Source 'C:\Temp\LocalImage.png'-AlternateText 'Picture of burnt toast, popped out of a toaster'
This example adds a local image as the hero image on the toast notification with supplied alt text to aid with accessibility e.g. the use of screen readers.
This example adds a hero image followed by three custom text elements to a toast content builder object on the pipeline by passing through a refference to the builder object.
PARAMETERS
-ContentBuilder
The toast content builder object that represents the toast notification being constructed.
Type: ToastContentBuilder
Parameter Sets: (All)
Aliases:
​
Required:True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters:False
-Source
The URI of the image. Can be from your local computer, network location, or the internet. Online images will be downloaded and cached in the user's TEMP directory for future use.
Type: String
Parameter Sets: (All)
Aliases:
​
Required:False
Position:1
Default value: None
Accept pipeline input:False
Accept wildcard characters:False
-AlternateText
A description of the image, for users of assistive technologies.
Type: String
Parameter Sets: (All)
Aliases:
​
Required:False
Position: Named
Default value: None
Accept pipeline input:False
Accept wildcard characters:False
-IgnoreCache
Specify that the online images should be downloaded, regardless of if they have been cached to the TEMP directory. Used when the online resource has been updated and you need to ensure that users see the latest version.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
​
Required:False
Position: Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False
-PassThru
Returns an object that represents the item with which you're working. By default, this cmdlet doesn't generate any output.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
​
Required:False
Position: Named
Default value:False
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.