DSMRecipientDefault Class Reference

#import <DSMRecipientDefault.h>

Inheritance diagram for DSMRecipientDefault:

Properties

NSString * inPersonSignerName
 
NSString * recipientEmail
 
NSString * recipientName
 
NSString * recipientId
 
NSString * recipientRoleName
 
DSMEnvelopeDefaultsUniqueRecipientSelectorType recipientSelectorType
 
DSMRecipientType recipientType
 
BOOL removeRecipient
 

Detailed Description

Parent class that contains the recipient default values to apply to override template data before starting signing ceremony.

See also
DSMEnvelopeDefaults.h

Property Documentation

◆ inPersonSignerName

- (NSString*) inPersonSignerName
readwritenonatomicretain

Name of inPersonSigner, Required only in case of recipientType as DSMRecipientTypeInPersonSigner.

See also
DSMRecipientType

◆ recipientEmail

- (NSString*) recipientEmail
readwritenonatomicretain

Email of the recipient, required for both DSMRecipientTypeInPersonSigner or DSMRecipientTypeSigner

See also
DSMRecipientType

◆ recipientId

- (NSString*) recipientId
readwritenonatomicretain

Selector value to identify a recipient with Id (e.g. "1" or "41774568"). Required when DSMEnvelopeDefaultsUniqueRecipientSelectorType is set as DSMEnvelopeDefaultsUniqueRecipientSelectorTypeRecipientId.

See also
DSMEnvelopeDefaultsUniqueRecipientSelectorType

◆ recipientName

- (NSString*) recipientName
readwritenonatomicretain

Name of the recipient, required for both DSMRecipientTypeInPersonSigner or DSMRecipientTypeSigner

See also
DSMRecipientType

◆ recipientRoleName

- (NSString*) recipientRoleName
readwritenonatomicretain

Selector value to identify a recipient with a given roleName (e.g. "SalesRep 1"). Required when DSMEnvelopeDefaultsUniqueRecipientSelectorType is set as DSMEnvelopeDefaultsUniqueRecipientSelectorTypeRecipientRoleName.

See also
DSMEnvelopeDefaultsUniqueRecipientSelectorType

◆ recipientSelectorType

- (DSMEnvelopeDefaultsUniqueRecipientSelectorType) recipientSelectorType
readwritenonatomicassign

Type of the recipient selector

See also
DSMEnvelopeDefaultsUniqueRecipientSelectorType

◆ recipientType

- (DSMRecipientType) recipientType
readwritenonatomicassign

Type of the recipient (Host vs RemoteSigner)

See also
DSMRecipientType.h

◆ removeRecipient

- (BOOL) removeRecipient
readwritenonatomicassign

When this boolean set to "true" the recipient will be removed during envelope creation.To remove a recipient, recipientName and recipientEmail is not required. Default value for this parameter is false.

See also
recipientId,recipientRoleName

The documentation for this class was generated from the following file: