DSMNotificationCodes.h File Reference

Go to the source code of this file.

Variables

NSString *const DSMSigningCompletedNotification
 Notification sent when signing is completed in online or offline mode. Returned userInfo contains signingMode associated with DSMSigningModeKey and templateId associated with DSMTemplateIdkey. Returned userInfo also contains envelopeId associated with DSMEnvelopeIdKey only when online signing; during offline signing, envelopeId for signed envelope is sent with DSMEnvelopeCachedNotification. This can be posted on a thread other than MainThread. [[NSNotificationCenter defaultCenter] postNotificationName:DSMSigningCompletedNotification object:viewController userInfo:userInfo];. More...
 
NSString *const DSMSigningCancelledNotification
 Notification sent when signing is cancelled. Returned userInfo has envelopeId associated with DSMEnvelopeIdKey. This can be posted on a thread other than MainThread. [[NSNotificationCenter defaultCenter] postNotificationName:DSMSigningCancelledNotification object:viewController userInfo:userInfo];. More...
 
NSString *const DSMEnvelopeOnlineSendFailedNotification
 Notification sent when composing online envelope fails. Returned userInfo has envelopeId associated with DSMEnvelopeIdKey. This can be posted on a thread other than MainThread. [[NSNotificationCenter defaultCenter] postNotificationName:DSMEnvelopeOnlineSendFailedNotification object:nil userInfo:userInfo];. More...
 
NSString *const DSMEnvelopeCachedNotification
 Notification sent when caching is enabled for a given record (envelope). Returned userInfo contains envelopeId associated with DSMEnvelopeIdKey, templateId associated with DSMTemplateIdKey. This can be posted on a thread other than MainThread. [[NSNotificationCenter defaultCenter] postNotificationName:DSMEnvelopeCachedNotification object:nil userInfo:userInfo]; Note: Enabling setup configuration DSM_SETUP_ENABLE_OFFLINE_SIGNING_SAVE_ENVELOPE_PROGRESS_KEY would result in this notification being sent every time a local offline envelope is saved after local signer finishes signing. More...
 
NSString *const DSMEnvelopeUncachedNotification
 Notification sent when caching is disabled for a given record (envelope). Returned userInfo has envelopeId associated with DSMEnvelopeIdKey key. This can be posted on a thread other than MainThread. [[NSNotificationCenter defaultCenter] postNotificationName:DSMEnvelopeUncachedNotification object:nil userInfo:userInfo];. More...
 
NSString *const DSMEnvelopeCacheFailedNotification
 Notification sent when attempt to cache an envelope fails. Returned userInfo has envelopeId associated with DSMEnvelopeIdKey key and error object associated with DSMErrorKey key. This can be posted on a thread other than MainThread. [[NSNotificationCenter defaultCenter] postNotificationName:DSMEnvelopeCacheFailedNotification object:nil userInfo:userInfo];. More...
 
NSString *const DSMEnvelopeSyncingEndedNotification
 Notification sent when process to start syncing cached-envelopes with docusign server either finishes normally or is terminated preemptively. Returns userInfo as nil. This can be posted on a thread other than MainThread. [[NSNotificationCenter defaultCenter] postNotificationName:DSMEnvelopeSyncingEndedNotification object:nil];. More...
 
NSString *const DSMEnvelopeSyncingStartedNotification
 Notification sent when process to start syncing cached-envelopes with docusign server begins. Returns userInfo with envelopes pending sync details. This can be posted on a thread other than MainThread. Each of the entries contains the dictionary of {DSMEnvelopeIdKey: envelopeId, DSMTemplateIdKey: templateId, DSMTransactionIdKey: transactionId} representing an envelope instance. [[NSNotificationCenter defaultCenter] postNotificationName:DSMEnvelopeSyncingStartedNotification object:nil];. More...
 
NSString *const DSMEnvelopeSyncingFailedNotification
 Notification sent when process to start syncing cached-envelopes with docusign server fails because of some error. Returned userInfo has envelopeId (cache uri) associated with DSMCacheURIKey key. This can be posted on a thread other than MainThread. [[NSNotificationCenter defaultCenter] postNotificationName:DSMEnvelopeSyncingFailedNotification object:nil userInfo:userInfo];. More...
 
NSString *const DSMEnvelopeSyncingSucceededNotification
 Notification sent when process to sync a cached-envelope succeeds with docusign server. Returned userInfo contains: envelopeId associated with DSMEnvelopeIdKey, cache uri associated with DSMCacheURIKey and templateId associated with DSMTemplateIdKey. This can be posted on a thread other than MainThread. [[NSNotificationCenter defaultCenter] postNotificationName:DSMEnvelopeSyncingSucceededNotification object:nil userInfo:userInfo];. More...
 
