DSMSigner Class Reference

#import <DSMSigner.h>

Inheritance diagram for DSMSigner:
DSMRecipient

Properties

DSMRecipientSignatureInformationsignatureInfo
 The DSMRecipientSignatureInformation class object. More...
 
BOOL defaultRecipient
 TODO:Doc. More...
 
DSMTabstabs
 The DSMTabs class object. More...
 
BOOL signInEachLocation
 When set to true, specifies that the signer must sign in all locations. [optional]. More...
 
NSString * requireSignerCertificate
 Sets the type of signer certificate required for signing. If left blank, no certificate is required. Only one type of certificate can be set for a signer. The possible values are:

* docusign_express – Requires a DocuSign Express certificate.
* safe – Requires a SAFE-BioPharma certificate.
* open_trust – Requires an OpenTrust certificate.

**Important**: There are certain rules and restrictions that must be followed when requiring OpenTrust digital signatures. See [ML:OpenTrust Rules and Restrictions] for more information. [optional]. More...
 
BOOL requireSignOnPaper
 When set to true, the signer must print, sign, and upload or fax the signed documents to DocuSign. [optional]. More...
 
BOOL canSignOffline
 When set to true, specifies that the signer can perform the signing ceremony offline. [optional]. More...
 
BOOL isBulkRecipient
 When set to true, this signer is a bulk recipient and the recipient information is contained in a bulk recipient file.
that when this is true the email and name for the recipient becomes bulk@.nosp@m.reci.nosp@m.pient.nosp@m..com and "Bulk Recipient". These fields can not be changed for the bulk recipient. [optional]. More...
 
NSString * bulkRecipientsUri
 Contains a URI for an endpoint that allows you to easily retrieve bulk recipient information. [optional]. More...
 
NSString * recipientSuppliesTabs
 TODO:Doc. More...
 
NSArray< NSString * > * excludedDocuments
 Specifies the documents that are not visible to this recipient. Document Visibility must be enabled for the account and the enforceSignerVisibility property must be set to true for the envelope to use this.
enforce signer visibility is enabled, documents with tabs can only be viewed by signers that have a tab on that document. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all the documents in an envelope, unless they are specifically excluded using this setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded using this setting when an envelope is sent. [optional]. More...
 
NSString * name
 Name of the recipient. More...
 
NSString * email
 Email id of the recipient. Notification of the document to sign is sent to this email id.
length: 100 characters. [optional]. More...
 
NSString * emailRecipientPostSigningURL
 TODO:Doc. More...
 
- Properties inherited from DSMRecipient
DSMRecipientType recipientType
 recipientType type of the recipient(siner, inpersonsinger,...) More...
 
NSString * signingGroupId
 When set to true and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab ( instead of adopting a signature/initial style or only drawing a signature/initial once). [optional]. More...
 
NSString * signingGroupName
 The display name for the signing group.
Length: 100 characters. [optional]. More...
 
NSArray< DSMUserInfo * > * signingGroupUsers
 A complex type that contains information about users in the signing group. [optional]. More...
 
NSString * recipientId
 Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. [optional]. More...
 
NSString * recipientIdGuid
 TODO:Doc. More...
 
NSString * accessCode
 If a value is provided, the recipient must enter the value as the access code to view and sign the envelope.
Length: 50 characters and must conform to account’s access code format setting.
blank, but the signer accessCode property is set in the envelope, then that value is used.
blank and the signer accessCode property is not set, then access code is not required. [optional]. More...
 
NSString * addAccessCodeToEmail
 This Optional attribute indicates that the access code will be added to the email sent to the recipient; this nullifies the Security measure of Access Code on the recipient. [optional]. More...
 
BOOL requireIdLookup
 When set to true, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity. [optional]. More...
 
NSString * idCheckConfigurationName
 Specifies authentication check by name. The names used here must be the same as the authentication type names used by the account (these name can also be found in the web console sending interface in the Identify list for a recipient,) This overrides any default authentication setting.

*Example*: Your account has ID Check and SMS Authentication available and in the web console Identify list these appear as 'ID Check $' and 'SMS Auth $'. To use ID check in an envelope, the idCheckConfigurationName should be 'ID Check '. If you wanted to use SMS, it would be 'SMS Auth $' and you would need to add you would need to add phone number information to the smsAuthentication node. [optional]. More...
 
NSString * userId
 TODO:Doc. More...
 
NSString * clientUserId
 Specifies whether the recipient is embedded or remote.
the clientUserId property is not null then the recipient is embedded. Note that if the ClientUserId property is set and either SignerMustHaveAccount or SignerMustLoginToSign property of the account settings is set to true, an error is generated on sending.ng.
length: 100 characters. [optional]. More...
 
NSString * embeddedRecipientStartURL
 Specifies a sender provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender’s system (the server responding to the URL) must request a recipient token to launch a signing session.
set to SIGN_AT_DOCUSIGN, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation that is launched by any partner.
is important to remember that in a typical embedded workflow the authentication of an embedded recipient is the responsibility of the sending application, DocuSign expects that senders will follow their own process for establishing the recipient’s identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process in initiated. However, when the sending application sets EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN, the recipient goes directly to the embedded signing or viewing process bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient.
the clientUserId property is NOT set, and the embeddedRecipientStartURL is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: envelopeId, recipientId, recipientName, recipientEmail, and customFields. The customFields property must be set fort the recipient or envelope. The merge fields are enclosed in double brackets.

*Example*:

