Package org.alfresco.rest.api
Interface Renditions
- All Known Implementing Classes:
RenditionsImpl
public interface Renditions
Renditions API
- Author:
- Jamal Kaabi-Mofrad, janv
-
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptionvoid
createRendition
(NodeRef nodeRef, String versionId, Rendition rendition, boolean executeAsync, Parameters parameters) Creates a rendition for the given node - either async r syncvoid
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, String versionId, List<Rendition> renditions, Parameters parameters) Creates renditions that don't already exist 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.void
deleteRendition
(NodeRef nodeRef, String versionId, String renditionId, Parameters parameters) Delete the rendition node.void
deleteRendition
(NodeRef nodeRef, String renditionId, Parameters parameters) Delete the rendition node.getContent
(NodeRef nodeRef, String versionId, String renditionId, Parameters parameters) Downloads rendition.getContent
(NodeRef nodeRef, String renditionId, Parameters parameters) Downloads rendition.getContentNoValidation
(NodeRef nodeRef, String versionId, String renditionId, Parameters parameters) Downloads rendition.getContentNoValidation
(NodeRef nodeRef, String renditionId, Parameters parameters) Downloads rendition.getRendition
(NodeRef nodeRef, String versionId, String renditionId, Parameters parameters) Gets information about a rendition of a node in the repository.getRendition
(NodeRef nodeRef, String renditionId, Parameters parameters) Gets information about a rendition of a node in the repository.getRenditions
(NodeRef nodeRef, String versionId, Parameters parameters) Lists all available renditions includes those that have been created and those that are yet to be created.getRenditions
(NodeRef nodeRef, Parameters parameters) Lists all available renditions includes those that have been created and those that are yet to be created.default DirectAccessUrl
requestContentDirectUrl
(String nodeId, String versionId, String renditionId, boolean attachment) Gets a presigned URL to directly access content.default DirectAccessUrl
requestContentDirectUrl
(String nodeId, String versionId, String renditionId, boolean attachment, Long validFor) Gets a presigned URL to directly access content.default DirectAccessUrl
requestContentDirectUrl
(NodeRef nodeRef, String versionId, String renditionId, boolean attachment) Gets a presigned URL to directly access content.requestContentDirectUrl
(NodeRef nodeRef, String versionId, String renditionId, boolean attachment, Long validFor) Gets a presigned URL to directly access content.
-
Field Details
-
PARAM_STATUS
- See Also:
-
PARAM_ATTACHMENT
- See Also:
-
PARAM_PLACEHOLDER
- See Also:
-
-
Method Details
-
getRenditions
Lists all available renditions includes those that have been created and those that are yet to be created.- Parameters:
nodeRef
- the source/live nodeRefparameters
- theParameters
object to get the parameters passed into the request- Returns:
- the rendition results
-
getRenditions
CollectionWithPagingInfo<Rendition> getRenditions(NodeRef nodeRef, String versionId, Parameters parameters) Lists all available renditions includes those that have been created and those that are yet to be created.- Parameters:
nodeRef
- the source/live nodeRefversionId
- the version id (aka version label)parameters
- theParameters
object to get the parameters passed into the request- Returns:
- the rendition results
-
getRendition
Gets information about a rendition of a node in the repository. If there is no rendition, then returns the available/registered rendition.- Parameters:
nodeRef
- the source nodeRef, ie. live noderenditionId
- the rendition idparameters
- theParameters
object to get the parameters passed into the request- Returns:
- the
Rendition
object
-
getRendition
Rendition getRendition(NodeRef nodeRef, String versionId, 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
- the source nodeRef, ie. live nodeversionId
- the version id (aka version label)renditionId
- the rendition idparameters
- theParameters
object to get the parameters passed into the request- Returns:
- the
Rendition
object
-
createRendition
Creates a rendition for the given node asynchronously.- Parameters:
nodeRef
- the source nodeRef, ie. live noderendition
- 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
- the source nodeRef, ie. live noderendition
- theRendition
requestexecuteAsync
-parameters
-
-
createRendition
void createRendition(NodeRef nodeRef, String versionId, Rendition rendition, boolean executeAsync, Parameters parameters) Creates a rendition for the given node - either async r sync- Parameters:
nodeRef
- the source nodeRef, ie. live nodeversionId
- the version id (aka version label)rendition
- theRendition
requestexecuteAsync
-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
- the source nodeRef, ie. live noderenditions
- the list ofRendition
requestsparameters
- 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.
-
createRenditions
void createRenditions(NodeRef nodeRef, String versionId, List<Rendition> renditions, Parameters parameters) throws NotFoundException, ConstraintViolatedException Creates renditions that don't already exist for the given node asynchronously.- Parameters:
nodeRef
- the source nodeRef, ie. live nodeversionId
- the version id (aka version label)renditions
- the list ofRendition
requestsparameters
- 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.
-
deleteRendition
Delete the rendition node.- Parameters:
nodeRef
- the source nodeRef, ie. live noderenditionId
- the rendition idparameters
- theParameters
object to get the parameters passed into the request
-
deleteRendition
Delete the rendition node.- Parameters:
nodeRef
- the source nodeRef, ie. live nodeversionId
- the version id (aka version label)renditionId
- the rendition idparameters
- theParameters
object to get the parameters passed into the request
-
getContent
Downloads rendition.- Parameters:
nodeRef
- the source nodeRef, ie. live noderenditionId
- the rendition idparameters
- theParameters
object to get the parameters passed into the request- Returns:
- the rendition stream
-
getContent
BinaryResource getContent(NodeRef nodeRef, String versionId, String renditionId, Parameters parameters) Downloads rendition.- Parameters:
nodeRef
- the source nodeRef, ie. live nodeversionId
- the version id (aka version label)renditionId
- the rendition idparameters
- theParameters
object to get the parameters passed into the request- Returns:
- the rendition stream
-
getContentNoValidation
Downloads rendition.- Parameters:
nodeRef
- the source nodeRef, ie. live noderenditionId
- the rendition idparameters
- theParameters
object to get the parameters passed into the request- Returns:
- the rendition stream
-
getContentNoValidation
BinaryResource getContentNoValidation(NodeRef nodeRef, String versionId, String renditionId, Parameters parameters) Downloads rendition.- Parameters:
nodeRef
- the source nodeRef, ie. live nodeversionId
- the version id (aka version label)renditionId
- the rendition idparameters
- theParameters
object to get the parameters passed into the request- Returns:
- the rendition stream
-
requestContentDirectUrl
default DirectAccessUrl requestContentDirectUrl(String nodeId, String versionId, String renditionId, boolean attachment) Gets a presigned URL to directly access content.- Parameters:
nodeId
- the node id for which to obtain the direct accessURL
versionId
- the version id (aka version label)renditionId
- the rendition idattachment
-true
if an attachmentURL
is requested,false
for an embeddedURL
- Returns:
- a direct access
URL
object for the content
-
requestContentDirectUrl
default DirectAccessUrl requestContentDirectUrl(String nodeId, String versionId, String renditionId, boolean attachment, Long validFor) Gets a presigned URL to directly access content.- Parameters:
nodeId
- the node id for which to obtain the direct accessURL
versionId
- the version id (aka version label)renditionId
- the rendition idattachment
-true
if an attachmentURL
is requested,false
for an embeddedURL
validFor
- the time at which the direct accessURL
will expire- Returns:
- a direct access
URL
object for the content
-
requestContentDirectUrl
default DirectAccessUrl requestContentDirectUrl(NodeRef nodeRef, String versionId, String renditionId, boolean attachment) Gets a presigned URL to directly access content.- Parameters:
nodeRef
- the node reference for which to obtain the direct accessURL
versionId
- the version id (aka version label)renditionId
- the rendition idattachment
-true
if an attachmentURL
is requested,false
for an embeddedURL
- Returns:
- a direct access
URL
object for the content.
-
requestContentDirectUrl
DirectAccessUrl requestContentDirectUrl(NodeRef nodeRef, String versionId, String renditionId, boolean attachment, Long validFor) Gets a presigned URL to directly access content.- Parameters:
nodeRef
- the node reference for which to obtain the direct accessURL
versionId
- the version id (aka version label)renditionId
- the rendition idattachment
-true
if an attachmentURL
is requested,false
for an embeddedURL
validFor
- the time at which the direct accessURL
will expire- Returns:
- a direct access
URL
object for the content.
-