Interface WikiMacro

  • All Superinterfaces:
    Comparable<org.xwiki.rendering.macro.Macro<?>>, org.xwiki.rendering.macro.Macro<WikiMacroParameters>

    public interface WikiMacro
    extends org.xwiki.rendering.macro.Macro<WikiMacroParameters>
    Interface for defining wiki content based xwiki rendering macros.
    Since:
    2.0M2
    Version:
    $Id: 4246d0b1224362ae366247b77f9515eee753d8f8 $
    • Method Detail

      • getId

        @Deprecated
        String getId()
        Deprecated.
        since 2.3M1, use MacroDescriptor.getId() instead
        Returns:
        the id under which this macro is registered with the component manager
      • getDocumentReference

        org.xwiki.model.reference.DocumentReference getDocumentReference()
        Returns:
        the DocumentReference of the Wiki Macro
        Since:
        2.3M1
      • getAuthorReference

        org.xwiki.model.reference.DocumentReference getAuthorReference()
        Returns:
        the author of the Wiki Macro
        Since:
        4.2M1