Class: Type

Type

new Type()

Type

Properties:
Name Type Description
connector IConnector

the jira connector instance

Source:

Methods

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

Returns the project type with the given key, if it is accessible to the logged in user. This takes into account whether the user is licensed on the Application that defines the project type.

Parameters:
Name Type Attributes Description
options Object

An object containing options to pass to the Jira API.

Properties
Name Type Description
projectTypeKey string

projectTypeKey

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>

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

Returns all the project types defined on the JIRA instance, not taking into account whether the license to use those project types is valid or not.

Parameters:
Name Type Attributes Description
options Object

An object containing options to pass to the Jira API.

Properties
Name Type Description
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>

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

Returns the project type with the given key.

Parameters:
Name Type Attributes Description
options Object

An object containing options to pass to the Jira API.

Properties
Name Type Description
projectTypeKey string

projectTypeKey

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>