.. index:: 
  !DocumentLicense Class

.. _id3_document_document_license_class:

===============================================================================
DocumentLicense Class
===============================================================================

Namespace: :ref:`id3.Document<reference_document>`

.. toctree::
  :hidden:

  activate<activate>
  activateActivationKey<activate_activation_key>
  activateActivationKeyBuffer<activate_activation_key_buffer>
  activateBuffer<activate_buffer>
  activateSerialKey<activate_serial_key>
  activateSerialKeyBuffer<activate_serial_key_buffer>
  checkLicense<check_license>
  checkLicenseBuffer<check_license_buffer>
  checkLicenseBufferWithCard<check_license_buffer_with_card>
  checkLicenseWithCard<check_license_with_card>
  checkModule<check_module>
  finalizeCheckLicenseWithCard<finalize_check_license_with_card>
  getExpiryDate<get_expiry_date>
  getExternalDriveHardwareCode<get_external_drive_hardware_code>
  getHostHardwareCode<get_host_hardware_code>
  getLicenseFileHardwareCode<get_license_file_hardware_code>
  getLicenseFileSerial<get_license_file_serial>
  getLicenseName<get_license_name>
  getLicenseOwner<get_license_owner>
  getLicensePath<get_license_path>
  getLicenseType<get_license_type>
  getModuleCount<get_module_count>
  getModuleName<get_module_name>
  getModuleValue<get_module_value>
  getProductReference<get_product_reference>
  getRemainingDays<get_remaining_days>
  reactivate<reactivate>
  reactivateBuffer<reactivate_buffer>


Definition
----------
.. line-block::
    Manages the license for this SDK.

.. tab-set::

    .. tab-item:: Python
      :sync: Python

      .. code:: Python

        class DocumentLicense

    .. tab-item:: Dart
      :sync: Dart

      .. code:: Dart

        class DocumentLicense

    .. tab-item:: C#
      :sync: C#

      .. code:: C#

        public static partial class DocumentLicense

    .. tab-item:: Java
      :sync: Java

      .. code:: Java

        public class DocumentLicense

    .. tab-item:: Swift
      :sync: Swift

      .. code:: Swift

        public class DocumentLicense


Static Methods
--------------

.. list-table:: 
  :width: 100%
  :widths: 30 70
  :header-rows: 1

  * - Name
    - Description
  * - :ref:`activate<id3_document_document_license_activate_class_method>`
    - Activates a license using customer credentials and a product reference and saves the license to a file.
  * - :ref:`activateActivationKey<id3_document_document_license_activate_activation_key_class_method>`
    - Activates a license file using an activation key and saves the license to a file.
  * - :ref:`activateActivationKeyBuffer<id3_document_document_license_activate_activation_key_buffer_class_method>`
    - Activates a license using an activation key and returns the license in a data buffer.
  * - :ref:`activateBuffer<id3_document_document_license_activate_buffer_class_method>`
    - Retrieves a license file buffer using customer credentials and a product reference and returns the license in a data buffer.
  * - :ref:`activateSerialKey<id3_document_document_license_activate_serial_key_class_method>`
    - Activates a license using a serial key and saves the license to a file.
  * - :ref:`activateSerialKeyBuffer<id3_document_document_license_activate_serial_key_buffer_class_method>`
    - Activates a license using a serial key and returns the license in a data buffer.
  * - :ref:`checkLicense<id3_document_document_license_check_license_class_method>`
    - Checks a license from a file.
  * - :ref:`checkLicenseBuffer<id3_document_document_license_check_license_buffer_class_method>`
    - Checks a license from a buffer.
  * - :ref:`checkLicenseBufferWithCard<id3_document_document_license_check_license_buffer_with_card_class_method>`
    - Checks the license using a buffer containing the license data and a card-based verification process.
  * - :ref:`checkLicenseWithCard<id3_document_document_license_check_license_with_card_class_method>`
    - Checks the license by using a card-based verification process.
  * - :ref:`checkModule<id3_document_document_license_check_module_class_method>`
    - Checks if a module is present in the previously loaded license.
  * - :ref:`finalizeCheckLicenseWithCard<id3_document_document_license_finalize_check_license_with_card_class_method>`
    - Finalizes the license check process using the provided cryptogram.
  * - :ref:`getExpiryDate<id3_document_document_license_get_expiry_date_class_method>`
    - Retrieves the license expiry date.
  * - :ref:`getExternalDriveHardwareCode<id3_document_document_license_get_external_drive_hardware_code_class_method>`
    - Retrieves the hardware code of the external drive you run the library on. This function works on Windows only.
  * - :ref:`getHostHardwareCode<id3_document_document_license_get_host_hardware_code_class_method>`
    - Retrieves the hardware code of the device using the requested hardware code type.
  * - :ref:`getLicenseFileHardwareCode<id3_document_document_license_get_license_file_hardware_code_class_method>`
    - Retrieves the hardware code of the previously loaded license.
  * - :ref:`getLicenseFileSerial<id3_document_document_license_get_license_file_serial_class_method>`
    - Retrieves the serial number of the previously loaded license.
  * - :ref:`getLicenseName<id3_document_document_license_get_license_name_class_method>`
    - Retrieves the license name.
  * - :ref:`getLicenseOwner<id3_document_document_license_get_license_owner_class_method>`
    - Retrieves the license owner.
  * - :ref:`getLicensePath<id3_document_document_license_get_license_path_class_method>`
    - Retrieves the license path.
  * - :ref:`getLicenseType<id3_document_document_license_get_license_type_class_method>`
    - Retrieves the license type.
  * - :ref:`getModuleCount<id3_document_document_license_get_module_count_class_method>`
    - Retrieves the number of modules in the license.
  * - :ref:`getModuleName<id3_document_document_license_get_module_name_class_method>`
    - Retrieves the name of the specified license module.
  * - :ref:`getModuleValue<id3_document_document_license_get_module_value_class_method>`
    - Retrieves the value associated to the specified license module.
  * - :ref:`getProductReference<id3_document_document_license_get_product_reference_class_method>`
    - Retrieves the license product reference.
  * - :ref:`getRemainingDays<id3_document_document_license_get_remaining_days_class_method>`
    - Retrieves the number of remaining days.
  * - :ref:`reactivate<id3_document_document_license_reactivate_class_method>`
    - Reactivates a license file using the host hardware code and the product reference.
  * - :ref:`reactivateBuffer<id3_document_document_license_reactivate_buffer_class_method>`
    - Reactivates a license in a data buffer using the host hardware code and the product reference.
