.. _module-twitter:

Twitter
--------------------------

* **Identifier** - TWITTER
* **Description** - Implements integration with Twitter.
* **Initialization** - Check availability of Twitter Consumer Key and Consumer Secret as meta-data. Set up redirect uri as meta-data (Only the logic of the redirect uri should be implemented and running on a dedicated server). More info in https://dev.twitter.com/web/sign-in/implementing
* **Destroy** - None
* **Dependencies** - :ref:`module-core`

Trigger New Tweet
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. cssclass:: table-bordered

+--------------+-------------------+---------------+--------------+-----------------------------+
| Name         | NEW-TWEET                                                                      |
+--------------+-------------------+---------------+--------------+-----------------------------+
| Description  | Executes when a new status is tweeted by the user denoted by the USER id       |
|              | parameter.                                                                     |
+--------------+-------------------+---------------+--------------+-----------------------------+
| Logic        | Periodic check every 10 minutes.                                               |
+--------------+-------------------+---------------+--------------+-----------------------------+

.. cssclass:: table-bordered

+--------------+-------------------+------------------+--------------+--------------------------+
|              | Type              | Name             | Required     | Description              |
+==============+===================+==================+==============+==========================+
| Parameters   | CORE.STRING       | USERID           | Yes          | ID of the user whose     |
|              |                   |                  |              | status is of interest.   |
+              +-------------------+------------------+--------------+--------------------------+
|              | CORE.STRING       | HASHTAG          | No           | Filter criteria for      |
|              |                   |                  |              | hashtag.                 |
+              +-------------------+------------------+--------------+--------------------------+
|              | CORE.STRING       | MENTIONED-USERID | No           | Filter criteria for      |
|              |                   |                  |              | mentioned user id.       |
+              +-------------------+------------------+--------------+--------------------------+
|              | CORE.TEXT-FILTER  | TEXT-FILTER      | No           | Filter criteria for      |
|              |                   |                  |              | status message.          |
+--------------+-------------------+------------------+--------------+--------------------------+
| Variables    | CORE.STRING       | USERID                          | Tweet sender user-id.    |
+              +-------------------+------------------+--------------+--------------------------+
|              | CORE.STRING       | USER-DISPLAYNAME                | Tweet sender name.       |
+              +-------------------+------------------+--------------+--------------------------+
|              | CORE.STRING       | TEXT                            | Tweet text.              |
+--------------+-------------------+------------------+--------------+--------------------------+


Trigger Reply Received
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. cssclass:: table-bordered

+--------------+-------------------+---------------+--------------+-----------------------------+
| Name         | REPLY-RECEIVED                                                                 |
+--------------+-------------------+---------------+--------------+-----------------------------+
| Description  | Executes when the user is mentioned in a tweet.                                |
+--------------+-------------------+---------------+--------------+-----------------------------+
| Logic        | Periodic check every 10 minutes.                                               |
+--------------+-------------------+---------------+--------------+-----------------------------+

.. cssclass:: table-bordered

+--------------+-------------------+------------------+--------------+--------------------------+
|              | Type              | Name             | Required     | Description              |
+==============+===================+==================+==============+==========================+
| Parameters   | CORE.STRING       | USERID           | No           | ID of the user who       |
|              |                   |                  |              | tweeted the message.     |
+              +-------------------+------------------+--------------+--------------------------+
|              | CORE.TEXT-FILTER  | TEXT-FILTER      | No           | Filter criteria for      |
|              |                   |                  |              | status message.          |
+--------------+-------------------+------------------+--------------+--------------------------+
| Variables    | CORE.STRING       | USERID                          | Reply sender user-id.    |
+              +-------------------+------------------+--------------+--------------------------+
|              | CORE.STRING       | USER-DISPLAYNAME                | Reply sender name.       |
+              +-------------------+------------------+--------------+--------------------------+
|              | CORE.STRING       | TEXT                            | Reply text.              |
+--------------+-------------------+------------------+--------------+--------------------------+


Trigger Direct Message Received
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. cssclass:: table-bordered

+--------------+-------------------+---------------+--------------+-----------------------------+
| Name         | DIRECT-MESSAGE-RECEIVED                                                        |
+--------------+-------------------+---------------+--------------+-----------------------------+
| Description  | Executes when a direct message is received.                                    |
+--------------+-------------------+---------------+--------------+-----------------------------+
| Logic        | Periodic check every 10 minutes.                                               |
+--------------+-------------------+---------------+--------------+-----------------------------+

.. cssclass:: table-bordered

+--------------+-------------------+------------------+--------------+--------------------------+
|              | Type              | Name             | Required     | Description              |
+==============+===================+==================+==============+==========================+
| Parameters   | CORE.STRING       | SENDER           | No           | ID of the user who       |
|              |                   |                  |              | sent the message.        |
+              +-------------------+------------------+--------------+--------------------------+
|              | CORE.TEXT-FILTER  | TEXT-FILTER      | No           | Filter criteria for      |
|              |                   |                  |              | received message.        |
+--------------+-------------------+------------------+--------------+--------------------------+
| Variables    | CORE.STRING       | USERID                          | Message sender user-id.  |
+              +-------------------+------------------+--------------+--------------------------+
|              | CORE.STRING       | USER-DISPLAYNAME                | Message sender name.     |
+              +-------------------+------------------+--------------+--------------------------+
|              | CORE.STRING       | TEXT                            | Message text.            |
+--------------+-------------------+------------------+--------------+--------------------------+



Trigger Favorited
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. cssclass:: table-bordered

+--------------+-------------------+---------------+--------------+-----------------------------+
| Name         | FAVORITED                                                                      |
+--------------+-------------------+---------------+--------------+-----------------------------+
| Description  | Executes when a tweet gets favorited.                                          |
+--------------+-------------------+---------------+--------------+-----------------------------+
| Logic        | Periodic check every 10 minutes.                                               |
+--------------+-------------------+---------------+--------------+-----------------------------+


.. cssclass:: table-bordered

+--------------+-------------------+------------------+--------------+--------------------------+
|              | Type              | Name             | Required     | Description              |
+==============+===================+==================+==============+==========================+
| Variables    | CORE.STRING       | USERID                          | Tweet sender user-id.    |
+              +-------------------+------------------+--------------+--------------------------+
|              | CORE.STRING       | USER-DISPLAYNAME                | Tweet sender name.       |
+              +-------------------+------------------+--------------+--------------------------+
|              | CORE.STRING       | TEXT                            | Tweet text.              |
+--------------+-------------------+------------------+--------------+--------------------------+



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

.. cssclass:: table-bordered

+--------------+-------------------+---------------+--------------+-----------------------------+
| Name         | TWEET                                                                          |
+--------------+-------------------+---------------+--------------+-----------------------------+
| Description  | Tweets a new status on Twitter user timeline.                                  |
+--------------+-------------------+---------------+--------------+-----------------------------+

.. cssclass:: table-bordered

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