Class IssueComments

Index

Constructors

constructor

Methods

addComment deleteComment getComment getComments getCommentsByIds updateComment

Constructors

constructor

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

Methods

addComment

addComment<T = Version3Models.Comment>(
parameters: Version3Parameters.AddComment,
callback: Callback<T>,
): Promise<void>
Adds a comment to an issue.

This operation can be accessed anonymously.

Permissions required:
- Browse projects and Add comments project permission for the project that the issue containing the comment is in.
- If issue-level security is configured, issue-level security permission to view the issue.
Type Parameters
- T = Version3Models.Comment
Parameters
- parameters: Version3Parameters.AddComment
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/issueComments.ts:133
addComment<T = Version3Models.Comment>(
parameters: Version3Parameters.AddComment,
callback?: undefined,
): Promise<T>
Adds a comment to an issue.

This operation can be accessed anonymously.

Permissions required:
- Browse projects and Add comments project permission for the project that the issue containing the comment is in.
- If issue-level security is configured, issue-level security permission to view the issue.
Type Parameters
- T = Version3Models.Comment
Parameters
- parameters: Version3Parameters.AddComment
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/issueComments.ts:146

deleteComment

deleteComment<T = void>(
parameters: Version3Parameters.DeleteComment,
callback: Callback<T>,
): Promise<void>
Deletes a comment.

Permissions required:
- Browse projects project permission for the project that the issue containing the comment is in.
- If issue-level security is configured, issue-level security permission to view the issue.
- Delete all comments project permission to delete any comment or Delete own comments to delete comment created by the user,
- If the comment has visibility restrictions, the user belongs to the group or has the role visibility is restricted to.
Type Parameters
- T = void
Parameters
- parameters: Version3Parameters.DeleteComment
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/issueComments.ts:311
deleteComment<T = void>(
parameters: Version3Parameters.DeleteComment,
callback?: undefined,
): Promise<T>
Deletes a comment.

Permissions required:
- Browse projects project permission for the project that the issue containing the comment is in.
- If issue-level security is configured, issue-level security permission to view the issue.
- Delete all comments project permission to delete any comment or Delete own comments to delete comment created by the user,
- If the comment has visibility restrictions, the user belongs to the group or has the role visibility is restricted to.
Type Parameters
- T = void
Parameters
- parameters: Version3Parameters.DeleteComment
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/issueComments.ts:326

getComment

getComment<T = Version3Models.Comment>(
parameters: Version3Parameters.GetComment,
callback: Callback<T>,
): Promise<void>
Returns a comment.

This operation can be accessed anonymously.

Permissions required:
- Browse projects project permission for the project containing the comment.
- If issue-level security is configured, issue-level security permission to view the issue.
- If the comment has visibility restrictions, the user belongs to the group or has the role visibility is restricted to.
Type Parameters
- T = Version3Models.Comment
Parameters
- parameters: Version3Parameters.GetComment
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/issueComments.ts:200
getComment<T = Version3Models.Comment>(
parameters: Version3Parameters.GetComment,
callback?: undefined,
): Promise<T>
Returns a comment.

This operation can be accessed anonymously.

Permissions required:
- Browse projects project permission for the project containing the comment.
- If issue-level security is configured, issue-level security permission to view the issue.
- If the comment has visibility restrictions, the user belongs to the group or has the role visibility is restricted to.
Type Parameters
- T = Version3Models.Comment
Parameters
- parameters: Version3Parameters.GetComment
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/issueComments.ts:215

getComments

getComments<T = Version3Models.PageOfComments>(
parameters: string | Version3Parameters.GetComments,
callback: Callback<T>,
): Promise<void>
Returns all comments for an issue.

This operation can be accessed anonymously.

Permissions required: Comments are included in the response where the user has:
- Browse projects project permission for the project containing the comment.
- If issue-level security is configured, issue-level security permission to view the issue.
- If the comment has visibility restrictions, belongs to the group or has the role visibility is role visibility is restricted to.
Type Parameters
- T = Version3Models.PageOfComments
Parameters
- parameters: string | Version3Parameters.GetComments
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/issueComments.ts:78
getComments<T = Version3Models.PageOfComments>(
parameters: string | Version3Parameters.GetComments,
callback?: undefined,
): Promise<T>
Returns all comments for an issue.

This operation can be accessed anonymously.

Permissions required: Comments are included in the response where the user has:
- Browse projects project permission for the project containing the comment.
- If issue-level security is configured, issue-level security permission to view the issue.
- If the comment has visibility restrictions, belongs to the group or has the role visibility is role visibility is restricted to.
Type Parameters
- T = Version3Models.PageOfComments
Parameters
- parameters: string | Version3Parameters.GetComments
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/issueComments.ts:97

getCommentsByIds

getCommentsByIds<T = Version3Models.PageComment>(
parameters: Version3Parameters.GetCommentsByIds,
callback: Callback<T>,
): Promise<void>
Returns a paginated list of comments specified by a list of comment IDs.

This operation can be accessed anonymously.

Permissions required: Comments are returned where the user:
- Has Browse projects project permission for the project containing the comment.
- If issue-level security is configured, issue-level security permission to view the issue.
- If the comment has visibility restrictions, belongs to the group or has the role visibility is restricted to.
Type Parameters
- T = Version3Models.PageComment
Parameters
- parameters: Version3Parameters.GetCommentsByIds
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/issueComments.ts:25
getCommentsByIds<T = Version3Models.PageComment>(
parameters: Version3Parameters.GetCommentsByIds,
callback?: undefined,
): Promise<T>
Returns a paginated list of comments specified by a list of comment IDs.

This operation can be accessed anonymously.

Permissions required: Comments are returned where the user:
- Has Browse projects project permission for the project containing the comment.
- If issue-level security is configured, issue-level security permission to view the issue.
- If the comment has visibility restrictions, belongs to the group or has the role visibility is restricted to.
Type Parameters
- T = Version3Models.PageComment
Parameters
- parameters: Version3Parameters.GetCommentsByIds
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/issueComments.ts:44

updateComment

updateComment<T = Version3Models.Comment>(
parameters: Version3Parameters.UpdateComment,
callback: Callback<T>,
): Promise<void>
Updates a comment.

This operation can be accessed anonymously.

Permissions required:
- Browse projects project permission for the project that the issue containing the comment is in.
- If issue-level security is configured, issue-level security permission to view the issue.
- Edit all comments project permission to update any comment or Edit own comments to update comment created by the user.
- If the comment has visibility restrictions, the user belongs to the group or has the role visibility is restricted to.
Type Parameters
- T = Version3Models.Comment
Parameters
- parameters: Version3Parameters.UpdateComment
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/issueComments.ts:244
updateComment<T = Version3Models.Comment>(
parameters: Version3Parameters.UpdateComment,
callback?: undefined,
): Promise<T>
Updates a comment.

This operation can be accessed anonymously.

Permissions required:
- Browse projects project permission for the project that the issue containing the comment is in.
- If issue-level security is configured, issue-level security permission to view the issue.
- Edit all comments project permission to update any comment or Edit own comments to update comment created by the user.
- If the comment has visibility restrictions, the user belongs to the group or has the role visibility is restricted to.
Type Parameters
- T = Version3Models.Comment
Parameters
- parameters: Version3Parameters.UpdateComment
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/issueComments.ts:261

Class IssueComments

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns Version3.IssueComments

Methods

addComment

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

deleteComment

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getComment

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getComments

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getCommentsByIds

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

updateComment

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

Settings

On This Page