ChangeApi.CommentsRequest (Gerrit Review Plugin API Documentation)

java.lang.Object
- com.google.gerrit.extensions.api.changes.ChangeApi.CommentsRequest

Enclosing interface:: ChangeApi

public abstract static class ChangeApi.CommentsRequest
extends Object

Constructor Summary

Constructors
Constructor Description

CommentsRequest()

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`abstract Map<String,List<CommentInfo>>`	`get()`	Get all published comments on a change.
`abstract List<CommentInfo>`	`getAsList()`	Get all published comments on a change as a list.
`boolean`	`getContext()`
`ChangeApi.CommentsRequest`	`withContext()`
`ChangeApi.CommentsRequest`	`withContext(boolean enableContext)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - CommentsRequest
```
public CommentsRequest()
```
- Method Detail
  - get
```
public abstract Map<String,List<CommentInfo>> get()
                                                 throws RestApiException
```
    Get all published comments on a change.
    
    Returns:
    
    comments in a map keyed by path; comments have the revision field set to indicate their patch set.
    
    Throws:
    
    RestApiException
  - getAsList
```
public abstract List<CommentInfo> getAsList()
                                     throws RestApiException
```
    Get all published comments on a change as a list.
    
    Returns:
    
    comments as a list; comments have the revision field set to indicate their patch set.
    
    Throws:
    
    RestApiException
  - withContext
```
public ChangeApi.CommentsRequest withContext(boolean enableContext)
```
  - withContext
```
public ChangeApi.CommentsRequest withContext()
```
  - getContext
```
public boolean getContext()
```