DSMRecipient.h
1 #import <Foundation/Foundation.h>
2 #import <CoreData/CoreData.h>
3 
4 @class DSMUserInfo;
5 @class DSMAttachment;
7 @class DSMSignature;
9 
10 typedef NS_ENUM(NSUInteger, DSMRecipientType);
14 @interface DSMRecipient : NSObject
19 @property(nonatomic) DSMRecipientType recipientType;
23 @property(nonatomic, copy) NSString *signingGroupId;
27 @property(nonatomic, copy) NSString *signingGroupName;
32 @property(nonatomic, copy) NSArray<DSMUserInfo *> *signingGroupUsers;
36 @property(nonatomic, copy) NSString *recipientId;
40 @property(nonatomic, copy) NSString *recipientIdGuid;
44 @property(nonatomic, copy) NSString *accessCode;
48 @property(nonatomic, copy) NSString *addAccessCodeToEmail;
52 @property(nonatomic, assign) BOOL requireIdLookup;
56 @property(nonatomic, copy) NSString *idCheckConfigurationName;
57 //@property(nonatomic, copy) NSArray<DSESocialAuthentication> *socialAuthentications;
58 //@property(nonatomic, copy) DSRecipientPhoneAuthentication *phoneAuthentication;
59 //@property(nonatomic, copy) DSRecipientSAMLAuthentication *samlAuthentication;
60 //@property(nonatomic, copy) DSRecipientSMSAuthentication *smsAuthentication;
64 @property(nonatomic, copy) NSString *userId;
68 @property(nonatomic, copy) NSString *clientUserId;
72 @property(nonatomic, copy) NSString *embeddedRecipientStartURL;
76 @property(nonatomic, copy) NSArray<NSString *> *customFields;
80 @property(nonatomic, copy) NSNumber *routingOrder;
81 //@property(nonatomic, copy) DSIdCheckInformationInput *idCheckInformationInput;
85 @property(nonatomic, copy) NSArray<DSMAttachment *> *recipientAttachments;
89 @property(nonatomic, copy) NSString *note;
93 @property(nonatomic, copy) NSString *roleName;
97 @property(nonatomic, copy) NSString *status;
101 @property(nonatomic, copy) NSDate *signedDateTime;
105 @property(nonatomic, copy) NSDate *deliveredDateTime;
109 @property(nonatomic, copy) NSDate *declinedDateTime;
113 @property(nonatomic, copy) NSDate *sentDateTime;
117 @property(nonatomic, copy) NSString *declinedReason;
121 @property(nonatomic, copy) NSString *deliveryMethod;
125 @property(nonatomic, copy) NSString *faxNumber;
129 @property(nonatomic, assign) BOOL templateLocked;
133 @property(nonatomic, assign) BOOL templateRequired;
134 //@property(nonatomic, copy) DSRecipientEmailNotification *emailNotification;
138 @property(nonatomic, assign) BOOL inheritEmailNotificationConfiguration;
139 //@property(nonatomic, copy) DSErrorDetails *errorDetails;
140 //@property(nonatomic, copy) DSAuthenticationStatus *recipientAuthenticationStatus;
144 @property(nonatomic, copy) NSNumber *totalTabCount;
149 @property (nonatomic, retain) DSMRecipientEmailNotification *emailNotification;
154 @property(nonatomic, retain) DSMOfflineAttributes *offlineAttributes;
159 @property (nonatomic, retain) DSMSignature *signature;
160 //TODO:Doc Move to categories
165 - (BOOL)isSentOrDelivered;
170 - (BOOL)hasCompletedOrDeclined;
180 - (BOOL)matchesUserWithUserID:(NSString *)userID;
181 
182 @end
183 
189 -(NSString *)dsm_name;
190 -(NSString *)dsm_email;
191 @end
NSDate * sentDateTime
The date and time the envelope was sent. [optional].
Definition: DSMRecipient.h:113
NSDate * signedDateTime
Reserved: For DocuSign use only. [optional].
Definition: DSMRecipient.h:101
NSString * note
Specifies a note that is unique to this recipient. This note is sent to the recipient via the signing...
Definition: DSMRecipient.h:89
NSString * userId
TODO:Doc.
Definition: DSMRecipient.h:64
Definition: DSMRecipientEmailNotification.h:6
NSDate * declinedDateTime
The date and time the recipient declined the document. [optional].
Definition: DSMRecipient.h:109
NSString * recipientIdGuid
TODO:Doc.
Definition: DSMRecipient.h:40
BOOL isSentOrDelivered()
DSMSignature * signature
TODO:Doc.
Definition: DSMRecipient.h:159
BOOL requireIdLookup
When set to true, the recipient is required to use the specified ID check method (including Phone and...
Definition: DSMRecipient.h:52
NSString * signingGroupId
When set to true and the feature is enabled in the sender&#39;s account, the signing recipient is require...
Definition: DSMRecipient.h:23
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].
Definition: DSMRecipient.h:72
NSArray< NSString * > * customFields
An optional array of strings that allows the sender to provide custom data about the recipient...
Definition: DSMRecipient.h:76
NSArray< DSMUserInfo * > * signingGroupUsers
A complex type that contains information about users in the signing group. [optional].
Definition: DSMRecipient.h:32
NSString * signingGroupName
The display name for the signing group. Length: 100 characters. [optional].
Definition: DSMRecipient.h:27
NSString * accessCode
If a value is provided, the recipient must enter the value as the access code to view and sign the en...
Definition: DSMRecipient.h:44
DSMRecipientType recipientType
recipientType type of the recipient(siner, inpersonsinger,...)
Definition: DSMRecipient.h:19
NSString * idCheckConfigurationName
Specifies authentication check by name. The names used here must be the same as the authentication ty...
Definition: DSMRecipient.h:56
DSMOfflineAttributes * offlineAttributes
TODO:Doc.
Definition: DSMRecipient.h:154
NSDate * deliveredDateTime
Reserved: For DocuSign use only. [optional].
Definition: DSMRecipient.h:105
NSString * clientUserId
Specifies whether the recipient is embedded or remote. the clientUserId property is not null then t...
Definition: DSMRecipient.h:68
Definition: DSMAttachment.h:6
NSString * recipientId
Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Do...
Definition: DSMRecipient.h:36
BOOL hasCompletedOrDeclined()
BOOL templateRequired
When set to true, the sender may not remove the recipient. Used only when working with template recip...
Definition: DSMRecipient.h:133
NSArray< DSMAttachment * > * recipientAttachments
TODO:Doc.
Definition: DSMRecipient.h:85
NSString * status
Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients...
Definition: DSMRecipient.h:97
Definition: DSMOfflineAttributes.h:6
NSNumber * totalTabCount
Total tab count.
Definition: DSMRecipient.h:144
Definition: DSMRecipient.h:184
BOOL templateLocked
When set to true, the sender cannot change any attributes of the recipient. Used only when working wi...
Definition: DSMRecipient.h:129
NSString * addAccessCodeToEmail
This Optional attribute indicates that the access code will be added to the email sent to the recipie...
Definition: DSMRecipient.h:48
Definition: DSMUserInfo.h:5
BOOL isDigitalCertificateSigner()
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&#39;s account. [optional].
Definition: DSMRecipient.h:138
NSString * faxNumber
Reserved: [optional].
Definition: DSMRecipient.h:125
NSString * declinedReason
The reason the recipient declined the document. [optional].
Definition: DSMRecipient.h:117
DSMRecipientEmailNotification * emailNotification
TODO:Doc.
Definition: DSMRecipient.h:149
NSString * roleName
Optional element. Specifies the role name associated with the recipient. This is required when worki...
Definition: DSMRecipient.h:93
NSString * deliveryMethod
Reserved: For DocuSign use only. [optional].
Definition: DSMRecipient.h:121
NSNumber * routingOrder
Specifies the routing order of the recipient in the envelope. [optional].
Definition: DSMRecipient.h:80
Definition: DSMRecipient.h:14