tridion-sites-extensions-api-docs

Home > @tridion-sites/open-api-client > PublishingService

PublishingService class

Signature:

export declare class PublishingService

Methods

Method Modifiers Description
getBusinessProcessTypes({ topologyTypeId, }) static Gets a list of Business Process Types linked to a specified Topology Type. This operation returns an instance of ‘Link’ type.
getItemsToPublish({ requestModel, }) static Gets a list of items that will be published when executing the specified instructions. This operation returns an instance of ‘ResolvedItem’ type.
getItemsToUnpublish({ requestModel, }) static Gets a list of items that will be unpublished when executing the specified instructions. This operation returns an instance of ‘ResolvedItem’ type.
getPublishedPages({ escapedComponentId, }) static Gets a list of published Pages that use a specified Component. This operation returns an instance of ‘Page’ type.
getPublishedTo({ escapedItemId, }) static Gets a summary of all publishing targets for a specified item. This operation returns an instance of ‘PublishInfo’ type.
getPublishSourceByUrl({ url, }) static Gets information about the source from which content was published using the published URL. This operation returns an instance of ‘PublishSource’ type.
getPublishTransactions({ userId, publicationId, targetTypeId, startDate, endDate, priority, state, details, }) static Gets a list of all publishing transactions. This operation returns an instance of ‘PublishTransaction’ type.
getPublishUrls({ escapedPageId, }) static Gets the URL where an item is published. This operation returns an instance of ‘PublishUrlInfo’ type.
isPublished({ escapedItemId, isPublishedInContext, targetIdOrPurpose, }) static Indicates whether a specified item is published (true) or not (false).
publish({ requestModel, }) static Publishes items according to the specified instructions. This operation returns an instance of ‘PublishTransactionsCreationResult’ type.
unpublish({ requestModel, }) static Unpublishes items according to the specified instructions. This operation returns an instance of ‘PublishTransactionsCreationResult’ type.