SearchApi class

This document describes the REST API and resources provided by Confluence. The REST APIs are for developers who want to integrate Confluence into their application and for administrators who want to script interactions with the Confluence server.Confluence's REST APIs provide access to resources (data entities) via URI paths. To use a REST API, your application will make an HTTP request and parse the response. The response format is JSON. Your methods will be the standard HTTP methods like GET, PUT, POST and DELETE. Because the REST API is based on open standards, you can use any web development language to access the API.

Constructors

SearchApi(ApiClient _client)

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

searchByCQL({required String cql, String? cqlcontext, String? cursor, bool? next, bool? prev, int? limit, int? start, bool? includeArchivedSpaces, bool? excludeCurrentSpaces, String? excerpt, String? sitePermissionTypeFilter, int? $, List<String>? expand}) → Future<SearchPageResponseSearchResult>

Searches for content using the Confluence Query Language (CQL).

searchUser({required String cql, int? start, int? limit, List<String>? expand, String? sitePermissionTypeFilter}) → Future<SearchPageResponseSearchResult>

Searches for users using user-specific queries from the Confluence Query Language (CQL).

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited