com.atlassian.confluence.plugins.restapi.enrich

Interface RestObjectEnricher

All Known Subinterfaces:

CollectionEnricher, EntityEnricher

All Known Implementing Classes:

ContentEnricher, RequestEntityEnricher, RestListLinkEnricher, SpaceEnricher

public interface RestObjectEnricher

Enriches entities and collections with extra properties that participate in json or graph-ql serialization.

Since:

6.12.0

Method Summary

Modifier and Type	Method and Description
@NonNull Map<String,Type>	getEnrichedPropertyTypes(@NonNull Type type) Get the types of the properties that may possibly be provided by this enricher.
boolean	isRecursive() Get whether the enricher applies to the root object only, or recursively to all objects in the tree.

Method Detail

isRecursive

boolean isRecursive()

Get whether the enricher applies to the root object only, or recursively to all objects in the tree.

getEnrichedPropertyTypes

@NonNull Map<String,Type> getEnrichedPropertyTypes(@NonNull Type type)

Get the types of the properties that may possibly be provided by this enricher. This is used to populate the graph-ql schema.

Parameters:

type - The type of the object being enriched

Returns:

A map of property names to property types