ContentPropertiesApi 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

ContentPropertiesApi(ApiClient _client)

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

createAttachmentProperty({required String attachmentId, required ContentPropertyCreateRequest body}) → Future<ContentProperty>

Creates a new content property for an attachment.

createBlogpostProperty({required int blogpostId, required ContentPropertyCreateRequest body}) → Future<ContentProperty>

Creates a new property for a blogpost.

createCommentProperty({required int commentId, required ContentPropertyCreateRequest body}) → Future<ContentProperty>

Creates a new content property for a comment.

createCustomContentProperty({required int customContentId, required ContentPropertyCreateRequest body}) → Future<ContentProperty>

Creates a new content property for a piece of custom content.

createPageProperty({required int pageId, required ContentPropertyCreateRequest body}) → Future<ContentProperty>

Creates a new content property for a page.

deleteAttachmentPropertyById({required String attachmentId, required int propertyId}) → Future<void>

Deletes a content property for an attachment by its id.

deleteBlogpostPropertyById({required int blogpostId, required int propertyId}) → Future<void>

Deletes a content property for a blogpost by its id.

deleteCommentPropertyById({required int commentId, required int propertyId}) → Future<void>

Deletes a content property for a comment by its id.

deleteCustomContentPropertyById({required int customContentId, required int propertyId}) → Future<void>

Deletes a content property for a piece of custom content by its id.

deletePagePropertyById({required int pageId, required int propertyId}) → Future<void>

Deletes a content property for a page by its id.

getAttachmentContentProperties({required String attachmentId, String? key, String? sort, String? cursor, int? limit}) → Future<MultiEntityResult<ContentProperty>>

Retrieves all Content Properties tied to a specified attachment.

getAttachmentContentPropertiesById({required String attachmentId, required int propertyId}) → Future<ContentProperty>

Retrieves a specific Content Property by ID that is attached to a specified attachment.

getBlogpostContentProperties({required int blogpostId, String? key, String? sort, String? cursor, int? limit}) → Future<MultiEntityResult<ContentProperty>>

Retrieves all Content Properties tied to a specified blog post.

getBlogpostContentPropertiesById({required int blogpostId, required int propertyId}) → Future<ContentProperty>

Retrieves a specific Content Property by ID that is attached to a specified blog post.

getCommentContentProperties({required int commentId, String? key, String? sort, String? cursor, int? limit}) → Future<MultiEntityResult<ContentProperty>>

Retrieves Content Properties attached to a specified comment.

getCommentContentPropertiesById({required int commentId, required int propertyId}) → Future<ContentProperty>

Retrieves a specific Content Property by ID that is attached to a specified comment.

getCustomContentContentProperties({required int customContentId, String? key, String? sort, String? cursor, int? limit}) → Future<MultiEntityResult<ContentProperty>>

Retrieves Content Properties tied to a specified custom content.

getCustomContentContentPropertiesById({required int customContentId, required int propertyId}) → Future<ContentProperty>

Retrieves a specific Content Property by ID that is attached to a specified custom content.

getPageContentProperties({required int pageId, String? key, String? sort, String? cursor, int? limit}) → Future<MultiEntityResult<ContentProperty>>

Retrieves Content Properties tied to a specified page.

getPageContentPropertiesById({required int pageId, required int propertyId}) → Future<ContentProperty>

Retrieves a specific Content Property by ID that is attached to a specified page.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

updateAttachmentPropertyById({required String attachmentId, required int propertyId, required ContentPropertyUpdateRequest body}) → Future<ContentProperty>

Update a content property for attachment by its id.

updateBlogpostPropertyById({required int blogpostId, required int propertyId, required ContentPropertyUpdateRequest body}) → Future<ContentProperty>

Update a content property for blog post by its id.

updateCommentPropertyById({required int commentId, required int propertyId, required ContentPropertyUpdateRequest body}) → Future<ContentProperty>

Update a content property for a comment by its id.

updateCustomContentPropertyById({required int customContentId, required int propertyId, required ContentPropertyUpdateRequest body}) → Future<ContentProperty>

Update a content property for a piece of custom content by its id.

updatePagePropertyById({required int pageId, required int propertyId, required ContentPropertyUpdateRequest body}) → Future<ContentProperty>

Update a content property for a page by its id.

Operators

operator ==(Object other) → bool

The equality operator.

inherited