Hide navigation sidebar
Hide table of contents sidebar
Skip to content
Back to top
Toggle table of contents sidebar

# DocumentAuthenticator Class

Namespace: id3.Document

## Definition

Verifies the authenticity of a document using security features such as holograms.
Python

    class DocumentAuthenticator

Dart

    class DocumentAuthenticator implements Finalizable

C#

    public partial class DocumentAuthenticator

Java

    public class DocumentAuthenticator implements AutoCloseable, Serializable

Swift

    public class DocumentAuthenticator

C

    typedef struct id3DocumentAuthenticator *ID3_DOCUMENT_AUTHENTICATOR;

## Usage

Python

    documentAuthenticatorInstance = DocumentAuthenticator()
    # ...

Explicit destruction

    # ...
    del documentAuthenticatorInstance

Dart

    final documentAuthenticatorInstance = sdk.DocumentAuthenticator();
    // ...

Explicit destruction

    // ...
    documentAuthenticatorInstance.dispose()

C#

    using (var documentAuthenticatorInstance = new DocumentAuthenticator())
    {
       // ...
    }

Explicit destruction

    var documentAuthenticatorInstance = new DocumentAuthenticator()
    // ...
    documentAuthenticatorInstance.Dispose()

Java

    try (DocumentAuthenticator documentAuthenticatorInstance = new DocumentAuthenticator()) {
    // ...
    }

Explicit destruction

    DocumentAuthenticator documentAuthenticatorInstance = new DocumentAuthenticator();
    // ...
    documentAuthenticatorInstance.close();

Swift

    private var documentAuthenticatorInstance: DocumentAuthenticator? = nil
    documentAuthenticatorInstance = try DocumentAuthenticator()

C

    ID3_DOCUMENT_AUTHENTICATOR hDocumentAuthenticator{};
    int err = id3DocumentAuthenticator_Initialize(&hDocumentAuthenticator);
    if (err == ID3_SUCCESS) {
        // ...
        id3DocumentAuthenticator_Dispose(&hDocumentAuthenticator);
    }

## Properties

Name | Type | Description
--- | --- | ---
documentName | string | Document type to authenticate.
temporalWindowSize | int | Size of the FIFO frame buffer, used for processing.

## Methods

Name | Description
--- | ---
appendFrame | Appends a frame in the FIFO buffer.
authenticateHolograms | Authenticates the holograms on the current frame buffer.
isFull | Checks if the frame buffer is full and ready to authenticate for all holograms.