Class IssueCommentProperties

Index

Constructors

constructor

Methods

deleteCommentProperty getCommentProperty getCommentPropertyKeys setCommentProperty

Constructors

constructor

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

Methods

deleteCommentProperty

deleteCommentProperty<T = void>(
parameters: Version3Parameters.DeleteCommentProperty,
callback: Callback<T>,
): Promise<void>
Deletes a comment property.

Permissions required: either of:
- Edit All Comments project permission to delete a property from any comment.
- Edit Own Comments project permission to delete a property from a comment created by the user.
Also, when the visibility of a comment is restricted to a role or group the user must be a member of that role or group.
Type Parameters
- T = void
Parameters
- parameters: Version3Parameters.DeleteCommentProperty
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/issueCommentProperties.ts:166
deleteCommentProperty<T = void>(
parameters: Version3Parameters.DeleteCommentProperty,
callback?: undefined,
): Promise<T>
Deletes a comment property.

Permissions required: either of:
- Edit All Comments project permission to delete a property from any comment.
- Edit Own Comments project permission to delete a property from a comment created by the user.
Also, when the visibility of a comment is restricted to a role or group the user must be a member of that role or group.
Type Parameters
- T = void
Parameters
- parameters: Version3Parameters.DeleteCommentProperty
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/issueCommentProperties.ts:184

getCommentProperty

getCommentProperty<T = Version3Models.EntityProperty>(
parameters: Version3Parameters.GetCommentProperty,
callback: Callback<T>,
): Promise<void>
Returns the value of a comment property.

This operation can be accessed anonymously.

Permissions required:
- Browse projects project permission for the project.
- 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.EntityProperty
Parameters
- parameters: Version3Parameters.GetCommentProperty
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/issueCommentProperties.ts:68
getCommentProperty<T = Version3Models.EntityProperty>(
parameters: Version3Parameters.GetCommentProperty,
callback?: undefined,
): Promise<T>
Returns the value of a comment property.

This operation can be accessed anonymously.

Permissions required:
- Browse projects project permission for the project.
- 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.EntityProperty
Parameters
- parameters: Version3Parameters.GetCommentProperty
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/issueCommentProperties.ts:84

getCommentPropertyKeys

getCommentPropertyKeys<T = Version3Models.PropertyKeys>(
parameters: string | Version3Parameters.GetCommentPropertyKeys,
callback: Callback<T>,
): Promise<void>
Returns the keys of all the properties of a comment.

This operation can be accessed anonymously.

Permissions required:
- Browse projects project permission for the project.
- 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.PropertyKeys
Parameters
- parameters: string | Version3Parameters.GetCommentPropertyKeys
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/issueCommentProperties.ts:22
getCommentPropertyKeys<T = Version3Models.PropertyKeys>(
parameters: string | Version3Parameters.GetCommentPropertyKeys,
callback?: undefined,
): Promise<T>
Returns the keys of all the properties of a comment.

This operation can be accessed anonymously.

Permissions required:
- Browse projects project permission for the project.
- 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.PropertyKeys
Parameters
- parameters: string | Version3Parameters.GetCommentPropertyKeys
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/issueCommentProperties.ts:38

setCommentProperty

setCommentProperty<T = unknown>(
parameters: Version3Parameters.SetCommentProperty,
callback: Callback<T>,
): Promise<void>
Creates or updates the value of a property for a comment. Use this resource to store custom data against a comment.

The value of the request body must be a valid, non-empty JSON blob. The maximum length is 32768 characters.

Permissions required: either of:
- Edit All Comments project permission to create or update the value of a property on any comment.
- Edit Own Comments project permission to create or update the value of a property on a comment created by the user.
Also, when the visibility of a comment is restricted to a role or group the user must be a member of that role or group.
Type Parameters
- T = unknown
Parameters
- parameters: Version3Parameters.SetCommentProperty
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/issueCommentProperties.ts:117
setCommentProperty<T = unknown>(
parameters: Version3Parameters.SetCommentProperty,
callback?: undefined,
): Promise<T>
Creates or updates the value of a property for a comment. Use this resource to store custom data against a comment.

The value of the request body must be a valid, non-empty JSON blob. The maximum length is 32768 characters.

Permissions required: either of:
- Edit All Comments project permission to create or update the value of a property on any comment.
- Edit Own Comments project permission to create or update the value of a property on a comment created by the user.
Also, when the visibility of a comment is restricted to a role or group the user must be a member of that role or group.
Type Parameters
- T = unknown
Parameters
- parameters: Version3Parameters.SetCommentProperty
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/issueCommentProperties.ts:138

Class IssueCommentProperties

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns Version3.IssueCommentProperties

Methods

deleteCommentProperty

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getCommentProperty

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getCommentPropertyKeys

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

setCommentProperty

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

Settings

On This Page