DSMRecipients.h
1 #import <Foundation/Foundation.h>
2 #import <CoreData/CoreData.h>
3 
8 @interface DSMRecipients : NSObject
13 @property(nonatomic, copy) NSArray<DSMSigner *> *signers;
18 @property(nonatomic, copy) NSArray<DSMAgent *> *agents;
23 @property(nonatomic, copy) NSArray<DSMEditor *> *editors;
28 @property(nonatomic, copy) NSArray<DSMIntermediary *> *intermediaries;
33 @property(nonatomic, copy) NSArray<DSMCarbonCopy *> *carbonCopies;
38 @property(nonatomic, copy) NSArray<DSMCertifiedDelivery *> *certifiedDeliveries;
43 @property(nonatomic, copy) NSArray<DSMInPersonSigner *> *inPersonSigners;
47 @property(nonatomic, copy) NSNumber *recipientCount;
51 @property(nonatomic, copy) NSNumber *currentRoutingOrder;
52 //TODO:Doc move to categories
57 - (NSArray *)allRecipientArrays;
62 - (NSArray *)allRecipients;
67 - (NSArray *)allSigners;
77 - (NSArray *)allSignersAndInpersonSigners;
91 - (DSMRecipient *)recipientWithId:(NSString *)recipientId;
95 - (DSMRecipient *)recipientWithRoleName:(NSString *)recipientRoleName;
96 
100 - (void)removeRecipient:(DSMRecipient *)recipient;
101 
102 #pragma mark - Recipient Switching (Native)
103 
110 - (void)signerFromInPersonSigner:(DSMInPersonSigner *)inPersonSigner name:(NSString *)name email:(NSString *)email;
120 - (void)inPersonSignerFromSigner:(DSMSigner *)signer hostName:(NSString *)hostName hostEmail:(NSString *)hostEmail signerName:(NSString *)signerName signerEmail:(NSString *)signerEmail;
121 
122 @end
Definition: DSMSigner.h:9
Definition: DSMInPersonSigner.h:9
BOOL allRecipientsHaveCompletedOrDeclined()
NSArray * allRecipients()
Definition: DSMRecipients.h:8
NSArray< DSMCarbonCopy * > * carbonCopies
A complex type containing information about recipients who should receive a copy of the envelope...
Definition: DSMRecipients.h:33
NSArray< DSMEditor * > * editors
A complex type defining the management and access rights of a recipient assigned assigned as an edito...
Definition: DSMRecipients.h:23
Definition: DSMCarbonCopy.h:5
NSArray * allSignersIncludingNeedsToView()
NSArray< DSMAgent * > * agents
A complex type defining the management and access rights of a recipient assigned assigned as an agent...
Definition: DSMRecipients.h:18
NSArray * allSignersAndInpersonSigners()
NSArray * allSigners()
NSNumber * currentRoutingOrder
Current routing order (recipient routing who is current signer)
Definition: DSMRecipients.h:51
Definition: DSMEditor.h:6
NSArray< DSMIntermediary * > * intermediaries
Identifies a recipient that can, but is not required to, add name and email information for recipient...
Definition: DSMRecipients.h:28
NSArray< DSMCertifiedDelivery * > * certifiedDeliveries
A complex type containing information on a recipient the must receive the completed documents for the...
Definition: DSMRecipients.h:38
Definition: DSMCertifiedDelivery.h:5
Definition: DSMAgent.h:5
NSArray< DSMSigner * > * signers
A complex type containing information about the Signer recipient. [optional].
Definition: DSMRecipients.h:13
NSNumber * recipientCount
recipients count
Definition: DSMRecipients.h:47
NSArray< DSMInPersonSigner * > * inPersonSigners
Specifies a signer that is in the same physical location as a DocuSign user who will act as a Signing...
Definition: DSMRecipients.h:43
BOOL anyCurrentRecipientsHaveDeclined()
NSArray * allRecipientArrays()
Definition: DSMIntermediary.h:6
Definition: DSMRecipient.h:14