io.vertx.ext.web.multipart

## Interface MultipartForm

- All Superinterfaces:
    Iterable<FormDataPart>

      public interface MultipartForm
      extends Iterable<FormDataPart>

  A multipart form.
  Author:
    Julien Viet

- - ### Method Summary

    All Methods Static Methods Instance Methods Abstract Methods Default Methods
    Modifier and Type | Method and Description
    --- | ---
    `MultipartForm` | `attribute(String name, String value)` Add an attribute form data part.
    `MultipartForm` | `binaryFileUpload(String name, String filename, Buffer content, String mediaType)` Add a binary file upload form data part.
    `MultipartForm` | `binaryFileUpload(String name, String filename, String pathname, String mediaType)` Add a binary file upload form data part.
    `static MultipartForm` | `create()`
    `Charset` | `getCharset()`
    `MultipartForm` | `setCharset(Charset charset)` Set the `charset` to use when encoding the form.
    `MultipartForm` | `setCharset(String charset)` Set the `charset` to use when encoding the form.
    `MultipartForm` | `textFileUpload(String name, String filename, Buffer content, String mediaType)` Add a text file upload form data part.
    `MultipartForm` | `textFileUpload(String name, String filename, String pathname, String mediaType)` Add a text file upload form data part.

    - ### Methods inherited from interface java.lang.Iterable

      `forEach, iterator, spliterator`

- - ### Method Detail

    - #### create

          static MultipartForm create()

      Returns:
        a multipart form instance

    - #### setCharset

          MultipartForm setCharset(String charset)

      Set the `charset` to use when encoding the form. The default charset is `StandardCharsets.UTF_8`.
      Parameters:
        `charset` - the charset to use
      Returns:
        a reference to this, so the API can be used fluently

    - #### setCharset

          MultipartForm setCharset(Charset charset)

      Set the `charset` to use when encoding the form. The default charset is `StandardCharsets.UTF_8`.
      Parameters:
        `charset` - the charset to use
      Returns:
        a reference to this, so the API can be used fluently

    - #### getCharset

          Charset getCharset()

      Returns:
        the charset to use when encoding the form

    - #### attribute

          MultipartForm attribute(String name,
                                  String value)

      Add an attribute form data part.
      Parameters:
        `name` - the name of the attribute
        `value` - the value of the attribute
      Returns:
        a reference to this, so the API can be used fluently

    - #### textFileUpload

          MultipartForm textFileUpload(String name,
                                       String filename,
                                       String pathname,
                                       String mediaType)

      Add a text file upload form data part.
      Parameters:
        `name` - name of the parameter
        `filename` - filename of the file
        `pathname` - the pathname of the file
        `mediaType` - the MIME type of the file
      Returns:
        a reference to this, so the API can be used fluently

    - #### textFileUpload

          MultipartForm textFileUpload(String name,
                                       String filename,
                                       Buffer content,
                                       String mediaType)

      Add a text file upload form data part.
      Parameters:
        `name` - name of the parameter
        `filename` - filename of the file
        `content` - the content of the file
        `mediaType` - the MIME type of the file
      Returns:
        a reference to this, so the API can be used fluently

    - #### binaryFileUpload

          MultipartForm binaryFileUpload(String name,
                                         String filename,
                                         String pathname,
                                         String mediaType)

      Add a binary file upload form data part.
      Parameters:
        `name` - name of the parameter
        `filename` - filename of the file
        `pathname` - the pathname of the file
        `mediaType` - the MIME type of the file
      Returns:
        a reference to this, so the API can be used fluently

    - #### binaryFileUpload

          MultipartForm binaryFileUpload(String name,
                                         String filename,
                                         Buffer content,
                                         String mediaType)

      Add a binary file upload form data part.
      Parameters:
        `name` - name of the parameter
        `filename` - filename of the file
        `content` - the content of the file
        `mediaType` - the MIME type of the file
      Returns:
        a reference to this, so the API can be used fluently

Copyright © 2023 Eclipse. All rights reserved.