.. _module-dropbox:

Dropbox
--------------------------

* **Identifier** - DROPBOX
* **Description** - Implements integration with Dropbox.
* **Initialization** - Check availability of Dropbox App Key and App Secret as meta-data. Set up Dropbox AuthActivity in Manifest file in order for the client application to interact with Dropbox API.
* **Destroy** - None
* **Dependencies** - :ref:`module-core`


Value Types
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. cssclass:: table-bordered

+--------------+--------------------------------------------------+---------------+-------------------------+
| Name         | Description                                      | From Version  | Wrapper Class           |
+==============+==================================================+===============+=========================+
| **URI**      | Represents a Dropbox Relative Uri.               | 1             | VT_Dropbox_Uri_Wrapper  |
+--------------+--------------------------------------------------+---------------+-------------------------+


Trigger Directory Created
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. cssclass:: table-bordered

+--------------+---------------------+----------------+------------+------------------------------+
| Name         | DIR-CREATED                                                                      |
+--------------+---------------------+----------------+------------+------------------------------+
| Description  | Executes when a new directory is created by the Dropbox user.                    |
|              |                                                                                  |
+--------------+---------------------+----------------+------------+------------------------------+

.. cssclass:: table-bordered

+--------------+---------------------+----------------+------------+------------------------------+
|              | Type                | Name           | Required   | Description                  |
+==============+=====================+================+============+==============================+
| Parameters   | DROPBOX.URI         | DIR-PATH       | No         | Filter criteria for path     |
|              |                     |                |            | of the folder created.       |
+              +---------------------+----------------+------------+------------------------------+
|              | CORE.STRING         | DIR-NAME       | No         | Filter criteria for name     |
|              |                     |                |            | of the folder created.       |
+--------------+---------------------+----------------+------------+------------------------------+
| Variables    | DROPBOX.URI         | DIR-NAME                    | Directory name.              |
+--------------+---------------------+----------------+------------+------------------------------+


Trigger Directory Deleted
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. cssclass:: table-bordered

+--------------+---------------------+----------------+------------+------------------------------+
| Name         | DIR-CREATED                                                                      |
+--------------+---------------------+----------------+------------+------------------------------+
| Description  | Executes when a directory is deleted by the Dropbox user.                        |
|              |                                                                                  |
+--------------+---------------------+----------------+------------+------------------------------+

.. cssclass:: table-bordered

+--------------+---------------------+----------------+------------+------------------------------+
|              | Type                | Name           | Required   | Description                  |
+==============+=====================+================+============+==============================+
| Parameters   | DROPBOX.URI         | DIR-PATH       | No         | Filter criteria for path     |
|              |                     |                |            | of the folder deleted.       |
+              +---------------------+----------------+------------+------------------------------+
|              | CORE.STRING         | DIR-NAME       | No         | Filter criteria for name     |
|              |                     |                |            | of the folder deleted.       |
+--------------+---------------------+----------------+------------+------------------------------+
| Variables    | DROPBOX.URI         | DIR-NAME                    | Directory name.              |
+--------------+---------------------+----------------+------------+------------------------------+


Trigger File Added
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. cssclass:: table-bordered

+--------------+---------------------+----------------+------------+------------------------------+
| Name         | FILE-ADDED                                                                       |
+--------------+---------------------+----------------+------------+------------------------------+
| Description  | Executes when a file is added by the Dropbox user.                               |
|              |                                                                                  |
+--------------+---------------------+----------------+------------+------------------------------+

.. cssclass:: table-bordered

+--------------+---------------------+----------------+------------+------------------------------+
|              | Type                | Name           | Required   | Description                  |
+==============+=====================+================+============+==============================+
| Parameters   | DROPBOX.URI         | FILE-PATH      | No         | Filter criteria for path     |
|              |                     |                |            | of the file added.           |
+              +---------------------+----------------+------------+------------------------------+
|              | CORE.STRING         | FILE-NAME      | No         | Filter criteria for name     |
|              |                     |                |            | of the file added.           |
+--------------+---------------------+----------------+------------+------------------------------+
| Variables    | DROPBOX.URI         | FILE-PATH                   | File path.                   |
+--------------+---------------------+----------------+------------+------------------------------+


