Class: Role

Role

new Role()

Role

Properties:
Name Type Description
connector IConnector

the jira connector instance

Source:

Methods

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

Adds default actors to the given role. The request data should contain a list of usernames or a list of groups to add.

Parameters:
Name Type Attributes Description
options Object

An object containing options to pass to the Jira API.

Properties
Name Type Description
id string

id

user string

user

group string

group

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>

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

Creates a new ProjectRole to be available in JIRA. The created role does not have any default actors assigned.

Parameters:
Name Type Attributes Description
options Object

An object containing options to pass to the Jira API.

Properties
Name Type Description
description string

description

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>

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

Deletes a role. May return 403 in the futureif given, removes a role even if it is used in scheme by replacing the role with the given one

Parameters:
Name Type Attributes Description
options Object

An object containing options to pass to the Jira API.

Properties
Name Type Description
id string

id

swap string

swap if given, removes a role even if it is used in scheme by replacing the role with the given one

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>

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

Removes default actor from the given role.if given, removes an actor from given roleif given, removes an actor from given role

Parameters:
Name Type Attributes Description
options Object

An object containing options to pass to the Jira API.

Properties
Name Type Description
id string

id

user string

user if given, removes an actor from given role

group string

group if given, removes an actor from given role

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>

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

Fully updates a roles. Both name and description must be given.

Parameters:
Name Type Attributes Description
options Object

An object containing options to pass to the Jira API.

Properties
Name Type Description
id string

id

description string

description

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>

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

Gets default actors for the given role.

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>

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

Get all the ProjectRoles available in JIRA. Currently this list is global.

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>

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

Get a specific ProjectRole available in JIRA.

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>

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

Partially updates a roles name or description.

Parameters:
Name Type Attributes Description
options Object

An object containing options to pass to the Jira API.

Properties
Name Type Description
id string

id

description string

description

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>