Class: Properties

Properties

new Properties()

Properties

Properties:
Name Type Description
connector IConnector

the jira connector instance

Source:

Methods

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

Removes the property from the user identified by the key or by the id. Ths user removing the property is required to have permissions to administer the user.key of the user whose property is to be removedusername of the user whose property is to be removed

Parameters:
Name Type Attributes Description
options Object

An object containing options to pass to the Jira API.

Properties
Name Type Description
propertyKey string

propertyKey

userKey string

userKey key of the user whose property is to be removed

username string

username username of the user whose property is to be removed

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>

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

Returns the keys of all properties for the user identified by the key or by the id.key of the user whose properties are to be returnedusername of the user whose properties are to be returned

Parameters:
Name Type Attributes Description
options Object

An object containing options to pass to the Jira API.

Properties
Name Type Description
userKey string

userKey key of the user whose properties are to be returned

username string

username username of the user whose properties are to be returned

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>

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

Returns the value of the property with a given key from the user identified by the key or by the id. The user who retrieves the property is required to have permissions to read the user.key of the user whose property is to be returnedusername of the user whose property is to be returned

Parameters:
Name Type Attributes Description
options Object

An object containing options to pass to the Jira API.

Properties
Name Type Description
propertyKey string

propertyKey

userKey string

userKey key of the user whose property is to be returned

username string

username username of the user whose property is to be returned

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>

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

Sets the value of the specified user's property.

You can use this resource to store a custom data against the user identified by the key or by the id. The user who stores the data is required to have permissions to administer the user. key of the user whose property is to be setusername of the user whose property is to be set

Parameters:
Name Type Attributes Description
options Object

An object containing options to pass to the Jira API.

Properties
Name Type Description
propertyKey string

propertyKey

userKey string

userKey key of the user whose property is to be set

username string

username username of the user whose property is to be set

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>