legacy-libs/grpc/node_modules/protobufjs/docs/ProtoBuf.Reflect.T.html

   1 <!DOCTYPE html>
   2 <html lang="en">
   3 <head>
   4     <meta charset="utf-8">
   5     <title>JSDoc: Class: T</title>
   6
   7     <script src="scripts/prettify/prettify.js"> </script>
   8     <script src="scripts/prettify/lang-css.js"> </script>
   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/prettify-tomorrow.css">
  13     <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
  14 </head>
  15
  16 <body>
  17
  18 <div id="main">
  19
  20     <h1 class="page-title">Class: T</h1>
  21
  22
  23
  24
  25
  26
  27 <section>
  28
  29 <header>
  30
  31         <h2>
  32             <span class="ancestors"><a href="ProtoBuf.html">ProtoBuf</a><a href="ProtoBuf.Reflect.html">.Reflect</a>.</span>
  33
  34         T
  35         </h2>
  36
  37
  38 </header>
  39
  40 <article>
  41     <div class="container-overview">
  42
  43
  44
  45
  46
  47     <h4 class="name" id="T"><span class="type-signature">(abstract) </span>new T<span class="signature">(builder<span class="signature-attributes">non-null</span>, parent<span class="signature-attributes">nullable</span>, name)</span><span class="type-signature"></span></h4>
  48
  49
  50
  51
  52
  53 <div class="description">
  54     <p>Constructs a Reflect base class.</p>
  55 </div>
  56
  57
  58
  59
  60
  61
  62
  63
  64
  65     <h5>Parameters:</h5>
  66
  67
  68 <table class="params">
  69     <thead>
  70     <tr>
  71
  72         <th>Name</th>
  73
  74
  75         <th>Type</th>
  76
  77
  78         <th>Attributes</th>
  79
  80
  81
  82
  83         <th class="last">Description</th>
  84     </tr>
  85     </thead>
  86
  87     <tbody>
  88
  89
  90         <tr>
  91
  92                 <td class="name"><code>builder</code></td>
  93
  94
  95             <td class="type">
  96
  97
  98 <span class="param-type"><a href="ProtoBuf.Builder.html">ProtoBuf.Builder</a></span>
  99
 100
 101
 102             </td>
 103
 104
 105                 <td class="attributes">
 106
 107
 108
 109
 110
 111                 </td>
 112
 113
 114
 115
 116             <td class="description last"><p>Builder reference</p></td>
 117         </tr>
 118
 119
 120
 121         <tr>
 122
 123                 <td class="name"><code>parent</code></td>
 124
 125
 126             <td class="type">
 127
 128
 129 <span class="param-type"><a href="ProtoBuf.Reflect.T.html">ProtoBuf.Reflect.T</a></span>
 130
 131
 132
 133             </td>
 134
 135
 136                 <td class="attributes">
 137
 138
 139
 140                     &lt;nullable><br>
 141
 142
 143
 144                 </td>
 145
 146
 147
 148
 149             <td class="description last"><p>Parent object</p></td>
 150         </tr>
 151
 152
 153
 154         <tr>
 155
 156                 <td class="name"><code>name</code></td>
 157
 158
 159             <td class="type">
 160
 161
 162 <span class="param-type">string</span>
 163
 164
 165
 166             </td>
 167
 168
 169                 <td class="attributes">
 170
 171
 172
 173
 174
 175                 </td>
 176
 177
 178
 179
 180             <td class="description last"><p>Object name</p></td>
 181         </tr>
 182
 183
 184     </tbody>
 185 </table>
 186
 187
 188
 189
 190
 191
 192 <dl class="details">
 193
 194
 195
 196
 197
 198
 199
 200
 201
 202
 203
 204
 205
 206
 207
 208
 209
 210
 211
 212
 213
 214
 215
 216
 217
 218
 219     <dt class="tag-source">Source:</dt>
 220     <dd class="tag-source"><ul class="dummy"><li>
 221         <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1410">line 1410</a>
 222     </li></ul></dd>
 223
 224
 225
 226
 227
 228
 229
 230 </dl>
 231
 232
 233
 234
 235
 236
 237
 238
 239
 240
 241
 242
 243
 244
 245
 246
 247
 248     </div>
 249
 250
 251
 252
 253
 254
 255
 256
 257
 258
 259
 260
 261         <h3 class="subsection-title">Members</h3>
 262
 263
 264
 265 <h4 class="name" id="builder"><span class="type-signature">(non-null) </span>builder<span class="type-signature"> :<a href="ProtoBuf.Builder.html">ProtoBuf.Builder</a></span></h4>
 266
 267
 268
 269
 270 <div class="description">
 271     <p>Builder reference.</p>
 272 </div>
 273
 274
 275
 276     <h5>Type:</h5>
 277     <ul>
 278         <li>
 279
 280 <span class="param-type"><a href="ProtoBuf.Builder.html">ProtoBuf.Builder</a></span>
 281
 282
 283         </li>
 284     </ul>
 285
 286
 287
 288
 289
 290 <dl class="details">
 291
 292
 293
 294
 295
 296
 297
 298
 299
 300
 301
 302
 303
 304
 305
 306
 307
 308
 309
 310
 311
 312
 313
 314
 315
 316
 317     <dt class="tag-source">Source:</dt>
 318     <dd class="tag-source"><ul class="dummy"><li>
 319         <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1417">line 1417</a>
 320     </li></ul></dd>
 321
 322
 323
 324
 325
 326
 327
 328 </dl>
 329
 330
 331
 332
 333
 334
 335
 336
 337 <h4 class="name" id="className"><span class="type-signature"></span>className<span class="type-signature"> :string</span></h4>
 338
 339
 340
 341
 342 <div class="description">
 343     <p>Fully qualified class name</p>
 344 </div>
 345
 346
 347
 348     <h5>Type:</h5>
 349     <ul>
 350         <li>
 351
 352 <span class="param-type">string</span>
 353
 354
 355         </li>
 356     </ul>
 357
 358
 359
 360
 361
 362 <dl class="details">
 363
 364
 365
 366
 367
 368
 369
 370
 371
 372
 373
 374
 375
 376
 377
 378
 379
 380
 381
 382
 383
 384
 385
 386
 387
 388
 389     <dt class="tag-source">Source:</dt>
 390     <dd class="tag-source"><ul class="dummy"><li>
 391         <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1438">line 1438</a>
 392     </li></ul></dd>
 393
 394
 395
 396
 397
 398
 399
 400 </dl>
 401
 402
 403
 404
 405
 406
 407
 408
 409 <h4 class="name" id="name"><span class="type-signature"></span>name<span class="type-signature"> :string</span></h4>
 410
 411
 412
 413
 414 <div class="description">
 415     <p>Object name in namespace.</p>
 416 </div>
 417
 418
 419
 420     <h5>Type:</h5>
 421     <ul>
 422         <li>
 423
 424 <span class="param-type">string</span>
 425
 426
 427         </li>
 428     </ul>
 429
 430
 431
 432
 433
 434 <dl class="details">
 435
 436
 437
 438
 439
 440
 441
 442
 443
 444
 445
 446
 447
 448
 449
 450
 451
 452
 453
 454
 455
 456
 457
 458
 459
 460
 461     <dt class="tag-source">Source:</dt>
 462     <dd class="tag-source"><ul class="dummy"><li>
 463         <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1431">line 1431</a>
 464     </li></ul></dd>
 465
 466
 467
 468
 469
 470
 471
 472 </dl>
 473
 474
 475
 476
 477
 478
 479
 480
 481 <h4 class="name" id="parent"><span class="type-signature">(nullable) </span>parent<span class="type-signature"> :<a href="ProtoBuf.Reflect.T.html">ProtoBuf.Reflect.T</a></span></h4>
 482
 483
 484
 485
 486 <div class="description">
 487     <p>Parent object.</p>
 488 </div>
 489
 490
 491
 492     <h5>Type:</h5>
 493     <ul>
 494         <li>
 495
 496 <span class="param-type"><a href="ProtoBuf.Reflect.T.html">ProtoBuf.Reflect.T</a></span>
 497
 498
 499         </li>
 500     </ul>
 501
 502
 503
 504
 505
 506 <dl class="details">
 507
 508
 509
 510
 511
 512
 513
 514
 515
 516
 517
 518
 519
 520
 521
 522
 523
 524
 525
 526
 527
 528
 529
 530
 531
 532
 533     <dt class="tag-source">Source:</dt>
 534     <dd class="tag-source"><ul class="dummy"><li>
 535         <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1424">line 1424</a>
 536     </li></ul></dd>
 537
 538
 539
 540
 541
 542
 543
 544 </dl>
 545
 546
 547
 548
 549
 550
 551
 552
 553
 554
 555         <h3 class="subsection-title">Methods</h3>
 556
 557
 558
 559
 560
 561
 562     <h4 class="name" id="build"><span class="type-signature"></span>build<span class="signature">()</span><span class="type-signature"></span></h4>
 563
 564
 565
 566
 567
 568 <div class="description">
 569     <p>Builds this type.</p>
 570 </div>
 571
 572
 573
 574
 575
 576
 577
 578
 579
 580
 581
 582
 583
 584 <dl class="details">
 585
 586
 587
 588
 589
 590
 591
 592
 593
 594
 595
 596
 597
 598
 599
 600
 601
 602
 603
 604
 605
 606
 607
 608
 609
 610
 611     <dt class="tag-source">Source:</dt>
 612     <dd class="tag-source"><ul class="dummy"><li>
 613         <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1479">line 1479</a>
 614     </li></ul></dd>
 615
 616
 617
 618
 619
 620
 621
 622 </dl>
 623
 624
 625
 626
 627
 628
 629
 630
 631
 632
 633
 634 <h5>Throws:</h5>
 635
 636
 637
 638 <dl>
 639     <dt>
 640         <div class="param-desc">
 641         <p>If this type cannot be built directly</p>
 642         </div>
 643     </dt>
 644     <dd></dd>
 645     <dt>
 646         <dl>
 647             <dt>
 648                 Type
 649             </dt>
 650             <dd>
 651
 652 <span class="param-type">Error</span>
 653
 654
 655             </dd>
 656         </dl>
 657     </dt>
 658     <dd></dd>
 659 </dl>
 660
 661
 662
 663
 664
 665
 666
 667
 668
 669
 670
 671
 672
 673     <h4 class="name" id="fqn"><span class="type-signature"></span>fqn<span class="signature">()</span><span class="type-signature"> &rarr; {string}</span></h4>
 674
 675
 676
 677
 678
 679 <div class="description">
 680     <p>Returns the fully qualified name of this object.</p>
 681 </div>
 682
 683
 684
 685
 686
 687
 688
 689
 690
 691
 692
 693
 694
 695 <dl class="details">
 696
 697
 698
 699
 700
 701
 702
 703
 704
 705
 706
 707
 708
 709
 710
 711
 712
 713
 714
 715
 716
 717
 718
 719
 720
 721
 722     <dt class="tag-source">Source:</dt>
 723     <dd class="tag-source"><ul class="dummy"><li>
 724         <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1452">line 1452</a>
 725     </li></ul></dd>
 726
 727
 728
 729
 730
 731
 732
 733 </dl>
 734
 735
 736
 737
 738
 739
 740
 741
 742
 743
 744
 745
 746
 747 <h5>Returns:</h5>
 748
 749
 750 <div class="param-desc">
 751     <p>Fully qualified name as of &quot;.PATH.TO.THIS&quot;</p>
 752 </div>
 753
 754
 755
 756 <dl>
 757     <dt>
 758         Type
 759     </dt>
 760     <dd>
 761
 762 <span class="param-type">string</span>
 763
 764
 765     </dd>
 766 </dl>
 767
 768
 769
 770
 771
 772
 773
 774
 775
 776
 777     <h4 class="name" id="toString"><span class="type-signature"></span>toString<span class="signature">(includeClass<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
 778
 779
 780
 781
 782
 783 <div class="description">
 784     <p>Returns a string representation of this Reflect object (its fully qualified name).</p>
 785 </div>
 786
 787
 788
 789
 790
 791
 792
 793
 794
 795     <h5>Parameters:</h5>
 796
 797
 798 <table class="params">
 799     <thead>
 800     <tr>
 801
 802         <th>Name</th>
 803
 804
 805         <th>Type</th>
 806
 807
 808         <th>Attributes</th>
 809
 810
 811
 812
 813         <th class="last">Description</th>
 814     </tr>
 815     </thead>
 816
 817     <tbody>
 818
 819
 820         <tr>
 821
 822                 <td class="name"><code>includeClass</code></td>
 823
 824
 825             <td class="type">
 826
 827
 828 <span class="param-type">boolean</span>
 829
 830
 831
 832             </td>
 833
 834
 835                 <td class="attributes">
 836
 837                     &lt;optional><br>
 838
 839
 840
 841
 842
 843                 </td>
 844
 845
 846
 847
 848             <td class="description last"><p>Set to true to include the class name. Defaults to false.</p></td>
 849         </tr>
 850
 851
 852     </tbody>
 853 </table>
 854
 855
 856
 857
 858
 859
 860 <dl class="details">
 861
 862
 863
 864
 865
 866
 867
 868
 869
 870
 871
 872
 873
 874
 875
 876
 877
 878
 879
 880
 881
 882
 883
 884
 885
 886
 887     <dt class="tag-source">Source:</dt>
 888     <dd class="tag-source"><ul class="dummy"><li>
 889         <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1470">line 1470</a>
 890     </li></ul></dd>
 891
 892
 893
 894
 895
 896
 897
 898 </dl>
 899
 900
 901
 902
 903
 904
 905
 906
 907
 908
 909
 910
 911
 912 <h5>Returns:</h5>
 913
 914
 915 <div class="param-desc">
 916     <p>String representation</p>
 917 </div>
 918
 919
 920
 921
 922
 923
 924
 925
 926
 927
 928
 929
 930
 931 </article>
 932
 933 </section>
 934
 935
 936
 937
 938 </div>
 939
 940 <nav>
 941     <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="ProtoBuf.Builder.html">Builder</a></li><li><a href="ProtoBuf.Builder.Message.html">Message</a></li><li><a href="ProtoBuf.Builder.Service.html">Service</a></li><li><a href="ProtoBuf.DotProto.Parser.html">Parser</a></li><li><a href="ProtoBuf.DotProto.Tokenizer.html">Tokenizer</a></li><li><a href="ProtoBuf.Map.html">Map</a></li><li><a href="ProtoBuf.Reflect.Element.html">Element</a></li><li><a href="ProtoBuf.Reflect.Enum.html">Enum</a></li><li><a href="ProtoBuf.Reflect.Enum.Value.html">Value</a></li><li><a href="ProtoBuf.Reflect.Extension.html">Extension</a></li><li><a href="ProtoBuf.Reflect.Message.html">Message</a></li><li><a href="ProtoBuf.Reflect.Message.ExtensionField.html">ExtensionField</a></li><li><a href="ProtoBuf.Reflect.Message.Field.html">Field</a></li><li><a href="ProtoBuf.Reflect.Message.OneOf.html">OneOf</a></li><li><a href="ProtoBuf.Reflect.Namespace.html">Namespace</a></li><li><a href="ProtoBuf.Reflect.Service.html">Service</a></li><li><a href="ProtoBuf.Reflect.Service.Method.html">Method</a></li><li><a href="ProtoBuf.Reflect.Service.RPCMethod.html">RPCMethod</a></li><li><a href="ProtoBuf.Reflect.T.html">T</a></li></ul><h3>Namespaces</h3><ul><li><a href="ProtoBuf.html">ProtoBuf</a></li><li><a href="ProtoBuf.DotProto.html">DotProto</a></li><li><a href="ProtoBuf.Reflect.html">Reflect</a></li><li><a href="ProtoBuf.Util.html">Util</a></li></ul>
 942 </nav>
 943
 944 <br class="clear">
 945
 946 <footer>
 947     Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.3</a> on Fri Jan 27 2017 17:03:55 GMT+0100 (Mitteleuropäische Zeit)
 948 </footer>
 949
 950 <script> prettyPrint(); </script>
 951 <script src="scripts/linenumber.js"> </script>
 952 </body>
 953 </html>