http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]] [optional]. More...
 
NSArray< NSString * > * customFields
 An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters. [optional]. More...
 
NSNumber * routingOrder
 Specifies the routing order of the recipient in the envelope. [optional]. More...
 
NSArray< DSMAttachment * > * recipientAttachments
 TODO:Doc. More...
 
NSString * note
 Specifies a note that is unique to this recipient. This note is sent to the recipient via the signing email. The note displays in the signing UI near the upper left corner of the document on the signing screen.
Length: 1000 characters. [optional]. More...
 
NSString * roleName
 Optional element. Specifies the role name associated with the recipient.

This is required when working with template recipients. [optional]. More...
 
NSString * status
 Indicates the envelope status. Valid values are:

* sent - The envelope is sent to the recipients.
* created - The envelope is saved as a draft and can be modified and sent later. [optional]. More...
 
NSDate * signedDateTime
 Reserved: For DocuSign use only. [optional]. More...
 
NSDate * deliveredDateTime
 Reserved: For DocuSign use only. [optional]. More...
 
NSDate * declinedDateTime
 The date and time the recipient declined the document. [optional]. More...
 
NSDate * sentDateTime
 The date and time the envelope was sent. [optional]. More...
 
NSString * declinedReason
 The reason the recipient declined the document. [optional]. More...
 
NSString * deliveryMethod
 Reserved: For DocuSign use only. [optional]. More...
 
NSString * faxNumber
 Reserved: [optional]. More...
 
BOOL templateLocked
 When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients. [optional]. More...
 
BOOL templateRequired
 When set to true, the sender may not remove the recipient. Used only when working with template recipients. [optional]. More...
 
BOOL inheritEmailNotificationConfiguration
 When set to true and the envelope recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient's account. [optional]. More...
 
NSNumber * totalTabCount
 Total tab count. More...
 
DSMRecipientEmailNotificationemailNotification
 TODO:Doc. More...
 
DSMOfflineAttributesofflineAttributes
 TODO:Doc. More...
 
DSMSignature * signature
 TODO:Doc. More...
 

Additional Inherited Members

- Instance Methods inherited from DSMRecipient
(BOOL) - isSentOrDelivered
 
(BOOL) - hasCompletedOrDeclined
 
(BOOL) - isDigitalCertificateSigner
 
(BOOL) - matchesUserWithUserID:
 
(NSString *) - dsm_name
 
(NSString *) - dsm_email
 

Property Documentation

◆ bulkRecipientsUri

- (NSString*) bulkRecipientsUri
readwritenonatomiccopy

Contains a URI for an endpoint that allows you to easily retrieve bulk recipient information. [optional].

◆ canSignOffline

- (BOOL) canSignOffline
readwritenonatomicassign

When set to true, specifies that the signer can perform the signing ceremony offline. [optional].

◆ defaultRecipient

- (BOOL) defaultRecipient
readwritenonatomicassign

TODO:Doc.

◆ email

- (NSString*) email
readwritenonatomiccopy

Email id of the recipient. Notification of the document to sign is sent to this email id.
length: 100 characters. [optional].

◆ emailRecipientPostSigningURL

- (NSString*) emailRecipientPostSigningURL
readwritenonatomiccopy

TODO:Doc.

◆ excludedDocuments

- (NSArray<NSString *>*) excludedDocuments
readwritenonatomiccopy

Specifies the documents that are not visible to this recipient. Document Visibility must be enabled for the account and the enforceSignerVisibility property must be set to true for the envelope to use this.
enforce signer visibility is enabled, documents with tabs can only be viewed by signers that have a tab on that document. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all the documents in an envelope, unless they are specifically excluded using this setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded using this setting when an envelope is sent. [optional].

◆ isBulkRecipient

- (BOOL) isBulkRecipient
readwritenonatomicassign

When set to true, this signer is a bulk recipient and the recipient information is contained in a bulk recipient file.
that when this is true the email and name for the recipient becomes bulk@.nosp@m.reci.nosp@m.pient.nosp@m..com and "Bulk Recipient". These fields can not be changed for the bulk recipient. [optional].

◆ name

- (NSString*) name
readwritenonatomiccopy

Name of the recipient.

◆ recipientSuppliesTabs

- (NSString*) recipientSuppliesTabs
readwritenonatomiccopy

TODO:Doc.

◆ requireSignerCertificate

- (NSString*) requireSignerCertificate
readwritenonatomiccopy

Sets the type of signer certificate required for signing. If left blank, no certificate is required. Only one type of certificate can be set for a signer. The possible values are:

* docusign_express – Requires a DocuSign Express certificate.
* safe – Requires a SAFE-BioPharma certificate.
* open_trust – Requires an OpenTrust certificate.

**Important**: There are certain rules and restrictions that must be followed when requiring OpenTrust digital signatures. See [ML:OpenTrust Rules and Restrictions] for more information. [optional].

◆ requireSignOnPaper

- (BOOL) requireSignOnPaper
readwritenonatomicassign

When set to true, the signer must print, sign, and upload or fax the signed documents to DocuSign. [optional].

◆ signatureInfo

- (DSMRecipientSignatureInformation*) signatureInfo
readwritenonatomicretain

◆ signInEachLocation

- (BOOL) signInEachLocation
readwritenonatomicassign

When set to true, specifies that the signer must sign in all locations. [optional].

◆ tabs

- (DSMTabs*) tabs
readwritenonatomicretain

The DSMTabs class object.

See also
DSMTabs.h

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