docs/module-AccessTokensApi.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: AccessTokensApi</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: AccessTokensApi</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#AccessToken">access tokens</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="~create"><span class="type-signature">&lt;inner> </span>create(id)</h4>
 154
 155
 156 </dt>
 157 <dd>
 158
 159
 160     <div class="description">
 161         <p>Create a new access token.</p>
 162     </div>
 163
 164
 165
 166
 167
 168
 169
 170
 171         <h5>Parameters:</h5>
 172
 173
 174 <table class="params table table-striped">
 175     <thead>
 176     <tr>
 177
 178         <th>Name</th>
 179
 180
 181         <th>Type</th>
 182
 183
 184
 185
 186
 187         <th class="last">Description</th>
 188     </tr>
 189     </thead>
 190
 191     <tbody>
 192
 193
 194         <tr>
 195
 196                 <td class="name"><code>id</code></td>
 197
 198
 199             <td class="type">
 200
 201
 202 <span class="param-type">String</span>
 203
 204
 205
 206
 207             </td>
 208
 209
 210
 211
 212
 213             <td class="description last"><p>User specified, unique identifier.</p></td>
 214         </tr>
 215
 216
 217     </tbody>
 218 </table>
 219
 220
 221
 222
 223 <dl class="details">
 224
 225
 226
 227
 228
 229
 230
 231
 232
 233
 234
 235
 236
 237
 238
 239
 240
 241
 242
 243
 244
 245
 246
 247
 248
 249
 250
 251
 252
 253
 254
 255
 256
 257
 258
 259 </dl>
 260
 261
 262
 263
 264
 265
 266
 267
 268
 269
 270
 271
 272
 273     <h5>Returns:</h5>
 274
 275
 276 <div class="param-desc">
 277     <p>Newly created access token.</p>
 278 </div>
 279
 280
 281
 282 <dl>
 283     <dt>
 284         Type
 285     </dt>
 286     <dd>
 287
 288 <span class="param-type">Promise.&lt;<a href="global.html#AccessToken">AccessToken</a>></span>
 289
 290
 291
 292     </dd>
 293 </dl>
 294
 295
 296
 297
 298
 299 </dd>
 300
 301
 302
 303 <hr>
 304 <dt>
 305     <h4 class="name" id="~delete"><span class="type-signature">&lt;inner> </span>delete(id)</h4>
 306
 307
 308 </dt>
 309 <dd>
 310
 311
 312     <div class="description">
 313         <p>Delete the target access token.</p>
 314     </div>
 315
 316
 317
 318
 319
 320
 321
 322
 323         <h5>Parameters:</h5>
 324
 325
 326 <table class="params table table-striped">
 327     <thead>
 328     <tr>
 329
 330         <th>Name</th>
 331
 332
 333         <th>Type</th>
 334
 335
 336
 337
 338
 339         <th class="last">Description</th>
 340     </tr>
 341     </thead>
 342
 343     <tbody>
 344
 345
 346         <tr>
 347
 348                 <td class="name"><code>id</code></td>
 349
 350
 351             <td class="type">
 352
 353
 354 <span class="param-type">String</span>
 355
 356
 357
 358
 359             </td>
 360
 361
 362
 363
 364
 365             <td class="description last"><p>The to be deleted token id.</p></td>
 366         </tr>
 367
 368
 369     </tbody>
 370 </table>
 371
 372
 373
 374
 375 <dl class="details">
 376
 377
 378
 379
 380
 381
 382
 383
 384
 385
 386
 387
 388
 389
 390
 391
 392
 393
 394
 395
 396
 397
 398
 399
 400
 401
 402
 403
 404
 405
 406
 407
 408
 409
 410
 411 </dl>
 412
 413
 414
 415
 416
 417
 418
 419
 420
 421
 422
 423
 424
 425
 426
 427 </dd>
 428
 429
 430
 431 <hr>
 432 <dt>
 433     <h4 class="name" id="~list"><span class="type-signature">&lt;inner> </span>list()</h4>
 434
 435
 436 </dt>
 437 <dd>
 438
 439
 440     <div class="description">
 441         <p>Get all access tokens.</p>
 442     </div>
 443
 444
 445
 446
 447
 448
 449
 450
 451
 452
 453 <dl class="details">
 454
 455
 456
 457
 458
 459
 460
 461
 462
 463
 464
 465
 466
 467
 468
 469
 470
 471
 472
 473
 474
 475
 476
 477
 478
 479
 480
 481
 482
 483
 484
 485
 486
 487
 488
 489 </dl>
 490
 491
 492
 493
 494
 495
 496
 497
 498
 499
 500
 501
 502
 503     <h5>Returns:</h5>
 504
 505
 506 <div class="param-desc">
 507     <p>All access tokens.</p>
 508 </div>
 509
 510
 511
 512 <dl>
 513     <dt>
 514         Type
 515     </dt>
 516     <dd>
 517
 518 <span class="param-type">Promise.&lt;Array.&lt;<a href="global.html#AccessToken">AccessToken</a>>></span>
 519
 520
 521
 522     </dd>
 523 </dl>
 524
 525
 526
 527
 528
 529 </dd>
 530
 531         </dl>
 532
 533
 534
 535
 536
 537 </article>
 538
 539 </section>
 540
 541
 542
 543
 544                 </div>
 545         </div>
 546
 547         <div class="clearfix"></div>
 548
 549
 550                 <div class="col-md-3">
 551                         <div id="toc" class="col-md-3 hidden-xs hidden-sm hidden-md"></div>
 552                 </div>
 553
 554
 555 </div>
 556 </div>
 557
 558
 559     <div class="modal fade" id="searchResults">
 560       <div class="modal-dialog">
 561         <div class="modal-content">
 562           <div class="modal-header">
 563             <button type="button" class="close" data-dismiss="modal" aria-label="Close"><span aria-hidden="true">&times;</span></button>
 564             <h4 class="modal-title">Search results</h4>
 565           </div>
 566           <div class="modal-body"></div>
 567           <div class="modal-footer">
 568             <button type="button" class="btn btn-default" data-dismiss="modal">Close</button>
 569           </div>
 570         </div><!-- /.modal-content -->
 571       </div><!-- /.modal-dialog -->
 572     </div>
 573
 574
 575 <footer>
 576
 577
 578 <span class="jsdoc-message">
 579         Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
 580
 581                 on 2018-05-24T14:05:00+08:00
 582
 583         using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 584 </span>
 585 </footer>
 586
 587 <script src="scripts/docstrap.lib.js"></script>
 588 <script src="scripts/toc.js"></script>
 589
 590     <script type="text/javascript" src="scripts/fulltext-search-ui.js"></script>
 591
 592
 593 <script>
 594 $( function () {
 595         $( "[id*='$']" ).each( function () {
 596                 var $this = $( this );
 597
 598                 $this.attr( "id", $this.attr( "id" ).replace( "$", "__" ) );
 599         } );
 600
 601         $( ".tutorial-section pre, .readme-section pre, pre.prettyprint.source" ).each( function () {
 602                 var $this = $( this );
 603
 604                 var example = $this.find( "code" );
 605                 exampleText = example.html();
 606                 var lang = /{@lang (.*?)}/.exec( exampleText );
 607                 if ( lang && lang[1] ) {
 608                         exampleText = exampleText.replace( lang[0], "" );
 609                         example.html( exampleText );
 610                         lang = lang[1];
 611                 } else {
 612                         var langClassMatch = example.parent()[0].className.match(/lang\-(\S+)/);
 613                         lang = langClassMatch ? langClassMatch[1] : "javascript";
 614                 }
 615
 616                 if ( lang ) {
 617
 618                         $this
 619                         .addClass( "sunlight-highlight-" + lang )
 620                         .addClass( "linenums" )
 621                         .html( example.html() );
 622
 623                 }
 624         } );
 625
 626         Sunlight.highlightAll( {
 627                 lineNumbers : true,
 628                 showMenu : true,
 629                 enableDoclinks : true
 630         } );
 631
 632         $.catchAnchorLinks( {
 633         navbarOffset: 10
 634         } );
 635         $( "#toc" ).toc( {
 636                 anchorName  : function ( i, heading, prefix ) {
 637                         return $( heading ).attr( "id" ) || ( prefix + i );
 638                 },
 639                 selectors   : "#toc-content h1,#toc-content h2,#toc-content h3,#toc-content h4",
 640                 showAndHide : false,
 641                 smoothScrolling: true
 642         } );
 643
 644         $( "#main span[id^='toc']" ).addClass( "toc-shim" );
 645         $( '.dropdown-toggle' ).dropdown();
 646
 647     $( "table" ).each( function () {
 648       var $this = $( this );
 649       $this.addClass('table');
 650     } );
 651
 652 } );
 653 </script>
 654
 655
 656
 657 <!--Navigation and Symbol Display-->
 658
 659
 660 <!--Google Analytics-->
 661
 662
 663
 664     <script type="text/javascript">
 665         $(document).ready(function() {
 666             SearcherDisplay.init();
 667         });
 668     </script>
 669
 670
 671 </body>
 672 </html>