Class IssueVotes

Index

Constructors

constructor

Methods

addVote getVotes removeVote

Constructors

constructor

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

Methods

addVote

addVote<T = void>(
parameters: Version3Parameters.AddVote,
callback: Callback<T>,
): Promise<void>
Adds the user's vote to an issue. This is the equivalent of the user clicking Vote on an issue in Jira.

This operation requires the Allow users to vote on 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 = void
Parameters
- parameters: Version3Parameters.AddVote
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/issueVotes.ts:73
addVote<T = void>(
parameters: Version3Parameters.AddVote,
callback?: undefined,
): Promise<T>
Adds the user's vote to an issue. This is the equivalent of the user clicking Vote on an issue in Jira.

This operation requires the Allow users to vote on 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 = void
Parameters
- parameters: Version3Parameters.AddVote
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/issueVotes.ts:88

getVotes

getVotes<T = Version3Models.Votes>(
parameters: Version3Parameters.GetVotes,
callback: Callback<T>,
): Promise<void>
Returns details about the votes on an issue.

This operation requires the Allow users to vote on 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.
Note that users with the necessary permissions for this operation but without the View voters and watchers project permissions are not returned details in the voters field.
Type Parameters
- T = Version3Models.Votes
Parameters
- parameters: Version3Parameters.GetVotes
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/issueVotes.ts:29
getVotes<T = Version3Models.Votes>(
parameters: Version3Parameters.GetVotes,
callback?: undefined,
): Promise<T>
Returns details about the votes on an issue.

This operation requires the Allow users to vote on 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.
Note that users with the necessary permissions for this operation but without the View voters and watchers project permissions are not returned details in the voters field.
Type Parameters
- T = Version3Models.Votes
Parameters
- parameters: Version3Parameters.GetVotes
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/issueVotes.ts:49

removeVote

removeVote<T = void>(
parameters: Version3Parameters.RemoveVote,
callback: Callback<T>,
): Promise<void>
Deletes a user's vote from an issue. This is the equivalent of the user clicking Unvote on an issue in Jira.

This operation requires the Allow users to vote on 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 = void
Parameters
- parameters: Version3Parameters.RemoveVote
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/issueVotes.ts:115
removeVote<T = void>(
parameters: Version3Parameters.RemoveVote,
callback?: undefined,
): Promise<T>
Deletes a user's vote from an issue. This is the equivalent of the user clicking Unvote on an issue in Jira.

This operation requires the Allow users to vote on 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 = void
Parameters
- parameters: Version3Parameters.RemoveVote
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/issueVotes.ts:130

Class IssueVotes

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns Version3.IssueVotes

Methods

addVote

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getVotes

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

removeVote

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

Settings

On This Page