sdk/com.docusign.androidsdk.delegates/DSEnvelopeDelegate

DSEnvelopeDelegate

class DSEnvelopeDelegate : DSBaseDelegate, IDisposableHandler

Types

Companion

object Companion

Functions

addDisposableToCompositeDisposable

open override fun addDisposableToCompositeDisposable(disposable: Disposable)

cacheEnvelope

fun cacheEnvelope(envelope: DSEnvelope, cacheEnvelopeListener: CacheEnvelopeListener)

Given a envelope, cache it to the DB for using it with offline signing

fun cacheEnvelope(envelopeId: String, cacheEnvelopeListener: DSCacheEnvelopeListener)

Cache the envelope given the envelope ID. This will return the envelope if it is already cached. If not, fetches the latest copy of the envelope along with the documents from the Docusign API

clearAllDisposables

open override fun clearAllDisposables()

composeAndSendEnvelope

fun composeAndSendEnvelope(envelope: DSEnvelope, listener: DSComposeAndSendEnvelopeListener)

Composes a new envelope with the data provided through DSEnvelope instance.

deleteCachedEnvelope

fun deleteCachedEnvelope(envelopeId: String, listener: DSDeleteCachedEnvelopeListener)

Deletes the cached envelope for the given envelopeId

downloadCompletedEnvelopeDocument

fun downloadCompletedEnvelopeDocument(envelopeId: String, listener: DSDownloadCompletedEnvelopeListener)

Retrieves the completed envelope's combined document uri path

getCachedEnvelope

fun getCachedEnvelope(envelopeId: String, includeDocuments: Boolean = false, cachedEnvelopeListener: DSGetCachedEnvelopeListener)

Retrieves cached envelope

getCachedEnvelopeList

fun getCachedEnvelopeList(listFilter: DSListFilter, syncStatusList: List<SyncStatus>, listener: DSGetEnvelopeListListener)

Retrieves All cached envelope

getEnvelope

fun getEnvelope(serverEnvelopeId: String, envelopeListener: DSGetEnvelopeListener)

Retrieves the envelope from Docusign server and returns DSEnvelope on success

getSyncPendingEnvelopeIdsList

fun getSyncPendingEnvelopeIdsList(listener: DSGetEnvelopeIdsListener)

Retrieves the list of all SYNC PENDING, SYNC FAILED and SYNC IN_PROGRESS envelope Id's

removeDisposableFromCompositeDisposable

open override fun removeDisposableFromCompositeDisposable(disposable: Disposable): Boolean

syncAll

fun syncAll(envelopeIdList: List<String>, listener: DSSyncAllEnvelopesListener, deleteCachedEnvelope: Boolean = true)

Syncs all envelopes in the envelopeList in batches of 5 - defined in ENVELOPES_TO_SYNC_IN_BATCH.

syncAllEnvelopes

fun syncAllEnvelopes(listener: DSSyncAllEnvelopesListener, deleteCachedEnvelope: Boolean = true)

Syncs all the cached envelopes in batches of 5

syncEnvelope

fun syncEnvelope(envelopeId: String, listener: DSSyncEnvelopeListener, deleteCachedEnvelope: Boolean = true)

Syncs the cached envelope for the given envelopeId