a00626.html 28 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=11"/>
  6. <meta name="generator" content="Doxygen 1.9.7"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>Zibra Effects: ServerAuthManager Class Reference</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js.txt"></script>
  11. <script type="text/javascript" src="dynsections.js.txt"></script>
  12. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  13. <script type="text/javascript" src="search/searchdata.js.txt"></script>
  14. <script type="text/javascript" src="search/search.js.txt"></script>
  15. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  16. </head>
  17. <body>
  18. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  19. <div id="titlearea">
  20. <table cellspacing="0" cellpadding="0">
  21. <tbody>
  22. <tr id="projectrow">
  23. <td id="projectalign">
  24. <div id="projectname">Zibra Effects
  25. </div>
  26. <div id="projectbrief">Real-time Simulated Visual Effects</div>
  27. </td>
  28. </tr>
  29. </tbody>
  30. </table>
  31. </div>
  32. <!-- end header part -->
  33. <!-- Generated by Doxygen 1.9.7 -->
  34. <script type="text/javascript">
  35. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  36. var searchBox = new SearchBox("searchBox", "search/",'.html');
  37. /* @license-end */
  38. </script>
  39. <script type="text/javascript" src="menudata.js.txt"></script>
  40. <script type="text/javascript" src="menu.js.txt"></script>
  41. <script type="text/javascript">
  42. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  43. $(function() {
  44. initMenu('',true,false,'search.php','Search');
  45. $(document).ready(function() { init_search(); });
  46. });
  47. /* @license-end */
  48. </script>
  49. <div id="main-nav"></div>
  50. <!-- window showing the filter options -->
  51. <div id="MSearchSelectWindow"
  52. onmouseover="return searchBox.OnSearchSelectShow()"
  53. onmouseout="return searchBox.OnSearchSelectHide()"
  54. onkeydown="return searchBox.OnSearchSelectKey(event)">
  55. </div>
  56. <!-- iframe showing the search results (closed by default) -->
  57. <div id="MSearchResultsWindow">
  58. <div id="MSearchResults">
  59. <div class="SRPage">
  60. <div id="SRIndex">
  61. <div id="SRResults"></div>
  62. <div class="SRStatus" id="Loading">Loading...</div>
  63. <div class="SRStatus" id="Searching">Searching...</div>
  64. <div class="SRStatus" id="NoMatches">No Matches</div>
  65. </div>
  66. </div>
  67. </div>
  68. </div>
  69. <div id="nav-path" class="navpath">
  70. <ul>
  71. <li class="navelem"><a class="el" href="a00335.html">com</a></li><li class="navelem"><a class="el" href="a00336.html">zibra</a></li><li class="navelem"><a class="el" href="a00337.html">common</a></li><li class="navelem"><a class="el" href="a00340.html">Editor</a></li><li class="navelem"><a class="el" href="a00352.html">SDFObjects</a></li><li class="navelem"><a class="el" href="a00626.html">ServerAuthManager</a></li> </ul>
  72. </div>
  73. </div><!-- top -->
  74. <div class="header">
  75. <div class="summary">
  76. <a href="#pub-types">Public Types</a> &#124;
  77. <a href="#pub-methods">Public Member Functions</a> &#124;
  78. <a href="#pub-static-methods">Static Public Member Functions</a> &#124;
  79. <a href="#properties">Properties</a> &#124;
  80. <a href="a00623.html">List of all members</a> </div>
  81. <div class="headertitle"><div class="title">ServerAuthManager Class Reference</div></div>
  82. </div><!--header-->
  83. <div class="contents">
  84. <p>Class responsible for managing licensing and allowing server communication.
  85. <a href="a00626.html#details">More...</a></p>
  86. <table class="memberdecls">
  87. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-types" name="pub-types"></a>
  88. Public Types</h2></td></tr>
  89. <tr class="memitem:a67a0db04d321a74b7e7fcfd3f1a3f70b"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00626.html#a67a0db04d321a74b7e7fcfd3f1a3f70b">Status</a> { <br />
  90. &#160;&#160;<b>NotInitialized</b> = 0
  91. , <b>OK</b>
  92. , <b>KeyValidationInProgress</b>
  93. , <b>NetworkError</b>
  94. , <br />
  95. &#160;&#160;<b>InvalidKey</b>
  96. , <b>NotRegistered</b>
  97. , <b>NoMaintance</b>
  98. , <b>Expired</b>
  99. <br />
  100. }</td></tr>
  101. <tr class="memdesc:a67a0db04d321a74b7e7fcfd3f1a3f70b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Status of license validation. <a href="a00626.html#a67a0db04d321a74b7e7fcfd3f1a3f70b">More...</a><br /></td></tr>
  102. <tr class="separator:a67a0db04d321a74b7e7fcfd3f1a3f70b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  103. </table><table class="memberdecls">
  104. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
  105. Public Member Functions</h2></td></tr>
  106. <tr class="memitem:a103fcd35e2406718fb2fe5e8adbde637"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00626.html#a67a0db04d321a74b7e7fcfd3f1a3f70b">Status</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00626.html#a103fcd35e2406718fb2fe5e8adbde637">GetStatus</a> (<a class="el" href="a00622.html#acd9c2a1cf576f0fd9da232d337d9720c">PluginManager.Effect</a> effect)</td></tr>
  107. <tr class="memdesc:a103fcd35e2406718fb2fe5e8adbde637"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns current status of license validation for specified effect. <br /></td></tr>
  108. <tr class="separator:a103fcd35e2406718fb2fe5e8adbde637"><td class="memSeparator" colspan="2">&#160;</td></tr>
  109. <tr class="memitem:ab3775ee958bbf5ee9ac108b6c49d6baa"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00626.html#ab3775ee958bbf5ee9ac108b6c49d6baa">IsLicenseVerified</a> (<a class="el" href="a00622.html#acd9c2a1cf576f0fd9da232d337d9720c">PluginManager.Effect</a> effect)</td></tr>
  110. <tr class="memdesc:ab3775ee958bbf5ee9ac108b6c49d6baa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks whether license is verified for specified effect. <br /></td></tr>
  111. <tr class="separator:ab3775ee958bbf5ee9ac108b6c49d6baa"><td class="memSeparator" colspan="2">&#160;</td></tr>
  112. <tr class="memitem:ad2e5039aa4da31728b5d4847e918e689"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00626.html#ad2e5039aa4da31728b5d4847e918e689">IsGenerationAvailable</a> ()</td></tr>
  113. <tr class="memdesc:ad2e5039aa4da31728b5d4847e918e689"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks whether generation is available. <br /></td></tr>
  114. <tr class="separator:ad2e5039aa4da31728b5d4847e918e689"><td class="memSeparator" colspan="2">&#160;</td></tr>
  115. <tr class="memitem:ad699d519d196e8619bc155a65c7fdac2"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00626.html#ad699d519d196e8619bc155a65c7fdac2">GetErrorMessage</a> (<a class="el" href="a00626.html#a67a0db04d321a74b7e7fcfd3f1a3f70b">Status</a> status)</td></tr>
  116. <tr class="memdesc:ad699d519d196e8619bc155a65c7fdac2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns human readable string explaining error based on Status. <br /></td></tr>
  117. <tr class="separator:ad699d519d196e8619bc155a65c7fdac2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  118. <tr class="memitem:ae5c595d8573f6d2e61841d92901c8cf9"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00626.html#ae5c595d8573f6d2e61841d92901c8cf9">GetErrorMessage</a> (<a class="el" href="a00622.html#acd9c2a1cf576f0fd9da232d337d9720c">PluginManager.Effect</a> effect)</td></tr>
  119. <tr class="memdesc:ae5c595d8573f6d2e61841d92901c8cf9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns human readable string explaining current error with activation of specified effect. <br /></td></tr>
  120. <tr class="separator:ae5c595d8573f6d2e61841d92901c8cf9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  121. <tr class="memitem:a7fd5d4c27d32671914485b14b4bae83c"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00626.html#a7fd5d4c27d32671914485b14b4bae83c">GetGenerationErrorMessage</a> ()</td></tr>
  122. <tr class="memdesc:a7fd5d4c27d32671914485b14b4bae83c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns human readable string explaining current error with generation availability. <br /></td></tr>
  123. <tr class="separator:a7fd5d4c27d32671914485b14b4bae83c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  124. <tr class="memitem:ae69012d435d72520651a3e321589b6bd"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00626.html#ae69012d435d72520651a3e321589b6bd">RegisterKey</a> (string key)</td></tr>
  125. <tr class="memdesc:ae69012d435d72520651a3e321589b6bd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets license key and starts key validation process. <br /></td></tr>
  126. <tr class="separator:ae69012d435d72520651a3e321589b6bd"><td class="memSeparator" colspan="2">&#160;</td></tr>
  127. <tr class="memitem:a9e1cc93b78157fd4a74814c2d40e5a27"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00626.html#a9e1cc93b78157fd4a74814c2d40e5a27">ValidateLicense</a> (string[] keys)</td></tr>
  128. <tr class="memdesc:a9e1cc93b78157fd4a74814c2d40e5a27"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets list of license keys and starts key validation process. <br /></td></tr>
  129. <tr class="separator:a9e1cc93b78157fd4a74814c2d40e5a27"><td class="memSeparator" colspan="2">&#160;</td></tr>
  130. <tr class="memitem:aeae62b53d238e0ea235c3b2470ddcc6d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00626.html#aeae62b53d238e0ea235c3b2470ddcc6d">RemoveKey</a> ()</td></tr>
  131. <tr class="memdesc:aeae62b53d238e0ea235c3b2470ddcc6d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Removes current license key. <br /></td></tr>
  132. <tr class="separator:aeae62b53d238e0ea235c3b2470ddcc6d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  133. </table><table class="memberdecls">
  134. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-methods" name="pub-static-methods"></a>
  135. Static Public Member Functions</h2></td></tr>
  136. <tr class="memitem:a277063ab843115933ff67b9891ae9288"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00626.html#a277063ab843115933ff67b9891ae9288">CheckKeysFormat</a> (string keys)</td></tr>
  137. <tr class="memdesc:a277063ab843115933ff67b9891ae9288"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks whether specified string is correctly formated list of keys. <br /></td></tr>
  138. <tr class="separator:a277063ab843115933ff67b9891ae9288"><td class="memSeparator" colspan="2">&#160;</td></tr>
  139. <tr class="memitem:a4e698e47214df7a64446630702660cd1"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="a00626.html">ServerAuthManager</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00626.html#a4e698e47214df7a64446630702660cd1">GetInstance</a> ()</td></tr>
  140. <tr class="memdesc:a4e698e47214df7a64446630702660cd1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns singleton of this class. <br /></td></tr>
  141. <tr class="separator:a4e698e47214df7a64446630702660cd1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  142. </table><table class="memberdecls">
  143. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="properties" name="properties"></a>
  144. Properties</h2></td></tr>
  145. <tr class="memitem:a11342e0c93b3d25557ae313ba74ad572"><td class="memItemLeft" align="right" valign="top">string[]&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00626.html#a11342e0c93b3d25557ae313ba74ad572">PluginLicenseKeys</a> = new string[0]<code> [get]</code></td></tr>
  146. <tr class="memdesc:a11342e0c93b3d25557ae313ba74ad572"><td class="mdescLeft">&#160;</td><td class="mdescRight">License key used for the plugin. <br /></td></tr>
  147. <tr class="separator:a11342e0c93b3d25557ae313ba74ad572"><td class="memSeparator" colspan="2">&#160;</td></tr>
  148. <tr class="memitem:a0520589e3e32353a7585e4d00a3d3eb3"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00626.html#a0520589e3e32353a7585e4d00a3d3eb3">GenerationLicenseKey</a> = &quot;&quot;<code> [get]</code></td></tr>
  149. <tr class="memdesc:a0520589e3e32353a7585e4d00a3d3eb3"><td class="mdescLeft">&#160;</td><td class="mdescRight">License key used for the generation. <br /></td></tr>
  150. <tr class="separator:a0520589e3e32353a7585e4d00a3d3eb3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  151. <tr class="memitem:a53285eb6fe7c0e10f23962af49c10eae"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00626.html#a53285eb6fe7c0e10f23962af49c10eae">GenerationURL</a> = &quot;&quot;<code> [get]</code></td></tr>
  152. <tr class="memdesc:a53285eb6fe7c0e10f23962af49c10eae"><td class="mdescLeft">&#160;</td><td class="mdescRight">URL address for generation API. <br /></td></tr>
  153. <tr class="separator:a53285eb6fe7c0e10f23962af49c10eae"><td class="memSeparator" colspan="2">&#160;</td></tr>
  154. <tr class="memitem:ad7c1e7880b1a0975f7b87a1321443c99"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00626.html#ad7c1e7880b1a0975f7b87a1321443c99">ServerErrorMessage</a> = &quot;&quot;<code> [get]</code></td></tr>
  155. <tr class="memdesc:ad7c1e7880b1a0975f7b87a1321443c99"><td class="mdescLeft">&#160;</td><td class="mdescRight">Human readable error message string returned from server. <br /></td></tr>
  156. <tr class="separator:ad7c1e7880b1a0975f7b87a1321443c99"><td class="memSeparator" colspan="2">&#160;</td></tr>
  157. </table>
  158. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  159. <div class="textblock"><p>Class responsible for managing licensing and allowing server communication. </p>
  160. </div><h2 class="groupheader">Member Enumeration Documentation</h2>
  161. <a id="a67a0db04d321a74b7e7fcfd3f1a3f70b" name="a67a0db04d321a74b7e7fcfd3f1a3f70b"></a>
  162. <h2 class="memtitle"><span class="permalink"><a href="#a67a0db04d321a74b7e7fcfd3f1a3f70b">&#9670;&#160;</a></span>Status</h2>
  163. <div class="memitem">
  164. <div class="memproto">
  165. <table class="memname">
  166. <tr>
  167. <td class="memname">enum <a class="el" href="a00626.html#a67a0db04d321a74b7e7fcfd3f1a3f70b">Status</a></td>
  168. </tr>
  169. </table>
  170. </div><div class="memdoc">
  171. <p>Status of license validation. </p>
  172. </div>
  173. </div>
  174. <h2 class="groupheader">Member Function Documentation</h2>
  175. <a id="a103fcd35e2406718fb2fe5e8adbde637" name="a103fcd35e2406718fb2fe5e8adbde637"></a>
  176. <h2 class="memtitle"><span class="permalink"><a href="#a103fcd35e2406718fb2fe5e8adbde637">&#9670;&#160;</a></span>GetStatus()</h2>
  177. <div class="memitem">
  178. <div class="memproto">
  179. <table class="mlabels">
  180. <tr>
  181. <td class="mlabels-left">
  182. <table class="memname">
  183. <tr>
  184. <td class="memname"><a class="el" href="a00626.html#a67a0db04d321a74b7e7fcfd3f1a3f70b">Status</a> GetStatus </td>
  185. <td>(</td>
  186. <td class="paramtype"><a class="el" href="a00622.html#acd9c2a1cf576f0fd9da232d337d9720c">PluginManager::Effect</a>&#160;</td>
  187. <td class="paramname"><em>effect</em></td><td>)</td>
  188. <td></td>
  189. </tr>
  190. </table>
  191. </td>
  192. <td class="mlabels-right">
  193. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  194. </tr>
  195. </table>
  196. </div><div class="memdoc">
  197. <p>Returns current status of license validation for specified effect. </p>
  198. <p>Never returns NotInitialized, since it initialized validation in this case. </p>
  199. </div>
  200. </div>
  201. <a id="ab3775ee958bbf5ee9ac108b6c49d6baa" name="ab3775ee958bbf5ee9ac108b6c49d6baa"></a>
  202. <h2 class="memtitle"><span class="permalink"><a href="#ab3775ee958bbf5ee9ac108b6c49d6baa">&#9670;&#160;</a></span>IsLicenseVerified()</h2>
  203. <div class="memitem">
  204. <div class="memproto">
  205. <table class="mlabels">
  206. <tr>
  207. <td class="mlabels-left">
  208. <table class="memname">
  209. <tr>
  210. <td class="memname">bool IsLicenseVerified </td>
  211. <td>(</td>
  212. <td class="paramtype"><a class="el" href="a00622.html#acd9c2a1cf576f0fd9da232d337d9720c">PluginManager::Effect</a>&#160;</td>
  213. <td class="paramname"><em>effect</em></td><td>)</td>
  214. <td></td>
  215. </tr>
  216. </table>
  217. </td>
  218. <td class="mlabels-right">
  219. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  220. </tr>
  221. </table>
  222. </div><div class="memdoc">
  223. <p>Checks whether license is verified for specified effect. </p>
  224. <dl class="section return"><dt>Returns</dt><dd>True if license is valid, false otherwise. </dd></dl>
  225. </div>
  226. </div>
  227. <a id="a277063ab843115933ff67b9891ae9288" name="a277063ab843115933ff67b9891ae9288"></a>
  228. <h2 class="memtitle"><span class="permalink"><a href="#a277063ab843115933ff67b9891ae9288">&#9670;&#160;</a></span>CheckKeysFormat()</h2>
  229. <div class="memitem">
  230. <div class="memproto">
  231. <table class="mlabels">
  232. <tr>
  233. <td class="mlabels-left">
  234. <table class="memname">
  235. <tr>
  236. <td class="memname">static bool CheckKeysFormat </td>
  237. <td>(</td>
  238. <td class="paramtype">string&#160;</td>
  239. <td class="paramname"><em>keys</em></td><td>)</td>
  240. <td></td>
  241. </tr>
  242. </table>
  243. </td>
  244. <td class="mlabels-right">
  245. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
  246. </tr>
  247. </table>
  248. </div><div class="memdoc">
  249. <p>Checks whether specified string is correctly formated list of keys. </p>
  250. </div>
  251. </div>
  252. <a id="ad2e5039aa4da31728b5d4847e918e689" name="ad2e5039aa4da31728b5d4847e918e689"></a>
  253. <h2 class="memtitle"><span class="permalink"><a href="#ad2e5039aa4da31728b5d4847e918e689">&#9670;&#160;</a></span>IsGenerationAvailable()</h2>
  254. <div class="memitem">
  255. <div class="memproto">
  256. <table class="mlabels">
  257. <tr>
  258. <td class="mlabels-left">
  259. <table class="memname">
  260. <tr>
  261. <td class="memname">bool IsGenerationAvailable </td>
  262. <td>(</td>
  263. <td class="paramname"></td><td>)</td>
  264. <td></td>
  265. </tr>
  266. </table>
  267. </td>
  268. <td class="mlabels-right">
  269. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  270. </tr>
  271. </table>
  272. </div><div class="memdoc">
  273. <p>Checks whether generation is available. </p>
  274. <dl class="section return"><dt>Returns</dt><dd>True if license is valid and not expired, false otherwise. </dd></dl>
  275. </div>
  276. </div>
  277. <a id="ad699d519d196e8619bc155a65c7fdac2" name="ad699d519d196e8619bc155a65c7fdac2"></a>
  278. <h2 class="memtitle"><span class="permalink"><a href="#ad699d519d196e8619bc155a65c7fdac2">&#9670;&#160;</a></span>GetErrorMessage() <span class="overload">[1/2]</span></h2>
  279. <div class="memitem">
  280. <div class="memproto">
  281. <table class="mlabels">
  282. <tr>
  283. <td class="mlabels-left">
  284. <table class="memname">
  285. <tr>
  286. <td class="memname">string GetErrorMessage </td>
  287. <td>(</td>
  288. <td class="paramtype"><a class="el" href="a00626.html#a67a0db04d321a74b7e7fcfd3f1a3f70b">Status</a>&#160;</td>
  289. <td class="paramname"><em>status</em></td><td>)</td>
  290. <td></td>
  291. </tr>
  292. </table>
  293. </td>
  294. <td class="mlabels-right">
  295. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  296. </tr>
  297. </table>
  298. </div><div class="memdoc">
  299. <p>Returns human readable string explaining error based on Status. </p>
  300. </div>
  301. </div>
  302. <a id="ae5c595d8573f6d2e61841d92901c8cf9" name="ae5c595d8573f6d2e61841d92901c8cf9"></a>
  303. <h2 class="memtitle"><span class="permalink"><a href="#ae5c595d8573f6d2e61841d92901c8cf9">&#9670;&#160;</a></span>GetErrorMessage() <span class="overload">[2/2]</span></h2>
  304. <div class="memitem">
  305. <div class="memproto">
  306. <table class="mlabels">
  307. <tr>
  308. <td class="mlabels-left">
  309. <table class="memname">
  310. <tr>
  311. <td class="memname">string GetErrorMessage </td>
  312. <td>(</td>
  313. <td class="paramtype"><a class="el" href="a00622.html#acd9c2a1cf576f0fd9da232d337d9720c">PluginManager::Effect</a>&#160;</td>
  314. <td class="paramname"><em>effect</em></td><td>)</td>
  315. <td></td>
  316. </tr>
  317. </table>
  318. </td>
  319. <td class="mlabels-right">
  320. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  321. </tr>
  322. </table>
  323. </div><div class="memdoc">
  324. <p>Returns human readable string explaining current error with activation of specified effect. </p>
  325. </div>
  326. </div>
  327. <a id="a7fd5d4c27d32671914485b14b4bae83c" name="a7fd5d4c27d32671914485b14b4bae83c"></a>
  328. <h2 class="memtitle"><span class="permalink"><a href="#a7fd5d4c27d32671914485b14b4bae83c">&#9670;&#160;</a></span>GetGenerationErrorMessage()</h2>
  329. <div class="memitem">
  330. <div class="memproto">
  331. <table class="mlabels">
  332. <tr>
  333. <td class="mlabels-left">
  334. <table class="memname">
  335. <tr>
  336. <td class="memname">string GetGenerationErrorMessage </td>
  337. <td>(</td>
  338. <td class="paramname"></td><td>)</td>
  339. <td></td>
  340. </tr>
  341. </table>
  342. </td>
  343. <td class="mlabels-right">
  344. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  345. </tr>
  346. </table>
  347. </div><div class="memdoc">
  348. <p>Returns human readable string explaining current error with generation availability. </p>
  349. </div>
  350. </div>
  351. <a id="a4e698e47214df7a64446630702660cd1" name="a4e698e47214df7a64446630702660cd1"></a>
  352. <h2 class="memtitle"><span class="permalink"><a href="#a4e698e47214df7a64446630702660cd1">&#9670;&#160;</a></span>GetInstance()</h2>
  353. <div class="memitem">
  354. <div class="memproto">
  355. <table class="mlabels">
  356. <tr>
  357. <td class="mlabels-left">
  358. <table class="memname">
  359. <tr>
  360. <td class="memname">static <a class="el" href="a00626.html">ServerAuthManager</a> GetInstance </td>
  361. <td>(</td>
  362. <td class="paramname"></td><td>)</td>
  363. <td></td>
  364. </tr>
  365. </table>
  366. </td>
  367. <td class="mlabels-right">
  368. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
  369. </tr>
  370. </table>
  371. </div><div class="memdoc">
  372. <p>Returns singleton of this class. </p>
  373. <p>Creates and initializes instance if needed. </p>
  374. </div>
  375. </div>
  376. <a id="ae69012d435d72520651a3e321589b6bd" name="ae69012d435d72520651a3e321589b6bd"></a>
  377. <h2 class="memtitle"><span class="permalink"><a href="#ae69012d435d72520651a3e321589b6bd">&#9670;&#160;</a></span>RegisterKey()</h2>
  378. <div class="memitem">
  379. <div class="memproto">
  380. <table class="mlabels">
  381. <tr>
  382. <td class="mlabels-left">
  383. <table class="memname">
  384. <tr>
  385. <td class="memname">void RegisterKey </td>
  386. <td>(</td>
  387. <td class="paramtype">string&#160;</td>
  388. <td class="paramname"><em>key</em></td><td>)</td>
  389. <td></td>
  390. </tr>
  391. </table>
  392. </td>
  393. <td class="mlabels-right">
  394. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  395. </tr>
  396. </table>
  397. </div><div class="memdoc">
  398. <p>Sets license key and starts key validation process. </p>
  399. </div>
  400. </div>
  401. <a id="a9e1cc93b78157fd4a74814c2d40e5a27" name="a9e1cc93b78157fd4a74814c2d40e5a27"></a>
  402. <h2 class="memtitle"><span class="permalink"><a href="#a9e1cc93b78157fd4a74814c2d40e5a27">&#9670;&#160;</a></span>ValidateLicense()</h2>
  403. <div class="memitem">
  404. <div class="memproto">
  405. <table class="mlabels">
  406. <tr>
  407. <td class="mlabels-left">
  408. <table class="memname">
  409. <tr>
  410. <td class="memname">void ValidateLicense </td>
  411. <td>(</td>
  412. <td class="paramtype">string[]&#160;</td>
  413. <td class="paramname"><em>keys</em></td><td>)</td>
  414. <td></td>
  415. </tr>
  416. </table>
  417. </td>
  418. <td class="mlabels-right">
  419. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  420. </tr>
  421. </table>
  422. </div><div class="memdoc">
  423. <p>Sets list of license keys and starts key validation process. </p>
  424. </div>
  425. </div>
  426. <a id="aeae62b53d238e0ea235c3b2470ddcc6d" name="aeae62b53d238e0ea235c3b2470ddcc6d"></a>
  427. <h2 class="memtitle"><span class="permalink"><a href="#aeae62b53d238e0ea235c3b2470ddcc6d">&#9670;&#160;</a></span>RemoveKey()</h2>
  428. <div class="memitem">
  429. <div class="memproto">
  430. <table class="mlabels">
  431. <tr>
  432. <td class="mlabels-left">
  433. <table class="memname">
  434. <tr>
  435. <td class="memname">void RemoveKey </td>
  436. <td>(</td>
  437. <td class="paramname"></td><td>)</td>
  438. <td></td>
  439. </tr>
  440. </table>
  441. </td>
  442. <td class="mlabels-right">
  443. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  444. </tr>
  445. </table>
  446. </div><div class="memdoc">
  447. <p>Removes current license key. </p>
  448. </div>
  449. </div>
  450. <h2 class="groupheader">Property Documentation</h2>
  451. <a id="a11342e0c93b3d25557ae313ba74ad572" name="a11342e0c93b3d25557ae313ba74ad572"></a>
  452. <h2 class="memtitle"><span class="permalink"><a href="#a11342e0c93b3d25557ae313ba74ad572">&#9670;&#160;</a></span>PluginLicenseKeys</h2>
  453. <div class="memitem">
  454. <div class="memproto">
  455. <table class="mlabels">
  456. <tr>
  457. <td class="mlabels-left">
  458. <table class="memname">
  459. <tr>
  460. <td class="memname">string [] PluginLicenseKeys = new string[0]</td>
  461. </tr>
  462. </table>
  463. </td>
  464. <td class="mlabels-right">
  465. <span class="mlabels"><span class="mlabel">get</span></span> </td>
  466. </tr>
  467. </table>
  468. </div><div class="memdoc">
  469. <p>License key used for the plugin. </p>
  470. <p>Not necessarily correct. Use IsLicenseVerified to check for that. </p>
  471. <p>May be empty. </p>
  472. </div>
  473. </div>
  474. <a id="a0520589e3e32353a7585e4d00a3d3eb3" name="a0520589e3e32353a7585e4d00a3d3eb3"></a>
  475. <h2 class="memtitle"><span class="permalink"><a href="#a0520589e3e32353a7585e4d00a3d3eb3">&#9670;&#160;</a></span>GenerationLicenseKey</h2>
  476. <div class="memitem">
  477. <div class="memproto">
  478. <table class="mlabels">
  479. <tr>
  480. <td class="mlabels-left">
  481. <table class="memname">
  482. <tr>
  483. <td class="memname">string GenerationLicenseKey = &quot;&quot;</td>
  484. </tr>
  485. </table>
  486. </td>
  487. <td class="mlabels-right">
  488. <span class="mlabels"><span class="mlabel">get</span></span> </td>
  489. </tr>
  490. </table>
  491. </div><div class="memdoc">
  492. <p>License key used for the generation. </p>
  493. <p>It's either validated key suitable for generation or an empty string. </p>
  494. </div>
  495. </div>
  496. <a id="a53285eb6fe7c0e10f23962af49c10eae" name="a53285eb6fe7c0e10f23962af49c10eae"></a>
  497. <h2 class="memtitle"><span class="permalink"><a href="#a53285eb6fe7c0e10f23962af49c10eae">&#9670;&#160;</a></span>GenerationURL</h2>
  498. <div class="memitem">
  499. <div class="memproto">
  500. <table class="mlabels">
  501. <tr>
  502. <td class="mlabels-left">
  503. <table class="memname">
  504. <tr>
  505. <td class="memname">string GenerationURL = &quot;&quot;</td>
  506. </tr>
  507. </table>
  508. </td>
  509. <td class="mlabels-right">
  510. <span class="mlabels"><span class="mlabel">get</span></span> </td>
  511. </tr>
  512. </table>
  513. </div><div class="memdoc">
  514. <p>URL address for generation API. </p>
  515. <p>Includes GenerationLicenseKey in the URL. </p>
  516. </div>
  517. </div>
  518. <a id="ad7c1e7880b1a0975f7b87a1321443c99" name="ad7c1e7880b1a0975f7b87a1321443c99"></a>
  519. <h2 class="memtitle"><span class="permalink"><a href="#ad7c1e7880b1a0975f7b87a1321443c99">&#9670;&#160;</a></span>ServerErrorMessage</h2>
  520. <div class="memitem">
  521. <div class="memproto">
  522. <table class="mlabels">
  523. <tr>
  524. <td class="mlabels-left">
  525. <table class="memname">
  526. <tr>
  527. <td class="memname">string ServerErrorMessage = &quot;&quot;</td>
  528. </tr>
  529. </table>
  530. </td>
  531. <td class="mlabels-right">
  532. <span class="mlabels"><span class="mlabel">get</span></span> </td>
  533. </tr>
  534. </table>
  535. </div><div class="memdoc">
  536. <p>Human readable error message string returned from server. </p>
  537. </div>
  538. </div>
  539. <hr/>The documentation for this class was generated from the following file:<ul>
  540. <li>Assets/Plugins/Zibra/Common/Scripts/SDFObjects/Editor/ServerAuthManager.cs</li>
  541. </ul>
  542. </div><!-- contents -->
  543. <!-- start footer part -->
  544. <hr class="footer"/><address class="footer"><small>
  545. Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.7
  546. </small></address>
  547. </body>
  548. </html>