ProtoBuf.Reflect.Message.html 44 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>JSDoc: Class: Message</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: Message</h1>
  17. <section>
  18. <header>
  19. <h2>
  20. <span class="ancestors"><a href="ProtoBuf.html">ProtoBuf</a><a href="ProtoBuf.Reflect.html">.Reflect</a>.</span>
  21. Message
  22. </h2>
  23. </header>
  24. <article>
  25. <div class="container-overview">
  26. <h4 class="name" id="Message"><span class="type-signature"></span>new Message<span class="signature">(builder<span class="signature-attributes">non-null</span>, parent<span class="signature-attributes">non-null</span>, name, options<span class="signature-attributes">opt</span>, isGroup<span class="signature-attributes">opt</span>, syntax<span class="signature-attributes">nullable</span>)</span><span class="type-signature"></span></h4>
  27. <div class="description">
  28. <p>Constructs a new Message.</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>Attributes</th>
  37. <th class="last">Description</th>
  38. </tr>
  39. </thead>
  40. <tbody>
  41. <tr>
  42. <td class="name"><code>builder</code></td>
  43. <td class="type">
  44. <span class="param-type"><a href="ProtoBuf.Builder.html">ProtoBuf.Builder</a></span>
  45. </td>
  46. <td class="attributes">
  47. </td>
  48. <td class="description last"><p>Builder reference</p></td>
  49. </tr>
  50. <tr>
  51. <td class="name"><code>parent</code></td>
  52. <td class="type">
  53. <span class="param-type"><a href="ProtoBuf.Reflect.Namespace.html">ProtoBuf.Reflect.Namespace</a></span>
  54. </td>
  55. <td class="attributes">
  56. </td>
  57. <td class="description last"><p>Parent message or namespace</p></td>
  58. </tr>
  59. <tr>
  60. <td class="name"><code>name</code></td>
  61. <td class="type">
  62. <span class="param-type">string</span>
  63. </td>
  64. <td class="attributes">
  65. </td>
  66. <td class="description last"><p>Message name</p></td>
  67. </tr>
  68. <tr>
  69. <td class="name"><code>options</code></td>
  70. <td class="type">
  71. <span class="param-type">Object.&lt;string, *></span>
  72. </td>
  73. <td class="attributes">
  74. &lt;optional><br>
  75. </td>
  76. <td class="description last"><p>Message options</p></td>
  77. </tr>
  78. <tr>
  79. <td class="name"><code>isGroup</code></td>
  80. <td class="type">
  81. <span class="param-type">boolean</span>
  82. </td>
  83. <td class="attributes">
  84. &lt;optional><br>
  85. </td>
  86. <td class="description last"><p><code>true</code> if this is a legacy group</p></td>
  87. </tr>
  88. <tr>
  89. <td class="name"><code>syntax</code></td>
  90. <td class="type">
  91. <span class="param-type">string</span>
  92. </td>
  93. <td class="attributes">
  94. &lt;nullable><br>
  95. </td>
  96. <td class="description last"><p>The syntax level of this definition (e.g., proto3)</p></td>
  97. </tr>
  98. </tbody>
  99. </table>
  100. <dl class="details">
  101. <dt class="tag-source">Source:</dt>
  102. <dd class="tag-source"><ul class="dummy"><li>
  103. <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line2298">line 2298</a>
  104. </li></ul></dd>
  105. </dl>
  106. </div>
  107. <h3 class="subsection-title">Extends</h3>
  108. <ul>
  109. <li><a href="ProtoBuf.Reflect.Namespace.html">ProtoBuf.Reflect.Namespace</a></li>
  110. </ul>
  111. <h3 class="subsection-title">Classes</h3>
  112. <dl>
  113. <dt><a href="ProtoBuf.Reflect.Message.ExtensionField.html">ExtensionField</a></dt>
  114. <dd></dd>
  115. <dt><a href="ProtoBuf.Reflect.Message.Field.html">Field</a></dt>
  116. <dd></dd>
  117. <dt><a href="ProtoBuf.Reflect.Message.OneOf.html">OneOf</a></dt>
  118. <dd></dd>
  119. </dl>
  120. <h3 class="subsection-title">Members</h3>
  121. <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>
  122. <div class="description">
  123. <p>Builder reference.</p>
  124. </div>
  125. <h5>Type:</h5>
  126. <ul>
  127. <li>
  128. <span class="param-type"><a href="ProtoBuf.Builder.html">ProtoBuf.Builder</a></span>
  129. </li>
  130. </ul>
  131. <dl class="details">
  132. <dt class="inherited-from">Inherited From:</dt>
  133. <dd class="inherited-from"><ul class="dummy"><li>
  134. <a href="ProtoBuf.Reflect.T.html#builder">ProtoBuf.Reflect.T#builder</a>
  135. </li></ul></dd>
  136. <dt class="tag-source">Source:</dt>
  137. <dd class="tag-source"><ul class="dummy"><li>
  138. <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1417">line 1417</a>
  139. </li></ul></dd>
  140. </dl>
  141. <h4 class="name" id="children"><span class="type-signature">(non-null) </span>children<span class="type-signature"> :Array.&lt;<a href="ProtoBuf.Reflect.T.html">ProtoBuf.Reflect.T</a>></span></h4>
  142. <div class="description">
  143. <p>Children inside the namespace.</p>
  144. </div>
  145. <h5>Type:</h5>
  146. <ul>
  147. <li>
  148. <span class="param-type">Array.&lt;<a href="ProtoBuf.Reflect.T.html">ProtoBuf.Reflect.T</a>></span>
  149. </li>
  150. </ul>
  151. <dl class="details">
  152. <dt class="inherited-from">Inherited From:</dt>
  153. <dd class="inherited-from"><ul class="dummy"><li>
  154. <a href="ProtoBuf.Reflect.Namespace.html#children">ProtoBuf.Reflect.Namespace#children</a>
  155. </li></ul></dd>
  156. <dt class="tag-source">Source:</dt>
  157. <dd class="tag-source"><ul class="dummy"><li>
  158. <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1512">line 1512</a>
  159. </li></ul></dd>
  160. </dl>
  161. <h4 class="name" id="className"><span class="type-signature"></span>className<span class="type-signature"> :string</span></h4>
  162. <div class="description">
  163. <p>Fully qualified class name</p>
  164. </div>
  165. <h5>Type:</h5>
  166. <ul>
  167. <li>
  168. <span class="param-type">string</span>
  169. </li>
  170. </ul>
  171. <dl class="details">
  172. <dt class="tag-overrides">Overrides:</dt>
  173. <dd class="tag-overrides"><ul class="dummy"><li>
  174. <a href="ProtoBuf.Reflect.Namespace.html#className">ProtoBuf.Reflect.Namespace#className</a>
  175. </li></ul></dd>
  176. <dt class="tag-source">Source:</dt>
  177. <dd class="tag-source"><ul class="dummy"><li>
  178. <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1438">line 1438</a>
  179. </li></ul></dd>
  180. </dl>
  181. <h4 class="name" id="clazz"><span class="type-signature">(nullable) </span>clazz<span class="type-signature"> :function</span></h4>
  182. <div class="description">
  183. <p>Runtime message class.</p>
  184. </div>
  185. <h5>Type:</h5>
  186. <ul>
  187. <li>
  188. <span class="param-type">function</span>
  189. </li>
  190. </ul>
  191. <dl class="details">
  192. <dt class="tag-source">Source:</dt>
  193. <dd class="tag-source"><ul class="dummy"><li>
  194. <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line2318">line 2318</a>
  195. </li></ul></dd>
  196. </dl>
  197. <h4 class="name" id="extensions"><span class="type-signature"></span>extensions<span class="type-signature"> :!Array.&lt;number>|undefined</span></h4>
  198. <div class="description">
  199. <p>Extensions range.</p>
  200. </div>
  201. <h5>Type:</h5>
  202. <ul>
  203. <li>
  204. <span class="param-type">!Array.&lt;number></span>
  205. |
  206. <span class="param-type">undefined</span>
  207. </li>
  208. </ul>
  209. <dl class="details">
  210. <dt class="tag-source">Source:</dt>
  211. <dd class="tag-source"><ul class="dummy"><li>
  212. <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line2311">line 2311</a>
  213. </li></ul></dd>
  214. </dl>
  215. <h4 class="name" id="isGroup"><span class="type-signature"></span>isGroup<span class="type-signature"> :boolean</span></h4>
  216. <div class="description">
  217. <p>Whether this is a legacy group or not.</p>
  218. </div>
  219. <h5>Type:</h5>
  220. <ul>
  221. <li>
  222. <span class="param-type">boolean</span>
  223. </li>
  224. </ul>
  225. <dl class="details">
  226. <dt class="tag-source">Source:</dt>
  227. <dd class="tag-source"><ul class="dummy"><li>
  228. <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line2325">line 2325</a>
  229. </li></ul></dd>
  230. </dl>
  231. <h4 class="name" id="name"><span class="type-signature"></span>name<span class="type-signature"> :string</span></h4>
  232. <div class="description">
  233. <p>Object name in namespace.</p>
  234. </div>
  235. <h5>Type:</h5>
  236. <ul>
  237. <li>
  238. <span class="param-type">string</span>
  239. </li>
  240. </ul>
  241. <dl class="details">
  242. <dt class="inherited-from">Inherited From:</dt>
  243. <dd class="inherited-from"><ul class="dummy"><li>
  244. <a href="ProtoBuf.Reflect.T.html#name">ProtoBuf.Reflect.T#name</a>
  245. </li></ul></dd>
  246. <dt class="tag-source">Source:</dt>
  247. <dd class="tag-source"><ul class="dummy"><li>
  248. <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1431">line 1431</a>
  249. </li></ul></dd>
  250. </dl>
  251. <h4 class="name" id="options"><span class="type-signature">(non-null) </span>options<span class="type-signature"> :Object.&lt;string, *></span></h4>
  252. <div class="description">
  253. <p>Options.</p>
  254. </div>
  255. <h5>Type:</h5>
  256. <ul>
  257. <li>
  258. <span class="param-type">Object.&lt;string, *></span>
  259. </li>
  260. </ul>
  261. <dl class="details">
  262. <dt class="inherited-from">Inherited From:</dt>
  263. <dd class="inherited-from"><ul class="dummy"><li>
  264. <a href="ProtoBuf.Reflect.Namespace.html#options">ProtoBuf.Reflect.Namespace#options</a>
  265. </li></ul></dd>
  266. <dt class="tag-source">Source:</dt>
  267. <dd class="tag-source"><ul class="dummy"><li>
  268. <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1518">line 1518</a>
  269. </li></ul></dd>
  270. </dl>
  271. <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>
  272. <div class="description">
  273. <p>Parent object.</p>
  274. </div>
  275. <h5>Type:</h5>
  276. <ul>
  277. <li>
  278. <span class="param-type"><a href="ProtoBuf.Reflect.T.html">ProtoBuf.Reflect.T</a></span>
  279. </li>
  280. </ul>
  281. <dl class="details">
  282. <dt class="inherited-from">Inherited From:</dt>
  283. <dd class="inherited-from"><ul class="dummy"><li>
  284. <a href="ProtoBuf.Reflect.T.html#parent">ProtoBuf.Reflect.T#parent</a>
  285. </li></ul></dd>
  286. <dt class="tag-source">Source:</dt>
  287. <dd class="tag-source"><ul class="dummy"><li>
  288. <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1424">line 1424</a>
  289. </li></ul></dd>
  290. </dl>
  291. <h4 class="name" id="syntax"><span class="type-signature">(non-null) </span>syntax<span class="type-signature"> :string</span></h4>
  292. <div class="description">
  293. <p>Syntax level (e.g., proto2 or proto3).</p>
  294. </div>
  295. <h5>Type:</h5>
  296. <ul>
  297. <li>
  298. <span class="param-type">string</span>
  299. </li>
  300. </ul>
  301. <dl class="details">
  302. <dt class="inherited-from">Inherited From:</dt>
  303. <dd class="inherited-from"><ul class="dummy"><li>
  304. <a href="ProtoBuf.Reflect.Namespace.html#syntax">ProtoBuf.Reflect.Namespace#syntax</a>
  305. </li></ul></dd>
  306. <dt class="tag-source">Source:</dt>
  307. <dd class="tag-source"><ul class="dummy"><li>
  308. <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1524">line 1524</a>
  309. </li></ul></dd>
  310. </dl>
  311. <h3 class="subsection-title">Methods</h3>
  312. <h4 class="name" id="addChild"><span class="type-signature"></span>addChild<span class="signature">(child)</span><span class="type-signature"></span></h4>
  313. <div class="description">
  314. <p>Adds a child to the namespace.</p>
  315. </div>
  316. <h5>Parameters:</h5>
  317. <table class="params">
  318. <thead>
  319. <tr>
  320. <th>Name</th>
  321. <th>Type</th>
  322. <th class="last">Description</th>
  323. </tr>
  324. </thead>
  325. <tbody>
  326. <tr>
  327. <td class="name"><code>child</code></td>
  328. <td class="type">
  329. <span class="param-type"><a href="ProtoBuf.Reflect.T.html">ProtoBuf.Reflect.T</a></span>
  330. </td>
  331. <td class="description last"><p>Child</p></td>
  332. </tr>
  333. </tbody>
  334. </table>
  335. <dl class="details">
  336. <dt class="inherited-from">Inherited From:</dt>
  337. <dd class="inherited-from"><ul class="dummy"><li>
  338. <a href="ProtoBuf.Reflect.Namespace.html#addChild">ProtoBuf.Reflect.Namespace#addChild</a>
  339. </li></ul></dd>
  340. <dt class="tag-source">Source:</dt>
  341. <dd class="tag-source"><ul class="dummy"><li>
  342. <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1556">line 1556</a>
  343. </li></ul></dd>
  344. </dl>
  345. <h5>Throws:</h5>
  346. <dl>
  347. <dt>
  348. <div class="param-desc">
  349. <p>If the child cannot be added (duplicate)</p>
  350. </div>
  351. </dt>
  352. <dd></dd>
  353. <dt>
  354. <dl>
  355. <dt>
  356. Type
  357. </dt>
  358. <dd>
  359. <span class="param-type">Error</span>
  360. </dd>
  361. </dl>
  362. </dt>
  363. <dd></dd>
  364. </dl>
  365. <h4 class="name" id="build"><span class="type-signature"></span>build<span class="signature">(rebuild<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {<a href="ProtoBuf.Reflect.Message.html">ProtoBuf.Reflect.Message</a>}</span></h4>
  366. <div class="description">
  367. <p>Builds the message and returns the runtime counterpart, which is a fully functional class.</p>
  368. </div>
  369. <h5>Parameters:</h5>
  370. <table class="params">
  371. <thead>
  372. <tr>
  373. <th>Name</th>
  374. <th>Type</th>
  375. <th>Attributes</th>
  376. <th class="last">Description</th>
  377. </tr>
  378. </thead>
  379. <tbody>
  380. <tr>
  381. <td class="name"><code>rebuild</code></td>
  382. <td class="type">
  383. <span class="param-type">boolean</span>
  384. </td>
  385. <td class="attributes">
  386. &lt;optional><br>
  387. </td>
  388. <td class="description last"><p>Whether to rebuild or not, defaults to false</p></td>
  389. </tr>
  390. </tbody>
  391. </table>
  392. <dl class="details">
  393. <dt class="tag-overrides">Overrides:</dt>
  394. <dd class="tag-overrides"><ul class="dummy"><li>
  395. <a href="ProtoBuf.Reflect.Namespace.html#build">ProtoBuf.Reflect.Namespace#build</a>
  396. </li></ul></dd>
  397. <dt class="tag-source">Source:</dt>
  398. <dd class="tag-source"><ul class="dummy"><li>
  399. <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line2365">line 2365</a>
  400. </li></ul></dd>
  401. <dt class="tag-see">See:</dt>
  402. <dd class="tag-see">
  403. <ul>
  404. <li><a href="ProtoBuf.Builder.Message.html">ProtoBuf.Builder.Message</a></li>
  405. </ul>
  406. </dd>
  407. </dl>
  408. <h5>Throws:</h5>
  409. <dl>
  410. <dt>
  411. <div class="param-desc">
  412. <p>If the message cannot be built</p>
  413. </div>
  414. </dt>
  415. <dd></dd>
  416. <dt>
  417. <dl>
  418. <dt>
  419. Type
  420. </dt>
  421. <dd>
  422. <span class="param-type">Error</span>
  423. </dd>
  424. </dl>
  425. </dt>
  426. <dd></dd>
  427. </dl>
  428. <h5>Returns:</h5>
  429. <div class="param-desc">
  430. <p>Message class</p>
  431. </div>
  432. <dl>
  433. <dt>
  434. Type
  435. </dt>
  436. <dd>
  437. <span class="param-type"><a href="ProtoBuf.Reflect.Message.html">ProtoBuf.Reflect.Message</a></span>
  438. </dd>
  439. </dl>
  440. <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>
  441. <div class="description">
  442. <p>Builds the namespace's '$options' property.</p>
  443. </div>
  444. <dl class="details">
  445. <dt class="inherited-from">Inherited From:</dt>
  446. <dd class="inherited-from"><ul class="dummy"><li>
  447. <a href="ProtoBuf.Reflect.Namespace.html#buildOpt">ProtoBuf.Reflect.Namespace#buildOpt</a>
  448. </li></ul></dd>
  449. <dt class="tag-source">Source:</dt>
  450. <dd class="tag-source"><ul class="dummy"><li>
  451. <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1666">line 1666</a>
  452. </li></ul></dd>
  453. </dl>
  454. <h5>Returns:</h5>
  455. <dl>
  456. <dt>
  457. Type
  458. </dt>
  459. <dd>
  460. <span class="param-type">Object.&lt;string, *></span>
  461. </dd>
  462. </dl>
  463. <h4 class="name" id="calculate"><span class="type-signature"></span>calculate<span class="signature">(message<span class="signature-attributes">non-null</span>)</span><span class="type-signature"> &rarr; {number}</span></h4>
  464. <div class="description">
  465. <p>Calculates a runtime message's byte length.</p>
  466. </div>
  467. <h5>Parameters:</h5>
  468. <table class="params">
  469. <thead>
  470. <tr>
  471. <th>Name</th>
  472. <th>Type</th>
  473. <th class="last">Description</th>
  474. </tr>
  475. </thead>
  476. <tbody>
  477. <tr>
  478. <td class="name"><code>message</code></td>
  479. <td class="type">
  480. <span class="param-type"><a href="ProtoBuf.Builder.Message.html">ProtoBuf.Builder.Message</a></span>
  481. </td>
  482. <td class="description last"><p>Runtime message to encode</p></td>
  483. </tr>
  484. </tbody>
  485. </table>
  486. <dl class="details">
  487. <dt class="tag-source">Source:</dt>
  488. <dd class="tag-source"><ul class="dummy"><li>
  489. <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line3156">line 3156</a>
  490. </li></ul></dd>
  491. </dl>
  492. <h5>Throws:</h5>
  493. <dl>
  494. <dt>
  495. <div class="param-desc">
  496. <p>If required fields are missing or the message cannot be calculated for another reason</p>
  497. </div>
  498. </dt>
  499. <dd></dd>
  500. <dt>
  501. <dl>
  502. <dt>
  503. Type
  504. </dt>
  505. <dd>
  506. <span class="param-type">Error</span>
  507. </dd>
  508. </dl>
  509. </dt>
  510. <dd></dd>
  511. </dl>
  512. <h5>Returns:</h5>
  513. <div class="param-desc">
  514. <p>Byte length</p>
  515. </div>
  516. <dl>
  517. <dt>
  518. Type
  519. </dt>
  520. <dd>
  521. <span class="param-type">number</span>
  522. </dd>
  523. </dl>
  524. <h4 class="name" id="decode"><span class="type-signature"></span>decode<span class="signature">(buffer, length<span class="signature-attributes">opt</span>, expectedGroupEndId<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {<a href="ProtoBuf.Builder.Message.html">ProtoBuf.Builder.Message</a>}</span></h4>
  525. <div class="description">
  526. <p>Decodes an encoded message and returns the decoded message.</p>
  527. </div>
  528. <h5>Parameters:</h5>
  529. <table class="params">
  530. <thead>
  531. <tr>
  532. <th>Name</th>
  533. <th>Type</th>
  534. <th>Attributes</th>
  535. <th class="last">Description</th>
  536. </tr>
  537. </thead>
  538. <tbody>
  539. <tr>
  540. <td class="name"><code>buffer</code></td>
  541. <td class="type">
  542. <span class="param-type">ByteBuffer</span>
  543. </td>
  544. <td class="attributes">
  545. </td>
  546. <td class="description last"><p>ByteBuffer to decode from</p></td>
  547. </tr>
  548. <tr>
  549. <td class="name"><code>length</code></td>
  550. <td class="type">
  551. <span class="param-type">number</span>
  552. </td>
  553. <td class="attributes">
  554. &lt;optional><br>
  555. </td>
  556. <td class="description last"><p>Message length. Defaults to decode all remaining data.</p></td>
  557. </tr>
  558. <tr>
  559. <td class="name"><code>expectedGroupEndId</code></td>
  560. <td class="type">
  561. <span class="param-type">number</span>
  562. </td>
  563. <td class="attributes">
  564. &lt;optional><br>
  565. </td>
  566. <td class="description last"><p>Expected GROUPEND id if this is a legacy group</p></td>
  567. </tr>
  568. </tbody>
  569. </table>
  570. <dl class="details">
  571. <dt class="tag-source">Source:</dt>
  572. <dd class="tag-source"><ul class="dummy"><li>
  573. <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line3218">line 3218</a>
  574. </li></ul></dd>
  575. </dl>
  576. <h5>Throws:</h5>
  577. <dl>
  578. <dt>
  579. <div class="param-desc">
  580. <p>If the message cannot be decoded</p>
  581. </div>
  582. </dt>
  583. <dd></dd>
  584. <dt>
  585. <dl>
  586. <dt>
  587. Type
  588. </dt>
  589. <dd>
  590. <span class="param-type">Error</span>
  591. </dd>
  592. </dl>
  593. </dt>
  594. <dd></dd>
  595. </dl>
  596. <h5>Returns:</h5>
  597. <div class="param-desc">
  598. <p>Decoded message</p>
  599. </div>
  600. <dl>
  601. <dt>
  602. Type
  603. </dt>
  604. <dd>
  605. <span class="param-type"><a href="ProtoBuf.Builder.Message.html">ProtoBuf.Builder.Message</a></span>
  606. </dd>
  607. </dl>
  608. <h4 class="name" id="encode"><span class="type-signature"></span>encode<span class="signature">(message<span class="signature-attributes">non-null</span>, buffer, noVerify<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {ByteBuffer}</span></h4>
  609. <div class="description">
  610. <p>Encodes a runtime message's contents to the specified buffer.</p>
  611. </div>
  612. <h5>Parameters:</h5>
  613. <table class="params">
  614. <thead>
  615. <tr>
  616. <th>Name</th>
  617. <th>Type</th>
  618. <th>Attributes</th>
  619. <th class="last">Description</th>
  620. </tr>
  621. </thead>
  622. <tbody>
  623. <tr>
  624. <td class="name"><code>message</code></td>
  625. <td class="type">
  626. <span class="param-type"><a href="ProtoBuf.Builder.Message.html">ProtoBuf.Builder.Message</a></span>
  627. </td>
  628. <td class="attributes">
  629. </td>
  630. <td class="description last"><p>Runtime message to encode</p></td>
  631. </tr>
  632. <tr>
  633. <td class="name"><code>buffer</code></td>
  634. <td class="type">
  635. <span class="param-type">ByteBuffer</span>
  636. </td>
  637. <td class="attributes">
  638. </td>
  639. <td class="description last"><p>ByteBuffer to write to</p></td>
  640. </tr>
  641. <tr>
  642. <td class="name"><code>noVerify</code></td>
  643. <td class="type">
  644. <span class="param-type">boolean</span>
  645. </td>
  646. <td class="attributes">
  647. &lt;optional><br>
  648. </td>
  649. <td class="description last"><p>Whether to not verify field values, defaults to <code>false</code></p></td>
  650. </tr>
  651. </tbody>
  652. </table>
  653. <dl class="details">
  654. <dt class="tag-source">Source:</dt>
  655. <dd class="tag-source"><ul class="dummy"><li>
  656. <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line3129">line 3129</a>
  657. </li></ul></dd>
  658. </dl>
  659. <h5>Throws:</h5>
  660. <dl>
  661. <dt>
  662. <div class="param-desc">
  663. <p>If required fields are missing or the message cannot be encoded for another reason</p>
  664. </div>
  665. </dt>
  666. <dd></dd>
  667. <dt>
  668. <dl>
  669. <dt>
  670. Type
  671. </dt>
  672. <dd>
  673. <span class="param-type">Error</span>
  674. </dd>
  675. </dl>
  676. </dt>
  677. <dd></dd>
  678. </dl>
  679. <h5>Returns:</h5>
  680. <div class="param-desc">
  681. <p>The ByteBuffer for chaining</p>
  682. </div>
  683. <dl>
  684. <dt>
  685. Type
  686. </dt>
  687. <dd>
  688. <span class="param-type">ByteBuffer</span>
  689. </dd>
  690. </dl>
  691. <h4 class="name" id="fqn"><span class="type-signature"></span>fqn<span class="signature">()</span><span class="type-signature"> &rarr; {string}</span></h4>
  692. <div class="description">
  693. <p>Returns the fully qualified name of this object.</p>
  694. </div>
  695. <dl class="details">
  696. <dt class="inherited-from">Inherited From:</dt>
  697. <dd class="inherited-from"><ul class="dummy"><li>
  698. <a href="ProtoBuf.Reflect.T.html#fqn">ProtoBuf.Reflect.T#fqn</a>
  699. </li></ul></dd>
  700. <dt class="tag-source">Source:</dt>
  701. <dd class="tag-source"><ul class="dummy"><li>
  702. <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1452">line 1452</a>
  703. </li></ul></dd>
  704. </dl>
  705. <h5>Returns:</h5>
  706. <div class="param-desc">
  707. <p>Fully qualified name as of &quot;.PATH.TO.THIS&quot;</p>
  708. </div>
  709. <dl>
  710. <dt>
  711. Type
  712. </dt>
  713. <dd>
  714. <span class="param-type">string</span>
  715. </dd>
  716. </dl>
  717. <h4 class="name" id="getChild"><span class="type-signature"></span>getChild<span class="signature">(nameOrId)</span><span class="type-signature"> &rarr; (nullable) {<a href="ProtoBuf.Reflect.T.html">ProtoBuf.Reflect.T</a>}</span></h4>
  718. <div class="description">
  719. <p>Gets a child by its name or id.</p>
  720. </div>
  721. <h5>Parameters:</h5>
  722. <table class="params">
  723. <thead>
  724. <tr>
  725. <th>Name</th>
  726. <th>Type</th>
  727. <th class="last">Description</th>
  728. </tr>
  729. </thead>
  730. <tbody>
  731. <tr>
  732. <td class="name"><code>nameOrId</code></td>
  733. <td class="type">
  734. <span class="param-type">string</span>
  735. |
  736. <span class="param-type">number</span>
  737. </td>
  738. <td class="description last"><p>Child name or id</p></td>
  739. </tr>
  740. </tbody>
  741. </table>
  742. <dl class="details">
  743. <dt class="inherited-from">Inherited From:</dt>
  744. <dd class="inherited-from"><ul class="dummy"><li>
  745. <a href="ProtoBuf.Reflect.Namespace.html#getChild">ProtoBuf.Reflect.Namespace#getChild</a>
  746. </li></ul></dd>
  747. <dt class="tag-source">Source:</dt>
  748. <dd class="tag-source"><ul class="dummy"><li>
  749. <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1576">line 1576</a>
  750. </li></ul></dd>
  751. </dl>
  752. <h5>Returns:</h5>
  753. <div class="param-desc">
  754. <p>The child or null if not found</p>
  755. </div>
  756. <dl>
  757. <dt>
  758. Type
  759. </dt>
  760. <dd>
  761. <span class="param-type"><a href="ProtoBuf.Reflect.T.html">ProtoBuf.Reflect.T</a></span>
  762. </dd>
  763. </dl>
  764. <h4 class="name" id="getChildren"><span class="type-signature"></span>getChildren<span class="signature">(type<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Array.&lt;<a href="ProtoBuf.Reflect.T.html">ProtoBuf.Reflect.T</a>>}</span></h4>
  765. <div class="description">
  766. <p>Returns an array of the namespace's children.</p>
  767. </div>
  768. <h5>Parameters:</h5>
  769. <table class="params">
  770. <thead>
  771. <tr>
  772. <th>Name</th>
  773. <th>Type</th>
  774. <th>Attributes</th>
  775. <th class="last">Description</th>
  776. </tr>
  777. </thead>
  778. <tbody>
  779. <tr>
  780. <td class="name"><code>type</code></td>
  781. <td class="type">
  782. <span class="param-type"><a href="ProtoBuf.Reflect.T.html">ProtoBuf.Reflect.T</a></span>
  783. </td>
  784. <td class="attributes">
  785. &lt;optional><br>
  786. </td>
  787. <td class="description last"><p>Filter type (returns instances of this type only). Defaults to null (all children).</p></td>
  788. </tr>
  789. </tbody>
  790. </table>
  791. <dl class="details">
  792. <dt class="inherited-from">Inherited From:</dt>
  793. <dd class="inherited-from"><ul class="dummy"><li>
  794. <a href="ProtoBuf.Reflect.Namespace.html#getChildren">ProtoBuf.Reflect.Namespace#getChildren</a>
  795. </li></ul></dd>
  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#line1539">line 1539</a>
  799. </li></ul></dd>
  800. </dl>
  801. <h5>Returns:</h5>
  802. <dl>
  803. <dt>
  804. Type
  805. </dt>
  806. <dd>
  807. <span class="param-type">Array.&lt;<a href="ProtoBuf.Reflect.T.html">ProtoBuf.Reflect.T</a>></span>
  808. </dd>
  809. </dl>
  810. <h4 class="name" id="getOption"><span class="type-signature"></span>getOption<span class="signature">(name<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {*|Object.&lt;string, *>}</span></h4>
  811. <div class="description">
  812. <p>Gets the value assigned to the option with the specified name.</p>
  813. </div>
  814. <h5>Parameters:</h5>
  815. <table class="params">
  816. <thead>
  817. <tr>
  818. <th>Name</th>
  819. <th>Type</th>
  820. <th>Attributes</th>
  821. <th class="last">Description</th>
  822. </tr>
  823. </thead>
  824. <tbody>
  825. <tr>
  826. <td class="name"><code>name</code></td>
  827. <td class="type">
  828. <span class="param-type">string</span>
  829. </td>
  830. <td class="attributes">
  831. &lt;optional><br>
  832. </td>
  833. <td class="description last"><p>Returns the option value if specified, otherwise all options are returned.</p></td>
  834. </tr>
  835. </tbody>
  836. </table>
  837. <dl class="details">
  838. <dt class="inherited-from">Inherited From:</dt>
  839. <dd class="inherited-from"><ul class="dummy"><li>
  840. <a href="ProtoBuf.Reflect.Namespace.html#getOption">ProtoBuf.Reflect.Namespace#getOption</a>
  841. </li></ul></dd>
  842. <dt class="tag-source">Source:</dt>
  843. <dd class="tag-source"><ul class="dummy"><li>
  844. <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1687">line 1687</a>
  845. </li></ul></dd>
  846. </dl>
  847. <h5>Returns:</h5>
  848. <div class="param-desc">
  849. <p>null} Option value or NULL if there is no such option</p>
  850. </div>
  851. <dl>
  852. <dt>
  853. Type
  854. </dt>
  855. <dd>
  856. <span class="param-type">*</span>
  857. |
  858. <span class="param-type">Object.&lt;string, *></span>
  859. </dd>
  860. </dl>
  861. <h4 class="name" id="qn"><span class="type-signature"></span>qn<span class="signature">(t<span class="signature-attributes">non-null</span>)</span><span class="type-signature"> &rarr; {string}</span></h4>
  862. <div class="description">
  863. <p>Determines the shortest qualified name of the specified type, if any, relative to this namespace.</p>
  864. </div>
  865. <h5>Parameters:</h5>
  866. <table class="params">
  867. <thead>
  868. <tr>
  869. <th>Name</th>
  870. <th>Type</th>
  871. <th class="last">Description</th>
  872. </tr>
  873. </thead>
  874. <tbody>
  875. <tr>
  876. <td class="name"><code>t</code></td>
  877. <td class="type">
  878. <span class="param-type"><a href="ProtoBuf.Reflect.T.html">ProtoBuf.Reflect.T</a></span>
  879. </td>
  880. <td class="description last"><p>Reflection type</p></td>
  881. </tr>
  882. </tbody>
  883. </table>
  884. <dl class="details">
  885. <dt class="inherited-from">Inherited From:</dt>
  886. <dd class="inherited-from"><ul class="dummy"><li>
  887. <a href="ProtoBuf.Reflect.Namespace.html#qn">ProtoBuf.Reflect.Namespace#qn</a>
  888. </li></ul></dd>
  889. <dt class="tag-source">Source:</dt>
  890. <dd class="tag-source"><ul class="dummy"><li>
  891. <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1629">line 1629</a>
  892. </li></ul></dd>
  893. </dl>
  894. <h5>Returns:</h5>
  895. <div class="param-desc">
  896. <p>The shortest qualified name or, if there is none, the fqn</p>
  897. </div>
  898. <dl>
  899. <dt>
  900. Type
  901. </dt>
  902. <dd>
  903. <span class="param-type">string</span>
  904. </dd>
  905. </dl>
  906. <h4 class="name" id="resolve"><span class="type-signature"></span>resolve<span class="signature">(qn, excludeNonNamespace<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; (nullable) {<a href="ProtoBuf.Reflect.Namespace.html">ProtoBuf.Reflect.Namespace</a>}</span></h4>
  907. <div class="description">
  908. <p>Resolves a reflect object inside of this namespace.</p>
  909. </div>
  910. <h5>Parameters:</h5>
  911. <table class="params">
  912. <thead>
  913. <tr>
  914. <th>Name</th>
  915. <th>Type</th>
  916. <th>Attributes</th>
  917. <th class="last">Description</th>
  918. </tr>
  919. </thead>
  920. <tbody>
  921. <tr>
  922. <td class="name"><code>qn</code></td>
  923. <td class="type">
  924. <span class="param-type">string</span>
  925. |
  926. <span class="param-type">!Array.&lt;string></span>
  927. </td>
  928. <td class="attributes">
  929. </td>
  930. <td class="description last"><p>Qualified name to resolve</p></td>
  931. </tr>
  932. <tr>
  933. <td class="name"><code>excludeNonNamespace</code></td>
  934. <td class="type">
  935. <span class="param-type">boolean</span>
  936. </td>
  937. <td class="attributes">
  938. &lt;optional><br>
  939. </td>
  940. <td class="description last"><p>Excludes non-namespace types, defaults to <code>false</code></p></td>
  941. </tr>
  942. </tbody>
  943. </table>
  944. <dl class="details">
  945. <dt class="inherited-from">Inherited From:</dt>
  946. <dd class="inherited-from"><ul class="dummy"><li>
  947. <a href="ProtoBuf.Reflect.Namespace.html#resolve">ProtoBuf.Reflect.Namespace#resolve</a>
  948. </li></ul></dd>
  949. <dt class="tag-source">Source:</dt>
  950. <dd class="tag-source"><ul class="dummy"><li>
  951. <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1591">line 1591</a>
  952. </li></ul></dd>
  953. </dl>
  954. <h5>Returns:</h5>
  955. <div class="param-desc">
  956. <p>The resolved type or null if not found</p>
  957. </div>
  958. <dl>
  959. <dt>
  960. Type
  961. </dt>
  962. <dd>
  963. <span class="param-type"><a href="ProtoBuf.Reflect.Namespace.html">ProtoBuf.Reflect.Namespace</a></span>
  964. </dd>
  965. </dl>
  966. <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>
  967. <div class="description">
  968. <p>Returns a string representation of this Reflect object (its fully qualified name).</p>
  969. </div>
  970. <h5>Parameters:</h5>
  971. <table class="params">
  972. <thead>
  973. <tr>
  974. <th>Name</th>
  975. <th>Type</th>
  976. <th>Attributes</th>
  977. <th class="last">Description</th>
  978. </tr>
  979. </thead>
  980. <tbody>
  981. <tr>
  982. <td class="name"><code>includeClass</code></td>
  983. <td class="type">
  984. <span class="param-type">boolean</span>
  985. </td>
  986. <td class="attributes">
  987. &lt;optional><br>
  988. </td>
  989. <td class="description last"><p>Set to true to include the class name. Defaults to false.</p></td>
  990. </tr>
  991. </tbody>
  992. </table>
  993. <dl class="details">
  994. <dt class="inherited-from">Inherited From:</dt>
  995. <dd class="inherited-from"><ul class="dummy"><li>
  996. <a href="ProtoBuf.Reflect.T.html#toString">ProtoBuf.Reflect.T#toString</a>
  997. </li></ul></dd>
  998. <dt class="tag-source">Source:</dt>
  999. <dd class="tag-source"><ul class="dummy"><li>
  1000. <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1470">line 1470</a>
  1001. </li></ul></dd>
  1002. </dl>
  1003. <h5>Returns:</h5>
  1004. <div class="param-desc">
  1005. <p>String representation</p>
  1006. </div>
  1007. </article>
  1008. </section>
  1009. </div>
  1010. <nav>
  1011. <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>
  1012. </nav>
  1013. <br class="clear">
  1014. <footer>
  1015. 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)
  1016. </footer>
  1017. <script> prettyPrint(); </script>
  1018. <script src="scripts/linenumber.js"> </script>
  1019. </body>
  1020. </html>