Files
stacks.js/docs/classes/auth.appconfig.html
2021-06-28 10:27:07 -07:00

513 lines
24 KiB
HTML
Vendored

<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>AppConfig | Stacks.js 1.4.1 Library Reference</title>
<meta name="description" content="Documentation for Stacks.js 1.4.1 Library Reference">
<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">Stacks.js 1.4.1 Library Reference</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">Stacks.js 1.4.1 Library Reference</a>
</li>
<li>
<a href="../modules/auth.html">auth</a>
</li>
<li>
<a href="auth.appconfig.html">AppConfig</a>
</li>
</ul>
<h1>Class AppConfig</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>Configuration data for the current app.</p>
</div>
<p>On browser platforms, creating an instance of this
class without any arguments will use
<code>window.location.origin</code> as the app domain.
On non-browser platforms, you need to
specify an app domain as the second argument.</p>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">AppConfig</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>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="auth.appconfig.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-class"><a href="auth.appconfig.html#appdomain" class="tsd-kind-icon">app<wbr>Domain</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="auth.appconfig.html#authenticatorurl" class="tsd-kind-icon">authenticatorURL</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="auth.appconfig.html#corenode" class="tsd-kind-icon">core<wbr>Node</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="auth.appconfig.html#manifestpath" class="tsd-kind-icon">manifest<wbr>Path</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="auth.appconfig.html#redirectpath" class="tsd-kind-icon">redirect<wbr>Path</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="auth.appconfig.html#scopes" class="tsd-kind-icon">scopes</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="auth.appconfig.html#manifesturi" class="tsd-kind-icon">manifestURI</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="auth.appconfig.html#redirecturi" class="tsd-kind-icon">redirectURI</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>App<wbr>Config<span class="tsd-signature-symbol">(</span>scopes<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span>, appDomain<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span>, redirectPath<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, manifestPath<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, coreNode<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span>, authenticatorURL<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="auth.appconfig.html" class="tsd-signature-type" data-tsd-kind="Class">AppConfig</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/auth/src/appConfig.ts#L57">packages/auth/src/appConfig.ts:57</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>scopes: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = ...</span></h5>
<div class="tsd-comment tsd-typography">
<p>permissions this app is requesting</p>
</div>
</li>
<li>
<h5>appDomain: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = ...</span></h5>
<div class="tsd-comment tsd-typography">
<p>the app domain</p>
</div>
</li>
<li>
<h5>redirectPath: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &#x27;&#x27;</span></h5>
<div class="tsd-comment tsd-typography">
<p>path on app domain to redirect users to after authentication</p>
</div>
</li>
<li>
<h5>manifestPath: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &#x27;/manifest.json&#x27;</span></h5>
<div class="tsd-comment tsd-typography">
<p>path relative to app domain of app&#39;s manifest file</p>
</div>
</li>
<li>
<h5>coreNode: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = ...</span></h5>
<div class="tsd-comment tsd-typography">
<p>override the default or user selected core node</p>
</div>
</li>
<li>
<h5>authenticatorURL: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = ...</span></h5>
<div class="tsd-comment tsd-typography">
<p>the web-based fall back authenticator
(<a href="../modules/auth.html#default_blockstack_host">DEFAULT_BLOCKSTACK_HOST</a>)</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="auth.appconfig.html" class="tsd-signature-type" data-tsd-kind="Class">AppConfig</a></h4>
</li>
</ul>
</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-class">
<a name="appdomain" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> app<wbr>Domain</h3>
<div class="tsd-signature tsd-kind-icon">app<wbr>Domain<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/blockstack/stacks.js/blob/master/packages/auth/src/appConfig.ts#L19">packages/auth/src/appConfig.ts:19</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Blockstack apps are uniquely identified by their app domain.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="authenticatorurl" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> authenticatorURL</h3>
<div class="tsd-signature tsd-kind-icon">authenticatorURL<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/blockstack/stacks.js/blob/master/packages/auth/src/appConfig.ts#L57">packages/auth/src/appConfig.ts:57</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The URL of a web-based Blockstack Authenticator to use in the event
the user doesn&#39;t have Blockstack installed on their machine. If this
is not specified, the current default in this library will be used.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="corenode" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> core<wbr>Node</h3>
<div class="tsd-signature tsd-kind-icon">core<wbr>Node<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/blockstack/stacks.js/blob/master/packages/auth/src/appConfig.ts#L49">packages/auth/src/appConfig.ts:49</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The URL of Blockstack core node to use for this app. If this is
<code>null</code>, the core node specified by the user or default core node
will be used.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="manifestpath" class="tsd-anchor"></a>
<h3>manifest<wbr>Path</h3>
<div class="tsd-signature tsd-kind-icon">manifest<wbr>Path<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/blockstack/stacks.js/blob/master/packages/auth/src/appConfig.ts#L41">packages/auth/src/appConfig.ts:41</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Path relative to app domain of app&#39;s manifest file.</p>
</div>
<p>This file needs to have CORS headers set so that it can be fetched
from any origin. Typically this means return the header <code>Access-Control-Allow-Origin: *</code>.</p>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="redirectpath" class="tsd-anchor"></a>
<h3>redirect<wbr>Path</h3>
<div class="tsd-signature tsd-kind-icon">redirect<wbr>Path<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/blockstack/stacks.js/blob/master/packages/auth/src/appConfig.ts#L32">packages/auth/src/appConfig.ts:32</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Path on app domain to redirect users to after authentication. The
authentication response token will be postpended in a query.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="scopes" class="tsd-anchor"></a>
<h3>scopes</h3>
<div class="tsd-signature tsd-kind-icon">scopes<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/auth/src/appConfig.ts#L25">packages/auth/src/appConfig.ts:25</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>An array of string representing permissions requested by the app.</p>
</div>
</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">
<a name="manifesturi" class="tsd-anchor"></a>
<h3>manifestURI</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">manifestURI<span class="tsd-signature-symbol">(</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/blockstack/stacks.js/blob/master/packages/auth/src/appConfig.ts#L98">packages/auth/src/appConfig.ts:98</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The location of the app&#39;s manifest file.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
<ul>
<li>URI</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="redirecturi" class="tsd-anchor"></a>
<h3>redirectURI</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">redirectURI<span class="tsd-signature-symbol">(</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/blockstack/stacks.js/blob/master/packages/auth/src/appConfig.ts#L90">packages/auth/src/appConfig.ts:90</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The location to which the authenticator should
redirect the user.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
<ul>
<li>URI</li>
</ul>
</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">Modules</a>
</li>
<li class="current tsd-kind-module">
<a href="../modules/auth.html">auth</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/bns.html">bns</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/cli.html">cli</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/common.html">common</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/encryption.html">encryption</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/keychain.html">keychain</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/network.html">network</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/profile.html">profile</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/stacking.html">stacking</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/storage.html">storage</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/transactions.html">transactions</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-module">
<a href="../modules/auth.html" class="tsd-kind-icon">auth</a>
<ul>
<li class=" tsd-kind-enum tsd-parent-kind-module">
<a href="../enums/auth.authscope.html" class="tsd-kind-icon">Auth<wbr>Scope</a>
</li>
<li class="current tsd-kind-class tsd-parent-kind-module">
<a href="auth.appconfig.html" class="tsd-kind-icon">App<wbr>Config</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class">
<a href="auth.appconfig.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="auth.appconfig.html#appdomain" class="tsd-kind-icon">app<wbr>Domain</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="auth.appconfig.html#authenticatorurl" class="tsd-kind-icon">authenticatorURL</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="auth.appconfig.html#corenode" class="tsd-kind-icon">core<wbr>Node</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="auth.appconfig.html#manifestpath" class="tsd-kind-icon">manifest<wbr>Path</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="auth.appconfig.html#redirectpath" class="tsd-kind-icon">redirect<wbr>Path</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="auth.appconfig.html#scopes" class="tsd-kind-icon">scopes</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="auth.appconfig.html#manifesturi" class="tsd-kind-icon">manifestURI</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="auth.appconfig.html#redirecturi" class="tsd-kind-icon">redirectURI</a>
</li>
</ul>
</li>
<li class=" tsd-kind-class tsd-parent-kind-module">
<a href="auth.usersession.html" class="tsd-kind-icon">User<wbr>Session</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="../interfaces/auth.profilelookupoptions.html" class="tsd-kind-icon">Profile<wbr>Lookup<wbr>Options</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="../interfaces/auth.userdata.html" class="tsd-kind-icon">User<wbr>Data</a>
</li>
<li class=" tsd-kind-variable tsd-parent-kind-module">
<a href="../modules/auth.html#default_blockstack_host" class="tsd-kind-icon">DEFAULT_<wbr>BLOCKSTACK_<wbr>HOST</a>
</li>
<li class=" tsd-kind-variable tsd-parent-kind-module">
<a href="../modules/auth.html#default_profile" class="tsd-kind-icon">DEFAULT_<wbr>PROFILE</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-module">
<a href="../modules/auth.html#lookupprofile" class="tsd-kind-icon">lookup<wbr>Profile</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-module">
<a href="../modules/auth.html#makeauthrequest" class="tsd-kind-icon">make<wbr>Auth<wbr>Request</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-module">
<a href="../modules/bns.html" class="tsd-kind-icon">bns</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/cli.html" class="tsd-kind-icon">cli</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/common.html" class="tsd-kind-icon">common</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/encryption.html" class="tsd-kind-icon">encryption</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/keychain.html" class="tsd-kind-icon">keychain</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/network.html" class="tsd-kind-icon">network</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/profile.html" class="tsd-kind-icon">profile</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/stacking.html" class="tsd-kind-icon">stacking</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/storage.html" class="tsd-kind-icon">storage</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/transactions.html" class="tsd-kind-icon">transactions</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
<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-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>
</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-enum"><span class="tsd-kind-icon">Enumeration</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>