com.jivesoftware.base.plugin
Interface Macro

public interface Macro

Provides the ability to make custom macros to be used inside content such as blog posts, threads, documents, and comments.

Method Summary

java.lang.String

render(java.lang.String body, java.util.Map<java.lang.String,java.lang.String> parameters, MacroContext macroContext) Render the macro.

Method Detail

render

java.lang.String render(java.lang.String body,
                        java.util.Map<java.lang.String,java.lang.String> parameters,
                        MacroContext macroContext)

Render the macro.

Parameters:

body - The body content of the macro, if the macro has a body. This will be null otherwise.

parameters - The parameters passed into the macro.

macroContext - Provides extra information such as the JiveContext and PluginMetaDataImpl objects.

Returns:

The string rendered by the macro.