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

Klasse ConvertContentBodyOperationSpec.ConvertContentBodyOperationSpecBuilder

java.lang.Object

io.github.primelib.confluence4j.rest.v1.spec.ConvertContentBodyOperationSpec.ConvertContentBodyOperationSpecBuilder

Umschließende Klasse:

ConvertContentBodyOperationSpec

public static class ConvertContentBodyOperationSpec.ConvertContentBodyOperationSpecBuilder
extends Object

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
ConvertContentBodyOperationSpec.ConvertContentBodyOperationSpecBuilder	body(@NotNull ContentBodyCreate body)	The content body to convert.
ConvertContentBodyOperationSpec	build()
ConvertContentBodyOperationSpec.ConvertContentBodyOperationSpecBuilder	contentIdContext(@Nullable String contentIdContext)	The content ID used to find the space for resolving embedded content (page includes, files, and links) in the content body.
ConvertContentBodyOperationSpec.ConvertContentBodyOperationSpecBuilder	embeddedContentRender(@Nullable String embeddedContentRender)	Mode used for rendering embedded content, like attachments.
ConvertContentBodyOperationSpec.ConvertContentBodyOperationSpecBuilder	expand(@Nullable List<String> expand)	A multi-value parameter indicating which properties of the content to expand and populate.
ConvertContentBodyOperationSpec.ConvertContentBodyOperationSpecBuilder	spaceKeyContext(@Nullable String spaceKeyContext)	The space key used for resolving embedded content (page includes, files, and links) in the content body.
ConvertContentBodyOperationSpec.ConvertContentBodyOperationSpecBuilder	to(@NotNull String to)	The name of the target format for the content body.
String	toString()

Von Klasse geerbte Methoden java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methodendetails

to

public ConvertContentBodyOperationSpec.ConvertContentBodyOperationSpecBuilder to(@NotNull
 @NotNull String to)

The name of the target format for the content body.

Gibt zurück:

this.

body

public ConvertContentBodyOperationSpec.ConvertContentBodyOperationSpecBuilder body(@NotNull
 @NotNull ContentBodyCreate body)

The content body to convert.

Gibt zurück:

this.

spaceKeyContext

public ConvertContentBodyOperationSpec.ConvertContentBodyOperationSpecBuilder 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 <ac:link><ri:page ri:content-title="Example page" /><ac:link> 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 ConvertContentBodyOperationSpec.ConvertContentBodyOperationSpecBuilder 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 <ac:link><ri:page ri:content-title="Example page" /><ac:link> 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.

embeddedContentRender

public ConvertContentBodyOperationSpec.ConvertContentBodyOperationSpecBuilder 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.

expand

public ConvertContentBodyOperationSpec.ConvertContentBodyOperationSpecBuilder 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 <script> tags - webresource.superbatch.tags.css returns all common CSS dependencies as html <style> tags - webresource.superbatch.tags.js returns all common dependencies as html <script> and <style> 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 <script> tags - webresource.tags.css returns common CSS dependencies as html <style> tags - webresource.tags.js returns common dependencies as html <script> and <style> tags

Gibt zurück:

this.

build

public ConvertContentBodyOperationSpec build()

toString

public String toString()

Setzt außer Kraft:

toString in Klasse Object