new module:model/UserSignature()
- Source:
Constructs a new UserSignature.
Members
(inner) adoptedDateTime :String
- Source:
The date and time the user adopted their signature.
Type:
- String
(inner) createdDateTime :String
- Source:
Indicates the date and time the item was created.
Type:
- String
(inner) customField :String
- Source:
Type:
- String
(inner) dateStampProperties :module:model/DateStampProperties
- Source:
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.
Type:
(inner) disallowUserResizeStamp :String
- Source:
Type:
- String
(inner) errorDetails :module:model/ErrorDetails
- Source:
Array or errors.
Type:
(inner) externalID :String
- Source:
Type:
- String
(inner) imageBase64 :String
- Source:
Type:
- String
(inner) imageType :String
- Source:
Type:
- String
(inner) initials150ImageId :String
- Source:
Type:
- String
(inner) initialsImageUri :String
- Source:
Contains the URI for an endpoint that you can use to retrieve the initials image.
Type:
- String
(inner) isDefault :String
- Source:
Type:
- String
(inner) lastModifiedDateTime :String
- Source:
The date and time the item was last modified.
Type:
- String
(inner) nrdsId :String
- Source:
Type:
- String
(inner) nrdsLastName :String
- Source:
Type:
- String
(inner) nrdsStatus :String
- Source:
Type:
- String
(inner) phoneticName :String
- Source:
Type:
- String
(inner) signature150ImageId :String
- Source:
Type:
- String
(inner) signatureFont :String
- Source:
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"
Type:
- String
(inner) signatureId :String
- Source:
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.
Type:
- String
(inner) signatureImageUri :String
- Source:
Contains the URI for an endpoint that you can use to retrieve the signature image.
Type:
- String
(inner) signatureInitials :String
- Source:
The initials associated with the signature.
Type:
- String
(inner) signatureName :String
- Source:
Specifies the user signature name.
Type:
- String
(inner) signatureRights :String
- Source:
Type:
- String
(inner) signatureType :String
- Source:
Type:
- String
(inner) stampFormat :String
- Source:
Type:
- String
(inner) stampImageUri :String
- Source:
Type:
- String
(inner) stampSizeMM :String
- Source:
Type:
- String
(inner) stampType :String
- Source:
Type:
- String
(inner) status :String
- Source:
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.
Type:
- String
Methods
(static) constructFromObject(data, obj) → {module:model/UserSignature}
- Source:
Constructs a UserSignature from a plain JavaScript object, optionally creating a new instance.
Copies all relevant properties from data to obj if supplied or a new instance if not.
Parameters:
| Name | Type | Description |
|---|---|---|
data |
Object | The plain JavaScript object bearing properties of interest. |
obj |
module:model/UserSignature | Optional instance to populate. |
Returns:
The populated UserSignature instance.