com.atlassian.confluence.api.service.content

Interface ContentMacroService.MacroInstanceFinder

All Superinterfaces:

SingleFetcher<MacroInstance>

Enclosing interface:

ContentMacroService

public static interface ContentMacroService.MacroInstanceFinder
extends SingleFetcher<MacroInstance>

A finder for locating instances of macros on content

Method Summary

Modifier and Type	Method and Description
ContentMacroService.MacroInstanceFinder	withContentVersion(int version) Apply a filter for the content to search, if this is not specified the latest version of the content will be used.
ContentMacroService.MacroInstanceFinder	withHash(String hash) Deprecated. since 5.8, use withMacroId(String)
ContentMacroService.MacroInstanceFinder	withMacroId(String macroId) Apply a filter of the macroId, this is currently mandatory.

Methods inherited from interface com.atlassian.confluence.api.service.finder.SingleFetcher

fetch, fetchOne, fetchOneOrNull, fetchOrNull

Method Detail

withMacroId

ContentMacroService.MacroInstanceFinder withMacroId(String macroId)

Apply a filter of the macroId, this is currently mandatory.

If the macroId is not specified in the storage format of the content, then this finder will match against the macro body hash. This is to preserve backwards compatibility.

Parameters:

macroId - - The macroId identifying the macro

Returns:

this

withHash

@Deprecated
ContentMacroService.MacroInstanceFinder withHash(String hash)

Deprecated. since 5.8, use withMacroId(String)

Apply a filter of the macro body hash, this is currently mandatory.

This method calls the withMacroId(String) passing the hash as the macroId. This will preserve backwards compatibility of the API as well as functionality.

Parameters:

hash - - The hash identifying the macro body

Returns:

this

withContentVersion

ContentMacroService.MacroInstanceFinder withContentVersion(int version)

Apply a filter for the content to search, if this is not specified the latest version of the content will be used.

Parameters:

version - The version of the page to scan for the macro

Returns:

this