Documentation for Quick Language Switcher for Jira, version 1.0.

Release Notes

User's Manual

General

Sometimes you like to temporary change your language setting. You do this in your preferences. This takes some steps, as you have to navigate to the preferences page, wait for loading it, open the settings dialog, select a language, save, and wait for the reload of the preferences page again. If you do this often, this could become a cumbersome task. The Quick Language Switcher app lets you select any installed language in only three clicks, and reloads the current page in that language!

Some use cases:

1. You are a user: You run Jira in a non-Enlish language and like to write a filter. The system fields have to be given in their English names. To get an English name, you switch Jira to English temporarily, write the filter, and switch back to you language.
2. You are an admin: A user calls you for help. The user runs Jira in a different language than you, but you like to give support and detailed information in the language the user sees on his issues. To achieve this, you switch to the user's language, give support, and switch back to your language when finished.

How To Display

Click the "L"-button at the global top right navigation bar. The app will display the following dialog:

The dialog consists of the following elements, placed in one of the two tabs "List" and "Mosaic".

Tab "List"

1. "Select language": A single select list with all installed languanges. Selecting a language here is intendet as a temporary setting.
2. "Language set in preferences": The language you set in your preferences. This is intended as "your preferred language". The dialog is shown in this language if this language is supported by the app. If not, the dialog is shown in English.
3. "Show user's language": If you are an admin, you'll see this user picker. The app will show the selected language of the selected user, and enables the language-switch-button next to the user picker. Clicking the button switches to that language.
4. "Recent languages": The history of languages you set with the app's "Select language" or the language-mosaic. Choosing your "Language set in preferences" won't affect the history. Also setting the language in your preferences won't affect the history.

Tab "Mosaic"

Shows all installed languages as buttons. If you are familiar with locale names, this is the most quick way to switch to a language.

Supported languages in dialog labels

1. English
2. German

Administrator's Manual

Install

1. Download app from Atlassian Marketplace.
2. Install app into Jira.

REST API

All APIs need authentication and a valid license.

Get a user's locale

GET /rest/fliplang/latest/locale/user/{userName}

Permission needed: Admin

Responses:

200 OK: Returns the user's locale

Example:

{
    "localeKey": "de_DE",
    "displayName": "German (Germany)"
}

403 Forbidden

Example:

{
    "error": "Missing or invalid license"
}

404 Not found

Example:

{
    "error": "User key user_UNKNOWN is unknown"
}

Get all user's language histories

GET /rest/fliplang/latest/all

Permission needed: Admin

Responses:

200 OK: Returns all user's histories

propertyType "1" currently is the only type and reflects a history entry. The propertyKey is the locale, the propertyValue is the timestamp the user sets the locale (used for sorting only). The timestamp "0" reflects the preferred/original locale before the user sets a language with Quick Language Switcher.

F. y. i., about how Jira generates user keys: Up to Jira 8.3, the user key has been the same as username, lowercased. For example, user Admin got a user key admin. If there’s been a naming conflict, the user key has been set to a value like ID10100. Starting with Jira 8.4, all user keys for new users (no changes for existing users) have the following format: JIRAUSER10100

Example:

[
    {
        "aoID": 25,
        "userKey": "admin",
        "propertyType": 1,
        "propertyKey": "en_US",
        "propertyValue": "0"
    },
    {
        "aoID": 26,
        "userKey": "admin",
        "propertyType": 1,
        "propertyKey": "de_DE",
        "propertyValue": "1561292363928"
    },
    {
        "aoID": 27,
        "userKey": "admin",
        "propertyType": 1,
        "propertyKey": "fr_FR",
        "propertyValue": "1561292383302"
    },
    {
        "aoID": 28,
        "userKey": "admin",
        "propertyType": 1,
        "propertyKey": "zh_CN",
        "propertyValue": "1561292401765"
    },
    {
        "aoID": 29,
        "userKey": "user1",
        "propertyType": 1,
        "propertyKey": "de_DE",
        "propertyValue": "0"
    },
    {
        "aoID": 30,
        "userKey": "user1",
        "propertyType": 1,
        "propertyKey": "nl_NL",
        "propertyValue": "1561325316736"
    }
]

403 Forbidden

Example:

{
    "error": "Missing or invalid license"
}

Delete all user's language histories

DELETE /rest/fliplang/latest/all

Permission needed: Admin

Responses:

200 OK: Returns the number of deleted history entries

Example:

{
    "count": "6"
}

403 Forbidden

Example:

{
    "error": "Missing or invalid license"
}