FileDocumentElementType Data Type

This document element type indicates that the current element represents a given file.

Properties
name data type description
pageNumber number Returns the page Number of document.
originalFormat boolean Returns the original format flag.
fileName File Returns the file name.
picture boolean Returns the isPicture flag.
chunkedOnMedium boolean Returns the cunkedOnMedium flag.
Properties inherited from ContentDocumentElementType
annotations array of AnnotationType Returns the annotations.
nodeType DocumentNodeType Returns the document node type.
children array of DocumentElementType Returns the document element children.
content InputStream Returns the content.
contentMetaData ContentMetaDataType
Properties inherited from DocumentElementType
creationDate number Returns the creation date.
variables map of string Returns the element variables.
nodeType DocumentNodeType Returns the document node type.
children array of DocumentElementType Returns the document element children.
Properties inherited from ResourceType
reference ReferenceType Returns the resource's object reference.

Example

{
  "pageNumber" : 12345,
  "originalFormat" : true,
  "fileName" : {
    "usableSpace" : 12345,
    "absolute" : true,
    "freeSpace" : 12345,
    "file" : true,
    "path" : "...",
    "absoluteFile" : { },
    "directory" : true,
    "hidden" : true,
    "absolutePath" : "...",
    "totalSpace" : 12345,
    "canonicalPath" : "...",
    "parentFile" : { },
    "name" : "...",
    "parent" : "...",
    "canonicalFile" : { }
  },
  "picture" : true,
  "chunkedOnMedium" : true,
  "annotations" : [ {
    "accessData" : {
      "aclName" : "...",
      "creationDate" : 12345,
      "creationUser" : 12345,
      "lastModificationDate" : 12345,
      "lastModificationUser" : 12345
    },
    "height" : 12345,
    "page" : 12345,
    "width" : 12345,
    "x" : 12345,
    "y" : 12345
  }, {
    "accessData" : {
      "aclName" : "...",
      "creationDate" : 12345,
      "creationUser" : 12345,
      "lastModificationDate" : 12345,
      "lastModificationUser" : 12345
    },
    "height" : 12345,
    "page" : 12345,
    "width" : 12345,
    "x" : 12345,
    "y" : 12345
  } ],
  "nodeType" : "STRUCTURE",
  "children" : [ {
    "creationDate" : 12345,
    "variables" : {
      "property1" : "...",
      "property2" : "..."
    },
    "nodeType" : "CONTENT",
    "children" : [ { }, { } ],
    "reference" : { }
  }, {
    "creationDate" : 12345,
    "variables" : {
      "property1" : "...",
      "property2" : "..."
    },
    "nodeType" : "STRUCTURE",
    "children" : [ { }, { } ],
    "reference" : { }
  } ],
  "content" : { },
  "contentMetaData" : {
    "hash" : "...",
    "uncompressedSize" : 12345,
    "compressedSize" : 12345,
    "hashAlgorithm" : "..."
  },
  "creationDate" : 12345,
  "variables" : {
    "property1" : "...",
    "property2" : "..."
  },
  "reference" : { }
}