Package org.alfresco.rest.api
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 Summary
Fields Modifier and Type Field Description static String
PARAM_INCLUDE_ALLOWABLEOPERATIONS
static String
PARAM_INCLUDE_PATH
static String
PARAM_SHAREDBY
API Constants - query parameters, etc
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description List<QuickShareLink>
create(List<QuickShareLink> nodeIds, Parameters parameters)
Create quick share.void
delete(String sharedId, Parameters parameters)
Delete the shared link.void
emailSharedLink(String sharedId, QuickShareLinkEmailRequest emailRequest, Parameters parameters)
Notifies users by email that a content has been shared with them.CollectionWithPagingInfo<QuickShareLink>
findLinks(Parameters parameters)
Find (search) for shared links visible to current user.Rendition
getRendition(String shareId, String renditionId)
Gets information about a rendition of a shared link.CollectionWithPagingInfo<Rendition>
getRenditions(String sharedId)
List renditions info - note: only returns available (=> created) renditions.QuickShareLink
readById(String sharedId, Parameters parameters)
Returns limited metadata regarding the shared (content) link.BinaryResource
readProperty(String sharedId, String renditionId, Parameters parameters)
Download file content (or rendition content) via shared link.
-
-
-
Field Detail
-
PARAM_SHAREDBY
static final String PARAM_SHAREDBY
API Constants - query parameters, etc- See Also:
- Constant Field Values
-
PARAM_INCLUDE_ALLOWABLEOPERATIONS
static final String PARAM_INCLUDE_ALLOWABLEOPERATIONS
- See Also:
- Constant Field Values
-
PARAM_INCLUDE_PATH
static final String PARAM_INCLUDE_PATH
- See Also:
- Constant Field Values
-
-
Method Detail
-
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
- - optionalparameters
-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 shareemailRequest
- The email details including its template detailsparameters
- TheParameters
object to get the parameters passed into the request
-
findLinks
CollectionWithPagingInfo<QuickShareLink> findLinks(Parameters parameters)
Find (search) for shared links visible to current user. Optionally filter by "sharedByUser/id" (if -me- then filter by current user).- Parameters:
parameters
-- Returns:
-
-