docs/module-BalancesApi.html

   1 <!DOCTYPE html>
   2
   3 <html lang="en">
   4 <head>
   5         <meta charset="utf-8">
   6         <meta name="viewport" content="width=device-width">
   7         <title>Bytom Node.js SDK Module: BalancesApi</title>
   8
   9         <!--[if lt IE 9]>
  10         <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
  11         <![endif]-->
  12         <link type="text/css" rel="stylesheet" href="styles/sunlight.default.css">
  13
  14         <link type="text/css" rel="stylesheet" href="styles/site.cosmo.css">
  15
  16 </head>
  17
  18 <body>
  19
  20 <div class="navbar navbar-default navbar-fixed-top ">
  21 <div class="container">
  22         <div class="navbar-header">
  23                 <a class="navbar-brand" href="index.html">Bytom Node.js SDK</a>
  24                 <button class="navbar-toggle" type="button" data-toggle="collapse" data-target="#topNavigation">
  25                         <span class="icon-bar"></span>
  26                         <span class="icon-bar"></span>
  27                         <span class="icon-bar"></span>
  28         </button>
  29         </div>
  30         <div class="navbar-collapse collapse" id="topNavigation">
  31                 <ul class="nav navbar-nav">
  32
  33                         <li class="dropdown">
  34                                 <a href="modules.list.html" class="dropdown-toggle" data-toggle="dropdown">Modules<b class="caret"></b></a>
  35                                 <ul class="dropdown-menu ">
  36                                         <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>
  37                                 </ul>
  38                         </li>
  39
  40                         <li class="dropdown">
  41                                 <a href="global.html" class="dropdown-toggle" data-toggle="dropdown">Global<b class="caret"></b></a>
  42                                 <ul class="dropdown-menu ">
  43                                         <li><a href="global.html">Global</a></li>
  44                                 </ul>
  45                         </li>
  46
  47                 </ul>
  48
  49             <div class="col-sm-3 col-md-3">
  50                 <form class="navbar-form" role="search">
  51                     <div class="input-group">
  52                         <input type="text" class="form-control" placeholder="Search" name="q" id="search-input">
  53                         <div class="input-group-btn">
  54                             <button class="btn btn-default" id="search-submit"><i class="glyphicon glyphicon-search"></i></button>
  55                         </div>
  56                     </div>
  57                 </form>
  58             </div>
  59
  60         </div>
  61
  62 </div>
  63 </div>
  64
  65
  66 <div class="container" id="toc-content">
  67 <div class="row">
  68
  69
  70         <div class="col-md-8">
  71
  72                 <div id="main">
  73
  74
  75         <h1 class="page-title">Module: BalancesApi</h1>
  76 <section>
  77
  78 <header>
  79
  80 </header>
  81
  82
  83 <article>
  84     <div class="container-overview">
  85
  86
  87             <div class="description"><p>API for interacting with <a href="global.html#Balance">balances</a>.</p></div>
  88
  89
  90
  91 <dl class="details">
  92
  93
  94
  95
  96
  97
  98
  99
 100
 101
 102
 103
 104
 105
 106
 107
 108
 109
 110
 111
 112
 113
 114
 115
 116
 117
 118
 119
 120
 121
 122
 123
 124
 125
 126
 127 </dl>
 128
 129
 130
 131
 132     </div>
 133
 134
 135
 136
 137
 138
 139
 140
 141
 142
 143
 144
 145
 146
 147         <h3 class="subsection-title">Methods</h3>
 148
 149         <dl>
 150
 151 <hr>
 152 <dt>
 153     <h4 class="name" id="~list"><span class="type-signature">&lt;inner> </span>list()</h4>
 154
 155
 156 </dt>
 157 <dd>
 158
 159
 160     <div class="description">
 161         <p>Get all asset balances of all accounts.</p>
 162     </div>
 163
 164
 165
 166
 167
 168
 169
 170
 171
 172
 173 <dl class="details">
 174
 175
 176
 177
 178
 179
 180
 181
 182
 183
 184
 185
 186
 187
 188
 189
 190
 191
 192
 193
 194
 195
 196
 197
 198
 199
 200
 201
 202
 203
 204
 205
 206
 207
 208
 209 </dl>
 210
 211
 212
 213
 214
 215
 216
 217
 218
 219
 220
 221
 222
 223     <h5>Returns:</h5>
 224
 225
 226 <div class="param-desc">
 227     <p>The result balances.</p>
 228 </div>
 229
 230
 231
 232 <dl>
 233     <dt>
 234         Type
 235     </dt>
 236     <dd>
 237
 238 <span class="param-type">Promise.&lt;Array.&lt;<a href="global.html#Balance">Balance</a>>></span>
 239
 240
 241
 242     </dd>
 243 </dl>
 244
 245
 246
 247
 248
 249 </dd>
 250
 251         </dl>
 252
 253
 254
 255
 256
 257 </article>
 258
 259 </section>
 260
 261
 262
 263
 264                 </div>
 265         </div>
 266
 267         <div class="clearfix"></div>
 268
 269
 270                 <div class="col-md-3">
 271                         <div id="toc" class="col-md-3 hidden-xs hidden-sm hidden-md"></div>
 272                 </div>
 273
 274
 275 </div>
 276 </div>
 277
 278
 279     <div class="modal fade" id="searchResults">
 280       <div class="modal-dialog">
 281         <div class="modal-content">
 282           <div class="modal-header">
 283             <button type="button" class="close" data-dismiss="modal" aria-label="Close"><span aria-hidden="true">&times;</span></button>
 284             <h4 class="modal-title">Search results</h4>
 285           </div>
 286           <div class="modal-body"></div>
 287           <div class="modal-footer">
 288             <button type="button" class="btn btn-default" data-dismiss="modal">Close</button>
 289           </div>
 290         </div><!-- /.modal-content -->
 291       </div><!-- /.modal-dialog -->
 292     </div>
 293
 294
 295 <footer>
 296
 297
 298 <span class="jsdoc-message">
 299         Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
 300
 301                 on 2018-05-24T14:05:00+08:00
 302
 303         using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 304 </span>
 305 </footer>
 306
 307 <script src="scripts/docstrap.lib.js"></script>
 308 <script src="scripts/toc.js"></script>
 309
 310     <script type="text/javascript" src="scripts/fulltext-search-ui.js"></script>
 311
 312
 313 <script>
 314 $( function () {
 315         $( "[id*='$']" ).each( function () {
 316                 var $this = $( this );
 317
 318                 $this.attr( "id", $this.attr( "id" ).replace( "$", "__" ) );
 319         } );
 320
 321         $( ".tutorial-section pre, .readme-section pre, pre.prettyprint.source" ).each( function () {
 322                 var $this = $( this );
 323
 324                 var example = $this.find( "code" );
 325                 exampleText = example.html();
 326                 var lang = /{@lang (.*?)}/.exec( exampleText );
 327                 if ( lang && lang[1] ) {
 328                         exampleText = exampleText.replace( lang[0], "" );
 329                         example.html( exampleText );
 330                         lang = lang[1];
 331                 } else {
 332                         var langClassMatch = example.parent()[0].className.match(/lang\-(\S+)/);
 333                         lang = langClassMatch ? langClassMatch[1] : "javascript";
 334                 }
 335
 336                 if ( lang ) {
 337
 338                         $this
 339                         .addClass( "sunlight-highlight-" + lang )
 340                         .addClass( "linenums" )
 341                         .html( example.html() );
 342
 343                 }
 344         } );
 345
 346         Sunlight.highlightAll( {
 347                 lineNumbers : true,
 348                 showMenu : true,
 349                 enableDoclinks : true
 350         } );
 351
 352         $.catchAnchorLinks( {
 353         navbarOffset: 10
 354         } );
 355         $( "#toc" ).toc( {
 356                 anchorName  : function ( i, heading, prefix ) {
 357                         return $( heading ).attr( "id" ) || ( prefix + i );
 358                 },
 359                 selectors   : "#toc-content h1,#toc-content h2,#toc-content h3,#toc-content h4",
 360                 showAndHide : false,
 361                 smoothScrolling: true
 362         } );
 363
 364         $( "#main span[id^='toc']" ).addClass( "toc-shim" );
 365         $( '.dropdown-toggle' ).dropdown();
 366
 367     $( "table" ).each( function () {
 368       var $this = $( this );
 369       $this.addClass('table');
 370     } );
 371
 372 } );
 373 </script>
 374
 375
 376
 377 <!--Navigation and Symbol Display-->
 378
 379
 380 <!--Google Analytics-->
 381
 382
 383
 384     <script type="text/javascript">
 385         $(document).ready(function() {
 386             SearcherDisplay.init();
 387         });
 388     </script>
 389
 390
 391 </body>
 392 </html>