.. _module-gcalendar:

Google Calendar
--------------------------

* **Identifier** - GCALENDAR
* **Description** - Implements integration with Google Calendar.
* **Initialization** - Checks availability of Play Services, if not available checks availability of com.google.oauth.ClientId and com.google.oauth.ClientSecret as meta-data.
* **Destroy** - None
* **Dependencies** - :ref:`module-core`, :ref:`module-location`

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

.. cssclass:: table-bordered

+-------------------+--------------------------------------------------------------+---------------+---------------------+
| Name              | Description                                                  | From Version  | Wrapper Class       |
+===================+==============================================================+===============+=====================+
| **EVENT**         | Represents a Google Calendar event.                          | 1             | VT_Event_Wrapper    |
+-------------------+--------------------------------------------------------------+---------------+---------------------+
| **CALENDAR**      | Represents a User Google Calendar.                           | 1             | VT_Calendar_Wrapper |
+-------------------+--------------------------------------------------------------+---------------+---------------------+

Trigger Calendar Event
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. cssclass:: table-bordered

+--------------+-------------------+---------------+--------------+-----------------------------------------------------+
| Name         | ON-EVENT                                                                                               |
+--------------+-------------------+---------------+--------------+-----------------------------------------------------+
| Description  | Executes when a calendar event starts.                                                                 |
+--------------+-------------------+---------------+--------------+-----------------------------------------------------+
| Logic        | Periodic check every 10 minutes.                                                                       |
+--------------+-------------------+---------------+--------------+-----------------------------------------------------+

.. cssclass:: table-bordered

+--------------+---------------------------------+----------------+--------------+--------------------------------------+
|              | Type                            | Name           | Required     | Description                          |
+==============+=================================+================+==============+======================================+
| Parameters   | GCALENDAR.CALENDARDESC          | CALENDARDESC   | Yes          | User Calendar description.           |
+              +---------------------------------+----------------+--------------+--------------------------------------+
|              | CORE.STRING                     | KEYWORD        | No           | Calendar keyword to match.           |
+              +---------------------------------+----------------+--------------+--------------------------------------+
|              | LOCATION.AREA                   | LOCATION       | No           | Location of the Event.               |
+--------------+---------------------------------+----------------+--------------+--------------------------------------+
| Variables    | GCALENDAR.EVENT                 | EVENTTOSEND                   | Calendar Event.                      |
+              +---------------------------------+----------------+--------------+--------------------------------------+
|              | CORE.STRING                     | EVENTPOS                      | Location of the event                |
+--------------+---------------------------------+----------------+--------------+--------------------------------------+

Trigger Tomorrow Overloaded
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. cssclass:: table-bordered

+--------------+-------------------+---------------+--------------+-----------------------------------------------------+
| Name         | ON-OVERLOAD                                                                                            |
+--------------+-------------------+---------------+--------------+-----------------------------------------------------+
| Description  | Executes when tomorrow has more than N events, where N is a parameter provided by user. Please notice  |
|              | that trigger fires only once per day, unless number of events changes going below and above limit      |
|              | again.                                                                                                 |
+--------------+-------------------+---------------+--------------+-----------------------------------------------------+
| Logic        | Periodic check every 10 minutes.                                                                       |
+--------------+-------------------+---------------+--------------+-----------------------------------------------------+

.. cssclass:: table-bordered

+--------------+---------------------------------+----------------+--------------+--------------------------------------+
|              | Type                            | Name           | Required     | Description                          |
+==============+=================================+================+==============+======================================+
| Parameters   | GCALENDAR.CALENDARDESC          | CALENDARDESC   | Yes          | User Calendar description.           |
+              +---------------------------------+----------------+--------------+--------------------------------------+
|              | CORE.NUMBER                     | LIMIT          | Yes          | Limit for tomorrow events.           |
+--------------+---------------------------------+----------------+--------------+--------------------------------------+
| Variables    | CORE.NUMBER                     | NUM-EVENTS                    | Number of tomorrow events.           |
+--------------+---------------------------------+----------------+--------------+--------------------------------------+

Performer Create Event
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. cssclass:: table-bordered

+--------------+-------------------+---------------+--------------+-----------------------------------------------------+
| Name         | CREATE-EVENT                                                                                           |
+--------------+-------------------+---------------+--------------+-----------------------------------------------------+
| Description  | Sends an email with specified parameters.                                                              |
+--------------+-------------------+---------------+--------------+-----------------------------------------------------+

.. cssclass:: table-bordered

+--------------+---------------------------------+--------------+--------------+----------------------------------------+
|              | Type                            | Name         | Required     | Description                            |
+==============+=================================+==============+==============+========================================+
| Parameters   | GCALENDAR.EVENT                 | EVENT        | Yes          | Event to be created.                   |
+--------------+---------------------------------+--------------+--------------+----------------------------------------+