com.box.boxjavalibv2.resourcemanagers

Class BoxCommentsManager

java.lang.Object

com.box.boxjavalibv2.resourcemanagers.BoxResourceManager

com.box.boxjavalibv2.resourcemanagers.BoxCommentsManager

public final class BoxCommentsManager
extends BoxResourceManager

Use this class to execute requests synchronously against the Box REST API(V2), comments endpints. Full details about the Box API can be found at http://developers.box.com/docs . You must have an OpenBox application with a valid API key to use the Box API. All methods in this class are executed in the invoking thread, and therefore are NOT safe to execute in the UI thread of your application. You should only use this class if you already have worker threads or AsyncTasks that you want to incorporate the Box API into.

Constructor Summary

Constructors

Constructor and Description
BoxCommentsManager(IBoxConfig config, IBoxResourceHub resourceHub, IBoxJSONParser parser, IBoxRequestAuth auth, IBoxRESTClient restClient) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
BoxComment	addComment(BoxCommentRequestObject requestObject) Add a comment to an item.
void	deleteComment(String commentId, BoxDefaultRequestObject requestObject) Delete a comment.
BoxComment	getComment(String commentId, BoxDefaultRequestObject requestObject) Get a comment, given a comment id.
static List<BoxComment>	getComments(BoxCollection collection) Get comments from a collection.
BoxComment	updateComment(String commentId, BoxCommentRequestObject requestObject) Update a comment.

Methods inherited from class com.box.boxjavalibv2.resourcemanagers.BoxResourceManager

executeRequestWithNoResponseBody, getAuth, getClassFromType, getConfig, getJSONParser, getResourceHub, getResponseAndParse, getResponseAndParseAndTryCast, getRestClient, tryCastBoxItem, tryCastObject

Methods inherited from class java.lang.Object

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

Constructor Detail

BoxCommentsManager

public BoxCommentsManager(IBoxConfig config,
                  IBoxResourceHub resourceHub,
                  IBoxJSONParser parser,
                  IBoxRequestAuth auth,
                  IBoxRESTClient restClient)

Constructor.

Parameters:

config - Config

resourceHub - IResourceHub

parser - json parser

auth - auth for api calls

restClient - REST client to make api calls.

Method Detail

addComment

public BoxComment addComment(BoxCommentRequestObject requestObject)
                      throws BoxRestException,
                             BoxServerException,
                             AuthFatalFailureException

Add a comment to an item.

Parameters:

requestObject - comment request object.

Throws:

BoxRestException - exception

BoxServerException - exception

AuthFatalFailureException - exception indicating authentication totally failed

getComment

public BoxComment getComment(String commentId,
                    BoxDefaultRequestObject requestObject)
                      throws BoxRestException,
                             BoxServerException,
                             AuthFatalFailureException

Get a comment, given a comment id.

Parameters:

commentId - id of the comment

requestObject - object that goes into request.

Returns:

comment

Throws:

BoxRestException - exception

BoxServerException - exception

AuthFatalFailureException - exception indicating authentication totally failed

updateComment

public BoxComment updateComment(String commentId,
                       BoxCommentRequestObject requestObject)
                         throws BoxRestException,
                                BoxServerException,
                                AuthFatalFailureException

Update a comment.

Parameters:

commentId - id of the comment

requestObject - comment request object.s

Returns:

comment

Throws:

BoxRestException - exception

BoxServerException - exception

AuthFatalFailureException - exception indicating authentication totally failed

deleteComment

public void deleteComment(String commentId,
                 BoxDefaultRequestObject requestObject)
                   throws BoxRestException,
                          BoxServerException,
                          AuthFatalFailureException

Delete a comment.

Parameters:

commentId - id of the comment

requestObject - object that goes into request.

Throws:

BoxRestException - exception

BoxServerException - exception

AuthFatalFailureException - exception indicating authentication totally failed

getComments

public static List<BoxComment> getComments(BoxCollection collection)

Get comments from a collection.

Parameters:

collection - collection

Returns:

comments