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

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