Package io.github.primelib.confluence4j.rest.v1.spec

Klasse AsyncConvertContentBodyRequestOperationSpec.AsyncConvertContentBodyRequestOperationSpecBuilder

java.lang.Object
io.github.primelib.confluence4j.rest.v1.spec.AsyncConvertContentBodyRequestOperationSpec.AsyncConvertContentBodyRequestOperationSpecBuilder
Umschließende Klasse:
AsyncConvertContentBodyRequestOperationSpec
public static class AsyncConvertContentBodyRequestOperationSpec.AsyncConvertContentBodyRequestOperationSpecBuilder extends Object

  • Methodendetails

    • to

      public AsyncConvertContentBodyRequestOperationSpec.AsyncConvertContentBodyRequestOperationSpecBuilder to(@NotNull @NotNull String to)
      The name of the target format for the content body.
      Gibt zurück:
      this.

    • body

      public AsyncConvertContentBodyRequestOperationSpec.AsyncConvertContentBodyRequestOperationSpecBuilder body(@NotNull @NotNull ContentBodyCreate body)
      The content body to convert.
      Gibt zurück:
      this.

    • expand

      public AsyncConvertContentBodyRequestOperationSpec.AsyncConvertContentBodyRequestOperationSpecBuilder expand(@Nullable @Nullable List<String> expand)
      A multi-value parameter indicating which properties of the content to expand and populate. Expands are dependent on the to conversion format and may be irrelevant for certain conversions (e.g. macroRenderedOutput is redundant when converting to view format). If rendering to view format, and the body content being converted includes arbitrary nested content (such as macros); then it is necessary to include webresource expands in the request. Webresources for content body are the batched JS and CSS dependencies for any nested dynamic content (i.e. macros). - embeddedContent returns metadata for nested content (e.g. page included using page include macro) - mediaToken returns JWT token for retrieving attachment data from Media API - macroRenderedOutput additionally converts body to view format - webresource.superbatch.uris.js returns all common JS dependencies as static URLs - webresource.superbatch.uris.css returns all common CSS dependencies as static URLs - webresource.superbatch.uris.all returns all common dependencies as static URLs - webresource.superbatch.tags.all returns all common JS dependencies as html &amp;lt;script&amp;gt; tags - webresource.superbatch.tags.css returns all common CSS dependencies as html &amp;lt;style&amp;gt; tags - webresource.superbatch.tags.js returns all common dependencies as html &amp;lt;script&amp;gt; and &amp;lt;style&amp;gt; tags - webresource.uris.js returns JS dependencies specific to conversion - webresource.uris.css returns CSS dependencies specific to conversion - webresource.uris.all returns all dependencies specific to conversion - webresource.tags.all returns common JS dependencies as html &amp;lt;script&amp;gt; tags - webresource.tags.css returns common CSS dependencies as html &amp;lt;style&amp;gt; tags - webresource.tags.js returns common dependencies as html &amp;lt;script&amp;gt; and &amp;lt;style&amp;gt; tags
      Gibt zurück:
      this.

    • spaceKeyContext

      public AsyncConvertContentBodyRequestOperationSpec.AsyncConvertContentBodyRequestOperationSpecBuilder spaceKeyContext(@Nullable @Nullable String spaceKeyContext)
      The space key used for resolving embedded content (page includes, files, and links) in the content body. For example, if the source content contains the link &amp;lt;ac:link&amp;gt;&amp;lt;ri:page ri:content-title="Example page" /&amp;gt;&amp;lt;ac:link&amp;gt; and the spaceKeyContext=TEST parameter is provided, then the link will be converted to a link to the "Example page" page in the "TEST" space.
      Gibt zurück:
      this.

    • contentIdContext

      public AsyncConvertContentBodyRequestOperationSpec.AsyncConvertContentBodyRequestOperationSpecBuilder contentIdContext(@Nullable @Nullable String contentIdContext)
      The content ID used to find the space for resolving embedded content (page includes, files, and links) in the content body. For example, if the source content contains the link &amp;lt;ac:link&amp;gt;&amp;lt;ri:page ri:content-title="Example page" /&amp;gt;&amp;lt;ac:link&amp;gt; and the contentIdContext=123 parameter is provided, then the link will be converted to a link to the "Example page" page in the same space that has the content with ID=123. Note, spaceKeyContext will be ignored if this parameter is provided.
      Gibt zurück:
      this.

    • allowCache

      public AsyncConvertContentBodyRequestOperationSpec.AsyncConvertContentBodyRequestOperationSpecBuilder allowCache(@Nullable @Nullable Boolean allowCache)
      If this field is false, the cache will erase its current value and begin a new conversion. If this field is true, the cache will not erase its current value, and will set the status of the async conversion to RERUNNING. Once the data is updated, the status will change to COMPLETED. Large macros that take long to convert, and whose data need not immediately up to date (same as previous conversion's result within last 5 minutes) should set this fields to true. Cache values are stored per user per content body and expansions.
      Gibt zurück:
      this.

    • embeddedContentRender

      public AsyncConvertContentBodyRequestOperationSpec.AsyncConvertContentBodyRequestOperationSpecBuilder embeddedContentRender(@Nullable @Nullable String embeddedContentRender)
      Mode used for rendering embedded content, like attachments. - current renders the embedded content using the latest version. - version-at-save renders the embedded content using the version at the time of save.
      Gibt zurück:
      this.

    • build

      public AsyncConvertContentBodyRequestOperationSpec build()

    • toString

      public String toString()
      Setzt außer Kraft:
      toString in Klasse Object