IWorkspacePublisherService

IWorkspacePublisherService.createDocument()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Create a new document.

createDocument(publisherDocument: IPublisherDocumentDefinitionV1): Promise<IPublisherDocumentV1>;

Parameters

Returns

Promise<IPublisherDocumentV1>

IWorkspacePublisherService.createDocumentTemplate()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Create a new document template.

createDocumentTemplate(template: IPublisherDocumentTemplateDefinitionV1): Promise<IPublisherDocumentTemplateV1>;

Parameters

Returns

Promise<IPublisherDocumentTemplateV1>

IWorkspacePublisherService.createPageTemplate()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Create a new page template.

createPageTemplate(page: IPublisherPageTemplateDefinitionV1): Promise<IPublisherPageTemplateV1>;

Parameters

Returns

Promise<IPublisherPageTemplateV1>

IWorkspacePublisherService.deleteDocument()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Delete an existing document.

deleteDocument(ref: ObjRef): Promise<void>;

Parameters

Returns

Promise<void>

IWorkspacePublisherService.deleteDocumentTemplate()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Delete an existing document template.

deleteDocumentTemplate(ref: ObjRef): Promise<void>;

Parameters

Returns

Promise<void>

IWorkspacePublisherService.deletePageTemplate()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Delete an existing page template. Rejects default and locked page templates.

deletePageTemplate(ref: ObjRef): Promise<void>;

Parameters

Returns

Promise<void>

IWorkspacePublisherService.exportDocumentToPdf()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Export a document to PDF.

exportDocumentToPdf(ref: ObjRef, options?: IPublisherDocumentExportPdfOptions): Promise<IExportResult>;

Parameters

Returns

Promise<IExportResult>

Remarks

The backend renders the document as it is saved, so unsaved changes are not part of the export.

IWorkspacePublisherService.getDocument()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Get a single document by its reference.

getDocument(ref: ObjRef): Promise<IPublisherDocumentV1>;

Parameters

Returns

Promise<IPublisherDocumentV1>

IWorkspacePublisherService.getDocuments()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Get the list of documents available in the workspace.

getDocuments(): Promise<IPublisherDocumentV1[]>;

Returns

Promise<IPublisherDocumentV1[]>

IWorkspacePublisherService.getDocumentTemplate()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Get a single document template by its reference.

getDocumentTemplate(ref: ObjRef): Promise<IPublisherDocumentTemplateV1>;

Parameters

Returns

Promise<IPublisherDocumentTemplateV1>

IWorkspacePublisherService.getDocumentTemplates()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Get the list of document templates available in the workspace.

getDocumentTemplates(): Promise<IPublisherDocumentTemplateV1[]>;

Returns

Promise<IPublisherDocumentTemplateV1[]>

IWorkspacePublisherService.getPageTemplate()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Get a single page template by its reference.

getPageTemplate(ref: ObjRef): Promise<IPublisherPageTemplateV1>;

Parameters

Returns

Promise<IPublisherPageTemplateV1>

IWorkspacePublisherService.getPageTemplates()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Get the list of page templates available in the workspace, default page templates first.

getPageTemplates(): Promise<IPublisherPageTemplateV1[]>;

Returns

Promise<IPublisherPageTemplateV1[]>

IWorkspacePublisherService.hasDocuments()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Tells whether the workspace has any document, without loading them.

hasDocuments(): Promise<boolean>;

Returns

Promise<boolean>

IWorkspacePublisherService.updateDocument()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Update an existing document. Rejects locked documents.

updateDocument(publisherDocument: IPublisherDocumentV1): Promise<IPublisherDocumentV1>;

Parameters

Returns

Promise<IPublisherDocumentV1>

IWorkspacePublisherService.updateDocumentTemplate()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Update an existing document template. Rejects locked templates.

updateDocumentTemplate(template: IPublisherDocumentTemplateV1): Promise<IPublisherDocumentTemplateV1>;

Parameters

Returns

Promise<IPublisherDocumentTemplateV1>

IWorkspacePublisherService.updatePageTemplate()methodAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Update an existing page template. Rejects default and locked page templates.

updatePageTemplate(page: IPublisherPageTemplateV1): Promise<IPublisherPageTemplateV1>;

Parameters

Returns

Promise<IPublisherPageTemplateV1>