.. _pages_integration:

Integrating partoo pages
=================================

.. _pages_integration_navigation:

Navigation
---------------------------------

To navigate through Partoo App pages, you can use 3 methods:

.. code-block:: javascript

    // To navigate to a specific page
    // The 2nd and 3rd arguments are optional
    partooPage.navigate('reviewManagement', seedData, pageOptions);

    // To go back to previous page
    partooPage.back();

    // To go forward to next page
    partooPage.forward();


.. _pages_integration_available_pages:

Available Pages
-----------------------------------

In the table below:
  - Route name is the string value you should as the first argument of the `partooPage.navigate` function
  - seedData is the seed object you can indicate as the second argument of the `partooPage.navigate` function
  - pageOptions is the options object you can indicate as the third argument of the `partooPage.navigate` function

====================  =====================  =====================  ============================================  =========================
Route name            seedData argument      pageOptions argument   View                                          Authentication required
====================  =====================  =====================  ============================================  =========================
businesses            null                   null                   the list of a user's businesses               Yes
business              null                   {businessId: string}   the business edit view of a given business    Yes
add                   null                   null                   the add business view                         Yes
analytics             null                   null                   the analytics page                            Yes
presenceManagement    null                   null                   the presence management view                  Yes
posts                 null                   {status: string}       the post view                                 Yes
reviewManagement      null                   {status: string}       the review management view                    Yes
reviewAnalytics       null                   null                   the review analytics view                     Yes
reviewBooster         null                   null                   the review booster view                    	  Yes
partnerConnections    null                   null                   the google & facebook partner connexion page  Yes
messaging             null                   null                   the messages view                             Yes
bulkUpdate            null                   null                   the bulk update view                          Yes
conversationStarters  null                   null                   the conversation starters settings view       Yes
googleVerification    null                   null                   the google verification view                  Yes
whatsappSettings      null                   null                   the Whatsapp settings view                    Yes
====================  =====================  =====================  ============================================  =========================

.. _pages_integration_business_list_page:

Business list Page
-----------------------------------

**Integrating**

You can integrate this page by doing:

.. code-block:: javascript

    var partooPage = Partoo.init('partoo-container', {});
    var userToken = 'serverSideGeneratedToken';

    partooPage.login(userToken); // authentication is mandatory to access this page
    partooPage.navigate('businesses');


.. image:: ../images/js_api_business_list.gif
  :width: 600
  :alt: Alternative text

**Available callbacks**

There are 2 available callbacks:
 - Subscribe business callback :ref:`callbacks_subscribe_business_callback`
 - Open business callback :ref:`callbacks_open_business_callback`

.. _pages_integration_business_edit_page:

Business Edit Page
-----------------------------------

**Integrating**

You can integrate this page by doing:

.. code-block:: javascript

    var partooPage = Partoo.init('partoo-container', {});
    var userToken = 'serverSideGeneratedToken';

    partooPage.login(userToken); // authentication is mandatory to access this page
    partooPage.navigate('business', null, { businessId: 'theIDOfTheBusinesYouWantToEdit' });

.. image:: ../images/js_api_business_edit.gif
  :width: 600
  :alt: Alternative text

**Available callbacks**

❌ No available callback.

.. _pages_integration_add_business_page:

Add Business Page
-----------------------------------

**Integrating**

You can integrate this page by doing:

.. code-block:: javascript

    var partooPage = Partoo.init('partoo-container', {});
    var userToken = 'serverSideGeneratedToken';

    partooPage.login(userToken); // authentication is mandatory to access this page
    partooPage.navigate('add');

.. image:: ../images/js_api_business_add.gif
  :width: 600
  :alt: Alternative text

**Available callbacks**

There is 1 available callback:
 - Business created callback :ref:`callbacks_business_created_callback`

.. _pages_integration_analytics_page:

Analytics Page
-----------------------------------

**Integrating**

You can integrate this page by doing:

.. code-block:: javascript

    var partooPage = Partoo.init('partoo-container', {});
    var userToken = 'serverSideGeneratedToken';

    partooPage.login(userToken); // authentication is mandatory to access this page
    partooPage.navigate('analytics');

**Available callbacks**

❌ No available callback.

.. _pages_integration_pm_page:

Presence Management Page
-----------------------------------

**Integrating**

You can integrate this page by doing:

.. code-block:: javascript

    var partooPage = Partoo.init('partoo-container', {});
    var userToken = 'serverSideGeneratedToken';

    partooPage.login(userToken); // authentication is mandatory to access this page
    partooPage.navigate('presenceManagement');

**Available callbacks**

There are 2 available callbacks:
 - Go to edit click callback :ref:`callbacks_go_to_edit_callback`
 - Go to partner connection click callback :ref:`callbacks_go_to_partner_connection_callback`

