com.box.boxjavalibv2.resourcemanagers

Class BoxCommentsManagerImpl

java.lang.Object

com.box.boxjavalibv2.resourcemanagers.AbstractBoxResourceManager

com.box.boxjavalibv2.resourcemanagers.BoxCommentsManagerImpl

All Implemented Interfaces:

IBoxCommentsManager, IBoxResourceManager

public final class BoxCommentsManagerImpl
extends AbstractBoxResourceManager
implements IBoxCommentsManager

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
BoxCommentsManagerImpl(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.
BoxComment	addComment(java.lang.String commentedItemId, IBoxType commentedItemType, java.lang.String message)
void	deleteComment(java.lang.String commentId, BoxDefaultRequestObject requestObject) Delete a comment.
BoxComment	getComment(java.lang.String commentId, BoxDefaultRequestObject requestObject) Get a comment, given a comment id.
static java.util.List<BoxComment>	getComments(BoxCollection collection) Deprecated.
BoxComment	updateComment(java.lang.String commentId, BoxCommentRequestObject requestObject) Update a comment.

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

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

BoxCommentsManagerImpl

public BoxCommentsManagerImpl(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

Description copied from interface: IBoxCommentsManager

Add a comment to an item.

Specified by:

addComment in interface IBoxCommentsManager

Parameters:

requestObject - comment request object.

Throws:

BoxRestException - See BoxRestException for more info.

BoxServerException - See com.box.restclientv2.exceptions.BoxServerException for more info.

AuthFatalFailureException - See com.box.restclientv2.exceptions.AuthFatalFailureException for more info.

addComment

public BoxComment addComment(java.lang.String commentedItemId,
                    IBoxType commentedItemType,
                    java.lang.String message)
                      throws BoxRestException,
                             BoxServerException,
                             AuthFatalFailureException

Specified by:

addComment in interface IBoxCommentsManager

Throws:

BoxRestException

BoxServerException

AuthFatalFailureException

getComment

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

Description copied from interface: IBoxCommentsManager

Get a comment, given a comment id.

Specified by:

getComment in interface IBoxCommentsManager

Parameters:

commentId - id of the comment

requestObject - object that goes into request.

Returns:

comment

Throws:

BoxRestException - See BoxRestException for more info.

BoxServerException - See com.box.restclientv2.exceptions.BoxServerException for more info.

AuthFatalFailureException - See com.box.restclientv2.exceptions.AuthFatalFailureException for more info.

updateComment

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

Description copied from interface: IBoxCommentsManager

Update a comment.

Specified by:

updateComment in interface IBoxCommentsManager

Parameters:

commentId - id of the comment

requestObject - comment request object.s

Returns:

comment

Throws:

BoxRestException - See BoxRestException for more info.

BoxServerException - See com.box.restclientv2.exceptions.BoxServerException for more info.

AuthFatalFailureException - See com.box.restclientv2.exceptions.AuthFatalFailureException for more info.

deleteComment

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

Description copied from interface: IBoxCommentsManager

Delete a comment.

Specified by:

deleteComment in interface IBoxCommentsManager

Parameters:

commentId - id of the comment

requestObject - object that goes into request.

Throws:

BoxRestException - See BoxRestException for more info.

BoxServerException - See com.box.restclientv2.exceptions.BoxServerException for more info.

AuthFatalFailureException - See com.box.restclientv2.exceptions.AuthFatalFailureException for more info.

getComments

@Deprecated
public static java.util.List<BoxComment> getComments(BoxCollection collection)

Deprecated.

Get comments from a collection. Deprecated, use Utils.getTypedObjects instead.

Parameters:

collection - collection

Returns:

comments