public final class Document
extends Object
Documents are provided on IntegrationTemplate.execute(com.appian.connectedsystems.templateframework.sdk.configuration.ConfigurationDescriptor, com.appian.connectedsystems.templateframework.sdk.configuration.ConfigurationDescriptor, com.appian.connectedsystems.templateframework.sdk.ExecutionContext)
as the state for DocumentPropertyDescriptors
. Documents are provided on IntegrationTemplate.getConfigurationDescriptor(com.appian.connectedsystems.templateframework.sdk.configuration.ConfigurationDescriptor, com.appian.connectedsystems.templateframework.sdk.configuration.ConfigurationDescriptor, com.appian.connectedsystems.templateframework.sdk.configuration.PropertyPath, com.appian.connectedsystems.templateframework.sdk.ExecutionContext)
, as a wrapper for the document's Id. The Document object can be cleared using emptyDocument()
.
Documents are also returned by the DocumentDownloadService
on download.
After downloading a document, be sure to include it in your
IntegrationResponse
result map. Document
objects
in the map will be converted to Appian document references before being passed to the designer.
Note: On download, the returned stream will be the same stream passed into the download method.
Modifier and Type | Method and Description |
---|---|
static Document |
emptyDocument()
Singleton document representing a null document
|
String |
getExtension()
The document's extension
|
String |
getFileName()
The documents name and extension
|
Integer |
getFileSize()
The document's size, in bytes
|
Integer |
getId() |
InputStream |
getInputStream()
A stream of the document's content.
|
Long |
getParentFolderId() |
public Document(Integer id, InputStream inputStream, String extension, String fileName, Integer fileSize, Long parentFolderId)
IntegrationTemplate.execute(com.appian.connectedsystems.templateframework.sdk.configuration.ConfigurationDescriptor, com.appian.connectedsystems.templateframework.sdk.configuration.ConfigurationDescriptor, com.appian.connectedsystems.templateframework.sdk.ExecutionContext)
and IntegrationTemplate.getConfigurationDescriptor(com.appian.connectedsystems.templateframework.sdk.configuration.ConfigurationDescriptor, com.appian.connectedsystems.templateframework.sdk.configuration.ConfigurationDescriptor, com.appian.connectedsystems.templateframework.sdk.configuration.PropertyPath, com.appian.connectedsystems.templateframework.sdk.ExecutionContext)
in the ConfigurationDescriptor
. In IntegrationTemplate.getConfigurationDescriptor(com.appian.connectedsystems.templateframework.sdk.configuration.ConfigurationDescriptor, com.appian.connectedsystems.templateframework.sdk.configuration.ConfigurationDescriptor, com.appian.connectedsystems.templateframework.sdk.configuration.PropertyPath, com.appian.connectedsystems.templateframework.sdk.ExecutionContext)
only the id will be accessible
and an attempt to read will throw a RuntimeException.public Document(Integer id)
IntegrationTemplate.execute(com.appian.connectedsystems.templateframework.sdk.configuration.ConfigurationDescriptor, com.appian.connectedsystems.templateframework.sdk.configuration.ConfigurationDescriptor, com.appian.connectedsystems.templateframework.sdk.ExecutionContext)
and IntegrationTemplate.getConfigurationDescriptor(com.appian.connectedsystems.templateframework.sdk.configuration.ConfigurationDescriptor, com.appian.connectedsystems.templateframework.sdk.configuration.ConfigurationDescriptor, com.appian.connectedsystems.templateframework.sdk.configuration.PropertyPath, com.appian.connectedsystems.templateframework.sdk.ExecutionContext)
in the ConfigurationDescriptor
. In IntegrationTemplate.getConfigurationDescriptor(com.appian.connectedsystems.templateframework.sdk.configuration.ConfigurationDescriptor, com.appian.connectedsystems.templateframework.sdk.configuration.ConfigurationDescriptor, com.appian.connectedsystems.templateframework.sdk.configuration.PropertyPath, com.appian.connectedsystems.templateframework.sdk.ExecutionContext)
only the id will be accessible
and an attempt to read will throw a RuntimeException.public InputStream getInputStream()
public String getExtension()
public String getFileName()
public Integer getFileSize()
public Long getParentFolderId()
public Integer getId()
public static Document emptyDocument()
Copyright © 2018-present Appian Corporation. All Rights Reserved.