Class UserSignature

    • Constructor Detail

      • UserSignature

        public UserSignature()
    • 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.
      • customField

        public UserSignature customField​(String customField)
        customField.
        Returns:
        UserSignature
      • getCustomField

        public String getCustomField()
        .
        Returns:
        customField
      • setCustomField

        public void setCustomField​(String customField)
        setCustomField.
      • 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 UserSignature disallowUserResizeStamp​(String disallowUserResizeStamp)
        disallowUserResizeStamp.
        Returns:
        UserSignature
      • getDisallowUserResizeStamp

        public String getDisallowUserResizeStamp()
        .
        Returns:
        disallowUserResizeStamp
      • setDisallowUserResizeStamp

        public void setDisallowUserResizeStamp​(String disallowUserResizeStamp)
        setDisallowUserResizeStamp.
      • getErrorDetails

        public ErrorDetails getErrorDetails()
        Array or errors..
        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.
      • imageBase64

        public UserSignature imageBase64​(String imageBase64)
        imageBase64.
        Returns:
        UserSignature
      • getImageBase64

        public String getImageBase64()
        .
        Returns:
        imageBase64
      • setImageBase64

        public void setImageBase64​(String imageBase64)
        setImageBase64.
      • 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.
      • lastModifiedDateTime

        public UserSignature lastModifiedDateTime​(String lastModifiedDateTime)
        lastModifiedDateTime.
        Returns:
        UserSignature
      • getLastModifiedDateTime

        public String getLastModifiedDateTime()
        The date and time the item was last modified..
        Returns:
        lastModifiedDateTime
      • setLastModifiedDateTime

        public void setLastModifiedDateTime​(String lastModifiedDateTime)
        setLastModifiedDateTime.
      • getNrdsId

        public String getNrdsId()
        .
        Returns:
        nrdsId
      • setNrdsId

        public void setNrdsId​(String nrdsId)
        setNrdsId.
      • nrdsLastName

        public UserSignature nrdsLastName​(String nrdsLastName)
        nrdsLastName.
        Returns:
        UserSignature
      • getNrdsLastName

        public String getNrdsLastName()
        .
        Returns:
        nrdsLastName
      • setNrdsLastName

        public void setNrdsLastName​(String nrdsLastName)
        setNrdsLastName.
      • nrdsStatus

        public UserSignature nrdsStatus​(String nrdsStatus)
        nrdsStatus.
        Returns:
        UserSignature
      • getNrdsStatus

        public String getNrdsStatus()
        .
        Returns:
        nrdsStatus
      • setNrdsStatus

        public void setNrdsStatus​(String nrdsStatus)
        setNrdsStatus.
      • 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.
      • signatureRights

        public UserSignature signatureRights​(String signatureRights)
        signatureRights.
        Returns:
        UserSignature
      • getSignatureRights

        public String getSignatureRights()
        .
        Returns:
        signatureRights
      • setSignatureRights

        public void setSignatureRights​(String signatureRights)
        setSignatureRights.
      • 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.
      • getStatus

        public String getStatus()
        Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later..
        Returns:
        status
      • setStatus

        public void setStatus​(String status)
        setStatus.
      • equals

        public boolean equals​(Object o)
        Compares objects.
        Overrides:
        equals in class Object
        Returns:
        true or false depending on comparison result.
      • hashCode

        public int hashCode()
        Returns the HashCode.
        Overrides:
        hashCode in class Object
      • toString

        public String toString()
        Converts the given object to string.
        Overrides:
        toString in class Object