Object/Trait

io.fintrospect.parameters

Body

Related Docs: trait Body | package parameters

Permalink

object Body

Factory methods for various supported HTTP body types.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Body
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. def apply[T](bodySpec: BodySpec[T], description: String, example: T): Body[T]

    Permalink

    Create a custom body type for the request.

    Create a custom body type for the request. Encapsulates the means to insert/retrieve into the request

  5. def apply[T](bodySpec: BodySpec[T], description: String = null): Body[T]

    Permalink

    Create a custom body type for the request.

    Create a custom body type for the request. Encapsulates the means to insert/retrieve into the request

  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  7. def binary(contentType: ContentType, description: String = null): Body[Buf]

    Permalink

    Binary HTTP body, with custom ContentType

  8. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  9. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  10. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  11. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  12. def form(fields: FormField[_] with Extractor[Form, _]*): Body[Form]

    Permalink

    HTML encoded form HTTP message body which will fail to deserialize if a single field is missing/invalid.

    HTML encoded form HTTP message body which will fail to deserialize if a single field is missing/invalid. Use this for server-server communications when you want the server to reject with a BadRequest. This method simply takes a set of form fields.

  13. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  14. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  15. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  16. def json[T](description: String = null, example: T = null, jsonLib: JsonLibrary[T, _] = Argo): Body[T]

    Permalink

    JSON format HTTP message body.

    JSON format HTTP message body. Defaults to Argo JSON format, but this can be overridden by passing an alternative JsonFormat

  17. def multiPartForm(fields: FormField[_] with Extractor[Form, _]*): Body[Form]

    Permalink

    MultiPart encoded form HTTP message body which will fail to deserialize if a single field is missing/invalid.

    MultiPart encoded form HTTP message body which will fail to deserialize if a single field is missing/invalid. Use this for server-server communications when you want the server to reject with a BadRequest. This method simply takes a set of form fields.

  18. def multiPartWebForm(fields: (FormField[_] with Extractor[Form, _], String)*): Body[Form]

    Permalink

    MultiPart encoded form HTTP message body which deserializes even if fields are missing/invalid.

    MultiPart encoded form HTTP message body which deserializes even if fields are missing/invalid. Use this for browser-server communications where you want to give feedback to the user. This method takes a set of form fields, combined with their relevant error messages in case of validation failure.

  19. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  20. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  21. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  22. def string[T](contentType: ContentType, description: String = null, validation: StringValidations.Rule = StringValidations.EmptyIsInvalid): Body[String]

    Permalink

    String HTTP message body.

    String HTTP message body. Defaults to empty is invalid, but this can be overridden.

  23. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  24. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  25. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  26. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  27. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  28. def webForm(fields: (FormField[_] with Extractor[Form, _], String)*): Body[Form]

    Permalink

    HTML encoded form HTTP message body which deserializes even if fields are missing/invalid.

    HTML encoded form HTTP message body which deserializes even if fields are missing/invalid. Use this for browser-server communications where you want to give feedback to the user. This method takes a set of form fields, combined with their relevant error messages in case of validation failure.

  29. def xml(description: String = null, example: Elem = null): Body[Elem]

    Permalink

    Native Scala XML format HTTP message body.

Inherited from AnyRef

Inherited from Any

Ungrouped