Interface: ExportService

Defined in: domain/contracts.ts:523

Exports documents and workspaces to files.

Methods

exportDocument()

exportDocument(input): Promise<BinaryExport | TextExport>;

Defined in: domain/contracts.ts:525

Exports one document in the given format.

Parameters

Parameter	Type
input	{ documentId: string; fileName?: string; format: string; }
input.documentId	string
input.fileName?	string
input.format	string

Returns

Promise<BinaryExport | TextExport>

---

exportWorkspace()

exportWorkspace(input): Promise<BinaryExport>;

Defined in: domain/contracts.ts:532

Exports a whole workspace as JSON or a zip archive.

Parameters

Parameter	Type
input	{ format: "json" | "zip"; includeAttachments?: boolean; workspaceId: string; }
input.format	"json" | "zip"
input.includeAttachments?	boolean
input.workspaceId	string

Returns

Promise<BinaryExport>