Skip to content

Get-PodeCookie

SYNOPSIS

Retrieves a cookie from the Request.

SYNTAX

Get-PodeCookie [-Name] <String> [[-Secret] <String>] [-Raw] [<CommonParameters>]

DESCRIPTION

Retrieves a cookie from the Request, with the option to supply a secret to unsign the cookie's value.

EXAMPLES

EXAMPLE 1

Get-PodeCookie -Name 'Views'

EXAMPLE 2

Get-PodeCookie -Name 'Views' -Secret 'hunter2'

PARAMETERS

-Name

The name of the cookie to retrieve.

Type: String
Parameter Sets: (All)
Aliases:

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

-Raw

If supplied, the cookie returned will be the raw .NET Cookie object for manipulation.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-Secret

The secret used to unsign the cookie's value.

Type: String
Parameter Sets: (All)
Aliases:

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

System.Collections.Hashtable

NOTES