Invoke-UDRedirect

Synopsis

Redirect the user to another page.

Syntax

Invoke-UDRedirect [-Url] <String> [-OpenInNewWindow] [-Native] [<CommonParameters>]

Description

Redirect the user to another page.

Parameters

-Url

The URL to redirect the user to.

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

-OpenInNewWindow

Whether to open the URL in a new window.

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

-Native

Performs a native redirect. This is useful when using relative paths that aren't part of the dashboard.

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

Common parameters

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

Outputs

Examples

Example 1: Redirect

New-UDButton -Text 'Click Me' -OnClick {
   Invoke-UDRedirect 'https://www.google.com'
}

Redirects the user to another page.

Example 2: Redirect in New Window

New-UDButton -Text 'Click Me' -OnClick {
   Invoke-UDRedirect 'https://www.google.com' -OpenInNewWindow
}

Redirects the user to another page in a new window.

Example 3: Native Redirect

New-UDButton -Text 'Click Me' -OnClick {
   Invoke-UDRedirect '/relative/path' -Native
}

Performs a native redirect.