Interface PublishingServiceInterface

Service that provides access to publishing workflow actions

interface PublishingServiceInterface {
    createSiteDraft(site: SiteInterface): Promise<SiteInterface>;
    discardDraft(draftSite: SiteInterface): Promise<void>;
    publishDraft(draftSite: SiteInterface): Promise<void>;
}

Index

Methods

createSiteDraft discardDraft publishDraft

Methods

createSiteDraft

createSiteDraft(site: SiteInterface): Promise<SiteInterface>
Create a draft for the given site.
Parameters
- site: SiteInterface
  The site for which to create a draft
Returns Promise<SiteInterface>

discardDraft

discardDraft(draftSite: SiteInterface): Promise<void>
Discard a draft for the given site. This method resets site repository cache and refreshes users and groups if discard successful.
Parameters
- draftSite: SiteInterface
  The draft site for which to discard a draft
Returns Promise<void>

publishDraft

publishDraft(draftSite: SiteInterface): Promise<void>
Publish the given draft site, transforming the site in a published one.
Parameters
- draftSite: SiteInterface
  The draft site to publish
Returns Promise<void>