ContentLabelsApi 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
- ContentLabelsApi(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
-
addLabelsToContent(
{required String id, required dynamic body}) → Future< LabelArray> - Adds labels to a piece of content. Does not modify the existing labels.
-
getLabelsForContent(
{required String id, String? prefix, int? start, int? limit}) → Future< LabelArray> - Deprecated, use Confluence's v2 API.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
removeLabelFromContent(
{required String id, required String label}) → Future< void> - Removes a label from a piece of content. Labels can't be deleted from archived content. This is similar to Remove label from content using query parameter except that the label name is specified via a path parameter.
-
removeLabelFromContentUsingQueryParameter(
{required String id, required String name}) → Future< void> - Removes a label from a piece of content. Labels can't be deleted from archived content. This is similar to Remove label from content except that the label name is specified via a query parameter.
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited