Constructors

Properties

client: Client

Methods

  • Returns the locale for the user.

    If the user has no language preference set (which is the default setting) or this resource is accessed anonymous, the browser locale detected by Jira is returned. Jira detects the browser locale using the Accept-Language header in the request. However, if this doesn't match a locale available Jira, the site default locale is returned.

    This operation can be accessed anonymously.

    Permissions required: None.

    Type Parameters

    Parameters

    Returns Promise<void>

  • Returns the locale for the user.

    If the user has no language preference set (which is the default setting) or this resource is accessed anonymous, the browser locale detected by Jira is returned. Jira detects the browser locale using the Accept-Language header in the request. However, if this doesn't match a locale available Jira, the site default locale is returned.

    This operation can be accessed anonymously.

    Permissions required: None.

    Type Parameters

    Parameters

    • Optional callback: undefined

    Returns Promise<T>

  • Returns the value of a preference of the current user.

    Note that these keys are deprecated:

    • jira.user.locale The locale of the user. By default this is not set and the user takes the locale of the instance.
    • jira.user.timezone The time zone of the user. By default this is not set and the user takes the timezone of the instance.

    Use Update a user profile from the user management REST API to manage timezone and locale instead.

    Permissions required: Permission to access Jira.

    Type Parameters

    • T = string

    Parameters

    Returns Promise<void>

  • Returns the value of a preference of the current user.

    Note that these keys are deprecated:

    • jira.user.locale The locale of the user. By default this is not set and the user takes the locale of the instance.
    • jira.user.timezone The time zone of the user. By default this is not set and the user takes the timezone of the instance.

    Use Update a user profile from the user management REST API to manage timezone and locale instead.

    Permissions required: Permission to access Jira.

    Type Parameters

    • T = string

    Parameters

    Returns Promise<T>

  • Deletes a preference of the user, which restores the default value of system defined settings.

    Note that these keys are deprecated:

    • jira.user.locale The locale of the user. By default, not set. The user takes the instance locale.
    • jira.user.timezone The time zone of the user. By default, not set. The user takes the instance timezone.

    Use Update a user profile from the user management REST API to manage timezone and locale instead.

    Permissions required: Permission to access Jira.

    Type Parameters

    • T = void

    Parameters

    Returns Promise<void>

  • Deletes a preference of the user, which restores the default value of system defined settings.

    Note that these keys are deprecated:

    • jira.user.locale The locale of the user. By default, not set. The user takes the instance locale.
    • jira.user.timezone The time zone of the user. By default, not set. The user takes the instance timezone.

    Use Update a user profile from the user management REST API to manage timezone and locale instead.

    Permissions required: Permission to access Jira.

    Type Parameters

    • T = void

    Parameters

    Returns Promise<T>

  • Creates a preference for the user or updates a preference's value by sending a plain text string. For example, false. An arbitrary preference can be created with the value containing up to 255 characters. In addition, the following keys define system preferences that can be set or created:

    • user.notifications.mimetype The mime type used in notifications sent to the user. Defaults to html.
    • user.notify.own.changes Whether the user gets notified of their own changes. Defaults to false.
    • user.default.share.private Whether new filters are set to private. Defaults to true.
    • user.keyboard.shortcuts.disabled Whether keyboard shortcuts are disabled. Defaults to false.
    • user.autowatch.disabled Whether the user automatically watches issues they create or add a comment to. By default, not set: the user takes the instance autowatch setting.

    Note that these keys are deprecated:

    • jira.user.locale The locale of the user. By default, not set. The user takes the instance locale.
    • jira.user.timezone The time zone of the user. By default, not set. The user takes the instance timezone.

    Use Update a user profile from the user management REST API to manage timezone and locale instead.

    Permissions required: Permission to access Jira.

    Type Parameters

    • T = void

    Parameters

    Returns Promise<void>

  • Creates a preference for the user or updates a preference's value by sending a plain text string. For example, false. An arbitrary preference can be created with the value containing up to 255 characters. In addition, the following keys define system preferences that can be set or created:

    • user.notifications.mimetype The mime type used in notifications sent to the user. Defaults to html.
    • user.notify.own.changes Whether the user gets notified of their own changes. Defaults to false.
    • user.default.share.private Whether new filters are set to private. Defaults to true.
    • user.keyboard.shortcuts.disabled Whether keyboard shortcuts are disabled. Defaults to false.
    • user.autowatch.disabled Whether the user automatically watches issues they create or add a comment to. By default, not set: the user takes the instance autowatch setting.

    Note that these keys are deprecated:

    • jira.user.locale The locale of the user. By default, not set. The user takes the instance locale.
    • jira.user.timezone The time zone of the user. By default, not set. The user takes the instance timezone.

    Use Update a user profile from the user management REST API to manage timezone and locale instead.

    Permissions required: Permission to access Jira.

    Type Parameters

    • T = void

    Parameters

    Returns Promise<T>