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

   1 <!DOCTYPE html>
   2 <html lang="en">
   3 <head>
   4     <meta charset="utf-8">
   5     <title>JSDoc: Class: Method</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: Method</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         Method
  35         </h2>
  36
  37
  38 </header>
  39
  40 <article>
  41     <div class="container-overview">
  42
  43
  44
  45
  46
  47     <h4 class="name" id="Method"><span class="type-signature"></span>new Method<span class="signature">(builder<span class="signature-attributes">non-null</span>, svc<span class="signature-attributes">non-null</span>, name, 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>Abstract 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>options</code></td>
 186
 187
 188             <td class="type">
 189
 190
 191 <span class="param-type">Object.&lt;string, *></span>
 192
 193
 194
 195             </td>
 196
 197
 198                 <td class="attributes">
 199
 200                     &lt;optional><br>
 201
 202
 203
 204
 205
 206                 </td>
 207
 208
 209
 210
 211             <td class="description last"><p>Options</p></td>
 212         </tr>
 213
 214
 215     </tbody>
 216 </table>
 217
 218
 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     <dt class="tag-source">Source:</dt>
 251     <dd class="tag-source"><ul class="dummy"><li>
 252         <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line4167">line 4167</a>
 253     </li></ul></dd>
 254
 255
 256
 257
 258
 259
 260
 261 </dl>
 262
 263
 264
 265
 266
 267
 268
 269
 270
 271
 272
 273
 274
 275
 276
 277
 278
 279     </div>
 280
 281
 282         <h3 class="subsection-title">Extends</h3>
 283
 284
 285
 286
 287     <ul>
 288         <li><a href="ProtoBuf.Reflect.T.html">ProtoBuf.Reflect.T</a></li>
 289     </ul>
 290
 291
 292
 293
 294
 295
 296
 297
 298
 299
 300
 301
 302
 303         <h3 class="subsection-title">Members</h3>
 304
 305
 306
 307 <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>
 308
 309
 310
 311
 312 <div class="description">
 313     <p>Builder reference.</p>
 314 </div>
 315
 316
 317
 318     <h5>Type:</h5>
 319     <ul>
 320         <li>
 321
 322 <span class="param-type"><a href="ProtoBuf.Builder.html">ProtoBuf.Builder</a></span>
 323
 324
 325         </li>
 326     </ul>
 327
 328
 329
 330
 331
 332 <dl class="details">
 333
 334
 335
 336
 337
 338
 339     <dt class="inherited-from">Inherited From:</dt>
 340     <dd class="inherited-from"><ul class="dummy"><li>
 341         <a href="ProtoBuf.Reflect.T.html#builder">ProtoBuf.Reflect.T#builder</a>
 342     </li></ul></dd>
 343
 344
 345
 346
 347
 348
 349
 350
 351
 352
 353
 354
 355
 356
 357
 358
 359
 360
 361
 362
 363
 364     <dt class="tag-source">Source:</dt>
 365     <dd class="tag-source"><ul class="dummy"><li>
 366         <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1417">line 1417</a>
 367     </li></ul></dd>
 368
 369
 370
 371
 372
 373
 374
 375 </dl>
 376
 377
 378
 379
 380
 381
 382
 383
 384 <h4 class="name" id="className"><span class="type-signature"></span>className<span class="type-signature"> :string</span></h4>
 385
 386
 387
 388
 389 <div class="description">
 390     <p>Fully qualified class name</p>
 391 </div>
 392
 393
 394
 395     <h5>Type:</h5>
 396     <ul>
 397         <li>
 398
 399 <span class="param-type">string</span>
 400
 401
 402         </li>
 403     </ul>
 404
 405
 406
 407
 408
 409 <dl class="details">
 410
 411
 412
 413
 414
 415
 416
 417
 418     <dt class="tag-overrides">Overrides:</dt>
 419     <dd class="tag-overrides"><ul class="dummy"><li>
 420         <a href="ProtoBuf.Reflect.T.html#className">ProtoBuf.Reflect.T#className</a>
 421     </li></ul></dd>
 422
 423
 424
 425
 426
 427
 428
 429
 430
 431
 432
 433
 434
 435
 436
 437
 438
 439
 440
 441     <dt class="tag-source">Source:</dt>
 442     <dd class="tag-source"><ul class="dummy"><li>
 443         <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1438">line 1438</a>
 444     </li></ul></dd>
 445
 446
 447
 448
 449
 450
 451
 452 </dl>
 453
 454
 455
 456
 457
 458
 459
 460
 461 <h4 class="name" id="name"><span class="type-signature"></span>name<span class="type-signature"> :string</span></h4>
 462
 463
 464
 465
 466 <div class="description">
 467     <p>Object name in namespace.</p>
 468 </div>
 469
 470
 471
 472     <h5>Type:</h5>
 473     <ul>
 474         <li>
 475
 476 <span class="param-type">string</span>
 477
 478
 479         </li>
 480     </ul>
 481
 482
 483
 484
 485
 486 <dl class="details">
 487
 488
 489
 490
 491
 492
 493     <dt class="inherited-from">Inherited From:</dt>
 494     <dd class="inherited-from"><ul class="dummy"><li>
 495         <a href="ProtoBuf.Reflect.T.html#name">ProtoBuf.Reflect.T#name</a>
 496     </li></ul></dd>
 497
 498
 499
 500
 501
 502
 503
 504
 505
 506
 507
 508
 509
 510
 511
 512
 513
 514
 515
 516
 517
 518     <dt class="tag-source">Source:</dt>
 519     <dd class="tag-source"><ul class="dummy"><li>
 520         <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1431">line 1431</a>
 521     </li></ul></dd>
 522
 523
 524
 525
 526
 527
 528
 529 </dl>
 530
 531
 532
 533
 534
 535
 536
 537
 538 <h4 class="name" id="options"><span class="type-signature"></span>options<span class="type-signature"> :Object.&lt;string, *></span></h4>
 539
 540
 541
 542
 543 <div class="description">
 544     <p>Options.</p>
 545 </div>
 546
 547
 548
 549     <h5>Type:</h5>
 550     <ul>
 551         <li>
 552
 553 <span class="param-type">Object.&lt;string, *></span>
 554
 555
 556         </li>
 557     </ul>
 558
 559
 560
 561
 562
 563 <dl class="details">
 564
 565
 566
 567
 568
 569
 570
 571
 572
 573
 574
 575
 576
 577
 578
 579
 580
 581
 582
 583
 584
 585
 586
 587
 588
 589
 590     <dt class="tag-source">Source:</dt>
 591     <dd class="tag-source"><ul class="dummy"><li>
 592         <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line4180">line 4180</a>
 593     </li></ul></dd>
 594
 595
 596
 597
 598
 599
 600
 601 </dl>
 602
 603
 604
 605
 606
 607
 608
 609
 610 <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>
 611
 612
 613
 614
 615 <div class="description">
 616     <p>Parent object.</p>
 617 </div>
 618
 619
 620
 621     <h5>Type:</h5>
 622     <ul>
 623         <li>
 624
 625 <span class="param-type"><a href="ProtoBuf.Reflect.T.html">ProtoBuf.Reflect.T</a></span>
 626
 627
 628         </li>
 629     </ul>
 630
 631
 632
 633
 634
 635 <dl class="details">
 636
 637
 638
 639
 640
 641
 642     <dt class="inherited-from">Inherited From:</dt>
 643     <dd class="inherited-from"><ul class="dummy"><li>
 644         <a href="ProtoBuf.Reflect.T.html#parent">ProtoBuf.Reflect.T#parent</a>
 645     </li></ul></dd>
 646
 647
 648
 649
 650
 651
 652
 653
 654
 655
 656
 657
 658
 659
 660
 661
 662
 663
 664
 665
 666
 667     <dt class="tag-source">Source:</dt>
 668     <dd class="tag-source"><ul class="dummy"><li>
 669         <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1424">line 1424</a>
 670     </li></ul></dd>
 671
 672
 673
 674
 675
 676
 677
 678 </dl>
 679
 680
 681
 682
 683
 684
 685
 686
 687
 688
 689         <h3 class="subsection-title">Methods</h3>
 690
 691
 692
 693
 694
 695
 696     <h4 class="name" id="build"><span class="type-signature"></span>build<span class="signature">()</span><span class="type-signature"></span></h4>
 697
 698
 699
 700
 701
 702 <div class="description">
 703     <p>Builds this type.</p>
 704 </div>
 705
 706
 707
 708
 709
 710
 711
 712
 713
 714
 715
 716
 717
 718 <dl class="details">
 719
 720
 721
 722
 723
 724
 725     <dt class="inherited-from">Inherited From:</dt>
 726     <dd class="inherited-from"><ul class="dummy"><li>
 727         <a href="ProtoBuf.Reflect.T.html#build">ProtoBuf.Reflect.T#build</a>
 728     </li></ul></dd>
 729
 730
 731
 732
 733
 734
 735
 736
 737
 738
 739
 740
 741
 742
 743
 744
 745
 746
 747
 748
 749
 750     <dt class="tag-source">Source:</dt>
 751     <dd class="tag-source"><ul class="dummy"><li>
 752         <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1479">line 1479</a>
 753     </li></ul></dd>
 754
 755
 756
 757
 758
 759
 760
 761 </dl>
 762
 763
 764
 765
 766
 767
 768
 769
 770
 771
 772
 773 <h5>Throws:</h5>
 774
 775
 776
 777 <dl>
 778     <dt>
 779         <div class="param-desc">
 780         <p>If this type cannot be built directly</p>
 781         </div>
 782     </dt>
 783     <dd></dd>
 784     <dt>
 785         <dl>
 786             <dt>
 787                 Type
 788             </dt>
 789             <dd>
 790
 791 <span class="param-type">Error</span>
 792
 793
 794             </dd>
 795         </dl>
 796     </dt>
 797     <dd></dd>
 798 </dl>
 799
 800
 801
 802
 803
 804
 805
 806
 807
 808
 809
 810
 811
 812     <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>
 813
 814
 815
 816
 817
 818 <div class="description">
 819     <p>Builds the method's '$options' property.</p>
 820 </div>
 821
 822
 823
 824
 825
 826
 827
 828
 829
 830
 831
 832
 833
 834 <dl class="details">
 835
 836
 837
 838
 839
 840
 841
 842
 843
 844
 845
 846
 847
 848
 849
 850
 851
 852
 853
 854
 855
 856
 857
 858
 859
 860
 861     <dt class="tag-source">Source:</dt>
 862     <dd class="tag-source"><ul class="dummy"><li>
 863         <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line4189">line 4189</a>
 864     </li></ul></dd>
 865
 866
 867
 868
 869
 870
 871
 872 </dl>
 873
 874
 875
 876
 877
 878
 879
 880
 881
 882
 883
 884
 885
 886 <h5>Returns:</h5>
 887
 888
 889
 890
 891 <dl>
 892     <dt>
 893         Type
 894     </dt>
 895     <dd>
 896
 897 <span class="param-type">Object.&lt;string, *></span>
 898
 899
 900     </dd>
 901 </dl>
 902
 903
 904
 905
 906
 907
 908
 909
 910
 911
 912     <h4 class="name" id="fqn"><span class="type-signature"></span>fqn<span class="signature">()</span><span class="type-signature"> &rarr; {string}</span></h4>
 913
 914
 915
 916
 917
 918 <div class="description">
 919     <p>Returns the fully qualified name of this object.</p>
 920 </div>
 921
 922
 923
 924
 925
 926
 927
 928
 929
 930
 931
 932
 933
 934 <dl class="details">
 935
 936
 937
 938
 939
 940
 941     <dt class="inherited-from">Inherited From:</dt>
 942     <dd class="inherited-from"><ul class="dummy"><li>
 943         <a href="ProtoBuf.Reflect.T.html#fqn">ProtoBuf.Reflect.T#fqn</a>
 944     </li></ul></dd>
 945
 946
 947
 948
 949
 950
 951
 952
 953
 954
 955
 956
 957
 958
 959
 960
 961
 962
 963
 964
 965
 966     <dt class="tag-source">Source:</dt>
 967     <dd class="tag-source"><ul class="dummy"><li>
 968         <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1452">line 1452</a>
 969     </li></ul></dd>
 970
 971
 972
 973
 974
 975
 976
 977 </dl>
 978
 979
 980
 981
 982
 983
 984
 985
 986
 987
 988
 989
 990
 991 <h5>Returns:</h5>
 992
 993
 994 <div class="param-desc">
 995     <p>Fully qualified name as of &quot;.PATH.TO.THIS&quot;</p>
 996 </div>
 997
 998
 999
1000 <dl>
1001     <dt>
1002         Type
1003     </dt>
1004     <dd>
1005
1006 <span class="param-type">string</span>
1007
1008
1009     </dd>
1010 </dl>
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021     <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>
1022
1023
1024
1025
1026
1027 <div class="description">
1028     <p>Returns a string representation of this Reflect object (its fully qualified name).</p>
1029 </div>
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039     <h5>Parameters:</h5>
1040
1041
1042 <table class="params">
1043     <thead>
1044     <tr>
1045
1046         <th>Name</th>
1047
1048
1049         <th>Type</th>
1050
1051
1052         <th>Attributes</th>
1053
1054
1055
1056
1057         <th class="last">Description</th>
1058     </tr>
1059     </thead>
1060
1061     <tbody>
1062
1063
1064         <tr>
1065
1066                 <td class="name"><code>includeClass</code></td>
1067
1068
1069             <td class="type">
1070
1071
1072 <span class="param-type">boolean</span>
1073
1074
1075
1076             </td>
1077
1078
1079                 <td class="attributes">
1080
1081                     &lt;optional><br>
1082
1083
1084
1085
1086
1087                 </td>
1088
1089
1090
1091
1092             <td class="description last"><p>Set to true to include the class name. Defaults to false.</p></td>
1093         </tr>
1094
1095
1096     </tbody>
1097 </table>
1098
1099
1100
1101
1102
1103
1104 <dl class="details">
1105
1106
1107
1108
1109
1110
1111     <dt class="inherited-from">Inherited From:</dt>
1112     <dd class="inherited-from"><ul class="dummy"><li>
1113         <a href="ProtoBuf.Reflect.T.html#toString">ProtoBuf.Reflect.T#toString</a>
1114     </li></ul></dd>
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136     <dt class="tag-source">Source:</dt>
1137     <dd class="tag-source"><ul class="dummy"><li>
1138         <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1470">line 1470</a>
1139     </li></ul></dd>
1140
1141
1142
1143
1144
1145
1146
1147 </dl>
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161 <h5>Returns:</h5>
1162
1163
1164 <div class="param-desc">
1165     <p>String representation</p>
1166 </div>
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180 </article>
1181
1182 </section>
1183
1184
1185
1186
1187 </div>
1188
1189 <nav>
1190     <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>
1191 </nav>
1192
1193 <br class="clear">
1194
1195 <footer>
1196     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)
1197 </footer>
1198
1199 <script> prettyPrint(); </script>
1200 <script src="scripts/linenumber.js"> </script>
1201 </body>
1202 </html>