Class: Dashboard

Dashboard

new Dashboard()

Dashboard The /dashboard resource.

Properties:
Name Type Description
connector IConnector

the jira connector instance

Source:

Methods

findById(options, callbackopt) → {Promise.<any>}

Returns a single dashboard.

Parameters:
Name Type Attributes Description
options Object

An object containing options to pass to the Jira API.

Properties
Name Type Description
id string

id

token string

token The token to use for authentication. This token is supplied on a sucessful login. If not supplied, the default token (if set) is used

callback <optional>

if supplied, called with result of api call

Source:
Returns:

result of api call

Type
Promise.<any>

list(options, callbackopt) → {Promise.<any>}

Returns a list of all dashboards, optionally filtering them.an optional filter that is applied to the list of dashboards. Valid values include "favourite" for returning only favourite dashboards, and "my" for returning dashboards that are owned by the calling user.the index of the first dashboard to return (0-based). must be 0 or a multiple of maxResultsa hint as to the the maximum number of dashboards to return in each call. Note that the JIRA server reserves the right to impose a maxResults limit that is lower than the value that a client provides, dues to lack or resources or any other condition. When this happens, your results will be truncated. Callers should always check the returned maxResults to determine the value that is effectively being used.

Parameters:
Name Type Attributes Description
options Object

An object containing options to pass to the Jira API.

Properties
Name Type Description
filter"favourite""my" string

filter"favourite""my" an optional filter that is applied to the list of dashboards. Valid values include "favourite" for returning only favourite dashboards, and "my" for returning dashboards that are owned by the calling user.

startAtmaxResults string

startAtmaxResults the index of the first dashboard to return (0-based). must be 0 or a multiple of maxResults

maxResultsmaxResultsmaxResults string

maxResultsmaxResultsmaxResults a hint as to the the maximum number of dashboards to return in each call. Note that the JIRA server reserves the right to impose a maxResults limit that is lower than the value that a client provides, dues to lack or resources or any other condition. When this happens, your results will be truncated. Callers should always check the returned maxResults to determine the value that is effectively being used.

token string

token The token to use for authentication. This token is supplied on a sucessful login. If not supplied, the default token (if set) is used

callback <optional>

if supplied, called with result of api call

Source:
Returns:

result of api call

Type
Promise.<any>