| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600 |
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
- <html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
- <head>
- <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
- <meta http-equiv="X-UA-Compatible" content="IE=11"/>
- <meta name="generator" content="Doxygen 1.9.7"/>
- <meta name="viewport" content="width=device-width, initial-scale=1"/>
- <title>Zibra Effects: ServerAuthManager Class Reference</title>
- <link href="tabs.css" rel="stylesheet" type="text/css"/>
- <script type="text/javascript" src="jquery.js.txt"></script>
- <script type="text/javascript" src="dynsections.js.txt"></script>
- <link href="search/search.css" rel="stylesheet" type="text/css"/>
- <script type="text/javascript" src="search/searchdata.js.txt"></script>
- <script type="text/javascript" src="search/search.js.txt"></script>
- <link href="doxygen.css" rel="stylesheet" type="text/css" />
- </head>
- <body>
- <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
- <div id="titlearea">
- <table cellspacing="0" cellpadding="0">
- <tbody>
- <tr id="projectrow">
- <td id="projectalign">
- <div id="projectname">Zibra Effects
- </div>
- <div id="projectbrief">Real-time Simulated Visual Effects</div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <!-- end header part -->
- <!-- Generated by Doxygen 1.9.7 -->
- <script type="text/javascript">
- /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
- var searchBox = new SearchBox("searchBox", "search/",'.html');
- /* @license-end */
- </script>
- <script type="text/javascript" src="menudata.js.txt"></script>
- <script type="text/javascript" src="menu.js.txt"></script>
- <script type="text/javascript">
- /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
- $(function() {
- initMenu('',true,false,'search.php','Search');
- $(document).ready(function() { init_search(); });
- });
- /* @license-end */
- </script>
- <div id="main-nav"></div>
- <!-- window showing the filter options -->
- <div id="MSearchSelectWindow"
- onmouseover="return searchBox.OnSearchSelectShow()"
- onmouseout="return searchBox.OnSearchSelectHide()"
- onkeydown="return searchBox.OnSearchSelectKey(event)">
- </div>
- <!-- iframe showing the search results (closed by default) -->
- <div id="MSearchResultsWindow">
- <div id="MSearchResults">
- <div class="SRPage">
- <div id="SRIndex">
- <div id="SRResults"></div>
- <div class="SRStatus" id="Loading">Loading...</div>
- <div class="SRStatus" id="Searching">Searching...</div>
- <div class="SRStatus" id="NoMatches">No Matches</div>
- </div>
- </div>
- </div>
- </div>
- <div id="nav-path" class="navpath">
- <ul>
- <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>
- </div>
- </div><!-- top -->
- <div class="header">
- <div class="summary">
- <a href="#pub-types">Public Types</a> |
- <a href="#pub-methods">Public Member Functions</a> |
- <a href="#pub-static-methods">Static Public Member Functions</a> |
- <a href="#properties">Properties</a> |
- <a href="a00623.html">List of all members</a> </div>
- <div class="headertitle"><div class="title">ServerAuthManager Class Reference</div></div>
- </div><!--header-->
- <div class="contents">
- <p>Class responsible for managing licensing and allowing server communication.
- <a href="a00626.html#details">More...</a></p>
- <table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-types" name="pub-types"></a>
- Public Types</h2></td></tr>
- <tr class="memitem:a67a0db04d321a74b7e7fcfd3f1a3f70b"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00626.html#a67a0db04d321a74b7e7fcfd3f1a3f70b">Status</a> { <br />
-   <b>NotInitialized</b> = 0
- , <b>OK</b>
- , <b>KeyValidationInProgress</b>
- , <b>NetworkError</b>
- , <br />
-   <b>InvalidKey</b>
- , <b>NotRegistered</b>
- , <b>NoMaintance</b>
- , <b>Expired</b>
- <br />
- }</td></tr>
- <tr class="memdesc:a67a0db04d321a74b7e7fcfd3f1a3f70b"><td class="mdescLeft"> </td><td class="mdescRight">Status of license validation. <a href="a00626.html#a67a0db04d321a74b7e7fcfd3f1a3f70b">More...</a><br /></td></tr>
- <tr class="separator:a67a0db04d321a74b7e7fcfd3f1a3f70b"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
- Public Member Functions</h2></td></tr>
- <tr class="memitem:a103fcd35e2406718fb2fe5e8adbde637"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00626.html#a67a0db04d321a74b7e7fcfd3f1a3f70b">Status</a> </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>
- <tr class="memdesc:a103fcd35e2406718fb2fe5e8adbde637"><td class="mdescLeft"> </td><td class="mdescRight">Returns current status of license validation for specified effect. <br /></td></tr>
- <tr class="separator:a103fcd35e2406718fb2fe5e8adbde637"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ab3775ee958bbf5ee9ac108b6c49d6baa"><td class="memItemLeft" align="right" valign="top">bool </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>
- <tr class="memdesc:ab3775ee958bbf5ee9ac108b6c49d6baa"><td class="mdescLeft"> </td><td class="mdescRight">Checks whether license is verified for specified effect. <br /></td></tr>
- <tr class="separator:ab3775ee958bbf5ee9ac108b6c49d6baa"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ad2e5039aa4da31728b5d4847e918e689"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00626.html#ad2e5039aa4da31728b5d4847e918e689">IsGenerationAvailable</a> ()</td></tr>
- <tr class="memdesc:ad2e5039aa4da31728b5d4847e918e689"><td class="mdescLeft"> </td><td class="mdescRight">Checks whether generation is available. <br /></td></tr>
- <tr class="separator:ad2e5039aa4da31728b5d4847e918e689"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ad699d519d196e8619bc155a65c7fdac2"><td class="memItemLeft" align="right" valign="top">string </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>
- <tr class="memdesc:ad699d519d196e8619bc155a65c7fdac2"><td class="mdescLeft"> </td><td class="mdescRight">Returns human readable string explaining error based on Status. <br /></td></tr>
- <tr class="separator:ad699d519d196e8619bc155a65c7fdac2"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ae5c595d8573f6d2e61841d92901c8cf9"><td class="memItemLeft" align="right" valign="top">string </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>
- <tr class="memdesc:ae5c595d8573f6d2e61841d92901c8cf9"><td class="mdescLeft"> </td><td class="mdescRight">Returns human readable string explaining current error with activation of specified effect. <br /></td></tr>
- <tr class="separator:ae5c595d8573f6d2e61841d92901c8cf9"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a7fd5d4c27d32671914485b14b4bae83c"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="a00626.html#a7fd5d4c27d32671914485b14b4bae83c">GetGenerationErrorMessage</a> ()</td></tr>
- <tr class="memdesc:a7fd5d4c27d32671914485b14b4bae83c"><td class="mdescLeft"> </td><td class="mdescRight">Returns human readable string explaining current error with generation availability. <br /></td></tr>
- <tr class="separator:a7fd5d4c27d32671914485b14b4bae83c"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ae69012d435d72520651a3e321589b6bd"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00626.html#ae69012d435d72520651a3e321589b6bd">RegisterKey</a> (string key)</td></tr>
- <tr class="memdesc:ae69012d435d72520651a3e321589b6bd"><td class="mdescLeft"> </td><td class="mdescRight">Sets license key and starts key validation process. <br /></td></tr>
- <tr class="separator:ae69012d435d72520651a3e321589b6bd"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a9e1cc93b78157fd4a74814c2d40e5a27"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00626.html#a9e1cc93b78157fd4a74814c2d40e5a27">ValidateLicense</a> (string[] keys)</td></tr>
- <tr class="memdesc:a9e1cc93b78157fd4a74814c2d40e5a27"><td class="mdescLeft"> </td><td class="mdescRight">Sets list of license keys and starts key validation process. <br /></td></tr>
- <tr class="separator:a9e1cc93b78157fd4a74814c2d40e5a27"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aeae62b53d238e0ea235c3b2470ddcc6d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00626.html#aeae62b53d238e0ea235c3b2470ddcc6d">RemoveKey</a> ()</td></tr>
- <tr class="memdesc:aeae62b53d238e0ea235c3b2470ddcc6d"><td class="mdescLeft"> </td><td class="mdescRight">Removes current license key. <br /></td></tr>
- <tr class="separator:aeae62b53d238e0ea235c3b2470ddcc6d"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-methods" name="pub-static-methods"></a>
- Static Public Member Functions</h2></td></tr>
- <tr class="memitem:a277063ab843115933ff67b9891ae9288"><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00626.html#a277063ab843115933ff67b9891ae9288">CheckKeysFormat</a> (string keys)</td></tr>
- <tr class="memdesc:a277063ab843115933ff67b9891ae9288"><td class="mdescLeft"> </td><td class="mdescRight">Checks whether specified string is correctly formated list of keys. <br /></td></tr>
- <tr class="separator:a277063ab843115933ff67b9891ae9288"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a4e698e47214df7a64446630702660cd1"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="a00626.html">ServerAuthManager</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00626.html#a4e698e47214df7a64446630702660cd1">GetInstance</a> ()</td></tr>
- <tr class="memdesc:a4e698e47214df7a64446630702660cd1"><td class="mdescLeft"> </td><td class="mdescRight">Returns singleton of this class. <br /></td></tr>
- <tr class="separator:a4e698e47214df7a64446630702660cd1"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="properties" name="properties"></a>
- Properties</h2></td></tr>
- <tr class="memitem:a11342e0c93b3d25557ae313ba74ad572"><td class="memItemLeft" align="right" valign="top">string[] </td><td class="memItemRight" valign="bottom"><a class="el" href="a00626.html#a11342e0c93b3d25557ae313ba74ad572">PluginLicenseKeys</a> = new string[0]<code> [get]</code></td></tr>
- <tr class="memdesc:a11342e0c93b3d25557ae313ba74ad572"><td class="mdescLeft"> </td><td class="mdescRight">License key used for the plugin. <br /></td></tr>
- <tr class="separator:a11342e0c93b3d25557ae313ba74ad572"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a0520589e3e32353a7585e4d00a3d3eb3"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="a00626.html#a0520589e3e32353a7585e4d00a3d3eb3">GenerationLicenseKey</a> = ""<code> [get]</code></td></tr>
- <tr class="memdesc:a0520589e3e32353a7585e4d00a3d3eb3"><td class="mdescLeft"> </td><td class="mdescRight">License key used for the generation. <br /></td></tr>
- <tr class="separator:a0520589e3e32353a7585e4d00a3d3eb3"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a53285eb6fe7c0e10f23962af49c10eae"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="a00626.html#a53285eb6fe7c0e10f23962af49c10eae">GenerationURL</a> = ""<code> [get]</code></td></tr>
- <tr class="memdesc:a53285eb6fe7c0e10f23962af49c10eae"><td class="mdescLeft"> </td><td class="mdescRight">URL address for generation API. <br /></td></tr>
- <tr class="separator:a53285eb6fe7c0e10f23962af49c10eae"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ad7c1e7880b1a0975f7b87a1321443c99"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="a00626.html#ad7c1e7880b1a0975f7b87a1321443c99">ServerErrorMessage</a> = ""<code> [get]</code></td></tr>
- <tr class="memdesc:ad7c1e7880b1a0975f7b87a1321443c99"><td class="mdescLeft"> </td><td class="mdescRight">Human readable error message string returned from server. <br /></td></tr>
- <tr class="separator:ad7c1e7880b1a0975f7b87a1321443c99"><td class="memSeparator" colspan="2"> </td></tr>
- </table>
- <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
- <div class="textblock"><p>Class responsible for managing licensing and allowing server communication. </p>
- </div><h2 class="groupheader">Member Enumeration Documentation</h2>
- <a id="a67a0db04d321a74b7e7fcfd3f1a3f70b" name="a67a0db04d321a74b7e7fcfd3f1a3f70b"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a67a0db04d321a74b7e7fcfd3f1a3f70b">◆ </a></span>Status</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">enum <a class="el" href="a00626.html#a67a0db04d321a74b7e7fcfd3f1a3f70b">Status</a></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Status of license validation. </p>
- </div>
- </div>
- <h2 class="groupheader">Member Function Documentation</h2>
- <a id="a103fcd35e2406718fb2fe5e8adbde637" name="a103fcd35e2406718fb2fe5e8adbde637"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a103fcd35e2406718fb2fe5e8adbde637">◆ </a></span>GetStatus()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="a00626.html#a67a0db04d321a74b7e7fcfd3f1a3f70b">Status</a> GetStatus </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="a00622.html#acd9c2a1cf576f0fd9da232d337d9720c">PluginManager::Effect</a> </td>
- <td class="paramname"><em>effect</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Returns current status of license validation for specified effect. </p>
- <p>Never returns NotInitialized, since it initialized validation in this case. </p>
- </div>
- </div>
- <a id="ab3775ee958bbf5ee9ac108b6c49d6baa" name="ab3775ee958bbf5ee9ac108b6c49d6baa"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ab3775ee958bbf5ee9ac108b6c49d6baa">◆ </a></span>IsLicenseVerified()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">bool IsLicenseVerified </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="a00622.html#acd9c2a1cf576f0fd9da232d337d9720c">PluginManager::Effect</a> </td>
- <td class="paramname"><em>effect</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Checks whether license is verified for specified effect. </p>
- <dl class="section return"><dt>Returns</dt><dd>True if license is valid, false otherwise. </dd></dl>
- </div>
- </div>
- <a id="a277063ab843115933ff67b9891ae9288" name="a277063ab843115933ff67b9891ae9288"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a277063ab843115933ff67b9891ae9288">◆ </a></span>CheckKeysFormat()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">static bool CheckKeysFormat </td>
- <td>(</td>
- <td class="paramtype">string </td>
- <td class="paramname"><em>keys</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Checks whether specified string is correctly formated list of keys. </p>
- </div>
- </div>
- <a id="ad2e5039aa4da31728b5d4847e918e689" name="ad2e5039aa4da31728b5d4847e918e689"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ad2e5039aa4da31728b5d4847e918e689">◆ </a></span>IsGenerationAvailable()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">bool IsGenerationAvailable </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Checks whether generation is available. </p>
- <dl class="section return"><dt>Returns</dt><dd>True if license is valid and not expired, false otherwise. </dd></dl>
- </div>
- </div>
- <a id="ad699d519d196e8619bc155a65c7fdac2" name="ad699d519d196e8619bc155a65c7fdac2"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ad699d519d196e8619bc155a65c7fdac2">◆ </a></span>GetErrorMessage() <span class="overload">[1/2]</span></h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">string GetErrorMessage </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="a00626.html#a67a0db04d321a74b7e7fcfd3f1a3f70b">Status</a> </td>
- <td class="paramname"><em>status</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Returns human readable string explaining error based on Status. </p>
- </div>
- </div>
- <a id="ae5c595d8573f6d2e61841d92901c8cf9" name="ae5c595d8573f6d2e61841d92901c8cf9"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ae5c595d8573f6d2e61841d92901c8cf9">◆ </a></span>GetErrorMessage() <span class="overload">[2/2]</span></h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">string GetErrorMessage </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="a00622.html#acd9c2a1cf576f0fd9da232d337d9720c">PluginManager::Effect</a> </td>
- <td class="paramname"><em>effect</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Returns human readable string explaining current error with activation of specified effect. </p>
- </div>
- </div>
- <a id="a7fd5d4c27d32671914485b14b4bae83c" name="a7fd5d4c27d32671914485b14b4bae83c"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a7fd5d4c27d32671914485b14b4bae83c">◆ </a></span>GetGenerationErrorMessage()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">string GetGenerationErrorMessage </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Returns human readable string explaining current error with generation availability. </p>
- </div>
- </div>
- <a id="a4e698e47214df7a64446630702660cd1" name="a4e698e47214df7a64446630702660cd1"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a4e698e47214df7a64446630702660cd1">◆ </a></span>GetInstance()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">static <a class="el" href="a00626.html">ServerAuthManager</a> GetInstance </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Returns singleton of this class. </p>
- <p>Creates and initializes instance if needed. </p>
- </div>
- </div>
- <a id="ae69012d435d72520651a3e321589b6bd" name="ae69012d435d72520651a3e321589b6bd"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ae69012d435d72520651a3e321589b6bd">◆ </a></span>RegisterKey()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void RegisterKey </td>
- <td>(</td>
- <td class="paramtype">string </td>
- <td class="paramname"><em>key</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Sets license key and starts key validation process. </p>
- </div>
- </div>
- <a id="a9e1cc93b78157fd4a74814c2d40e5a27" name="a9e1cc93b78157fd4a74814c2d40e5a27"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a9e1cc93b78157fd4a74814c2d40e5a27">◆ </a></span>ValidateLicense()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void ValidateLicense </td>
- <td>(</td>
- <td class="paramtype">string[] </td>
- <td class="paramname"><em>keys</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Sets list of license keys and starts key validation process. </p>
- </div>
- </div>
- <a id="aeae62b53d238e0ea235c3b2470ddcc6d" name="aeae62b53d238e0ea235c3b2470ddcc6d"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#aeae62b53d238e0ea235c3b2470ddcc6d">◆ </a></span>RemoveKey()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void RemoveKey </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Removes current license key. </p>
- </div>
- </div>
- <h2 class="groupheader">Property Documentation</h2>
- <a id="a11342e0c93b3d25557ae313ba74ad572" name="a11342e0c93b3d25557ae313ba74ad572"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a11342e0c93b3d25557ae313ba74ad572">◆ </a></span>PluginLicenseKeys</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">string [] PluginLicenseKeys = new string[0]</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">get</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>License key used for the plugin. </p>
- <p>Not necessarily correct. Use IsLicenseVerified to check for that. </p>
- <p>May be empty. </p>
- </div>
- </div>
- <a id="a0520589e3e32353a7585e4d00a3d3eb3" name="a0520589e3e32353a7585e4d00a3d3eb3"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a0520589e3e32353a7585e4d00a3d3eb3">◆ </a></span>GenerationLicenseKey</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">string GenerationLicenseKey = ""</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">get</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>License key used for the generation. </p>
- <p>It's either validated key suitable for generation or an empty string. </p>
- </div>
- </div>
- <a id="a53285eb6fe7c0e10f23962af49c10eae" name="a53285eb6fe7c0e10f23962af49c10eae"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a53285eb6fe7c0e10f23962af49c10eae">◆ </a></span>GenerationURL</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">string GenerationURL = ""</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">get</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>URL address for generation API. </p>
- <p>Includes GenerationLicenseKey in the URL. </p>
- </div>
- </div>
- <a id="ad7c1e7880b1a0975f7b87a1321443c99" name="ad7c1e7880b1a0975f7b87a1321443c99"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ad7c1e7880b1a0975f7b87a1321443c99">◆ </a></span>ServerErrorMessage</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">string ServerErrorMessage = ""</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">get</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Human readable error message string returned from server. </p>
- </div>
- </div>
- <hr/>The documentation for this class was generated from the following file:<ul>
- <li>Assets/Plugins/Zibra/Common/Scripts/SDFObjects/Editor/ServerAuthManager.cs</li>
- </ul>
- </div><!-- contents -->
- <!-- start footer part -->
- <hr class="footer"/><address class="footer"><small>
- Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.7
- </small></address>
- </body>
- </html>
|