com.smartsheet.api.DiscussionResources Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of smartsheet-sdk-java Show documentation
Show all versions of smartsheet-sdk-java Show documentation
Library for connecting to Smartsheet Services
package com.smartsheet.api;
/*
* #[license]
* Smartsheet SDK for Java
* %%
* Copyright (C) 2014 Smartsheet
* %%
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
* %[license]
*/
import com.smartsheet.api.models.Comment;
/**
* This interface provides methods to access Discussion resources.
*
* Thread Safety: Implementation of this interface must be thread safe.
*/
public interface DiscussionResources {
/**
* Add a comment to a discussion.
*
* It mirrors to the following Smartsheet REST API method:
* POST /discussion/{discussionId}/comments
*
* @param id the discussion id
* @param comment the comment to add
* @return the created comment
* @throws IllegalArgumentException if any argument is null or empty string
* @throws InvalidRequestException if there is any problem with the REST API request
* @throws AuthorizationException if there is any problem with the REST API authorization (access token)
* @throws ResourceNotFoundException if the resource cannot be found
* @throws ServiceUnavailableException if the REST API service is not available (possibly due to rate limiting)
* @throws SmartsheetException if there is any other error during the operation
*/
public Comment addDiscussionComment(long id, Comment comment) throws SmartsheetException;
/**
* @deprecated As of release 2.0
* @return associated resources
*/
@Deprecated
public AssociatedAttachmentResources attachments();
/**
* Represents the DiscussionCommentResources.
* It will be initialized in constructor and will not change afterwards.
*
* @return comments object
*/
public DiscussionCommentResources comments();
}