Package org.alfresco.rest.requests

Class SharedLinks

java.lang.Object
org.alfresco.rest.requests.ModelRequest<SharedLinks>
org.alfresco.rest.requests.SharedLinks
public class SharedLinks extends ModelRequest<SharedLinks>
Declares all Rest API under the /shared-links path
Author:
Meenal Bhave

  • Constructor Details

    • SharedLinks

      public SharedLinks(RestWrapper restWrapper)

  • Method Details

    • getSharedLinks

      public RestSharedLinksModelCollection getSharedLinks()
      Retrieve sharedLinks using GET call on /shared-links
      Returns:
      RestSharedLinksModelCollection
      Throws:
      JsonToModelConversionException

    • getSharedLink

      public RestSharedLinksModel getSharedLink(RestSharedLinksModel sharedLinksModel)
      Retrieve details for a specific sharedLink using GET call on "shared-links/{sharedLinkId}"
      Parameters:
      sharedLinksModel -
      Returns:
      RestSharedLinkModel
      Throws:
      JsonToModelConversionException

    • getSharedLinkContent

      public RestResponse getSharedLinkContent(RestSharedLinksModel sharedLinksModel)
      Retrieve content for a specific sharedLink using GET call on "shared-links/{sharedLinkId}/content"
      Parameters:
      sharedLinksModel -
      Returns:
      RestResponse

    • sendSharedLinkEmail

      public RestResponse sendSharedLinkEmail(RestSharedLinksModel sharedLinksModel, String postBody)
      Send email with a specific sharedLink using POST call on "shared-links/{sharedLinkId}/email"
      Parameters:
      sharedLinksModel -
      postBody -
      Returns:
      RestResponse

    • getSharedLinkRenditions

      public RestRenditionInfoModelCollection getSharedLinkRenditions(RestSharedLinksModel sharedLinksModel)
      Retrieves Renditions for the specified sharedLink
      Returns:
      RestRenditionInfoModelCollection
      Throws:
      JsonToModelConversionException

    • getSharedLinkRendition

      public RestRenditionInfoModel getSharedLinkRendition(RestSharedLinksModel sharedLinksModel, String renditionId)
      Retrieves specific Rendition for the specified sharedLink
      Parameters:
      sharedLinksModel -
      renditionId -
      Returns:
      RestRenditionInfoModel
      Throws:
      JsonToModelConversionException

    • getSharedLinkRenditionContent

      public RestResponse getSharedLinkRenditionContent(RestSharedLinksModel sharedLinksModel, String renditionId)
      Retrieve rendition content for the specified sharedLink using GET call on "shared-links/{sharedLinkId}/renditions/{renditionId}/content"
      Parameters:
      sharedLinksModel -
      renditionId -
      Returns:
      RestRenditionInfoModel

    • deleteSharedLink

      public void deleteSharedLink(RestSharedLinksModel sharedLinksModel)
      Removes SharedLink for the specified file, the sharedlink is deleted, file is unshared as a result
      Parameters:
      RestSharedLinksModel -

    • createSharedLink

      public RestSharedLinksModel createSharedLink(org.alfresco.utility.model.FileModel file)
      Creates SharedLink for the specified file
      Parameters:
      file -
      Returns:
      RestSharedLinksModel

    • createSharedLinks

      public RestSharedLinksModelCollection createSharedLinks(org.alfresco.utility.model.FileModel... files)
      Creates SharedLink for all the specified files
      Parameters:
      file - list
      Returns:
      RestSharedLinksModelCollection

    • createSharedLinkWithExpiryDate

      public RestSharedLinksModel createSharedLinkWithExpiryDate(org.alfresco.utility.model.FileModel file, String expiryDate)
      Creates SharedLink for the specified file, with the given expiry date
      Parameters:
      file -
      expiryDate - : format: "2027-03-23T23:00:00.000+0000";
      Returns:
      RestSharedLinksModel