com.docusign.esign.api

Class CommentsApi

java.lang.Object

com.docusign.esign.api.CommentsApi

public class CommentsApi
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	CommentsApi.GetCommentsTranscriptOptions

Constructor Summary

Constructors

Constructor and Description
CommentsApi()
CommentsApi(ApiClient apiClient)

Method Summary

Methods

Modifier and Type	Method and Description
CommentHistoryResult	createEnvelopeComments(String accountId, String envelopeId, CommentsPublish commentsPublish) Posts a list of comments for authorized user
ApiClient	getApiClient()
byte[]	getCommentsTranscript(String accountId, String envelopeId) Gets comment transcript for envelope and user
byte[]	getCommentsTranscript(String accountId, String envelopeId, CommentsApi.GetCommentsTranscriptOptions options) Gets comment transcript for envelope and user
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

CommentsApi

public CommentsApi()

CommentsApi

public CommentsApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

createEnvelopeComments

public CommentHistoryResult createEnvelopeComments(String accountId,
                                          String envelopeId,
                                          CommentsPublish commentsPublish)
                                            throws ApiException

Posts a list of comments for authorized user

Parameters:

accountId - The external account number (int) or account ID Guid. (required)

envelopeId - The envelopeId Guid of the envelope being accessed. (required)

commentsPublish - (optional)

Returns:

CommentHistoryResult

Throws:

ApiException - if fails to make API call

getCommentsTranscript

public byte[] getCommentsTranscript(String accountId,
                           String envelopeId)
                             throws ApiException

Gets comment transcript for envelope and user

Parameters:

accountId - The external account number (int) or account ID Guid. (required)

envelopeId - The envelopeId Guid of the envelope being accessed. (required)

Returns:

byte[]

Throws:

ApiException

getCommentsTranscript

public byte[] getCommentsTranscript(String accountId,
                           String envelopeId,
                           CommentsApi.GetCommentsTranscriptOptions options)
                             throws ApiException

Gets comment transcript for envelope and user

Parameters:

accountId - The external account number (int) or account ID Guid. (required)

envelopeId - The envelopeId Guid of the envelope being accessed. (required)

options - for modifying the method behavior.

Returns:

byte[]

Throws:

ApiException - if fails to make API call