DSMEnvelopesManager Class Reference

#import <DSMEnvelopesManager.h>

Inheritance diagram for DSMEnvelopesManager:
<DSMEnvelopesManagerOffineSigningSwitchRecipient>

Instance Methods

(void) - syncEnvelopes
 
(void) - removeCachedEnvelopeWithId:
 
(NSArray *) - cachedEnvelopes
 
(NSArray< NSString * > *) - cachedEnvelopeIds
 
(void) - removeCachedEnvelopes
 
(void) - presentComposeEnvelopeControllerWithPresentingController:signingMode:resumeWithDraft:animated:completion:
 
(BOOL) - hasCachedDraftEnvelope
 
- Instance Methods inherited from <DSMEnvelopesManagerOffineSigningSwitchRecipient>
(void) - presentEditRecipientsControllerForEnvelopeWithId:animated:completion:
 

Properties

id< DSMEnvelopesManagerOfflineSigningDelegateofflineSigningDelegate
 

Detailed Description

It aggregates all envelope cache & sync functionality used with offline signing envelopes generated via templates.

See also
DSMTemplatesManager

Method Documentation

◆ cachedEnvelopeIds()

- (NSArray <NSString *> *) cachedEnvelopeIds

Retrive envelopeIds for all cached envelopes. Compared to cachedEnvelopes, this has only envelopeId in the array.

Returns
NSArray <NSString *> array containing strings representing unique envelopeId(s)

◆ cachedEnvelopes()

- (NSArray *) cachedEnvelopes

Retrive all cached envelopes. Envelopes can be filtered with "envelopeId". Many notifications, such as DSMEnvelopeCachedNotification, include "envelopeId" in the userInfo. Data validation or extraction for an offline completed envelope should be done before invoking the sync. Once an envelope is successfully synced, it's deleted from the cache on the device.

Returns
NSArray <DSMEnvelopeDefinition *>, array containing entire envelope definition(s)
See also
DSMEnvelopeDefinition DSMNotificationCodes DSMTemplatesManager

◆ hasCachedDraftEnvelope()

- (BOOL) hasCachedDraftEnvelope

Returns whether there is a current cached envelope in draft status. Once an envelope is successfully synced, it's deleted from the cache on the device. This can be used to determine whether presenting compose envelope flow should be resumed with the draft envelope. There can only be one draft cached envelope at a given time.

Returns
BOOL, true if there is a cached draft envelope

◆ presentComposeEnvelopeControllerWithPresentingController:signingMode:resumeWithDraft:animated:completion:()

- (void) presentComposeEnvelopeControllerWithPresentingController: (UIViewController *)  presentingController
signingMode: (DSMSigningMode)  signingMode
resumeWithDraft: (BOOL)  resumeWithDraft
animated: (BOOL)  animated
completion: (void(^)(UIViewController *viewController))  completion 

Start creating an envelope to manually add documents, recipients and tags. Client app is responsible for detecting network to present view controller.

Parameters
presentingControllercontroller will be presented on top of the given presentingController passed.
signingModecompose envelope in either online or offline mode, see DSMSigningMode
resumeWithDraftdetermines whether to initialize flow with a previously saved draft (if any)
animatedif the presentation of sign and send be animated or not.
completioncompletion block to be executed after compose envelope controller is presented
Warning
passing nil to a presentationController will not be able to load the offline envelope flow. Relevant Notifications that can be used to track the progress of an envelope sync task: DSMEnvelopeOnlineSendFailedNotification.
See also
DSMNotificationCodes

◆ removeCachedEnvelopes()

- (void) removeCachedEnvelopes

Remove all cached envelopes.

◆ removeCachedEnvelopeWithId:()

- (void) removeCachedEnvelopeWithId: (NSString *)  envelopeId

Remove a cached envelope.

Parameters
envelopeIdAn Id of the envelope to be removed.

◆ syncEnvelopes()

- (void) syncEnvelopes

Sync the pending envelopes on the device to create remote envelopes. An envelope can be in pending Sync state when a) created envelope's local InPersonSigner(s) or self-Signer have finished signing, and either has no pending local InPersonSigner(s) or only has pending remote signer(s) in next signing order. b) created envelope only has pending remote signer(s) in next signing order. When device is online and there has been sign and send Offline and pending sync to server. Data validation or extraction for an offline completed envelope should be done before invoking the sync. Once an envelope is successfully synced, it's deleted from the cache on the device. Relevant Notifications that can be used to track the progress of an envelope sync task: DSMEnvelopeSyncingStartedNotification, DSMEnvelopeSyncingSucceededNotification, DSMEnvelopeSyncingEndedNotification, DSMEnvelopeSyncingFailedNotification.

See also
DSMNotificationCodes

Property Documentation

◆ offlineSigningDelegate

- (id<DSMEnvelopesManagerOfflineSigningDelegate>) offlineSigningDelegate
readwritenonatomicweak

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