Attachments Interface

public interface Attachments

An instance of this class provides access to all the operations defined in Attachments.

Method Summary

Modifier and Type Method and Description
abstract java.util.concurrent.CompletableFuture<java.io.InputStream> getAttachment(String attachmentId, String viewId)

GetAttachment.

abstract java.util.concurrent.CompletableFuture<AttachmentInfo> getAttachmentInfo(String attachmentId)

GetAttachmentInfo.

default java.lang.String getAttachmentUri(String attachmentId)

Get the URI of an attachment view.

abstract java.lang.String getAttachmentUri(String attachmentId, String viewId)

Get the URI of an attachment view.

Method Details

getAttachment

public abstract CompletableFuture getAttachment(String attachmentId, String viewId)

GetAttachment. Get the named view as binary content.

Parameters:

attachmentId - attachment id
viewId - View id from attachmentInfo

Returns:

the observable to the InputStream object

getAttachmentInfo

public abstract CompletableFuture getAttachmentInfo(String attachmentId)

GetAttachmentInfo. Get AttachmentInfo structure describing the attachment views.

Parameters:

attachmentId - attachment id

Returns:

the observable to the AttachmentInfo object

getAttachmentUri

public default String getAttachmentUri(String attachmentId)

Get the URI of an attachment view.

Parameters:

attachmentId - id of the attachment.

Returns:

URI of the attachment.

getAttachmentUri

public abstract String getAttachmentUri(String attachmentId, String viewId)

Get the URI of an attachment view.

Parameters:

attachmentId - id of the attachment.
viewId - default is "original".

Returns:

URI of the attachment.

Applies to