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

Klasse GetAndAsyncConvertMacroBodyByMacroIdOperationSpec.GetAndAsyncConvertMacroBodyByMacroIdOperationSpecBuilder

java.lang.Object

io.github.primelib.confluence4j.rest.v1.spec.GetAndAsyncConvertMacroBodyByMacroIdOperationSpec.GetAndAsyncConvertMacroBodyByMacroIdOperationSpecBuilder

Umschließende Klasse:

GetAndAsyncConvertMacroBodyByMacroIdOperationSpec

public static class GetAndAsyncConvertMacroBodyByMacroIdOperationSpec.GetAndAsyncConvertMacroBodyByMacroIdOperationSpecBuilder
extends Object

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
GetAndAsyncConvertMacroBodyByMacroIdOperationSpec.GetAndAsyncConvertMacroBodyByMacroIdOperationSpecBuilder	allowCache(@Nullable Boolean allowCache)	If this field is false, the cache will erase its current value and begin a conversion.
GetAndAsyncConvertMacroBodyByMacroIdOperationSpec	build()
GetAndAsyncConvertMacroBodyByMacroIdOperationSpec.GetAndAsyncConvertMacroBodyByMacroIdOperationSpecBuilder	embeddedContentRender(@Nullable String embeddedContentRender)	Mode used for rendering embedded content, like attachments.
GetAndAsyncConvertMacroBodyByMacroIdOperationSpec.GetAndAsyncConvertMacroBodyByMacroIdOperationSpecBuilder	expand(@Nullable List<String> expand)	A multi-value parameter indicating which properties of the content to expand and populate.
GetAndAsyncConvertMacroBodyByMacroIdOperationSpec.GetAndAsyncConvertMacroBodyByMacroIdOperationSpecBuilder	id(@NotNull String id)	The ID for the content that contains the macro.
GetAndAsyncConvertMacroBodyByMacroIdOperationSpec.GetAndAsyncConvertMacroBodyByMacroIdOperationSpecBuilder	macroId(@NotNull String macroId)	The ID of the macro.
GetAndAsyncConvertMacroBodyByMacroIdOperationSpec.GetAndAsyncConvertMacroBodyByMacroIdOperationSpecBuilder	spaceKeyContext(@Nullable String spaceKeyContext)	The space key used for resolving embedded content (page includes, files, and links) in the content body.
GetAndAsyncConvertMacroBodyByMacroIdOperationSpec.GetAndAsyncConvertMacroBodyByMacroIdOperationSpecBuilder	to(@NotNull String to)	The content representation to return the macro in.
String	toString()
GetAndAsyncConvertMacroBodyByMacroIdOperationSpec.GetAndAsyncConvertMacroBodyByMacroIdOperationSpecBuilder	version(@NotNull Integer version)	The version of the content that contains the macro.

Von Klasse geerbte Methoden java.lang.Object

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

Methodendetails

id

public GetAndAsyncConvertMacroBodyByMacroIdOperationSpec.GetAndAsyncConvertMacroBodyByMacroIdOperationSpecBuilder id(@NotNull
 @NotNull String id)

The ID for the content that contains the macro.

Gibt zurück:

this.

version

public GetAndAsyncConvertMacroBodyByMacroIdOperationSpec.GetAndAsyncConvertMacroBodyByMacroIdOperationSpecBuilder version(@NotNull
 @NotNull Integer version)

The version of the content that contains the macro. Specifying 0 as the version will return the macro body for the latest content version.

Gibt zurück:

this.

macroId

public GetAndAsyncConvertMacroBodyByMacroIdOperationSpec.GetAndAsyncConvertMacroBodyByMacroIdOperationSpecBuilder macroId(@NotNull
 @NotNull String macroId)

The ID of the macro. For apps, this is passed to the macro by the Connect/Forge framework. Otherwise, find the macro ID by querying the desired content and version, then expanding the body in storage format. For example, '/content/196611/version/7?expand=content.body.storage'.

Gibt zurück:

this.

to

public GetAndAsyncConvertMacroBodyByMacroIdOperationSpec.GetAndAsyncConvertMacroBodyByMacroIdOperationSpecBuilder to(@NotNull
 @NotNull String to)

The content representation to return the macro in. Currently, the following conversions are allowed: - export_view - styled_view - view

Gibt zurück:

this.

expand

public GetAndAsyncConvertMacroBodyByMacroIdOperationSpec.GetAndAsyncConvertMacroBodyByMacroIdOperationSpecBuilder 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.

allowCache

public GetAndAsyncConvertMacroBodyByMacroIdOperationSpec.GetAndAsyncConvertMacroBodyByMacroIdOperationSpecBuilder allowCache(@Nullable
 @Nullable Boolean allowCache)

If this field is false, the cache will erase its current value and begin a conversion. If this field is true, the cache will not erase its current value, and will set the status of the result in cache to RERUNNING. Once the data is updated, the status will change to COMPLETED. Large macros that take long to convert, and who want to show intermediate, but potentially stale data, immediately should set this field to true. Cache values are stored per macro per user per content and expansions.

Gibt zurück:

this.

spaceKeyContext

public GetAndAsyncConvertMacroBodyByMacroIdOperationSpec.GetAndAsyncConvertMacroBodyByMacroIdOperationSpecBuilder 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.

embeddedContentRender

public GetAndAsyncConvertMacroBodyByMacroIdOperationSpec.GetAndAsyncConvertMacroBodyByMacroIdOperationSpecBuilder 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 GetAndAsyncConvertMacroBodyByMacroIdOperationSpec build()

toString

public String toString()

Setzt außer Kraft:

toString in Klasse Object