com.box.sdkgen.managers.comments

Class CommentsManager

Object

CommentsManager

public class CommentsManager
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CommentsManager.Builder

Field Summary

Fields

Modifier and Type	Field and Description
Authentication	auth
NetworkSession	networkSession

Constructor Summary

Constructors

Modifier	Constructor and Description
	CommentsManager()
protected	CommentsManager(CommentsManager.Builder builder)

Method Summary

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.

Methods inherited from class Object

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

Field Detail

auth

public Authentication auth

networkSession

public NetworkSession networkSession

Constructor Detail

CommentsManager

public CommentsManager()

CommentsManager

protected CommentsManager(CommentsManager.Builder builder)

Method Detail

getFileComments

public Comments getFileComments(String fileId)

Retrieves a list of comments for a file.

Parameters:

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"

getFileComments

public Comments getFileComments(String fileId,
                                GetFileCommentsQueryParams queryParams)

Retrieves a list of comments for a file.

Parameters:

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 method

getFileComments

public Comments getFileComments(String fileId,
                                GetFileCommentsHeaders headers)

Retrieves a list of comments for a file.

Parameters:

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 method

getFileComments

public Comments getFileComments(String fileId,
                                GetFileCommentsQueryParams queryParams,
                                GetFileCommentsHeaders headers)

Retrieves a list of comments for a file.

Parameters:

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 method

headers - Headers of getFileComments method

getCommentById

public CommentFull getCommentById(String commentId)

Retrieves the message and metadata for a specific comment, as well as information on the user who created the comment.

Parameters:

commentId - The ID of the comment. Example: "12345"

getCommentById

public 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.

Parameters:

commentId - The ID of the comment. Example: "12345"

queryParams - Query parameters of getCommentById method

getCommentById

public 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.

Parameters:

commentId - The ID of the comment. Example: "12345"

headers - Headers of getCommentById method

getCommentById

public 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.

Parameters:

commentId - The ID of the comment. Example: "12345"

queryParams - Query parameters of getCommentById method

headers - Headers of getCommentById method

updateCommentById

public CommentFull updateCommentById(String commentId)

Update the message of a comment.

Parameters:

commentId - The ID of the comment. Example: "12345"

updateCommentById

public CommentFull updateCommentById(String commentId,
                                     UpdateCommentByIdRequestBody requestBody)

Update the message of a comment.

Parameters:

commentId - The ID of the comment. Example: "12345"

requestBody - Request body of updateCommentById method

updateCommentById

public CommentFull updateCommentById(String commentId,
                                     UpdateCommentByIdQueryParams queryParams)

Update the message of a comment.

Parameters:

commentId - The ID of the comment. Example: "12345"

queryParams - Query parameters of updateCommentById method

updateCommentById

public CommentFull updateCommentById(String commentId,
                                     UpdateCommentByIdRequestBody requestBody,
                                     UpdateCommentByIdQueryParams queryParams)

Update the message of a comment.

Parameters:

commentId - The ID of the comment. Example: "12345"

requestBody - Request body of updateCommentById method

queryParams - Query parameters of updateCommentById method

updateCommentById

public CommentFull updateCommentById(String commentId,
                                     UpdateCommentByIdHeaders headers)

Update the message of a comment.

Parameters:

commentId - The ID of the comment. Example: "12345"

headers - Headers of updateCommentById method

updateCommentById

public CommentFull updateCommentById(String commentId,
                                     UpdateCommentByIdRequestBody requestBody,
                                     UpdateCommentByIdHeaders headers)

Update the message of a comment.

Parameters:

commentId - The ID of the comment. Example: "12345"

requestBody - Request body of updateCommentById method

headers - Headers of updateCommentById method

updateCommentById

public CommentFull updateCommentById(String commentId,
                                     UpdateCommentByIdQueryParams queryParams,
                                     UpdateCommentByIdHeaders headers)

Update the message of a comment.

Parameters:

commentId - The ID of the comment. Example: "12345"

queryParams - Query parameters of updateCommentById method

headers - Headers of updateCommentById method

updateCommentById

public CommentFull updateCommentById(String commentId,
                                     UpdateCommentByIdRequestBody requestBody,
                                     UpdateCommentByIdQueryParams queryParams,
                                     UpdateCommentByIdHeaders headers)

Update the message of a comment.

Parameters:

commentId - The ID of the comment. Example: "12345"

requestBody - Request body of updateCommentById method

queryParams - Query parameters of updateCommentById method

headers - Headers of updateCommentById method

deleteCommentById

public void deleteCommentById(String commentId)

Permanently deletes a comment.

Parameters:

commentId - The ID of the comment. Example: "12345"

deleteCommentById

public void deleteCommentById(String commentId,
                              DeleteCommentByIdHeaders headers)

Permanently deletes a comment.

Parameters:

commentId - The ID of the comment. Example: "12345"

headers - Headers of deleteCommentById method

createComment

public CommentFull createComment(CreateCommentRequestBody requestBody)

Adds a comment by the user to a specific file, or as a reply to an other comment.

Parameters:

requestBody - Request body of createComment method

createComment

public CommentFull createComment(CreateCommentRequestBody requestBody,
                                 CreateCommentQueryParams queryParams)

Adds a comment by the user to a specific file, or as a reply to an other comment.

Parameters:

requestBody - Request body of createComment method

queryParams - Query parameters of createComment method

createComment

public CommentFull createComment(CreateCommentRequestBody requestBody,
                                 CreateCommentHeaders headers)

Adds a comment by the user to a specific file, or as a reply to an other comment.

Parameters:

requestBody - Request body of createComment method

headers - Headers of createComment method

createComment

public 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.

Parameters:

requestBody - Request body of createComment method

queryParams - Query parameters of createComment method

headers - Headers of createComment method

getAuth

public Authentication getAuth()

getNetworkSession

public NetworkSession getNetworkSession()