Package com.docusign.esign.model
Class UserSignature
- java.lang.Object
-
- com.docusign.esign.model.UserSignature
-
public class UserSignature extends Object
UserSignature.
-
-
Constructor Summary
Constructors Constructor Description UserSignature()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description UserSignatureadoptedDateTime(String adoptedDateTime)adoptedDateTime.UserSignaturecreatedDateTime(String createdDateTime)createdDateTime.UserSignaturedateStampProperties(DateStampProperties dateStampProperties)dateStampProperties.booleanequals(Object o)Compares objects.UserSignatureerrorDetails(ErrorDetails errorDetails)errorDetails.UserSignatureexternalID(String externalID)externalID.StringgetAdoptedDateTime()The date and time the user adopted their signature..StringgetCreatedDateTime()Indicates the date and time the item was created..DateStampPropertiesgetDateStampProperties()Get dateStampProperties.ErrorDetailsgetErrorDetails()Get errorDetails.StringgetExternalID().StringgetImageType().StringgetInitials150ImageId().StringgetInitialsImageUri()Contains the URI for an endpoint that you can use to retrieve the initials image..StringgetIsDefault().StringgetPhoneticName().StringgetSignature150ImageId().StringgetSignatureFont()The font type for the signature, if the signature is not drawn.StringgetSignatureId()Specifies the signature ID associated with the signature name.StringgetSignatureImageUri()Contains the URI for an endpoint that you can use to retrieve the signature image..StringgetSignatureInitials()The initials associated with the signature..StringgetSignatureName()Specifies the user signature name..StringgetSignatureType().StringgetStampFormat().StringgetStampImageUri().StringgetStampSizeMM().StringgetStampType().inthashCode()Returns the HashCode.UserSignatureimageType(String imageType)imageType.UserSignatureinitials150ImageId(String initials150ImageId)initials150ImageId.UserSignatureinitialsImageUri(String initialsImageUri)initialsImageUri.UserSignatureisDefault(String isDefault)isDefault.UserSignaturephoneticName(String phoneticName)phoneticName.voidsetAdoptedDateTime(String adoptedDateTime)setAdoptedDateTime.voidsetCreatedDateTime(String createdDateTime)setCreatedDateTime.voidsetDateStampProperties(DateStampProperties dateStampProperties)setDateStampProperties.voidsetErrorDetails(ErrorDetails errorDetails)setErrorDetails.voidsetExternalID(String externalID)setExternalID.voidsetImageType(String imageType)setImageType.voidsetInitials150ImageId(String initials150ImageId)setInitials150ImageId.voidsetInitialsImageUri(String initialsImageUri)setInitialsImageUri.voidsetIsDefault(String isDefault)setIsDefault.voidsetPhoneticName(String phoneticName)setPhoneticName.voidsetSignature150ImageId(String signature150ImageId)setSignature150ImageId.voidsetSignatureFont(String signatureFont)setSignatureFont.voidsetSignatureId(String signatureId)setSignatureId.voidsetSignatureImageUri(String signatureImageUri)setSignatureImageUri.voidsetSignatureInitials(String signatureInitials)setSignatureInitials.voidsetSignatureName(String signatureName)setSignatureName.voidsetSignatureType(String signatureType)setSignatureType.voidsetStampFormat(String stampFormat)setStampFormat.voidsetStampImageUri(String stampImageUri)setStampImageUri.voidsetStampSizeMM(String stampSizeMM)setStampSizeMM.voidsetStampType(String stampType)setStampType.UserSignaturesignature150ImageId(String signature150ImageId)signature150ImageId.UserSignaturesignatureFont(String signatureFont)signatureFont.UserSignaturesignatureId(String signatureId)signatureId.UserSignaturesignatureImageUri(String signatureImageUri)signatureImageUri.UserSignaturesignatureInitials(String signatureInitials)signatureInitials.UserSignaturesignatureName(String signatureName)signatureName.UserSignaturesignatureType(String signatureType)signatureType.UserSignaturestampFormat(String stampFormat)stampFormat.UserSignaturestampImageUri(String stampImageUri)stampImageUri.UserSignaturestampSizeMM(String stampSizeMM)stampSizeMM.UserSignaturestampType(String stampType)stampType.StringtoString()Converts the given object to string.
-
-
-
Method Detail
-
adoptedDateTime
public UserSignature adoptedDateTime(String adoptedDateTime)
adoptedDateTime.- Returns:
- UserSignature
-
getAdoptedDateTime
public String getAdoptedDateTime()
The date and time the user adopted their signature..- Returns:
- adoptedDateTime
-
setAdoptedDateTime
public void setAdoptedDateTime(String adoptedDateTime)
setAdoptedDateTime.
-
createdDateTime
public UserSignature createdDateTime(String createdDateTime)
createdDateTime.- Returns:
- UserSignature
-
getCreatedDateTime
public String getCreatedDateTime()
Indicates the date and time the item was created..- Returns:
- createdDateTime
-
setCreatedDateTime
public void setCreatedDateTime(String createdDateTime)
setCreatedDateTime.
-
dateStampProperties
public UserSignature dateStampProperties(DateStampProperties dateStampProperties)
dateStampProperties.- Returns:
- UserSignature
-
getDateStampProperties
public DateStampProperties getDateStampProperties()
Get dateStampProperties.- Returns:
- dateStampProperties
-
setDateStampProperties
public void setDateStampProperties(DateStampProperties dateStampProperties)
setDateStampProperties.
-
errorDetails
public UserSignature errorDetails(ErrorDetails errorDetails)
errorDetails.- Returns:
- UserSignature
-
getErrorDetails
public ErrorDetails getErrorDetails()
Get errorDetails.- Returns:
- errorDetails
-
setErrorDetails
public void setErrorDetails(ErrorDetails errorDetails)
setErrorDetails.
-
externalID
public UserSignature externalID(String externalID)
externalID.- Returns:
- UserSignature
-
getExternalID
public String getExternalID()
.- Returns:
- externalID
-
setExternalID
public void setExternalID(String externalID)
setExternalID.
-
imageType
public UserSignature imageType(String imageType)
imageType.- Returns:
- UserSignature
-
getImageType
public String getImageType()
.- Returns:
- imageType
-
setImageType
public void setImageType(String imageType)
setImageType.
-
initials150ImageId
public UserSignature initials150ImageId(String initials150ImageId)
initials150ImageId.- Returns:
- UserSignature
-
getInitials150ImageId
public String getInitials150ImageId()
.- Returns:
- initials150ImageId
-
setInitials150ImageId
public void setInitials150ImageId(String initials150ImageId)
setInitials150ImageId.
-
initialsImageUri
public UserSignature initialsImageUri(String initialsImageUri)
initialsImageUri.- Returns:
- UserSignature
-
getInitialsImageUri
public String getInitialsImageUri()
Contains the URI for an endpoint that you can use to retrieve the initials image..- Returns:
- initialsImageUri
-
setInitialsImageUri
public void setInitialsImageUri(String initialsImageUri)
setInitialsImageUri.
-
isDefault
public UserSignature isDefault(String isDefault)
isDefault.- Returns:
- UserSignature
-
getIsDefault
public String getIsDefault()
.- Returns:
- isDefault
-
setIsDefault
public void setIsDefault(String isDefault)
setIsDefault.
-
phoneticName
public UserSignature phoneticName(String phoneticName)
phoneticName.- Returns:
- UserSignature
-
getPhoneticName
public String getPhoneticName()
.- Returns:
- phoneticName
-
setPhoneticName
public void setPhoneticName(String phoneticName)
setPhoneticName.
-
signature150ImageId
public UserSignature signature150ImageId(String signature150ImageId)
signature150ImageId.- Returns:
- UserSignature
-
getSignature150ImageId
public String getSignature150ImageId()
.- Returns:
- signature150ImageId
-
setSignature150ImageId
public void setSignature150ImageId(String signature150ImageId)
setSignature150ImageId.
-
signatureFont
public UserSignature signatureFont(String signatureFont)
signatureFont.- Returns:
- UserSignature
-
getSignatureFont
public String getSignatureFont()
The font type for the signature, if the signature is not drawn. The supported font types are: \"7_DocuSign\", \"1_DocuSign\", \"6_DocuSign\", \"8_DocuSign\", \"3_DocuSign\", \"Mistral\", \"4_DocuSign\", \"2_DocuSign\", \"5_DocuSign\", \"Rage Italic\" .- Returns:
- signatureFont
-
setSignatureFont
public void setSignatureFont(String signatureFont)
setSignatureFont.
-
signatureId
public UserSignature signatureId(String signatureId)
signatureId.- Returns:
- UserSignature
-
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.
-
signatureImageUri
public UserSignature signatureImageUri(String signatureImageUri)
signatureImageUri.- Returns:
- UserSignature
-
getSignatureImageUri
public String getSignatureImageUri()
Contains the URI for an endpoint that you can use to retrieve the signature image..- Returns:
- signatureImageUri
-
setSignatureImageUri
public void setSignatureImageUri(String signatureImageUri)
setSignatureImageUri.
-
signatureInitials
public UserSignature signatureInitials(String signatureInitials)
signatureInitials.- Returns:
- UserSignature
-
getSignatureInitials
public String getSignatureInitials()
The initials associated with the signature..- Returns:
- signatureInitials
-
setSignatureInitials
public void setSignatureInitials(String signatureInitials)
setSignatureInitials.
-
signatureName
public UserSignature signatureName(String signatureName)
signatureName.- Returns:
- UserSignature
-
getSignatureName
public String getSignatureName()
Specifies the user signature name..- Returns:
- signatureName
-
setSignatureName
public void setSignatureName(String signatureName)
setSignatureName.
-
signatureType
public UserSignature signatureType(String signatureType)
signatureType.- Returns:
- UserSignature
-
getSignatureType
public String getSignatureType()
.- Returns:
- signatureType
-
setSignatureType
public void setSignatureType(String signatureType)
setSignatureType.
-
stampFormat
public UserSignature stampFormat(String stampFormat)
stampFormat.- Returns:
- UserSignature
-
getStampFormat
public String getStampFormat()
.- Returns:
- stampFormat
-
setStampFormat
public void setStampFormat(String stampFormat)
setStampFormat.
-
stampImageUri
public UserSignature stampImageUri(String stampImageUri)
stampImageUri.- Returns:
- UserSignature
-
getStampImageUri
public String getStampImageUri()
.- Returns:
- stampImageUri
-
setStampImageUri
public void setStampImageUri(String stampImageUri)
setStampImageUri.
-
stampSizeMM
public UserSignature stampSizeMM(String stampSizeMM)
stampSizeMM.- Returns:
- UserSignature
-
getStampSizeMM
public String getStampSizeMM()
.- Returns:
- stampSizeMM
-
setStampSizeMM
public void setStampSizeMM(String stampSizeMM)
setStampSizeMM.
-
stampType
public UserSignature stampType(String stampType)
stampType.- Returns:
- UserSignature
-
getStampType
public String getStampType()
.- Returns:
- stampType
-
setStampType
public void setStampType(String stampType)
setStampType.
-
equals
public boolean equals(Object o)
Compares objects.
-
-