Class IssueWatchers

Index

Constructors

constructor

Methods

addWatcher getIssueWatchers getIsWatchingIssueBulk removeWatcher

Constructors

constructor

new IssueWatchers(client: Client): Version3.IssueWatchers
Parameters
- client: Client
Returns Version3.IssueWatchers
- Defined in src/version3/issueWatchers.ts:8

Methods

addWatcher

addWatcher<T = void>(
parameters: Version3Parameters.AddWatcher,
callback: Callback<T>,
): Promise<void>
Adds a user as a watcher of an issue by passing the account ID of the user. For example, "5b10ac8d82e05b22cc7d4ef5". If no user is specified the calling user is added.

This operation requires the Allow users to watch issues option to be ON. This option is set in General configuration for Jira. See Configuring Jira application options for details.

Permissions required:
- Browse projects project permission for the project that the issue is in.
- If issue-level security is configured, issue-level security permission to view the issue.
- To add users other than themselves to the watchlist, Manage watcher list project permission for the project that the issue is in.
Type Parameters
- T = void
Parameters
- parameters: Version3Parameters.AddWatcher
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/issueWatchers.ts:133
addWatcher<T = void>(
parameters: Version3Parameters.AddWatcher,
callback?: undefined,
): Promise<T>
Adds a user as a watcher of an issue by passing the account ID of the user. For example, "5b10ac8d82e05b22cc7d4ef5". If no user is specified the calling user is added.

This operation requires the Allow users to watch issues option to be ON. This option is set in General configuration for Jira. See Configuring Jira application options for details.

Permissions required:
- Browse projects project permission for the project that the issue is in.
- If issue-level security is configured, issue-level security permission to view the issue.
- To add users other than themselves to the watchlist, Manage watcher list project permission for the project that the issue is in.
Type Parameters
- T = void
Parameters
- parameters: Version3Parameters.AddWatcher
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/issueWatchers.ts:151

getIssueWatchers

getIssueWatchers<T = Version3Models.Watchers>(
parameters: Version3Parameters.GetIssueWatchers,
callback: Callback<T>,
): Promise<void>
Returns the watchers for an issue.

This operation requires the Allow users to watch issues option to be ON. This option is set in General configuration for Jira. See Configuring Jira application options for details.

This operation can be accessed anonymously.

Permissions required:
- Browse projects project permission for the project that the issue is ini
- If issue-level security is configured, issue-level security permission to view the issue.
- To see details of users on the watchlist other than themselves, View voters and watchers project permission for the project that the issue is in.
Type Parameters
- T = Version3Models.Watchers
Parameters
- parameters: Version3Parameters.GetIssueWatchers
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/issueWatchers.ts:81
getIssueWatchers<T = Version3Models.Watchers>(
parameters: Version3Parameters.GetIssueWatchers,
callback?: undefined,
): Promise<T>
Returns the watchers for an issue.

This operation requires the Allow users to watch issues option to be ON. This option is set in General configuration for Jira. See Configuring Jira application options for details.

This operation can be accessed anonymously.

Permissions required:
- Browse projects project permission for the project that the issue is ini
- If issue-level security is configured, issue-level security permission to view the issue.
- To see details of users on the watchlist other than themselves, View voters and watchers project permission for the project that the issue is in.
Type Parameters
- T = Version3Models.Watchers
Parameters
- parameters: Version3Parameters.GetIssueWatchers
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/issueWatchers.ts:103

getIsWatchingIssueBulk

getIsWatchingIssueBulk<T = Version3Models.BulkIssueIsWatching>(
parameters: undefined | Version3Parameters.GetIsWatchingIssueBulk,
callback: Callback<T>,
): Promise<void>
Returns, for the user, details of the watched status of issues from a list. If an issue ID is invalid, the returned watched status is false.

This operation requires the Allow users to watch issues option to be ON. This option is set in General configuration for Jira. See Configuring Jira application options for details.

Permissions required:
- Browse projects project permission for the project that the issue is in
- If issue-level security is configured, issue-level security permission to view the issue.
Type Parameters
- T = Version3Models.BulkIssueIsWatching
Parameters
- parameters: undefined | Version3Parameters.GetIsWatchingIssueBulk
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/issueWatchers.ts:25
getIsWatchingIssueBulk<T = Version3Models.BulkIssueIsWatching>(
parameters?: Version3Parameters.GetIsWatchingIssueBulk,
callback?: undefined,
): Promise<T>
Returns, for the user, details of the watched status of issues from a list. If an issue ID is invalid, the returned watched status is false.

This operation requires the Allow users to watch issues option to be ON. This option is set in General configuration for Jira. See Configuring Jira application options for details.

Permissions required:
- Browse projects project permission for the project that the issue is in
- If issue-level security is configured, issue-level security permission to view the issue.
Type Parameters
- T = Version3Models.BulkIssueIsWatching
Parameters
- Optionalparameters: Version3Parameters.GetIsWatchingIssueBulk
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/issueWatchers.ts:44

removeWatcher

removeWatcher<T = void>(
parameters: Version3Parameters.RemoveWatcher,
callback: Callback<T>,
): Promise<void>
Deletes a user as a watcher of an issue.

This operation requires the Allow users to watch issues option to be ON. This option is set in General configuration for Jira. See Configuring Jira application options for details.

Permissions required:
- Browse projects project permission for the project that the issue is in.
- If issue-level security is configured, issue-level security permission to view the issue.
- To remove users other than themselves from the watchlist, Manage watcher list project permission for the project that the issue is in.
Type Parameters
- T = void
Parameters
- parameters: Version3Parameters.RemoveWatcher
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/issueWatchers.ts:181
removeWatcher<T = void>(
parameters: Version3Parameters.RemoveWatcher,
callback?: undefined,
): Promise<T>
Deletes a user as a watcher of an issue.

This operation requires the Allow users to watch issues option to be ON. This option is set in General configuration for Jira. See Configuring Jira application options for details.

Permissions required:
- Browse projects project permission for the project that the issue is in.
- If issue-level security is configured, issue-level security permission to view the issue.
- To remove users other than themselves from the watchlist, Manage watcher list project permission for the project that the issue is in.
Type Parameters
- T = void
Parameters
- parameters: Version3Parameters.RemoveWatcher
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/issueWatchers.ts:198

Class IssueWatchers

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns Version3.IssueWatchers

Methods

addWatcher

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getIssueWatchers

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getIsWatchingIssueBulk

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

removeWatcher

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

Settings

On This Page