Skip to content

Register-PodeSseEvent

SYNOPSIS

Register an event for one or more SSE connections.

SYNTAX

Register-PodeSseEvent [-Name] <String[]> [-Type] <PodeClientConnectionEventType> [-EventName] <String>
 [-ScriptBlock] <ScriptBlock> [[-ArgumentList] <Object[]>] [-ProgressAction <ActionPreference>]
 [<CommonParameters>]

DESCRIPTION

Register an event for one or more SSE connections, allowing custom scriptblocks to be executed when the event is triggered.

EXAMPLES

EXAMPLE 1

Register-PodeSseEvent -Name 'Actions' -Type Connect -EventName 'OnConnect' -ScriptBlock {
    "SSE Connection established: $($TriggeredEvent.Connection.Name) - $($TriggeredEvent.Connection.ClientId)" | Out-Default
}

PARAMETERS

-ArgumentList

An optional array of Arguments to pass to the ScriptBlock when executed.

Type: Object[]
Parameter Sets: (All)
Aliases:

Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-EventName

The name of the event to register.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Name

The Name(s) of the SSE connection(s) to register the event for.

Type: String[]
Parameter Sets: (All)
Aliases:

Required: True
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

-ScriptBlock

The ScriptBlock to execute when the event is triggered.

Type: ScriptBlock
Parameter Sets: (All)
Aliases:

Required: True
Position: 4
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-Type

The Type of event to register, either Connect or Disconnect.

Type: PodeClientConnectionEventType
Parameter Sets: (All)
Aliases:
Accepted values: Connect, Disconnect

Required: True
Position: 2
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.

INPUTS

OUTPUTS

NOTES