Class: MyPreferencesClient

MyPreferencesClient(jiraClient)

new MyPreferencesClient(jiraClient)

Used to access Jira REST endpoints in '/rest/api/2/mypreferences'

Parameters:
Name Type Description
jiraClient JiraClient
Source:

Methods

deletePreference(opts, callbackopt) → {Promise}

Removes preference of the currently logged in user. Preference key must be provided as input parameters (key).

Parameters:
Name Type Attributes Description
opts

The request options send to the Jira API.

Properties
Name Type Description
key

Key of the preference to be deleted.
callback <optional>

Called when the preference has been deleted.
Source:
Returns:

Resolved when the preference has been deleted.

Type
Promise

editPreference(opts, callbackopt) → {Promise}

Sets preference of the currently logged in user. Preference key must be provided as input parameters (key).

Parameters:
Name Type Attributes Description
opts

The request options send to the Jira API.

Properties
Name Type Description
key

Key of the preference to be edited.
value

The new value to set for the preference.
callback <optional>

Called when the preference has been edited.
Source:
Returns:

Resolved when the preference has been edited.

Type
Promise

getPreference(opts, callbackopt) → {Promise}

Gets preference of the currently logged in user. Preference key must be provided as input parameter (key). The value is returned exactly as it is.

Parameters:
Name Type Attributes Description
opts

The request options send to the Jira API.

Properties
Name Type Description
key

Key of the preference to be returned.
callback <optional>

Called when the preference has been retrieved.
Source:
Returns:

Resolved when the preference has been retrieved.

Type
Promise