CustomContentApi 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
- CustomContentApi(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
-
createCustomContent(
{required CustomContentCreateRequest body}) → Future< CustomContentSingle> - Creates a new custom content in the given space, page, blogpost or other custom content.
-
deleteCustomContent(
int id) → Future< void> - Delete a custom content by id.
-
getCustomContentById(
{required int id, String? bodyFormat, int? version}) → Future< CustomContentSingle> - Returns a specific piece of custom content.
-
getCustomContentByType(
{required String type, List< int> ? id, List<int> ? spaceId, String? sort, String? cursor, int? limit, String? bodyFormat}) → Future<MultiEntityResult< CustomContentBulk> > -
Returns all custom content for a given type. The number of results is
limited by the
limitparameter and additional results (if available) will be available through thenextURL present in theLinkresponse header. -
getCustomContentByTypeInBlogPost(
{required int id, required String type, String? sort, String? cursor, int? limit, String? bodyFormat}) → Future< MultiEntityResult< CustomContentBulk> > -
Returns all custom content for a given type within a given blogpost. The
number of results is limited by the
limitparameter and additional results (if available) will be available through thenextURL present in theLinkresponse header. -
getCustomContentByTypeInPage(
{required int id, required String type, String? sort, String? cursor, int? limit, String? bodyFormat}) → Future< MultiEntityResult< CustomContentBulk> > -
Returns all custom content for a given type within a given page. The
number of results is limited by the
limitparameter and additional results (if available) will be available through thenextURL present in theLinkresponse header. -
getCustomContentByTypeInSpace(
{required int id, required String type, String? cursor, int? limit, String? bodyFormat}) → Future< MultiEntityResult< CustomContentBulk> > -
Returns all custom content for a given type within a given space. The
number of results is limited by the
limitparameter and additional results (if available) will be available through thenextURL present in theLinkresponse header. -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
-
updateCustomContent(
{required int id, required CustomContentUpdateRequest body}) → Future< CustomContentSingle> - Update a custom content by id.
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited