Package org.xwiki.image.style.rest
Interface ImageStylesResource
-
@Unstable public interface ImageStylesResource
Rest endpoint for the image styles.- Since:
- 14.3RC1
- Version:
- $Id: 41df1c56d5b9e3e94df9e826ae2bf7c71be92e7c $
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Map<String,String>
getDefaultStyleIdentifier(String wikiName, String documentReference)
Return the identifier of the default style for a given document.Styles
getStyles(String wikiName)
Return the list of styles for a given wiki.
-
-
-
Method Detail
-
getStyles
Styles getStyles(String wikiName) throws ImageStyleException
Return the list of styles for a given wiki.- Parameters:
wikiName
- the name of the wiki (e.g.,xwiki
)- Returns:
- the list of image styles
- Throws:
ImageStyleException
- in case of error while retrieving the list of styles
-
getDefaultStyleIdentifier
Map<String,String> getDefaultStyleIdentifier(String wikiName, String documentReference) throws ImageStyleException
Return the identifier of the default style for a given document.- Parameters:
wikiName
- the name of the wiki (e.g.,xwiki
)documentReference
- the document reference to resolve the default style for- Returns:
- the identifier of the default style
- Throws:
ImageStyleException
- in case of error while retrieving the default style
-
-