×

You're using an outdated browser

For a better experience, keep your browser up to date. Check here for the latest version.

Manual

SearchResult

Thomas Walker

Thomas Walker Last update: Aug 7, 2017

Represents one item in the SearchResults.

Display all search results

<ul>
    #foreach ($searchResult in $searchResults.items)
        <li>$searchResult.description</li>
    #end
</ul>

Methods

Name Type Description
$searchResult.absoluteLink String

The absolute link to this object.

$searchResult.description String

A description of this search result (usually the page or blog post title).

$searchResult.displayTitle String

The display title of this search result (usually the page or blog post title).

$searchResult.getDescription(maxLength) String

A description of this search result (usually the page or blog post title).

Parameter Type Description
maxLength int The maximum length of the returned description.
$searchResult.getProperty(key) String

The property of this search result for the given key. This will access the so-called content properties, which are different from the properties defined by the Page Properties macro.

Example Keys:

  • confluence.user.profile.position
  • confluence.user.profile.department
  • confluence.user.profile.location

Parameter Type Description
key String The key of the user property.
$searchResult.link String

The relative link to this object.

$searchResult.linkAsText String

The relative, decoded link to this search result.

$searchResult.object Linkable

The backing object of the search result.

$searchResult.type ContentType

The type of the search result.

Possible values:

  • page
  • blog_post
  • user
  • status
  • attachment

2xlatest
We use cookies to create a secure and effective browsing experience for our website visitors and to understand how you use our site (i.e. Google Analytics). For more information: click here.
Ok