Annotations
===========

.. _AnnotationsType:

AnnotationsType
---------------

Type of PDF Annotations.

Currently supported/used types are:

   - Private (for own use only)
  
   - Public - visible and editable by anyone with write-right
  
   - Redact - visible/editable by anyone with redact-right

.. code-block:: json
 
 enum AnnotationsType {
  ANNOTATIONS_TYPE_UNSPECIFIED = 0;
  ANNOTATIONS_TYPE_PRIVATE = 1;
  ANNOTATIONS_TYPE_GROUP = 2;
  ANNOTATIONS_TYPE_PUBLIC = 3;
  ANNOTATIONS_TYPE_REDACT = 4;

.. list-table::
   :widths: 20 15 65
   :header-rows: 1

   * - Value
     - Tag
     - Description
   * - ``ANNOTATIONS_TYPE_UNSPECIFIED``
     - ``0``
     - Default.
   * - ``ANNOTATIONS_TYPE_PRIVATE``
     - ``1``
     - Are used when only the current user can see their own private annotations. Can be made on **original pdfs** or on **pdfs generated from docs**.
   * - ``ANNOTATIONS_TYPE_GROUP``
     - ``2``
     -
   * - ``ANNOTATIONS_TYPE_PUBLIC``
     - ``3``
     - Are used when annotations are shared between all users with the correct rights to the specific dataroom. Can be made on **original pdfs** or on **pdfs generated from docs**.
   * - ``ANNOTATIONS_TYPE_REDACT``
     - ``4``
     - Are used to select text or an area of a document for redaction. Area redactions are used for images.