public class CommentsManager extends Object
| Modifier and Type | Class and Description |
|---|---|
static class |
CommentsManager.Builder |
| Modifier and Type | Field and Description |
|---|---|
Authentication |
auth |
NetworkSession |
networkSession |
| Modifier | Constructor and Description |
|---|---|
|
CommentsManager() |
protected |
CommentsManager(CommentsManager.Builder builder) |
| Modifier and Type | Method and Description |
|---|---|
CommentFull |
createComment(CreateCommentRequestBody requestBody)
Adds a comment by the user to a specific file, or as a reply to an other comment.
|
CommentFull |
createComment(CreateCommentRequestBody requestBody,
CreateCommentHeaders headers)
Adds a comment by the user to a specific file, or as a reply to an other comment.
|
CommentFull |
createComment(CreateCommentRequestBody requestBody,
CreateCommentQueryParams queryParams)
Adds a comment by the user to a specific file, or as a reply to an other comment.
|
CommentFull |
createComment(CreateCommentRequestBody requestBody,
CreateCommentQueryParams queryParams,
CreateCommentHeaders headers)
Adds a comment by the user to a specific file, or as a reply to an other comment.
|
void |
deleteCommentById(String commentId)
Permanently deletes a comment.
|
void |
deleteCommentById(String commentId,
DeleteCommentByIdHeaders headers)
Permanently deletes a comment.
|
Authentication |
getAuth() |
CommentFull |
getCommentById(String commentId)
Retrieves the message and metadata for a specific comment, as well as information on the user
who created the comment.
|
CommentFull |
getCommentById(String commentId,
GetCommentByIdHeaders headers)
Retrieves the message and metadata for a specific comment, as well as information on the user
who created the comment.
|
CommentFull |
getCommentById(String commentId,
GetCommentByIdQueryParams queryParams)
Retrieves the message and metadata for a specific comment, as well as information on the user
who created the comment.
|
CommentFull |
getCommentById(String commentId,
GetCommentByIdQueryParams queryParams,
GetCommentByIdHeaders headers)
Retrieves the message and metadata for a specific comment, as well as information on the user
who created the comment.
|
Comments |
getFileComments(String fileId)
Retrieves a list of comments for a file.
|
Comments |
getFileComments(String fileId,
GetFileCommentsHeaders headers)
Retrieves a list of comments for a file.
|
Comments |
getFileComments(String fileId,
GetFileCommentsQueryParams queryParams)
Retrieves a list of comments for a file.
|
Comments |
getFileComments(String fileId,
GetFileCommentsQueryParams queryParams,
GetFileCommentsHeaders headers)
Retrieves a list of comments for a file.
|
NetworkSession |
getNetworkSession() |
CommentFull |
updateCommentById(String commentId)
Update the message of a comment.
|
CommentFull |
updateCommentById(String commentId,
UpdateCommentByIdHeaders headers)
Update the message of a comment.
|
CommentFull |
updateCommentById(String commentId,
UpdateCommentByIdQueryParams queryParams)
Update the message of a comment.
|
CommentFull |
updateCommentById(String commentId,
UpdateCommentByIdQueryParams queryParams,
UpdateCommentByIdHeaders headers)
Update the message of a comment.
|
CommentFull |
updateCommentById(String commentId,
UpdateCommentByIdRequestBody requestBody)
Update the message of a comment.
|
CommentFull |
updateCommentById(String commentId,
UpdateCommentByIdRequestBody requestBody,
UpdateCommentByIdHeaders headers)
Update the message of a comment.
|
CommentFull |
updateCommentById(String commentId,
UpdateCommentByIdRequestBody requestBody,
UpdateCommentByIdQueryParams queryParams)
Update the message of a comment.
|
CommentFull |
updateCommentById(String commentId,
UpdateCommentByIdRequestBody requestBody,
UpdateCommentByIdQueryParams queryParams,
UpdateCommentByIdHeaders headers)
Update the message of a comment.
|
public Authentication auth
public NetworkSession networkSession
public CommentsManager()
protected CommentsManager(CommentsManager.Builder builder)
public Comments getFileComments(String fileId)
fileId - The unique identifier that represents a file.
The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`. Example: "12345"
public Comments getFileComments(String fileId, GetFileCommentsQueryParams queryParams)
fileId - The unique identifier that represents a file.
The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`. Example: "12345"
queryParams - Query parameters of getFileComments methodpublic Comments getFileComments(String fileId, GetFileCommentsHeaders headers)
fileId - The unique identifier that represents a file.
The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`. Example: "12345"
headers - Headers of getFileComments methodpublic Comments getFileComments(String fileId, GetFileCommentsQueryParams queryParams, GetFileCommentsHeaders headers)
fileId - The unique identifier that represents a file.
The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/files/123` the `file_id` is `123`. Example: "12345"
queryParams - Query parameters of getFileComments methodheaders - Headers of getFileComments methodpublic CommentFull getCommentById(String commentId)
commentId - The ID of the comment. Example: "12345"public CommentFull getCommentById(String commentId, GetCommentByIdQueryParams queryParams)
commentId - The ID of the comment. Example: "12345"queryParams - Query parameters of getCommentById methodpublic CommentFull getCommentById(String commentId, GetCommentByIdHeaders headers)
commentId - The ID of the comment. Example: "12345"headers - Headers of getCommentById methodpublic CommentFull getCommentById(String commentId, GetCommentByIdQueryParams queryParams, GetCommentByIdHeaders headers)
commentId - The ID of the comment. Example: "12345"queryParams - Query parameters of getCommentById methodheaders - Headers of getCommentById methodpublic CommentFull updateCommentById(String commentId)
commentId - The ID of the comment. Example: "12345"public CommentFull updateCommentById(String commentId, UpdateCommentByIdRequestBody requestBody)
commentId - The ID of the comment. Example: "12345"requestBody - Request body of updateCommentById methodpublic CommentFull updateCommentById(String commentId, UpdateCommentByIdQueryParams queryParams)
commentId - The ID of the comment. Example: "12345"queryParams - Query parameters of updateCommentById methodpublic CommentFull updateCommentById(String commentId, UpdateCommentByIdRequestBody requestBody, UpdateCommentByIdQueryParams queryParams)
commentId - The ID of the comment. Example: "12345"requestBody - Request body of updateCommentById methodqueryParams - Query parameters of updateCommentById methodpublic CommentFull updateCommentById(String commentId, UpdateCommentByIdHeaders headers)
commentId - The ID of the comment. Example: "12345"headers - Headers of updateCommentById methodpublic CommentFull updateCommentById(String commentId, UpdateCommentByIdRequestBody requestBody, UpdateCommentByIdHeaders headers)
commentId - The ID of the comment. Example: "12345"requestBody - Request body of updateCommentById methodheaders - Headers of updateCommentById methodpublic CommentFull updateCommentById(String commentId, UpdateCommentByIdQueryParams queryParams, UpdateCommentByIdHeaders headers)
commentId - The ID of the comment. Example: "12345"queryParams - Query parameters of updateCommentById methodheaders - Headers of updateCommentById methodpublic CommentFull updateCommentById(String commentId, UpdateCommentByIdRequestBody requestBody, UpdateCommentByIdQueryParams queryParams, UpdateCommentByIdHeaders headers)
commentId - The ID of the comment. Example: "12345"requestBody - Request body of updateCommentById methodqueryParams - Query parameters of updateCommentById methodheaders - Headers of updateCommentById methodpublic void deleteCommentById(String commentId)
commentId - The ID of the comment. Example: "12345"public void deleteCommentById(String commentId, DeleteCommentByIdHeaders headers)
commentId - The ID of the comment. Example: "12345"headers - Headers of deleteCommentById methodpublic CommentFull createComment(CreateCommentRequestBody requestBody)
requestBody - Request body of createComment methodpublic CommentFull createComment(CreateCommentRequestBody requestBody, CreateCommentQueryParams queryParams)
requestBody - Request body of createComment methodqueryParams - Query parameters of createComment methodpublic CommentFull createComment(CreateCommentRequestBody requestBody, CreateCommentHeaders headers)
requestBody - Request body of createComment methodheaders - Headers of createComment methodpublic CommentFull createComment(CreateCommentRequestBody requestBody, CreateCommentQueryParams queryParams, CreateCommentHeaders headers)
requestBody - Request body of createComment methodqueryParams - Query parameters of createComment methodheaders - Headers of createComment methodpublic Authentication getAuth()
public NetworkSession getNetworkSession()