Send-PodeSignal

NAME Send-PodeSignal



SYNOPSIS

Broadcasts a message to connected WebSocket clients.





SYNTAX

Send-PodeSignal [-Value] <Object> [[-Path] <String>] [[-ClientId] <String>] [[-Depth] <Int32>] [<CommonParameters>]





DESCRIPTION

Broadcasts a message to all, or some, connected WebSocket clients. You can specify a path to send messages to, or

a specific ClientId.





PARAMETERS

-Value <Object>

A String, PSObject, or HashTable value. For non-string values, they will be converted to JSON.



Required? true

Position? 1

Default value

Accept pipeline input? true (ByValue)

Accept wildcard characters? false



-Path <String>

The Path of connected clients to send the message.



Required? false

Position? 2

Default value

Accept pipeline input? false

Accept wildcard characters? false



-ClientId <String>

A specific ClientId of a connected client to send a message. Not currently used.



Required? false

Position? 3

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Depth <Int32>

The Depth to generate the JSON document - the larger this value the worse performance gets.



Required? false

Position? 4

Default value 10

Accept pipeline input? false

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).



INPUTS



OUTPUTS



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



PS C:\\>Send-PodeSignal -Value @{ Message = 'Hello, world!' }













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



PS C:\\>Send-PodeSignal -Value @{ Data = @(123, 100, 101) } -Path '/response-charts'















RELATED LINKS