public interface WGFileAnnotations
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
USAGE_ICON
An image representation representing the file type of the original file
|
static java.lang.String |
USAGE_POSTER
An image representation of any file displaying the files contents in graphical form
|
Modifier and Type | Method and Description |
---|---|
java.util.List<java.lang.String> |
getCustomFieldNames()
Returns the names of custom fields annotated for this file
|
java.lang.Object |
getCustomFieldValue(java.lang.String fieldName)
Returns the value of a custom field annotated for this file
|
int |
getDisplayHeight()
Returns the display height in pixels for images or videos
|
int |
getDisplayWidth()
Returns the display width in pixels for images or videos
|
java.lang.String |
getMimeType()
Returns the mime type
|
WGDocument |
getParentDocument()
Returns the parent document to which the file, described by these file annotations, belong
|
BinaryFieldData |
getPlainText()
returns a plain text representation of the file
|
long |
getSize()
Returns the size of the file in bytes
|
java.lang.String |
getUsage()
Returns the usage of a file derivate, using constants #USAGE_...
|
void |
removeCustomField(java.lang.String fieldName)
Removes a custom field annotated for this file
|
void |
setCustomFieldValue(java.lang.String fieldName,
java.lang.Object value)
Sets the value of a custom field annotated for this file
|
void |
setDisplayHeight(int displayHeight)
Sets the display height in pixels for images or videos
|
void |
setDisplayWidth(int displayWidth)
Sets the display width in pixels for images or videos
|
void |
setMimeType(java.lang.String mimeType)
Sets the mime type
|
void |
setPlainText(BinaryFieldData data)
sets the plain text representation of this file
|
static final java.lang.String USAGE_ICON
static final java.lang.String USAGE_POSTER
java.lang.String getMimeType() throws WGAPIException
WGAPIException
void setMimeType(java.lang.String mimeType) throws WGAPIException
mimeType
- WGAPIException
int getDisplayHeight() throws WGAPIException
WGAPIException
void setDisplayHeight(int displayHeight) throws WGAPIException
displayHeight
- WGAPIException
int getDisplayWidth() throws WGAPIException
WGAPIException
void setDisplayWidth(int displayWidth) throws WGAPIException
displayWidth
- WGAPIException
java.lang.String getUsage() throws WGAPIException
WGAPIException
java.util.List<java.lang.String> getCustomFieldNames() throws WGAPIException
WGAPIException
java.lang.Object getCustomFieldValue(java.lang.String fieldName) throws WGAPIException
fieldName
- Name of the fieldWGAPIException
void setCustomFieldValue(java.lang.String fieldName, java.lang.Object value) throws WGAPIException
fieldName
- Name of the fieldvalue
- Value of the fieldWGAPIException
void removeCustomField(java.lang.String fieldName) throws WGAPIException
fieldName
- Name of the fieldWGAPIException
long getSize() throws WGAPIException
WGAPIException
WGDocument getParentDocument() throws WGAPIException
WGAPIException
BinaryFieldData getPlainText() throws WGAPIException
WGAPIException
void setPlainText(BinaryFieldData data) throws WGAPIException
data
- plain text dataWGAPIException