azure-docs-sdk-java/docs-ref-autogen/com.azure.core.annotation.FormParam.yml

### YamlMime:JavaType
uid: "com.azure.core.annotation.FormParam"
fullName: "com.azure.core.annotation.FormParam"
name: "FormParam"
nameWithType: "FormParam"
summary: "Annotation for form parameters to be sent to a REST API Request URI."
syntax: "public interface **FormParam**</br> implements <a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Annotation.html\">Annotation</a>"
methods:
- uid: "com.azure.core.annotation.FormParam.encoded()"
  fullName: "com.azure.core.annotation.FormParam.encoded()"
  name: "encoded()"
  nameWithType: "FormParam.encoded()"
  summary: "Whether the form parameter is already form encoded."
  modifiers:
  - "abstract"
  syntax: "public abstract boolean encoded()"
  desc: "Whether the form parameter is already form encoded.\n\nA value true for this argument indicates that value of <xref uid=\"com.azure.core.annotation.FormParam.value()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"FormParam#value()\"></xref> is already encoded hence engine should not encode it, by default value will be encoded."
  returns:
    description: "Whether this query parameter is already encoded."
    type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.core.annotation.FormParam.value()"
  fullName: "com.azure.core.annotation.FormParam.value()"
  name: "value()"
  nameWithType: "FormParam.value()"
  summary: "Gets the name of the key in a key-value pair as part of the form data."
  modifiers:
  - "abstract"
  syntax: "public abstract String value()"
  desc: "Gets the name of the key in a key-value pair as part of the form data."
  returns:
    description: "The name of the key in a key value pair as part of the form data."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
type: "interface"
desc: "Annotation for form parameters to be sent to a REST API Request URI.\n\n**Example:**\n\n```java\n@Post(\"spellcheck\")\n Mono<Response<ResponseBody>> spellChecker(@HeaderParam(\"X-BingApis-SDK\") String xBingApisSDK,\n     @QueryParam(\"UserId\") String userId,\n     @FormParam(\"Text\") String text);\n```\n\nThe value of parameter text will be encoded and encoded value will be added to the form data sent to the API."
implements:
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/annotation/Annotation.html\">Annotation</a>"
metadata: {}
package: "com.azure.core.annotation"
artifact: com.azure:azure-core:1.52.0