The Space API provides functions for interacting with pages, documents, and files in the space.
space.deleteDocument
space.deleteDocument(name)
Deletes a document from the space.
space.deleteFile
space.deleteFile(name)
Deletes an arbitrary file from the space.
space.deletePage
space.deletePage(name)
Deletes a page from the space.
space.fileExists
space.fileExists(name)
Checks whether an arbitrary file exists in the space.
space.getAttachmentMeta
space.getAttachmentMeta(name)
Deprecated: Use space.getDocumentMeta instead.
Deprecated alias for space.getDocumentMeta.
space.getDocumentMeta
space.getDocumentMeta(name)
Returns metadata for a document.
space.getFileMeta
space.getFileMeta(name)
Returns metadata for an arbitrary space file.
space.getPageMeta
space.getPageMeta(name)
Returns metadata for a page.
space.listAttachments
space.listAttachments()
Deprecated: Use space.listDocuments instead.
Deprecated alias for space.listDocuments.
space.listDocuments
space.listDocuments()
Lists all non-page documents in the space.
space.listFiles
space.listFiles()
Lists every file in the space.
space.listPages
space.listPages()
Lists all pages in the space.
space.listPlugs
space.listPlugs()
Lists all plug files in the space.
space.pageExists
space.pageExists(name)
Checks whether a page exists in the space.
space.readAttachment
space.readAttachment(name)
Deprecated: Use space.readDocument instead.
Deprecated alias for space.readDocument.
space.readDocument
space.readDocument(name)
Reads a document as binary data.
space.readFile
space.readFile(name)
Reads an arbitrary space file as binary data.
space.readFileWithMeta
space.readFileWithMeta(name)
Reads an arbitrary space file together with its metadata.
space.readPage
space.readPage(name)
Reads a page and returns its Markdown text.
space.readPageWithMeta
space.readPageWithMeta(name)
Reads a page and returns both its Markdown text and metadata.
space.readRef
space.readRef(ref)
Reads the text addressed by a page, header, or position reference.
space.writeDocument
space.writeDocument(name, data)
Writes binary document data and returns its metadata.
space.writeFile
space.writeFile(name, data)
Writes an arbitrary binary file and returns its metadata.
space.writePage
space.writePage(name, text)
Writes Markdown text to a page and returns its metadata.