Package com.groupdocs.cloud.signature.model

Class SignDigitalOptions

java.lang.Object

com.groupdocs.cloud.signature.model.OptionsBase

com.groupdocs.cloud.signature.model.SignOptions

com.groupdocs.cloud.signature.model.SignImageOptions

com.groupdocs.cloud.signature.model.SignDigitalOptions

public class SignDigitalOptions
extends SignImageOptions

Represents the Digital sign options

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SignDigitalOptions.XadESTypeEnum	XAdES type GroupDocs.Signature.Options.DigitalSignOptions.XAdESType.

Nested classes/interfaces inherited from class com.groupdocs.cloud.signature.model.OptionsBase

OptionsBase.SignatureTypeEnum

Nested classes/interfaces inherited from class com.groupdocs.cloud.signature.model.SignImageOptions

SignImageOptions.HorizontalAlignmentEnum, SignImageOptions.LocationMeasureTypeEnum, SignImageOptions.MarginMeasureTypeEnum, SignImageOptions.SizeMeasureTypeEnum, SignImageOptions.VerticalAlignmentEnum

Constructor Summary

Constructors

Constructor	Description
SignDigitalOptions()

Method Summary

Modifier and Type	Method	Description
SignDigitalOptions	certificateFilePath(String certificateFilePath)
SignDigitalOptions	comments(String comments)
SignDigitalOptions	contact(String contact)
SignDigitalOptions	digitalVBA(DigitalVBA digitalVBA)
boolean	equals(Object o)
String	getCertificateFilePath()	Gets or sets the digital certificate file GUID
String	getComments()	The signing purpose comment.
String	getContact()	Gets or sets the signature contact.
DigitalVBA	getDigitalVBA()	Options for signing VBA project
String	getLocation()	Gets or sets the signature location.
String	getPassword()	Gets or sets the password of digital certificate
String	getReason()	Gets or sets the reason of signature.
org.threeten.bp.OffsetDateTime	getSignTime()	The time the document was signed.
Boolean	getVisible()	Gets or sets the visibility of signature.
SignDigitalOptions.XadESTypeEnum	getXadESType()	XAdES type GroupDocs.Signature.Options.DigitalSignOptions.XAdESType.
int	hashCode()
SignDigitalOptions	location(String location)
SignDigitalOptions	password(String password)
SignDigitalOptions	reason(String reason)
void	setCertificateFilePath(String certificateFilePath)
void	setComments(String comments)
void	setContact(String contact)
void	setDigitalVBA(DigitalVBA digitalVBA)
void	setLocation(String location)
void	setPassword(String password)
void	setReason(String reason)
void	setSignTime(org.threeten.bp.OffsetDateTime signTime)
void	setVisible(Boolean visible)
void	setXadESType(SignDigitalOptions.XadESTypeEnum xadESType)
SignDigitalOptions	signTime(org.threeten.bp.OffsetDateTime signTime)
String	toString()
SignDigitalOptions	visible(Boolean visible)
SignDigitalOptions	xadESType(SignDigitalOptions.XadESTypeEnum xadESType)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from class com.groupdocs.cloud.signature.model.OptionsBase

allPages, getAllPages, getPage, getPagesSetup, getSignatureType, page, pagesSetup, setAllPages, setPage, setPagesSetup, setSignatureType, signatureType

Methods inherited from class com.groupdocs.cloud.signature.model.SignImageOptions

border, getBorder, getHeight, getHorizontalAlignment, getImageFilePath, getLeft, getLocationMeasureType, getMargin, getMarginMeasureType, getRotationAngle, getSizeMeasureType, getTop, getTransparency, getVerticalAlignment, getWidth, height, horizontalAlignment, imageFilePath, left, locationMeasureType, margin, marginMeasureType, rotationAngle, setBorder, setHeight, setHorizontalAlignment, setImageFilePath, setLeft, setLocationMeasureType, setMargin, setMarginMeasureType, setRotationAngle, setSizeMeasureType, setTop, setTransparency, setVerticalAlignment, setWidth, sizeMeasureType, top, transparency, verticalAlignment, width

Methods inherited from class com.groupdocs.cloud.signature.model.SignOptions

appearance, getAppearance, setAppearance

Constructor Detail

SignDigitalOptions

public SignDigitalOptions()

Method Detail

reason

public SignDigitalOptions reason(String reason)

getReason

public String getReason()

Gets or sets the reason of signature.

Returns:

reason

setReason

public void setReason(String reason)

contact

public SignDigitalOptions contact(String contact)

getContact

public String getContact()

Gets or sets the signature contact.

Returns:

contact

setContact

public void setContact(String contact)

location

public SignDigitalOptions location(String location)

getLocation

public String getLocation()

Gets or sets the signature location.

Returns:

location

setLocation

public void setLocation(String location)

visible

public SignDigitalOptions visible(Boolean visible)

getVisible

public Boolean getVisible()

Gets or sets the visibility of signature.

Returns:

visible

setVisible

public void setVisible(Boolean visible)

password

public SignDigitalOptions password(String password)

getPassword

public String getPassword()

Gets or sets the password of digital certificate

Returns:

password

setPassword

public void setPassword(String password)

certificateFilePath

public SignDigitalOptions certificateFilePath(String certificateFilePath)

getCertificateFilePath

public String getCertificateFilePath()

Gets or sets the digital certificate file GUID

Returns:

certificateFilePath

setCertificateFilePath

public void setCertificateFilePath(String certificateFilePath)

xadESType

public SignDigitalOptions xadESType(SignDigitalOptions.XadESTypeEnum xadESType)

getXadESType

public SignDigitalOptions.XadESTypeEnum getXadESType()

XAdES type GroupDocs.Signature.Options.DigitalSignOptions.XAdESType. Default value is None (XAdES is off). At this moment XAdES signature type is supported only for Spreadsheet documents.

Returns:

xadESType

setXadESType

public void setXadESType(SignDigitalOptions.XadESTypeEnum xadESType)

digitalVBA

public SignDigitalOptions digitalVBA(DigitalVBA digitalVBA)

getDigitalVBA

public DigitalVBA getDigitalVBA()

Options for signing VBA project

Returns:

digitalVBA

setDigitalVBA

public void setDigitalVBA(DigitalVBA digitalVBA)

signTime

public SignDigitalOptions signTime(org.threeten.bp.OffsetDateTime signTime)

getSignTime

public org.threeten.bp.OffsetDateTime getSignTime()

The time the document was signed.

Returns:

signTime

setSignTime

public void setSignTime(org.threeten.bp.OffsetDateTime signTime)

comments

public SignDigitalOptions comments(String comments)

getComments

public String getComments()

The signing purpose comment.

Returns:

comments

setComments

public void setComments(String comments)

equals

public boolean equals(Object o)

Overrides:

equals in class SignImageOptions

hashCode

public int hashCode()

Overrides:

hashCode in class SignImageOptions

toString

public String toString()

Overrides:

toString in class SignImageOptions