Class: Groups

Groups

new Groups()

Groups REST endpoint for searching groups in a group picker

Properties:
Name Type Description
connector IConnector

the jira connector instance

Source:

Methods

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

Returns groups with substrings matching a given query. This is mainly for use with the group picker, so the returned groups contain html to be used as picker suggestions. The groups are also wrapped in a single response object that also contains a header for use in the picker, specifically Showing X of Y matching groups.

The number of groups returned is limited by the system property "jira.ajax.autocomplete.limit"

The groups will be unique and sorted.a String to match groups agains

Parameters:
Name Type Attributes Description
options Object

An object containing options to pass to the Jira API.

Properties
Name Type Description
query string

query a String to match groups agains

exclude string

exclude

maxResults string

maxResults

userName string

userName

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>