NSString *const DSMFoundReadonlyAndRequiredTabsWithInvalidDefaultsNotification
 Notification sent when envelope is created from template has invalid tab defaults for readonly & required tabs. Templates may have tabs which are set as Readonly (i.e. locked, signer can't modify the value during signing) AND Required (i.e. tab must have valid value when signing is finished). If Required AND Readonly tab(s) found with nil value in template and no tab-defaults value associated with tab-label(s), DSMFoundReadonlyAndRequiredTabsWithInvalidDefaultsNotification notification will be posted to notify listeners when such template configuration error(s) are detected for envelope-tabs. Optional SDK configuration available: DSM_SETUP_OFFLINE_SIGNING_CONVERT_INVALID_READONLY_REQUIRED_TEXTTABS_TO_EDITABLE. More...
 
NSString *const DSMOfflineEnvelopeSaveErrorNotification
 Notification sent when errors are detected with the offline envelope being persisted to coredata for progress save. Offline envelope is saved after it's created for offline signing and once a local signer finishes signing or a local signer choose to pause signing to be resumed later. Use the envelopeId to uniquely identify the envelope. More...
 
NSString *const DSMOfflineEnvelopeSigningErrorNotification
 Notification sent when errors are detected with the template configuration during offline envelope signing. This notification is sent in addition to other specific notifications such as DSMEnvelopeSyncingFailedNotification, DSMEnvelopeCacheFailedNotification and is meant to cover cases related to configuration errors in the template or signed envelope. It's highly recommended to subscribe, log and handle this notification when DSM_SETUP_OFFLINE_SIGNING_HIDE_ALERTS_KEY is used to supress the UI alerts during offline signing. Notification will be sent irrespective of the optional SDK configuration DSM_SETUP_OFFLINE_SIGNING_HIDE_ALERTS_KEY value being set as true or false. UserInfo contains the error object with details on the cause, for example, a) duplicate recipients found with template recipients data or b) invalid formola tab configuration detected in template during offline envelope signing. Optionally, "AdditionalDetails" key points to details related to specific tab resulting in validation errors during offline signing. More...
 
NSString *const DSMAdditionalAccountDataFetchOrDeleteErrorNotification
 Notification sent when errors are detected with the additional data fetch or deletion for a given account. UserInfo contains the error object with details on the cause, for example, a) key(s): value(s) that failed to fetch or delete with a given error code. Optionally, "AdditionalDetails" key points to details related to severity of the error. More...
 
NSString *const DSMCacheDidAddStatus
 Envelope status represending successful caching; this status is sent with various Notification userInfo. More...
 
NSString *const DSMCacheDidUpdateStatus
 Envelope status represending successful update of the cache status; this status is sent with various Notification userInfo. More...
 
NSString *const DSMCacheDidRemoveStatus
 Envelope status represending successful uncaching of already cached envelope; this status is sent with various Notification userInfo. More...
 
NSString *const DSMCacheDidFailStatus
 Envelope status represending failure during caching; this status is sent with various Notification userInfo. More...
 
NSString *const DSMCacheURIKey
 Notification userInfo key to represent CacheURI (recordId) of an envelope. More...
 
NSString *const DSMEnvelopeIdKey
 Notification userInfo key to represent EnvelopeId (also recordId) of an envelope. More...
 
NSString *const DSMTemplateIdKey
 Notification userInfo key to represent TemplateId of a template. More...
 
NSString *const DSMTransactionIdKey
 Notification userInfo key to represent TransactionId of an envelope. TransactionIds are only used for offline envelopes which are created on the device using a template or pdf documents. More...
 
NSString *const DSMErrorKey
 Notification userInfo key to represent Error of an envelope. More...
 
NSString *const DSMSigningModeKey
 Notification userInfo key to represent envelope signing mode (online vs offline). More...
 

Variable Documentation

◆ DSMAdditionalAccountDataFetchOrDeleteErrorNotification

NSString* const DSMAdditionalAccountDataFetchOrDeleteErrorNotification

Notification sent when errors are detected with the additional data fetch or deletion for a given account. UserInfo contains the error object with details on the cause, for example, a) key(s): value(s) that failed to fetch or delete with a given error code. Optionally, "AdditionalDetails" key points to details related to severity of the error.

◆ DSMCacheDidAddStatus

NSString* const DSMCacheDidAddStatus

Envelope status represending successful caching; this status is sent with various Notification userInfo.

◆ DSMCacheDidFailStatus

