Interface Renditions

  • All Known Implementing Classes:
    RenditionsImpl

    public interface Renditions
    Renditions API
    Author:
    Jamal Kaabi-Mofrad
    • Method Detail

      • getRenditions

        CollectionWithPagingInfo<Rendition> getRenditions​(org.alfresco.service.cmr.repository.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 - the Parameters object to get the parameters passed into the request
        Returns:
        the rendition results
      • getRendition

        Rendition getRendition​(org.alfresco.service.cmr.repository.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 id
        parameters - the Parameters object to get the parameters passed into the request
        Returns:
        the Rendition object
      • createRendition

        void createRendition​(org.alfresco.service.cmr.repository.NodeRef nodeRef,
                             Rendition rendition,
                             Parameters parameters)
        Creates a rendition for the given node asynchronously.
        Parameters:
        nodeRef -
        rendition - the Rendition request
        parameters - the Parameters object to get the parameters passed into the request
      • createRendition

        void createRendition​(org.alfresco.service.cmr.repository.NodeRef nodeRef,
                             Rendition rendition,
                             boolean executeAsync,
                             Parameters parameters)
        Creates a rendition for the given node - either async r sync
        Parameters:
        nodeRef -
        rendition -
        executeAsync -
        parameters -
      • 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
      • getContentNoValidation

        BinaryResource getContentNoValidation​(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