ContentAttachmentsApi class

This document describes the REST API and resources provided by Confluence. The REST APIs are for developers who want to integrate Confluence into their application and for administrators who want to script interactions with the Confluence server.Confluence's REST APIs provide access to resources (data entities) via URI paths. To use a REST API, your application will make an HTTP request and parse the response. The response format is JSON. Your methods will be the standard HTTP methods like GET, PUT, POST and DELETE. Because the REST API is based on open standards, you can use any web development language to access the API.

Constructors

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

createAttachment({required String id, String? status, required dynamic body}) → Future<ContentArray>

Adds an attachment to a piece of content. This method only adds a new attachment. If you want to update an existing attachment, use Create or update attachments.

createOrUpdateAttachments({required String id, String? status, required dynamic body}) → Future<ContentArray>

Adds an attachment to a piece of content. If the attachment already exists for the content, then the attachment is updated (i.e. a new version of the attachment is created).

downloadAttachment({required String id, required String attachmentId, int? version}) → Future<Uri>

Redirects the client to a URL that serves an attachment's binary data.

getAttachments({required String id, List<String>? expand, int? start, int? limit, String? filename, String? mediaType}) → Future<ContentArray>

Deprecated, use Confluence's v2 API.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

updateAttachmentData({required String id, required String attachmentId, required dynamic body}) → Future<Content>

Updates the binary data of an attachment, given the attachment ID, and optionally the comment and the minor edit field.

updateAttachmentProperties({required String id, required String attachmentId, required AttachmentPropertiesUpdateBody body}) → Future<Content>

Updates the attachment properties, i.e. the non-binary data of an attachment like the filename, media-type, comment, and parent container.

Operators

operator ==(Object other) → bool

The equality operator.

inherited