ContentStatesApi 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

ContentStatesApi(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

bulkRemoveContentStates({required String status, required dynamic body}) → Future<AsyncId>

Creates a long running task that Removes content state from draft or published versions of pages specified.

bulkSetContentStates({required String status, required BulkContentStateSetInput body}) → Future<AsyncId>

Creates a long running task that sets content state of draft or published versions of pages specified.

getAvailableContentStates(String id) → Future<AvailableContentStates>

Gets content states that are available for the content to be set as. Will return all enabled Space Content States. Will only return most the 3 most recently published custom content states to match UI editor list. To get all custom content states, use the /content-states endpoint.

getContentState({required String id, String? status}) → Future<ContentStateResponse>

Gets the current content state of the draft or current version of content. To specify the draft version, set the parameter status to draft, otherwise archived or current will get the relevant published state. Permissions required: Permission to view the content.

getContentStateSettings(String spaceKey) → Future<ContentStateSettings>

Get object describing whether content states are allowed at all, if custom content states or space content states are restricted, and a list of space content states allowed for the space if they are not restricted.

getContentsWithState({required String spaceKey, required int stateId, List<String>? expand, int? limit, int? start}) → Future<ContentArray>

Finds paginated content with

getCustomContentStates() → Future<List<ContentState>>

Get custom content states that authenticated user has created.

getSpaceContentStates(String spaceKey) → Future<List<ContentState>>

Get content states that are suggested in the space. Permissions required: Space view permission

getTaskUpdate(String taskId) → Future<ContentStateBulkSetTaskUpdate>

Get Status of long running task that was previously created to set or remove content states from content. User must first create a task by passing in details to /wiki/rest/api/content-states PUT or DELETE endpoints.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

removeContentState({required String id, String? status}) → Future<ContentStateResponse>

Removes the content state of the content specified and creates a new version (publishes the content without changing the body) of the content with the new status.

setContentState({required String id, String? status, required ContentStateRestInput body}) → Future<ContentStateResponse>

Sets the content state of the content specified and creates a new version (publishes the content without changing the body) of the content with the new state.

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited