SignDoc SDK (Java)  5.0.0
SignDocAttachment Class Reference

Output of SignDocDocument.getAttachment(). More...

Inheritance diagram for SignDocAttachment:

Public Member Functions

synchronized String getName () throws SignDocException
 Get the name of the attachment. More...
 
synchronized String getFileName () throws SignDocException
 The file name of the attachment. More...
 
synchronized String getDescription () throws SignDocException
 The description of the attachment (empty if missing). More...
 
synchronized int getSize () throws SignDocException
 The size (in octets) of the attachment. More...
 
synchronized int getCompressedSize () throws SignDocException
 The compressed size (in octets) of the attachment. More...
 
synchronized String getType () throws SignDocException
 The MIME type of the attachment (empty if missing). More...
 
synchronized String getCreationTime () throws SignDocException
 The creation time and date of the attachment (empty if missing). More...
 
synchronized String getModificationTime () throws SignDocException
 The time and date of the last modification of the attachment (optional). More...
 
synchronized void close ()
 Destroy the underlying native object (for java.lang.AutoCloseable). More...
 

Protected Member Functions

void finalize () throws Throwable
 Finalize this object. More...
 

Detailed Description

Member Function Documentation

synchronized void close ( )

Destroy the underlying native object (for java.lang.AutoCloseable).

After calling this method, all methods but close() will throw SignDocUnexpectedErrorException.

void finalize ( ) throws Throwable
protected

Finalize this object.

Do not call this method unless you know what you are doing.

synchronized int getCompressedSize ( ) throws SignDocException

The compressed size (in octets) of the attachment.

synchronized String getCreationTime ( ) throws SignDocException

The creation time and date of the attachment (empty if missing).

ISO 8601 format is used: yyyy-mm-ddThh:mm:ss, optionally followed by a timezone: Z, +hh:mm, or -hh:mm.

The PDF reference is ambiguous; apparently, the creation time is supposed to be the time and date at which the attachment was the PDF document. Changing the description does not update the modification date/time.

synchronized String getDescription ( ) throws SignDocException

The description of the attachment (empty if missing).

synchronized String getFileName ( ) throws SignDocException

The file name of the attachment.

synchronized String getModificationTime ( ) throws SignDocException

The time and date of the last modification of the attachment (optional).

ISO 8601 format is used: yyyy-mm-ddThh:mm:ss, optionally followed by a timezone: Z, +hh:mm, or -hh:mm.

The PDF reference is ambiguous; apparently, the modifiation time is supposed to be the time and date of the last modification of the file at the time it was attached. Changing the description does not update the modification date/time.

synchronized String getName ( ) throws SignDocException

Get the name of the attachment.

synchronized int getSize ( ) throws SignDocException

The size (in octets) of the attachment.

This member is -1 if the size of the attachment is not readily available.

synchronized String getType ( ) throws SignDocException

The MIME type of the attachment (empty if missing).


The documentation for this class was generated from the following file: