Interface QuickShareLinks

All Known Implementing Classes:
QuickShareLinksImpl

public interface QuickShareLinks
Centralises access to quick share services and maps between representations.
Since:
publicapi1.0
Author:
janv, Jamal Kaabi-Mofrad
  • Field Details

  • Method Details

    • readById

      QuickShareLink readById(String sharedId, Parameters parameters)
      Returns limited metadata regarding the shared (content) link. Note: does *not* require authenticated access for (public) shared link.
    • readProperty

      BinaryResource readProperty(String sharedId, String renditionId, Parameters parameters) throws EntityNotFoundException
      Download file content (or rendition content) via shared link. Note: does *not* require authenticated access for (public) shared link.
      Parameters:
      sharedId -
      renditionId - - optional
      parameters - Parameters
      Returns:
      Throws:
      EntityNotFoundException
    • getRendition

      Rendition getRendition(String shareId, String renditionId)
      Gets information about a rendition of a shared link.
      Parameters:
      shareId -
      renditionId -
      Returns:
      the Rendition object
    • getRenditions

      CollectionWithPagingInfo<Rendition> getRenditions(String sharedId)
      List renditions info - note: only returns available (=> created) renditions. Note: does *not* require authenticated access for (public) shared link.
      Parameters:
      sharedId -
      Returns:
    • delete

      void delete(String sharedId, Parameters parameters)
      Delete the shared link. Once deleted, the shared link will no longer exist hence get/download will no longer work (ie. return 404). If the link is later re-created then a new unique shared id will be generated. Requires authenticated access.
      Parameters:
      sharedId - String id of the quick share
    • create

      List<QuickShareLink> create(List<QuickShareLink> nodeIds, Parameters parameters)
      Create quick share. Requires authenticated access.
      Parameters:
      nodeIds -
      parameters -
      Returns:
    • emailSharedLink

      void emailSharedLink(String sharedId, QuickShareLinkEmailRequest emailRequest, Parameters parameters)
      Notifies users by email that a content has been shared with them.
      Parameters:
      sharedId - The string id of the quick share
      emailRequest - The email details including its template details
      parameters - The Parameters object to get the parameters passed into the request
    • findLinks

      Find (search) for shared links visible to current user. Optionally filter by "sharedByUser/id" (if -me- then filter by current user).
      Parameters:
      parameters -
      Returns: