/node_modules/protobufjs/docs/ProtoBuf.Reflect.Message.OneOf.html
HTML | 1043 lines | 283 code | 757 blank | 3 comment | 0 complexity | 546aa0cbb30f19931df86a485d245b12 MD5 | raw file
- <!DOCTYPE html>
- <html lang="en">
- <head>
- <meta charset="utf-8">
- <title>JSDoc: Class: OneOf</title>
- <script src="scripts/prettify/prettify.js"> </script>
- <script src="scripts/prettify/lang-css.js"> </script>
- <!--[if lt IE 9]>
- <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
- <![endif]-->
- <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
- <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
- </head>
- <body>
- <div id="main">
- <h1 class="page-title">Class: OneOf</h1>
-
- <section>
- <header>
-
- <h2>
- <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>
-
- OneOf
- </h2>
-
-
- </header>
- <article>
- <div class="container-overview">
-
-
-
- <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>
-
- <div class="description">
- <p>Constructs a new Message OneOf.</p>
- </div>
- <h5>Parameters:</h5>
-
- <table class="params">
- <thead>
- <tr>
-
- <th>Name</th>
-
- <th>Type</th>
-
-
- <th class="last">Description</th>
- </tr>
- </thead>
- <tbody>
-
- <tr>
-
- <td class="name"><code>builder</code></td>
-
- <td class="type">
-
-
- <span class="param-type"><a href="ProtoBuf.Builder.html">ProtoBuf.Builder</a></span>
-
- </td>
-
-
- <td class="description last"><p>Builder reference</p></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>message</code></td>
-
- <td class="type">
-
-
- <span class="param-type"><a href="ProtoBuf.Reflect.Message.html">ProtoBuf.Reflect.Message</a></span>
-
- </td>
-
-
- <td class="description last"><p>Message reference</p></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>name</code></td>
-
- <td class="type">
-
-
- <span class="param-type">string</span>
-
- </td>
-
-
- <td class="description last"><p>OneOf name</p></td>
- </tr>
-
- </tbody>
- </table>
- <dl class="details">
-
-
-
-
-
-
-
-
-
-
-
-
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="ProtoBuf.js.html">ProtoBuf.js</a>, <a href="ProtoBuf.js.html#line3740">line 3740</a>
- </li></ul></dd>
-
-
-
-
- </dl>
-
- </div>
-
- <h3 class="subsection-title">Extends</h3>
-
- <ul>
- <li><a href="ProtoBuf.Reflect.T.html">ProtoBuf.Reflect.T</a></li>
- </ul>
-
-
-
-
-
-
- <h3 class="subsection-title">Members</h3>
-
-
- <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>
- <div class="description">
- <p>Builder reference.</p>
- </div>
- <h5>Type:</h5>
- <ul>
- <li>
-
- <span class="param-type"><a href="ProtoBuf.Builder.html">ProtoBuf.Builder</a></span>
- </li>
- </ul>
- <dl class="details">
-
-
-
- <dt class="inherited-from">Inherited From:</dt>
- <dd class="inherited-from"><ul class="dummy"><li>
- <a href="ProtoBuf.Reflect.T.html#builder">ProtoBuf.Reflect.T#builder</a>
- </li></ul></dd>
-
-
-
-
-
-
-
-
-
-
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="ProtoBuf.js.html">ProtoBuf.js</a>, <a href="ProtoBuf.js.html#line1382">line 1382</a>
- </li></ul></dd>
-
-
-
-
- </dl>
-
-
- <h4 class="name" id="className"><span class="type-signature"></span>className<span class="type-signature"> :string</span></h4>
- <div class="description">
- <p>Fully qualified class name</p>
- </div>
- <h5>Type:</h5>
- <ul>
- <li>
-
- <span class="param-type">string</span>
- </li>
- </ul>
- <dl class="details">
-
-
-
- <dt class="inherited-from">Inherited From:</dt>
- <dd class="inherited-from"><ul class="dummy"><li>
- <a href="ProtoBuf.Reflect.T.html#className">ProtoBuf.Reflect.T#className</a>
- </li></ul></dd>
-
-
-
-
-
-
-
-
-
-
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="ProtoBuf.js.html">ProtoBuf.js</a>, <a href="ProtoBuf.js.html#line1403">line 1403</a>
- </li></ul></dd>
-
-
-
-
- </dl>
-
-
- <h4 class="name" id="fields"><span class="type-signature">(non-null) </span>fields<span class="type-signature"> :Array.<!<a href="ProtoBuf.Reflect.Message.Field.html">ProtoBuf.Reflect.Message.Field</a>></span></h4>
- <div class="description">
- <p>Enclosed fields.</p>
- </div>
- <h5>Type:</h5>
- <ul>
- <li>
-
- <span class="param-type">Array.<!<a href="ProtoBuf.Reflect.Message.Field.html">ProtoBuf.Reflect.Message.Field</a>></span>
- </li>
- </ul>
- <dl class="details">
-
-
-
-
-
-
-
-
-
-
-
-
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="ProtoBuf.js.html">ProtoBuf.js</a>, <a href="ProtoBuf.js.html#line3748">line 3748</a>
- </li></ul></dd>
-
-
-
-
- </dl>
-
-
- <h4 class="name" id="name"><span class="type-signature"></span>name<span class="type-signature"> :string</span></h4>
- <div class="description">
- <p>Object name in namespace.</p>
- </div>
- <h5>Type:</h5>
- <ul>
- <li>
-
- <span class="param-type">string</span>
- </li>
- </ul>
- <dl class="details">
-
-
-
- <dt class="inherited-from">Inherited From:</dt>
- <dd class="inherited-from"><ul class="dummy"><li>
- <a href="ProtoBuf.Reflect.T.html#name">ProtoBuf.Reflect.T#name</a>
- </li></ul></dd>
-
-
-
-
-
-
-
-
-
-
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="ProtoBuf.js.html">ProtoBuf.js</a>, <a href="ProtoBuf.js.html#line1396">line 1396</a>
- </li></ul></dd>
-
-
-
-
- </dl>
-
-
- <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>
- <div class="description">
- <p>Parent object.</p>
- </div>
- <h5>Type:</h5>
- <ul>
- <li>
-
- <span class="param-type"><a href="ProtoBuf.Reflect.T.html">ProtoBuf.Reflect.T</a></span>
- </li>
- </ul>
- <dl class="details">
-
-
-
- <dt class="inherited-from">Inherited From:</dt>
- <dd class="inherited-from"><ul class="dummy"><li>
- <a href="ProtoBuf.Reflect.T.html#parent">ProtoBuf.Reflect.T#parent</a>
- </li></ul></dd>
-
-
-
-
-
-
-
-
-
-
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="ProtoBuf.js.html">ProtoBuf.js</a>, <a href="ProtoBuf.js.html#line1389">line 1389</a>
- </li></ul></dd>
-
-
-
-
- </dl>
-
-
-
- <h3 class="subsection-title">Methods</h3>
-
-
-
- <h4 class="name" id="build"><span class="type-signature"></span>build<span class="signature">()</span><span class="type-signature"></span></h4>
-
- <div class="description">
- <p>Builds this type.</p>
- </div>
- <dl class="details">
-
-
-
- <dt class="inherited-from">Inherited From:</dt>
- <dd class="inherited-from"><ul class="dummy"><li>
- <a href="ProtoBuf.Reflect.T.html#build">ProtoBuf.Reflect.T#build</a>
- </li></ul></dd>
-
-
-
-
-
-
-
-
-
-
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="ProtoBuf.js.html">ProtoBuf.js</a>, <a href="ProtoBuf.js.html#line1444">line 1444</a>
- </li></ul></dd>
-
-
-
-
- </dl>
- <h5>Throws:</h5>
-
- <dl>
- <dt>
- <div class="param-desc">
- <p>If this type cannot be built directly</p>
- </div>
- </dt>
- <dd></dd>
- <dt>
- <dl>
- <dt>
- Type
- </dt>
- <dd>
-
- <span class="param-type">Error</span>
- </dd>
- </dl>
- </dt>
- <dd></dd>
- </dl>
-
-
-
-
- <h4 class="name" id="fqn"><span class="type-signature"></span>fqn<span class="signature">()</span><span class="type-signature"> → {string}</span></h4>
-
- <div class="description">
- <p>Returns the fully qualified name of this object.</p>
- </div>
- <dl class="details">
-
-
-
- <dt class="inherited-from">Inherited From:</dt>
- <dd class="inherited-from"><ul class="dummy"><li>
- <a href="ProtoBuf.Reflect.T.html#fqn">ProtoBuf.Reflect.T#fqn</a>
- </li></ul></dd>
-
-
-
-
-
-
-
-
-
-
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="ProtoBuf.js.html">ProtoBuf.js</a>, <a href="ProtoBuf.js.html#line1417">line 1417</a>
- </li></ul></dd>
-
-
-
-
- </dl>
- <h5>Returns:</h5>
-
- <div class="param-desc">
- <p>Fully qualified name as of ".PATH.TO.THIS"</p>
- </div>
- <dl>
- <dt>
- Type
- </dt>
- <dd>
-
- <span class="param-type">string</span>
- </dd>
- </dl>
-
-
-
-
- <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>
-
- <div class="description">
- <p>Returns a string representation of this Reflect object (its fully qualified name).</p>
- </div>
- <h5>Parameters:</h5>
-
- <table class="params">
- <thead>
- <tr>
-
- <th>Name</th>
-
- <th>Type</th>
-
- <th>Attributes</th>
-
-
- <th class="last">Description</th>
- </tr>
- </thead>
- <tbody>
-
- <tr>
-
- <td class="name"><code>includeClass</code></td>
-
- <td class="type">
-
-
- <span class="param-type">boolean</span>
-
- </td>
-
- <td class="attributes">
-
- <optional><br>
-
-
-
- </td>
-
-
- <td class="description last"><p>Set to true to include the class name. Defaults to false.</p></td>
- </tr>
-
- </tbody>
- </table>
- <dl class="details">
-
-
-
- <dt class="inherited-from">Inherited From:</dt>
- <dd class="inherited-from"><ul class="dummy"><li>
- <a href="ProtoBuf.Reflect.T.html#toString">ProtoBuf.Reflect.T#toString</a>
- </li></ul></dd>
-
-
-
-
-
-
-
-
-
-
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="ProtoBuf.js.html">ProtoBuf.js</a>, <a href="ProtoBuf.js.html#line1435">line 1435</a>
- </li></ul></dd>
-
-
-
-
- </dl>
- <h5>Returns:</h5>
-
- <div class="param-desc">
- <p>String representation</p>
- </div>
-
-
-
-
-
- </article>
- </section>
- </div>
- <nav>
- <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>
- </nav>
- <br class="clear">
- <footer>
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.3</a> on Tue Nov 17 2015 01:51:28 GMT+0100 (Mitteleuropäische Zeit)
- </footer>
- <script> prettyPrint(); </script>
- <script src="scripts/linenumber.js"> </script>
- </body>
- </html>