Get-KrRequestCookie

SYNOPSIS

Retrieves a cookie value from the HTTP request.

SYNTAX

Default (Default)

Get-KrRequestCookie -Name <string> [-ThrowIfMissing] [<CommonParameters>]

Int

Get-KrRequestCookie -Name <string> [-AsInt] [-ThrowIfMissing] [<CommonParameters>]

Bool

Get-KrRequestCookie -Name <string> [-AsBool] [-ThrowIfMissing] [<CommonParameters>]

Double

Get-KrRequestCookie -Name <string> [-AsDouble] [-ThrowIfMissing] [<CommonParameters>]

String

Get-KrRequestCookie -Name <string> [-AsString] [-ThrowIfMissing] [<CommonParameters>]

ALIASES

This cmdlet has the following aliases, {{Insert list of aliases}}

DESCRIPTION

This function accesses the current HTTP request context and retrieves the value of the specified cookie by name.

EXAMPLES

EXAMPLE 1

$value = Get-KrRequestCookie -Name “param1” Retrieves the value of the cookie “param1” from the HTTP request.

EXAMPLE 2

$id = Get-KrRequestCookie -Name “id” -AsInt -ThrowIfMissing Retrieves the value of the cookie “id” as an integer, throwing an error if it’s missing.

EXAMPLE 3

$flag = Get-KrRequestCookie -Name “flag” -AsBool Retrieves the value of the cookie “flag” as a boolean.

PARAMETERS

-AsBool

If specified, converts the cookie value to a boolean.

Type: System.Management.Automation.SwitchParameter
DefaultValue: False
SupportsWildcards: false
Aliases:
- AsBoolean
ParameterSets:
- Name: Bool
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-AsDouble

If specified, converts the cookie value to a double.

Type: System.Management.Automation.SwitchParameter
DefaultValue: False
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: Double
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-AsInt

If specified, converts the cookie value to an integer.

Type: System.Management.Automation.SwitchParameter
DefaultValue: False
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: Int
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-AsString

If specified, converts the cookie value to a string.

Type: System.Management.Automation.SwitchParameter
DefaultValue: False
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: String
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Name

The name of the cookie to retrieve from the HTTP request.

Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-ThrowIfMissing

If specified, throws an error if the cookie is not found. By default, it returns $null if not found.

Type: System.Management.Automation.SwitchParameter
DefaultValue: False
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

System.String

System.Int32

System.Boolean

System.Double

System.Object

NOTES

This function is designed to be used in the context of a Kestrun server response.