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 and Description
static String	PARAM_STATUS

Method Summary

Modifier and Type	Method and Description
void	createRendition(String nodeId, Rendition rendition, Parameters parameters) Creates a rendition for the given node asynchronously.
BinaryResource	getContent(org.alfresco.service.cmr.repository.NodeRef sourceNodeRef, String renditionId, Parameters parameters) Downloads rendition.
BinaryResource	getContent(String nodeId, String renditionId, Parameters parameters) Downloads rendition.
Rendition	getRendition(String nodeId, String renditionId, Parameters parameters) Gets information about a rendition of a node in the repository.
CollectionWithPagingInfo<Rendition>	getRenditions(String nodeId, 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(String nodeId,
                                                  Parameters parameters)

Lists all available renditions includes those that have been created and those that are yet to be created.

Parameters:

nodeId - the source node id

parameters - the Parameters object to get the parameters passed into the request

Returns:

the rendition results

getRendition

Rendition getRendition(String nodeId,
                       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:

nodeId - the source node id

renditionId - the rendition id

parameters - the Parameters object to get the parameters passed into the request

Returns:

the Rendition object

createRendition

void createRendition(String nodeId,
                     Rendition rendition,
                     Parameters parameters)

Creates a rendition for the given node asynchronously.

Parameters:

nodeId - the source node id

rendition - the Rendition request

parameters - the Parameters object to get the parameters passed into the request

getContent

BinaryResource getContent(String nodeId,
                          String renditionId,
                          Parameters parameters)

Downloads rendition.

Parameters:

nodeId - the source node id

renditionId - the rendition id

parameters - the Parameters object to get the parameters passed into the request

Returns:

the rendition stream

getContent

BinaryResource getContent(org.alfresco.service.cmr.repository.NodeRef sourceNodeRef,
                          String renditionId,
                          Parameters parameters)

Downloads rendition.

Parameters:

sourceNodeRef - the source nodeRef

renditionId - the rendition id

parameters - the Parameters object to get the parameters passed into the request

Returns:

the rendition stream