com.atlassian.confluence.api.extension
Interface ModelMetadataProvider

All Known Implementing Classes:

AbstractModelMetadataProvider

@PublicSpi
public interface ModelMetadataProvider

Provides additional metadata such as Likes and Watches to API Model objects.

Method Summary

java.util.Map<java.lang.String,java.lang.Object>

getMetadata(java.lang.Object entity, Expansions expansions) Returns keyed metadata based on the passed entity and the expansions.

Method Detail

getMetadata

java.util.Map<java.lang.String,java.lang.Object> getMetadata(java.lang.Object entity,
                                                             Expansions expansions)

Returns keyed metadata based on the passed entity and the expansions.

Parameters:

entity - a Confluence API object (e.g. Content, Space)

expansions - indicating which metadata (and at which depth) to include

Returns:

Jackson-serializable metadata keyed by globally-unique strings, else an empty Map