Mirroristas/CommunitySolidServer
2
0
Fork 0
mirror of https://github.com/CommunitySolidServer/CommunitySolidServer.git synced 2024-10-03 14:55:10 +00:00
Code Issues Packages Projects Releases Wiki Activity
CommunitySolidServer/7.x/docs/interfaces/LinkWebIdHandlerArgs.html

15 lines
17 KiB
HTML
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>LinkWebIdHandlerArgs | Community Solid Server - v7.1.1</title><meta name="description" content="Documentation for Community Solid Server"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><link rel="stylesheet" href="../assets/custom.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Community Solid Server - v7.1.1</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">Community Solid Server</a></li><li><a href="LinkWebIdHandlerArgs.html">LinkWebIdHandlerArgs</a></li></ul><h1>Interface LinkWebIdHandlerArgs</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">LinkWebIdHandlerArgs</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><a class="tsd-kind-property" href="LinkWebIdHandlerArgs.html#baseUrl">baseUrl</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="LinkWebIdHandlerArgs.html#ownershipValidator">ownershipValidator</a><span class="tsd-signature-symbol">: </span><a href="../classes/OwnershipValidator.html" class="tsd-signature-type tsd-kind-class">OwnershipValidator</a><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="LinkWebIdHandlerArgs.html#podStore">podStore</a><span class="tsd-signature-symbol">: </span><a href="PodStore.html" class="tsd-signature-type tsd-kind-interface">PodStore</a><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="LinkWebIdHandlerArgs.html#storageStrategy">storageStrategy</a><span class="tsd-signature-symbol">: </span><a href="StorageLocationStrategy.html" class="tsd-signature-type tsd-kind-interface">StorageLocationStrategy</a><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="LinkWebIdHandlerArgs.html#webIdRoute">webIdRoute</a><span class="tsd-signature-symbol">: </span><a href="../types/WebIdLinkRoute.html" class="tsd-signature-type tsd-kind-type-alias">WebIdLinkRoute</a><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="LinkWebIdHandlerArgs.html#webIdStore">webIdStore</a><span class="tsd-signature-symbol">: </span><a href="WebIdStore.html" class="tsd-signature-type tsd-kind-interface">WebIdStore</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/4599bf413e0ca08725d22b5e01fe43e97ef7d714/src/identity/interaction/webid/LinkWebIdHandler.ts#L26">src/identity/interaction/webid/LinkWebIdHandler.ts:26</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="LinkWebIdHandlerArgs.html#baseUrl" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>base<wbr/>Url</span></a>
<a href="LinkWebIdHandlerArgs.html#ownershipValidator" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ownership<wbr/>Validator</span></a>
<a href="LinkWebIdHandlerArgs.html#podStore" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>pod<wbr/>Store</span></a>
<a href="LinkWebIdHandlerArgs.html#storageStrategy" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>storage<wbr/>Strategy</span></a>
<a href="LinkWebIdHandlerArgs.html#webIdRoute" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>web<wbr/>Id<wbr/>Route</span></a>
<a href="LinkWebIdHandlerArgs.html#webIdStore" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>web<wbr/>Id<wbr/>Store</span></a>
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="baseUrl" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>base<wbr/>Url</span><a href="#baseUrl" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">base<wbr/>Url</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Base URL of the server.
Used to indicate in the response what the object of the <code>solid:oidcIssuer</code> triple should be.</p>
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/4599bf413e0ca08725d22b5e01fe43e97ef7d714/src/identity/interaction/webid/LinkWebIdHandler.ts#L31">src/identity/interaction/webid/LinkWebIdHandler.ts:31</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="ownershipValidator" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>ownership<wbr/>Validator</span><a href="#ownershipValidator" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ownership<wbr/>Validator</span><span class="tsd-signature-symbol">:</span> <a href="../classes/OwnershipValidator.html" class="tsd-signature-type tsd-kind-class">OwnershipValidator</a></div><div class="tsd-comment tsd-typography"><p>Validates whether the user trying to link the WebID is the actual owner of that WebID.</p>
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/4599bf413e0ca08725d22b5e01fe43e97ef7d714/src/identity/interaction/webid/LinkWebIdHandler.ts#L35">src/identity/interaction/webid/LinkWebIdHandler.ts:35</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="podStore" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>pod<wbr/>Store</span><a href="#podStore" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">pod<wbr/>Store</span><span class="tsd-signature-symbol">:</span> <a href="PodStore.html" class="tsd-signature-type tsd-kind-interface">PodStore</a></div><div class="tsd-comment tsd-typography"><p>Pod store to find out if the account created the pod containing the WebID.</p>
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/4599bf413e0ca08725d22b5e01fe43e97ef7d714/src/identity/interaction/webid/LinkWebIdHandler.ts#L39">src/identity/interaction/webid/LinkWebIdHandler.ts:39</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="storageStrategy" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>storage<wbr/>Strategy</span><a href="#storageStrategy" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">storage<wbr/>Strategy</span><span class="tsd-signature-symbol">:</span> <a href="StorageLocationStrategy.html" class="tsd-signature-type tsd-kind-interface">StorageLocationStrategy</a></div><div class="tsd-comment tsd-typography"><p>Before calling the <a href="../classes/OwnershipValidator.html" class="tsd-kind-class">OwnershipValidator</a>, we first check if the target WebID is in a pod owned by the user.</p>
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/4599bf413e0ca08725d22b5e01fe43e97ef7d714/src/identity/interaction/webid/LinkWebIdHandler.ts#L51">src/identity/interaction/webid/LinkWebIdHandler.ts:51</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="webIdRoute" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>web<wbr/>Id<wbr/>Route</span><a href="#webIdRoute" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">web<wbr/>Id<wbr/>Route</span><span class="tsd-signature-symbol">:</span> <a href="../types/WebIdLinkRoute.html" class="tsd-signature-type tsd-kind-type-alias">WebIdLinkRoute</a></div><div class="tsd-comment tsd-typography"><p>Route used to generate the WebID link resource URL.</p>
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/4599bf413e0ca08725d22b5e01fe43e97ef7d714/src/identity/interaction/webid/LinkWebIdHandler.ts#L47">src/identity/interaction/webid/LinkWebIdHandler.ts:47</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="webIdStore" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>web<wbr/>Id<wbr/>Store</span><a href="#webIdStore" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">web<wbr/>Id<wbr/>Store</span><span class="tsd-signature-symbol">:</span> <a href="WebIdStore.html" class="tsd-signature-type tsd-kind-interface">WebIdStore</a></div><div class="tsd-comment tsd-typography"><p>WebID store to store WebID links.</p>
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/4599bf413e0ca08725d22b5e01fe43e97ef7d714/src/identity/interaction/webid/LinkWebIdHandler.ts#L43">src/identity/interaction/webid/LinkWebIdHandler.ts:43</a></li></ul></aside></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#baseUrl" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>base<wbr/>Url</span></a><a href="#ownershipValidator" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ownership<wbr/>Validator</span></a><a href="#podStore" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>pod<wbr/>Store</span></a><a href="#storageStrategy" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>storage<wbr/>Strategy</span></a><a href="#webIdRoute" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>web<wbr/>Id<wbr/>Route</span></a><a href="#webIdStore" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>web<wbr/>Id<wbr/>Store</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>Community Solid Server - v7.1.1</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer></footer><div class="overlay"></div></body></html>
Reference in New Issue View Git Blame Copy Permalink