Sync-UDElement

Causes an element to update.

Synopsis

Causes an element to update.

Syntax

Sync-UDElement [-Id] <String[]> [-Broadcast] [[-ArgumentList] <Object[]>] [-Wait] [[-Timeout] <Int32>] [<CommonParameters>]

Description

Causes an element to update. Not all elements can be updated. For elements that cannot be updated, wrap them in New-UDDynamic and update that.

Parameters

-Id <String[]>

The ID of the element to update.

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

    -Broadcast [<SwitchParameter>]
        Whether to broadcast the update to all clients.

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

-ArgumentList <Object[]>

The argument list to pass to the element.

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

    -Wait [<SwitchParameter>]

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

-Timeout

Required?                    false
Position?                    3
Default value                5000
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-UDDynamic -Id 'sync1' -Content {
PS >    New-UDTypography (Get-Random)
PS > }
PS > New-UDButton -Text 'Refresh' -OnClick {
PS >    Sync-UDElement 'sync1'
PS > } -Id 'syncButton1'

Sync Element|Syncs an element.




-------------------------- EXAMPLE 2 --------------------------

PS >New-UDDynamic -Id 'sync2' -Content {
PS >    New-UDTypography (Get-Random)
PS > }
PS > New-UDButton -Text 'Refresh' -OnClick {
PS >    Sync-UDElement 'sync2' -Broadcast
PS > } -Id 'syncButton2'

Broadcast|Syncs an element and broadcasts it to all connected dashboards.