pspdfkit/com.pspdfkit.ui.signatures/ElectronicSignatureOptions

ElectronicSignatureOptions

data class ElectronicSignatureOptions(val signatureSavingStrategy: SignatureSavingStrategy = SignatureSavingStrategy.SAVE_IF_SELECTED, val signatureColorOptions: SignatureColorOptions = SignatureColorOptions.fromDefaults(), val signatureCreationModes: List<SignatureCreationMode> = listOf(SignatureCreationMode.DRAW, SignatureCreationMode.IMAGE, SignatureCreationMode.TYPE)) : Parcelable

Options for configuring the ElectronicSignatureFragment. An instance of this can be passed to .

Constructors

Link copied to clipboard
constructor(signatureSavingStrategy: SignatureSavingStrategy = SignatureSavingStrategy.SAVE_IF_SELECTED, signatureColorOptions: SignatureColorOptions = SignatureColorOptions.fromDefaults(), signatureCreationModes: List<SignatureCreationMode> = listOf(SignatureCreationMode.DRAW, SignatureCreationMode.IMAGE, SignatureCreationMode.TYPE))

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val signatureColorOptions: SignatureColorOptions

Defines the signature color options available when using the "Draw" or "Type" signing UI. Defaults to black, purple, and blue. signatureColorOptions Can be created from @ColorRes or @ColorInt with SignatureColorOptions.fromColorRes and SignatureColorOptions.fromColorInt respectively. Defaults can be created with SignatureColorOptions.fromDefaults

Link copied to clipboard
@get:Size(min = 1, max = 3)
val signatureCreationModes: List<SignatureCreationMode>

Which modes do you want to support? Defaults to Draw/Type/Image.

Link copied to clipboard
val signatureSavingStrategy: SignatureSavingStrategy

The saving strategy used when adding signatures. Defaults to . This will only work if a com.pspdfkit.signatures.storage.SignatureStorage has been created and set via com.pspdfkit.ui.PdfFragment.setSignatureStorage, otherwise SignatureSavingStrategy.NEVER_SAVE will be used.