Interface SharedDocumentsApi

All Known Implementing Classes:
ApiServiceImpl

public interface SharedDocumentsApi
  • Method Details

    • getShareDocumentsRequestState

      ShareDocumentsRequestState getShareDocumentsRequestState(SenderId senderId, UUID shareDocumentsRequestUuid)
      Gets the current state for an existing ShareDocumentsRequest. If no documents have been shared, the state contains no documents or relevant timestamps. If documents have been shared, the content of each document is available through the use of the corresponding links.
      Parameters:
      shareDocumentsRequestUuid - The UUID of the primary document of the original ShareDocumentsRequest message
      Returns:
      the state
    • getSharedDocumentContentStream

      InputStream getSharedDocumentContentStream(URI uri)
      Gets the content of a specific document as a stream of bytes.
      Parameters:
      uri - The URI of the SharedDocument returned as part of the ShareDocumentsRequestState
      Returns:
      the shared document content as stream
    • getSharedDocumentContent

      SharedDocumentContent getSharedDocumentContent(URI uri)
      Gets the content of a specific document as a link to view on Digipost's domain.
      Parameters:
      uri - The URI of the SharedDocument returned as part of the ShareDocumentsRequestState
      Returns:
      the shared document content with url
    • stopSharing

      org.apache.http.client.methods.CloseableHttpResponse stopSharing(SenderId senderId, URI uri)
      Stops the sharing, after which you will no longer have access to the shared documents
      Parameters:
      uri - The URI of the StopSharing relation returned as part of the ShareDocumentsRequestState