Start-UDDownload

Starts the download of a file within the dashboard.

Synopsis

Starts the download of a file within the dashboard.

Syntax

Start-UDDownload [-FileName <String>] -StringData <String> [-ContentType <String>] [<CommonParameters>]

    Start-UDDownload [-FileName <String>] -Path <String> [-ContentType <String>] [<CommonParameters>]

    Start-UDDownload [-FileName <String>] [-ContentType <String>] -Url <String> [<CommonParameters>]

Description

Starts the download of a file within the dashboard. Only text files are supported

Parameters

-FileName

The name of the file.

Required?                    false
Position?                    named
Default value                text.txt
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false

-StringData

The data to be written to the file.

Required?                    true
Position?                    named
Default value
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false

-Path

Required?                    true
Position?                    named
Default value
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false

-ContentType

The content type of the file.

Required?                    false
Position?                    named
Default value                text/plain
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false

-Url

A URL to download as string data and send to the user.

Required?                    true
Position?                    named
Default value
Accept pipeline input?       false
Aliases
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).

Outputs

-------------------------- EXAMPLE 1 --------------------------

PS >New-UDButton -Text 'Click Me' -OnClick {
PS >    Start-UDDownload -FileName 'myfile.txt' -StringData 'Hello World' -ContentType 'text/plain'
PS > }

Download File|Starts the download of a file within the dashboard.