ContentMacroBodyApi 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

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

getAndAsyncConvertMacroBodyByMacroId({required String id, required int version, required String macroId, required String to, List<String>? expand, bool? allowCache, String? spaceKeyContext, String? embeddedContentRender}) → Future<AsyncId>

Returns Async Id of the conversion task which will convert the macro into a content body of the desired format. The result will be available for 5 minutes after completion of the conversion.

getAndConvertMacroBodyByMacroId({required String id, required int version, required String macroId, required String to, List<String>? expand, String? spaceKeyContext, String? embeddedContentRender}) → Future<ContentBody>

Returns the body of a macro in format specified in path, for the given macro ID. This includes information like the name of the macro, the body of the macro, and any macro parameters.

getMacroBodyByMacroId({required String id, required int version, required String macroId}) → Future<MacroInstance>

Returns the body of a macro in storage format, for the given macro ID. This includes information like the name of the macro, the body of the macro, and any macro parameters. This method is mainly used by Cloud apps.

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