sdk-common/com.docusign.androidsdk.dsmodels

Package com.docusign.androidsdk.dsmodels

Types

DSAccount

data class DSAccount(name: String, accountId: String, isDefault: Boolean)

DSAnchorUnitsType

enum DSAnchorUnitsType : Enum<DSAnchorUnitsType>

DSAppearance

class DSAppearance

This class provides branding information

DSBottomToolbarAppearance

data class DSBottomToolbarAppearance(bottomToolbarColor: ColorDrawable?, bottomToolbarButtonColor: ColorDrawable?, bottomToolbarButtonTextColor: ColorDrawable?, bottomToolbarDocuSignImageVisibility: Boolean)

This class provides Bottom Toolbar branding information

DSCacheable

class DSCacheable

This class provides the info whether template is cacheable

DSConsumerDisclosure

data class DSConsumerDisclosure(enableEsign: Boolean?, companyName: String?, esignAgreement: String?)

DSCustomFields

data class DSCustomFields(listCustomFields: MutableList<DSListCustomField>?, textCustomFields: MutableList<DSTextCustomField>?)

This class provides template/envelope custom fields

DSCustomSettings

class DSCustomSettings

This class is used to enable/disable Custom Settings

DSDateFormat

enum DSDateFormat : Enum<DSDateFormat>

This class represents the types of date formats

DSDocument

class DSDocument

Class which publicly represents a Document object

DSDocumentInsertAtPosition

enum DSDocumentInsertAtPosition : Enum<DSDocumentInsertAtPosition>

DSEnvelope

class DSEnvelope

This class provides envelope information

DSEnvelopeDefaults

data class DSEnvelopeDefaults(recipientDefaults: List<DSRecipientDefault>?, emailSubject: String?, emailBlurb: String?, envelopeTitle: String?, tabValueDefaults: Map<String, Any>?, customFields: DSCustomFields?)

This class provides the proper structure for Envelope Defaults to be used to inject (pre-fill) data into a Template

DSEnvelopeDefaultsUniqueRecipientSelectorType

enum DSEnvelopeDefaultsUniqueRecipientSelectorType : Enum<DSEnvelopeDefaultsUniqueRecipientSelectorType>

DSEnvelopeRecipient

class DSEnvelopeRecipient : DSRecipient

Class which publicly represents a Recipient object which is associated with an Envelope

DSLanguage

enum DSLanguage : Enum<DSLanguage>

Branding language for Embedded Signing

DSListCustomField

data class DSListCustomField(fieldId: Long, name: String, value: String, listItems: <ERROR CLASS><String>?, required: Boolean?, show: Boolean?)

This class provides list custom field information

DSOfflineAttributes

data class DSOfflineAttributes(gpsLatitude: Double?, gpsLongitude: Double?, deviceModel: String?, deviceName: String?, accountESignId: String?, offlineSigningHash: String?)

DSRecipient

abstract class DSRecipient

Base class for DSEnvelopeRecipient and DSTemplateRecipient

DSRecipientDefault

data class DSRecipientDefault(recipientEmail: String, recipientName: String, inPersonSignerName: String?, inPersonSignerEmail: String?, recipientId: String?, recipientRoleName: String?, recipientSelectorType: DSEnvelopeDefaultsUniqueRecipientSelectorType)

This class provides the proper structure for Recipient Defaults to be used to inject (pre-fill) Recipient data into a Template

DSRecipientType

enum DSRecipientType : Enum<DSRecipientType>

This class provides the types of recipients

DSSignatureType

enum DSSignatureType : Enum<DSSignatureType>

DSStampType

enum DSStampType : Enum<DSStampType>

This class includes the stamp types of the Signature Tab

DSSupplementalOptions

enum DSSupplementalOptions : Enum<DSSupplementalOptions>

This class provides Supplemental options

DSTab

class DSTab : Cloneable

Class which publicly represents a Tab (aka Field) object

DSTabListItem

data class DSTabListItem(templateTabId: String, text: String, value: String, selected: Boolean)

DSTabType

enum DSTabType : Enum<DSTabType>

This class includes the tab types that are supported and unsupported

DSTemplate

data class DSTemplate(templateId: String, templateName: String?, documentUri: String?)

This class provides the information about template. This is passed back to the integrating app

DSTemplateDefinition

data class DSTemplateDefinition(templateId: String, name: String?, description: String?, emailSubject: String?, emailBlurb: String?, pageCount: Int?, lastModified: Date?, uri: String?, envelopeId: String?, recipients: List<DSTemplateRecipient>?, customFields: DSCustomFields?, documents: List<DSDocument>?, cacheable: DSCacheable, brandId: String?, envelopeIdStamping: Boolean?)

This class provides the information about template. This is passed back to the integrating app

DSTemplateFilter

data class DSTemplateFilter(includeDocuments: Boolean, includeTabs: Boolean, includePowerForms: Boolean, includeTemplateFavoriteStatus: Boolean)

This class is used to filter the template based on the attributes

DSTemplateRecipient

data class DSTemplateRecipient(recipientId: String, email: String?, signerName: String?, hostName: String?, hostEmail: String?, roleName: String?, type: DSRecipientType, routingOrder: Int?, status: RecipientStatus?, tabs: List<DSTab>?, emailBody: String?, emailSubject: String?, emailSupportedLanguage: String?) : DSRecipient

This class provides the information about the template recipient

DSTemplates

data class DSTemplates(templates: List<DSTemplate>, resultTemplatesSize: Int, totalTemplatesSize: Int)

This class contains list of templates

DSTemplatesFilter

data class DSTemplatesFilter(count: Int, folder: String?, folder_ids: List<UUID>?, start_position: Int)

This class is used to filter the templates based on the attributes

DSTextCustomField

data class DSTextCustomField(fieldId: Long, name: String, value: String, required: Boolean?, show: Boolean?)

This class provides text custom field information

DSTheme

enum DSTheme : Enum<DSTheme>

Sets the theme. For Dark theme, set DSTheme.DARK

DSUser

data class DSUser(userId: String, name: String, email: String, accountId: String, accounts: List<DSAccount>)

This class provides information about the User. This is passed back to the integrating app