NSString* const DSMCacheDidFailStatus

Envelope status represending failure during caching; this status is sent with various Notification userInfo.

◆ DSMCacheDidRemoveStatus

NSString* const DSMCacheDidRemoveStatus

Envelope status represending successful uncaching of already cached envelope; this status is sent with various Notification userInfo.

◆ DSMCacheDidUpdateStatus

NSString* const DSMCacheDidUpdateStatus

Envelope status represending successful update of the cache status; this status is sent with various Notification userInfo.

◆ DSMCacheURIKey

NSString* const DSMCacheURIKey

Notification userInfo key to represent CacheURI (recordId) of an envelope.

◆ DSMEnvelopeCachedNotification

NSString* const DSMEnvelopeCachedNotification

Notification sent when caching is enabled for a given record (envelope). Returned userInfo contains envelopeId associated with DSMEnvelopeIdKey, templateId associated with DSMTemplateIdKey. This can be posted on a thread other than MainThread. [[NSNotificationCenter defaultCenter] postNotificationName:DSMEnvelopeCachedNotification object:nil userInfo:userInfo]; Note: Enabling setup configuration DSM_SETUP_ENABLE_OFFLINE_SIGNING_SAVE_ENVELOPE_PROGRESS_KEY would result in this notification being sent every time a local offline envelope is saved after local signer finishes signing.

◆ DSMEnvelopeCacheFailedNotification

NSString* const DSMEnvelopeCacheFailedNotification

Notification sent when attempt to cache an envelope fails. Returned userInfo has envelopeId associated with DSMEnvelopeIdKey key and error object associated with DSMErrorKey key. This can be posted on a thread other than MainThread. [[NSNotificationCenter defaultCenter] postNotificationName:DSMEnvelopeCacheFailedNotification object:nil userInfo:userInfo];.

◆ DSMEnvelopeIdKey

NSString* const DSMEnvelopeIdKey

Notification userInfo key to represent EnvelopeId (also recordId) of an envelope.

◆ DSMEnvelopeOnlineSendFailedNotification

NSString* const DSMEnvelopeOnlineSendFailedNotification

Notification sent when composing online envelope fails. Returned userInfo has envelopeId associated with DSMEnvelopeIdKey. This can be posted on a thread other than MainThread. [[NSNotificationCenter defaultCenter] postNotificationName:DSMEnvelopeOnlineSendFailedNotification object:nil userInfo:userInfo];.

◆ DSMEnvelopeSyncingEndedNotification

NSString* const DSMEnvelopeSyncingEndedNotification

Notification sent when process to start syncing cached-envelopes with docusign server either finishes normally or is terminated preemptively. Returns userInfo as nil. This can be posted on a thread other than MainThread. [[NSNotificationCenter defaultCenter] postNotificationName:DSMEnvelopeSyncingEndedNotification object:nil];.

◆ DSMEnvelopeSyncingFailedNotification

NSString* const DSMEnvelopeSyncingFailedNotification

Notification sent when process to start syncing cached-envelopes with docusign server fails because of some error. Returned userInfo has envelopeId (cache uri) associated with DSMCacheURIKey key. This can be posted on a thread other than MainThread. [[NSNotificationCenter defaultCenter] postNotificationName:DSMEnvelopeSyncingFailedNotification object:nil userInfo:userInfo];.

◆ DSMEnvelopeSyncingStartedNotification

NSString* const DSMEnvelopeSyncingStartedNotification

Notification sent when process to start syncing cached-envelopes with docusign server begins. Returns userInfo with envelopes pending sync details. This can be posted on a thread other than MainThread. Each of the entries contains the dictionary of {DSMEnvelopeIdKey: envelopeId, DSMTemplateIdKey: templateId, DSMTransactionIdKey: transactionId} representing an envelope instance. [[NSNotificationCenter defaultCenter] postNotificationName:DSMEnvelopeSyncingStartedNotification object:nil];.

◆ DSMEnvelopeSyncingSucceededNotification

NSString* const DSMEnvelopeSyncingSucceededNotification

Notification sent when process to sync a cached-envelope succeeds with docusign server. Returned userInfo contains: envelopeId associated with DSMEnvelopeIdKey, cache uri associated with DSMCacheURIKey and templateId associated with DSMTemplateIdKey. This can be posted on a thread other than MainThread. [[NSNotificationCenter defaultCenter] postNotificationName:DSMEnvelopeSyncingSucceededNotification object:nil userInfo:userInfo];.

◆ DSMEnvelopeUncachedNotification

NSString* const DSMEnvelopeUncachedNotification

