Skip to navigation
Apex Toolkit reference

SignHereTab

View as Markdown
global class SignHereTab extends SignatureTab
Description
A sign here tab enables the recipient to sign a document. May be optional. This value can't be set.
isSeal
global Boolean isSeal
When set to true, the tab contains a visual representation for an electronic seal in a document.

Corresponds to the isSealSignTab API property.

stamp
global Stamp stamp
The user's stamp.

Methods

global SignHereTab()
Description
Constructs a sign here tab.
global SignHereTab withIsSeal(final Boolean isSeal)
Description
Updates the tab isSeal property.
Returns
The tab with an updated isSeal value.
Parameters
isSeal
final Boolean isSeal
When set to true, the tab contains a visual representation for an electronic seal in a document.
global SignHereTab withStamp(final Stamp stamp)
Description
Updates the tab stamp property.
Returns
The tab with an updated stamp value.
Parameters
stamp
final Stamp stamp
The user's stamp.

SignHereTab.DateStamp

global class DateStamp
Description
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.
height
global Integer height
The height of the rectangle.

Corresponds to the dateAreaHeight API property.

width
global Integer width
The width of the rectangle.

Corresponds to the dateAreaWidth API property.

x
global Integer x
The X axis position of the top-left corner.

Corresponds to the dateAreaX API property.

y
global Integer y
The Y axis position of the top-left corner.

Corresponds to the dateAreaY API property.

Methods

global DateStamp(final Integer x, final Integer y, final Integer width, final Integer height)
Description
Constructs a date stamp.
Parameters
x
final Integer x
The X axis position of the top-left corner.
y
final Integer y
The Y axis position of the top-left corner.
width
final Integer width
The width of the rectangle.
height
final Integer height
The height of the rectangle.

SignHereTab.StampImage

global class StampImage
Description
Representation of the signature stamp image.
base64
global String base64
Base64 representation of the image.

Corresponds to the imageBase64 API parameter.

isResizable
global Boolean isResizable
When set to true, users may resize the stamp.

Corresponds to the disallowUserResizeStamp API parameter.

size
global Integer size
The physical height of the stamp image (in millimeters) that the stamp vendor recommends for displaying the image in PDF documents.

Corresponds to the stampSizeMM API parameter.

type
global String type
Specifies the type of image. Valid values are:
  • signature_image
  • initials_image

Corresponds to the imageType API parameter.

uri
global String uri
The URI for retrieving the image of the user's stamp.

Corresponds to the stampImageUri API parameter.

Methods

global StampImage(final String type, final String uri, final String base64, final Integer size, final Boolean isResizable)
Description
Constructs a stamp image.
Parameters
type
final String type
Specifies the type of image.
uri
final String uri
The URI for retrieving the image of the user's stamp.
base64
final String base64
Base64 representation of the image.
size
final Integer size
The physical height of the stamp image (in millimeters) that the stamp vendor recommends for displaying the image in PDF documents.
isResizable
final Boolean isResizable
When set to true, users may resize the stamp.

SignHereTab.Stamp

global class Stamp
Description
Representation of a user's stamp.
customField
global String customField
Optional custom field for the stamp.
dateStamp
global DateStamp dateStamp
The date stamp.
externalId
global String externalId
Optional external identifier for the user's signature.
format
global String format
The format of the stamp. Valid values are:
  • NameHanko: The stamp represents only the signer's name.
  • NameDateHanko: The stamp represents the signer's name and the date.

Corresponds to the stampFormat API parameter.

image
global StampImage image
The stamp image.
phoneticName
global String phoneticName
The phonetic spelling of the signatureName.
signatureName
global String signatureName
Specifies the user's signature name.
type
global String type
The type of stamp. Valid values are:
  • signature: A signature image. This is the default value.
  • stamp: A stamp image.

Corresponds to the stampType API parameter.

Methods

global Stamp( final String type, final String externalId, final String format, final String signatureName, final String phoneticName, final StampImage image, final DateStamp dateStamp, final String customField )
Description
Constructs a stamp.
Parameters
type
final String type
The type of stamp.
externalId
final String externalId
Optional external identifier for the user's signature.
format
final String format
The format of the stamp.
signatureName
final String signatureName
Specifies the user's signature name.
phoneticName
final String phoneticName
The phonetic spelling of the signatureName.
image
final StampImage image
The stamp image.
dateStamp
final DateStamp dateStamp
The date stamp.
customField
final String customField
Optional custom field for the stamp.