AttachmentApi 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

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

deleteAttachment(int id) → Future<void>
Delete an attachment by id.
getAttachmentById({required String id, int? version, bool? serializeIdsAsStrings}) → Future<Attachment>
Returns a specific attachment.
getAttachments({String? sort, String? cursor, List<String>? status, String? mediaType, String? filename, int? limit, bool? serializeIdsAsStrings}) → Future<MultiEntityResult<Attachment>>
Returns all attachments. 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.
getBlogpostAttachments({required int id, String? sort, String? cursor, List<String>? status, String? mediaType, String? filename, int? limit, bool? serializeIdsAsStrings}) → Future<MultiEntityResult<Attachment>>
Returns the attachments of specific blog post. 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.
getCustomContentAttachments({required int id, String? sort, String? cursor, List<String>? status, String? mediaType, String? filename, int? limit, bool? serializeIdsAsStrings}) → Future<MultiEntityResult<Attachment>>
Returns the attachments of specific custom content. 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.
getLabelAttachments({required int id, String? sort, String? cursor, int? limit, bool? serializeIdsAsStrings}) → Future<MultiEntityResult<Attachment>>
Returns the attachments 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.
getPageAttachments({required int id, String? sort, String? cursor, List<String>? status, String? mediaType, String? filename, int? limit, bool? serializeIdsAsStrings}) → Future<MultiEntityResult<Attachment>>
Returns the attachments of specific page. 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

Operators

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