Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IOpenPublicationRequest

Hierarchy

  • IOpenPublicationRequest

Index

Properties

Optional callbackIdentifier

callbackIdentifier: string

callbackIdentifier allows you to distinguish between different callbacks

failureCallback

failureCallback: IOpenPublicationFailureFn

Optional hideToolbarButtons

hideToolbarButtons: boolean

Indicates if you want to hide all toolbar buttons except the close button. Default value is false

Optional publicationKey

publicationKey: string

The key/reference of the target publication

Optional publicationName

publicationName: string

The name of the target publication, is required when publicationKey is missing

Optional referenceId

referenceId: string

Reference for LMS platform

Optional refreshWhenReturningToPreviousPublication

refreshWhenReturningToPreviousPublication: boolean

Indicates if you want to refresh the previous publication when returning to it, only applicable if returnToPreviousPublicationWhenClosed is true. Default value is false

Optional returnToPreviousPublicationWhenClosed

returnToPreviousPublicationWhenClosed: boolean

Indicates if you want to return to previous publication upon exiting/closing the publication, default value is false

Optional storyKey

storyKey: string

The key of the story on which we like to open the publication

successCallback

successCallback: IOpenPublicationSuccessFn

Generated using TypeDoc