SpaceApi 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

SpaceApi(ApiClient _client)

Properties

hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

createPrivateSpace({required SpaceCreate body}) → Future<Space>
Creates a new space that is only visible to the creator. This method is the same as the Create space method with permissions set to the current user only. Note, currently you cannot set space labels when creating a space.
createSpace({required SpaceCreate body}) → Future<Space>
Creates a new space. Note, currently you cannot set space labels when creating a space.
deleteSpace(String spaceKey) → Future<LongTask>
Deletes a space. Note, the space will be deleted in a long running task. Therefore, the space may not be deleted yet when this method has returned. Clients should poll the status link that is returned in the response until the task completes.
getContentByTypeForSpace({required String spaceKey, required String type, String? depth, List<String>? expand, int? start, int? limit}) → Future<ContentArray>
Deprecated, use Confluence's v2 API.
getContentForSpace({required String spaceKey, String? depth, List<String>? expand, int? start, int? limit}) → Future<Map<String, dynamic>>
Deprecated, use Confluence's v2 API.
getSpace({required String spaceKey, List<String>? expand}) → Future<Space>
Deprecated, use Confluence's v2 API.
getSpaces({List<String>? spaceKey, List<int>? spaceId, String? type, String? status, List<String>? label, bool? favourite, String? favouriteUserKey, List<String>? expand, int? start, int? limit}) → Future<SpaceArray>
Deprecated, use Confluence's v2 API.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited
updateSpace({required String spaceKey, required SpaceUpdate body}) → Future<Space>
Updates the name, description, or homepage of a space.

Operators

operator ==(Object other) → bool
The equality operator.
inherited