API Reference

Version 522.2 by Vincent Massol on 2017/09/11
Warning: For security reasons, the document is displayed in restricted mode as it is not the current version. There may be differences and errors due to this.

Failed to execute the [velocity] macro. Cause: [The execution of the [velocity] script macro is not allowed in [xwiki:Documentation.DevGuide.API.WebHome]. Check the rights of its last author or the parameters if it's rendered from another script.]. Click on this message for details.

XWiki's APIs are the methods that the XWiki development team consider safe for you to use (i.e. for which backward compatibility is guaranteed). They can be called from Java or directly from your wiki pages using a scripting language (Velocity, Groovy, Python, Ruby, etc).

As users of the XWiki API you need to be aware of some important points:

  • You should never use a class having internal in its package. It means this class is not a public API and XWiki developers can change it at any time. If you depend on such a class you're on your own and the XWiki Development Team doesn't guarantee its stability.
  • You should pay attention to the @Unstable annotation. When you see code marked with this annotation it means it's a new public API that it still considered unstable and that can change at any time too. See Unstable Annotation for more details.

Scripting Reference Documentation

How to find a class

You can get the maven module where to find a Java class by using XWiki Nexus Search page. Put the complete class name and you will get all modules containing it. Nexus also allows you to see what's in those artifacts and read the javadoc.

JavaDoc

XWiki is made of various extensions/modules and each module offers API for both developers coding in Java and for Scripts written in wiki pages. In the future our goal is to have Javadoc links directly from each extension page located in the Extensions Wiki

Failed to execute the [velocity] macro. Cause: [The execution of the [velocity] script macro is not allowed in [xwiki:Documentation.DevGuide.API.WebHome]. Check the rights of its last author or the parameters if it's rendered from another script.]. Click on this message for details.

The full Javadoc is also available (but only for old versions, we need to fix this).

Older Javadocs of XWiki can be found in our Maven Release repository. For example for XWiki Platform Core Javadocs, check the files suffixed by javadoc for the version you wish under this directory.

Tags:
   

Get Connected