.. _pages_integration_gp_page:

Post Page
-----------------------------------

**Integrating**

You can integrate this page by doing:

.. code-block:: javascript

    var partooPage = Partoo.init('partoo-container', {});
    var userToken = 'serverSideGeneratedToken';

    partooPage.login(userToken); // authentication is mandatory to access this page
    partooPage.navigate('posts');

You can use the optional pageOption ``status`` to filter the posts that are being displayed.
The available values for status are ``all``, ``published``, ``unpublished`` and ``pending``.
If not specified, ``all`` reviews will be displayed.

.. code-block:: javascript

    // This will only display posts that have not been published yet.
    partooPage.navigate('posts', null, {status: 'unpublished'});

**Available callbacks**

❌ No available callback.

.. _pages_integration_rm_page:

Review Management Page
-----------------------------------

**Integrating**

You can integrate this page by doing:

.. code-block:: javascript

    var partooPage = Partoo.init('partoo-container', {});
    var userToken = 'serverSideGeneratedToken';

    partooPage.login(userToken); // authentication is mandatory to access this page
    partooPage.navigate('reviewManagement');

You can use the optional pageOption ``status`` to filter the reviews that are being displayed.
The available values for status are ``live``, ``treated``, ``not-treated`` and ``deleted``.
If not specified, only ``live`` reviews will be displayed.

.. code-block:: javascript

    // This will only display reviews that have not been answered to.
    partooPage.navigate('reviewManagement', null, {status: 'not-treated'});

**Available callbacks**

❌ No available callback.

.. _pages_integration_ra_page:

Review Analytics Page
-----------------------------------

**Integrating**

You can integrate this page by doing:

.. code-block:: javascript

    var partooPage = Partoo.init('partoo-container', {});
    var userToken = 'serverSideGeneratedToken';

    partooPage.login(userToken); // authentication is mandatory to access this page
    partooPage.navigate('reviewAnalytics');

**Available callbacks**

❌ No available callback.

.. _pages_integration_rb_page:

Review Booster Page
-----------------------------------

**Integrating**

You can integrate this page by doing:

.. code-block:: javascript

    var partooPage = Partoo.init('partoo-container', {});
    var userToken = 'serverSideGeneratedToken';

    partooPage.login(userToken); // authentication is mandatory to access this page
    partooPage.navigate('reviewBooster');

**Available callbacks**

❌ No available callback.

.. _pages_integration_partner_co_page:

Partner Connections Page
-----------------------------------

**Integrating**

You can integrate this page by doing:

.. code-block:: javascript

    var partooPage = Partoo.init('partoo-container', {});
    var userToken = 'serverSideGeneratedToken';

    partooPage.login(userToken); // authentication is mandatory to access this page
    partooPage.navigate('partnerConnections');

**Available callbacks**

❌ No available callback.

Messaging Page
-----------------------------------

**Integrating**

You can integrate this page by doing:

.. code-block:: javascript

    var partooPage = Partoo.init('partoo-container', {});
    var userToken = 'serverSideGeneratedToken';

    partooPage.login(userToken); // authentication is mandatory to access this page
    partooPage.navigate('messaging');

**Available callbacks**

❌ No available callback.

Bulk update Page
-----------------------------------

**Integrating**

You can integrate this page by doing:

.. code-block:: javascript

    var partooPage = Partoo.init('partoo-container', {});
    var userToken = 'serverSideGeneratedToken';

    partooPage.login(userToken); // authentication is mandatory to access this page
    partooPage.navigate('bulkUpdate');

**Available callbacks**

❌ No available callback.

Conversation Starters Page
-----------------------------------

**Integrating**

You can integrate this page by doing:

.. code-block:: javascript

    var partooPage = Partoo.init('partoo-container', {});
    var userToken = 'serverSideGeneratedToken';

    partooPage.login(userToken); // authentication is mandatory to access this page
    partooPage.navigate('conversationStarters');

**Available callbacks**

❌ No available callback.

Google Verification Page
-----------------------------------

**Integrating**

You can integrate this page by doing:

.. code-block:: javascript

    var partooPage = Partoo.init('partoo-container', {});
    var userToken = 'serverSideGeneratedToken';

    partooPage.login(userToken); // authentication is mandatory to access this page
    partooPage.navigate('googleVerification');

**Available callbacks**

❌ No available callback.

Whatsapp Settings Page
-----------------------------------

**Integrating**

You can integrate this page by doing:

.. code-block:: javascript
    var partooPage = Partoo.init('partoo-container', {});
    var userToken = 'serverSideGeneratedToken';
    partooPage.login(userToken); // authentication is mandatory to access this page
    partooPage.navigate('whatsappSettings');
**Available callbacks**

❌ No available callback.

.. include:: ../utils/intercom.rst