Package de.espirit.firstspirit.agency

Interface PreviewUrlAgent.ContentProducerPreviewUrlBuilder

All Superinterfaces:
PreviewUrlAgent.PreviewUrlBuilder<PreviewUrlAgent.ContentProducerPreviewUrlBuilder>
Enclosing interface:
PreviewUrlAgent
public static interface PreviewUrlAgent.ContentProducerPreviewUrlBuilder extends PreviewUrlAgent.PreviewUrlBuilder<PreviewUrlAgent.ContentProducerPreviewUrlBuilder>
The preview url builder for ContentProducers like Page, PageRef or DocumentGroup nodes.
Since:
5.2.190105

  • Method Details

    • templateSet

      @Contract("_ -> this") @NotNull @NotNull PreviewUrlAgent.ContentProducerPreviewUrlBuilder templateSet(TemplateSet templateSet)
      Selects the TemplateSet to use for rendering the preview url. If no TemplateSet is set, the builder will fall back to the first available (and possibly only) templateSet of the project.
      Parameters:
      templateSet - The template set to use when rendering the preview url.
      Returns:
      The builder itself.
      Since:
      5.2.190105

    • pageParams

      @Contract("_ -> this") @NotNull @NotNull PreviewUrlAgent.ContentProducerPreviewUrlBuilder pageParams(PageParams pageParams)
      Sets the PageParams to use for rendering the preview url. This should be used to address specific sub pages of a content projection page.
      Parameters:
      pageParams - The page params object to use when rendering the preview url.
      Returns:
      The builder itself.
      Since:
      5.2.190300

    • getUrl

      @NotNull @NotNull String getUrl(@NotNull @NotNull ContentProducer contentProducer)
      Returns the URL-String for the provided ContentProducer (Page, PageRef or DocumentGroup).
      Parameters:
      contentProducer - the pageRef, page or documentGroup to return a url for.
      Returns:
      The url as String.
      Since:
      5.2.190105

    • getUrlObject

      @NotNull @NotNull PreviewUrl getUrlObject(@NotNull @NotNull ContentProducer contentProducer)
      Returns a PreviewUrl instance for the provided ContentProducer (Page, PageRef or DocumentGroup).
      Parameters:
      contentProducer - The pageRef, page or documentGroup to return a url for.
      Returns:
      The preview url object
      Since:
      5.2.190105