Package io.vertx.core.http
Interface ClientMultipartForm
-
- All Superinterfaces:
ClientForm
public interface ClientMultipartForm extends ClientForm
A multipart form, providing file upload capabilities.- Author:
- Julien Viet
-
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Modifier and Type Method Description ClientMultipartFormattribute(String name, String value)ClientMultipartFormbinaryFileUpload(String name, String filename, String mediaType, Buffer content)Add a binary file upload form data part.ClientMultipartFormbinaryFileUpload(String name, String filename, String mediaType, String pathname)Add a binary file upload form data part.ClientMultipartFormcharset(String charset)Set thecharsetto use when encoding the form.ClientMultipartFormcharset(Charset charset)Set thecharsetto use when encoding the form.booleanmixed()ClientMultipartFormmixed(boolean allow)Allow or disallow multipart mixed encoding when files are sharing the same file name.static ClientMultipartFormmultipartForm()ClientMultipartFormtextFileUpload(String name, String filename, String mediaType, Buffer content)Add a text file upload form data part.ClientMultipartFormtextFileUpload(String name, String filename, String mediaType, String pathname)Add a text file upload form data part.-
Methods inherited from interface io.vertx.core.http.ClientForm
charset
-
-
-
-
Method Detail
-
multipartForm
static ClientMultipartForm multipartForm()
- Returns:
- a blank multipart form
-
attribute
ClientMultipartForm attribute(String name, String value)
- Specified by:
attributein interfaceClientForm
-
charset
ClientMultipartForm charset(String charset)
Set thecharsetto use when encoding the form. The default charset isStandardCharsets.UTF_8.- Specified by:
charsetin interfaceClientForm- Parameters:
charset- the charset to use- Returns:
- a reference to this, so the API can be used fluently
-
charset
ClientMultipartForm charset(Charset charset)
Set thecharsetto use when encoding the form. The default charset isStandardCharsets.UTF_8.- Specified by:
charsetin interfaceClientForm- Parameters:
charset- the charset to use- Returns:
- a reference to this, so the API can be used fluently
-
mixed
ClientMultipartForm mixed(boolean allow)
Allow or disallow multipart mixed encoding when files are sharing the same file name.
The default value istrue.
Set tofalseif you want to achieve the behavior for HTML5.- Parameters:
allow-trueallows use of multipart mixed encoding- Returns:
- a reference to this, so the API can be used fluently
-
mixed
boolean mixed()
- Returns:
- whether multipart mixed encoding is allowed
-
textFileUpload
ClientMultipartForm textFileUpload(String name, String filename, String mediaType, Buffer content)
Add a text file upload form data part.- Parameters:
name- name of the parameterfilename- filename of the filemediaType- the MIME type of the filecontent- the content of the file- Returns:
- a reference to this, so the API can be used fluently
-
binaryFileUpload
ClientMultipartForm binaryFileUpload(String name, String filename, String mediaType, Buffer content)
Add a binary file upload form data part.- Parameters:
name- name of the parameterfilename- filename of the filemediaType- the MIME type of the filecontent- the content of the file- Returns:
- a reference to this, so the API can be used fluently
-
textFileUpload
ClientMultipartForm textFileUpload(String name, String filename, String mediaType, String pathname)
Add a text file upload form data part.- Parameters:
name- name of the parameterfilename- filename of the filemediaType- the MIME type of the filepathname- the pathname of the file- Returns:
- a reference to this, so the API can be used fluently
-
binaryFileUpload
ClientMultipartForm binaryFileUpload(String name, String filename, String mediaType, String pathname)
Add a binary file upload form data part.- Parameters:
name- name of the parameterfilename- filename of the filemediaType- the MIME type of the filepathname- the pathname of the file- Returns:
- a reference to this, so the API can be used fluently
-
-