.. Netfiles API documentation master file, created by
   sphinx-quickstart on Fri Mar  6 11:42:21 2020.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Meeting Topic Minutes
=====================

**Meeting Topic Minutes** defines a *document* that contains agenda item minutes (protocol, log), preferably
as a plain-text formatted text-document. It can only exist under an HW Object of ``documentClass`` ``NF_MeetingTopic``
and there can be only one such document per :doc:`Meeting Topic <meetingtopic>`

Meeting Topic Minutes (HW_Object)
---------------------------------

An Meeting Topic Minutes object is a standard Hyperwave Object of ``documentClass`` ``NF_MeetingTopicMinutes``, and ``type`` of ``document``.

+-----------------------+-----------------------+---------------------------------------------------------------+
| Attribute Name        | Attribute Type        | Comments                                                      |
+=======================+=======================+===============================================================+
| id                    | String                | The globally Unique ID of the object                          |
+-----------------------+-----------------------+---------------------------------------------------------------+
| documentClass         | String                | NF_MeetingTopicMinutes                                        |
+-----------------------+-----------------------+---------------------------------------------------------------+
| type                  | String                | "document"                                                    |
+-----------------------+-----------------------+---------------------------------------------------------------+
| version               | String                | Current version of the object                                 |
+-----------------------+-----------------------+---------------------------------------------------------------+
| author                | String                | Name of the user who created this object                      |
+-----------------------+-----------------------+---------------------------------------------------------------+
| creationDate          | DateTime              | Date & Time of Creation                                       |
+-----------------------+-----------------------+---------------------------------------------------------------+
| modificationDate      | DateTime              | Date & Time of last modification                              |
+-----------------------+-----------------------+---------------------------------------------------------------+
| name                  | String                | The name of the object                                        |
+-----------------------+-----------------------+---------------------------------------------------------------+
| owner                 | String                | Owner of the object                                           |
+-----------------------+-----------------------+---------------------------------------------------------------+
| title                 | String                | Title of the object usually shown to the users                |
+-----------------------+-----------------------+---------------------------------------------------------------+
| path                  | String                | Path relative to the server                                   |
+-----------------------+-----------------------+---------------------------------------------------------------+
| searchable            | Boolean               | Is the object searchable?                                     |
+-----------------------+-----------------------+---------------------------------------------------------------+
| downloadProhibited    | Boolean               | Whether the download is prohibited or not                     |
+-----------------------+-----------------------+---------------------------------------------------------------+
| writeAccess           | Boolean               | Whether writing is allowed for the current user               |
+-----------------------+-----------------------+---------------------------------------------------------------+
| documentType          | String                | Content-Type for `content` attribute, usually texxt/html      |
+-----------------------+-----------------------+---------------------------------------------------------------+
| documentSize          | int                   | Size of the `content` attribute in octets                     |
+-----------------------+-----------------------+---------------------------------------------------------------+
| content               | String                | Size of the `content` attribute in octets                     |
+-----------------------+-----------------------+---------------------------------------------------------------+

Additionally to the standard HW_Object Attributes, we have the following attributes for **Meeting Topic Minutes**.

Please note that we are using the ``author`` field as the creator of this object (s. below).

+-----------------------+-----------------------+---------------------------------------------------------------+
| Attribute Name        | Attribute Type        | Comments                                                      |
+=======================+=======================+===============================================================+
| minutesApproved       | boolean               | Is the minutes approved?                                      |
+-----------------------+-----------------------+---------------------------------------------------------------+

This object is a leaf object and can not, therefore, have children.

Explanation
-----------

author
  This is one of the ``minutesRecorders`` from :doc:`Meeting <meeting>`.

Discussion
----------
In order to get the meeting topic minutes, you need to make a :doc:`GetObject <../calls/getobject>` call with
the url of the meeting-topic with ``/minutes`` appended to it. The actual minutes can then be found in the
``content`` attribute. The content-type is definied in the ``documentType`` attribute (usually text/html).

E.g.: if the URL to an agenda item is ``<..>/Report Q1_2020`` you would send a GetObject call with the URL
``<..>/Report Q1_2020/minutes``.