mirror of
https://github.com/CommunitySolidServer/CommunitySolidServer.git
synced 2024-10-03 14:55:10 +00:00
58 lines
29 KiB
HTML
58 lines
29 KiB
HTML
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>AuxiliaryStrategy | Community Solid Server - v4.0.0</title><meta name="description" content="Documentation for Community Solid Server - v4.0.0"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></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 - v4.0.0</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">Community Solid Server - v4.0.0</a></li><li><a href="AuxiliaryStrategy.html">AuxiliaryStrategy</a></li></ul><h1>Interface AuxiliaryStrategy</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>A strategy for handling one or more types of auxiliary resources.
|
|
References to "an auxiliary resource" implicitly imply a specific type of auxiliary resources
|
|
supported by this strategy.</p>
|
|
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><a href="AuxiliaryIdentifierStrategy.html" class="tsd-signature-type" data-tsd-kind="Interface">AuxiliaryIdentifierStrategy</a><ul class="tsd-hierarchy"><li><span class="target">AuxiliaryStrategy</span></li></ul></li></ul></section><section class="tsd-panel"><h3>Implemented by</h3><ul class="tsd-hierarchy"><li><a href="../classes/ComposedAuxiliaryStrategy.html" class="tsd-signature-type" data-tsd-kind="Class">ComposedAuxiliaryStrategy</a></li><li><a href="../classes/RoutingAuxiliaryStrategy.html" class="tsd-signature-type" data-tsd-kind="Class">RoutingAuxiliaryStrategy</a></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-interface"><a href="AuxiliaryStrategy.html#addMetadata" class="tsd-kind-icon">add<wbr/>Metadata</a></li><li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"><a href="AuxiliaryStrategy.html#getAuxiliaryIdentifier" class="tsd-kind-icon">get<wbr/>Auxiliary<wbr/>Identifier</a></li><li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"><a href="AuxiliaryStrategy.html#getAuxiliaryIdentifiers" class="tsd-kind-icon">get<wbr/>Auxiliary<wbr/>Identifiers</a></li><li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"><a href="AuxiliaryStrategy.html#getSubjectIdentifier" class="tsd-kind-icon">get<wbr/>Subject<wbr/>Identifier</a></li><li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"><a href="AuxiliaryStrategy.html#isAuxiliaryIdentifier" class="tsd-kind-icon">is<wbr/>Auxiliary<wbr/>Identifier</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="AuxiliaryStrategy.html#isRequiredInRoot" class="tsd-kind-icon">is<wbr/>Required<wbr/>In<wbr/>Root</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="AuxiliaryStrategy.html#usesOwnAuthorization" class="tsd-kind-icon">uses<wbr/>Own<wbr/>Authorization</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="AuxiliaryStrategy.html#validate" class="tsd-kind-icon">validate</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="addMetadata" class="tsd-anchor"></a><h3 class="tsd-anchor-link">add<wbr/>Metadata<a href="#addMetadata" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">add<wbr/>Metadata<span class="tsd-signature-symbol">(</span>metadata<span class="tsd-signature-symbol">: </span><a href="../classes/RepresentationMetadata.html" class="tsd-signature-type" data-tsd-kind="Class">RepresentationMetadata</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/1c376cb/src/http/auxiliary/AuxiliaryStrategy.ts#L40">src/http/auxiliary/AuxiliaryStrategy.ts:40</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Adds metadata related to this auxiliary resource,
|
|
in case this is required for this type of auxiliary resource.
|
|
The metadata that is added depends on the given identifier being an auxiliary or subject resource:
|
|
the metadata will be used to link to the other one, and potentially add extra typing info.</p>
|
|
</div><div><p>Used for:
|
|
Solid, §4.3.1: "For any defined auxiliary resource available for a given Solid resource, all representations of
|
|
that resource MUST include an HTTP Link header pointing to the location of each auxiliary resource."
|
|
<a href="https://solid.github.io/specification/protocol#auxiliary-resources-server">https://solid.github.io/specification/protocol#auxiliary-resources-server</a></p>
|
|
<p>The above is an example of how that metadata would only be added in case the input is the subject identifier.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>metadata: <a href="../classes/RepresentationMetadata.html" class="tsd-signature-type" data-tsd-kind="Class">RepresentationMetadata</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Metadata to update.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"><a id="getAuxiliaryIdentifier" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Auxiliary<wbr/>Identifier<a href="#getAuxiliaryIdentifier" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">get<wbr/>Auxiliary<wbr/>Identifier<span class="tsd-signature-symbol">(</span>identifier<span class="tsd-signature-symbol">: </span><a href="ResourceIdentifier.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceIdentifier</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="ResourceIdentifier.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceIdentifier</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="AuxiliaryIdentifierStrategy.html">AuxiliaryIdentifierStrategy</a>.<a href="AuxiliaryIdentifierStrategy.html#getAuxiliaryIdentifier">getAuxiliaryIdentifier</a></p><ul><li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/1c376cb/src/http/auxiliary/AuxiliaryIdentifierStrategy.ts#L17">src/http/auxiliary/AuxiliaryIdentifierStrategy.ts:17</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Returns the identifier of the auxiliary resource corresponding to the given resource.
|
|
This does not guarantee that this auxiliary resource exists.</p>
|
|
</div><div><p>Should error if there are multiple results: see <a href="AuxiliaryStrategy.html#getAuxiliaryIdentifiers">getAuxiliaryIdentifiers</a>.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>identifier: <a href="ResourceIdentifier.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceIdentifier</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>The ResourceIdentifier of which we need the corresponding auxiliary resource.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="ResourceIdentifier.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceIdentifier</a></h4><div><p>The ResourceIdentifier of the corresponding auxiliary resource.</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"><a id="getAuxiliaryIdentifiers" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Auxiliary<wbr/>Identifiers<a href="#getAuxiliaryIdentifiers" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">get<wbr/>Auxiliary<wbr/>Identifiers<span class="tsd-signature-symbol">(</span>identifier<span class="tsd-signature-symbol">: </span><a href="ResourceIdentifier.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceIdentifier</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="ResourceIdentifier.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceIdentifier</a><span class="tsd-signature-symbol">[]</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="AuxiliaryIdentifierStrategy.html">AuxiliaryIdentifierStrategy</a>.<a href="AuxiliaryIdentifierStrategy.html#getAuxiliaryIdentifiers">getAuxiliaryIdentifiers</a></p><ul><li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/1c376cb/src/http/auxiliary/AuxiliaryIdentifierStrategy.ts#L28">src/http/auxiliary/AuxiliaryIdentifierStrategy.ts:28</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Returns all the identifiers of corresponding auxiliary resources.
|
|
This can be used when there are potentially multiple results.
|
|
In the case of a single result this should be an array containing the result of <a href="AuxiliaryStrategy.html#getAuxiliaryIdentifier">getAuxiliaryIdentifier</a>.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>identifier: <a href="ResourceIdentifier.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceIdentifier</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>The ResourceIdentifier of which we need the corresponding auxiliary resources.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="ResourceIdentifier.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceIdentifier</a><span class="tsd-signature-symbol">[]</span></h4><div><p>The ResourceIdentifiers of the corresponding auxiliary resources.</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"><a id="getSubjectIdentifier" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Subject<wbr/>Identifier<a href="#getSubjectIdentifier" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">get<wbr/>Subject<wbr/>Identifier<span class="tsd-signature-symbol">(</span>identifier<span class="tsd-signature-symbol">: </span><a href="ResourceIdentifier.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceIdentifier</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="ResourceIdentifier.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceIdentifier</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="AuxiliaryIdentifierStrategy.html">AuxiliaryIdentifierStrategy</a>.<a href="AuxiliaryIdentifierStrategy.html#getSubjectIdentifier">getSubjectIdentifier</a></p><ul><li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/1c376cb/src/http/auxiliary/AuxiliaryIdentifierStrategy.ts#L47">src/http/auxiliary/AuxiliaryIdentifierStrategy.ts:47</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Returns the identifier of the resource which this auxiliary resource is referring to.
|
|
This does not guarantee that this resource exists.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>identifier: <a href="ResourceIdentifier.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceIdentifier</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Identifier of the auxiliary resource.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="ResourceIdentifier.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceIdentifier</a></h4><div><p>The ResourceIdentifier of the subject resource.</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"><a id="isAuxiliaryIdentifier" class="tsd-anchor"></a><h3 class="tsd-anchor-link">is<wbr/>Auxiliary<wbr/>Identifier<a href="#isAuxiliaryIdentifier" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"><li class="tsd-signature tsd-kind-icon">is<wbr/>Auxiliary<wbr/>Identifier<span class="tsd-signature-symbol">(</span>identifier<span class="tsd-signature-symbol">: </span><a href="ResourceIdentifier.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceIdentifier</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="AuxiliaryIdentifierStrategy.html">AuxiliaryIdentifierStrategy</a>.<a href="AuxiliaryIdentifierStrategy.html#isAuxiliaryIdentifier">isAuxiliaryIdentifier</a></p><ul><li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/1c376cb/src/http/auxiliary/AuxiliaryIdentifierStrategy.ts#L38">src/http/auxiliary/AuxiliaryIdentifierStrategy.ts:38</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Checks if the input identifier corresponds to an auxiliary resource.
|
|
This does not check if that auxiliary resource exists,
|
|
only if the identifier indicates that there could be an auxiliary resource there.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>identifier: <a href="ResourceIdentifier.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceIdentifier</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Identifier to check.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><div><p>true if the input identifier points to an auxiliary resource.</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="isRequiredInRoot" class="tsd-anchor"></a><h3 class="tsd-anchor-link">is<wbr/>Required<wbr/>In<wbr/>Root<a href="#isRequiredInRoot" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">is<wbr/>Required<wbr/>In<wbr/>Root<span class="tsd-signature-symbol">(</span>identifier<span class="tsd-signature-symbol">: </span><a href="ResourceIdentifier.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceIdentifier</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/1c376cb/src/http/auxiliary/AuxiliaryStrategy.ts#L23">src/http/auxiliary/AuxiliaryStrategy.ts:23</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Whether the root storage container requires this auxiliary resource to be present.
|
|
If yes, this means they can't be deleted individually from such a container.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>identifier: <a href="ResourceIdentifier.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceIdentifier</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Identifier of the auxiliary resource.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="usesOwnAuthorization" class="tsd-anchor"></a><h3 class="tsd-anchor-link">uses<wbr/>Own<wbr/>Authorization<a href="#usesOwnAuthorization" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">uses<wbr/>Own<wbr/>Authorization<span class="tsd-signature-symbol">(</span>identifier<span class="tsd-signature-symbol">: </span><a href="ResourceIdentifier.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceIdentifier</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/1c376cb/src/http/auxiliary/AuxiliaryStrategy.ts#L16">src/http/auxiliary/AuxiliaryStrategy.ts:16</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Whether this auxiliary resources uses its own authorization instead of the subject resource authorization.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>identifier: <a href="ResourceIdentifier.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceIdentifier</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Identifier of the auxiliary resource.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="validate" class="tsd-anchor"></a><h3 class="tsd-anchor-link">validate<a href="#validate" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">validate<span class="tsd-signature-symbol">(</span>representation<span class="tsd-signature-symbol">: </span><a href="Representation.html" class="tsd-signature-type" data-tsd-kind="Interface">Representation</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/1c376cb/src/http/auxiliary/AuxiliaryStrategy.ts#L48">src/http/auxiliary/AuxiliaryStrategy.ts:48</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Validates if the representation contains valid data for an auxiliary resource.
|
|
Should throw an error in case the data is invalid.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>representation: <a href="Representation.html" class="tsd-signature-type" data-tsd-kind="Interface">Representation</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Representation of the auxiliary resource.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface"><a href="AuxiliaryStrategy.html" class="tsd-kind-icon">Auxiliary<wbr/>Strategy</a><ul><li class="tsd-kind-method tsd-parent-kind-interface"><a href="AuxiliaryStrategy.html#addMetadata" class="tsd-kind-icon">add<wbr/>Metadata</a></li><li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"><a href="AuxiliaryStrategy.html#getAuxiliaryIdentifier" class="tsd-kind-icon">get<wbr/>Auxiliary<wbr/>Identifier</a></li><li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"><a href="AuxiliaryStrategy.html#getAuxiliaryIdentifiers" class="tsd-kind-icon">get<wbr/>Auxiliary<wbr/>Identifiers</a></li><li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"><a href="AuxiliaryStrategy.html#getSubjectIdentifier" class="tsd-kind-icon">get<wbr/>Subject<wbr/>Identifier</a></li><li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"><a href="AuxiliaryStrategy.html#isAuxiliaryIdentifier" class="tsd-kind-icon">is<wbr/>Auxiliary<wbr/>Identifier</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="AuxiliaryStrategy.html#isRequiredInRoot" class="tsd-kind-icon">is<wbr/>Required<wbr/>In<wbr/>Root</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="AuxiliaryStrategy.html#usesOwnAuthorization" class="tsd-kind-icon">uses<wbr/>Own<wbr/>Authorization</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="AuxiliaryStrategy.html#validate" class="tsd-kind-icon">validate</a></li></ul></li></ul></nav></div></div></div><footer class=""><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li><li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="overlay"></div><script src="../assets/main.js"></script></body></html> |