Trigger File Deleted
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. cssclass:: table-bordered

+--------------+---------------------+----------------+------------+------------------------------+
| Name         | FILE-DELETED                                                                     |
+--------------+---------------------+----------------+------------+------------------------------+
| Description  | Executes when a file is deleted by the Dropbox user.                             |
|              |                                                                                  |
+--------------+---------------------+----------------+------------+------------------------------+

.. cssclass:: table-bordered

+--------------+---------------------+----------------+------------+------------------------------+
|              | Type                | Name           | Required   | Description                  |
+==============+=====================+================+============+==============================+
| Parameters   | DROPBOX.URI         | FILE-PATH      | No         | Filter criteria for path     |
|              |                     |                |            | of the file deleted.         |
+              +---------------------+----------------+------------+------------------------------+
|              | CORE.STRING         | FILE-NAME      | No         | Filter criteria for name     |
|              |                     |                |            | of the file deleted.         |
+--------------+---------------------+----------------+------------+------------------------------+
| Variables    | DROPBOX.URI         | FILE-PATH                   | File path.                   |
+--------------+---------------------+----------------+------------+------------------------------+


Trigger Media Uploaded
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. cssclass:: table-bordered

+--------------+---------------------+----------------+------------+------------------------------+
| Name         | MEDIA-UPLOADED                                                                   |
+--------------+---------------------+----------------+------------+------------------------------+
| Description  | Executes when a media file is uploaded by the Dropbox user.                      |
|              |                                                                                  |
+--------------+---------------------+----------------+------------+------------------------------+

.. cssclass:: table-bordered

+--------------+---------------------+----------------+------------+------------------------------+
|              | Type                | Name           | Required   | Description cc               |
+==============+=====================+================+============+==============================+
| Parameters   | DROPBOX.URI         | FILE-PATH      | No         | Filter criteria for path     |
|              |                     |                |            | of the media uploaded.       |
+              +---------------------+----------------+------------+------------------------------+
|              | CORE.STRING         | FILE-NAME      | No         | Filter criteria for name     |
|              |                     |                |            | of the media uploaded.       |
+--------------+---------------------+----------------+------------+------------------------------+
| Variables    | DROPBOX.URI         | DIR-TO                      | Media File path.             |
+--------------+---------------------+----------------+------------+------------------------------+


Trigger Space Used
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. cssclass:: table-bordered

+--------------+---------------------+----------------+------------+------------------------------+
| Name         | SPACE-USED                                                                       |
+--------------+---------------------+----------------+------------+------------------------------+
| Description  | Executes when the used space in Dropbox is equal/greater/lesser than a           |
|              | predefined percentage value passed as a parameter.                               |
+--------------+---------------------+----------------+------------+------------------------------+

.. cssclass:: table-bordered

+--------------+---------------------+----------------+------------+------------------------------+
|              | Type                | Name           | Required   | Description                  |
+==============+=====================+================+============+==============================+
| Parameters   | CORE.PERCENT-FILTER | PERCENT        | Yes        | Filter criteria for          |
|              |                     |                |            | used space.                  |
+--------------+---------------------+----------------+------------+------------------------------+


Performer Create Directory
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. cssclass:: table-bordered

+--------------+---------------------+----------------+------------+------------------------------+
| Name         | DIR-CREATE                                                                       |
+--------------+---------------------+----------------+------------+------------------------------+
| Description  | Creates a new directory in Dropbox.                                              |
+--------------+---------------------+----------------+------------+------------------------------+

.. cssclass:: table-bordered

+--------------+---------------------+----------------+------------+------------------------------+
|              | Type                | Name           | Required   | Description                  |
+==============+=====================+================+============+==============================+
| Parameters   | DROPBOX.URI         | DIR-PATH       | No         | Dropbox relative path of     |
|              |                     |                |            | the directory to be created. |
+              +---------------------+----------------+------------+------------------------------+
|              | CORE.STRING         | DIR-NAME       | Yes        | Name of the directory to be  |
|              |                     |                |            | created.                     |
+--------------+---------------------+----------------+------------+------------------------------+


