mirror of
https://github.com/alexgo-io/stacks.js.git
synced 2026-01-12 22:52:34 +08:00
300 lines
12 KiB
HTML
Vendored
300 lines
12 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>AuthScope | 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.authscope.html">AuthScope</a>
|
||
</li>
|
||
</ul>
|
||
<h1>Enumeration AuthScope</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>Non-exhaustive list of common permission scopes.</p>
|
||
</div>
|
||
</div>
|
||
</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>Enumeration members</h3>
|
||
<ul class="tsd-index-list">
|
||
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="auth.authscope.html#email" class="tsd-kind-icon">email</a></li>
|
||
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="auth.authscope.html#publish_data" class="tsd-kind-icon">publish_<wbr>data</a></li>
|
||
<li class="tsd-kind-enum-member tsd-parent-kind-enum"><a href="auth.authscope.html#store_write" class="tsd-kind-icon">store_<wbr>write</a></li>
|
||
</ul>
|
||
</section>
|
||
</div>
|
||
</section>
|
||
</section>
|
||
<section class="tsd-panel-group tsd-member-group ">
|
||
<h2>Enumeration members</h2>
|
||
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum">
|
||
<a name="email" class="tsd-anchor"></a>
|
||
<h3>email</h3>
|
||
<div class="tsd-signature tsd-kind-icon">email<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = "email"</span></div>
|
||
<aside class="tsd-sources">
|
||
<ul>
|
||
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/auth/src/constants.ts#L40">packages/auth/src/constants.ts:40</a></li>
|
||
</ul>
|
||
</aside>
|
||
<div class="tsd-comment tsd-typography">
|
||
<div class="lead">
|
||
<p>Request the user's email if available.</p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum">
|
||
<a name="publish_data" class="tsd-anchor"></a>
|
||
<h3>publish_<wbr>data</h3>
|
||
<div class="tsd-signature tsd-kind-icon">publish_<wbr>data<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = "publish_data"</span></div>
|
||
<aside class="tsd-sources">
|
||
<ul>
|
||
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/auth/src/constants.ts#L36">packages/auth/src/constants.ts:36</a></li>
|
||
</ul>
|
||
</aside>
|
||
<div class="tsd-comment tsd-typography">
|
||
<div class="lead">
|
||
<p>Publish data so that other users of the app can discover and interact with the user.
|
||
The user's files stored on Gaia hub are made visible to others via the <code>apps</code> property in the
|
||
user’s <code>profile.json</code> file.</p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum">
|
||
<a name="store_write" class="tsd-anchor"></a>
|
||
<h3>store_<wbr>write</h3>
|
||
<div class="tsd-signature tsd-kind-icon">store_<wbr>write<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = "store_write"</span></div>
|
||
<aside class="tsd-sources">
|
||
<ul>
|
||
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/auth/src/constants.ts#L30">packages/auth/src/constants.ts:30</a></li>
|
||
</ul>
|
||
</aside>
|
||
<div class="tsd-comment tsd-typography">
|
||
<div class="lead">
|
||
<p>Read and write data to the user's Gaia hub in an app-specific storage bucket.
|
||
This is the default scope.</p>
|
||
</div>
|
||
</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">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="current tsd-kind-enum tsd-parent-kind-module">
|
||
<a href="auth.authscope.html" class="tsd-kind-icon">Auth<wbr>Scope</a>
|
||
<ul>
|
||
<li class=" tsd-kind-enum-member tsd-parent-kind-enum">
|
||
<a href="auth.authscope.html#email" class="tsd-kind-icon">email</a>
|
||
</li>
|
||
<li class=" tsd-kind-enum-member tsd-parent-kind-enum">
|
||
<a href="auth.authscope.html#publish_data" class="tsd-kind-icon">publish_<wbr>data</a>
|
||
</li>
|
||
<li class=" tsd-kind-enum-member tsd-parent-kind-enum">
|
||
<a href="auth.authscope.html#store_write" class="tsd-kind-icon">store_<wbr>write</a>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class=" tsd-kind-class tsd-parent-kind-module">
|
||
<a href="../classes/auth.appconfig.html" class="tsd-kind-icon">App<wbr>Config</a>
|
||
</li>
|
||
<li class=" tsd-kind-class tsd-parent-kind-module">
|
||
<a href="../classes/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-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>
|
||
<ul class="tsd-legend">
|
||
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</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> |