Package com.hellosign.openapi.model
Class TemplateResponseDocumentCustomField
- java.lang.Object
-
- com.hellosign.openapi.model.TemplateResponseDocumentCustomField
-
@Generated("org.openapitools.codegen.languages.JavaClientCodegen") public class TemplateResponseDocumentCustomField extends java.lang.ObjectTemplateResponseDocumentCustomField
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classTemplateResponseDocumentCustomField.TypeEnumThe type of this Custom Field.
-
Field Summary
Fields Modifier and Type Field Description static java.lang.StringJSON_PROPERTY_API_IDstatic java.lang.StringJSON_PROPERTY_AVG_TEXT_LENGTHstatic java.lang.StringJSON_PROPERTY_FONT_FAMILYstatic java.lang.StringJSON_PROPERTY_GROUPstatic java.lang.StringJSON_PROPERTY_HEIGHTstatic java.lang.StringJSON_PROPERTY_IS_MULTILINEstatic java.lang.StringJSON_PROPERTY_NAMEstatic java.lang.StringJSON_PROPERTY_NAMED_FORM_FIELDSstatic java.lang.StringJSON_PROPERTY_ORIGINAL_FONT_SIZEstatic java.lang.StringJSON_PROPERTY_REQUIREDstatic java.lang.StringJSON_PROPERTY_REUSABLE_FORM_IDstatic java.lang.StringJSON_PROPERTY_SIGNERstatic java.lang.StringJSON_PROPERTY_TYPEstatic java.lang.StringJSON_PROPERTY_WIDTHstatic java.lang.StringJSON_PROPERTY_Xstatic java.lang.StringJSON_PROPERTY_Y
-
Constructor Summary
Constructors Constructor Description TemplateResponseDocumentCustomField()
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description TemplateResponseDocumentCustomFieldapiId(java.lang.String apiId)TemplateResponseDocumentCustomFieldavgTextLength(TemplateResponseFieldAvgTextLength avgTextLength)java.util.Map<java.lang.String,java.lang.Object>createFormData()booleanequals(java.lang.Object o)Return true if this TemplateResponseDocumentCustomField object is equal to o.TemplateResponseDocumentCustomFieldfontFamily(java.lang.String fontFamily)java.lang.StringgetApiId()The unique ID for this field.TemplateResponseFieldAvgTextLengthgetAvgTextLength()Get avgTextLengthjava.lang.StringgetFontFamily()Font family used in this form field's text.java.lang.StringgetGroup()The name of the group this field is in.java.lang.IntegergetHeight()The height in pixels of this form field.java.lang.BooleangetIsMultiline()Whether this form field is multiline text.java.lang.StringgetName()The name of the Custom Field.java.lang.ObjectgetNamedFormFields()Deprecated.java.lang.IntegergetOriginalFontSize()Original font size used in this form field's text.java.lang.BooleangetRequired()Boolean showing whether or not this field is required.java.lang.StringgetReusableFormId()Deprecated.java.lang.StringgetSigner()The signer of the Custom Field.TemplateResponseDocumentCustomField.TypeEnumgetType()The type of this Custom Field.java.lang.IntegergetWidth()The width in pixels of this form field.java.lang.IntegergetX()The horizontal offset in pixels for this form field.java.lang.IntegergetY()The vertical offset in pixels for this form field.TemplateResponseDocumentCustomFieldgroup(java.lang.String group)inthashCode()TemplateResponseDocumentCustomFieldheight(java.lang.Integer height)TemplateResponseDocumentCustomFieldisMultiline(java.lang.Boolean isMultiline)TemplateResponseDocumentCustomFieldname(java.lang.String name)TemplateResponseDocumentCustomFieldnamedFormFields(java.lang.Object namedFormFields)TemplateResponseDocumentCustomFieldoriginalFontSize(java.lang.Integer originalFontSize)TemplateResponseDocumentCustomFieldrequired(java.lang.Boolean required)TemplateResponseDocumentCustomFieldreusableFormId(java.lang.String reusableFormId)voidsetApiId(java.lang.String apiId)voidsetAvgTextLength(TemplateResponseFieldAvgTextLength avgTextLength)voidsetFontFamily(java.lang.String fontFamily)voidsetGroup(java.lang.String group)voidsetHeight(java.lang.Integer height)voidsetIsMultiline(java.lang.Boolean isMultiline)voidsetName(java.lang.String name)voidsetNamedFormFields(java.lang.Object namedFormFields)voidsetOriginalFontSize(java.lang.Integer originalFontSize)voidsetRequired(java.lang.Boolean required)voidsetReusableFormId(java.lang.String reusableFormId)voidsetSigner(java.lang.String signer)voidsetType(TemplateResponseDocumentCustomField.TypeEnum type)voidsetWidth(java.lang.Integer width)voidsetX(java.lang.Integer x)voidsetY(java.lang.Integer y)TemplateResponseDocumentCustomFieldsigner(java.lang.String signer)java.lang.StringtoString()TemplateResponseDocumentCustomFieldtype(TemplateResponseDocumentCustomField.TypeEnum type)TemplateResponseDocumentCustomFieldwidth(java.lang.Integer width)TemplateResponseDocumentCustomFieldx(java.lang.Integer x)TemplateResponseDocumentCustomFieldy(java.lang.Integer y)
-
-
-
Field Detail
-
JSON_PROPERTY_NAME
public static final java.lang.String JSON_PROPERTY_NAME
- See Also:
- Constant Field Values
-
JSON_PROPERTY_TYPE
public static final java.lang.String JSON_PROPERTY_TYPE
- See Also:
- Constant Field Values
-
JSON_PROPERTY_SIGNER
public static final java.lang.String JSON_PROPERTY_SIGNER
- See Also:
- Constant Field Values
-
JSON_PROPERTY_X
public static final java.lang.String JSON_PROPERTY_X
- See Also:
- Constant Field Values
-
JSON_PROPERTY_Y
public static final java.lang.String JSON_PROPERTY_Y
- See Also:
- Constant Field Values
-
JSON_PROPERTY_WIDTH
public static final java.lang.String JSON_PROPERTY_WIDTH
- See Also:
- Constant Field Values
-
JSON_PROPERTY_HEIGHT
public static final java.lang.String JSON_PROPERTY_HEIGHT
- See Also:
- Constant Field Values
-
JSON_PROPERTY_REQUIRED
public static final java.lang.String JSON_PROPERTY_REQUIRED
- See Also:
- Constant Field Values
-
JSON_PROPERTY_API_ID
public static final java.lang.String JSON_PROPERTY_API_ID
- See Also:
- Constant Field Values
-
JSON_PROPERTY_GROUP
public static final java.lang.String JSON_PROPERTY_GROUP
- See Also:
- Constant Field Values
-
JSON_PROPERTY_AVG_TEXT_LENGTH
public static final java.lang.String JSON_PROPERTY_AVG_TEXT_LENGTH
- See Also:
- Constant Field Values
-
JSON_PROPERTY_IS_MULTILINE
public static final java.lang.String JSON_PROPERTY_IS_MULTILINE
- See Also:
- Constant Field Values
-
JSON_PROPERTY_ORIGINAL_FONT_SIZE
public static final java.lang.String JSON_PROPERTY_ORIGINAL_FONT_SIZE
- See Also:
- Constant Field Values
-
JSON_PROPERTY_FONT_FAMILY
public static final java.lang.String JSON_PROPERTY_FONT_FAMILY
- See Also:
- Constant Field Values
-
JSON_PROPERTY_NAMED_FORM_FIELDS
public static final java.lang.String JSON_PROPERTY_NAMED_FORM_FIELDS
- See Also:
- Constant Field Values
-
JSON_PROPERTY_REUSABLE_FORM_ID
public static final java.lang.String JSON_PROPERTY_REUSABLE_FORM_ID
- See Also:
- Constant Field Values
-
-
Method Detail
-
name
public TemplateResponseDocumentCustomField name(java.lang.String name)
-
getName
@Nullable public java.lang.String getName()
The name of the Custom Field.- Returns:
- name
-
setName
public void setName(java.lang.String name)
-
type
public TemplateResponseDocumentCustomField type(TemplateResponseDocumentCustomField.TypeEnum type)
-
getType
@Nullable public TemplateResponseDocumentCustomField.TypeEnum getType()
The type of this Custom Field. Only `text` and `checkbox` are currently supported.- Returns:
- type
-
setType
public void setType(TemplateResponseDocumentCustomField.TypeEnum type)
-
signer
public TemplateResponseDocumentCustomField signer(java.lang.String signer)
-
getSigner
@Nullable public java.lang.String getSigner()
The signer of the Custom Field.- Returns:
- signer
-
setSigner
public void setSigner(java.lang.String signer)
-
x
public TemplateResponseDocumentCustomField x(java.lang.Integer x)
-
getX
@Nullable public java.lang.Integer getX()
The horizontal offset in pixels for this form field.- Returns:
- x
-
setX
public void setX(java.lang.Integer x)
-
y
public TemplateResponseDocumentCustomField y(java.lang.Integer y)
-
getY
@Nullable public java.lang.Integer getY()
The vertical offset in pixels for this form field.- Returns:
- y
-
setY
public void setY(java.lang.Integer y)
-
width
public TemplateResponseDocumentCustomField width(java.lang.Integer width)
-
getWidth
@Nullable public java.lang.Integer getWidth()
The width in pixels of this form field.- Returns:
- width
-
setWidth
public void setWidth(java.lang.Integer width)
-
height
public TemplateResponseDocumentCustomField height(java.lang.Integer height)
-
getHeight
@Nullable public java.lang.Integer getHeight()
The height in pixels of this form field.- Returns:
- height
-
setHeight
public void setHeight(java.lang.Integer height)
-
required
public TemplateResponseDocumentCustomField required(java.lang.Boolean required)
-
getRequired
@Nullable public java.lang.Boolean getRequired()
Boolean showing whether or not this field is required.- Returns:
- required
-
setRequired
public void setRequired(java.lang.Boolean required)
-
apiId
public TemplateResponseDocumentCustomField apiId(java.lang.String apiId)
-
getApiId
@Nullable public java.lang.String getApiId()
The unique ID for this field.- Returns:
- apiId
-
setApiId
public void setApiId(java.lang.String apiId)
-
group
public TemplateResponseDocumentCustomField group(java.lang.String group)
-
getGroup
@Nullable public java.lang.String getGroup()
The name of the group this field is in. If this field is not a group, this defaults to `null`.- Returns:
- group
-
setGroup
public void setGroup(java.lang.String group)
-
avgTextLength
public TemplateResponseDocumentCustomField avgTextLength(TemplateResponseFieldAvgTextLength avgTextLength)
-
getAvgTextLength
@Nullable public TemplateResponseFieldAvgTextLength getAvgTextLength()
Get avgTextLength- Returns:
- avgTextLength
-
setAvgTextLength
public void setAvgTextLength(TemplateResponseFieldAvgTextLength avgTextLength)
-
isMultiline
public TemplateResponseDocumentCustomField isMultiline(java.lang.Boolean isMultiline)
-
getIsMultiline
@Nullable public java.lang.Boolean getIsMultiline()
Whether this form field is multiline text.- Returns:
- isMultiline
-
setIsMultiline
public void setIsMultiline(java.lang.Boolean isMultiline)
-
originalFontSize
public TemplateResponseDocumentCustomField originalFontSize(java.lang.Integer originalFontSize)
-
getOriginalFontSize
@Nullable public java.lang.Integer getOriginalFontSize()
Original font size used in this form field's text.- Returns:
- originalFontSize
-
setOriginalFontSize
public void setOriginalFontSize(java.lang.Integer originalFontSize)
-
fontFamily
public TemplateResponseDocumentCustomField fontFamily(java.lang.String fontFamily)
-
getFontFamily
@Nullable public java.lang.String getFontFamily()
Font family used in this form field's text.- Returns:
- fontFamily
-
setFontFamily
public void setFontFamily(java.lang.String fontFamily)
-
namedFormFields
public TemplateResponseDocumentCustomField namedFormFields(java.lang.Object namedFormFields)
-
getNamedFormFields
@Deprecated @Nullable public java.lang.Object getNamedFormFields()
Deprecated.Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead.- Returns:
- namedFormFields
-
setNamedFormFields
public void setNamedFormFields(java.lang.Object namedFormFields)
-
reusableFormId
public TemplateResponseDocumentCustomField reusableFormId(java.lang.String reusableFormId)
-
getReusableFormId
@Deprecated @Nullable public java.lang.String getReusableFormId()
Deprecated.Get reusableFormId- Returns:
- reusableFormId
-
setReusableFormId
public void setReusableFormId(java.lang.String reusableFormId)
-
equals
public boolean equals(java.lang.Object o)
Return true if this TemplateResponseDocumentCustomField object is equal to o.- Overrides:
equalsin classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCodein classjava.lang.Object
-
toString
public java.lang.String toString()
- Overrides:
toStringin classjava.lang.Object
-
createFormData
public java.util.Map<java.lang.String,java.lang.Object> createFormData() throws ApiException- Throws:
ApiException
-
-