Package org.alfresco.rest.api
Interface Renditions
-
- All Known Implementing Classes:
RenditionsImpl
public interface Renditions
Renditions API- Author:
- Jamal Kaabi-Mofrad
-
-
Field Summary
Fields Modifier and Type Field Description static String
PARAM_STATUS
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
createRendition(NodeRef nodeRef, Rendition rendition, boolean executeAsync, Parameters parameters)
Creates a rendition for the given node - either async r syncvoid
createRendition(NodeRef nodeRef, Rendition rendition, Parameters parameters)
Creates a rendition for the given node asynchronously.void
createRenditions(NodeRef nodeRef, List<Rendition> renditions, Parameters parameters)
Creates renditions that don't already exist for the given node asynchronously.BinaryResource
getContent(NodeRef sourceNodeRef, String renditionId, Parameters parameters)
Downloads rendition.BinaryResource
getContentNoValidation(NodeRef sourceNodeRef, String renditionId, Parameters parameters)
Downloads rendition.Rendition
getRendition(NodeRef nodeRef, String renditionId, Parameters parameters)
Gets information about a rendition of a node in the repository.CollectionWithPagingInfo<Rendition>
getRenditions(NodeRef nodeRef, Parameters parameters)
Lists all available renditions includes those that have been created and those that are yet to be created.
-
-
-
Field Detail
-
PARAM_STATUS
static final String PARAM_STATUS
- See Also:
- Constant Field Values
-
-
Method Detail
-
getRenditions
CollectionWithPagingInfo<Rendition> getRenditions(NodeRef nodeRef, Parameters parameters)
Lists all available renditions includes those that have been created and those that are yet to be created.- Parameters:
nodeRef
-parameters
- theParameters
object to get the parameters passed into the request- Returns:
- the rendition results
-
getRendition
Rendition getRendition(NodeRef nodeRef, String renditionId, Parameters parameters)
Gets information about a rendition of a node in the repository. If there is no rendition, then returns the available/registered rendition.- Parameters:
nodeRef
-renditionId
- the rendition idparameters
- theParameters
object to get the parameters passed into the request- Returns:
- the
Rendition
object
-
createRendition
void createRendition(NodeRef nodeRef, Rendition rendition, Parameters parameters)
Creates a rendition for the given node asynchronously.- Parameters:
nodeRef
-rendition
- theRendition
requestparameters
- theParameters
object to get the parameters passed into the request
-
createRendition
void createRendition(NodeRef nodeRef, Rendition rendition, boolean executeAsync, Parameters parameters)
Creates a rendition for the given node - either async r sync- Parameters:
nodeRef
-rendition
-executeAsync
-parameters
-
-
createRenditions
void createRenditions(NodeRef nodeRef, List<Rendition> renditions, Parameters parameters) throws NotFoundException, ConstraintViolatedException
Creates renditions that don't already exist for the given node asynchronously.- Parameters:
nodeRef
-renditions
- theRendition
requestparameters
- theParameters
object to get the parameters passed into the request- Throws:
NotFoundException
- if any of the rendition id do not exist.ConstraintViolatedException
- if all of the renditions already exist.
-
getContent
BinaryResource getContent(NodeRef sourceNodeRef, String renditionId, Parameters parameters)
Downloads rendition.- Parameters:
sourceNodeRef
- the source nodeRefrenditionId
- the rendition idparameters
- theParameters
object to get the parameters passed into the request- Returns:
- the rendition stream
-
getContentNoValidation
BinaryResource getContentNoValidation(NodeRef sourceNodeRef, String renditionId, Parameters parameters)
Downloads rendition.- Parameters:
sourceNodeRef
- the source nodeRefrenditionId
- the rendition idparameters
- theParameters
object to get the parameters passed into the request- Returns:
- the rendition stream
-
-