5 <title>JSDoc: Class: Method</title>
7 <script src="scripts/prettify/prettify.js"> </script>
8 <script src="scripts/prettify/lang-css.js"> </script>
10 <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
12 <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
13 <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
20 <h1 class="page-title">Class: Method</h1>
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>
41 <div class="container-overview">
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>
53 <div class="description">
54 <p>Abstract service method.</p>
68 <table class="params">
83 <th class="last">Description</th>
92 <td class="name"><code>builder</code></td>
98 <span class="param-type"><a href="ProtoBuf.Builder.html">ProtoBuf.Builder</a></span>
105 <td class="attributes">
116 <td class="description last"><p>Builder reference</p></td>
123 <td class="name"><code>svc</code></td>
129 <span class="param-type"><a href="ProtoBuf.Reflect.Service.html">ProtoBuf.Reflect.Service</a></span>
136 <td class="attributes">
147 <td class="description last"><p>Service</p></td>
154 <td class="name"><code>name</code></td>
160 <span class="param-type">string</span>
167 <td class="attributes">
178 <td class="description last"><p>Method name</p></td>
185 <td class="name"><code>options</code></td>
191 <span class="param-type">Object.<string, *></span>
198 <td class="attributes">
211 <td class="description last"><p>Options</p></td>
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>
282 <h3 class="subsection-title">Extends</h3>
288 <li><a href="ProtoBuf.Reflect.T.html">ProtoBuf.Reflect.T</a></li>
303 <h3 class="subsection-title">Members</h3>
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>
312 <div class="description">
313 <p>Builder reference.</p>
322 <span class="param-type"><a href="ProtoBuf.Builder.html">ProtoBuf.Builder</a></span>
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>
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>
384 <h4 class="name" id="className"><span class="type-signature"></span>className<span class="type-signature"> :string</span></h4>
389 <div class="description">
390 <p>Fully qualified class name</p>
399 <span class="param-type">string</span>
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>
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>
461 <h4 class="name" id="name"><span class="type-signature"></span>name<span class="type-signature"> :string</span></h4>
466 <div class="description">
467 <p>Object name in namespace.</p>
476 <span class="param-type">string</span>
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>
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>
538 <h4 class="name" id="options"><span class="type-signature"></span>options<span class="type-signature"> :Object.<string, *></span></h4>
543 <div class="description">
553 <span class="param-type">Object.<string, *></span>
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>
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>
615 <div class="description">
616 <p>Parent object.</p>
625 <span class="param-type"><a href="ProtoBuf.Reflect.T.html">ProtoBuf.Reflect.T</a></span>
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>
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>
689 <h3 class="subsection-title">Methods</h3>
696 <h4 class="name" id="build"><span class="type-signature"></span>build<span class="signature">()</span><span class="type-signature"></span></h4>
702 <div class="description">
703 <p>Builds this type.</p>
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>
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>
779 <div class="param-desc">
780 <p>If this type cannot be built directly</p>
791 <span class="param-type">Error</span>
812 <h4 class="name" id="buildOpt"><span class="type-signature"></span>buildOpt<span class="signature">()</span><span class="type-signature"> → {Object.<string, *>}</span></h4>
818 <div class="description">
819 <p>Builds the method's '$options' property.</p>
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>
897 <span class="param-type">Object.<string, *></span>
912 <h4 class="name" id="fqn"><span class="type-signature"></span>fqn<span class="signature">()</span><span class="type-signature"> → {string}</span></h4>
918 <div class="description">
919 <p>Returns the fully qualified name of this object.</p>
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>
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>
994 <div class="param-desc">
995 <p>Fully qualified name as of ".PATH.TO.THIS"</p>
1006 <span class="param-type">string</span>
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>
1027 <div class="description">
1028 <p>Returns a string representation of this Reflect object (its fully qualified name).</p>
1039 <h5>Parameters:</h5>
1042 <table class="params">
1057 <th class="last">Description</th>
1066 <td class="name"><code>includeClass</code></td>
1072 <span class="param-type">boolean</span>
1079 <td class="attributes">
1092 <td class="description last"><p>Set to true to include the class name. Defaults to false.</p></td>
1104 <dl class="details">
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>
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>
1164 <div class="param-desc">
1165 <p>String representation</p>
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>
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)
1199 <script> prettyPrint(); </script>
1200 <script src="scripts/linenumber.js"> </script>