Test-PodeSignalClientIdValid
SYNOPSIS
Test if a Signal connection ClientId is valid.
SYNTAX
Test-PodeSignalClientIdValid [[-ClientId] <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
DESCRIPTION
Test if a Signal connection ClientId, passed or from $WebEvent, is valid. A ClientId is valid if it's not signed and we're not signing ClientIds, or if we are signing ClientIds and the ClientId is validly signed.
EXAMPLES
EXAMPLE 1
if (Test-PodeSignalClientIdValid) { ... }
EXAMPLE 2
if (Test-PodeSignalClientIdValid -ClientId 'my-client-id') { ... }
PARAMETERS
-ClientId
An optional Signal connection ClientId, if not supplied it will be retrieved from $WebEvent.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ProgressAction
{{ Fill ProgressAction Description }}
Type: ActionPreference
Parameter Sets: (All)
Aliases: proga
Required: False
Position: Named
Default value: None
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.