OSDN Git Service

add docs
[bytom/bytom-node-sdk.git] / docs / module-AccessTokensApi.html
diff --git a/docs/module-AccessTokensApi.html b/docs/module-AccessTokensApi.html
new file mode 100644 (file)
index 0000000..29f5bec
--- /dev/null
@@ -0,0 +1,672 @@
+<!DOCTYPE html>
+
+<html lang="en">
+<head>
+       <meta charset="utf-8">
+       <meta name="viewport" content="width=device-width">
+       <title>Bytom Node.js SDK Module: AccessTokensApi</title>
+
+       <!--[if lt IE 9]>
+       <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
+       <![endif]-->
+       <link type="text/css" rel="stylesheet" href="styles/sunlight.default.css">
+
+       <link type="text/css" rel="stylesheet" href="styles/site.cosmo.css">
+
+</head>
+
+<body>
+
+<div class="navbar navbar-default navbar-fixed-top ">
+<div class="container">
+       <div class="navbar-header">
+               <a class="navbar-brand" href="index.html">Bytom Node.js SDK</a>
+               <button class="navbar-toggle" type="button" data-toggle="collapse" data-target="#topNavigation">
+                       <span class="icon-bar"></span>
+                       <span class="icon-bar"></span>
+                       <span class="icon-bar"></span>
+        </button>
+       </div>
+       <div class="navbar-collapse collapse" id="topNavigation">
+               <ul class="nav navbar-nav">
+                       
+                       <li class="dropdown">
+                               <a href="modules.list.html" class="dropdown-toggle" data-toggle="dropdown">Modules<b class="caret"></b></a>
+                               <ul class="dropdown-menu ">
+                                       <li><a href="module-AccessTokensApi.html">AccessTokensApi</a></li><li><a href="module-AccountsApi.html">AccountsApi</a></li><li><a href="module-AssetsApi.html">AssetsApi</a></li><li><a href="module-BalancesApi.html">BalancesApi</a></li><li><a href="module-KeysApi.html">KeysApi</a></li><li><a href="module-TransactionsApi.html">TransactionsApi</a></li><li><a href="module-UnspentOutputsApi.html">UnspentOutputsApi</a></li>
+                               </ul>
+                       </li>
+                       
+                       <li class="dropdown">
+                               <a href="global.html" class="dropdown-toggle" data-toggle="dropdown">Global<b class="caret"></b></a>
+                               <ul class="dropdown-menu ">
+                                       <li><a href="global.html">Global</a></li>
+                               </ul>
+                       </li>
+                       
+               </ul>
+        
+            <div class="col-sm-3 col-md-3">
+                <form class="navbar-form" role="search">
+                    <div class="input-group">
+                        <input type="text" class="form-control" placeholder="Search" name="q" id="search-input">
+                        <div class="input-group-btn">
+                            <button class="btn btn-default" id="search-submit"><i class="glyphicon glyphicon-search"></i></button>
+                        </div>
+                    </div>
+                </form>
+            </div>
+        
+       </div>
+
+</div>
+</div>
+
+
+<div class="container" id="toc-content">
+<div class="row">
+
+       
+       <div class="col-md-8">
+       
+               <div id="main">
+                       
+
+       <h1 class="page-title">Module: AccessTokensApi</h1>
+<section>
+
+<header>
+    
+</header>
+
+
+<article>
+    <div class="container-overview">
+    
+        
+            <div class="description"><p>API for interacting with <a href="global.html#AccessToken">access tokens</a>.</p></div>
+        
+
+        
+<dl class="details">
+    
+
+       
+
+       
+
+       
+
+    
+
+    
+
+    
+
+    
+
+       
+
+       
+
+       
+
+       
+
+       
+
+
+
+       
+
+       
+
+       
+
+       
+</dl>
+
+
+        
+    
+    </div>
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+        <h3 class="subsection-title">Methods</h3>
+
+        <dl>
+            
+<hr>
+<dt>
+    <h4 class="name" id="~create"><span class="type-signature">&lt;inner> </span>create(id)</h4>
+    
+    
+</dt>
+<dd>
+
+    
+    <div class="description">
+        <p>Create a new access token.</p>
+    </div>
+    
+
+    
+
+    
+
+    
+    
+        <h5>Parameters:</h5>
+        
+
+<table class="params table table-striped">
+    <thead>
+    <tr>
+        
+        <th>Name</th>
+        
+
+        <th>Type</th>
+
+        
+
+        
+
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+
+    <tbody>
+    
+
+        <tr>
+            
+                <td class="name"><code>id</code></td>
+            
+
+            <td class="type">
+            
+                
+<span class="param-type">String</span>
+
+
+
+            
+            </td>
+
+            
+
+            
+
+            <td class="description last"><p>User specified, unique identifier.</p></td>
+        </tr>
+
+    
+    </tbody>
+</table>
+
+    
+
+    
+<dl class="details">
+    
+
+       
+
+       
+
+       
+
+    
+
+    
+
+    
+
+    
+
+       
+
+       
+
+       
+
+       
+
+       
+
+
+
+       
+
+       
+
+       
+
+       
+</dl>
+
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <h5>Returns:</h5>
+    
+            
+<div class="param-desc">
+    <p>Newly created access token.</p>
+</div>
+
+
+
+<dl>
+    <dt>
+        Type
+    </dt>
+    <dd>
+        
+<span class="param-type">Promise.&lt;<a href="global.html#AccessToken">AccessToken</a>></span>
+
+
+
+    </dd>
+</dl>
+
+
+        
+
+    
+</dd>
+
+        
+            
+<hr>
+<dt>
+    <h4 class="name" id="~delete"><span class="type-signature">&lt;inner> </span>delete(id)</h4>
+    
+    
+</dt>
+<dd>
+
+    
+    <div class="description">
+        <p>Delete the target access token.</p>
+    </div>
+    
+
+    
+
+    
+
+    
+    
+        <h5>Parameters:</h5>
+        
+
+<table class="params table table-striped">
+    <thead>
+    <tr>
+        
+        <th>Name</th>
+        
+
+        <th>Type</th>
+
+        
+
+        
+
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+
+    <tbody>
+    
+
+        <tr>
+            
+                <td class="name"><code>id</code></td>
+            
+
+            <td class="type">
+            
+                
+<span class="param-type">String</span>
+
+
+
+            
+            </td>
+
+            
+
+            
+
+            <td class="description last"><p>The to be deleted token id.</p></td>
+        </tr>
+
+    
+    </tbody>
+</table>
+
+    
+
+    
+<dl class="details">
+    
+
+       
+
+       
+
+       
+
+    
+
+    
+
+    
+
+    
+
+       
+
+       
+
+       
+
+       
+
+       
+
+
+
+       
+
+       
+
+       
+
+       
+</dl>
+
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+</dd>
+
+        
+            
+<hr>
+<dt>
+    <h4 class="name" id="~list"><span class="type-signature">&lt;inner> </span>list()</h4>
+    
+    
+</dt>
+<dd>
+
+    
+    <div class="description">
+        <p>Get all access tokens.</p>
+    </div>
+    
+
+    
+
+    
+
+    
+    
+
+    
+<dl class="details">
+    
+
+       
+
+       
+
+       
+
+    
+
+    
+
+    
+
+    
+
+       
+
+       
+
+       
+
+       
+
+       
+
+
+
+       
+
+       
+
+       
+
+       
+</dl>
+
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <h5>Returns:</h5>
+    
+            
+<div class="param-desc">
+    <p>All access tokens.</p>
+</div>
+
+
+
+<dl>
+    <dt>
+        Type
+    </dt>
+    <dd>
+        
+<span class="param-type">Promise.&lt;Array.&lt;<a href="global.html#AccessToken">AccessToken</a>>></span>
+
+
+
+    </dd>
+</dl>
+
+
+        
+
+    
+</dd>
+
+        </dl>
+    
+
+    
+
+    
+</article>
+
+</section>
+
+
+
+
+               </div>
+       </div>
+
+       <div class="clearfix"></div>
+
+       
+               <div class="col-md-3">
+                       <div id="toc" class="col-md-3 hidden-xs hidden-sm hidden-md"></div>
+               </div>
+       
+
+</div>
+</div>
+
+
+    <div class="modal fade" id="searchResults">
+      <div class="modal-dialog">
+        <div class="modal-content">
+          <div class="modal-header">
+            <button type="button" class="close" data-dismiss="modal" aria-label="Close"><span aria-hidden="true">&times;</span></button>
+            <h4 class="modal-title">Search results</h4>
+          </div>
+          <div class="modal-body"></div>
+          <div class="modal-footer">
+            <button type="button" class="btn btn-default" data-dismiss="modal">Close</button>
+          </div>
+        </div><!-- /.modal-content -->
+      </div><!-- /.modal-dialog -->
+    </div>
+
+
+<footer>
+
+
+<span class="jsdoc-message">
+       Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
+       
+               on 2018-05-21T13:04:21+08:00
+       
+       using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
+</span>
+</footer>
+
+<script src="scripts/docstrap.lib.js"></script>
+<script src="scripts/toc.js"></script>
+
+    <script type="text/javascript" src="scripts/fulltext-search-ui.js"></script>
+
+
+<script>
+$( function () {
+       $( "[id*='$']" ).each( function () {
+               var $this = $( this );
+
+               $this.attr( "id", $this.attr( "id" ).replace( "$", "__" ) );
+       } );
+
+       $( ".tutorial-section pre, .readme-section pre, pre.prettyprint.source" ).each( function () {
+               var $this = $( this );
+
+               var example = $this.find( "code" );
+               exampleText = example.html();
+               var lang = /{@lang (.*?)}/.exec( exampleText );
+               if ( lang && lang[1] ) {
+                       exampleText = exampleText.replace( lang[0], "" );
+                       example.html( exampleText );
+                       lang = lang[1];
+               } else {
+                       var langClassMatch = example.parent()[0].className.match(/lang\-(\S+)/);
+                       lang = langClassMatch ? langClassMatch[1] : "javascript";
+               }
+
+               if ( lang ) {
+
+                       $this
+                       .addClass( "sunlight-highlight-" + lang )
+                       .addClass( "linenums" )
+                       .html( example.html() );
+
+               }
+       } );
+
+       Sunlight.highlightAll( {
+               lineNumbers : true,
+               showMenu : true,
+               enableDoclinks : true
+       } );
+
+       $.catchAnchorLinks( {
+        navbarOffset: 10
+       } );
+       $( "#toc" ).toc( {
+               anchorName  : function ( i, heading, prefix ) {
+                       return $( heading ).attr( "id" ) || ( prefix + i );
+               },
+               selectors   : "#toc-content h1,#toc-content h2,#toc-content h3,#toc-content h4",
+               showAndHide : false,
+               smoothScrolling: true
+       } );
+
+       $( "#main span[id^='toc']" ).addClass( "toc-shim" );
+       $( '.dropdown-toggle' ).dropdown();
+
+    $( "table" ).each( function () {
+      var $this = $( this );
+      $this.addClass('table');
+    } );
+
+} );
+</script>
+
+
+
+<!--Navigation and Symbol Display-->
+
+
+<!--Google Analytics-->
+
+
+
+    <script type="text/javascript">
+        $(document).ready(function() {
+            SearcherDisplay.init();
+        });
+    </script>
+
+
+</body>
+</html>
\ No newline at end of file