Methods

Name Type Description
$searchRequest.contentTypes List<String>

The content types to search for, as specified by the HTTP search request. HTTP parameter name: t (may be defined multiple times). Possible parameter values:

  • page
  • blog_post
  • user
  • status
  • attachment
Returns an empty list if the CQL search was used.

$searchRequest.labels List<String>

The labels to search for, as specified by the HTTP search request. HTTP parameter name: l (may be defined multiple times) Returns an empty list if the CQL search was used.

$searchRequest.maxResultsPerPage int

The maximum results per page, as specified by the HTTP search request. Useful for pagination. HTTP parameter name: max.

$searchRequest.queryString String

The query string that is used for the search, as specified by the HTTP search request. HTTP parameter name when using CQL search: cql. HTTP parameter name when using old search: q.

$searchRequest.repositoryKeys List<String>

The space keys to search in, as specified by the HTTP search request. HTTP parameter name: s (may be defined multiple times) Returns an empty list if the CQL search was used.

$searchRequest.startIndex int

The start index, as specified by the HTTP search request. Useful for pagination. HTTP parameter name: start.