IWorkspaceExportTemplatesService
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Service for managing workspace-level export templates.
export interface IWorkspaceExportTemplatesService
Methods
Method | Description |
|---|---|
(BETA) Create a new export template. | |
(BETA) Delete an existing export template. | |
(BETA) Get a single export template by its reference. | |
(BETA) Get the list of available export templates for slide exports. | |
(BETA) Partially update an existing export template. Only the provided properties are changed. |
Method details
IWorkspaceExportTemplatesService.createExportTemplate()methodBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Create a new export template.
createExportTemplate(template: IExportTemplateDefinition): Promise<IExportTemplate>;
Parameters
Parameter | Type | Description |
|---|---|---|
template | definition of the export template to create |
Returns
Promise<IExportTemplate>
promise with the created export template
IWorkspaceExportTemplatesService.deleteExportTemplate()methodBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Delete an existing export template.
deleteExportTemplate(ref: ObjRef): Promise<void>;
Parameters
Parameter | Type | Description |
|---|---|---|
ref | reference to the export template to delete |
Returns
Promise<void>
promise
IWorkspaceExportTemplatesService.getExportTemplate()methodBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Get a single export template by its reference.
getExportTemplate(ref: ObjRef): Promise<IExportTemplate>;
Parameters
Parameter | Type | Description |
|---|---|---|
ref | reference to the export template |
Returns
Promise<IExportTemplate>
promise with the export template
IWorkspaceExportTemplatesService.getExportTemplates()methodBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Get the list of available export templates for slide exports.
getExportTemplates(): Promise<IExportTemplate[]>;
Returns
Promise<IExportTemplate[]>
promise with array of export templates available in the workspace
IWorkspaceExportTemplatesService.patchExportTemplate()methodBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Partially update an existing export template. Only the provided properties are changed.
patchExportTemplate(ref: ObjRef, template: Partial<IExportTemplateDefinition>): Promise<IExportTemplate>;
Parameters
Parameter | Type | Description |
|---|---|---|
ref | reference to the export template to update | |
template | Partial<IExportTemplateDefinition> | subset of the export template properties to change |
Returns
Promise<IExportTemplate>
promise with the updated export template