SpacePropertiesApi class
This document describes Confluence's v2 APIs. This is intended to be an iteration on the existing Confluence Cloud REST API with improvements in both endpoint definitions and performance.
Constructors
- SpacePropertiesApi(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
-
createSpaceProperty(
{required int spaceId, required SpacePropertyCreateRequest body}) → Future< SpaceProperty> - Creates a new space property.
-
deleteSpacePropertyById(
{required int spaceId, required int propertyId}) → Future< void> - Deletes a space property by its id.
-
getSpaceProperties(
{required int spaceId, String? key, String? cursor, int? limit}) → Future< MultiEntityResult< SpaceProperty> > -
Returns all properties for the given space. Space properties are a
key-value storage associated with a space.
The limit parameter specifies the maximum number of results returned in a
single response. Use the
linkresponse header to paginate through additional results. -
getSpacePropertyById(
{required int spaceId, required int propertyId}) → Future< SpaceProperty> - Retrieve a space property by its id.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
-
updateSpacePropertyById(
{required int spaceId, required int propertyId, required SpacePropertyUpdateRequest body}) → Future< SpaceProperty> - Update a space property by its id.
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited