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

Interface FormFieldDirectives

All Superinterfaces:

FormFieldDirectivesInstances, ToNameReceptacleEnhancements

All Known Subinterfaces:

Directives

All Known Implementing Classes:

Directives$, FormFieldDirectives$, HttpApp

public interface FormFieldDirectives
extends FormFieldDirectivesInstances, ToNameReceptacleEnhancements

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	FormFieldDirectives.FieldDef<T> Deprecated. Use new `formFields` overloads with FieldSpec parameters. Kept for binary compatibility. Since Akka HTTP 10.2.0.
static class	FormFieldDirectives.FieldDef$ Deprecated. Use new `formFields` overloads with FieldSpec parameters. Kept for binary compatibility. Since Akka HTTP 10.2.0.
static interface	FormFieldDirectives.FieldMagnet Deprecated. Use new `formField` overloads with FieldSpec parameters. Kept for binary compatibility. Since Akka HTTP 10.2.0.
static class	FormFieldDirectives.FieldMagnet$ Deprecated. Use new `formField` overloads with FieldSpec parameters. Kept for binary compatibility. Since Akka HTTP 10.2.0.
static interface	FormFieldDirectives.FieldSpec
static class	FormFieldDirectives.FieldSpec$
static class	FormFieldDirectives.Impl$

Method Summary

Modifier and Type	Method and Description
Directive<java.lang.Object>	formField(FormFieldDirectives.FieldMagnet pdm) Deprecated. Use new `formField` overloads with FieldSpec parameters. Kept for binary compatibility. Since Akka HTTP 10.2.0.
Directive<scala.Tuple1<scala.collection.immutable.Map<java.lang.String,java.lang.String>>>	formFieldMap() Extracts HTTP form fields from the request as a Map[String, String].
Directive<scala.Tuple1<scala.collection.immutable.Map<java.lang.String,scala.collection.immutable.List<java.lang.String>>>>	formFieldMultiMap() Extracts HTTP form fields from the request as a Map[String, List[String}.
Directive<java.lang.Object>	formFields(FormFieldDirectives.FieldMagnet pdm) Deprecated. Use new `formField` overloads with FieldSpec 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>>>>	formFieldSeq() Extracts HTTP form fields from the request as a Seq[(String, String)].

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

formField, formField, formField, formField, formField, formField, formField, formField, formField, formField, formField, formField, formField, formField, formField, formField, formField, formField, formField, formField, formField, formField, formFields, formFields, formFields, formFields, formFields, formFields, formFields, formFields, formFields, formFields, formFields, formFields, formFields, formFields, formFields, formFields, formFields, formFields, formFields, formFields, formFields, formFields

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

_string2NR, _symbol2NR

Method Detail

formFieldMap

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

Extracts HTTP form fields from the request as a Map[String, String].

Returns:

(undocumented)

formFieldMultiMap

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

Extracts HTTP form fields from the request as a Map[String, List[String}.

Returns:

(undocumented)

formFieldSeq

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

Extracts HTTP form fields from the request as a Seq[(String, String)].

Returns:

(undocumented)

formField

Directive<java.lang.Object> formField(FormFieldDirectives.FieldMagnet pdm)

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

Extracts an HTTP form field from the request. Rejects the request if the defined form field matcher(s) don't match.

Parameters:

pdm - (undocumented)

Returns:

(undocumented)

formFields

Directive<java.lang.Object> formFields(FormFieldDirectives.FieldMagnet pdm)

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

Extracts a number of HTTP form field from the request. Rejects the request if the defined form field matcher(s) don't match.

Parameters:

pdm - (undocumented)

Returns:

(undocumented)