<DSMEnvelopeHelperProtocol > Protocol Reference

#import <DSMEnvelopeHelperProtocol.h>

Inheritance diagram for <DSMEnvelopeHelperProtocol >:

Instance Methods

(NSOrderedSet *) - allDocuments
 
(NSOrderedSet *) - allSigners
 
(NSOrderedSet *) - incompleteLocalSigners
 
(DSMRecipient *) - recipientWithId:
 
(NSOrderedSet *) - recipientsOfType:
 
(BOOL) - isRemoteEnvelopeSignedByAtLeastOneSignerInCurrentSession
 
(NSOrderedSet *) - allOfflineRecipientsInCurrentRoutingOrder
 
(DSMRecipients *) - unsignedRecipients
 
(BOOL) - isLocallyOriginatedEnvelope
 
(BOOL) - isAvailableRemotely
 
(BOOL) - isCreatedFromTemplate
 
(NSSet *) - allTags
 
(NSSet *) - tagsForDocument:
 
(NSSet *) - tagsForSigner:
 
(BOOL) - isSelfSign
 
(void) - setSubjectIfNeeded
 
(DSMRadioGroup *) - radioGroupWith:forRecipient:
 

Properties

NSInteger currentRoutingOrder
 Maintains the currentRouting Order (Currently signing recipient routing order) for a envelope being signed. More...
 

Method Documentation

◆ allDocuments()

- (NSOrderedSet * DSMEnvelopeHelperProtocol) allDocuments

Gives list of docuemnts for a Template.

Returns
NSOrderedSet ( NSArray<DSMDocument *> *documents;)
See also
DSMDocument.h

◆ allOfflineRecipientsInCurrentRoutingOrder()

- (NSOrderedSet * DSMEnvelopeHelperProtocol) allOfflineRecipientsInCurrentRoutingOrder

◆ allSigners()

- (NSOrderedSet * DSMEnvelopeHelperProtocol) allSigners

Gives list of InPerson and Remote Signers.

Returns
NSOrderedSet
See also
DSMSigner.h and DSMInPersonSigner.h

◆ allTags()

- (NSSet * DSMEnvelopeHelperProtocol) allTags

◆ incompleteLocalSigners()

- (NSOrderedSet * DSMEnvelopeHelperProtocol) incompleteLocalSigners

Gives list of inclomplete local signers.

Returns
NSOrderedSet
See also
DSMSigner.h and DSMInPersonSigner.h

◆ isAvailableRemotely()

- (BOOL DSMEnvelopeHelperProtocol) isAvailableRemotely

◆ isCreatedFromTemplate()

- (BOOL DSMEnvelopeHelperProtocol) isCreatedFromTemplate

◆ isLocallyOriginatedEnvelope()

- (BOOL DSMEnvelopeHelperProtocol) isLocallyOriginatedEnvelope

◆ isRemoteEnvelopeSignedByAtLeastOneSignerInCurrentSession()

- (BOOL DSMEnvelopeHelperProtocol) isRemoteEnvelopeSignedByAtLeastOneSignerInCurrentSession

If envelope is signed by atleast one remote signer/inperson signer in current session.

Returns
BOOL

◆ isSelfSign()

- (BOOL DSMEnvelopeHelperProtocol) isSelfSign

◆ radioGroupWith:forRecipient:()

- (DSMRadioGroup * DSMEnvelopeHelperProtocol) radioGroupWith: (DSMRadio *)  radioTab
forRecipient: (DSMRecipient *_Nullable)  signer 

◆ recipientsOfType:()

- (NSOrderedSet * DSMEnvelopeHelperProtocol) recipientsOfType: (DSMRecipientType)  recipientType

Gives recipients list of given DSMRecipientType.

Returns
NSOrderedSet
See also
DSMRecipientType.h

◆ recipientWithId:()

- (DSMRecipient * DSMEnvelopeHelperProtocol) recipientWithId: (NSString *)  recipientID

Gives recipient details for a given recipeitnId.

Returns
DSMRecipient
See also
DSMRecipient.h

◆ setSubjectIfNeeded()

- (void DSMEnvelopeHelperProtocol) setSubjectIfNeeded

◆ tagsForDocument:()

- (NSSet * DSMEnvelopeHelperProtocol) tagsForDocument: (DSMDocument *_Nullable)  document

◆ tagsForSigner:()

- (NSSet * DSMEnvelopeHelperProtocol) tagsForSigner: (DSMRecipient *_Nullable)  signer

◆ unsignedRecipients()

- (DSMRecipients * DSMEnvelopeHelperProtocol) unsignedRecipients

Property Documentation

◆ currentRoutingOrder

- (NSInteger DSMEnvelopeHelperProtocol) currentRoutingOrder
readwriterequirednonatomicassign

Maintains the currentRouting Order (Currently signing recipient routing order) for a envelope being signed.

See also
DSMEnvelopeTemplate.h

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