Web Components
  1. Injectables
  2. PublishingService

File

platform-components-ng/projects/platform-components-lib/src/lib/components/collection/service/publishing.service.ts

Description

Pushing service

Index

Properties
Methods

Constructor

constructor(http: HttpClient)
Parameters :
Name Type Optional
http HttpClient No

Methods

addStatus
addStatus(contextId: string, isPending: boolean, isPreview: boolean, channelId: String)

Add publishing context status.

Parameters :
Name Type Optional Description
contextId string No

Publishing context id
isPending boolean No

True for preview request
isPreview boolean No

True for preview request
channelId String No

Piblishing channel id
Returns : void

void
cancelRequest
cancelRequest(channelId: string, isPreview: boolean)

Cancel preview request.

Parameters :
Name Type Optional Description
channelId string No

Preview request channel id
isPreview boolean No

True for preview request
Returns : void

void
delay
delay(ms: number)
Parameters :
Name Type Optional
ms number No
Returns : any
download
download(assetId: number, versionInfo: VersionInfo, publishingChannelId: string)

Download

Parameters :
Name Type Optional Description
assetId number No

Asset id of asset
versionInfo VersionInfo No

Version info
publishingChannelId string No

Publishing Channel Id
Returns : Observable<any>

Observable
downloadAssetVersionAsync
downloadAssetVersionAsync(assetId: number, versionInfo: VersionInfo, publishingChannelId: string)

Download asset version async

Parameters :
Name Type Optional Description
assetId number No

Asset id of asset
versionInfo VersionInfo No

Version info
publishingChannelId string No

Publishing Channel Id
Returns : Observable<PublishingStatus>

Observable
getTitleDescriptionFromStatus
getTitleDescriptionFromStatus(status: PUBLISHING_STATUS_TYPE)

Get Title Description From Status

Parameters :
Name Type Optional Description
status PUBLISHING_STATUS_TYPE No

status
Returns : any

any
Async pollPublishingStatus
pollPublishingStatus(contextId: string)

Poll publishing status

Parameters :
Name Type Optional Description
contextId string No

Context Id
Returns : Promise<Observable<PublishingStatus>>

Promise<Observable>
publishAssetVersion
publishAssetVersion(assetId: number, versionInfo: VersionInfo, publishingChannelId: string)

Public asset version

Parameters :
Name Type Optional Description
assetId number No

Asset id of asset
versionInfo VersionInfo No

Version info
publishingChannelId string No

Publishing Channel Id
Returns : Observable<any>

Observable
publishAssetVersionAsync
publishAssetVersionAsync(assetId: number, versionInfo: VersionInfo, publishingChannelId: string)

Public asset version async

Parameters :
Name Type Optional Description
assetId number No

Asset id of asset
versionInfo VersionInfo No

Version info
publishingChannelId string No

Publishing Channel Id
Returns : Observable<PublishingStatus>

Observable

Properties

previewStatus
Type : object
Default value : { PUBLISHING_IN_PROGRESS: { title: "Preparation…", description: "Assembling and organizing content for processing." }, PUBLISHING_PREPARATION: { title: "Preparation…", description: "Assembling and organizing content for processing." }, PUBLISHING_PRE_GENERATION: { title: "Pre-Generation…", description: "Setting up content for the final output." }, PUBLISHING_GENERATION: { title: "Generation…", description: "Executing the construction and flow to generate the preview." }, PUBLISHING_FINALIZATION: { title: "Finalization…", description: "Retrieving the completed document for preview." }, PUBLISHING_COMPLETE: { title: "Finalization…", description: "Retrieving the completed document for preview." } }

result-matching ""

    No results matching ""