Class: Screens

Screens

new Screens()

Screens

Properties:
Name Type Description
connector IConnector

the jira connector instance

Source:

Methods

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

Adds field to the given tab.

Parameters:
Name Type Attributes Description
options Object

An object containing options to pass to the Jira API.

Properties
Name Type Description
screenId string

screenId

tabId string

tabId

fieldId string

fieldId

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>

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

Adds field or custom field to the default tab

Parameters:
Name Type Attributes Description
options Object

An object containing options to pass to the Jira API.

Properties
Name Type Description
fieldId string

fieldId

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>

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

Creates tab for given screen

Parameters:
Name Type Attributes Description
options Object

An object containing options to pass to the Jira API.

Properties
Name Type Description
screenId string

screenId

id string

id

name string

name

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>

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

Deletes tab to give screen

Parameters:
Name Type Attributes Description
options Object

An object containing options to pass to the Jira API.

Properties
Name Type Description
screenId string

screenId

tabId string

tabId

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>

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

Gets all fields for a given tabthe key of the project; this parameter is optional

Parameters:
Name Type Attributes Description
options Object

An object containing options to pass to the Jira API.

Properties
Name Type Description
screenId string

screenId

tabId string

tabId

projectKey string

projectKey the key of the project; this parameter is optional

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>

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

Returns a list of all tabs for the given screenthe key of the project; this parameter is optional

Parameters:
Name Type Attributes Description
options Object

An object containing options to pass to the Jira API.

Properties
Name Type Description
screenId string

screenId

projectKey string

projectKey the key of the project; this parameter is optional

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>

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

Gets available fields for screen. i.e ones that haven't already been added.

Parameters:
Name Type Attributes Description
options Object

An object containing options to pass to the Jira API.

Properties
Name Type Description
screenId string

screenId

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>

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

Moves field on the given tab

Parameters:
Name Type Attributes Description
options Object

An object containing options to pass to the Jira API.

Properties
Name Type Description
screenId string

screenId

tabId string

tabId

id string

id

after string

after

position string

position

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>

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

Moves tab position

Parameters:
Name Type Attributes Description
options Object

An object containing options to pass to the Jira API.

Properties
Name Type Description
screenId string

screenId

tabId string

tabId

pos string

pos

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>

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

Removes field from given tab

Parameters:
Name Type Attributes Description
options Object

An object containing options to pass to the Jira API.

Properties
Name Type Description
screenId string

screenId

tabId string

tabId

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>

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

Renames tab on given screen

Parameters:
Name Type Attributes Description
options Object

An object containing options to pass to the Jira API.

Properties
Name Type Description
screenId string

screenId

tabId string

tabId

id string

id

name string

name

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>