Controller: /nodeworx/lang
==========================

:Required Permissions: LANGUAGES

Action: ``add``
---------------

:Added in Version: 4.7.0-339
:Description: Add a new language.

Input Parameters
^^^^^^^^^^^^^^^^^

.. list-table::
   :widths: auto
   :header-rows: 1

   * - Name
     - Type
     - Required?
     - Example Values
     - Default Values
     - Notes
   * - ``code``
     - string
     - Yes
     - ab, aa, af, sq, am, ar, hy, as, ay, az, ba, eu, bn, dz, bh, bi, br, bg, my, be, km, ca, co, hr, en-uk, eo, et, fo, fj, fi, fy, gd, gl, ka, el, kl, gn, gu, ha, iw, hi, is, in, ia, ie, ik, ga, ja, jw, ...
     - 
     - 
   * - ``lang_file``
     - string
     - Yes
     - 
     - 
     - 

Action: ``changeCurrentUserLanguage``
-------------------------------------

:Added in Version: 4.8.0-393
:Description: Change the current language.

Action: ``delete``
------------------

:Added in Version: 4.7.0-339
:Description: Delete a language file.

Input Parameters
^^^^^^^^^^^^^^^^^

.. list-table::
   :widths: auto
   :header-rows: 1

   * - Name
     - Type
     - Required?
     - Example Values
     - Default Values
     - Notes
   * - ``code``
     - string
     - Yes
     - cs, da, de, es, fr, hu, it, nl, pl, pt, ru, sk, sv, tr, zh
     - 
     - 

Action: ``fail``
----------------

:Added in Version: 4.7.0-339
:Description: Magic function - test for failure mechanism.

Action: ``listLanguages``
-------------------------

:Added in Version: 4.8.0-393
:Description: List languages available for use in interworx.

Sample Output
^^^^^^^^^^^^^

.. code-block::

   array (
     'status' => 0,
     'payload' => 
     array (
       0 => 
       array (
         'code' => 'cs',
         'language' => 'Czech',
         'status' => 'unused',
       ),
       1 => 
       array (
         'code' => 'da',
         'language' => 'Danish',
         'status' => 'unused',
       ),
       2 => 
       array (
         'code' => 'de',
         'language' => 'German',
         'status' => 'unused',
       ),
     ),
     'reply_code' => 205,
   )


Action: ``queryChangeCurrentUserLanguage``
------------------------------------------

:Added in Version: 5.1.0-838
:Description: Displays the information available to the action "changeCurrentUserLanguage".

Sample Output
^^^^^^^^^^^^^

.. code-block::

   array (
     'status' => 0,
     'payload' => 
     array (
       'code_copy' => 'en-us',
       'code' => 'en-us',
     ),
     'reply_code' => 205,
   )


Action: ``reroute``
-------------------

:Added in Version: n/a
:Description: Action to re-route from the current controller to a different one.

Input Parameters
^^^^^^^^^^^^^^^^^

.. list-table::
   :widths: auto
   :header-rows: 1

   * - Name
     - Type
     - Required?
     - Example Values
     - Default Values
     - Notes
   * - ``controller``
     - string
     - Yes
     - Index, Overview, Users, Lang, Apikey, Plugins, Twofactorauth, Notice, Siteworx, Shell, Packages, Backup, Import, Softaculous, Reseller, ResellerPackages, ResellerBandwidthhistory, Http, Phpextensions, Ftp, Sshd, MailMta, MailSmtp, MailSmtp2, MailSend, MailMda, MailMsa, MailDovecot, MailSpam, MailVirus, MailMailman, MailQueue, Mysql, MysqlRemote, MysqlPhpmyadmin, Dns, DnsZone, DnsRecord, DnsSync, Nfs, NfsExport, NfsMount, Health, Cron, Firewall, Ssl, Logs, Settings, Updates, Rrd, ...
     - 
     - 

Action: ``syncLanguage``
------------------------

:Added in Version: 4.7.0-339
:Description: Trigger language synchronization for a node.

Input Parameters
^^^^^^^^^^^^^^^^^

.. list-table::
   :widths: auto
   :header-rows: 1

   * - Name
     - Type
     - Required?
     - Example Values
     - Default Values
     - Notes
   * - ``code``
     - string
     - Yes
     - cs, da, de, en-us, es, fr, hu, it, nl, pl, pt, ru, sk, sv, tr, zh
     - 
     - 

Action: ``win``
---------------

:Added in Version: n/a
:Description: Magic function - test for testing success mechanism.