Electronic Signature Storage Database Example

1
/*
2
 *   Copyright © 2021-2026 PSPDFKit GmbH. All rights reserved.
3
 *
4
 *   The PSPDFKit Sample applications are licensed with a modified BSD license.
5
 *   Please see License for details. This notice may not be removed from this file.
6
 */
7

8
package com.pspdfkit.catalog.examples.kotlin
9

10
import android.content.Context
11
import android.graphics.Color
12
import android.net.Uri
13
import android.os.Bundle
14
import com.pspdfkit.catalog.R
15
import com.pspdfkit.catalog.SdkExample
16
import com.pspdfkit.catalog.tasks.ExtractAssetTask
17
import com.pspdfkit.configuration.activity.PdfActivityConfiguration
18
import com.pspdfkit.configuration.signatures.SignatureColorOptions
19
import com.pspdfkit.configuration.signatures.SignatureSavingStrategy
20
import com.pspdfkit.signatures.storage.DatabaseSignatureStorage
21
import com.pspdfkit.ui.PdfActivity
22
import com.pspdfkit.ui.PdfActivityIntentBuilder
23

24
/**
25
 * Showcases how to initialize a signature storage database that can be used for storing electronic signatures.
26
 */
27
class SignatureStorageDatabaseExample(context: Context) :
28
    SdkExample(
29
        context,
30
        R.string.signatureStorageDatabaseExampleTitle,
31
        R.string.signatureStorageDatabaseExampleDescription
32
    ) {
33
    override fun launchExample(context: Context, configuration: PdfActivityConfiguration.Builder) {
34
        // When setting [SignatureSavingStrategy.SAVE_IF_SELECTED], the signature saving
35
        // dialog will show an option that allows users to store the signature into the database provided that
36
        // a SignatureStorage database has been set (see ¦SignatureStorageDatabaseActivity`).
37
        configuration.signatureSavingStrategy(SignatureSavingStrategy.SAVE_IF_SELECTED)
38
        // Extract the document to the Catalog's private files, so that examples can freely modify the file.
39
        ExtractAssetTask.extract(WELCOME_DOC, title, context) { documentFile ->
40
            // Create an intent for showing the SignatureStorageDatabaseActivity.
41
            val intent = PdfActivityIntentBuilder.fromUri(context, Uri.fromFile(documentFile))
42
                // Signature form field on page index 16.
43
                .configuration(
44
                    configuration
45
                        .page(16)
46
                        // An example of changing the default signing colors is here as well.
47
                        .signatureColorOptions(SignatureColorOptions.fromColorInt(Color.BLACK, Color.GRAY, Color.RED))
48
                        .build()
49
                )
50
                .activityClass(SignatureStorageDatabaseActivity::class)
51
                .build()
52

53
            // Start the SignatureStorageDatabaseActivity showing the demo document.
54
            context.startActivity(intent)
55
        }
56
    }
57
}
58

59
/**
60
 * Shows how to initialize a signature storage database in custom [PdfActivity].
61
 */
62
class SignatureStorageDatabaseActivity : PdfActivity() {
63

64
    override fun onCreate(savedInstanceState: Bundle?) {
65
        super.onCreate(savedInstanceState)
66

67
        // Initialize a signature storage database that uses SQLite to store signatures.
68
        requirePdfFragment().signatureStorage = DatabaseSignatureStorage.withName(
69
            this,
70
            // You can use any name for your database signature storage. Here, the default one
71
            // suggested by Nutrient. For example, if your app supports multiple users, you can
72
            // have a separate database signature storage for every user.
73
            DatabaseSignatureStorage.SIGNATURE_DB_NAME
74
        )
75
    }
76
}