sdk/com.docusign.androidsdk.delegates/DSTemplateDelegate

DSTemplateDelegate

class DSTemplateDelegate : DSBaseDelegate, IDisposableHandler
Content copied to clipboard

This class handles template tasks

Constructors

Link copied to clipboard
fun DSTemplateDelegate()
Content copied to clipboard

Types

Link copied to clipboard
object Companion
Content copied to clipboard

Functions

Link copied to clipboard
open override fun addDisposableToCompositeDisposable(disposable: Disposable)
Content copied to clipboard
Link copied to clipboard
fun cacheTemplate(templateId: String, cacheTemplateListener: DSCacheTemplateListener)
Content copied to clipboard

Caches the template which includes downloading the template and documents which will then be available for offline signing.

Link copied to clipboard
open override fun clearAllDisposables()
Content copied to clipboard
Link copied to clipboard
fun getDownloadedTemplatesFullDefinition(listFilter: DSListFilter, templateListListener: DSTemplateDefinitionListListener)
Content copied to clipboard

Fetches the downloaded templates from the Database

Link copied to clipboard
fun getOfflineUseTemplateListener(): DSOfflineUseTemplateListener?
Content copied to clipboard

This method returns an instance of the DSOfflineUseTemplateListener

Link copied to clipboard
fun getOfflineUseTemplateWithPhotoListener(): DSOfflineUseTemplateWithPhotoListener?
Content copied to clipboard

This method returns an instance of the DSOfflineUseTemplateWithPhotoListener

Link copied to clipboard
fun getOnlineUseTemplateListener(): DSOnlineUseTemplateListener?
Content copied to clipboard

This method returns an instance of the DSOnlineUseTemplateListener

Link copied to clipboard
fun getTemplate(templateId: String, filter: DSTemplateFilter?, templateListener: DSTemplateListener)
Content copied to clipboard

Fetches the template

Link copied to clipboard
fun getTemplates(filter: DSTemplatesFilter, templateListListener: DSTemplateListListener)
Content copied to clipboard

Fetches templates of the logged in user

Link copied to clipboard
fun removeCachedTemplate(template: DSTemplateDefinition, removeListener: DSRemoveTemplateListener)
Content copied to clipboard

Deletes the cached template from the local database. Since the operation needs to happen asynchronously the success/failure is returned in the DSRemoveTemplateListener callback

Link copied to clipboard
open override fun removeDisposableFromCompositeDisposable(disposable: Disposable): Boolean
Content copied to clipboard
Link copied to clipboard
fun retrieveCachedTemplate(templateId: String, cachedTemplateListener: DSGetCachedTemplateListener)
Content copied to clipboard

Retrieves the cached template given the template id. Since the operation needs to happen asynchronously the success/failure is returned in the DSGetCachedTemplateListener callback

Link copied to clipboard
fun retrieveDownloadedTemplates(templateListListener: DSTemplateListListener)
Content copied to clipboard

Fetches the downloaded templates from the Database

Link copied to clipboard
fun setOfflineUseTemplateListener(listener: DSOfflineUseTemplateListener?)
Content copied to clipboard
Link copied to clipboard
Link copied to clipboard
fun setOnlineUseTemplateListener(listener: DSOnlineUseTemplateListener?)
Content copied to clipboard
Link copied to clipboard
fun updateCachedTemplate(templateId: String, updateCachedTemplateListener: DSUpdateCachedTemplateListener)
Content copied to clipboard

Fetches the template from API and compares the lastModified Date with that of the cached Template. If it's not the same, remove the cached template and get the latest one from server

Link copied to clipboard
fun useTemplateOffline(context: Context, templateId: String, envelopeDefaults: DSEnvelopeDefaults?, offlineUseTemplateListener: DSOfflineUseTemplateListener)
Content copied to clipboard

Send an Envelope derived from a Template in Offline mode

fun useTemplateOffline(context: Context, templateId: String, envelopeDefaults: DSEnvelopeDefaults?, pdfToAddUri: URI?, insertPdfAtPosition: DSDocumentInsertAtPosition?, offlineUseTemplateListener: DSOfflineUseTemplateListener)
Content copied to clipboard

Creates an Envelope derived from a Template in Offline mode. Use this API when the SignWithPhoto Capture implementation is NOT handled by the client.

Link copied to clipboard
fun useTemplateOfflineWithPhoto(context: Context, templateId: String, envelopeDefaults: DSEnvelopeDefaults?, offlineUseTemplateWithPhotoListener: DSOfflineUseTemplateWithPhotoListener)
Content copied to clipboard

Send an Envelope derived from a Template in Offline mode

fun useTemplateOfflineWithPhoto(context: Context, templateId: String, envelopeDefaults: DSEnvelopeDefaults?, pdfToAddUri: URI?, insertPdfAtPosition: DSDocumentInsertAtPosition?, offlineUseTemplateWithPhotoListener: DSOfflineUseTemplateWithPhotoListener)
Content copied to clipboard

Creates an Envelope derived from a Template in Offline mode. Use this API when the SignWithPhoto Capture implementation is handled by the client

Link copied to clipboard
fun useTemplateOnline(context: Context, templateId: String, envelopeDefaults: DSEnvelopeDefaults?, onlineUseTemplateListener: DSOnlineUseTemplateListener)
Content copied to clipboard

Send an Envelope derived from a Template in Online mode