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/docs/classes/ldp_auxiliary_suffixauxiliaryidentifierstrategy.suffixauxiliaryidentifierstrategy.html
RubenVerborgh e1e35a84d0 deploy: 0a68fbfe6ab39b5a9dd88f3880c5c4b343672f75
2021-05-04 14:35:57 +00:00

362 lines
21 KiB
HTML
Raw Blame History

<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>SuffixAuxiliaryIdentifierStrategy | Community Solid Server - v0.9.0</title>
<meta name="description" content="Documentation for Community Solid Server - v0.9.0">
<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.9.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 - v0.9.0</a>
</li>
<li>
<a href="../modules/ldp_auxiliary_suffixauxiliaryidentifierstrategy.html">ldp/auxiliary/SuffixAuxiliaryIdentifierStrategy</a>
</li>
<li>
<a href="ldp_auxiliary_suffixauxiliaryidentifierstrategy.suffixauxiliaryidentifierstrategy.html">SuffixAuxiliaryIdentifierStrategy</a>
</li>
</ul>
<h1>Class SuffixAuxiliaryIdentifierStrategy</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>Helper class that uses a suffix to determine if a resource is an auxiliary resource or not.
Simple string matching is used, so the dot needs to be included if needed, e.g. &quot;.acl&quot;.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">SuffixAuxiliaryIdentifierStrategy</span>
</li>
</ul>
</section>
<section class="tsd-panel">
<h3>Implements</h3>
<ul class="tsd-hierarchy">
<li><a href="../interfaces/ldp_auxiliary_auxiliaryidentifierstrategy.auxiliaryidentifierstrategy.html" class="tsd-signature-type" data-tsd-kind="Interface">AuxiliaryIdentifierStrategy</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>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="ldp_auxiliary_suffixauxiliaryidentifierstrategy.suffixauxiliaryidentifierstrategy.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-private-protected">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a href="ldp_auxiliary_suffixauxiliaryidentifierstrategy.suffixauxiliaryidentifierstrategy.html#suffix" class="tsd-kind-icon">suffix</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class"><a href="ldp_auxiliary_suffixauxiliaryidentifierstrategy.suffixauxiliaryidentifierstrategy.html#getassociatedidentifier" class="tsd-kind-icon">get<wbr>Associated<wbr>Identifier</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="ldp_auxiliary_suffixauxiliaryidentifierstrategy.suffixauxiliaryidentifierstrategy.html#getauxiliaryidentifier" class="tsd-kind-icon">get<wbr>Auxiliary<wbr>Identifier</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="ldp_auxiliary_suffixauxiliaryidentifierstrategy.suffixauxiliaryidentifierstrategy.html#getauxiliaryidentifiers" class="tsd-kind-icon">get<wbr>Auxiliary<wbr>Identifiers</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="ldp_auxiliary_suffixauxiliaryidentifierstrategy.suffixauxiliaryidentifierstrategy.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>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">new <wbr>Suffix<wbr>Auxiliary<wbr>Identifier<wbr>Strategy<span class="tsd-signature-symbol">(</span>suffix<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="ldp_auxiliary_suffixauxiliaryidentifierstrategy.suffixauxiliaryidentifierstrategy.html" class="tsd-signature-type" data-tsd-kind="Class">SuffixAuxiliaryIdentifierStrategy</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/0a68fbf/src/ldp/auxiliary/SuffixAuxiliaryIdentifierStrategy.ts#L10">src/ldp/auxiliary/SuffixAuxiliaryIdentifierStrategy.ts:10</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>suffix: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="ldp_auxiliary_suffixauxiliaryidentifierstrategy.suffixauxiliaryidentifierstrategy.html" class="tsd-signature-type" data-tsd-kind="Class">SuffixAuxiliaryIdentifierStrategy</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-private-protected">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-protected">
<a name="suffix" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> suffix</h3>
<div class="tsd-signature tsd-kind-icon">suffix<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/0a68fbf/src/ldp/auxiliary/SuffixAuxiliaryIdentifierStrategy.ts#L10">src/ldp/auxiliary/SuffixAuxiliaryIdentifierStrategy.ts:10</a></li>
</ul>
</aside>
</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-class">
<a name="getassociatedidentifier" class="tsd-anchor"></a>
<h3>get<wbr>Associated<wbr>Identifier</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Associated<wbr>Identifier<span class="tsd-signature-symbol">(</span>identifier<span class="tsd-signature-symbol">: </span><a href="../interfaces/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="../interfaces/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">
<aside class="tsd-sources">
<p>Implementation of AuxiliaryIdentifierStrategy.getAssociatedIdentifier</p>
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/0a68fbf/src/ldp/auxiliary/SuffixAuxiliaryIdentifierStrategy.ts#L31">src/ldp/auxiliary/SuffixAuxiliaryIdentifierStrategy.ts:31</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="../interfaces/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="../interfaces/ldp_representation_resourceidentifier.resourceidentifier.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceIdentifier</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getauxiliaryidentifier" class="tsd-anchor"></a>
<h3>get<wbr>Auxiliary<wbr>Identifier</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<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="../interfaces/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="../interfaces/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">
<aside class="tsd-sources">
<p>Implementation of AuxiliaryIdentifierStrategy.getAuxiliaryIdentifier</p>
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/0a68fbf/src/ldp/auxiliary/SuffixAuxiliaryIdentifierStrategy.ts#L19">src/ldp/auxiliary/SuffixAuxiliaryIdentifierStrategy.ts:19</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_suffixauxiliaryidentifierstrategy.suffixauxiliaryidentifierstrategy.html#getauxiliaryidentifiers">getAuxiliaryIdentifiers</a>.</p>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>identifier: <a href="../interfaces/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="../interfaces/ldp_representation_resourceidentifier.resourceidentifier.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceIdentifier</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getauxiliaryidentifiers" class="tsd-anchor"></a>
<h3>get<wbr>Auxiliary<wbr>Identifiers</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<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="../interfaces/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="../interfaces/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">
<aside class="tsd-sources">
<p>Implementation of AuxiliaryIdentifierStrategy.getAuxiliaryIdentifiers</p>
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/0a68fbf/src/ldp/auxiliary/SuffixAuxiliaryIdentifierStrategy.ts#L23">src/ldp/auxiliary/SuffixAuxiliaryIdentifierStrategy.ts:23</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_suffixauxiliaryidentifierstrategy.suffixauxiliaryidentifierstrategy.html#getauxiliaryidentifier">getAuxiliaryIdentifier</a>.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>identifier: <a href="../interfaces/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="../interfaces/ldp_representation_resourceidentifier.resourceidentifier.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceIdentifier</a><span class="tsd-signature-symbol">[]</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="isauxiliaryidentifier" class="tsd-anchor"></a>
<h3>is<wbr>Auxiliary<wbr>Identifier</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<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="../interfaces/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">
<aside class="tsd-sources">
<p>Implementation of AuxiliaryIdentifierStrategy.isAuxiliaryIdentifier</p>
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/0a68fbf/src/ldp/auxiliary/SuffixAuxiliaryIdentifierStrategy.ts#L27">src/ldp/auxiliary/SuffixAuxiliaryIdentifierStrategy.ts:27</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="../interfaces/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>
</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_suffixauxiliaryidentifierstrategy.html">ldp/auxiliary/<wbr>Suffix<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-class tsd-parent-kind-module">
<a href="ldp_auxiliary_suffixauxiliaryidentifierstrategy.suffixauxiliaryidentifierstrategy.html" class="tsd-kind-icon">Suffix<wbr>Auxiliary<wbr>Identifier<wbr>Strategy</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class">
<a href="ldp_auxiliary_suffixauxiliaryidentifierstrategy.suffixauxiliaryidentifierstrategy.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-protected">
<a href="ldp_auxiliary_suffixauxiliaryidentifierstrategy.suffixauxiliaryidentifierstrategy.html#suffix" class="tsd-kind-icon">suffix</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="ldp_auxiliary_suffixauxiliaryidentifierstrategy.suffixauxiliaryidentifierstrategy.html#getassociatedidentifier" class="tsd-kind-icon">get<wbr>Associated<wbr>Identifier</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="ldp_auxiliary_suffixauxiliaryidentifierstrategy.suffixauxiliaryidentifierstrategy.html#getauxiliaryidentifier" class="tsd-kind-icon">get<wbr>Auxiliary<wbr>Identifier</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="ldp_auxiliary_suffixauxiliaryidentifierstrategy.suffixauxiliaryidentifierstrategy.html#getauxiliaryidentifiers" class="tsd-kind-icon">get<wbr>Auxiliary<wbr>Identifiers</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="ldp_auxiliary_suffixauxiliaryidentifierstrategy.suffixauxiliaryidentifierstrategy.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-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>
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</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>
</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>
</ul>
</div>
</div>
</footer>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink