Package com.docusign.androidsdk.dsmodels

Types

Link copied to clipboard
data class DSAccount(name: String, accountId: String, isDefault: Boolean)
Link copied to clipboard
enum DSAnchorUnitsType : Enum<DSAnchorUnitsType>
Link copied to clipboard
class DSAppearance

This class provides branding information

Link copied to clipboard
data class DSBottomToolbarAppearance(bottomToolbarColor: ColorDrawable?, bottomToolbarButtonColor: ColorDrawable?, bottomToolbarButtonTextColor: ColorDrawable?, bottomToolbarDocuSignImageVisibility: Boolean)

This class provides Bottom Toolbar branding information

Link copied to clipboard
class DSCacheable

This class provides the info whether template is cacheable

Link copied to clipboard
data class DSConsumerDisclosure(enableEsign: Boolean?, companyName: String?, esignAgreement: String?)
Link copied to clipboard
data class DSCustomFields(listCustomFields: MutableList<DSListCustomField>?, textCustomFields: MutableList<DSTextCustomField>?)

This class provides template/envelope custom fields

Link copied to clipboard
class DSCustomSettings

This class is used to enable/disable Custom Settings

Link copied to clipboard
enum DSDateFormat : Enum<DSDateFormat>

This class represents the types of date formats

Link copied to clipboard
class DSDocument

Class which publicly represents a Document object

Link copied to clipboard
enum DSDocumentInsertAtPosition : Enum<DSDocumentInsertAtPosition>
Link copied to clipboard
class DSEnvelope

This class provides envelope information

Link copied to clipboard
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

Link copied to clipboard
class DSEnvelopeRecipient : DSRecipient

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

Link copied to clipboard
enum DSLanguage : Enum<DSLanguage>

Branding language for Embedded Signing

Link copied to clipboard
data class DSListCustomField(fieldId: Long, name: String, value: String, listItems: ArrayList<String>?, required: Boolean?, show: Boolean?)

This class provides list custom field information

Link copied to clipboard
data class DSOfflineAttributes(gpsLatitude: Double?, gpsLongitude: Double?, deviceModel: String?, deviceName: String?, accountESignId: String?, offlineSigningHash: String?)
Link copied to clipboard
abstract class DSRecipient
Link copied to clipboard
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

Link copied to clipboard
enum DSRecipientType : Enum<DSRecipientType>

This class provides the types of recipients

Link copied to clipboard
enum DSSignatureType : Enum<DSSignatureType>
Link copied to clipboard
enum DSStampType : Enum<DSStampType>

This class includes the stamp types of the Signature Tab

Link copied to clipboard
class DSTab : Cloneable

Class which publicly represents a Tab (aka Field) object

Link copied to clipboard
data class DSTabListItem(templateTabId: String, text: String, value: String, selected: Boolean)
Link copied to clipboard
enum DSTabType : Enum<DSTabType>

This class includes the tab types that are supported and unsupported

Link copied to clipboard
data class DSTemplate(templateId: String, templateName: String?, documentUri: String?)

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

Link copied to clipboard
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

Link copied to clipboard
data class DSTemplateFilter(includeDocuments: Boolean, includeTabs: Boolean, includePowerForms: Boolean, includeTemplateFavoriteStatus: Boolean)

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

Link copied to clipboard
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

Link copied to clipboard
data class DSTemplates(templates: List<DSTemplate>, resultTemplatesSize: Int, totalTemplatesSize: Int)

This class contains list of templates

Link copied to clipboard
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

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

This class provides text custom field information

Link copied to clipboard
enum DSTheme : Enum<DSTheme>

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

Link copied to clipboard
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