PageRenderTime 48ms CodeModel.GetById 21ms RepoModel.GetById 0ms app.codeStats 0ms

/node_modules/protobufjs/docs/ProtoBuf.Reflect.Message.OneOf.html

https://gitlab.com/AshleyMcVeigh/cloudComputingAssignment
HTML | 1043 lines | 283 code | 757 blank | 3 comment | 0 complexity | 546aa0cbb30f19931df86a485d245b12 MD5 | raw file
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>JSDoc: Class: OneOf</title>
  6. <script src="scripts/prettify/prettify.js"> </script>
  7. <script src="scripts/prettify/lang-css.js"> </script>
  8. <!--[if lt IE 9]>
  9. <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
  10. <![endif]-->
  11. <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
  12. <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
  13. </head>
  14. <body>
  15. <div id="main">
  16. <h1 class="page-title">Class: OneOf</h1>
  17. <section>
  18. <header>
  19. <h2>
  20. <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>
  21. OneOf
  22. </h2>
  23. </header>
  24. <article>
  25. <div class="container-overview">
  26. <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>
  27. <div class="description">
  28. <p>Constructs a new Message OneOf.</p>
  29. </div>
  30. <h5>Parameters:</h5>
  31. <table class="params">
  32. <thead>
  33. <tr>
  34. <th>Name</th>
  35. <th>Type</th>
  36. <th class="last">Description</th>
  37. </tr>
  38. </thead>
  39. <tbody>
  40. <tr>
  41. <td class="name"><code>builder</code></td>
  42. <td class="type">
  43. <span class="param-type"><a href="ProtoBuf.Builder.html">ProtoBuf.Builder</a></span>
  44. </td>
  45. <td class="description last"><p>Builder reference</p></td>
  46. </tr>
  47. <tr>
  48. <td class="name"><code>message</code></td>
  49. <td class="type">
  50. <span class="param-type"><a href="ProtoBuf.Reflect.Message.html">ProtoBuf.Reflect.Message</a></span>
  51. </td>
  52. <td class="description last"><p>Message reference</p></td>
  53. </tr>
  54. <tr>
  55. <td class="name"><code>name</code></td>
  56. <td class="type">
  57. <span class="param-type">string</span>
  58. </td>
  59. <td class="description last"><p>OneOf name</p></td>
  60. </tr>
  61. </tbody>
  62. </table>
  63. <dl class="details">
  64. <dt class="tag-source">Source:</dt>
  65. <dd class="tag-source"><ul class="dummy"><li>
  66. <a href="ProtoBuf.js.html">ProtoBuf.js</a>, <a href="ProtoBuf.js.html#line3740">line 3740</a>
  67. </li></ul></dd>
  68. </dl>
  69. </div>
  70. <h3 class="subsection-title">Extends</h3>
  71. <ul>
  72. <li><a href="ProtoBuf.Reflect.T.html">ProtoBuf.Reflect.T</a></li>
  73. </ul>
  74. <h3 class="subsection-title">Members</h3>
  75. <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>
  76. <div class="description">
  77. <p>Builder reference.</p>
  78. </div>
  79. <h5>Type:</h5>
  80. <ul>
  81. <li>
  82. <span class="param-type"><a href="ProtoBuf.Builder.html">ProtoBuf.Builder</a></span>
  83. </li>
  84. </ul>
  85. <dl class="details">
  86. <dt class="inherited-from">Inherited From:</dt>
  87. <dd class="inherited-from"><ul class="dummy"><li>
  88. <a href="ProtoBuf.Reflect.T.html#builder">ProtoBuf.Reflect.T#builder</a>
  89. </li></ul></dd>
  90. <dt class="tag-source">Source:</dt>
  91. <dd class="tag-source"><ul class="dummy"><li>
  92. <a href="ProtoBuf.js.html">ProtoBuf.js</a>, <a href="ProtoBuf.js.html#line1382">line 1382</a>
  93. </li></ul></dd>
  94. </dl>
  95. <h4 class="name" id="className"><span class="type-signature"></span>className<span class="type-signature"> :string</span></h4>
  96. <div class="description">
  97. <p>Fully qualified class name</p>
  98. </div>
  99. <h5>Type:</h5>
  100. <ul>
  101. <li>
  102. <span class="param-type">string</span>
  103. </li>
  104. </ul>
  105. <dl class="details">
  106. <dt class="inherited-from">Inherited From:</dt>
  107. <dd class="inherited-from"><ul class="dummy"><li>
  108. <a href="ProtoBuf.Reflect.T.html#className">ProtoBuf.Reflect.T#className</a>
  109. </li></ul></dd>
  110. <dt class="tag-source">Source:</dt>
  111. <dd class="tag-source"><ul class="dummy"><li>
  112. <a href="ProtoBuf.js.html">ProtoBuf.js</a>, <a href="ProtoBuf.js.html#line1403">line 1403</a>
  113. </li></ul></dd>
  114. </dl>
  115. <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>
  116. <div class="description">
  117. <p>Enclosed fields.</p>
  118. </div>
  119. <h5>Type:</h5>
  120. <ul>
  121. <li>
  122. <span class="param-type">Array.&lt;!<a href="ProtoBuf.Reflect.Message.Field.html">ProtoBuf.Reflect.Message.Field</a>></span>
  123. </li>
  124. </ul>
  125. <dl class="details">
  126. <dt class="tag-source">Source:</dt>
  127. <dd class="tag-source"><ul class="dummy"><li>
  128. <a href="ProtoBuf.js.html">ProtoBuf.js</a>, <a href="ProtoBuf.js.html#line3748">line 3748</a>
  129. </li></ul></dd>
  130. </dl>
  131. <h4 class="name" id="name"><span class="type-signature"></span>name<span class="type-signature"> :string</span></h4>
  132. <div class="description">
  133. <p>Object name in namespace.</p>
  134. </div>
  135. <h5>Type:</h5>
  136. <ul>
  137. <li>
  138. <span class="param-type">string</span>
  139. </li>
  140. </ul>
  141. <dl class="details">
  142. <dt class="inherited-from">Inherited From:</dt>
  143. <dd class="inherited-from"><ul class="dummy"><li>
  144. <a href="ProtoBuf.Reflect.T.html#name">ProtoBuf.Reflect.T#name</a>
  145. </li></ul></dd>
  146. <dt class="tag-source">Source:</dt>
  147. <dd class="tag-source"><ul class="dummy"><li>
  148. <a href="ProtoBuf.js.html">ProtoBuf.js</a>, <a href="ProtoBuf.js.html#line1396">line 1396</a>
  149. </li></ul></dd>
  150. </dl>
  151. <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>
  152. <div class="description">
  153. <p>Parent object.</p>
  154. </div>
  155. <h5>Type:</h5>
  156. <ul>
  157. <li>
  158. <span class="param-type"><a href="ProtoBuf.Reflect.T.html">ProtoBuf.Reflect.T</a></span>
  159. </li>
  160. </ul>
  161. <dl class="details">
  162. <dt class="inherited-from">Inherited From:</dt>
  163. <dd class="inherited-from"><ul class="dummy"><li>
  164. <a href="ProtoBuf.Reflect.T.html#parent">ProtoBuf.Reflect.T#parent</a>
  165. </li></ul></dd>
  166. <dt class="tag-source">Source:</dt>
  167. <dd class="tag-source"><ul class="dummy"><li>
  168. <a href="ProtoBuf.js.html">ProtoBuf.js</a>, <a href="ProtoBuf.js.html#line1389">line 1389</a>
  169. </li></ul></dd>
  170. </dl>
  171. <h3 class="subsection-title">Methods</h3>
  172. <h4 class="name" id="build"><span class="type-signature"></span>build<span class="signature">()</span><span class="type-signature"></span></h4>
  173. <div class="description">
  174. <p>Builds this type.</p>
  175. </div>
  176. <dl class="details">
  177. <dt class="inherited-from">Inherited From:</dt>
  178. <dd class="inherited-from"><ul class="dummy"><li>
  179. <a href="ProtoBuf.Reflect.T.html#build">ProtoBuf.Reflect.T#build</a>
  180. </li></ul></dd>
  181. <dt class="tag-source">Source:</dt>
  182. <dd class="tag-source"><ul class="dummy"><li>
  183. <a href="ProtoBuf.js.html">ProtoBuf.js</a>, <a href="ProtoBuf.js.html#line1444">line 1444</a>
  184. </li></ul></dd>
  185. </dl>
  186. <h5>Throws:</h5>
  187. <dl>
  188. <dt>
  189. <div class="param-desc">
  190. <p>If this type cannot be built directly</p>
  191. </div>
  192. </dt>
  193. <dd></dd>
  194. <dt>
  195. <dl>
  196. <dt>
  197. Type
  198. </dt>
  199. <dd>
  200. <span class="param-type">Error</span>
  201. </dd>
  202. </dl>
  203. </dt>
  204. <dd></dd>
  205. </dl>
  206. <h4 class="name" id="fqn"><span class="type-signature"></span>fqn<span class="signature">()</span><span class="type-signature"> &rarr; {string}</span></h4>
  207. <div class="description">
  208. <p>Returns the fully qualified name of this object.</p>
  209. </div>
  210. <dl class="details">
  211. <dt class="inherited-from">Inherited From:</dt>
  212. <dd class="inherited-from"><ul class="dummy"><li>
  213. <a href="ProtoBuf.Reflect.T.html#fqn">ProtoBuf.Reflect.T#fqn</a>
  214. </li></ul></dd>
  215. <dt class="tag-source">Source:</dt>
  216. <dd class="tag-source"><ul class="dummy"><li>
  217. <a href="ProtoBuf.js.html">ProtoBuf.js</a>, <a href="ProtoBuf.js.html#line1417">line 1417</a>
  218. </li></ul></dd>
  219. </dl>
  220. <h5>Returns:</h5>
  221. <div class="param-desc">
  222. <p>Fully qualified name as of &quot;.PATH.TO.THIS&quot;</p>
  223. </div>
  224. <dl>
  225. <dt>
  226. Type
  227. </dt>
  228. <dd>
  229. <span class="param-type">string</span>
  230. </dd>
  231. </dl>
  232. <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>
  233. <div class="description">
  234. <p>Returns a string representation of this Reflect object (its fully qualified name).</p>
  235. </div>
  236. <h5>Parameters:</h5>
  237. <table class="params">
  238. <thead>
  239. <tr>
  240. <th>Name</th>
  241. <th>Type</th>
  242. <th>Attributes</th>
  243. <th class="last">Description</th>
  244. </tr>
  245. </thead>
  246. <tbody>
  247. <tr>
  248. <td class="name"><code>includeClass</code></td>
  249. <td class="type">
  250. <span class="param-type">boolean</span>
  251. </td>
  252. <td class="attributes">
  253. &lt;optional><br>
  254. </td>
  255. <td class="description last"><p>Set to true to include the class name. Defaults to false.</p></td>
  256. </tr>
  257. </tbody>
  258. </table>
  259. <dl class="details">
  260. <dt class="inherited-from">Inherited From:</dt>
  261. <dd class="inherited-from"><ul class="dummy"><li>
  262. <a href="ProtoBuf.Reflect.T.html#toString">ProtoBuf.Reflect.T#toString</a>
  263. </li></ul></dd>
  264. <dt class="tag-source">Source:</dt>
  265. <dd class="tag-source"><ul class="dummy"><li>
  266. <a href="ProtoBuf.js.html">ProtoBuf.js</a>, <a href="ProtoBuf.js.html#line1435">line 1435</a>
  267. </li></ul></dd>
  268. </dl>
  269. <h5>Returns:</h5>
  270. <div class="param-desc">
  271. <p>String representation</p>
  272. </div>
  273. </article>
  274. </section>
  275. </div>
  276. <nav>
  277. <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>
  278. </nav>
  279. <br class="clear">
  280. <footer>
  281. 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)
  282. </footer>
  283. <script> prettyPrint(); </script>
  284. <script src="scripts/linenumber.js"> </script>
  285. </body>
  286. </html>