BlogPostApi 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

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

createBlogPost({bool? private, required BlogPostCreateRequest body}) → Future<BlogPostSingle>
Creates a new blog post in the space specified by the spaceId.
deleteBlogPost(int id) → Future<void>
Delete a blog post by id.
getBlogPostById({required int id, String? bodyFormat, bool? getDraft, int? version}) → Future<BlogPostSingle>
Returns a specific blog post.
getBlogPosts({List<int>? id, List<int>? spaceId, String? sort, List<String>? status, String? title, String? bodyFormat, String? cursor, int? limit}) → Future<MultiEntityResult<BlogPostBulk>>
Returns all blog posts. The number of results is limited by the limit parameter and additional results (if available) will be available through the next URL present in the Link response header.
getBlogPostsInSpace({required int id, String? sort, List<String>? status, String? title, String? bodyFormat, String? cursor, int? limit}) → Future<MultiEntityResult<BlogPostBulk>>
Returns all blog posts in a space. The number of results is limited by the limit parameter and additional results (if available) will be available through the next URL present in the Link response header.
getLabelBlogPosts({required int id, List<int>? spaceId, String? bodyFormat, String? sort, String? cursor, int? limit}) → Future<MultiEntityResult<BlogPostBulk>>
Returns the blogposts of specified label. The number of results is limited by the limit parameter and additional results (if available) will be available through the next URL present in the Link response header.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited
updateBlogPost({required int id, required BlogPostUpdateRequest body}) → Future<BlogPostSingle>
Update a blog post by id.

Operators

operator ==(Object other) → bool
The equality operator.
inherited