/usr/share/doc/libjuce/apiref/classOnlineUnlockStatus.html is in libjuce-doc 4.3.0~repack-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.12"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>JUCE: OnlineUnlockStatus Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></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 style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">JUCE
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.12 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</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">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="classOnlineUnlockStatus-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">OnlineUnlockStatus Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>A base class for online unlocking systems.
<a href="classOnlineUnlockStatus.html#details">More...</a></p>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for OnlineUnlockStatus:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center">
<img src="classOnlineUnlockStatus.png" usemap="#OnlineUnlockStatus_map" alt=""/>
<map id="OnlineUnlockStatus_map" name="OnlineUnlockStatus_map">
<area href="classTracktionMarketplaceStatus.html" title="An implementation of the OnlineUnlockStatus class which talks to the Tracktion Marketplace server..." alt="TracktionMarketplaceStatus" shape="rect" coords="0,56,168,80"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structOnlineUnlockStatus_1_1MachineIDUtilities.html">MachineIDUtilities</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">This class contains some utility functions that might help with machine ID generation. <a href="structOnlineUnlockStatus_1_1MachineIDUtilities.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structOnlineUnlockStatus_1_1UnlockResult.html">UnlockResult</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">This provides some details about the reply that the server gave in a call to <a class="el" href="classOnlineUnlockStatus.html#ae40afa554781a7649645c75c664bba47" title="Contacts the webserver and attempts to perform a registration with the given user details...">attemptWebserverUnlock()</a>. <a href="structOnlineUnlockStatus_1_1UnlockResult.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a0e389a69ccb4f985b19a8db49082c559"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOnlineUnlockStatus.html#a0e389a69ccb4f985b19a8db49082c559">OnlineUnlockStatus</a> ()</td></tr>
<tr class="separator:a0e389a69ccb4f985b19a8db49082c559"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac4ae46fdbfa5e1c673dd9cac376459fb"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classOnlineUnlockStatus.html#ac4ae46fdbfa5e1c673dd9cac376459fb">~OnlineUnlockStatus</a> ()</td></tr>
<tr class="memdesc:ac4ae46fdbfa5e1c673dd9cac376459fb"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#ac4ae46fdbfa5e1c673dd9cac376459fb">More...</a><br /></td></tr>
<tr class="separator:ac4ae46fdbfa5e1c673dd9cac376459fb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad1bf9fd2ae972550c628ddf3f344a2bb"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classString.html">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOnlineUnlockStatus.html#ad1bf9fd2ae972550c628ddf3f344a2bb">getProductID</a> ()=0</td></tr>
<tr class="memdesc:ad1bf9fd2ae972550c628ddf3f344a2bb"><td class="mdescLeft"> </td><td class="mdescRight">This must return your product's ID, as allocated by the store. <a href="#ad1bf9fd2ae972550c628ddf3f344a2bb">More...</a><br /></td></tr>
<tr class="separator:ad1bf9fd2ae972550c628ddf3f344a2bb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5f69983d5cdc509ec74f12b2441ab47c"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classOnlineUnlockStatus.html#a5f69983d5cdc509ec74f12b2441ab47c">doesProductIDMatch</a> (const <a class="el" href="classString.html">String</a> &returnedIDFromServer)=0</td></tr>
<tr class="memdesc:a5f69983d5cdc509ec74f12b2441ab47c"><td class="mdescLeft"> </td><td class="mdescRight">This must check whether a product ID string that the server returned is OK for unlocking the current app. <a href="#a5f69983d5cdc509ec74f12b2441ab47c">More...</a><br /></td></tr>
<tr class="separator:a5f69983d5cdc509ec74f12b2441ab47c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a679f3ce70571465fb8b842ed8e075252"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classRSAKey.html">RSAKey</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOnlineUnlockStatus.html#a679f3ce70571465fb8b842ed8e075252">getPublicKey</a> ()=0</td></tr>
<tr class="memdesc:a679f3ce70571465fb8b842ed8e075252"><td class="mdescLeft"> </td><td class="mdescRight">This must return the RSA public key for authenticating responses from the server for this app. <a href="#a679f3ce70571465fb8b842ed8e075252">More...</a><br /></td></tr>
<tr class="separator:a679f3ce70571465fb8b842ed8e075252"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a998088faaf321e5eeb2b0b7693c3f01e"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classOnlineUnlockStatus.html#a998088faaf321e5eeb2b0b7693c3f01e">saveState</a> (const <a class="el" href="classString.html">String</a> &)=0</td></tr>
<tr class="memdesc:a998088faaf321e5eeb2b0b7693c3f01e"><td class="mdescLeft"> </td><td class="mdescRight">This method must store the given string somewhere in your app's persistent properties, so it can be retrieved later by <a class="el" href="classOnlineUnlockStatus.html#ae5674cb0770bc8a8720367d69cf74433" title="This method must retrieve the last state that was provided by the saveState method. ">getState()</a>. <a href="#a998088faaf321e5eeb2b0b7693c3f01e">More...</a><br /></td></tr>
<tr class="separator:a998088faaf321e5eeb2b0b7693c3f01e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae5674cb0770bc8a8720367d69cf74433"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classString.html">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOnlineUnlockStatus.html#ae5674cb0770bc8a8720367d69cf74433">getState</a> ()=0</td></tr>
<tr class="memdesc:ae5674cb0770bc8a8720367d69cf74433"><td class="mdescLeft"> </td><td class="mdescRight">This method must retrieve the last state that was provided by the saveState method. <a href="#ae5674cb0770bc8a8720367d69cf74433">More...</a><br /></td></tr>
<tr class="separator:ae5674cb0770bc8a8720367d69cf74433"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a75d83cbbaa653afab4952549f0d02178"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classString.html">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOnlineUnlockStatus.html#a75d83cbbaa653afab4952549f0d02178">getWebsiteName</a> ()=0</td></tr>
<tr class="memdesc:a75d83cbbaa653afab4952549f0d02178"><td class="mdescLeft"> </td><td class="mdescRight">Returns the name of the web-store website, not for communication, but for presenting to the user. <a href="#a75d83cbbaa653afab4952549f0d02178">More...</a><br /></td></tr>
<tr class="separator:a75d83cbbaa653afab4952549f0d02178"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8d92f4a78736b93dc8874aba00bf0170"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classURL.html">URL</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOnlineUnlockStatus.html#a8d92f4a78736b93dc8874aba00bf0170">getServerAuthenticationURL</a> ()=0</td></tr>
<tr class="memdesc:a8d92f4a78736b93dc8874aba00bf0170"><td class="mdescLeft"> </td><td class="mdescRight">Returns the <a class="el" href="classURL.html" title="Represents a URL and has a bunch of useful functions to manipulate it. ">URL</a> of the authentication API. <a href="#a8d92f4a78736b93dc8874aba00bf0170">More...</a><br /></td></tr>
<tr class="separator:a8d92f4a78736b93dc8874aba00bf0170"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a85f7c723e3a402551df7dbcc8d45f951"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classString.html">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOnlineUnlockStatus.html#a85f7c723e3a402551df7dbcc8d45f951">readReplyFromWebserver</a> (const <a class="el" href="classString.html">String</a> &email, const <a class="el" href="classString.html">String</a> &password)=0</td></tr>
<tr class="memdesc:a85f7c723e3a402551df7dbcc8d45f951"><td class="mdescLeft"> </td><td class="mdescRight">Subclasses that talk to a particular web-store will implement this method to contact their webserver and attempt to unlock the current machine for the given username and password. <a href="#a85f7c723e3a402551df7dbcc8d45f951">More...</a><br /></td></tr>
<tr class="separator:a85f7c723e3a402551df7dbcc8d45f951"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad05647b5eb85f60e797d0adb3d03f862"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classStringArray.html">StringArray</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOnlineUnlockStatus.html#ad05647b5eb85f60e797d0adb3d03f862">getLocalMachineIDs</a> ()</td></tr>
<tr class="memdesc:ad05647b5eb85f60e797d0adb3d03f862"><td class="mdescLeft"> </td><td class="mdescRight">Returns a list of strings, any of which should be unique to this physical computer. <a href="#ad05647b5eb85f60e797d0adb3d03f862">More...</a><br /></td></tr>
<tr class="separator:ad05647b5eb85f60e797d0adb3d03f862"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad5b13f8fc564b0540033b614db089169"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classvar.html">var</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOnlineUnlockStatus.html#ad5b13f8fc564b0540033b614db089169">isUnlocked</a> () const</td></tr>
<tr class="memdesc:ad5b13f8fc564b0540033b614db089169"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if the product has been successfully authorised for this machine. <a href="#ad5b13f8fc564b0540033b614db089169">More...</a><br /></td></tr>
<tr class="separator:ad5b13f8fc564b0540033b614db089169"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3a604280c13257166c476b696fea66e1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classTime.html">Time</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOnlineUnlockStatus.html#a3a604280c13257166c476b696fea66e1">getExpiryTime</a> () const</td></tr>
<tr class="memdesc:a3a604280c13257166c476b696fea66e1"><td class="mdescLeft"> </td><td class="mdescRight">Returns the <a class="el" href="classTime.html" title="Holds an absolute date and time. ">Time</a> when the keyfile expires. <a href="#a3a604280c13257166c476b696fea66e1">More...</a><br /></td></tr>
<tr class="separator:a3a604280c13257166c476b696fea66e1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4c0b9c189f1923a017d9f3ffb726dd91"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classOnlineUnlockStatus.html#a4c0b9c189f1923a017d9f3ffb726dd91">setUserEmail</a> (const <a class="el" href="classString.html">String</a> &usernameOrEmail)</td></tr>
<tr class="memdesc:a4c0b9c189f1923a017d9f3ffb726dd91"><td class="mdescLeft"> </td><td class="mdescRight">Optionally allows the app to provide the user's email address if it is known. <a href="#a4c0b9c189f1923a017d9f3ffb726dd91">More...</a><br /></td></tr>
<tr class="separator:a4c0b9c189f1923a017d9f3ffb726dd91"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a86e0ec1b76d194de95c143720efa3a36"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classString.html">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOnlineUnlockStatus.html#a86e0ec1b76d194de95c143720efa3a36">getUserEmail</a> () const</td></tr>
<tr class="memdesc:a86e0ec1b76d194de95c143720efa3a36"><td class="mdescLeft"> </td><td class="mdescRight">Returns the user's email address if known. <a href="#a86e0ec1b76d194de95c143720efa3a36">More...</a><br /></td></tr>
<tr class="separator:a86e0ec1b76d194de95c143720efa3a36"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac0763c3b120f1b173c46dc5611112da3"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classOnlineUnlockStatus.html#ac0763c3b120f1b173c46dc5611112da3">applyKeyFile</a> (<a class="el" href="classString.html">String</a> keyFileContent)</td></tr>
<tr class="memdesc:ac0763c3b120f1b173c46dc5611112da3"><td class="mdescLeft"> </td><td class="mdescRight">Attempts to perform an unlock using a block of key-file data provided. <a href="#ac0763c3b120f1b173c46dc5611112da3">More...</a><br /></td></tr>
<tr class="separator:ac0763c3b120f1b173c46dc5611112da3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae40afa554781a7649645c75c664bba47"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structOnlineUnlockStatus_1_1UnlockResult.html">UnlockResult</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOnlineUnlockStatus.html#ae40afa554781a7649645c75c664bba47">attemptWebserverUnlock</a> (const <a class="el" href="classString.html">String</a> &email, const <a class="el" href="classString.html">String</a> &password)</td></tr>
<tr class="memdesc:ae40afa554781a7649645c75c664bba47"><td class="mdescLeft"> </td><td class="mdescRight">Contacts the webserver and attempts to perform a registration with the given user details. <a href="#ae40afa554781a7649645c75c664bba47">More...</a><br /></td></tr>
<tr class="separator:ae40afa554781a7649645c75c664bba47"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6873d6e37f4b2a85555fb6858fa61f3b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classOnlineUnlockStatus.html#a6873d6e37f4b2a85555fb6858fa61f3b">load</a> ()</td></tr>
<tr class="memdesc:a6873d6e37f4b2a85555fb6858fa61f3b"><td class="mdescLeft"> </td><td class="mdescRight">Attempts to load the status from the state retrieved by <a class="el" href="classOnlineUnlockStatus.html#ae5674cb0770bc8a8720367d69cf74433" title="This method must retrieve the last state that was provided by the saveState method. ">getState()</a>. <a href="#a6873d6e37f4b2a85555fb6858fa61f3b">More...</a><br /></td></tr>
<tr class="separator:a6873d6e37f4b2a85555fb6858fa61f3b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:affe1d380e45dadfb6d83f8fb05aad2ac"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classOnlineUnlockStatus.html#affe1d380e45dadfb6d83f8fb05aad2ac">save</a> ()</td></tr>
<tr class="memdesc:affe1d380e45dadfb6d83f8fb05aad2ac"><td class="mdescLeft"> </td><td class="mdescRight">Triggers a call to saveState which you can use to store the current unlock status in your app's settings. <a href="#affe1d380e45dadfb6d83f8fb05aad2ac">More...</a><br /></td></tr>
<tr class="separator:affe1d380e45dadfb6d83f8fb05aad2ac"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A base class for online unlocking systems. </p>
<p>This class stores information about whether your app has been unlocked for the current machine, and handles communication with a web-store to perform the unlock procedure.</p>
<p>You probably won't ever use this base class directly, but rather a store-specific subclass such as <a class="el" href="classTracktionMarketplaceStatus.html" title="An implementation of the OnlineUnlockStatus class which talks to the Tracktion Marketplace server...">TracktionMarketplaceStatus</a>, which knows how to talk to the particular online store that you're using.</p>
<p>To use it, you create a subclass which implements all the pure virtual methods (see their comments to find out what you'll need to make them do).</p>
<p>Then you can create an instance of your subclass which will hold the registration state. Typically, you'll want to just keep a single instance of the class around for the duration of your app. You can then call its methods to handle the various registration tasks.</p>
<p>Areas of your code that need to know whether the user is registered (e.g. to decide whether a particular feature is available) should call <a class="el" href="classOnlineUnlockStatus.html#ad5b13f8fc564b0540033b614db089169" title="Returns true if the product has been successfully authorised for this machine. ">isUnlocked()</a> to find out.</p>
<p>If you want to create a GUI that allows your users to enter their details and register, see the <a class="el" href="classOnlineUnlockForm.html" title="Acts as a GUI which asks the user for their details, and calls the approriate methods on your OnlineU...">OnlineUnlockForm</a> class.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classOnlineUnlockForm.html" title="Acts as a GUI which asks the user for their details, and calls the approriate methods on your OnlineU...">OnlineUnlockForm</a>, <a class="el" href="classKeyGeneration.html" title="Contains static utilities for generating key-files that can be unlocked by the OnlineUnlockStatus cla...">KeyGeneration</a> </dd></dl>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="a0e389a69ccb4f985b19a8db49082c559"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0e389a69ccb4f985b19a8db49082c559">§ </a></span>OnlineUnlockStatus()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">OnlineUnlockStatus::OnlineUnlockStatus </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ac4ae46fdbfa5e1c673dd9cac376459fb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac4ae46fdbfa5e1c673dd9cac376459fb">§ </a></span>~OnlineUnlockStatus()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual OnlineUnlockStatus::~OnlineUnlockStatus </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Destructor. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="ad1bf9fd2ae972550c628ddf3f344a2bb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad1bf9fd2ae972550c628ddf3f344a2bb">§ </a></span>getProductID()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classString.html">String</a> OnlineUnlockStatus::getProductID </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>This must return your product's ID, as allocated by the store. </p>
</div>
</div>
<a id="a5f69983d5cdc509ec74f12b2441ab47c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5f69983d5cdc509ec74f12b2441ab47c">§ </a></span>doesProductIDMatch()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool OnlineUnlockStatus::doesProductIDMatch </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classString.html">String</a> & </td>
<td class="paramname"><em>returnedIDFromServer</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>This must check whether a product ID string that the server returned is OK for unlocking the current app. </p>
<p>Implemented in <a class="el" href="classTracktionMarketplaceStatus.html#a12de868a27b5657d2c3d65cba5f3ccfc">TracktionMarketplaceStatus</a>.</p>
</div>
</div>
<a id="a679f3ce70571465fb8b842ed8e075252"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a679f3ce70571465fb8b842ed8e075252">§ </a></span>getPublicKey()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classRSAKey.html">RSAKey</a> OnlineUnlockStatus::getPublicKey </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>This must return the RSA public key for authenticating responses from the server for this app. </p>
<p>You can get this key from your marketplace account page. </p>
</div>
</div>
<a id="a998088faaf321e5eeb2b0b7693c3f01e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a998088faaf321e5eeb2b0b7693c3f01e">§ </a></span>saveState()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void OnlineUnlockStatus::saveState </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classString.html">String</a> & </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>This method must store the given string somewhere in your app's persistent properties, so it can be retrieved later by <a class="el" href="classOnlineUnlockStatus.html#ae5674cb0770bc8a8720367d69cf74433" title="This method must retrieve the last state that was provided by the saveState method. ">getState()</a>. </p>
</div>
</div>
<a id="ae5674cb0770bc8a8720367d69cf74433"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae5674cb0770bc8a8720367d69cf74433">§ </a></span>getState()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classString.html">String</a> OnlineUnlockStatus::getState </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>This method must retrieve the last state that was provided by the saveState method. </p>
<p>On first-run, it should just return an empty string. </p>
</div>
</div>
<a id="a75d83cbbaa653afab4952549f0d02178"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a75d83cbbaa653afab4952549f0d02178">§ </a></span>getWebsiteName()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classString.html">String</a> OnlineUnlockStatus::getWebsiteName </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the name of the web-store website, not for communication, but for presenting to the user. </p>
<p>Implemented in <a class="el" href="classTracktionMarketplaceStatus.html#a49d23a8228030bf92db354eb90832023">TracktionMarketplaceStatus</a>.</p>
</div>
</div>
<a id="a8d92f4a78736b93dc8874aba00bf0170"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8d92f4a78736b93dc8874aba00bf0170">§ </a></span>getServerAuthenticationURL()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classURL.html">URL</a> OnlineUnlockStatus::getServerAuthenticationURL </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the <a class="el" href="classURL.html" title="Represents a URL and has a bunch of useful functions to manipulate it. ">URL</a> of the authentication API. </p>
<p>Implemented in <a class="el" href="classTracktionMarketplaceStatus.html#a470dadfb5f524d155506126e45d4aba7">TracktionMarketplaceStatus</a>.</p>
</div>
</div>
<a id="a85f7c723e3a402551df7dbcc8d45f951"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a85f7c723e3a402551df7dbcc8d45f951">§ </a></span>readReplyFromWebserver()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classString.html">String</a> OnlineUnlockStatus::readReplyFromWebserver </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classString.html">String</a> & </td>
<td class="paramname"><em>email</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classString.html">String</a> & </td>
<td class="paramname"><em>password</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Subclasses that talk to a particular web-store will implement this method to contact their webserver and attempt to unlock the current machine for the given username and password. </p>
<p>The return value is the XML text from the server which contains error information and/or the encrypted keyfile. </p>
<p>Implemented in <a class="el" href="classTracktionMarketplaceStatus.html#a00f05162ad6541ae5ee1e0dd5bed6674">TracktionMarketplaceStatus</a>.</p>
</div>
</div>
<a id="ad05647b5eb85f60e797d0adb3d03f862"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad05647b5eb85f60e797d0adb3d03f862">§ </a></span>getLocalMachineIDs()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classStringArray.html">StringArray</a> OnlineUnlockStatus::getLocalMachineIDs </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a list of strings, any of which should be unique to this physical computer. </p>
<p>When testing whether the user is allowed to use the product on this machine, this list of tokens is compared to the ones that were stored on the webserver.</p>
<p>The default implementation of this method will simply call <a class="el" href="structOnlineUnlockStatus_1_1MachineIDUtilities.html#afdd5483bba5e18fbf58a5acb61710eb6" title="This method calculates some machine IDs based on things like network MAC addresses, hard-disk IDs, etc, but if you want, you can overload it to generate your own list of IDs. ">MachineIDUtilities::getLocalMachineIDs()</a>, which provides a default version of this functionality. </p>
</div>
</div>
<a id="ad5b13f8fc564b0540033b614db089169"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad5b13f8fc564b0540033b614db089169">§ </a></span>isUnlocked()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classvar.html">var</a> OnlineUnlockStatus::isUnlocked </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns true if the product has been successfully authorised for this machine. </p>
<p>The reason it returns a variant rather than a bool is just to make it marginally more tedious for crackers to work around. Hopefully if this method gets inlined they'll need to hack all the places where you call it, rather than just the function itself.</p>
<p>Bear in mind that each place where you check this return value will need to be changed by a cracker in order to unlock your app, so the more places you call this method, the more hassle it will be for them to find and crack them all. </p>
</div>
</div>
<a id="a3a604280c13257166c476b696fea66e1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3a604280c13257166c476b696fea66e1">§ </a></span>getExpiryTime()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTime.html">Time</a> OnlineUnlockStatus::getExpiryTime </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the <a class="el" href="classTime.html" title="Holds an absolute date and time. ">Time</a> when the keyfile expires. </p>
<p>If a the key file obtained has an expiry time, isUnlocked will return false and this will return a non-zero time. The interpretation of this is up to your app but could be used for subscription based models or trial periods. </p>
</div>
</div>
<a id="a4c0b9c189f1923a017d9f3ffb726dd91"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4c0b9c189f1923a017d9f3ffb726dd91">§ </a></span>setUserEmail()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void OnlineUnlockStatus::setUserEmail </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classString.html">String</a> & </td>
<td class="paramname"><em>usernameOrEmail</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Optionally allows the app to provide the user's email address if it is known. </p>
<p>You don't need to call this, but if you do it may save the user typing it in. </p>
</div>
</div>
<a id="a86e0ec1b76d194de95c143720efa3a36"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a86e0ec1b76d194de95c143720efa3a36">§ </a></span>getUserEmail()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classString.html">String</a> OnlineUnlockStatus::getUserEmail </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the user's email address if known. </p>
</div>
</div>
<a id="ac0763c3b120f1b173c46dc5611112da3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac0763c3b120f1b173c46dc5611112da3">§ </a></span>applyKeyFile()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool OnlineUnlockStatus::applyKeyFile </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classString.html">String</a> </td>
<td class="paramname"><em>keyFileContent</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Attempts to perform an unlock using a block of key-file data provided. </p>
<p>You may wish to use this as a way of allowing a user to unlock your app by drag-and-dropping a file containing the key data, or by letting them select such a file. This is often needed for allowing registration on machines without internet access. </p>
</div>
</div>
<a id="ae40afa554781a7649645c75c664bba47"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae40afa554781a7649645c75c664bba47">§ </a></span>attemptWebserverUnlock()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structOnlineUnlockStatus_1_1UnlockResult.html">UnlockResult</a> OnlineUnlockStatus::attemptWebserverUnlock </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classString.html">String</a> & </td>
<td class="paramname"><em>email</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classString.html">String</a> & </td>
<td class="paramname"><em>password</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Contacts the webserver and attempts to perform a registration with the given user details. </p>
<p>The return value will either be a success, or a failure with an error message from the server, so you should show this message to your user.</p>
<p>Because this method blocks while it contacts the server, you must run it on a background thread, not on the message thread. For an easier way to create a GUI to do the unlocking, see <a class="el" href="classOnlineUnlockForm.html" title="Acts as a GUI which asks the user for their details, and calls the approriate methods on your OnlineU...">OnlineUnlockForm</a>. </p>
</div>
</div>
<a id="a6873d6e37f4b2a85555fb6858fa61f3b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6873d6e37f4b2a85555fb6858fa61f3b">§ </a></span>load()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void OnlineUnlockStatus::load </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Attempts to load the status from the state retrieved by <a class="el" href="classOnlineUnlockStatus.html#ae5674cb0770bc8a8720367d69cf74433" title="This method must retrieve the last state that was provided by the saveState method. ">getState()</a>. </p>
<p>Call this somewhere in your app's startup code. </p>
</div>
</div>
<a id="affe1d380e45dadfb6d83f8fb05aad2ac"></a>
<h2 class="memtitle"><span class="permalink"><a href="#affe1d380e45dadfb6d83f8fb05aad2ac">§ </a></span>save()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void OnlineUnlockStatus::save </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Triggers a call to saveState which you can use to store the current unlock status in your app's settings. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="juce__OnlineUnlockStatus_8h.html">juce_OnlineUnlockStatus.h</a></li>
</ul>
</div><!-- contents -->
<hr class="footer"/>
<address class="footer"><small>All content © ROLI Ltd.</small></address><br/>
</body>
</html>
|