Performer Delete Directory
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. cssclass:: table-bordered

+--------------+---------------------+----------------+------------+------------------------------+
| Name         | DIR-DELETE                                                                       |
+--------------+---------------------+----------------+------------+------------------------------+
| Description  | Deletes an existing directory in Dropbox.                                        |
+--------------+---------------------+----------------+------------+------------------------------+

.. cssclass:: table-bordered

+--------------+---------------------+----------------+------------+------------------------------+
|              | Type                | Name           | Required   | Description                  |
+==============+=====================+================+============+==============================+
| Parameters   | DROPBOX.URI         | DIR-PATH       | No         | Dropbox relative path of     |
|              |                     |                |            | the directory to be deleted. |
+              +---------------------+----------------+------------+------------------------------+
|              | CORE.STRING         | DIR-NAME       | Yes        | Name of the directory to be  |
|              |                     |                |            | deleted.                     |
+--------------+---------------------+----------------+------------+------------------------------+


Performer Add File
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. cssclass:: table-bordered

+--------------+---------------------+----------------+------------+------------------------------+
| Name         | FILE-ADD                                                                         |
+--------------+---------------------+----------------+------------+------------------------------+
| Description  | Adds a new file in Dropbox.                                                      |
+--------------+---------------------+----------------+------------+------------------------------+

.. cssclass:: table-bordered

+--------------+---------------------+----------------+------------+------------------------------+
|              | Type                | Name           | Required   | Description                  |
+==============+=====================+================+============+==============================+
| Parameters   | DROPBOX.URI         | FILE-PATH      | No         | Dropbox relative path of     |
|              |                     |                |            | the file to be added.        |
+              +---------------------+----------------+------------+------------------------------+
|              | CORE.URI            | FILE           | Yes        | Uri of the file to be added. |
|              |                     |                |            |                              |
+--------------+---------------------+----------------+------------+------------------------------+


Performer Delete File
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. cssclass:: table-bordered

+--------------+---------------------+----------------+------------+------------------------------+
| Name         | FILE-DELETE                                                                      |
+--------------+---------------------+----------------+------------+------------------------------+
| Description  | Deletes an existing file in Dropbox.                                             |
+--------------+---------------------+----------------+------------+------------------------------+

.. cssclass:: table-bordered

+--------------+---------------------+----------------+------------+------------------------------+
|              | Type                | Name           | Required   | Description                  |
+==============+=====================+================+============+==============================+
| Parameters   | DROPBOX.URI         | DIR-PATH       | Yes        | Dropbox relative Uri of the  |
|              |                     |                |            | file to be deleted.          |
+--------------+---------------------+----------------+------------+------------------------------+


Performer Share File
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. cssclass:: table-bordered

+--------------+---------------------+----------------+------------+------------------------------+
| Name         | FILE-SHARE                                                                       |
+--------------+---------------------+----------------+------------+------------------------------+
| Description  | Shares an existing file in Dropbox.                                              |
+--------------+---------------------+----------------+------------+------------------------------+

.. cssclass:: table-bordered

+--------------+---------------------+----------------+------------+------------------------------+
|              | Type                | Name           | Required   | Description                  |
+==============+=====================+================+============+==============================+
| Parameters   | DROPBOX.URI         | FILE-PATH      | No         | Dropbox relative path of     |
|              |                     |                |            | the file to be shared.       |
+              +---------------------+----------------+------------+------------------------------+
|              | CORE.STRING         | FILE-NAME      | Yes        | Name of the file to be       |
|              |                     |                |            | shared                       |
+--------------+---------------------+----------------+------------+------------------------------+
| Variables    | CORE.LINK           | LINK                        | File link.                   |
+--------------+---------------------+----------------+------------+------------------------------+