CommunitySolidServer/docs/interfaces/ldp_auxiliary_auxiliaryidentifierstrategy.auxiliaryidentifierstrategy.html
2021-03-23 12:00:09 +00:00

371 lines
21 KiB
HTML

<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>AuxiliaryIdentifierStrategy | Community Solid Server - v0.8.1</title>
<meta name="description" content="Documentation for Community Solid Server - v0.8.1">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</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 - v0.8.1</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 - v0.8.1</a>
</li>
<li>
<a href="../modules/ldp_auxiliary_auxiliaryidentifierstrategy.html">ldp/auxiliary/AuxiliaryIdentifierStrategy</a>
</li>
<li>
<a href="ldp_auxiliary_auxiliaryidentifierstrategy.auxiliaryidentifierstrategy.html">AuxiliaryIdentifierStrategy</a>
</li>
</ul>
<h1>Interface AuxiliaryIdentifierStrategy</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 auxiliary related ResourceIdentifiers.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">AuxiliaryIdentifierStrategy</span>
<ul class="tsd-hierarchy">
<li>
<a href="ldp_auxiliary_auxiliarystrategy.auxiliarystrategy.html" class="tsd-signature-type" data-tsd-kind="Interface">AuxiliaryStrategy</a>
</li>
<li>
<a href="index.auxiliarystrategy.html" class="tsd-signature-type" data-tsd-kind="Interface">AuxiliaryStrategy</a>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel">
<h3>Implemented by</h3>
<ul class="tsd-hierarchy">
<li><a href="../classes/ldp_auxiliary_routingauxiliaryidentifierstrategy.routingauxiliaryidentifierstrategy.html" class="tsd-signature-type" data-tsd-kind="Class">RoutingAuxiliaryIdentifierStrategy</a></li>
<li><a href="../classes/index.routingauxiliaryidentifierstrategy.html" class="tsd-signature-type" data-tsd-kind="Class">RoutingAuxiliaryIdentifierStrategy</a></li>
<li><a href="../classes/ldp_auxiliary_suffixauxiliaryidentifierstrategy.suffixauxiliaryidentifierstrategy.html" class="tsd-signature-type" data-tsd-kind="Class">SuffixAuxiliaryIdentifierStrategy</a></li>
<li><a href="../classes/index.suffixauxiliaryidentifierstrategy.html" class="tsd-signature-type" data-tsd-kind="Class">SuffixAuxiliaryIdentifierStrategy</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>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="ldp_auxiliary_auxiliaryidentifierstrategy.auxiliaryidentifierstrategy.html#getassociatedidentifier" class="tsd-kind-icon">get<wbr>Associated<wbr>Identifier</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="ldp_auxiliary_auxiliaryidentifierstrategy.auxiliaryidentifierstrategy.html#getauxiliaryidentifier" class="tsd-kind-icon">get<wbr>Auxiliary<wbr>Identifier</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="ldp_auxiliary_auxiliaryidentifierstrategy.auxiliaryidentifierstrategy.html#getauxiliaryidentifiers" class="tsd-kind-icon">get<wbr>Auxiliary<wbr>Identifiers</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="ldp_auxiliary_auxiliaryidentifierstrategy.auxiliaryidentifierstrategy.html#isauxiliaryidentifier" class="tsd-kind-icon">is<wbr>Auxiliary<wbr>Identifier</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="getassociatedidentifier" class="tsd-anchor"></a>
<h3>get<wbr>Associated<wbr>Identifier</h3>
<div class="tsd-signature tsd-kind-icon">get<wbr>Associated<wbr>Identifier<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>identifier<span class="tsd-signature-symbol">: </span><a href="ldp_representation_resourceidentifier.resourceidentifier.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceIdentifier</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><a href="ldp_representation_resourceidentifier.resourceidentifier.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceIdentifier</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/54ff231/src/ldp/auxiliary/AuxiliaryIdentifierStrategy.ts#L47">src/ldp/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>
<dl class="tsd-comment-tags">
<dt>param</dt>
<dd><p>Identifier of the auxiliary resource.</p>
</dd>
<dt>returns</dt>
<dd><p>The ResourceIdentifier of the corresponding resource.</p>
</dd>
</dl>
</div>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>identifier<span class="tsd-signature-symbol">: </span><a href="ldp_representation_resourceidentifier.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="ldp_representation_resourceidentifier.resourceidentifier.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceIdentifier</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>identifier: <a href="ldp_representation_resourceidentifier.resourceidentifier.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceIdentifier</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="ldp_representation_resourceidentifier.resourceidentifier.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceIdentifier</a></h4>
</li>
</ul>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="getauxiliaryidentifier" class="tsd-anchor"></a>
<h3>get<wbr>Auxiliary<wbr>Identifier</h3>
<div class="tsd-signature tsd-kind-icon">get<wbr>Auxiliary<wbr>Identifier<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>identifier<span class="tsd-signature-symbol">: </span><a href="ldp_representation_resourceidentifier.resourceidentifier.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceIdentifier</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><a href="ldp_representation_resourceidentifier.resourceidentifier.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceIdentifier</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/54ff231/src/ldp/auxiliary/AuxiliaryIdentifierStrategy.ts#L17">src/ldp/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>
<p>Should error if there are multiple results: see <a href="ldp_auxiliary_auxiliaryidentifierstrategy.auxiliaryidentifierstrategy.html#getauxiliaryidentifiers">getAuxiliaryIdentifiers</a>.</p>
<dl class="tsd-comment-tags">
<dt>param</dt>
<dd><p>The ResourceIdentifier of which we need the corresponding auxiliary resource.</p>
</dd>
<dt>returns</dt>
<dd><p>The ResourceIdentifier of the corresponding auxiliary resource.</p>
</dd>
</dl>
</div>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>identifier<span class="tsd-signature-symbol">: </span><a href="ldp_representation_resourceidentifier.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="ldp_representation_resourceidentifier.resourceidentifier.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceIdentifier</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>identifier: <a href="ldp_representation_resourceidentifier.resourceidentifier.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceIdentifier</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="ldp_representation_resourceidentifier.resourceidentifier.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceIdentifier</a></h4>
</li>
</ul>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="getauxiliaryidentifiers" class="tsd-anchor"></a>
<h3>get<wbr>Auxiliary<wbr>Identifiers</h3>
<div class="tsd-signature tsd-kind-icon">get<wbr>Auxiliary<wbr>Identifiers<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>identifier<span class="tsd-signature-symbol">: </span><a href="ldp_representation_resourceidentifier.resourceidentifier.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceIdentifier</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><a href="ldp_representation_resourceidentifier.resourceidentifier.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceIdentifier</a><span class="tsd-signature-symbol">[]</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/54ff231/src/ldp/auxiliary/AuxiliaryIdentifierStrategy.ts#L28">src/ldp/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="ldp_auxiliary_auxiliaryidentifierstrategy.auxiliaryidentifierstrategy.html#getauxiliaryidentifier">getAuxiliaryIdentifier</a>.</p>
</div>
<dl class="tsd-comment-tags">
<dt>param</dt>
<dd><p>The ResourceIdentifier of which we need the corresponding auxiliary resources.</p>
</dd>
<dt>returns</dt>
<dd><p>The ResourceIdentifiers of the corresponding auxiliary resources.</p>
</dd>
</dl>
</div>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>identifier<span class="tsd-signature-symbol">: </span><a href="ldp_representation_resourceidentifier.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="ldp_representation_resourceidentifier.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">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>identifier: <a href="ldp_representation_resourceidentifier.resourceidentifier.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceIdentifier</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="ldp_representation_resourceidentifier.resourceidentifier.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceIdentifier</a><span class="tsd-signature-symbol">[]</span></h4>
</li>
</ul>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="isauxiliaryidentifier" class="tsd-anchor"></a>
<h3>is<wbr>Auxiliary<wbr>Identifier</h3>
<div class="tsd-signature tsd-kind-icon">is<wbr>Auxiliary<wbr>Identifier<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>identifier<span class="tsd-signature-symbol">: </span><a href="ldp_representation_resourceidentifier.resourceidentifier.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceIdentifier</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/54ff231/src/ldp/auxiliary/AuxiliaryIdentifierStrategy.ts#L38">src/ldp/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>
<dl class="tsd-comment-tags">
<dt>param</dt>
<dd><p>Identifier to check.</p>
</dd>
<dt>returns</dt>
<dd><p>true if the input identifier points to an auxiliary resource.</p>
</dd>
</dl>
</div>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>identifier<span class="tsd-signature-symbol">: </span><a href="ldp_representation_resourceidentifier.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">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>identifier: <a href="ldp_representation_resourceidentifier.resourceidentifier.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceIdentifier</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
</li>
</ul>
</li>
</ul>
</div>
</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>
<li class="current tsd-kind-module">
<a href="../modules/ldp_auxiliary_auxiliaryidentifierstrategy.html">ldp/auxiliary/<wbr>Auxiliary<wbr>Identifier<wbr>Strategy</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-interface tsd-parent-kind-module">
<a href="ldp_auxiliary_auxiliaryidentifierstrategy.auxiliaryidentifierstrategy.html" class="tsd-kind-icon">Auxiliary<wbr>Identifier<wbr>Strategy</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="ldp_auxiliary_auxiliaryidentifierstrategy.auxiliaryidentifierstrategy.html#getassociatedidentifier" class="tsd-kind-icon">get<wbr>Associated<wbr>Identifier</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="ldp_auxiliary_auxiliaryidentifierstrategy.auxiliaryidentifierstrategy.html#getauxiliaryidentifier" class="tsd-kind-icon">get<wbr>Auxiliary<wbr>Identifier</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="ldp_auxiliary_auxiliaryidentifierstrategy.auxiliaryidentifierstrategy.html#getauxiliaryidentifiers" class="tsd-kind-icon">get<wbr>Auxiliary<wbr>Identifiers</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="ldp_auxiliary_auxiliaryidentifierstrategy.auxiliaryidentifierstrategy.html#isauxiliaryidentifier" class="tsd-kind-icon">is<wbr>Auxiliary<wbr>Identifier</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</ul>
</nav>
</div>
</div>
</div>
<footer>
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
<li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
</ul>
</div>
</div>
</footer>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>