IWorkspacePublisherServiceV2
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Service for managing Publisher page templates, document templates and documents in content version 2.
export interface IWorkspacePublisherServiceV2
Remarks
Every entity is validated on load and before save. Content that fails the validation, or has a version this frontend does not read, throws PublisherContentNotSupportedError; a save that fails it never reaches the backend.
The page template and document template lists leave such entities out. The document list keeps them as unsupported items.
Default page templates come from the backend and carry isDefault: true. A save under a default. id is rejected before the backend, and the backend rejects deleting a default page template. A copy saved under a new id is an ordinary page template.
Methods
Method | Description |
|---|---|
(ALPHA) | |
(ALPHA) | |
(ALPHA) | |
(ALPHA) | |
(ALPHA) | |
(ALPHA) | |
(ALPHA) The backend renders the document as it is saved, so unsaved changes are not part of the export. | |
(ALPHA) | |
(ALPHA) | |
(ALPHA) | |
(ALPHA) | |
(ALPHA) | |
(ALPHA) | |
(ALPHA) | |
(ALPHA) | |
(ALPHA) |
Method details
IWorkspacePublisherServiceV2.createDocument()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
createDocument(publisherDocument: IPublisherDocumentDefinitionV2): Promise<IPublisherDocumentV2>;
Parameters
Parameter | Type | Description |
|---|---|---|
publisherDocument |
Returns
Promise<IPublisherDocumentV2>
IWorkspacePublisherServiceV2.createDocumentTemplate()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
createDocumentTemplate(template: IPublisherDocumentTemplateDefinitionV2): Promise<IPublisherDocumentTemplateV2>;
Parameters
Parameter | Type | Description |
|---|---|---|
template |
Returns
Promise<IPublisherDocumentTemplateV2>
IWorkspacePublisherServiceV2.createPageTemplate()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
createPageTemplate(template: IPublisherPageTemplateDefinitionV2): Promise<IPublisherPageTemplateV2>;
Parameters
Parameter | Type | Description |
|---|---|---|
template |
Returns
Promise<IPublisherPageTemplateV2>
IWorkspacePublisherServiceV2.deleteDocument()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
deleteDocument(ref: ObjRef): Promise<void>;
Parameters
Parameter | Type | Description |
|---|---|---|
ref |
Returns
Promise<void>
IWorkspacePublisherServiceV2.deleteDocumentTemplate()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
deleteDocumentTemplate(ref: ObjRef): Promise<void>;
Parameters
Parameter | Type | Description |
|---|---|---|
ref |
Returns
Promise<void>
IWorkspacePublisherServiceV2.deletePageTemplate()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
deletePageTemplate(ref: ObjRef): Promise<void>;
Parameters
Parameter | Type | Description |
|---|---|---|
ref |
Returns
Promise<void>
IWorkspacePublisherServiceV2.exportDocumentToPdf()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
The backend renders the document as it is saved, so unsaved changes are not part of the export.
exportDocumentToPdf(ref: ObjRef, options?: IPublisherDocumentExportPdfOptions): Promise<IExportResult>;
Parameters
Parameter | Type | Description |
|---|---|---|
ref | ||
options | (Optional) |
Returns
Promise<IExportResult>
IWorkspacePublisherServiceV2.getDocument()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
getDocument(ref: ObjRef): Promise<IPublisherDocumentV2>;
Parameters
Parameter | Type | Description |
|---|---|---|
ref |
Returns
Promise<IPublisherDocumentV2>
IWorkspacePublisherServiceV2.getDocuments()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
getDocuments(): Promise<PublisherDocumentListItemV2[]>;
Returns
Promise<PublisherDocumentListItemV2[]>
IWorkspacePublisherServiceV2.getDocumentTemplate()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
getDocumentTemplate(ref: ObjRef): Promise<IPublisherDocumentTemplateV2>;
Parameters
Parameter | Type | Description |
|---|---|---|
ref |
Returns
Promise<IPublisherDocumentTemplateV2>
IWorkspacePublisherServiceV2.getDocumentTemplates()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
getDocumentTemplates(): Promise<IPublisherDocumentTemplateV2[]>;
Returns
Promise<IPublisherDocumentTemplateV2[]>
IWorkspacePublisherServiceV2.getPageTemplate()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
getPageTemplate(ref: ObjRef): Promise<IPublisherPageTemplateV2>;
Parameters
Parameter | Type | Description |
|---|---|---|
ref |
Returns
Promise<IPublisherPageTemplateV2>
IWorkspacePublisherServiceV2.getPageTemplates()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
getPageTemplates(): Promise<IPublisherPageTemplateV2[]>;
Returns
Promise<IPublisherPageTemplateV2[]>
IWorkspacePublisherServiceV2.updateDocument()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
updateDocument(publisherDocument: IPublisherDocumentV2): Promise<IPublisherDocumentV2>;
Parameters
Parameter | Type | Description |
|---|---|---|
publisherDocument |
Returns
Promise<IPublisherDocumentV2>
IWorkspacePublisherServiceV2.updateDocumentTemplate()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
updateDocumentTemplate(template: IPublisherDocumentTemplateV2): Promise<IPublisherDocumentTemplateV2>;
Parameters
Parameter | Type | Description |
|---|---|---|
template |
Returns
Promise<IPublisherDocumentTemplateV2>
IWorkspacePublisherServiceV2.updatePageTemplate()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
updatePageTemplate(template: IPublisherPageTemplateV2): Promise<IPublisherPageTemplateV2>;
Parameters
Parameter | Type | Description |
|---|---|---|
template |
Returns
Promise<IPublisherPageTemplateV2>