mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-05-12 17:04:57 +00:00
39 lines
1.7 KiB
Markdown
39 lines
1.7 KiB
Markdown
---
|
|
Added: v2.0.0
|
|
Status: Active
|
|
---
|
|
|
|
# Shared Links Api service
|
|
|
|
Finds shared links to Content Services items.
|
|
|
|
## Class members
|
|
|
|
### Methods
|
|
|
|
- **createSharedLinks**(nodeId: `string` = `null`, options: `any` = `{}`): `Observable<SharedLinkEntry>`<br/>
|
|
Creates a shared link available to the current user.
|
|
- _nodeId:_ `string` - ID of the node to link to
|
|
- _options:_ `any` - Options supported by JSAPI
|
|
- **Returns** `Observable<SharedLinkEntry>` - The shared link just created
|
|
- **deleteSharedLink**(sharedId: `string` = `null`): `Observable<SharedLinkEntry>`<br/>
|
|
Deletes a shared link.
|
|
- _sharedId:_ `string` - ID of the link to delete
|
|
- **Returns** `Observable<SharedLinkEntry>` - Null response notifying when the operation is complete
|
|
- **getSharedLinks**(options: `any` = `{}`): [`Observable<NodePaging>`](../../lib/content-services/document-list/models/document-library.model.ts)<br/>
|
|
Gets shared links available to the current user.
|
|
- _options:_ `any` - Options supported by JSAPI
|
|
- **Returns** [`Observable<NodePaging>`](../../lib/content-services/document-list/models/document-library.model.ts) - List of shared links
|
|
|
|
## Details
|
|
|
|
Content Services allows users to generate URLs that can be shared with
|
|
other people, even if they don't have a Content Services account. These
|
|
URLs are known as _shared links_.
|
|
|
|
Use `getSharedLinks` to find all the shared links that are available to
|
|
the current user. You can supply a number of `options` to refine the
|
|
search; see the
|
|
[Alfresco JS API](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SharedlinksApi.md#findsharedlinks)
|
|
for more information.
|