Builder

class Builder

This class is used for building the DSEnvelope Object

Constructors

Link copied to clipboard
fun Builder()

Functions

Link copied to clipboard
fun brandId(brandId: String): DSEnvelope.Builder

Used to set brand Id for the envelope. It is applicable for embedded Online Signing only. You may need to invoke DocuSign.getInstance().getCustomSettingsDelegate().disableNativeComponentsInOnlineSigning(context, true) to see branding based on the brandId in embedded online signing ceremony.

Link copied to clipboard
fun build(): DSEnvelope

Used for building a DSEnvelope object

Link copied to clipboard
fun document(document: DSDocument): DSEnvelope.Builder

Used to add a document's details

Link copied to clipboard
fun documents(documents: List<DSDocument>): DSEnvelope.Builder

Used to add a list documents

Link copied to clipboard
fun emailBlurb(emailBlurb: String): DSEnvelope.Builder

Used to add Email Message. Message should not exceed 10,000 characters in length

Link copied to clipboard
fun emailSubject(emailSubject: String): DSEnvelope.Builder

Used to add Email Subject. Subject should not exceed 1,000 characters in length

Link copied to clipboard
fun envelopeIdStamping(enabled: Boolean): DSEnvelope.Builder

Used to enable or disable displaying envelope Id stamp in the document.

Link copied to clipboard
fun envelopeName(envelopeName: String): DSEnvelope.Builder

Used to add Envelope Name. Name should not exceed 950 characters in length

Link copied to clipboard
fun listCustomField(listCustomField: DSListCustomField): DSEnvelope.Builder

Used to add Envelope's ListCustomField

Link copied to clipboard
fun listCustomFields(listCustomFields: List<DSListCustomField>): DSEnvelope.Builder

Used to list of Envelope's ListCustomField

Link copied to clipboard
fun recipient(recipient: DSEnvelopeRecipient): DSEnvelope.Builder

Used to add a recipient information

Link copied to clipboard
fun recipients(recipients: List<DSEnvelopeRecipient>): DSEnvelope.Builder

Used to add list of recipients

Link copied to clipboard
fun textCustomField(textCustomField: DSTextCustomField): DSEnvelope.Builder

Used to add Envelope's TextCustomField

Link copied to clipboard
fun textCustomFields(textCustomFields: List<DSTextCustomField>): DSEnvelope.Builder

Used to list of Envelope's TextCustomField

Properties

Link copied to clipboard
var online: Boolean = false
Link copied to clipboard
var validate: Boolean = true