.. _module-facebook:

Facebook
--------------------------

* **Identifier** - FACEBOOK
* **Description** - Implements integration with Facebook.
* **Initialization** - Checks availability of Facebook Application Id as meta-data.
* **Destroy** - None
* **Dependencies** - :ref:`module-core`

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

.. cssclass:: table-bordered

+--------------+----------------------------+---------------+-----------------------------------+
| Name         | Description                | From Version  | Wrapper Class                     |
+==============+============================+===============+===================================+
| **PROFILE**  | Represents a Facebook      | 1             | VT_Profile_Wrapper                |
|              | profile, with id and name. |               |                                   |
+--------------+----------------------------+---------------+-----------------------------------+

Trigger Status Update
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. cssclass:: table-bordered

+--------------+-------------------+---------------+--------------+-----------------------------+
| Name         | STATUS-UPDATE                                                                  |
+--------------+-------------------+---------------+--------------+-----------------------------+
| Description  | Executes when weather forecast for following day is Cloudy.                    |
+--------------+-------------------+---------------+--------------+-----------------------------+
| Logic        | Periodic check every 10 minutes.                                               |
+--------------+-------------------+---------------+--------------+-----------------------------+

.. cssclass:: table-bordered

+--------------+-------------------+-------------+--------------+-------------------------------+
|              | Type              | Name        | Required     | Description                   |
+==============+===================+=============+==============+===============================+
| Parameters   | FACEBOOK.PROFILE  | PROFILE     | No           | Profile to monitor. If empty, |
|              |                   |             |              | current profile is monitored. |
+              +-------------------+-------------+--------------+-------------------------------+
|              | CORE.TEXT-FILTER  | TEXT-FILTER | No           | Filter criteria for status.   |
+--------------+-------------------+-------------+--------------+-------------------------------+


Trigger Birthday
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. cssclass:: table-bordered

+--------------+-------------------+---------------+--------------+-----------------------------+
| Name         | BIRTHDAY                                                                       |
+--------------+-------------------+---------------+--------------+-----------------------------+
| Description  | Executes when weather forecast for following day is Cloudy.                    |
+--------------+-------------------+---------------+--------------+-----------------------------+
| Logic        | Periodic check every 12 hours.                                                 |
+--------------+-------------------+---------------+--------------+-----------------------------+

.. cssclass:: table-bordered

+--------------+-------------------+-------------+--------------+-------------------------------+
|              | Type              | Name        | Required     | Description                   |
+==============+===================+=============+==============+===============================+
| Parameters   | FACEBOOK.PROFILE  | PROFILE     | Yes          | Profile to monitor.           |
+              +-------------------+-------------+--------------+-------------------------------+
|              | CORE.NUMBER       | DAYS-BEFORE | No           | Filter criteria for status.   |
+--------------+-------------------+-------------+--------------+-------------------------------+

Performer Update Status
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. cssclass:: table-bordered

+--------------+-------------------+---------------+--------------+-----------------------------+
| Name         | UPDATE-STATUS                                                                  |
+--------------+-------------------+---------------+--------------+-----------------------------+
| Description  | Executes when weather forecast for following day is Cloudy.                    |
+--------------+-------------------+---------------+--------------+-----------------------------+

.. cssclass:: table-bordered

+--------------+-------------------+-------------+--------------+-------------------------------+
|              | Type              | Name        | Required     | Description                   |
+==============+===================+=============+==============+===============================+
| Parameters   | CORE.STRING       | TEXT        | Yes          | Status message.               |
+--------------+-------------------+-------------+--------------+-------------------------------+

Performer Post Link
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. cssclass:: table-bordered

+--------------+-------------------+---------------+--------------+-----------------------------+
| Name         | POST-LINK                                                                      |
+--------------+-------------------+---------------+--------------+-----------------------------+
| Description  | Executes when weather forecast for following day is Cloudy.                    |
+--------------+-------------------+---------------+--------------+-----------------------------+

.. cssclass:: table-bordered

+--------------+-------------------+-------------+--------------+-------------------------------+
|              | Type              | Name        | Required     | Description                   |
+==============+===================+=============+==============+===============================+
| Parameters   | CORE.STRING       | LINK        | Yes          | Link to share.                |
+--------------+-------------------+-------------+--------------+-------------------------------+
| Parameters   | CORE.STRING       | CAPTION     | Yes          | Caption for link.             |
+--------------+-------------------+-------------+--------------+-------------------------------+
| Parameters   | CORE.STRING       | DESCRIPTION | No           | Link description.             |
+--------------+-------------------+-------------+--------------+-------------------------------+