ProtoBuf.Reflect.Message.ExtensionField.html 44 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>JSDoc: Class: ExtensionField</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: ExtensionField</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. ExtensionField
  22. </h2>
  23. </header>
  24. <article>
  25. <div class="container-overview">
  26. <h4 class="name" id="ExtensionField"><span class="type-signature"></span>new ExtensionField<span class="signature">(builder<span class="signature-attributes">non-null</span>, message<span class="signature-attributes">non-null</span>, rule, type, name, id, options<span class="signature-attributes">opt, non-null</span>)</span><span class="type-signature"></span></h4>
  27. <div class="description">
  28. <p>Constructs a new Message ExtensionField.</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>message</code></td>
  52. <td class="type">
  53. <span class="param-type"><a href="ProtoBuf.Reflect.Message.html">ProtoBuf.Reflect.Message</a></span>
  54. </td>
  55. <td class="attributes">
  56. </td>
  57. <td class="description last"><p>Message reference</p></td>
  58. </tr>
  59. <tr>
  60. <td class="name"><code>rule</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>Rule, one of requried, optional, repeated</p></td>
  67. </tr>
  68. <tr>
  69. <td class="name"><code>type</code></td>
  70. <td class="type">
  71. <span class="param-type">string</span>
  72. </td>
  73. <td class="attributes">
  74. </td>
  75. <td class="description last"><p>Data type, e.g. int32</p></td>
  76. </tr>
  77. <tr>
  78. <td class="name"><code>name</code></td>
  79. <td class="type">
  80. <span class="param-type">string</span>
  81. </td>
  82. <td class="attributes">
  83. </td>
  84. <td class="description last"><p>Field name</p></td>
  85. </tr>
  86. <tr>
  87. <td class="name"><code>id</code></td>
  88. <td class="type">
  89. <span class="param-type">number</span>
  90. </td>
  91. <td class="attributes">
  92. </td>
  93. <td class="description last"><p>Unique field id</p></td>
  94. </tr>
  95. <tr>
  96. <td class="name"><code>options</code></td>
  97. <td class="type">
  98. <span class="param-type">Object.&lt;string, *></span>
  99. </td>
  100. <td class="attributes">
  101. &lt;optional><br>
  102. </td>
  103. <td class="description last"><p>Options</p></td>
  104. </tr>
  105. </tbody>
  106. </table>
  107. <dl class="details">
  108. <dt class="tag-source">Source:</dt>
  109. <dd class="tag-source"><ul class="dummy"><li>
  110. <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line3774">line 3774</a>
  111. </li></ul></dd>
  112. </dl>
  113. </div>
  114. <h3 class="subsection-title">Extends</h3>
  115. <ul>
  116. <li><a href="ProtoBuf.Reflect.Message.Field.html">ProtoBuf.Reflect.Message.Field</a></li>
  117. </ul>
  118. <h3 class="subsection-title">Members</h3>
  119. <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>
  120. <div class="description">
  121. <p>Builder reference.</p>
  122. </div>
  123. <h5>Type:</h5>
  124. <ul>
  125. <li>
  126. <span class="param-type"><a href="ProtoBuf.Builder.html">ProtoBuf.Builder</a></span>
  127. </li>
  128. </ul>
  129. <dl class="details">
  130. <dt class="inherited-from">Inherited From:</dt>
  131. <dd class="inherited-from"><ul class="dummy"><li>
  132. <a href="ProtoBuf.Reflect.T.html#builder">ProtoBuf.Reflect.T#builder</a>
  133. </li></ul></dd>
  134. <dt class="tag-source">Source:</dt>
  135. <dd class="tag-source"><ul class="dummy"><li>
  136. <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1417">line 1417</a>
  137. </li></ul></dd>
  138. </dl>
  139. <h4 class="name" id="className"><span class="type-signature"></span>className<span class="type-signature"> :string</span></h4>
  140. <div class="description">
  141. <p>Fully qualified class name</p>
  142. </div>
  143. <h5>Type:</h5>
  144. <ul>
  145. <li>
  146. <span class="param-type">string</span>
  147. </li>
  148. </ul>
  149. <dl class="details">
  150. <dt class="inherited-from">Inherited From:</dt>
  151. <dd class="inherited-from"><ul class="dummy"><li>
  152. <a href="ProtoBuf.Reflect.T.html#className">ProtoBuf.Reflect.T#className</a>
  153. </li></ul></dd>
  154. <dt class="tag-source">Source:</dt>
  155. <dd class="tag-source"><ul class="dummy"><li>
  156. <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1438">line 1438</a>
  157. </li></ul></dd>
  158. </dl>
  159. <h4 class="name" id="defaultValue"><span class="type-signature"></span>defaultValue<span class="type-signature"> :*</span></h4>
  160. <div class="description">
  161. <p>Default value.</p>
  162. </div>
  163. <h5>Type:</h5>
  164. <ul>
  165. <li>
  166. <span class="param-type">*</span>
  167. </li>
  168. </ul>
  169. <dl class="details">
  170. <dt class="inherited-from">Inherited From:</dt>
  171. <dd class="inherited-from"><ul class="dummy"><li>
  172. <a href="ProtoBuf.Reflect.Message.Field.html#defaultValue">ProtoBuf.Reflect.Message.Field#defaultValue</a>
  173. </li></ul></dd>
  174. <dt class="tag-source">Source:</dt>
  175. <dd class="tag-source"><ul class="dummy"><li>
  176. <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line3384">line 3384</a>
  177. </li></ul></dd>
  178. </dl>
  179. <h4 class="name" id="element"><span class="type-signature"></span>element<span class="type-signature"> :ProtoBuf.Element</span></h4>
  180. <div class="description">
  181. <p>Element implementation. Created in build() after types are resolved.</p>
  182. </div>
  183. <h5>Type:</h5>
  184. <ul>
  185. <li>
  186. <span class="param-type">ProtoBuf.Element</span>
  187. </li>
  188. </ul>
  189. <dl class="details">
  190. <dt class="inherited-from">Inherited From:</dt>
  191. <dd class="inherited-from"><ul class="dummy"><li>
  192. <a href="ProtoBuf.Reflect.Message.Field.html#element">ProtoBuf.Reflect.Message.Field#element</a>
  193. </li></ul></dd>
  194. <dt class="tag-source">Source:</dt>
  195. <dd class="tag-source"><ul class="dummy"><li>
  196. <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line3412">line 3412</a>
  197. </li></ul></dd>
  198. </dl>
  199. <h4 class="name" id="extension"><span class="type-signature">(non-null) </span>extension<span class="type-signature"> :<a href="ProtoBuf.Reflect.Extension.html">ProtoBuf.Reflect.Extension</a></span></h4>
  200. <div class="description">
  201. <p>Extension reference.</p>
  202. </div>
  203. <h5>Type:</h5>
  204. <ul>
  205. <li>
  206. <span class="param-type"><a href="ProtoBuf.Reflect.Extension.html">ProtoBuf.Reflect.Extension</a></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#line3782">line 3782</a>
  213. </li></ul></dd>
  214. </dl>
  215. <h4 class="name" id="id"><span class="type-signature"></span>id<span class="type-signature"> :number</span></h4>
  216. <div class="description">
  217. <p>Unique message field id.</p>
  218. </div>
  219. <h5>Type:</h5>
  220. <ul>
  221. <li>
  222. <span class="param-type">number</span>
  223. </li>
  224. </ul>
  225. <dl class="details">
  226. <dt class="inherited-from">Inherited From:</dt>
  227. <dd class="inherited-from"><ul class="dummy"><li>
  228. <a href="ProtoBuf.Reflect.Message.Field.html#id">ProtoBuf.Reflect.Message.Field#id</a>
  229. </li></ul></dd>
  230. <dt class="tag-source">Source:</dt>
  231. <dd class="tag-source"><ul class="dummy"><li>
  232. <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line3369">line 3369</a>
  233. </li></ul></dd>
  234. </dl>
  235. <h4 class="name" id="keyElement"><span class="type-signature"></span>keyElement<span class="type-signature"> :ProtoBuf.Element</span></h4>
  236. <div class="description">
  237. <p>Key element implementation, for map fields. Created in build() after
  238. types are resolved.</p>
  239. </div>
  240. <h5>Type:</h5>
  241. <ul>
  242. <li>
  243. <span class="param-type">ProtoBuf.Element</span>
  244. </li>
  245. </ul>
  246. <dl class="details">
  247. <dt class="inherited-from">Inherited From:</dt>
  248. <dd class="inherited-from"><ul class="dummy"><li>
  249. <a href="ProtoBuf.Reflect.Message.Field.html#keyElement">ProtoBuf.Reflect.Message.Field#keyElement</a>
  250. </li></ul></dd>
  251. <dt class="tag-source">Source:</dt>
  252. <dd class="tag-source"><ul class="dummy"><li>
  253. <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line3420">line 3420</a>
  254. </li></ul></dd>
  255. </dl>
  256. <h4 class="name" id="keyType"><span class="type-signature"></span>keyType<span class="type-signature"> :string|Object|null</span></h4>
  257. <div class="description">
  258. <p>Message field key type. Type reference string if unresolved, protobuf
  259. type if resolved. Valid only if this.map === true, null otherwise.</p>
  260. </div>
  261. <h5>Type:</h5>
  262. <ul>
  263. <li>
  264. <span class="param-type">string</span>
  265. |
  266. <span class="param-type">Object</span>
  267. |
  268. <span class="param-type">null</span>
  269. </li>
  270. </ul>
  271. <dl class="details">
  272. <dt class="inherited-from">Inherited From:</dt>
  273. <dd class="inherited-from"><ul class="dummy"><li>
  274. <a href="ProtoBuf.Reflect.Message.Field.html#keyType">ProtoBuf.Reflect.Message.Field#keyType</a>
  275. </li></ul></dd>
  276. <dt class="tag-source">Source:</dt>
  277. <dd class="tag-source"><ul class="dummy"><li>
  278. <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line3347">line 3347</a>
  279. </li></ul></dd>
  280. </dl>
  281. <h4 class="name" id="map"><span class="type-signature"></span>map<span class="type-signature"> :boolean</span></h4>
  282. <div class="description">
  283. <p>Message field map flag.</p>
  284. </div>
  285. <h5>Type:</h5>
  286. <ul>
  287. <li>
  288. <span class="param-type">boolean</span>
  289. </li>
  290. </ul>
  291. <dl class="details">
  292. <dt class="inherited-from">Inherited From:</dt>
  293. <dd class="inherited-from"><ul class="dummy"><li>
  294. <a href="ProtoBuf.Reflect.Message.Field.html#map">ProtoBuf.Reflect.Message.Field#map</a>
  295. </li></ul></dd>
  296. <dt class="tag-source">Source:</dt>
  297. <dd class="tag-source"><ul class="dummy"><li>
  298. <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line3339">line 3339</a>
  299. </li></ul></dd>
  300. </dl>
  301. <h4 class="name" id="name"><span class="type-signature"></span>name<span class="type-signature"> :string</span></h4>
  302. <div class="description">
  303. <p>Object name in namespace.</p>
  304. </div>
  305. <h5>Type:</h5>
  306. <ul>
  307. <li>
  308. <span class="param-type">string</span>
  309. </li>
  310. </ul>
  311. <dl class="details">
  312. <dt class="inherited-from">Inherited From:</dt>
  313. <dd class="inherited-from"><ul class="dummy"><li>
  314. <a href="ProtoBuf.Reflect.T.html#name">ProtoBuf.Reflect.T#name</a>
  315. </li></ul></dd>
  316. <dt class="tag-source">Source:</dt>
  317. <dd class="tag-source"><ul class="dummy"><li>
  318. <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1431">line 1431</a>
  319. </li></ul></dd>
  320. </dl>
  321. <h4 class="name" id="oneof"><span class="type-signature">(nullable) </span>oneof<span class="type-signature"> :<a href="ProtoBuf.Reflect.Message.OneOf.html">ProtoBuf.Reflect.Message.OneOf</a></span></h4>
  322. <div class="description">
  323. <p>Enclosing OneOf.</p>
  324. </div>
  325. <h5>Type:</h5>
  326. <ul>
  327. <li>
  328. <span class="param-type"><a href="ProtoBuf.Reflect.Message.OneOf.html">ProtoBuf.Reflect.Message.OneOf</a></span>
  329. </li>
  330. </ul>
  331. <dl class="details">
  332. <dt class="inherited-from">Inherited From:</dt>
  333. <dd class="inherited-from"><ul class="dummy"><li>
  334. <a href="ProtoBuf.Reflect.Message.Field.html#oneof">ProtoBuf.Reflect.Message.Field#oneof</a>
  335. </li></ul></dd>
  336. <dt class="tag-source">Source:</dt>
  337. <dd class="tag-source"><ul class="dummy"><li>
  338. <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line3391">line 3391</a>
  339. </li></ul></dd>
  340. </dl>
  341. <h4 class="name" id="options"><span class="type-signature">(non-null) </span>options<span class="type-signature"> :Object.&lt;string, *></span></h4>
  342. <div class="description">
  343. <p>Message field options.</p>
  344. </div>
  345. <h5>Type:</h5>
  346. <ul>
  347. <li>
  348. <span class="param-type">Object.&lt;string, *></span>
  349. </li>
  350. </ul>
  351. <dl class="details">
  352. <dt class="inherited-from">Inherited From:</dt>
  353. <dd class="inherited-from"><ul class="dummy"><li>
  354. <a href="ProtoBuf.Reflect.Message.Field.html#options">ProtoBuf.Reflect.Message.Field#options</a>
  355. </li></ul></dd>
  356. <dt class="tag-source">Source:</dt>
  357. <dd class="tag-source"><ul class="dummy"><li>
  358. <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line3377">line 3377</a>
  359. </li></ul></dd>
  360. </dl>
  361. <h4 class="name" id="originalName"><span class="type-signature"></span>originalName<span class="type-signature"> :string</span></h4>
  362. <div class="description">
  363. <p>Original field name.</p>
  364. </div>
  365. <h5>Type:</h5>
  366. <ul>
  367. <li>
  368. <span class="param-type">string</span>
  369. </li>
  370. </ul>
  371. <dl class="details">
  372. <dt class="inherited-from">Inherited From:</dt>
  373. <dd class="inherited-from"><ul class="dummy"><li>
  374. <a href="ProtoBuf.Reflect.Message.Field.html#originalName">ProtoBuf.Reflect.Message.Field#originalName</a>
  375. </li></ul></dd>
  376. <dt class="tag-source">Source:</dt>
  377. <dd class="tag-source"><ul class="dummy"><li>
  378. <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line3405">line 3405</a>
  379. </li></ul></dd>
  380. </dl>
  381. <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>
  382. <div class="description">
  383. <p>Parent object.</p>
  384. </div>
  385. <h5>Type:</h5>
  386. <ul>
  387. <li>
  388. <span class="param-type"><a href="ProtoBuf.Reflect.T.html">ProtoBuf.Reflect.T</a></span>
  389. </li>
  390. </ul>
  391. <dl class="details">
  392. <dt class="inherited-from">Inherited From:</dt>
  393. <dd class="inherited-from"><ul class="dummy"><li>
  394. <a href="ProtoBuf.Reflect.T.html#parent">ProtoBuf.Reflect.T#parent</a>
  395. </li></ul></dd>
  396. <dt class="tag-source">Source:</dt>
  397. <dd class="tag-source"><ul class="dummy"><li>
  398. <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1424">line 1424</a>
  399. </li></ul></dd>
  400. </dl>
  401. <h4 class="name" id="repeated"><span class="type-signature"></span>repeated<span class="type-signature"> :boolean</span></h4>
  402. <div class="description">
  403. <p>Message field repeated flag.</p>
  404. </div>
  405. <h5>Type:</h5>
  406. <ul>
  407. <li>
  408. <span class="param-type">boolean</span>
  409. </li>
  410. </ul>
  411. <dl class="details">
  412. <dt class="inherited-from">Inherited From:</dt>
  413. <dd class="inherited-from"><ul class="dummy"><li>
  414. <a href="ProtoBuf.Reflect.Message.Field.html#repeated">ProtoBuf.Reflect.Message.Field#repeated</a>
  415. </li></ul></dd>
  416. <dt class="tag-source">Source:</dt>
  417. <dd class="tag-source"><ul class="dummy"><li>
  418. <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line3332">line 3332</a>
  419. </li></ul></dd>
  420. </dl>
  421. <h4 class="name" id="required"><span class="type-signature"></span>required<span class="type-signature"> :boolean</span></h4>
  422. <div class="description">
  423. <p>Message field required flag.</p>
  424. </div>
  425. <h5>Type:</h5>
  426. <ul>
  427. <li>
  428. <span class="param-type">boolean</span>
  429. </li>
  430. </ul>
  431. <dl class="details">
  432. <dt class="inherited-from">Inherited From:</dt>
  433. <dd class="inherited-from"><ul class="dummy"><li>
  434. <a href="ProtoBuf.Reflect.Message.Field.html#required">ProtoBuf.Reflect.Message.Field#required</a>
  435. </li></ul></dd>
  436. <dt class="tag-source">Source:</dt>
  437. <dd class="tag-source"><ul class="dummy"><li>
  438. <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line3325">line 3325</a>
  439. </li></ul></dd>
  440. </dl>
  441. <h4 class="name" id="resolvedType"><span class="type-signature"></span>resolvedType<span class="type-signature"> :<a href="ProtoBuf.Reflect.T.html">ProtoBuf.Reflect.T</a>|null</span></h4>
  442. <div class="description">
  443. <p>Resolved type reference inside the global namespace.</p>
  444. </div>
  445. <h5>Type:</h5>
  446. <ul>
  447. <li>
  448. <span class="param-type"><a href="ProtoBuf.Reflect.T.html">ProtoBuf.Reflect.T</a></span>
  449. |
  450. <span class="param-type">null</span>
  451. </li>
  452. </ul>
  453. <dl class="details">
  454. <dt class="inherited-from">Inherited From:</dt>
  455. <dd class="inherited-from"><ul class="dummy"><li>
  456. <a href="ProtoBuf.Reflect.Message.Field.html#resolvedType">ProtoBuf.Reflect.Message.Field#resolvedType</a>
  457. </li></ul></dd>
  458. <dt class="tag-source">Source:</dt>
  459. <dd class="tag-source"><ul class="dummy"><li>
  460. <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line3362">line 3362</a>
  461. </li></ul></dd>
  462. </dl>
  463. <h4 class="name" id="syntax"><span class="type-signature"></span>syntax<span class="type-signature"> :string</span></h4>
  464. <div class="description">
  465. <p>Syntax level of this definition (e.g., proto3).</p>
  466. </div>
  467. <h5>Type:</h5>
  468. <ul>
  469. <li>
  470. <span class="param-type">string</span>
  471. </li>
  472. </ul>
  473. <dl class="details">
  474. <dt class="inherited-from">Inherited From:</dt>
  475. <dd class="inherited-from"><ul class="dummy"><li>
  476. <a href="ProtoBuf.Reflect.Message.Field.html#syntax">ProtoBuf.Reflect.Message.Field#syntax</a>
  477. </li></ul></dd>
  478. <dt class="tag-source">Source:</dt>
  479. <dd class="tag-source"><ul class="dummy"><li>
  480. <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line3398">line 3398</a>
  481. </li></ul></dd>
  482. </dl>
  483. <h4 class="name" id="type"><span class="type-signature"></span>type<span class="type-signature"> :string|Object</span></h4>
  484. <div class="description">
  485. <p>Message field type. Type reference string if unresolved, protobuf type if
  486. resolved. In a map field, this is the value type.</p>
  487. </div>
  488. <h5>Type:</h5>
  489. <ul>
  490. <li>
  491. <span class="param-type">string</span>
  492. |
  493. <span class="param-type">Object</span>
  494. </li>
  495. </ul>
  496. <dl class="details">
  497. <dt class="inherited-from">Inherited From:</dt>
  498. <dd class="inherited-from"><ul class="dummy"><li>
  499. <a href="ProtoBuf.Reflect.Message.Field.html#type">ProtoBuf.Reflect.Message.Field#type</a>
  500. </li></ul></dd>
  501. <dt class="tag-source">Source:</dt>
  502. <dd class="tag-source"><ul class="dummy"><li>
  503. <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line3355">line 3355</a>
  504. </li></ul></dd>
  505. </dl>
  506. <h3 class="subsection-title">Methods</h3>
  507. <h4 class="name" id="build"><span class="type-signature"></span>build<span class="signature">()</span><span class="type-signature"></span></h4>
  508. <div class="description">
  509. <p>Builds this type.</p>
  510. </div>
  511. <dl class="details">
  512. <dt class="inherited-from">Inherited From:</dt>
  513. <dd class="inherited-from"><ul class="dummy"><li>
  514. <a href="ProtoBuf.Reflect.T.html#build">ProtoBuf.Reflect.T#build</a>
  515. </li></ul></dd>
  516. <dt class="tag-source">Source:</dt>
  517. <dd class="tag-source"><ul class="dummy"><li>
  518. <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1479">line 1479</a>
  519. </li></ul></dd>
  520. </dl>
  521. <h5>Throws:</h5>
  522. <dl>
  523. <dt>
  524. <div class="param-desc">
  525. <p>If this type cannot be built directly</p>
  526. </div>
  527. </dt>
  528. <dd></dd>
  529. <dt>
  530. <dl>
  531. <dt>
  532. Type
  533. </dt>
  534. <dd>
  535. <span class="param-type">Error</span>
  536. </dd>
  537. </dl>
  538. </dt>
  539. <dd></dd>
  540. </dl>
  541. <h4 class="name" id="calculate"><span class="type-signature"></span>calculate<span class="signature">(value, message<span class="signature-attributes">non-null</span>)</span><span class="type-signature"> &rarr; {number}</span></h4>
  542. <div class="description">
  543. <p>Calculates the length of this field's value on the network level.</p>
  544. </div>
  545. <h5>Parameters:</h5>
  546. <table class="params">
  547. <thead>
  548. <tr>
  549. <th>Name</th>
  550. <th>Type</th>
  551. <th class="last">Description</th>
  552. </tr>
  553. </thead>
  554. <tbody>
  555. <tr>
  556. <td class="name"><code>value</code></td>
  557. <td class="type">
  558. <span class="param-type">*</span>
  559. </td>
  560. <td class="description last"><p>Field value</p></td>
  561. </tr>
  562. <tr>
  563. <td class="name"><code>message</code></td>
  564. <td class="type">
  565. <span class="param-type"><a href="ProtoBuf.Builder.Message.html">ProtoBuf.Builder.Message</a></span>
  566. </td>
  567. <td class="description last"><p>Runtime message</p></td>
  568. </tr>
  569. </tbody>
  570. </table>
  571. <dl class="details">
  572. <dt class="inherited-from">Inherited From:</dt>
  573. <dd class="inherited-from"><ul class="dummy"><li>
  574. <a href="ProtoBuf.Reflect.Message.Field.html#calculate">ProtoBuf.Reflect.Message.Field#calculate</a>
  575. </li></ul></dd>
  576. <dt class="tag-source">Source:</dt>
  577. <dd class="tag-source"><ul class="dummy"><li>
  578. <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line3635">line 3635</a>
  579. </li></ul></dd>
  580. </dl>
  581. <h5>Returns:</h5>
  582. <div class="param-desc">
  583. <p>Byte length</p>
  584. </div>
  585. <dl>
  586. <dt>
  587. Type
  588. </dt>
  589. <dd>
  590. <span class="param-type">number</span>
  591. </dd>
  592. </dl>
  593. <h4 class="name" id="decode"><span class="type-signature"></span>decode<span class="signature">(wireType, buffer, skipRepeated<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {*}</span></h4>
  594. <div class="description">
  595. <p>Decode the field value from the specified buffer.</p>
  596. </div>
  597. <h5>Parameters:</h5>
  598. <table class="params">
  599. <thead>
  600. <tr>
  601. <th>Name</th>
  602. <th>Type</th>
  603. <th>Attributes</th>
  604. <th class="last">Description</th>
  605. </tr>
  606. </thead>
  607. <tbody>
  608. <tr>
  609. <td class="name"><code>wireType</code></td>
  610. <td class="type">
  611. <span class="param-type">number</span>
  612. </td>
  613. <td class="attributes">
  614. </td>
  615. <td class="description last"><p>Leading wire type</p></td>
  616. </tr>
  617. <tr>
  618. <td class="name"><code>buffer</code></td>
  619. <td class="type">
  620. <span class="param-type">ByteBuffer</span>
  621. </td>
  622. <td class="attributes">
  623. </td>
  624. <td class="description last"><p>ByteBuffer to decode from</p></td>
  625. </tr>
  626. <tr>
  627. <td class="name"><code>skipRepeated</code></td>
  628. <td class="type">
  629. <span class="param-type">boolean</span>
  630. </td>
  631. <td class="attributes">
  632. &lt;optional><br>
  633. </td>
  634. <td class="description last"><p>Whether to skip the repeated check or not. Defaults to false.</p></td>
  635. </tr>
  636. </tbody>
  637. </table>
  638. <dl class="details">
  639. <dt class="inherited-from">Inherited From:</dt>
  640. <dd class="inherited-from"><ul class="dummy"><li>
  641. <a href="ProtoBuf.Reflect.Message.Field.html#decode">ProtoBuf.Reflect.Message.Field#decode</a>
  642. </li></ul></dd>
  643. <dt class="tag-source">Source:</dt>
  644. <dd class="tag-source"><ul class="dummy"><li>
  645. <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line3693">line 3693</a>
  646. </li></ul></dd>
  647. </dl>
  648. <h5>Throws:</h5>
  649. <dl>
  650. <dt>
  651. <div class="param-desc">
  652. <p>If the field cannot be decoded</p>
  653. </div>
  654. </dt>
  655. <dd></dd>
  656. <dt>
  657. <dl>
  658. <dt>
  659. Type
  660. </dt>
  661. <dd>
  662. <span class="param-type">Error</span>
  663. </dd>
  664. </dl>
  665. </dt>
  666. <dd></dd>
  667. </dl>
  668. <h5>Returns:</h5>
  669. <div class="param-desc">
  670. <p>Decoded value: array for packed repeated fields, [key, value] for
  671. map fields, or an individual value otherwise.</p>
  672. </div>
  673. <dl>
  674. <dt>
  675. Type
  676. </dt>
  677. <dd>
  678. <span class="param-type">*</span>
  679. </dd>
  680. </dl>
  681. <h4 class="name" id="encode"><span class="type-signature"></span>encode<span class="signature">(value, buffer, message<span class="signature-attributes">non-null</span>)</span><span class="type-signature"> &rarr; {ByteBuffer}</span></h4>
  682. <div class="description">
  683. <p>Encodes the specified field value to the specified buffer.</p>
  684. </div>
  685. <h5>Parameters:</h5>
  686. <table class="params">
  687. <thead>
  688. <tr>
  689. <th>Name</th>
  690. <th>Type</th>
  691. <th class="last">Description</th>
  692. </tr>
  693. </thead>
  694. <tbody>
  695. <tr>
  696. <td class="name"><code>value</code></td>
  697. <td class="type">
  698. <span class="param-type">*</span>
  699. </td>
  700. <td class="description last"><p>Verified field value</p></td>
  701. </tr>
  702. <tr>
  703. <td class="name"><code>buffer</code></td>
  704. <td class="type">
  705. <span class="param-type">ByteBuffer</span>
  706. </td>
  707. <td class="description last"><p>ByteBuffer to encode to</p></td>
  708. </tr>
  709. <tr>
  710. <td class="name"><code>message</code></td>
  711. <td class="type">
  712. <span class="param-type"><a href="ProtoBuf.Builder.Message.html">ProtoBuf.Builder.Message</a></span>
  713. </td>
  714. <td class="description last"><p>Runtime message</p></td>
  715. </tr>
  716. </tbody>
  717. </table>
  718. <dl class="details">
  719. <dt class="inherited-from">Inherited From:</dt>
  720. <dd class="inherited-from"><ul class="dummy"><li>
  721. <a href="ProtoBuf.Reflect.Message.Field.html#encode">ProtoBuf.Reflect.Message.Field#encode</a>
  722. </li></ul></dd>
  723. <dt class="tag-source">Source:</dt>
  724. <dd class="tag-source"><ul class="dummy"><li>
  725. <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line3561">line 3561</a>
  726. </li></ul></dd>
  727. </dl>
  728. <h5>Throws:</h5>
  729. <dl>
  730. <dt>
  731. <div class="param-desc">
  732. <p>If the field cannot be encoded</p>
  733. </div>
  734. </dt>
  735. <dd></dd>
  736. <dt>
  737. <dl>
  738. <dt>
  739. Type
  740. </dt>
  741. <dd>
  742. <span class="param-type">Error</span>
  743. </dd>
  744. </dl>
  745. </dt>
  746. <dd></dd>
  747. </dl>
  748. <h5>Returns:</h5>
  749. <div class="param-desc">
  750. <p>The ByteBuffer for chaining</p>
  751. </div>
  752. <dl>
  753. <dt>
  754. Type
  755. </dt>
  756. <dd>
  757. <span class="param-type">ByteBuffer</span>
  758. </dd>
  759. </dl>
  760. <h4 class="name" id="fqn"><span class="type-signature"></span>fqn<span class="signature">()</span><span class="type-signature"> &rarr; {string}</span></h4>
  761. <div class="description">
  762. <p>Returns the fully qualified name of this object.</p>
  763. </div>
  764. <dl class="details">
  765. <dt class="inherited-from">Inherited From:</dt>
  766. <dd class="inherited-from"><ul class="dummy"><li>
  767. <a href="ProtoBuf.Reflect.T.html#fqn">ProtoBuf.Reflect.T#fqn</a>
  768. </li></ul></dd>
  769. <dt class="tag-source">Source:</dt>
  770. <dd class="tag-source"><ul class="dummy"><li>
  771. <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1452">line 1452</a>
  772. </li></ul></dd>
  773. </dl>
  774. <h5>Returns:</h5>
  775. <div class="param-desc">
  776. <p>Fully qualified name as of &quot;.PATH.TO.THIS&quot;</p>
  777. </div>
  778. <dl>
  779. <dt>
  780. Type
  781. </dt>
  782. <dd>
  783. <span class="param-type">string</span>
  784. </dd>
  785. </dl>
  786. <h4 class="name" id="hasWirePresence"><span class="type-signature"></span>hasWirePresence<span class="signature">(value, message<span class="signature-attributes">non-null</span>)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
  787. <div class="description">
  788. <p>Determines whether the field will have a presence on the wire given its
  789. value.</p>
  790. </div>
  791. <h5>Parameters:</h5>
  792. <table class="params">
  793. <thead>
  794. <tr>
  795. <th>Name</th>
  796. <th>Type</th>
  797. <th class="last">Description</th>
  798. </tr>
  799. </thead>
  800. <tbody>
  801. <tr>
  802. <td class="name"><code>value</code></td>
  803. <td class="type">
  804. <span class="param-type">*</span>
  805. </td>
  806. <td class="description last"><p>Verified field value</p></td>
  807. </tr>
  808. <tr>
  809. <td class="name"><code>message</code></td>
  810. <td class="type">
  811. <span class="param-type"><a href="ProtoBuf.Builder.Message.html">ProtoBuf.Builder.Message</a></span>
  812. </td>
  813. <td class="description last"><p>Runtime message</p></td>
  814. </tr>
  815. </tbody>
  816. </table>
  817. <dl class="details">
  818. <dt class="inherited-from">Inherited From:</dt>
  819. <dd class="inherited-from"><ul class="dummy"><li>
  820. <a href="ProtoBuf.Reflect.Message.Field.html#hasWirePresence">ProtoBuf.Reflect.Message.Field#hasWirePresence</a>
  821. </li></ul></dd>
  822. <dt class="tag-source">Source:</dt>
  823. <dd class="tag-source"><ul class="dummy"><li>
  824. <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line3509">line 3509</a>
  825. </li></ul></dd>
  826. </dl>
  827. <h5>Returns:</h5>
  828. <div class="param-desc">
  829. <p>Whether the field will be present on the wire</p>
  830. </div>
  831. <dl>
  832. <dt>
  833. Type
  834. </dt>
  835. <dd>
  836. <span class="param-type">boolean</span>
  837. </dd>
  838. </dl>
  839. <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>
  840. <div class="description">
  841. <p>Returns a string representation of this Reflect object (its fully qualified name).</p>
  842. </div>
  843. <h5>Parameters:</h5>
  844. <table class="params">
  845. <thead>
  846. <tr>
  847. <th>Name</th>
  848. <th>Type</th>
  849. <th>Attributes</th>
  850. <th class="last">Description</th>
  851. </tr>
  852. </thead>
  853. <tbody>
  854. <tr>
  855. <td class="name"><code>includeClass</code></td>
  856. <td class="type">
  857. <span class="param-type">boolean</span>
  858. </td>
  859. <td class="attributes">
  860. &lt;optional><br>
  861. </td>
  862. <td class="description last"><p>Set to true to include the class name. Defaults to false.</p></td>
  863. </tr>
  864. </tbody>
  865. </table>
  866. <dl class="details">
  867. <dt class="inherited-from">Inherited From:</dt>
  868. <dd class="inherited-from"><ul class="dummy"><li>
  869. <a href="ProtoBuf.Reflect.T.html#toString">ProtoBuf.Reflect.T#toString</a>
  870. </li></ul></dd>
  871. <dt class="tag-source">Source:</dt>
  872. <dd class="tag-source"><ul class="dummy"><li>
  873. <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1470">line 1470</a>
  874. </li></ul></dd>
  875. </dl>
  876. <h5>Returns:</h5>
  877. <div class="param-desc">
  878. <p>String representation</p>
  879. </div>
  880. <h4 class="name" id="verifyValue"><span class="type-signature"></span>verifyValue<span class="signature">(value, skipRepeated<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {*}</span></h4>
  881. <div class="description">
  882. <p>Checks if the given value can be set for this field.</p>
  883. </div>
  884. <h5>Parameters:</h5>
  885. <table class="params">
  886. <thead>
  887. <tr>
  888. <th>Name</th>
  889. <th>Type</th>
  890. <th>Attributes</th>
  891. <th class="last">Description</th>
  892. </tr>
  893. </thead>
  894. <tbody>
  895. <tr>
  896. <td class="name"><code>value</code></td>
  897. <td class="type">
  898. <span class="param-type">*</span>
  899. </td>
  900. <td class="attributes">
  901. </td>
  902. <td class="description last"><p>Value to check</p></td>
  903. </tr>
  904. <tr>
  905. <td class="name"><code>skipRepeated</code></td>
  906. <td class="type">
  907. <span class="param-type">boolean</span>
  908. </td>
  909. <td class="attributes">
  910. &lt;optional><br>
  911. </td>
  912. <td class="description last"><p>Whether to skip the repeated value check or not. Defaults to false.</p></td>
  913. </tr>
  914. </tbody>
  915. </table>
  916. <dl class="details">
  917. <dt class="inherited-from">Inherited From:</dt>
  918. <dd class="inherited-from"><ul class="dummy"><li>
  919. <a href="ProtoBuf.Reflect.Message.Field.html#verifyValue">ProtoBuf.Reflect.Message.Field#verifyValue</a>
  920. </li></ul></dd>
  921. <dt class="tag-source">Source:</dt>
  922. <dd class="tag-source"><ul class="dummy"><li>
  923. <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line3461">line 3461</a>
  924. </li></ul></dd>
  925. </dl>
  926. <h5>Throws:</h5>
  927. <dl>
  928. <dt>
  929. <div class="param-desc">
  930. <p>If the value cannot be set for this field</p>
  931. </div>
  932. </dt>
  933. <dd></dd>
  934. <dt>
  935. <dl>
  936. <dt>
  937. Type
  938. </dt>
  939. <dd>
  940. <span class="param-type">Error</span>
  941. </dd>
  942. </dl>
  943. </dt>
  944. <dd></dd>
  945. </dl>
  946. <h5>Returns:</h5>
  947. <div class="param-desc">
  948. <p>Verified, maybe adjusted, value</p>
  949. </div>
  950. <dl>
  951. <dt>
  952. Type
  953. </dt>
  954. <dd>
  955. <span class="param-type">*</span>
  956. </dd>
  957. </dl>
  958. </article>
  959. </section>
  960. </div>
  961. <nav>
  962. <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>
  963. </nav>
  964. <br class="clear">
  965. <footer>
  966. 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)
  967. </footer>
  968. <script> prettyPrint(); </script>
  969. <script src="scripts/linenumber.js"> </script>
  970. </body>
  971. </html>