Notification sent when caching is disabled for a given record (envelope). Returned userInfo has envelopeId associated with DSMEnvelopeIdKey key. This can be posted on a thread other than MainThread. [[NSNotificationCenter defaultCenter] postNotificationName:DSMEnvelopeUncachedNotification object:nil userInfo:userInfo];.

◆ DSMErrorKey

NSString* const DSMErrorKey

Notification userInfo key to represent Error of an envelope.

◆ DSMFoundReadonlyAndRequiredTabsWithInvalidDefaultsNotification

NSString* const DSMFoundReadonlyAndRequiredTabsWithInvalidDefaultsNotification

Notification sent when envelope is created from template has invalid tab defaults for readonly & required tabs. Templates may have tabs which are set as Readonly (i.e. locked, signer can't modify the value during signing) AND Required (i.e. tab must have valid value when signing is finished). If Required AND Readonly tab(s) found with nil value in template and no tab-defaults value associated with tab-label(s), DSMFoundReadonlyAndRequiredTabsWithInvalidDefaultsNotification notification will be posted to notify listeners when such template configuration error(s) are detected for envelope-tabs. Optional SDK configuration available: DSM_SETUP_OFFLINE_SIGNING_CONVERT_INVALID_READONLY_REQUIRED_TEXTTABS_TO_EDITABLE.

See also
DSMSetupConstants.h [[NSNotificationCenter defaultCenter] postNotificationName:DSMFoundReadonlyAndRequiredTabsWithInvalidDefaultsNotification object:nil userInfo:userInfo];

◆ DSMOfflineEnvelopeSaveErrorNotification

NSString* const DSMOfflineEnvelopeSaveErrorNotification

Notification sent when errors are detected with the offline envelope being persisted to coredata for progress save. Offline envelope is saved after it's created for offline signing and once a local signer finishes signing or a local signer choose to pause signing to be resumed later. Use the envelopeId to uniquely identify the envelope.

◆ DSMOfflineEnvelopeSigningErrorNotification

NSString* const DSMOfflineEnvelopeSigningErrorNotification

Notification sent when errors are detected with the template configuration during offline envelope signing. This notification is sent in addition to other specific notifications such as DSMEnvelopeSyncingFailedNotification, DSMEnvelopeCacheFailedNotification and is meant to cover cases related to configuration errors in the template or signed envelope. It's highly recommended to subscribe, log and handle this notification when DSM_SETUP_OFFLINE_SIGNING_HIDE_ALERTS_KEY is used to supress the UI alerts during offline signing. Notification will be sent irrespective of the optional SDK configuration DSM_SETUP_OFFLINE_SIGNING_HIDE_ALERTS_KEY value being set as true or false. UserInfo contains the error object with details on the cause, for example, a) duplicate recipients found with template recipients data or b) invalid formola tab configuration detected in template during offline envelope signing. Optionally, "AdditionalDetails" key points to details related to specific tab resulting in validation errors during offline signing.

See also
DSMSetupConstants.h [[NSNotificationCenter defaultCenter] postNotificationName:DSMOfflineEnvelopeSigningErrorNotification object:nil userInfo:userInfo];

◆ DSMSigningCancelledNotification

NSString* const DSMSigningCancelledNotification

Notification sent when signing is cancelled. Returned userInfo has envelopeId associated with DSMEnvelopeIdKey. This can be posted on a thread other than MainThread. [[NSNotificationCenter defaultCenter] postNotificationName:DSMSigningCancelledNotification object:viewController userInfo:userInfo];.

◆ DSMSigningCompletedNotification

NSString* const DSMSigningCompletedNotification

Notification sent when signing is completed in online or offline mode. Returned userInfo contains signingMode associated with DSMSigningModeKey and templateId associated with DSMTemplateIdkey. Returned userInfo also contains envelopeId associated with DSMEnvelopeIdKey only when online signing; during offline signing, envelopeId for signed envelope is sent with DSMEnvelopeCachedNotification. This can be posted on a thread other than MainThread. [[NSNotificationCenter defaultCenter] postNotificationName:DSMSigningCompletedNotification object:viewController userInfo:userInfo];.

◆ DSMSigningModeKey

NSString* const DSMSigningModeKey

Notification userInfo key to represent envelope signing mode (online vs offline).

See also
DSMSigningMode

◆ DSMTemplateIdKey

NSString* const DSMTemplateIdKey

Notification userInfo key to represent TemplateId of a template.

◆ DSMTransactionIdKey

NSString* const DSMTransactionIdKey

Notification userInfo key to represent TransactionId of an envelope. TransactionIds are only used for offline envelopes which are created on the device using a template or pdf documents.