org.apache.pekko.http.scaladsl.server.directives

Interface ParameterDirectives

All Superinterfaces:

ParameterDirectivesInstances, ToNameReceptacleEnhancements

All Known Subinterfaces:

Directives

All Known Implementing Classes:

Directives$, HttpApp, ParameterDirectives$

public interface ParameterDirectives
extends ParameterDirectivesInstances, ToNameReceptacleEnhancements

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ParameterDirectives.ParamDef<T> Deprecated. Use new `parameters` overloads with ParamSpec parameters. Kept for binary compatibility. Since Akka HTTP 10.2.0.
static class	ParameterDirectives.ParamDef$ Deprecated. Use new `parameters` overloads with ParamSpec parameters. Kept for binary compatibility. Since Akka HTTP 10.2.0.
static interface	ParameterDirectives.ParamMagnet Deprecated. Use new `parameters` overloads with ParamSpec parameters. Kept for binary compatibility. Since Akka HTTP 10.2.0.
static class	ParameterDirectives.ParamMagnet$ Deprecated. Use new `parameters` overloads with ParamSpec parameters. Kept for binary compatibility. Since Akka HTTP 10.2.0.
static interface	ParameterDirectives.ParamSpec
static class	ParameterDirectives.ParamSpec$

Method Summary

Modifier and Type	Method and Description
org.apache.pekko.http.scaladsl.server.directives.ParameterDirectives.pdm	parameter(ParameterDirectives.ParamMagnet pdm) Deprecated. Use new `parameters` overloads with ParamSpec parameters. Kept for binary compatibility. Since Akka HTTP 10.2.0.
Directive<scala.Tuple1<scala.collection.immutable.Map<java.lang.String,java.lang.String>>>	parameterMap() Extracts the request's query parameters as a Map[String, String].
Directive<scala.Tuple1<scala.collection.immutable.Map<java.lang.String,scala.collection.immutable.List<java.lang.String>>>>	parameterMultiMap() Extracts the request's query parameters as a Map[String, List[String}.
org.apache.pekko.http.scaladsl.server.directives.ParameterDirectives.pdm	parameters(ParameterDirectives.ParamMagnet pdm) Deprecated. Use new `parameters` overloads with ParamSpec parameters. Kept for binary compatibility. Since Akka HTTP 10.2.0.
Directive<scala.Tuple1<scala.collection.immutable.Seq<scala.Tuple2<java.lang.String,java.lang.String>>>>	parameterSeq() Extracts the request's query parameters as a Seq[(String, String)].

Methods inherited from interface org.apache.pekko.http.scaladsl.server.directives.ParameterDirectivesInstances

parameter, parameter, parameter, parameter, parameter, parameter, parameter, parameter, parameter, parameter, parameter, parameter, parameter, parameter, parameter, parameter, parameter, parameter, parameter, parameter, parameter, parameter, parameters, parameters, parameters, parameters, parameters, parameters, parameters, parameters, parameters, parameters, parameters, parameters, parameters, parameters, parameters, parameters, parameters, parameters, parameters, parameters, parameters, parameters

Methods inherited from interface org.apache.pekko.http.scaladsl.common.ToNameReceptacleEnhancements

_string2NR, _symbol2NR

Method Detail

parameterMap

Directive<scala.Tuple1<scala.collection.immutable.Map<java.lang.String,java.lang.String>>> parameterMap()

Extracts the request's query parameters as a Map[String, String].

Returns:

(undocumented)

parameterMultiMap

Directive<scala.Tuple1<scala.collection.immutable.Map<java.lang.String,scala.collection.immutable.List<java.lang.String>>>> parameterMultiMap()

Extracts the request's query parameters as a Map[String, List[String}.

Returns:

(undocumented)

parameterSeq

Directive<scala.Tuple1<scala.collection.immutable.Seq<scala.Tuple2<java.lang.String,java.lang.String>>>> parameterSeq()

Extracts the request's query parameters as a Seq[(String, String)].

Returns:

(undocumented)

parameter

org.apache.pekko.http.scaladsl.server.directives.ParameterDirectives.pdm parameter(ParameterDirectives.ParamMagnet pdm)

Deprecated. Use new `parameters` overloads with ParamSpec parameters. Kept for binary compatibility. Since Akka HTTP 10.2.0.

Extracts a query parameter value from the request. Rejects the request if the defined query parameter matcher(s) don't match.

Parameters:

pdm - (undocumented)

Returns:

(undocumented)

parameters

org.apache.pekko.http.scaladsl.server.directives.ParameterDirectives.pdm parameters(ParameterDirectives.ParamMagnet pdm)

Deprecated. Use new `parameters` overloads with ParamSpec parameters. Kept for binary compatibility. Since Akka HTTP 10.2.0.

Extracts a number of query parameter values from the request. Rejects the request if the defined query parameter matcher(s) don't match.

Parameters:

pdm - (undocumented)

Returns:

(undocumented)