Package com.logicaldoc.gui.frontend.client.services

Interface DocuSignService

All Superinterfaces:
com.google.gwt.user.client.rpc.RemoteService
@RemoteServiceRelativePath("docusign") public interface DocuSignService extends com.google.gwt.user.client.rpc.RemoteService
The client side stub for the DocuSign Service.
Since:
8.5
Author:
Marco Meschieri - LogicalDOC

  • Method Details

    • loadSettings

      GUIDocuSignSettings loadSettings() throws ServerException
      Retrieves the DocuSign settings from the server.
      Returns:
      the DocuSign settings
      Throws:
      ServerException - an error happened in the server application

    • authorize

      String authorize(GUIDocuSignSettings settings) throws ServerException
      Saves the settings into the database and returns the authorization URL the user must be redirected to.
      Parameters:
      settings - The settings to save in the user's profile
      Returns:
      the authorization URL
      Throws:
      ServerException - an error happened in the server application

    • isAuthorized

      boolean isAuthorized() throws ServerException
      Checks if the current user is authorized to interact with DocuSign
      Returns:
      if you are authorized
      Throws:
      ServerException - an error happened in the server application

    • getSigners

      Collection<String> getSigners(String envelopeId) throws ServerException
      Retrieves the list of signers of a given envelope
      Parameters:
      envelopeId - identifier of the envelope
      Returns:
      the list of signer e-mails
      Throws:
      ServerException - an error happened in the server application

    • validateEnvelope

      Collection<GUIDocument> validateEnvelope(Collection<Long> docIds) throws ServerException
      Checks if a collection of document can be put into an envelope, that is if all of them define the docusign tabs annotations.
      Parameters:
      docIds - identifiers of the documents contained in the envelope
      Returns:
      the list of documents that are not admitted
      Throws:
      ServerException - an error happened in the server application

    • sendEnvelope

      String sendEnvelope(GUIDocuSignSettings envelope) throws ServerException
      Creates the envelope and sends it to DocuSign
      Parameters:
      envelope - the envelope's details
      Returns:
      the identifier of the new envelope
      Throws:
      ServerException - an error happened in the server application