DSMRecipients Class Reference

#import <DSMRecipients.h>

Inheritance diagram for DSMRecipients:

Instance Methods

(NSArray *) - allRecipientArrays
 
(NSArray *) - allRecipients
 
(NSArray *) - allSigners
 
(NSArray *) - allSignersIncludingNeedsToView
 
(NSArray *) - allSignersAndInpersonSigners
 
(BOOL) - anyCurrentRecipientsHaveDeclined
 
(BOOL) - allRecipientsHaveCompletedOrDeclined
 
(DSMRecipient *) - recipientWithId:
 
(DSMRecipient *) - recipientWithRoleName:
 
(void) - removeRecipient:
 
(void) - signerFromInPersonSigner:name:email:
 
(void) - inPersonSignerFromSigner:hostName:hostEmail:signerName:signerEmail:
 

Properties

NSArray< DSMSigner * > * signers
 A complex type containing information about the Signer recipient. [optional]. More...
 
NSArray< DSMAgent * > * agents
 A complex type defining the management and access rights of a recipient assigned assigned as an agent on the document. [optional]. More...
 
NSArray< DSMEditor * > * editors
 A complex type defining the management and access rights of a recipient assigned assigned as an editor on the document. [optional]. More...
 
NSArray< DSMIntermediary * > * intermediaries
 Identifies a recipient that can, but is not required to, add name and email information for recipients at the same or subsequent level in the routing order (until subsequent Agents, Editors or Intermediaries recipient types are added). [optional]. More...
 
NSArray< DSMCarbonCopy * > * carbonCopies
 A complex type containing information about recipients who should receive a copy of the envelope, but does not need to sign it. [optional]. More...
 
NSArray< DSMCertifiedDelivery * > * certifiedDeliveries
 A complex type containing information on a recipient the must receive the completed documents for the envelope to be completed, but the recipient does not need to sign, initial, date, or add information to any of the documents. [optional]. More...
 
NSArray< DSMInPersonSigner * > * inPersonSigners
 Specifies a signer that is in the same physical location as a DocuSign user who will act as a Signing Host for the transaction. The recipient added is the Signing Host and new separate Signer Name field appears after Sign in person is selected. [optional]. More...
 
NSNumber * recipientCount
 recipients count More...
 
NSNumber * currentRoutingOrder
 Current routing order (recipient routing who is current signer) More...
 

Method Documentation

◆ allRecipientArrays()

- (NSArray *) allRecipientArrays

Gives list of all recipients.

Returns
NSArray

◆ allRecipients()

- (NSArray *) allRecipients

Gives list of all recipients.

Returns
NSArray

◆ allRecipientsHaveCompletedOrDeclined()

- (BOOL) allRecipientsHaveCompletedOrDeclined

Returns true if all the recipients have completed (signing or decliend).

Returns
BOOL

◆ allSigners()

- (NSArray *) allSigners

Gives list of all recipients. TODO:Doc

Returns
NSArray

◆ allSignersAndInpersonSigners()

- (NSArray *) allSignersAndInpersonSigners

Gives list of all inperson signers.

Returns
NSArray

◆ allSignersIncludingNeedsToView()

- (NSArray *) allSignersIncludingNeedsToView

Gives list of all signers.

Returns
NSArray

◆ anyCurrentRecipientsHaveDeclined()

- (BOOL) anyCurrentRecipientsHaveDeclined

If any of the current signers have declined. TODO:Doc

Returns
BOOL

◆ inPersonSignerFromSigner:hostName:hostEmail:signerName:signerEmail:()

- (void) inPersonSignerFromSigner: (DSMSigner *)  signer
hostName: (NSString *)  hostName
hostEmail: (NSString *)  hostEmail
signerName: (NSString *)  signerName
signerEmail: (NSString *)  signerEmail 

return an inPersonSigner created from signer object data.

Parameters
signersigner object
hostNamename of host for in person signer
hostEmailemail of host for in person signer
signerNamename of in person signer
signerEmailemail of in person signer
See also
DSMSigner.h DSMInPersonSigner.h

◆ recipientWithId:()

- (DSMRecipient *) recipientWithId: (NSString *)  recipientId

Return a recipient with given recipient Id.

◆ recipientWithRoleName:()

- (DSMRecipient *) recipientWithRoleName: (NSString *)  recipientRoleName

Return a recipient with given recipient RoleName.

◆ removeRecipient:()

- (void) removeRecipient: (DSMRecipient *)  recipient

Removes a recipient from corresponding recipients array.

◆ signerFromInPersonSigner:name:email:()

- (void) signerFromInPersonSigner: (DSMInPersonSigner *)  inPersonSigner
name: (NSString *)  name
email: (NSString *)  email 

return a signer created from inPersonSigner object data.

Parameters
inPersonSignerin person signer object
namename of remote signer
emailemail of remote signer
See also
DSMSigner.h DSMInPersonSigner.h

Property Documentation

◆ agents

- (NSArray<DSMAgent *>*) agents
readwritenonatomiccopy

A complex type defining the management and access rights of a recipient assigned assigned as an agent on the document. [optional].

See also
DSMAgent.h

◆ carbonCopies

- (NSArray<DSMCarbonCopy *>*) carbonCopies
readwritenonatomiccopy

A complex type containing information about recipients who should receive a copy of the envelope, but does not need to sign it. [optional].

See also
DSMCarbonCopy.h

◆ certifiedDeliveries

- (NSArray<DSMCertifiedDelivery *>*) certifiedDeliveries
readwritenonatomiccopy

A complex type containing information on a recipient the must receive the completed documents for the envelope to be completed, but the recipient does not need to sign, initial, date, or add information to any of the documents. [optional].

See also
DSMCertifiedDelivery.h

◆ currentRoutingOrder

- (NSNumber*) currentRoutingOrder
readwritenonatomiccopy

Current routing order (recipient routing who is current signer)

◆ editors

- (NSArray<DSMEditor *>*) editors
readwritenonatomiccopy

A complex type defining the management and access rights of a recipient assigned assigned as an editor on the document. [optional].

See also
DSMEditor.h

◆ inPersonSigners

- (NSArray<DSMInPersonSigner *>*) inPersonSigners
readwritenonatomiccopy

Specifies a signer that is in the same physical location as a DocuSign user who will act as a Signing Host for the transaction. The recipient added is the Signing Host and new separate Signer Name field appears after Sign in person is selected. [optional].

See also
DSMInPersonSigner.h

◆ intermediaries

- (NSArray<DSMIntermediary *>*) intermediaries
readwritenonatomiccopy

Identifies a recipient that can, but is not required to, add name and email information for recipients at the same or subsequent level in the routing order (until subsequent Agents, Editors or Intermediaries recipient types are added). [optional].

See also
DSMIntermediary.h

◆ recipientCount

- (NSNumber*) recipientCount
readwritenonatomiccopy

recipients count

◆ signers

- (NSArray<DSMSigner *>*) signers
readwritenonatomiccopy

A complex type containing information about the Signer recipient. [optional].

See also
DSMSigner.h

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