Jira.js - Jira Cloud API library
    Preparing search index...

    Class JiraSettings

    Index

    Constructors

    constructor

    Methods

    getAdvancedSettings getApplicationProperty getConfiguration setApplicationProperty

    Constructors

    Methods

    • Changes the value of an application property. For example, you can change the value of the jira.clone.prefix from its default value of CLONE - to Clone - if you prefer sentence case capitalization. Editable properties are described below along with their default values.

      The advanced settings below are also accessible in Jira.

      Key Description Default value
      jira.clone.prefix The string of text prefixed to the title of a cloned issue. CLONE -
      jira.date.picker.java.format The date format for the Java (server-side) generated dates. This must be the same as the jira.date.picker.javascript.format format setting. d/MMM/yy
      jira.date.picker.javascript.format The date format for the JavaScript (client-side) generated dates. This must be the same as the jira.date.picker.java.format format setting. %e/%b/%y
      jira.date.time.picker.java.format The date format for the Java (server-side) generated date times. This must be the same as the jira.date.time.picker.javascript.format format setting. dd/MMM/yy h:mm a
      jira.date.time.picker.javascript.format The date format for the JavaScript (client-side) generated date times. This must be the same as the jira.date.time.picker.java.format format setting. %e/%b/%y %I:%M %p
      jira.issue.actions.order The default order of actions (such as Comments or Change history) displayed on the issue view. asc
      jira.view.issue.links.sort.order The sort order of the list of issue links on the issue view. type, status, priority
      jira.comment.collapsing.minimum.hidden The minimum number of comments required for comment collapsing to occur. A value of 0 disables comment collapsing. 4
      jira.newsletter.tip.delay.days The number of days before a prompt to sign up to the Jira Insiders newsletter is shown. A value of -1 disables this feature. 7

      The settings listed below adjust the look and feel.

      Key Description Default value
      jira.lf.date.time The time format. h:mm a
      jira.lf.date.day The day format. EEEE h:mm a
      jira.lf.date.complete The date and time format. dd/MMM/yy h:mm a
      jira.lf.date.dmy The date format. dd/MMM/yy
      jira.date.time.picker.use.iso8061 When enabled, sets Monday as the first day of the week in the date picker, as specified by the ISO8601 standard. false
      jira.lf.logo.url The URL of the logo image file. /images/icon-jira-logo.png
      jira.lf.logo.show.application.title Controls the visibility of the application title on the sidebar. false
      jira.lf.favicon.url The URL of the favicon. /favicon.ico
      jira.lf.favicon.hires.url The URL of the high-resolution favicon. /images/64jira.png
      jira.lf.navigation.bgcolour The background color of the sidebar. #0747A6
      jira.lf.navigation.highlightcolour The color of the text and logo of the sidebar. #DEEBFF
      jira.lf.hero.button.base.bg.colour The background color of the hero button. #3b7fc4
      jira.title The text for the application title. The application title can also be set in General settings. Jira
      jira.option.globalsharing Whether filters and dashboards can be shared with anyone signed into Jira. true
      xflow.product.suggestions.enabled Whether to expose product suggestions for other Atlassian products within Jira. true
      Key Description Default value
      jira.issuenav.criteria.autoupdate Whether instant updates to search criteria is active. true

      Note: Be careful when changing application properties and advanced settings.

      Permissions required: Administer Jira global permission.

      Type Parameters

      Parameters

      Returns Promise<void>

    • Changes the value of an application property. For example, you can change the value of the jira.clone.prefix from its default value of CLONE - to Clone - if you prefer sentence case capitalization. Editable properties are described below along with their default values.

      The advanced settings below are also accessible in Jira.

      Key Description Default value
      jira.clone.prefix The string of text prefixed to the title of a cloned issue. CLONE -
      jira.date.picker.java.format The date format for the Java (server-side) generated dates. This must be the same as the jira.date.picker.javascript.format format setting. d/MMM/yy
      jira.date.picker.javascript.format The date format for the JavaScript (client-side) generated dates. This must be the same as the jira.date.picker.java.format format setting. %e/%b/%y
      jira.date.time.picker.java.format The date format for the Java (server-side) generated date times. This must be the same as the jira.date.time.picker.javascript.format format setting. dd/MMM/yy h:mm a
      jira.date.time.picker.javascript.format The date format for the JavaScript (client-side) generated date times. This must be the same as the jira.date.time.picker.java.format format setting. %e/%b/%y %I:%M %p
      jira.issue.actions.order The default order of actions (such as Comments or Change history) displayed on the issue view. asc
      jira.view.issue.links.sort.order The sort order of the list of issue links on the issue view. type, status, priority
      jira.comment.collapsing.minimum.hidden The minimum number of comments required for comment collapsing to occur. A value of 0 disables comment collapsing. 4
      jira.newsletter.tip.delay.days The number of days before a prompt to sign up to the Jira Insiders newsletter is shown. A value of -1 disables this feature. 7

      The settings listed below adjust the look and feel.

      Key Description Default value
      jira.lf.date.time The time format. h:mm a
      jira.lf.date.day The day format. EEEE h:mm a
      jira.lf.date.complete The date and time format. dd/MMM/yy h:mm a
      jira.lf.date.dmy The date format. dd/MMM/yy
      jira.date.time.picker.use.iso8061 When enabled, sets Monday as the first day of the week in the date picker, as specified by the ISO8601 standard. false
      jira.lf.logo.url The URL of the logo image file. /images/icon-jira-logo.png
      jira.lf.logo.show.application.title Controls the visibility of the application title on the sidebar. false
      jira.lf.favicon.url The URL of the favicon. /favicon.ico
      jira.lf.favicon.hires.url The URL of the high-resolution favicon. /images/64jira.png
      jira.lf.navigation.bgcolour The background color of the sidebar. #0747A6
      jira.lf.navigation.highlightcolour The color of the text and logo of the sidebar. #DEEBFF
      jira.lf.hero.button.base.bg.colour The background color of the hero button. #3b7fc4
      jira.title The text for the application title. The application title can also be set in General settings. Jira
      jira.option.globalsharing Whether filters and dashboards can be shared with anyone signed into Jira. true
      xflow.product.suggestions.enabled Whether to expose product suggestions for other Atlassian products within Jira. true
      Key Description Default value
      jira.issuenav.criteria.autoupdate Whether instant updates to search criteria is active. true

      Note: Be careful when changing application properties and advanced settings.

      Permissions required: Administer Jira global permission.

      Type Parameters

      Parameters

      Returns Promise<T>

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods