Package com.docusign.esign.model
Class UserSignatureDefinition
- java.lang.Object
-
- com.docusign.esign.model.UserSignatureDefinition
-
public class UserSignatureDefinition extends Object
UserSignatureDefinition.
-
-
Constructor Summary
Constructors Constructor Description UserSignatureDefinition()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description UserSignatureDefinitiondateStampProperties(DateStampProperties dateStampProperties)dateStampProperties.UserSignatureDefinitiondisallowUserResizeStamp(String disallowUserResizeStamp)disallowUserResizeStamp.booleanequals(Object o)Compares objects.UserSignatureDefinitionexternalID(String externalID)externalID.DateStampPropertiesgetDateStampProperties()Specifies the area in which a date stamp is placed.StringgetDisallowUserResizeStamp().StringgetExternalID().StringgetImageType().StringgetIsDefault().StringgetNrdsId().StringgetNrdsLastName().StringgetPhoneticName().StringgetSignatureFont().StringgetSignatureId()Specifies the signature ID associated with the signature name.StringgetSignatureInitials().StringgetSignatureName()Specifies the user signature name..StringgetSignatureType().StringgetStampFormat().StringgetStampSizeMM().inthashCode()Returns the HashCode.UserSignatureDefinitionimageType(String imageType)imageType.UserSignatureDefinitionisDefault(String isDefault)isDefault.UserSignatureDefinitionnrdsId(String nrdsId)nrdsId.UserSignatureDefinitionnrdsLastName(String nrdsLastName)nrdsLastName.UserSignatureDefinitionphoneticName(String phoneticName)phoneticName.voidsetDateStampProperties(DateStampProperties dateStampProperties)setDateStampProperties.voidsetDisallowUserResizeStamp(String disallowUserResizeStamp)setDisallowUserResizeStamp.voidsetExternalID(String externalID)setExternalID.voidsetImageType(String imageType)setImageType.voidsetIsDefault(String isDefault)setIsDefault.voidsetNrdsId(String nrdsId)setNrdsId.voidsetNrdsLastName(String nrdsLastName)setNrdsLastName.voidsetPhoneticName(String phoneticName)setPhoneticName.voidsetSignatureFont(String signatureFont)setSignatureFont.voidsetSignatureId(String signatureId)setSignatureId.voidsetSignatureInitials(String signatureInitials)setSignatureInitials.voidsetSignatureName(String signatureName)setSignatureName.voidsetSignatureType(String signatureType)setSignatureType.voidsetStampFormat(String stampFormat)setStampFormat.voidsetStampSizeMM(String stampSizeMM)setStampSizeMM.UserSignatureDefinitionsignatureFont(String signatureFont)signatureFont.UserSignatureDefinitionsignatureId(String signatureId)signatureId.UserSignatureDefinitionsignatureInitials(String signatureInitials)signatureInitials.UserSignatureDefinitionsignatureName(String signatureName)signatureName.UserSignatureDefinitionsignatureType(String signatureType)signatureType.UserSignatureDefinitionstampFormat(String stampFormat)stampFormat.UserSignatureDefinitionstampSizeMM(String stampSizeMM)stampSizeMM.StringtoString()Converts the given object to string.
-
-
-
Method Detail
-
dateStampProperties
public UserSignatureDefinition dateStampProperties(DateStampProperties dateStampProperties)
dateStampProperties.- Returns:
- UserSignatureDefinition
-
getDateStampProperties
public DateStampProperties getDateStampProperties()
Specifies the area in which a date stamp is placed. This parameter uses pixel positioning to draw a rectangle at the center of the stamp area. The stamp is superimposed on top of this central area. This property contains the following information about the central rectangle: - `DateAreaX`: The X axis position of the top-left corner. - `DateAreaY`: The Y axis position of the top-left corner. - `DateAreaWidth`: The width of the rectangle. - `DateAreaHeight`: The height of the rectangle..- Returns:
- dateStampProperties
-
setDateStampProperties
public void setDateStampProperties(DateStampProperties dateStampProperties)
setDateStampProperties.
-
disallowUserResizeStamp
public UserSignatureDefinition disallowUserResizeStamp(String disallowUserResizeStamp)
disallowUserResizeStamp.- Returns:
- UserSignatureDefinition
-
getDisallowUserResizeStamp
public String getDisallowUserResizeStamp()
.- Returns:
- disallowUserResizeStamp
-
setDisallowUserResizeStamp
public void setDisallowUserResizeStamp(String disallowUserResizeStamp)
setDisallowUserResizeStamp.
-
externalID
public UserSignatureDefinition externalID(String externalID)
externalID.- Returns:
- UserSignatureDefinition
-
getExternalID
public String getExternalID()
.- Returns:
- externalID
-
setExternalID
public void setExternalID(String externalID)
setExternalID.
-
imageType
public UserSignatureDefinition imageType(String imageType)
imageType.- Returns:
- UserSignatureDefinition
-
getImageType
public String getImageType()
.- Returns:
- imageType
-
setImageType
public void setImageType(String imageType)
setImageType.
-
isDefault
public UserSignatureDefinition isDefault(String isDefault)
isDefault.- Returns:
- UserSignatureDefinition
-
getIsDefault
public String getIsDefault()
.- Returns:
- isDefault
-
setIsDefault
public void setIsDefault(String isDefault)
setIsDefault.
-
nrdsId
public UserSignatureDefinition nrdsId(String nrdsId)
nrdsId.- Returns:
- UserSignatureDefinition
-
getNrdsId
public String getNrdsId()
.- Returns:
- nrdsId
-
setNrdsId
public void setNrdsId(String nrdsId)
setNrdsId.
-
nrdsLastName
public UserSignatureDefinition nrdsLastName(String nrdsLastName)
nrdsLastName.- Returns:
- UserSignatureDefinition
-
getNrdsLastName
public String getNrdsLastName()
.- Returns:
- nrdsLastName
-
setNrdsLastName
public void setNrdsLastName(String nrdsLastName)
setNrdsLastName.
-
phoneticName
public UserSignatureDefinition phoneticName(String phoneticName)
phoneticName.- Returns:
- UserSignatureDefinition
-
getPhoneticName
public String getPhoneticName()
.- Returns:
- phoneticName
-
setPhoneticName
public void setPhoneticName(String phoneticName)
setPhoneticName.
-
signatureFont
public UserSignatureDefinition signatureFont(String signatureFont)
signatureFont.- Returns:
- UserSignatureDefinition
-
getSignatureFont
public String getSignatureFont()
.- Returns:
- signatureFont
-
setSignatureFont
public void setSignatureFont(String signatureFont)
setSignatureFont.
-
signatureId
public UserSignatureDefinition signatureId(String signatureId)
signatureId.- Returns:
- UserSignatureDefinition
-
getSignatureId
public String getSignatureId()
Specifies the signature ID associated with the signature name. You can use the signature ID in the URI in place of the signature name, and the value stored in the `signatureName` property in the body is used. This allows the use of special characters (such as \"&\", \"<\", \">\") in a the signature name. Note that with each update to signatures, the returned signature ID might change, so the caller will need to trigger off the signature name to get the new signature ID..- Returns:
- signatureId
-
setSignatureId
public void setSignatureId(String signatureId)
setSignatureId.
-
signatureInitials
public UserSignatureDefinition signatureInitials(String signatureInitials)
signatureInitials.- Returns:
- UserSignatureDefinition
-
getSignatureInitials
public String getSignatureInitials()
.- Returns:
- signatureInitials
-
setSignatureInitials
public void setSignatureInitials(String signatureInitials)
setSignatureInitials.
-
signatureName
public UserSignatureDefinition signatureName(String signatureName)
signatureName.- Returns:
- UserSignatureDefinition
-
getSignatureName
public String getSignatureName()
Specifies the user signature name..- Returns:
- signatureName
-
setSignatureName
public void setSignatureName(String signatureName)
setSignatureName.
-
signatureType
public UserSignatureDefinition signatureType(String signatureType)
signatureType.- Returns:
- UserSignatureDefinition
-
getSignatureType
public String getSignatureType()
.- Returns:
- signatureType
-
setSignatureType
public void setSignatureType(String signatureType)
setSignatureType.
-
stampFormat
public UserSignatureDefinition stampFormat(String stampFormat)
stampFormat.- Returns:
- UserSignatureDefinition
-
getStampFormat
public String getStampFormat()
.- Returns:
- stampFormat
-
setStampFormat
public void setStampFormat(String stampFormat)
setStampFormat.
-
stampSizeMM
public UserSignatureDefinition stampSizeMM(String stampSizeMM)
stampSizeMM.- Returns:
- UserSignatureDefinition
-
getStampSizeMM
public String getStampSizeMM()
.- Returns:
- stampSizeMM
-
setStampSizeMM
public void setStampSizeMM(String stampSizeMM)
setStampSizeMM.
-
equals
public boolean equals(Object o)
Compares objects.
-
-