Package com.atlassian.confluence.search.v2

Interface HightlightParams

All Known Implementing Classes:

DefaultHighlightParams

public interface HightlightParams

Parameters for highlighting in search.

Since:

5.10

Method Summary

Modifier and Type	Method	Description
String	getEncoder()	The encoding required for highlight result.
String	getPostTag()
String	getPreTag()
default SearchQuery	getQuery()

Method Details

getPreTag

String getPreTag()

getPostTag

String getPostTag()

getEncoder

String getEncoder()

The encoding required for highlight result. Use NoOpEncoder to bypass encoding.

Returns:

"html" if html encoding is required. "none" for bypassing encoding.

Since:

5.10.5

getQuery

default SearchQuery getQuery()

Since:

5.10.5