UNPKG

manifesto.js

Version:

IIIF Presentation API utility library for client and server

694 lines 146 kB
<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>Utils | manifesto</title> <meta name="description" content=""> <meta name="viewport" content="width=device-width, initial-scale=1"> <link rel="stylesheet" href="../assets/css/main.css"> </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.js" 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">manifesto</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> <input type="checkbox" id="tsd-filter-only-exported" /> <label class="tsd-widget" for="tsd-filter-only-exported">Only exported</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="../globals.html">Globals</a> </li> <li> <a href="../modules/_utils_.html">&quot;Utils&quot;</a> </li> <li> <a href="_utils_.utils.html">Utils</a> </li> </ul> <h1>Class Utils</h1> </div> </div> </header> <div class="container container-main"> <div class="row"> <div class="col-8 col-content"> <section class="tsd-panel tsd-hierarchy"> <h3>Hierarchy</h3> <ul class="tsd-hierarchy"> <li> <span class="target">Utils</span> </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-class tsd-is-static"><a href="_utils_.utils.html#attemptresourcewithtoken" class="tsd-kind-icon">attempt<wbr>Resource<wbr>With<wbr>Token</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_utils_.utils.html#authorize" class="tsd-kind-icon">authorize</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_utils_.utils.html#createauthorizationfailederror" class="tsd-kind-icon">create<wbr>Authorization<wbr>Failed<wbr>Error</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_utils_.utils.html#createerror" class="tsd-kind-icon">create<wbr>Error</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_utils_.utils.html#createinternalservererror" class="tsd-kind-icon">create<wbr>Internal<wbr>Server<wbr>Error</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_utils_.utils.html#createrestrictederror" class="tsd-kind-icon">create<wbr>Restricted<wbr>Error</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_utils_.utils.html#doauthchain" class="tsd-kind-icon">do<wbr>Auth<wbr>Chain</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_utils_.utils.html#generatetreenodeids" class="tsd-kind-icon">generate<wbr>Tree<wbr>Node<wbr>Ids</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_utils_.utils.html#getimagequality" class="tsd-kind-icon">get<wbr>Image<wbr>Quality</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_utils_.utils.html#getinexactlocale" class="tsd-kind-icon">get<wbr>Inexact<wbr>Locale</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_utils_.utils.html#getlocalisedvalue" class="tsd-kind-icon">get<wbr>Localised<wbr>Value</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_utils_.utils.html#getmediatype" class="tsd-kind-icon">get<wbr>Media<wbr>Type</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_utils_.utils.html#getresourcebyid" class="tsd-kind-icon">get<wbr>Resource<wbr>ById</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_utils_.utils.html#getservice" class="tsd-kind-icon">get<wbr>Service</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_utils_.utils.html#getservices" class="tsd-kind-icon">get<wbr>Services</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_utils_.utils.html#gettemporalcomponent" class="tsd-kind-icon">get<wbr>Temporal<wbr>Component</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_utils_.utils.html#isimageprofile" class="tsd-kind-icon">is<wbr>Image<wbr>Profile</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_utils_.utils.html#islevel0imageprofile" class="tsd-kind-icon">is<wbr>Level0<wbr>Image<wbr>Profile</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_utils_.utils.html#islevel1imageprofile" class="tsd-kind-icon">is<wbr>Level1<wbr>Image<wbr>Profile</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_utils_.utils.html#islevel2imageprofile" class="tsd-kind-icon">is<wbr>Level2<wbr>Image<wbr>Profile</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_utils_.utils.html#loadexternalresourceauth09" class="tsd-kind-icon">load<wbr>External<wbr>Resource<wbr>Auth09</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_utils_.utils.html#loadexternalresourceauth1" class="tsd-kind-icon">load<wbr>External<wbr>Resource<wbr>Auth1</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_utils_.utils.html#loadexternalresourcesauth09" class="tsd-kind-icon">load<wbr>External<wbr>Resources<wbr>Auth09</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_utils_.utils.html#loadexternalresourcesauth1" class="tsd-kind-icon">load<wbr>External<wbr>Resources<wbr>Auth1</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_utils_.utils.html#loadmanifest" class="tsd-kind-icon">load<wbr>Manifest</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_utils_.utils.html#normalisetype" class="tsd-kind-icon">normalise<wbr>Type</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_utils_.utils.html#normaliseurl" class="tsd-kind-icon">normalise<wbr>Url</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_utils_.utils.html#normalisedurlsmatch" class="tsd-kind-icon">normalised<wbr>Urls<wbr>Match</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_utils_.utils.html#parsemanifest" class="tsd-kind-icon">parse<wbr>Manifest</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private tsd-is-static"><a href="_utils_.utils.html#showauthinteraction" class="tsd-kind-icon">show<wbr>Auth<wbr>Interaction</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_utils_.utils.html#traverseandfind" class="tsd-kind-icon">traverse<wbr>And<wbr>Find</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-class tsd-is-static"> <a name="attemptresourcewithtoken" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagStatic">Static</span> attempt<wbr>Resource<wbr>With<wbr>Token</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static"> <li class="tsd-signature tsd-kind-icon">attempt<wbr>Resource<wbr>With<wbr>Token<span class="tsd-signature-symbol">(</span>resource<span class="tsd-signature-symbol">: </span><a href="../interfaces/_iexternalresource_.iexternalresource.html" class="tsd-signature-type">IExternalResource</a>, openTokenService<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">function</span>, authService<span class="tsd-signature-symbol">: </span><a href="_service_.service.html" class="tsd-signature-type">Service</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">&lt;</span><a href="../interfaces/_iexternalresource_.iexternalresource.html" class="tsd-signature-type">IExternalResource</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/edsilv/manifesto/blob/b83b754/src/Utils.ts#L467">Utils.ts:467</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>resource: <a href="../interfaces/_iexternalresource_.iexternalresource.html" class="tsd-signature-type">IExternalResource</a></h5> </li> <li> <h5>openTokenService: <span class="tsd-signature-type">function</span></h5> <ul class="tsd-parameters"> <li class="tsd-parameter-siganture"> <ul class="tsd-signatures tsd-kind-type-literal tsd-is-not-exported"> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>resource<span class="tsd-signature-symbol">: </span><a href="../interfaces/_iexternalresource_.iexternalresource.html" class="tsd-signature-type">IExternalResource</a>, tokenService<span class="tsd-signature-symbol">: </span><a href="_service_.service.html" class="tsd-signature-type">Service</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">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>resource: <a href="../interfaces/_iexternalresource_.iexternalresource.html" class="tsd-signature-type">IExternalResource</a></h5> </li> <li> <h5>tokenService: <a href="_service_.service.html" class="tsd-signature-type">Service</a></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4> </li> </ul> </li> </ul> </li> <li> <h5>authService: <a href="_service_.service.html" class="tsd-signature-type">Service</a></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_iexternalresource_.iexternalresource.html" class="tsd-signature-type">IExternalResource</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static"> <a name="authorize" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagStatic">Static</span> authorize</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static"> <li class="tsd-signature tsd-kind-icon">authorize<span class="tsd-signature-symbol">(</span>resource<span class="tsd-signature-symbol">: </span><a href="../interfaces/_iexternalresource_.iexternalresource.html" class="tsd-signature-type">IExternalResource</a>, tokenStorageStrategy<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, clickThrough<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">function</span>, restricted<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">function</span>, login<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">function</span>, getAccessToken<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">function</span>, storeAccessToken<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">function</span>, getStoredAccessToken<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">function</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_iexternalresource_.iexternalresource.html" class="tsd-signature-type">IExternalResource</a><span class="tsd-signature-symbol">&gt;</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/edsilv/manifesto/blob/b83b754/src/Utils.ts#L654">Utils.ts:654</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>resource: <a href="../interfaces/_iexternalresource_.iexternalresource.html" class="tsd-signature-type">IExternalResource</a></h5> </li> <li> <h5>tokenStorageStrategy: <span class="tsd-signature-type">string</span></h5> </li> <li> <h5>clickThrough: <span class="tsd-signature-type">function</span></h5> <ul class="tsd-parameters"> <li class="tsd-parameter-siganture"> <ul class="tsd-signatures tsd-kind-type-literal tsd-is-not-exported"> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>resource<span class="tsd-signature-symbol">: </span><a href="../interfaces/_iexternalresource_.iexternalresource.html" class="tsd-signature-type">IExternalResource</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">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>resource: <a href="../interfaces/_iexternalresource_.iexternalresource.html" class="tsd-signature-type">IExternalResource</a></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4> </li> </ul> </li> </ul> </li> <li> <h5>restricted: <span class="tsd-signature-type">function</span></h5> <ul class="tsd-parameters"> <li class="tsd-parameter-siganture"> <ul class="tsd-signatures tsd-kind-type-literal tsd-is-not-exported"> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>resource<span class="tsd-signature-symbol">: </span><a href="../interfaces/_iexternalresource_.iexternalresource.html" class="tsd-signature-type">IExternalResource</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">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>resource: <a href="../interfaces/_iexternalresource_.iexternalresource.html" class="tsd-signature-type">IExternalResource</a></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4> </li> </ul> </li> </ul> </li> <li> <h5>login: <span class="tsd-signature-type">function</span></h5> <ul class="tsd-parameters"> <li class="tsd-parameter-siganture"> <ul class="tsd-signatures tsd-kind-type-literal tsd-is-not-exported"> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>resource<span class="tsd-signature-symbol">: </span><a href="../interfaces/_iexternalresource_.iexternalresource.html" class="tsd-signature-type">IExternalResource</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">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>resource: <a href="../interfaces/_iexternalresource_.iexternalresource.html" class="tsd-signature-type">IExternalResource</a></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4> </li> </ul> </li> </ul> </li> <li> <h5>getAccessToken: <span class="tsd-signature-type">function</span></h5> <ul class="tsd-parameters"> <li class="tsd-parameter-siganture"> <ul class="tsd-signatures tsd-kind-type-literal tsd-is-not-exported"> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>resource<span class="tsd-signature-symbol">: </span><a href="../interfaces/_iexternalresource_.iexternalresource.html" class="tsd-signature-type">IExternalResource</a>, rejectOnError<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_iaccesstoken_.iaccesstoken.html" class="tsd-signature-type">IAccessToken</a><span class="tsd-signature-symbol">&gt;</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>resource: <a href="../interfaces/_iexternalresource_.iexternalresource.html" class="tsd-signature-type">IExternalResource</a></h5> </li> <li> <h5>rejectOnError: <span class="tsd-signature-type">boolean</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_iaccesstoken_.iaccesstoken.html" class="tsd-signature-type">IAccessToken</a><span class="tsd-signature-symbol">&gt;</span></h4> </li> </ul> </li> </ul> </li> <li> <h5>storeAccessToken: <span class="tsd-signature-type">function</span></h5> <ul class="tsd-parameters"> <li class="tsd-parameter-siganture"> <ul class="tsd-signatures tsd-kind-type-literal tsd-is-not-exported"> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>resource<span class="tsd-signature-symbol">: </span><a href="../interfaces/_iexternalresource_.iexternalresource.html" class="tsd-signature-type">IExternalResource</a>, token<span class="tsd-signature-symbol">: </span><a href="../interfaces/_iaccesstoken_.iaccesstoken.html" class="tsd-signature-type">IAccessToken</a>, tokenStorageStrategy<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><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>resource: <a href="../interfaces/_iexternalresource_.iexternalresource.html" class="tsd-signature-type">IExternalResource</a></h5> </li> <li> <h5>token: <a href="../interfaces/_iaccesstoken_.iaccesstoken.html" class="tsd-signature-type">IAccessToken</a></h5> </li> <li> <h5>tokenStorageStrategy: <span class="tsd-signature-type">string</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4> </li> </ul> </li> </ul> </li> <li> <h5>getStoredAccessToken: <span class="tsd-signature-type">function</span></h5> <ul class="tsd-parameters"> <li class="tsd-parameter-siganture"> <ul class="tsd-signatures tsd-kind-type-literal tsd-is-not-exported"> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>resource<span class="tsd-signature-symbol">: </span><a href="../interfaces/_iexternalresource_.iexternalresource.html" class="tsd-signature-type">IExternalResource</a>, tokenStorageStrategy<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><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_iaccesstoken_.iaccesstoken.html" class="tsd-signature-type">IAccessToken</a><span class="tsd-signature-symbol">&gt;</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>resource: <a href="../interfaces/_iexternalresource_.iexternalresource.html" class="tsd-signature-type">IExternalResource</a></h5> </li> <li> <h5>tokenStorageStrategy: <span class="tsd-signature-type">string</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_iaccesstoken_.iaccesstoken.html" class="tsd-signature-type">IAccessToken</a><span class="tsd-signature-symbol">&gt;</span></h4> </li> </ul> </li> </ul> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_iexternalresource_.iexternalresource.html" class="tsd-signature-type">IExternalResource</a><span class="tsd-signature-symbol">&gt;</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static"> <a name="createauthorizationfailederror" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagStatic">Static</span> create<wbr>Authorization<wbr>Failed<wbr>Error</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static"> <li class="tsd-signature tsd-kind-icon">create<wbr>Authorization<wbr>Failed<wbr>Error<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Error</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/edsilv/manifesto/blob/b83b754/src/Utils.ts#L642">Utils.ts:642</a></li> </ul> </aside> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Error</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static"> <a name="createerror" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagStatic">Static</span> create<wbr>Error</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static"> <li class="tsd-signature tsd-kind-icon">create<wbr>Error<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><a href="../enums/_statuscode_.statuscode.html" class="tsd-signature-type">StatusCode</a>, message<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><span class="tsd-signature-type">Error</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/edsilv/manifesto/blob/b83b754/src/Utils.ts#L635">Utils.ts:635</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>name: <a href="../enums/_statuscode_.statuscode.html" class="tsd-signature-type">StatusCode</a></h5> </li> <li> <h5>message: <span class="tsd-signature-type">string</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Error</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static"> <a name="createinternalservererror" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagStatic">Static</span> create<wbr>Internal<wbr>Server<wbr>Error</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static"> <li class="tsd-signature tsd-kind-icon">create<wbr>Internal<wbr>Server<wbr>Error<span class="tsd-signature-symbol">(</span>message<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><span class="tsd-signature-type">Error</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/edsilv/manifesto/blob/b83b754/src/Utils.ts#L650">Utils.ts:650</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>message: <span class="tsd-signature-type">string</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Error</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static"> <a name="createrestrictederror" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagStatic">Static</span> create<wbr>Restricted<wbr>Error</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static"> <li class="tsd-signature tsd-kind-icon">create<wbr>Restricted<wbr>Error<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Error</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/edsilv/manifesto/blob/b83b754/src/Utils.ts#L646">Utils.ts:646</a></li> </ul> </aside> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Error</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static"> <a name="doauthchain" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagStatic">Static</span> do<wbr>Auth<wbr>Chain</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static"> <li class="tsd-signature tsd-kind-icon">do<wbr>Auth<wbr>Chain<span class="tsd-signature-symbol">(</span>resource<span class="tsd-signature-symbol">: </span><a href="../interfaces/_iexternalresource_.iexternalresource.html" class="tsd-signature-type">IExternalResource</a>, openContentProviderInteraction<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">function</span>, openTokenService<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">function</span>, userInteractedWithContentProvider<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">function</span>, getContentProviderInteraction<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">function</span>, handleMovedTemporarily<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">function</span>, showOutOfOptionsMessages<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">function</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_iexternalresource_.iexternalresource.html" class="tsd-signature-type">IExternalResource</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/edsilv/manifesto/blob/b83b754/src/Utils.ts#L352">Utils.ts:352</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>resource: <a href="../interfaces/_iexternalresource_.iexternalresource.html" class="tsd-signature-type">IExternalResource</a></h5> </li> <li> <h5>openContentProviderInteraction: <span class="tsd-signature-type">function</span></h5> <ul class="tsd-parameters"> <li class="tsd-parameter-siganture"> <ul class="tsd-signatures tsd-kind-type-literal tsd-is-not-exported"> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>service<span class="tsd-signature-symbol">: </span><a href="_service_.service.html" class="tsd-signature-type">Service</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>service: <a href="_service_.service.html" class="tsd-signature-type">Service</a></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4> </li> </ul> </li> </ul> </li> <li> <h5>openTokenService: <span class="tsd-signature-type">function</span></h5> <ul class="tsd-parameters"> <li class="tsd-parameter-siganture"> <ul class="tsd-signatures tsd-kind-type-literal tsd-is-not-exported"> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>resource<span class="tsd-signature-symbol">: </span><a href="../interfaces/_iexternalresource_.iexternalresource.html" class="tsd-signature-type">IExternalResource</a>, tokenService<span class="tsd-signature-symbol">: </span><a href="_service_.service.html" class="tsd-signature-type">Service</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">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>resource: <a href="../interfaces/_iexternalresource_.iexternalresource.html" class="tsd-signature-type">IExternalResource</a></h5> </li> <li> <h5>tokenService: <a href="_service_.service.html" class="tsd-signature-type">Service</a></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4> </li> </ul> </li> </ul> </li> <li> <h5>userInteractedWithContentProvider: <span class="tsd-signature-type">function</span></h5> <ul class="tsd-parameters"> <li class="tsd-parameter-siganture"> <ul class="tsd-signatures tsd-kind-type-literal tsd-is-not-exported"> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>contentProviderInteraction<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>contentProviderInteraction: <span class="tsd-signature-type">any</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4> </li> </ul> </li> </ul> </li> <li> <h5>getContentProviderInteraction: <span class="tsd-signature-type">function</span></h5> <ul class="tsd-parameters"> <li class="tsd-parameter-siganture"> <ul class="tsd-signatures tsd-kind-type-literal tsd-is-not-exported"> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>resource<span class="tsd-signature-symbol">: </span><a href="../interfaces/_iexternalresource_.iexternalresource.html" class="tsd-signature-type">IExternalResource</a>, service<span class="tsd-signature-symbol">: </span><a href="_service_.service.html" class="tsd-signature-type">Service</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">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>resource: <a href="../interfaces/_iexternalresource_.iexternalresource.html" class="tsd-signature-type">IExternalResource</a></h5> </li> <li> <h5>service: <a href="_service_.service.html" class="tsd-signature-type">Service</a></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4> </li> </ul> </li> </ul> </li> <li> <h5>handleMovedTemporarily: <span class="tsd-signature-type">function</span></h5> <ul class="tsd-parameters"> <li class="tsd-parameter-siganture"> <ul class="tsd-signatures tsd-kind-type-literal tsd-is-not-exported"> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>resource<span class="tsd-signature-symbol">: </span><a href="../interfaces/_iexternalresource_.iexternalresource.html" class="tsd-signature-type">IExternalResource</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">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>resource: <a href="../interfaces/_iexternalresource_.iexternalresource.html" class="tsd-signature-type">IExternalResource</a></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4> </li> </ul> </li> </ul> </li> <li> <h5>showOutOfOptionsMessages: <span class="tsd-signature-type">function</span></h5> <ul class="tsd-parameters"> <li class="tsd-parameter-siganture"> <ul class="tsd-signatures tsd-kind-type-literal tsd-is-not-exported"> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>resource<span class="tsd-signature-symbol">: </span><a href="../interfaces/_iexternalresource_.iexternalresource.html" class="tsd-signature-type">IExternalResource</a>, service<span class="tsd-signature-symbol">: </span><a href="_service_.service.html" class="tsd-signature-type">Service</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>resource: <a href="../interfaces/_iexternalresource_.iexternalresource.html" class="tsd-signature-type">IExternalResource</a></h5> </li> <li> <h5>service: <a href="_service_.service.html" class="tsd-signature-type">Service</a></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </li> </ul> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_iexternalresource_.iexternalresource.html" class="tsd-signature-type">IExternalResource</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static"> <a name="generatetreenodeids" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagStatic">Static</span> generate<wbr>Tree<wbr>Node<wbr>Ids</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static"> <li class="tsd-signature tsd-kind-icon">generate<wbr>Tree<wbr>Node<wbr>Ids<span class="tsd-signature-symbol">(</span>treeNode<span class="tsd-signature-symbol">: </span><a href="_treenode_.treenode.html" class="tsd-signature-type">TreeNode</a>, index<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/edsilv/manifesto/blob/b83b754/src/Utils.ts#L84">Utils.ts:84</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>treeNode: <a href="_treenode_.treenode.html" class="tsd-signature-type">TreeNode</a></h5> </li> <li> <h5><span class="tsd-flag ts-flagDefault value">Default value</span> index: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> =&nbsp;0</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static"> <a name="getimagequality" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagStatic">Static</span> get<wbr>Image<wbr>Quality</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static"> <li class="tsd-signature tsd-kind-icon">get<wbr>Image<wbr>Quality<span class="tsd-signature-symbol">(</span>profile<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ServiceProfile</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/edsilv/manifesto/blob/b83b754/src/Utils.ts#L24">Utils.ts:24</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>profile: <span class="tsd-signature-type">ServiceProfile</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static"> <a name="getinexactlocale" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagStatic">Static</span> get<wbr>Inexact<wbr>Locale</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static"> <li class="tsd-signature tsd-kind-icon">get<wbr>Inexact<wbr>Locale<span class="tsd-signature-symbol">(</span>locale<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><span class="tsd-signature-type">string</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/edsilv/manifesto/blob/b83b754/src/Utils.ts#L44">Utils.ts:44</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>locale: <span class="tsd-signature-type">string</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static"> <a name="getlocalisedvalue" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagStatic">Static</span> get<wbr>Localised<wbr>Value</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static"> <li class="tsd-signature tsd-kind-icon">get<wbr>Localised<wbr>Value<span class="tsd-signature-symbol">(</span>resource<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, locale<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><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/edsilv/manifesto/blob/b83b754/src/Utils.ts#L52">Utils.ts:52</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>resource: <span class="tsd-signature-type">any</span></h5> </li> <li> <h5>locale: <span class="tsd-signature-type">string</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol"> | </span> <span class="tsd-signature-type">null</span> </h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static"> <a name="getmediatype" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagStatic">Static</span> get<wbr>Media<wbr>Type</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static"> <li class="tsd-signature tsd-kind-icon">get<wbr>Media<wbr>Type<span class="tsd-signature-symbol">(</span>type<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><span class="tsd-signature-type">MediaType</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/edsilv/manifesto/blob/b83b754/src/Utils.ts#L18">Utils.ts:18</a></li> </ul> </aside> <h4 class="tsd-parameters-title">