Package org.azd.workitemtracking.comments

Class CommentsRequestBuilder

java.lang.Object

org.azd.abstractions.BaseRequestBuilder

org.azd.workitemtracking.comments.CommentsRequestBuilder

public class CommentsRequestBuilder
extends BaseRequestBuilder

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CommentsRequestBuilder.GetQueryParameters	Represents the query parameters.
static class	CommentsRequestBuilder.ListBatchQueryParameters	Represents the list query parameters.
static class	CommentsRequestBuilder.ListBatchRequestConfiguration	Request configuration object for the query parameters.
static class	CommentsRequestBuilder.ListQueryParameters	Represents the list query parameters.
static class	CommentsRequestBuilder.ListRequestConfiguration	Request configuration object for the query parameters.
static class	CommentsRequestBuilder.RequestConfiguration	Request configuration object for the query parameters.

Nested classes/interfaces inherited from class org.azd.abstractions.BaseRequestBuilder

BaseRequestBuilder.ProjectExcludeParameter

Field Summary

Fields inherited from class org.azd.abstractions.BaseRequestBuilder

accessTokenCredential, apiVersion, area, locationId, organizationUrl, serializer

Constructor Summary

Constructors

Constructor	Description
CommentsRequestBuilder(String organizationUrl, AccessTokenCredential accessTokenCredential)

Method Summary

Modifier and Type	Method	Description
Comment	add(String comment, int workItemId)	Add a comment on a work item.
Comment	add(String comment, int workItemId, CommentFormat format)	Add a comment on a work item.
CompletableFuture<Comment>	addAsync(String comment, int workItemId)	Add a comment on a work item.
CompletableFuture<Comment>	addAsync(String comment, int workItemId, CommentFormat format)	Add a comment on a work item.
Void	delete(int commentId, int workItemId)	Delete a comment on a work item.
CompletableFuture<Void>	deleteAsync(int commentId, int workItemId)	Delete a comment on a work item.
Comment	get(int commentId, int workItemId)	Returns a work item comment.
Comment	get(int commentId, int workItemId, Consumer<CommentsRequestBuilder.RequestConfiguration> requestConfiguration)	Returns a work item comment.
CompletableFuture<Comment>	getAsync(int commentId, int workItemId)	Returns a work item comment.
CompletableFuture<Comment>	getAsync(int commentId, int workItemId, Consumer<CommentsRequestBuilder.RequestConfiguration> requestConfiguration)	Returns a work item comment.
CommentList	list(int workItemId)	Returns a list of work item comments, pageable.
CommentList	list(int workItemId, Consumer<CommentsRequestBuilder.ListRequestConfiguration> requestConfiguration)	Returns a list of work item comments, pageable.
CompletableFuture<CommentList>	listAsync(int workItemId)	Returns a list of work item comments, pageable.
CompletableFuture<CommentList>	listAsync(int workItemId, Consumer<CommentsRequestBuilder.ListRequestConfiguration> requestConfiguration)	Returns a list of work item comments, pageable.
CommentList	listBatch(int workItemId, Consumer<CommentsRequestBuilder.ListBatchRequestConfiguration> requestConfiguration)	Returns a list of work item comments by ids.
CompletableFuture<CommentList>	listBatchAsync(int workItemId, Consumer<CommentsRequestBuilder.ListBatchRequestConfiguration> requestConfiguration)	Returns a list of work item comments by ids.
Comment	update(String comment, int commentId, int workItemId)	Update a comment on a work item.
Comment	update(String comment, int commentId, int workItemId, CommentFormat format)	Update a comment on a work item.
CompletableFuture<Comment>	updateAsync(String comment, int workItemId)	Update a comment on a work item.
CompletableFuture<Comment>	updateAsync(String comment, int workItemId, CommentFormat format)	Update a comment on a work item.

Methods inherited from class org.azd.abstractions.BaseRequestBuilder

builder

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

CommentsRequestBuilder

public CommentsRequestBuilder(String organizationUrl,
 AccessTokenCredential accessTokenCredential)

Method Details

addAsync

public CompletableFuture<Comment> addAsync(String comment,
 int workItemId)
                                    throws AzDException

Add a comment on a work item.

Parameters:

comment - Text of the comment.

workItemId - Id of a work item.

Returns:

Comment Object Comment

Throws:

AzDException - Default Api Exception handler.

addAsync

public CompletableFuture<Comment> addAsync(String comment,
 int workItemId,
 CommentFormat format)
                                    throws AzDException

Add a comment on a work item.

Parameters:

comment - Text of the comment.

workItemId - Id of a work item.

format - Format of a work item comment (Markdown or Html).

Returns:

Comment Object Comment

Throws:

AzDException - Default Api Exception handler.

getAsync

public CompletableFuture<Comment> getAsync(int commentId,
 int workItemId)
                                    throws AzDException

Returns a work item comment.

Parameters:

commentId - Id of the comment.

workItemId - Id of a work item.

Returns:

Comment Object Comment

Throws:

AzDException - Default Api Exception handler.

getAsync

public CompletableFuture<Comment> getAsync(int commentId,
 int workItemId,
 Consumer<CommentsRequestBuilder.RequestConfiguration> requestConfiguration)
                                    throws AzDException

Returns a work item comment.

Parameters:

commentId - Id of the comment.

workItemId - Id of a work item.

requestConfiguration - Represents the query parameters.

Returns:

Comment Object Comment

Throws:

AzDException - Default Api Exception handler.

listAsync

public CompletableFuture<CommentList> listAsync(int workItemId)
                                         throws AzDException

Returns a list of work item comments, pageable.

Parameters:

workItemId - Id of a work item.

Returns:

List of Comment Object CommentList

Throws:

AzDException - Default Api Exception handler.

listAsync

public CompletableFuture<CommentList> listAsync(int workItemId,
 Consumer<CommentsRequestBuilder.ListRequestConfiguration> requestConfiguration)
                                         throws AzDException

Returns a list of work item comments, pageable.

Parameters:

workItemId - Id of a work item.

requestConfiguration - Represents the query parameters.

Returns:

List of Comment Object CommentList

Throws:

AzDException - Default Api Exception handler.

listBatchAsync

public CompletableFuture<CommentList> listBatchAsync(int workItemId,
 Consumer<CommentsRequestBuilder.ListBatchRequestConfiguration> requestConfiguration)
                                              throws AzDException

Returns a list of work item comments by ids.

Parameters:

workItemId - Id of a work item.

requestConfiguration - Represents the query parameters.

Returns:

List of Comment Object CommentList

Throws:

AzDException - Default Api Exception handler.

deleteAsync

public CompletableFuture<Void> deleteAsync(int commentId,
 int workItemId)
                                    throws AzDException

Delete a comment on a work item.

Parameters:

commentId - Id of the comment.

workItemId - Id of a work item.

Throws:

AzDException - Default Api Exception handler.

updateAsync

public CompletableFuture<Comment> updateAsync(String comment,
 int workItemId)
                                       throws AzDException

Update a comment on a work item.

Parameters:

comment - Text of the comment.

workItemId - Id of a work item.

Returns:

Comment Object Comment

Throws:

AzDException - Default Api Exception handler.

updateAsync

public CompletableFuture<Comment> updateAsync(String comment,
 int workItemId,
 CommentFormat format)
                                       throws AzDException

Update a comment on a work item.

Parameters:

comment - Text of the comment.

workItemId - Id of a work item.

format - Format of a work item comment (Markdown or Html).

Returns:

Comment Object Comment

Throws:

AzDException - Default Api Exception handler.

add

public Comment add(String comment,
 int workItemId)
            throws AzDException

Add a comment on a work item.

Parameters:

comment - Text of the comment.

workItemId - Id of a work item.

Returns:

Comment Object Comment

Throws:

AzDException - Default Api Exception handler.

add

public Comment add(String comment,
 int workItemId,
 CommentFormat format)
            throws AzDException

Add a comment on a work item.

Parameters:

comment - Text of the comment.

workItemId - Id of a work item.

format - Format of a work item comment (Markdown or Html).

Returns:

Comment Object Comment

Throws:

AzDException - Default Api Exception handler.

get

public Comment get(int commentId,
 int workItemId)
            throws AzDException

Returns a work item comment.

Parameters:

commentId - Id of the comment.

workItemId - Id of a work item.

Returns:

Comment Object Comment

Throws:

AzDException - Default Api Exception handler.

get

public Comment get(int commentId,
 int workItemId,
 Consumer<CommentsRequestBuilder.RequestConfiguration> requestConfiguration)
            throws AzDException

Returns a work item comment.

Parameters:

commentId - Id of the comment.

workItemId - Id of a work item.

requestConfiguration - Represents the query parameters.

Returns:

Comment Object Comment

Throws:

AzDException - Default Api Exception handler.

list

public CommentList list(int workItemId)
                 throws AzDException

Returns a list of work item comments, pageable.

Parameters:

workItemId - Id of a work item.

Returns:

List of Comment Object CommentList

Throws:

AzDException - Default Api Exception handler.

list

public CommentList list(int workItemId,
 Consumer<CommentsRequestBuilder.ListRequestConfiguration> requestConfiguration)
                 throws AzDException

Returns a list of work item comments, pageable.

Parameters:

workItemId - Id of a work item.

requestConfiguration - Represents the query parameters.

Returns:

List of Comment Object CommentList

Throws:

AzDException - Default Api Exception handler.

listBatch

public CommentList listBatch(int workItemId,
 Consumer<CommentsRequestBuilder.ListBatchRequestConfiguration> requestConfiguration)
                      throws AzDException

Returns a list of work item comments by ids.

Parameters:

workItemId - Id of a work item.

requestConfiguration - Represents the query parameters.

Returns:

List of Comment Object CommentList

Throws:

AzDException - Default Api Exception handler.

delete

public Void delete(int commentId,
 int workItemId)
            throws AzDException

Delete a comment on a work item.

Parameters:

commentId - Id of the comment.

workItemId - Id of a work item.

Throws:

AzDException - Default Api Exception handler.

update

public Comment update(String comment,
 int commentId,
 int workItemId)
               throws AzDException

Update a comment on a work item.

Parameters:

comment - Text of the comment.

commentId - Id of the comment.

workItemId - Id of a work item.

Returns:

Comment Object Comment

Throws:

AzDException - Default Api Exception handler.

update

public Comment update(String comment,
 int commentId,
 int workItemId,
 CommentFormat format)
               throws AzDException

Update a comment on a work item.

Parameters:

comment - Text of the comment.

commentId - Id of the comment.

workItemId - Id of a work item.

format - Format of a work item comment (Markdown or Html).

Returns:

Comment Object Comment

Throws:

AzDException - Default Api Exception handler.