legacy-libs/grpc-cloned/node_modules/protobufjs/docs/ProtoBuf.Reflect.Service.RPCMethod.html

   1 <!DOCTYPE html>
   2 <html lang="en">
   3 <head>
   4     <meta charset="utf-8">
   5     <title>JSDoc: Class: RPCMethod</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: RPCMethod</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.Service.html">.Service</a>.</span>
  33
  34         RPCMethod
  35         </h2>
  36
  37
  38 </header>
  39
  40 <article>
  41     <div class="container-overview">
  42
  43
  44
  45
  46
  47     <h4 class="name" id="RPCMethod"><span class="type-signature"></span>new RPCMethod<span class="signature">(builder<span class="signature-attributes">non-null</span>, svc<span class="signature-attributes">non-null</span>, name, request, response, request_stream, response_stream, options<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
  48
  49
  50
  51
  52
  53 <div class="description">
  54     <p>RPC service method.</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>svc</code></td>
 124
 125
 126             <td class="type">
 127
 128
 129 <span class="param-type"><a href="ProtoBuf.Reflect.Service.html">ProtoBuf.Reflect.Service</a></span>
 130
 131
 132
 133             </td>
 134
 135
 136                 <td class="attributes">
 137
 138
 139
 140
 141
 142                 </td>
 143
 144
 145
 146
 147             <td class="description last"><p>Service</p></td>
 148         </tr>
 149
 150
 151
 152         <tr>
 153
 154                 <td class="name"><code>name</code></td>
 155
 156
 157             <td class="type">
 158
 159
 160 <span class="param-type">string</span>
 161
 162
 163
 164             </td>
 165
 166
 167                 <td class="attributes">
 168
 169
 170
 171
 172
 173                 </td>
 174
 175
 176
 177
 178             <td class="description last"><p>Method name</p></td>
 179         </tr>
 180
 181
 182
 183         <tr>
 184
 185                 <td class="name"><code>request</code></td>
 186
 187
 188             <td class="type">
 189
 190
 191 <span class="param-type">string</span>
 192
 193
 194
 195             </td>
 196
 197
 198                 <td class="attributes">
 199
 200
 201
 202
 203
 204                 </td>
 205
 206
 207
 208
 209             <td class="description last"><p>Request message name</p></td>
 210         </tr>
 211
 212
 213
 214         <tr>
 215
 216                 <td class="name"><code>response</code></td>
 217
 218
 219             <td class="type">
 220
 221
 222 <span class="param-type">string</span>
 223
 224
 225
 226             </td>
 227
 228
 229                 <td class="attributes">
 230
 231
 232
 233
 234
 235                 </td>
 236
 237
 238
 239
 240             <td class="description last"><p>Response message name</p></td>
 241         </tr>
 242
 243
 244
 245         <tr>
 246
 247                 <td class="name"><code>request_stream</code></td>
 248
 249
 250             <td class="type">
 251
 252
 253 <span class="param-type">boolean</span>
 254
 255
 256
 257             </td>
 258
 259
 260                 <td class="attributes">
 261
 262
 263
 264
 265
 266                 </td>
 267
 268
 269
 270
 271             <td class="description last"><p>Whether requests are streamed</p></td>
 272         </tr>
 273
 274
 275
 276         <tr>
 277
 278                 <td class="name"><code>response_stream</code></td>
 279
 280
 281             <td class="type">
 282
 283
 284 <span class="param-type">boolean</span>
 285
 286
 287
 288             </td>
 289
 290
 291                 <td class="attributes">
 292
 293
 294
 295
 296
 297                 </td>
 298
 299
 300
 301
 302             <td class="description last"><p>Whether responses are streamed</p></td>
 303         </tr>
 304
 305
 306
 307         <tr>
 308
 309                 <td class="name"><code>options</code></td>
 310
 311
 312             <td class="type">
 313
 314
 315 <span class="param-type">Object.&lt;string, *></span>
 316
 317
 318
 319             </td>
 320
 321
 322                 <td class="attributes">
 323
 324                     &lt;optional><br>
 325
 326
 327
 328
 329
 330                 </td>
 331
 332
 333
 334
 335             <td class="description last"><p>Options</p></td>
 336         </tr>
 337
 338
 339     </tbody>
 340 </table>
 341
 342
 343
 344
 345
 346
 347 <dl class="details">
 348
 349
 350
 351
 352
 353
 354
 355
 356
 357
 358
 359
 360
 361
 362
 363
 364
 365
 366
 367
 368
 369
 370
 371
 372
 373
 374     <dt class="tag-source">Source:</dt>
 375     <dd class="tag-source"><ul class="dummy"><li>
 376         <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line4217">line 4217</a>
 377     </li></ul></dd>
 378
 379
 380
 381
 382
 383
 384
 385 </dl>
 386
 387
 388
 389
 390
 391
 392
 393
 394
 395
 396
 397
 398
 399
 400
 401
 402
 403     </div>
 404
 405
 406         <h3 class="subsection-title">Extends</h3>
 407
 408
 409
 410
 411     <ul>
 412         <li><a href="ProtoBuf.Reflect.Service.Method.html">ProtoBuf.Reflect.Service.Method</a></li>
 413     </ul>
 414
 415
 416
 417
 418
 419
 420
 421
 422
 423
 424
 425
 426
 427         <h3 class="subsection-title">Members</h3>
 428
 429
 430
 431 <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>
 432
 433
 434
 435
 436 <div class="description">
 437     <p>Builder reference.</p>
 438 </div>
 439
 440
 441
 442     <h5>Type:</h5>
 443     <ul>
 444         <li>
 445
 446 <span class="param-type"><a href="ProtoBuf.Builder.html">ProtoBuf.Builder</a></span>
 447
 448
 449         </li>
 450     </ul>
 451
 452
 453
 454
 455
 456 <dl class="details">
 457
 458
 459
 460
 461
 462
 463     <dt class="inherited-from">Inherited From:</dt>
 464     <dd class="inherited-from"><ul class="dummy"><li>
 465         <a href="ProtoBuf.Reflect.T.html#builder">ProtoBuf.Reflect.T#builder</a>
 466     </li></ul></dd>
 467
 468
 469
 470
 471
 472
 473
 474
 475
 476
 477
 478
 479
 480
 481
 482
 483
 484
 485
 486
 487
 488     <dt class="tag-source">Source:</dt>
 489     <dd class="tag-source"><ul class="dummy"><li>
 490         <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1417">line 1417</a>
 491     </li></ul></dd>
 492
 493
 494
 495
 496
 497
 498
 499 </dl>
 500
 501
 502
 503
 504
 505
 506
 507
 508 <h4 class="name" id="className"><span class="type-signature"></span>className<span class="type-signature"> :string</span></h4>
 509
 510
 511
 512
 513 <div class="description">
 514     <p>Fully qualified class name</p>
 515 </div>
 516
 517
 518
 519     <h5>Type:</h5>
 520     <ul>
 521         <li>
 522
 523 <span class="param-type">string</span>
 524
 525
 526         </li>
 527     </ul>
 528
 529
 530
 531
 532
 533 <dl class="details">
 534
 535
 536
 537
 538
 539
 540
 541
 542     <dt class="tag-overrides">Overrides:</dt>
 543     <dd class="tag-overrides"><ul class="dummy"><li>
 544         <a href="ProtoBuf.Reflect.Service.Method.html#className">ProtoBuf.Reflect.Service.Method#className</a>
 545     </li></ul></dd>
 546
 547
 548
 549
 550
 551
 552
 553
 554
 555
 556
 557
 558
 559
 560
 561
 562
 563
 564
 565     <dt class="tag-source">Source:</dt>
 566     <dd class="tag-source"><ul class="dummy"><li>
 567         <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1438">line 1438</a>
 568     </li></ul></dd>
 569
 570
 571
 572
 573
 574
 575
 576 </dl>
 577
 578
 579
 580
 581
 582
 583
 584
 585 <h4 class="name" id="name"><span class="type-signature"></span>name<span class="type-signature"> :string</span></h4>
 586
 587
 588
 589
 590 <div class="description">
 591     <p>Object name in namespace.</p>
 592 </div>
 593
 594
 595
 596     <h5>Type:</h5>
 597     <ul>
 598         <li>
 599
 600 <span class="param-type">string</span>
 601
 602
 603         </li>
 604     </ul>
 605
 606
 607
 608
 609
 610 <dl class="details">
 611
 612
 613
 614
 615
 616
 617     <dt class="inherited-from">Inherited From:</dt>
 618     <dd class="inherited-from"><ul class="dummy"><li>
 619         <a href="ProtoBuf.Reflect.T.html#name">ProtoBuf.Reflect.T#name</a>
 620     </li></ul></dd>
 621
 622
 623
 624
 625
 626
 627
 628
 629
 630
 631
 632
 633
 634
 635
 636
 637
 638
 639
 640
 641
 642     <dt class="tag-source">Source:</dt>
 643     <dd class="tag-source"><ul class="dummy"><li>
 644         <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1431">line 1431</a>
 645     </li></ul></dd>
 646
 647
 648
 649
 650
 651
 652
 653 </dl>
 654
 655
 656
 657
 658
 659
 660
 661
 662 <h4 class="name" id="options"><span class="type-signature"></span>options<span class="type-signature"> :Object.&lt;string, *></span></h4>
 663
 664
 665
 666
 667 <div class="description">
 668     <p>Options.</p>
 669 </div>
 670
 671
 672
 673     <h5>Type:</h5>
 674     <ul>
 675         <li>
 676
 677 <span class="param-type">Object.&lt;string, *></span>
 678
 679
 680         </li>
 681     </ul>
 682
 683
 684
 685
 686
 687 <dl class="details">
 688
 689
 690
 691
 692
 693
 694     <dt class="inherited-from">Inherited From:</dt>
 695     <dd class="inherited-from"><ul class="dummy"><li>
 696         <a href="ProtoBuf.Reflect.Service.Method.html#options">ProtoBuf.Reflect.Service.Method#options</a>
 697     </li></ul></dd>
 698
 699
 700
 701
 702
 703
 704
 705
 706
 707
 708
 709
 710
 711
 712
 713
 714
 715
 716
 717
 718
 719     <dt class="tag-source">Source:</dt>
 720     <dd class="tag-source"><ul class="dummy"><li>
 721         <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line4180">line 4180</a>
 722     </li></ul></dd>
 723
 724
 725
 726
 727
 728
 729
 730 </dl>
 731
 732
 733
 734
 735
 736
 737
 738
 739 <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>
 740
 741
 742
 743
 744 <div class="description">
 745     <p>Parent object.</p>
 746 </div>
 747
 748
 749
 750     <h5>Type:</h5>
 751     <ul>
 752         <li>
 753
 754 <span class="param-type"><a href="ProtoBuf.Reflect.T.html">ProtoBuf.Reflect.T</a></span>
 755
 756
 757         </li>
 758     </ul>
 759
 760
 761
 762
 763
 764 <dl class="details">
 765
 766
 767
 768
 769
 770
 771     <dt class="inherited-from">Inherited From:</dt>
 772     <dd class="inherited-from"><ul class="dummy"><li>
 773         <a href="ProtoBuf.Reflect.T.html#parent">ProtoBuf.Reflect.T#parent</a>
 774     </li></ul></dd>
 775
 776
 777
 778
 779
 780
 781
 782
 783
 784
 785
 786
 787
 788
 789
 790
 791
 792
 793
 794
 795
 796     <dt class="tag-source">Source:</dt>
 797     <dd class="tag-source"><ul class="dummy"><li>
 798         <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1424">line 1424</a>
 799     </li></ul></dd>
 800
 801
 802
 803
 804
 805
 806
 807 </dl>
 808
 809
 810
 811
 812
 813
 814
 815
 816 <h4 class="name" id="requestName"><span class="type-signature"></span>requestName<span class="type-signature"> :string</span></h4>
 817
 818
 819
 820
 821 <div class="description">
 822     <p>Request message name.</p>
 823 </div>
 824
 825
 826
 827     <h5>Type:</h5>
 828     <ul>
 829         <li>
 830
 831 <span class="param-type">string</span>
 832
 833
 834         </li>
 835     </ul>
 836
 837
 838
 839
 840
 841 <dl class="details">
 842
 843
 844
 845
 846
 847
 848
 849
 850
 851
 852
 853
 854
 855
 856
 857
 858
 859
 860
 861
 862
 863
 864
 865
 866
 867
 868     <dt class="tag-source">Source:</dt>
 869     <dd class="tag-source"><ul class="dummy"><li>
 870         <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line4230">line 4230</a>
 871     </li></ul></dd>
 872
 873
 874
 875
 876
 877
 878
 879 </dl>
 880
 881
 882
 883
 884
 885
 886
 887
 888 <h4 class="name" id="requestStream"><span class="type-signature"></span>requestStream<span class="type-signature"> :bool</span></h4>
 889
 890
 891
 892
 893 <div class="description">
 894     <p>Whether requests are streamed</p>
 895 </div>
 896
 897
 898
 899     <h5>Type:</h5>
 900     <ul>
 901         <li>
 902
 903 <span class="param-type">bool</span>
 904
 905
 906         </li>
 907     </ul>
 908
 909
 910
 911
 912
 913 <dl class="details">
 914
 915
 916
 917
 918
 919
 920
 921
 922
 923
 924
 925
 926
 927
 928
 929
 930
 931
 932
 933
 934
 935
 936
 937
 938
 939
 940     <dt class="tag-source">Source:</dt>
 941     <dd class="tag-source"><ul class="dummy"><li>
 942         <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line4244">line 4244</a>
 943     </li></ul></dd>
 944
 945
 946
 947
 948
 949
 950
 951 </dl>
 952
 953
 954
 955
 956
 957
 958
 959
 960 <h4 class="name" id="resolvedRequestType"><span class="type-signature"></span>resolvedRequestType<span class="type-signature"> :<a href="ProtoBuf.Reflect.Message.html">ProtoBuf.Reflect.Message</a></span></h4>
 961
 962
 963
 964
 965 <div class="description">
 966     <p>Resolved request message type.</p>
 967 </div>
 968
 969
 970
 971     <h5>Type:</h5>
 972     <ul>
 973         <li>
 974
 975 <span class="param-type"><a href="ProtoBuf.Reflect.Message.html">ProtoBuf.Reflect.Message</a></span>
 976
 977
 978         </li>
 979     </ul>
 980
 981
 982
 983
 984
 985 <dl class="details">
 986
 987
 988
 989
 990
 991
 992
 993
 994
 995
 996
 997
 998
 999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012     <dt class="tag-source">Source:</dt>
1013     <dd class="tag-source"><ul class="dummy"><li>
1014         <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line4258">line 4258</a>
1015     </li></ul></dd>
1016
1017
1018
1019
1020
1021
1022
1023 </dl>
1024
1025
1026
1027
1028
1029
1030
1031
1032 <h4 class="name" id="resolvedResponseType"><span class="type-signature"></span>resolvedResponseType<span class="type-signature"> :<a href="ProtoBuf.Reflect.Message.html">ProtoBuf.Reflect.Message</a></span></h4>
1033
1034
1035
1036
1037 <div class="description">
1038     <p>Resolved response message type.</p>
1039 </div>
1040
1041
1042
1043     <h5>Type:</h5>
1044     <ul>
1045         <li>
1046
1047 <span class="param-type"><a href="ProtoBuf.Reflect.Message.html">ProtoBuf.Reflect.Message</a></span>
1048
1049
1050         </li>
1051     </ul>
1052
1053
1054
1055
1056
1057 <dl class="details">
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084     <dt class="tag-source">Source:</dt>
1085     <dd class="tag-source"><ul class="dummy"><li>
1086         <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line4265">line 4265</a>
1087     </li></ul></dd>
1088
1089
1090
1091
1092
1093
1094
1095 </dl>
1096
1097
1098
1099
1100
1101
1102
1103
1104 <h4 class="name" id="responseName"><span class="type-signature"></span>responseName<span class="type-signature"> :string</span></h4>
1105
1106
1107
1108
1109 <div class="description">
1110     <p>Response message name.</p>
1111 </div>
1112
1113
1114
1115     <h5>Type:</h5>
1116     <ul>
1117         <li>
1118
1119 <span class="param-type">string</span>
1120
1121
1122         </li>
1123     </ul>
1124
1125
1126
1127
1128
1129 <dl class="details">
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156     <dt class="tag-source">Source:</dt>
1157     <dd class="tag-source"><ul class="dummy"><li>
1158         <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line4237">line 4237</a>
1159     </li></ul></dd>
1160
1161
1162
1163
1164
1165
1166
1167 </dl>
1168
1169
1170
1171
1172
1173
1174
1175
1176 <h4 class="name" id="responseStream"><span class="type-signature"></span>responseStream<span class="type-signature"> :bool</span></h4>
1177
1178
1179
1180
1181 <div class="description">
1182     <p>Whether responses are streamed</p>
1183 </div>
1184
1185
1186
1187     <h5>Type:</h5>
1188     <ul>
1189         <li>
1190
1191 <span class="param-type">bool</span>
1192
1193
1194         </li>
1195     </ul>
1196
1197
1198
1199
1200
1201 <dl class="details">
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228     <dt class="tag-source">Source:</dt>
1229     <dd class="tag-source"><ul class="dummy"><li>
1230         <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line4251">line 4251</a>
1231     </li></ul></dd>
1232
1233
1234
1235
1236
1237
1238
1239 </dl>
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250         <h3 class="subsection-title">Methods</h3>
1251
1252
1253
1254
1255
1256
1257     <h4 class="name" id="build"><span class="type-signature"></span>build<span class="signature">()</span><span class="type-signature"></span></h4>
1258
1259
1260
1261
1262
1263 <div class="description">
1264     <p>Builds this type.</p>
1265 </div>
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279 <dl class="details">
1280
1281
1282
1283
1284
1285
1286     <dt class="inherited-from">Inherited From:</dt>
1287     <dd class="inherited-from"><ul class="dummy"><li>
1288         <a href="ProtoBuf.Reflect.T.html#build">ProtoBuf.Reflect.T#build</a>
1289     </li></ul></dd>
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311     <dt class="tag-source">Source:</dt>
1312     <dd class="tag-source"><ul class="dummy"><li>
1313         <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1479">line 1479</a>
1314     </li></ul></dd>
1315
1316
1317
1318
1319
1320
1321
1322 </dl>
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334 <h5>Throws:</h5>
1335
1336
1337
1338 <dl>
1339     <dt>
1340         <div class="param-desc">
1341         <p>If this type cannot be built directly</p>
1342         </div>
1343     </dt>
1344     <dd></dd>
1345     <dt>
1346         <dl>
1347             <dt>
1348                 Type
1349             </dt>
1350             <dd>
1351
1352 <span class="param-type">Error</span>
1353
1354
1355             </dd>
1356         </dl>
1357     </dt>
1358     <dd></dd>
1359 </dl>
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373     <h4 class="name" id="buildOpt"><span class="type-signature"></span>buildOpt<span class="signature">()</span><span class="type-signature"> &rarr; {Object.&lt;string, *>}</span></h4>
1374
1375
1376
1377
1378
1379 <div class="description">
1380     <p>Builds the method's '$options' property.</p>
1381 </div>
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395 <dl class="details">
1396
1397
1398
1399
1400
1401
1402     <dt class="inherited-from">Inherited From:</dt>
1403     <dd class="inherited-from"><ul class="dummy"><li>
1404         <a href="ProtoBuf.Reflect.Service.Method.html#buildOpt">ProtoBuf.Reflect.Service.Method#buildOpt</a>
1405     </li></ul></dd>
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427     <dt class="tag-source">Source:</dt>
1428     <dd class="tag-source"><ul class="dummy"><li>
1429         <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line4189">line 4189</a>
1430     </li></ul></dd>
1431
1432
1433
1434
1435
1436
1437
1438 </dl>
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452 <h5>Returns:</h5>
1453
1454
1455
1456
1457 <dl>
1458     <dt>
1459         Type
1460     </dt>
1461     <dd>
1462
1463 <span class="param-type">Object.&lt;string, *></span>
1464
1465
1466     </dd>
1467 </dl>
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478     <h4 class="name" id="fqn"><span class="type-signature"></span>fqn<span class="signature">()</span><span class="type-signature"> &rarr; {string}</span></h4>
1479
1480
1481
1482
1483
1484 <div class="description">
1485     <p>Returns the fully qualified name of this object.</p>
1486 </div>
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500 <dl class="details">
1501
1502
1503
1504
1505
1506
1507     <dt class="inherited-from">Inherited From:</dt>
1508     <dd class="inherited-from"><ul class="dummy"><li>
1509         <a href="ProtoBuf.Reflect.T.html#fqn">ProtoBuf.Reflect.T#fqn</a>
1510     </li></ul></dd>
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532     <dt class="tag-source">Source:</dt>
1533     <dd class="tag-source"><ul class="dummy"><li>
1534         <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1452">line 1452</a>
1535     </li></ul></dd>
1536
1537
1538
1539
1540
1541
1542
1543 </dl>
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557 <h5>Returns:</h5>
1558
1559
1560 <div class="param-desc">
1561     <p>Fully qualified name as of &quot;.PATH.TO.THIS&quot;</p>
1562 </div>
1563
1564
1565
1566 <dl>
1567     <dt>
1568         Type
1569     </dt>
1570     <dd>
1571
1572 <span class="param-type">string</span>
1573
1574
1575     </dd>
1576 </dl>
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587     <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>
1588
1589
1590
1591
1592
1593 <div class="description">
1594     <p>Returns a string representation of this Reflect object (its fully qualified name).</p>
1595 </div>
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605     <h5>Parameters:</h5>
1606
1607
1608 <table class="params">
1609     <thead>
1610     <tr>
1611
1612         <th>Name</th>
1613
1614
1615         <th>Type</th>
1616
1617
1618         <th>Attributes</th>
1619
1620
1621
1622
1623         <th class="last">Description</th>
1624     </tr>
1625     </thead>
1626
1627     <tbody>
1628
1629
1630         <tr>
1631
1632                 <td class="name"><code>includeClass</code></td>
1633
1634
1635             <td class="type">
1636
1637
1638 <span class="param-type">boolean</span>
1639
1640
1641
1642             </td>
1643
1644
1645                 <td class="attributes">
1646
1647                     &lt;optional><br>
1648
1649
1650
1651
1652
1653                 </td>
1654
1655
1656
1657
1658             <td class="description last"><p>Set to true to include the class name. Defaults to false.</p></td>
1659         </tr>
1660
1661
1662     </tbody>
1663 </table>
1664
1665
1666
1667
1668
1669
1670 <dl class="details">
1671
1672
1673
1674
1675
1676
1677     <dt class="inherited-from">Inherited From:</dt>
1678     <dd class="inherited-from"><ul class="dummy"><li>
1679         <a href="ProtoBuf.Reflect.T.html#toString">ProtoBuf.Reflect.T#toString</a>
1680     </li></ul></dd>
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702     <dt class="tag-source">Source:</dt>
1703     <dd class="tag-source"><ul class="dummy"><li>
1704         <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1470">line 1470</a>
1705     </li></ul></dd>
1706
1707
1708
1709
1710
1711
1712
1713 </dl>
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727 <h5>Returns:</h5>
1728
1729
1730 <div class="param-desc">
1731     <p>String representation</p>
1732 </div>
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746 </article>
1747
1748 </section>
1749
1750
1751
1752
1753 </div>
1754
1755 <nav>
1756     <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>
1757 </nav>
1758
1759 <br class="clear">
1760
1761 <footer>
1762     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)
1763 </footer>
1764
1765 <script> prettyPrint(); </script>
1766 <script src="scripts/linenumber.js"> </script>
1767 </body>
1768 </html>