ContentPropertiesApi 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
- ContentPropertiesApi(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
-
createContentProperty(
{required String id, required ContentPropertyCreate body}) → Future< ContentProperty> - Creates a property for an existing piece of content. For more information about content properties, see Confluence entity properties.
-
createContentPropertyForKey(
{required String id, required String key, required ContentPropertyCreateNoKey body}) → Future< ContentProperty> - Creates a property for an existing piece of content. For more information about content properties, see Confluence entity properties.
-
deleteContentProperty(
{required String id, required String key}) → Future< void> - Deletes a content property. For more information about content properties, see Confluence entity properties.
-
getContentProperties(
{required String id, List< String> ? key, List<String> ? expand, int? start, int? limit}) → Future<ContentPropertyArray> - Returns the properties for a piece of content. For more information about content properties, see Confluence entity properties.
-
getContentProperty(
{required String id, required String key, List< String> ? expand, List<String> ? status}) → Future<ContentProperty> - Returns a content property for a piece of content. For more information, see Confluence entity properties.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
-
updateContentProperty(
{required String id, required String key, required ContentPropertyUpdate body}) → Future< ContentProperty> - Updates an existing content property. This method will also create a new property for a piece of content, if the property key does not exist and the property version is 1. For more information about content properties, see Confluence entity properties.
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited