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

Parameters

recipientEmail

Email of the recipient. In the case of in-person, this is the Host Email. Required.

recipientName

Name of the recipient. In the case of in-person, this is the Host Name. Required.

inPersonSignerName

Name of inPersonSigner, Required only in case for recipientType DSRecipientType.IN_PERSON_SIGNER.

inPersonSignerEmail

Email of inPersonSigner. Optional.

recipientId

Selector value to identify a recipient with Id (e.g. "1" or "41774568"). Required when recipientSelector type is DSEnvelopeDefaultsUniqueRecipientSelectorType.RECIPIENT_ID.

recipientRoleName

Selector value to identify a recipient with a given roleName (e.g. "SalesRep 1"). Required when recipientSelector type is DSEnvelopeDefaultsUniqueRecipientSelectorType.ROLE_NAME.

recipientSelectorType

Either DSEnvelopeDefaultsUniqueRecipientSelectorType.ROLE_NAME or DSEnvelopeDefaultsUniqueRecipientSelectorType.RECIPIENT. Required.

Constructors

Link copied to clipboard
fun DSRecipientDefault(recipientEmail: String, recipientName: String, inPersonSignerName: String?, inPersonSignerEmail: String?, recipientId: String?, recipientRoleName: String?, recipientSelectorType: DSEnvelopeDefaultsUniqueRecipientSelectorType)

Properties

Link copied to clipboard
var inPersonSignerEmail: String?
Link copied to clipboard
val inPersonSignerName: String?
Link copied to clipboard
var recipientEmail: String
Link copied to clipboard
val recipientId: String?
Link copied to clipboard
val recipientName: String
Link copied to clipboard
val recipientRoleName: String?
Link copied to clipboard