.. 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.

Calls Overview
==============

The Netfiles API consists of two groups of calls:

1. User Related Calls
2. Document Related Calls

User Related Calls
------------------

User related calls deal with user data and login/logout.

+--------------------------------------------+-------------------------------------------------------------------+
| Call                                       | Brief description                                                 |
+============================================+===================================================================+
| :doc:`checkIdentity <checkidentity>`       | Login to Netfiles                                                 |
+--------------------------------------------+-------------------------------------------------------------------+
| :doc:`getDatarooms <getdatarooms>`         | Retrieve the list of datarooms for this user                      |
+--------------------------------------------+-------------------------------------------------------------------+
| getFavorites                               | Retrieves the list of favorite objects                            |
+--------------------------------------------+-------------------------------------------------------------------+
| addFavorite                                | Adds the object to the list of favorite objects                   |
+--------------------------------------------+-------------------------------------------------------------------+
| remFavorite                                | Removes the object from the list of favorites                     |
+--------------------------------------------+-------------------------------------------------------------------+
| showPrefered [#]_                          | ??                                                                |
+--------------------------------------------+-------------------------------------------------------------------+
| showLocked                                 | Retrieves the list of locked objects                              |
+--------------------------------------------+-------------------------------------------------------------------+
| :doc:`showNewFiles <shownewfiles>`         | Retrieve the list of new obejct since last login                  |
+--------------------------------------------+-------------------------------------------------------------------+
| :doc:`showChangedFiles <showchangedfiles>` | Retrieve the list of changed objects since last login             |
+--------------------------------------------+-------------------------------------------------------------------+
| showSearchResults                          | Retrieve the results of the last search                           |
+--------------------------------------------+-------------------------------------------------------------------+
| :doc:`acceptDisclaimer <acceptdisclaimer>` | Accept any disclaimer that was set                                |
+--------------------------------------------+-------------------------------------------------------------------+
| logout                                     | Logout from Netfiles                                              |
+--------------------------------------------+-------------------------------------------------------------------+

Document Related Calls
----------------------

Document related calls work on collections, directories and files [#]_.

+--------------------------------------+-------------------------------------------------------------------+
| Call                                 | Brief description                                                 |
+======================================+===================================================================+
| :doc:`getObject <getobject>`         | Retrieves information about the specific object                   |
+--------------------------------------+-------------------------------------------------------------------+
| :doc:`getChildren <getchildren>`     | Retrieves the children of a folder or a collection                |
+--------------------------------------+-------------------------------------------------------------------+
| :doc:`getContent <getcontent>`       | Retrieves the original content of a file                          |
+--------------------------------------+-------------------------------------------------------------------+
| :doc:`getContentPDF <getcontentpdf>` | Retrieves the content of a file as a PDF (if possible)            |
+--------------------------------------+-------------------------------------------------------------------+
| createFolder                         | Creates a new parent object as the child of another parent        |
+--------------------------------------+-------------------------------------------------------------------+
| insertObject                         | Adds a new object as the sub-object of another object             |
+--------------------------------------+-------------------------------------------------------------------+
| createTextDocument                   | Creates a new text document?                                      |
+--------------------------------------+-------------------------------------------------------------------+
| updateContent                        | Uploads a new content for a given file-object                     |
+--------------------------------------+-------------------------------------------------------------------+
| moveObject                           | Moves one object from one parent to a new parent                  |
+--------------------------------------+-------------------------------------------------------------------+
| deleteObject [#]_                    | Deletes an object and all its child-objects                       |
+--------------------------------------+-------------------------------------------------------------------+
| insertMFT                            | Creates a Secure Filetransfer email package?                      |
+--------------------------------------+-------------------------------------------------------------------+

Footnotes
---------
.. [#] This is not a typo by the author of this documentation.

.. [#] Netfiles using the Hyperwave system means that actually there is no
       notion of files, directories or such. Everything is an object. In order
       for us to be able to use it though, we think in terms of files, folders, and
       collections. A Hyperwave Object that has children is usually a folder. If it
       doesn't have any children, it usually has a content and thus represents a
       file as we know it.

.. [#] These inconsistencies do exist in Netfiles. Documents are ``delete`` d and
       favorites are ``rem`` oved.