/usr/share/doc/libjuce/apiref/classURL.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 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 | <!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: URL 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="#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="classURL-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">URL Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Represents a <a class="el" href="classURL.html" title="Represents a URL and has a bunch of useful functions to manipulate it. ">URL</a> and has a bunch of useful functions to manipulate it.
<a href="classURL.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:ab70af307c2f72ca61378b8ace221ff51"><td class="memItemLeft" align="right" valign="top">typedef bool( </td><td class="memItemRight" valign="bottom"><a class="el" href="classURL.html#ab70af307c2f72ca61378b8ace221ff51">OpenStreamProgressCallback</a>) (void *context, int bytesSent, int totalBytes)</td></tr>
<tr class="memdesc:ab70af307c2f72ca61378b8ace221ff51"><td class="mdescLeft"> </td><td class="mdescRight">This callback function can be used by the <a class="el" href="classURL.html#ad86e302c11f45a556e760d43e3292f3f" title="Attempts to open a stream that can read from this URL. ">createInputStream()</a> method. <a href="#ab70af307c2f72ca61378b8ace221ff51">More...</a><br /></td></tr>
<tr class="separator:ab70af307c2f72ca61378b8ace221ff51"><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:ad6ecb93e145465c5b20f2e90f2f1163a"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classURL.html#ad6ecb93e145465c5b20f2e90f2f1163a">URL</a> ()</td></tr>
<tr class="memdesc:ad6ecb93e145465c5b20f2e90f2f1163a"><td class="mdescLeft"> </td><td class="mdescRight">Creates an empty <a class="el" href="classURL.html" title="Represents a URL and has a bunch of useful functions to manipulate it. ">URL</a>. <a href="#ad6ecb93e145465c5b20f2e90f2f1163a">More...</a><br /></td></tr>
<tr class="separator:ad6ecb93e145465c5b20f2e90f2f1163a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa00fab54fc95a6a9a468228150c034d6"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classURL.html#aa00fab54fc95a6a9a468228150c034d6">URL</a> (const <a class="el" href="classString.html">String</a> &url)</td></tr>
<tr class="memdesc:aa00fab54fc95a6a9a468228150c034d6"><td class="mdescLeft"> </td><td class="mdescRight">Creates a <a class="el" href="classURL.html" title="Represents a URL and has a bunch of useful functions to manipulate it. ">URL</a> from a string. <a href="#aa00fab54fc95a6a9a468228150c034d6">More...</a><br /></td></tr>
<tr class="separator:aa00fab54fc95a6a9a468228150c034d6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af069bf0e7621be7f0eec3f1c80f5560a"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classURL.html#af069bf0e7621be7f0eec3f1c80f5560a">URL</a> (const <a class="el" href="classURL.html">URL</a> &other)</td></tr>
<tr class="memdesc:af069bf0e7621be7f0eec3f1c80f5560a"><td class="mdescLeft"> </td><td class="mdescRight">Creates a copy of another <a class="el" href="classURL.html" title="Represents a URL and has a bunch of useful functions to manipulate it. ">URL</a>. <a href="#af069bf0e7621be7f0eec3f1c80f5560a">More...</a><br /></td></tr>
<tr class="separator:af069bf0e7621be7f0eec3f1c80f5560a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a127152050325ba77075f00ee2630c33c"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classURL.html#a127152050325ba77075f00ee2630c33c">~URL</a> ()</td></tr>
<tr class="memdesc:a127152050325ba77075f00ee2630c33c"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#a127152050325ba77075f00ee2630c33c">More...</a><br /></td></tr>
<tr class="separator:a127152050325ba77075f00ee2630c33c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0b7c692abdea0088c065a562559101f2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classURL.html">URL</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classURL.html#a0b7c692abdea0088c065a562559101f2">operator=</a> (const <a class="el" href="classURL.html">URL</a> &other)</td></tr>
<tr class="memdesc:a0b7c692abdea0088c065a562559101f2"><td class="mdescLeft"> </td><td class="mdescRight">Copies this <a class="el" href="classURL.html" title="Represents a URL and has a bunch of useful functions to manipulate it. ">URL</a> from another one. <a href="#a0b7c692abdea0088c065a562559101f2">More...</a><br /></td></tr>
<tr class="separator:a0b7c692abdea0088c065a562559101f2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae11344056f9c41f72d509f377fac7d18"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classURL.html#ae11344056f9c41f72d509f377fac7d18">operator==</a> (const <a class="el" href="classURL.html">URL</a> &) const</td></tr>
<tr class="memdesc:ae11344056f9c41f72d509f377fac7d18"><td class="mdescLeft"> </td><td class="mdescRight">Compares two URLs. <a href="#ae11344056f9c41f72d509f377fac7d18">More...</a><br /></td></tr>
<tr class="separator:ae11344056f9c41f72d509f377fac7d18"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aeefd67d7e998f755fd7dc68839157a10"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classURL.html#aeefd67d7e998f755fd7dc68839157a10">operator!=</a> (const <a class="el" href="classURL.html">URL</a> &) const</td></tr>
<tr class="separator:aeefd67d7e998f755fd7dc68839157a10"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4f8b7e5a18bc152daaad5192c8d0b003"><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="classURL.html#a4f8b7e5a18bc152daaad5192c8d0b003">toString</a> (bool includeGetParameters) const</td></tr>
<tr class="memdesc:a4f8b7e5a18bc152daaad5192c8d0b003"><td class="mdescLeft"> </td><td class="mdescRight">Returns a string version of the <a class="el" href="classURL.html" title="Represents a URL and has a bunch of useful functions to manipulate it. ">URL</a>. <a href="#a4f8b7e5a18bc152daaad5192c8d0b003">More...</a><br /></td></tr>
<tr class="separator:a4f8b7e5a18bc152daaad5192c8d0b003"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2c4969b6498c3323b02977218ca03989"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classURL.html#a2c4969b6498c3323b02977218ca03989">isEmpty</a> () const noexcept</td></tr>
<tr class="memdesc:a2c4969b6498c3323b02977218ca03989"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if the <a class="el" href="classURL.html" title="Represents a URL and has a bunch of useful functions to manipulate it. ">URL</a> is an empty string. <a href="#a2c4969b6498c3323b02977218ca03989">More...</a><br /></td></tr>
<tr class="separator:a2c4969b6498c3323b02977218ca03989"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a39695b32e1c88d2af575fb1b59c595ed"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classURL.html#a39695b32e1c88d2af575fb1b59c595ed">isWellFormed</a> () const</td></tr>
<tr class="memdesc:a39695b32e1c88d2af575fb1b59c595ed"><td class="mdescLeft"> </td><td class="mdescRight">True if it seems to be valid. <a href="#a39695b32e1c88d2af575fb1b59c595ed">More...</a><br /></td></tr>
<tr class="separator:a39695b32e1c88d2af575fb1b59c595ed"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3b08cc42c8f6bd9d3db16eb03d4217a5"><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="classURL.html#a3b08cc42c8f6bd9d3db16eb03d4217a5">getDomain</a> () const</td></tr>
<tr class="memdesc:a3b08cc42c8f6bd9d3db16eb03d4217a5"><td class="mdescLeft"> </td><td class="mdescRight">Returns just the domain part of the <a class="el" href="classURL.html" title="Represents a URL and has a bunch of useful functions to manipulate it. ">URL</a>. <a href="#a3b08cc42c8f6bd9d3db16eb03d4217a5">More...</a><br /></td></tr>
<tr class="separator:a3b08cc42c8f6bd9d3db16eb03d4217a5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8dfc96dd5527805dcacb2382045825e9"><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="classURL.html#a8dfc96dd5527805dcacb2382045825e9">getSubPath</a> () const</td></tr>
<tr class="memdesc:a8dfc96dd5527805dcacb2382045825e9"><td class="mdescLeft"> </td><td class="mdescRight">Returns the path part of the <a class="el" href="classURL.html" title="Represents a URL and has a bunch of useful functions to manipulate it. ">URL</a>. <a href="#a8dfc96dd5527805dcacb2382045825e9">More...</a><br /></td></tr>
<tr class="separator:a8dfc96dd5527805dcacb2382045825e9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa35285ea2c98ec55dcfac86eb29d1188"><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="classURL.html#aa35285ea2c98ec55dcfac86eb29d1188">getScheme</a> () const</td></tr>
<tr class="memdesc:aa35285ea2c98ec55dcfac86eb29d1188"><td class="mdescLeft"> </td><td class="mdescRight">Returns the scheme of the <a class="el" href="classURL.html" title="Represents a URL and has a bunch of useful functions to manipulate it. ">URL</a>. <a href="#aa35285ea2c98ec55dcfac86eb29d1188">More...</a><br /></td></tr>
<tr class="separator:aa35285ea2c98ec55dcfac86eb29d1188"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3adb90bf01d4c97529545f27bc21ab16"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classURL.html#a3adb90bf01d4c97529545f27bc21ab16">getPort</a> () const</td></tr>
<tr class="memdesc:a3adb90bf01d4c97529545f27bc21ab16"><td class="mdescLeft"> </td><td class="mdescRight">Attempts to read a port number from the <a class="el" href="classURL.html" title="Represents a URL and has a bunch of useful functions to manipulate it. ">URL</a>. <a href="#a3adb90bf01d4c97529545f27bc21ab16">More...</a><br /></td></tr>
<tr class="separator:a3adb90bf01d4c97529545f27bc21ab16"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a08e2b52608fa01285e4cef5ae8ab9536"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classURL.html">URL</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classURL.html#a08e2b52608fa01285e4cef5ae8ab9536">withNewDomainAndPath</a> (const <a class="el" href="classString.html">String</a> &newFullPath) const</td></tr>
<tr class="memdesc:a08e2b52608fa01285e4cef5ae8ab9536"><td class="mdescLeft"> </td><td class="mdescRight">Returns a new version of this <a class="el" href="classURL.html" title="Represents a URL and has a bunch of useful functions to manipulate it. ">URL</a> with a different domain and path. <a href="#a08e2b52608fa01285e4cef5ae8ab9536">More...</a><br /></td></tr>
<tr class="separator:a08e2b52608fa01285e4cef5ae8ab9536"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa35ab990d1011795d9a4de9b9f7a4a24"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classURL.html">URL</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classURL.html#aa35ab990d1011795d9a4de9b9f7a4a24">withNewSubPath</a> (const <a class="el" href="classString.html">String</a> &newPath) const</td></tr>
<tr class="memdesc:aa35ab990d1011795d9a4de9b9f7a4a24"><td class="mdescLeft"> </td><td class="mdescRight">Returns a new version of this <a class="el" href="classURL.html" title="Represents a URL and has a bunch of useful functions to manipulate it. ">URL</a> with a different sub-path. <a href="#aa35ab990d1011795d9a4de9b9f7a4a24">More...</a><br /></td></tr>
<tr class="separator:aa35ab990d1011795d9a4de9b9f7a4a24"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad0e7a3f537841e8b40c69e21257ec929"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classURL.html">URL</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classURL.html#ad0e7a3f537841e8b40c69e21257ec929">getChildURL</a> (const <a class="el" href="classString.html">String</a> &subPath) const</td></tr>
<tr class="memdesc:ad0e7a3f537841e8b40c69e21257ec929"><td class="mdescLeft"> </td><td class="mdescRight">Returns a new <a class="el" href="classURL.html" title="Represents a URL and has a bunch of useful functions to manipulate it. ">URL</a> that refers to a sub-path relative to this one. <a href="#ad0e7a3f537841e8b40c69e21257ec929">More...</a><br /></td></tr>
<tr class="separator:ad0e7a3f537841e8b40c69e21257ec929"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6a0091935aa905139328516783288bf9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classURL.html">URL</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classURL.html#a6a0091935aa905139328516783288bf9">withParameter</a> (const <a class="el" href="classString.html">String</a> &parameterName, const <a class="el" href="classString.html">String</a> &parameterValue) const</td></tr>
<tr class="memdesc:a6a0091935aa905139328516783288bf9"><td class="mdescLeft"> </td><td class="mdescRight">Returns a copy of this <a class="el" href="classURL.html" title="Represents a URL and has a bunch of useful functions to manipulate it. ">URL</a>, with a GET or POST parameter added to the end. <a href="#a6a0091935aa905139328516783288bf9">More...</a><br /></td></tr>
<tr class="separator:a6a0091935aa905139328516783288bf9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a54e6339972b23f8750cd7f7eec91c42d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classURL.html">URL</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classURL.html#a54e6339972b23f8750cd7f7eec91c42d">withParameters</a> (const <a class="el" href="classStringPairArray.html">StringPairArray</a> &parametersToAdd) const</td></tr>
<tr class="memdesc:a54e6339972b23f8750cd7f7eec91c42d"><td class="mdescLeft"> </td><td class="mdescRight">Returns a copy of this <a class="el" href="classURL.html" title="Represents a URL and has a bunch of useful functions to manipulate it. ">URL</a>, with a set of GET or POST parameters added. <a href="#a54e6339972b23f8750cd7f7eec91c42d">More...</a><br /></td></tr>
<tr class="separator:a54e6339972b23f8750cd7f7eec91c42d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9fdd22a9c12fa1270de9b9962ffbd6b7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classURL.html">URL</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classURL.html#a9fdd22a9c12fa1270de9b9962ffbd6b7">withFileToUpload</a> (const <a class="el" href="classString.html">String</a> &parameterName, const <a class="el" href="classFile.html">File</a> &fileToUpload, const <a class="el" href="classString.html">String</a> &mimeType) const</td></tr>
<tr class="memdesc:a9fdd22a9c12fa1270de9b9962ffbd6b7"><td class="mdescLeft"> </td><td class="mdescRight">Returns a copy of this <a class="el" href="classURL.html" title="Represents a URL and has a bunch of useful functions to manipulate it. ">URL</a>, with a file-upload type parameter added to it. <a href="#a9fdd22a9c12fa1270de9b9962ffbd6b7">More...</a><br /></td></tr>
<tr class="separator:a9fdd22a9c12fa1270de9b9962ffbd6b7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a91f4af8697bd103f2400b50b4d8a3958"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classURL.html">URL</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classURL.html#a91f4af8697bd103f2400b50b4d8a3958">withDataToUpload</a> (const <a class="el" href="classString.html">String</a> &parameterName, const <a class="el" href="classString.html">String</a> &filename, const <a class="el" href="classMemoryBlock.html">MemoryBlock</a> &fileContentToUpload, const <a class="el" href="classString.html">String</a> &mimeType) const</td></tr>
<tr class="memdesc:a91f4af8697bd103f2400b50b4d8a3958"><td class="mdescLeft"> </td><td class="mdescRight">Returns a copy of this <a class="el" href="classURL.html" title="Represents a URL and has a bunch of useful functions to manipulate it. ">URL</a>, with a file-upload type parameter added to it. <a href="#a91f4af8697bd103f2400b50b4d8a3958">More...</a><br /></td></tr>
<tr class="separator:a91f4af8697bd103f2400b50b4d8a3958"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a10a2d1604d0a3d86381a4b142624c662"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classStringArray.html">StringArray</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classURL.html#a10a2d1604d0a3d86381a4b142624c662">getParameterNames</a> () const noexcept</td></tr>
<tr class="memdesc:a10a2d1604d0a3d86381a4b142624c662"><td class="mdescLeft"> </td><td class="mdescRight">Returns an array of the names of all the <a class="el" href="classURL.html" title="Represents a URL and has a bunch of useful functions to manipulate it. ">URL</a>'s parameters. <a href="#a10a2d1604d0a3d86381a4b142624c662">More...</a><br /></td></tr>
<tr class="separator:a10a2d1604d0a3d86381a4b142624c662"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a61b5ddfaf16fd5ba305c22ccd13ee7ee"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classStringArray.html">StringArray</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classURL.html#a61b5ddfaf16fd5ba305c22ccd13ee7ee">getParameterValues</a> () const noexcept</td></tr>
<tr class="memdesc:a61b5ddfaf16fd5ba305c22ccd13ee7ee"><td class="mdescLeft"> </td><td class="mdescRight">Returns an array of the values of all the <a class="el" href="classURL.html" title="Represents a URL and has a bunch of useful functions to manipulate it. ">URL</a>'s parameters. <a href="#a61b5ddfaf16fd5ba305c22ccd13ee7ee">More...</a><br /></td></tr>
<tr class="separator:a61b5ddfaf16fd5ba305c22ccd13ee7ee"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a424c1066a6e5c978ca7bdfab2a757889"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classURL.html">URL</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classURL.html#a424c1066a6e5c978ca7bdfab2a757889">withPOSTData</a> (const <a class="el" href="classString.html">String</a> &postData) const</td></tr>
<tr class="memdesc:a424c1066a6e5c978ca7bdfab2a757889"><td class="mdescLeft"> </td><td class="mdescRight">Returns a copy of this <a class="el" href="classURL.html" title="Represents a URL and has a bunch of useful functions to manipulate it. ">URL</a>, with a block of data to send as the POST data. <a href="#a424c1066a6e5c978ca7bdfab2a757889">More...</a><br /></td></tr>
<tr class="separator:a424c1066a6e5c978ca7bdfab2a757889"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abbda16851f170d9093ded242f7fdd00f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classURL.html">URL</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classURL.html#abbda16851f170d9093ded242f7fdd00f">withPOSTData</a> (const <a class="el" href="classMemoryBlock.html">MemoryBlock</a> &postData) const</td></tr>
<tr class="memdesc:abbda16851f170d9093ded242f7fdd00f"><td class="mdescLeft"> </td><td class="mdescRight">Returns a copy of this <a class="el" href="classURL.html" title="Represents a URL and has a bunch of useful functions to manipulate it. ">URL</a>, with a block of data to send as the POST data. <a href="#abbda16851f170d9093ded242f7fdd00f">More...</a><br /></td></tr>
<tr class="separator:abbda16851f170d9093ded242f7fdd00f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2c57f1efe99673bf051999f41bc4ef74"><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="classURL.html#a2c57f1efe99673bf051999f41bc4ef74">getPostData</a> () const noexcept</td></tr>
<tr class="memdesc:a2c57f1efe99673bf051999f41bc4ef74"><td class="mdescLeft"> </td><td class="mdescRight">Returns the data that was set using <a class="el" href="classURL.html#a424c1066a6e5c978ca7bdfab2a757889" title="Returns a copy of this URL, with a block of data to send as the POST data. ">withPOSTData()</a>. <a href="#a2c57f1efe99673bf051999f41bc4ef74">More...</a><br /></td></tr>
<tr class="separator:a2c57f1efe99673bf051999f41bc4ef74"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6df9b7070b2b92fe20371d649b87d6c7"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classMemoryBlock.html">MemoryBlock</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classURL.html#a6df9b7070b2b92fe20371d649b87d6c7">getPostDataAsMemoryBlock</a> () const noexcept</td></tr>
<tr class="memdesc:a6df9b7070b2b92fe20371d649b87d6c7"><td class="mdescLeft"> </td><td class="mdescRight">Returns the data that was set using <a class="el" href="classURL.html#a424c1066a6e5c978ca7bdfab2a757889" title="Returns a copy of this URL, with a block of data to send as the POST data. ">withPOSTData()</a> as <a class="el" href="classMemoryBlock.html" title="A class to hold a resizable block of raw data. ">MemoryBlock</a>. <a href="#a6df9b7070b2b92fe20371d649b87d6c7">More...</a><br /></td></tr>
<tr class="separator:a6df9b7070b2b92fe20371d649b87d6c7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2e0faa22cab2447d64c8ac0d01bdccda"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classURL.html#a2e0faa22cab2447d64c8ac0d01bdccda">launchInDefaultBrowser</a> () const</td></tr>
<tr class="memdesc:a2e0faa22cab2447d64c8ac0d01bdccda"><td class="mdescLeft"> </td><td class="mdescRight">Tries to launch the system's default browser to open the <a class="el" href="classURL.html" title="Represents a URL and has a bunch of useful functions to manipulate it. ">URL</a>. <a href="#a2e0faa22cab2447d64c8ac0d01bdccda">More...</a><br /></td></tr>
<tr class="separator:a2e0faa22cab2447d64c8ac0d01bdccda"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad86e302c11f45a556e760d43e3292f3f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classInputStream.html">InputStream</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classURL.html#ad86e302c11f45a556e760d43e3292f3f">createInputStream</a> (bool doPostLikeRequest, <a class="el" href="classURL.html#ab70af307c2f72ca61378b8ace221ff51">OpenStreamProgressCallback</a> *progressCallback=nullptr, void *progressCallbackContext=nullptr, <a class="el" href="classString.html">String</a> extraHeaders=<a class="el" href="classString.html">String</a>(), int connectionTimeOutMs=0, <a class="el" href="classStringPairArray.html">StringPairArray</a> *responseHeaders=nullptr, int *statusCode=nullptr, int numRedirectsToFollow=5, <a class="el" href="classString.html">String</a> httpRequestCmd=<a class="el" href="classString.html">String</a>()) const</td></tr>
<tr class="memdesc:ad86e302c11f45a556e760d43e3292f3f"><td class="mdescLeft"> </td><td class="mdescRight">Attempts to open a stream that can read from this <a class="el" href="classURL.html" title="Represents a URL and has a bunch of useful functions to manipulate it. ">URL</a>. <a href="#ad86e302c11f45a556e760d43e3292f3f">More...</a><br /></td></tr>
<tr class="separator:ad86e302c11f45a556e760d43e3292f3f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae80831fe2f20790ca491d27eef884b46"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classURL.html#ae80831fe2f20790ca491d27eef884b46">readEntireBinaryStream</a> (<a class="el" href="classMemoryBlock.html">MemoryBlock</a> &destData, bool usePostCommand=false) const</td></tr>
<tr class="memdesc:ae80831fe2f20790ca491d27eef884b46"><td class="mdescLeft"> </td><td class="mdescRight">Tries to download the entire contents of this <a class="el" href="classURL.html" title="Represents a URL and has a bunch of useful functions to manipulate it. ">URL</a> into a binary data block. <a href="#ae80831fe2f20790ca491d27eef884b46">More...</a><br /></td></tr>
<tr class="separator:ae80831fe2f20790ca491d27eef884b46"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0f860c4986e9e67f54ffb7cfb7c1062d"><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="classURL.html#a0f860c4986e9e67f54ffb7cfb7c1062d">readEntireTextStream</a> (bool usePostCommand=false) const</td></tr>
<tr class="memdesc:a0f860c4986e9e67f54ffb7cfb7c1062d"><td class="mdescLeft"> </td><td class="mdescRight">Tries to download the entire contents of this <a class="el" href="classURL.html" title="Represents a URL and has a bunch of useful functions to manipulate it. ">URL</a> as a string. <a href="#a0f860c4986e9e67f54ffb7cfb7c1062d">More...</a><br /></td></tr>
<tr class="separator:a0f860c4986e9e67f54ffb7cfb7c1062d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aff3ee88e646fa0bf0602613c6b93e2fa"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classXmlElement.html">XmlElement</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classURL.html#aff3ee88e646fa0bf0602613c6b93e2fa">readEntireXmlStream</a> (bool usePostCommand=false) const</td></tr>
<tr class="memdesc:aff3ee88e646fa0bf0602613c6b93e2fa"><td class="mdescLeft"> </td><td class="mdescRight">Tries to download the entire contents of this <a class="el" href="classURL.html" title="Represents a URL and has a bunch of useful functions to manipulate it. ">URL</a> and parse it as XML. <a href="#aff3ee88e646fa0bf0602613c6b93e2fa">More...</a><br /></td></tr>
<tr class="separator:aff3ee88e646fa0bf0602613c6b93e2fa"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a99df56e20fd9bf9426538571eaa06909"><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classURL.html#a99df56e20fd9bf9426538571eaa06909">isProbablyAWebsiteURL</a> (const <a class="el" href="classString.html">String</a> &possibleURL)</td></tr>
<tr class="memdesc:a99df56e20fd9bf9426538571eaa06909"><td class="mdescLeft"> </td><td class="mdescRight">Takes a guess as to whether a string might be a valid website address. <a href="#a99df56e20fd9bf9426538571eaa06909">More...</a><br /></td></tr>
<tr class="separator:a99df56e20fd9bf9426538571eaa06909"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a104e0a0539ab797a3057b19b8c531503"><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classURL.html#a104e0a0539ab797a3057b19b8c531503">isProbablyAnEmailAddress</a> (const <a class="el" href="classString.html">String</a> &possibleEmailAddress)</td></tr>
<tr class="memdesc:a104e0a0539ab797a3057b19b8c531503"><td class="mdescLeft"> </td><td class="mdescRight">Takes a guess as to whether a string might be a valid email address. <a href="#a104e0a0539ab797a3057b19b8c531503">More...</a><br /></td></tr>
<tr class="separator:a104e0a0539ab797a3057b19b8c531503"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad2a5f3808099305c73c84112a01ecb1d"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classString.html">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classURL.html#ad2a5f3808099305c73c84112a01ecb1d">addEscapeChars</a> (const <a class="el" href="classString.html">String</a> &stringToAddEscapeCharsTo, bool isParameter, bool roundBracketsAreLegal=true)</td></tr>
<tr class="memdesc:ad2a5f3808099305c73c84112a01ecb1d"><td class="mdescLeft"> </td><td class="mdescRight">Adds escape sequences to a string to encode any characters that aren't legal in a <a class="el" href="classURL.html" title="Represents a URL and has a bunch of useful functions to manipulate it. ">URL</a>. <a href="#ad2a5f3808099305c73c84112a01ecb1d">More...</a><br /></td></tr>
<tr class="separator:ad2a5f3808099305c73c84112a01ecb1d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:add07acc3e33e34097c2e93447f6fd0f9"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classString.html">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classURL.html#add07acc3e33e34097c2e93447f6fd0f9">removeEscapeChars</a> (const <a class="el" href="classString.html">String</a> &stringToRemoveEscapeCharsFrom)</td></tr>
<tr class="memdesc:add07acc3e33e34097c2e93447f6fd0f9"><td class="mdescLeft"> </td><td class="mdescRight">Replaces any escape character sequences in a string with their original character codes. <a href="#add07acc3e33e34097c2e93447f6fd0f9">More...</a><br /></td></tr>
<tr class="separator:add07acc3e33e34097c2e93447f6fd0f9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9a8a3e4344e94b6d074df5f7223f9c77"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classURL.html">URL</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classURL.html#a9a8a3e4344e94b6d074df5f7223f9c77">createWithoutParsing</a> (const <a class="el" href="classString.html">String</a> &url)</td></tr>
<tr class="memdesc:a9a8a3e4344e94b6d074df5f7223f9c77"><td class="mdescLeft"> </td><td class="mdescRight">Returns a <a class="el" href="classURL.html" title="Represents a URL and has a bunch of useful functions to manipulate it. ">URL</a> without attempting to remove any embedded parameters from the string. <a href="#a9a8a3e4344e94b6d074df5f7223f9c77">More...</a><br /></td></tr>
<tr class="separator:a9a8a3e4344e94b6d074df5f7223f9c77"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Represents a <a class="el" href="classURL.html" title="Represents a URL and has a bunch of useful functions to manipulate it. ">URL</a> and has a bunch of useful functions to manipulate it. </p>
<p>This class can be used to launch URLs in browsers, and also to create InputStreams that can read from remote http or ftp sources. </p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a id="ab70af307c2f72ca61378b8ace221ff51"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab70af307c2f72ca61378b8ace221ff51">§ </a></span>OpenStreamProgressCallback</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef bool( URL::OpenStreamProgressCallback) (void *context, int bytesSent, int totalBytes)</td>
</tr>
</table>
</div><div class="memdoc">
<p>This callback function can be used by the <a class="el" href="classURL.html#ad86e302c11f45a556e760d43e3292f3f" title="Attempts to open a stream that can read from this URL. ">createInputStream()</a> method. </p>
<p>It allows your app to receive progress updates during a lengthy POST operation. If you want to continue the operation, this should return true, or false to abort. </p>
</div>
</div>
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="ad6ecb93e145465c5b20f2e90f2f1163a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad6ecb93e145465c5b20f2e90f2f1163a">§ </a></span>URL() <span class="overload">[1/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">URL::URL </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates an empty <a class="el" href="classURL.html" title="Represents a URL and has a bunch of useful functions to manipulate it. ">URL</a>. </p>
</div>
</div>
<a id="aa00fab54fc95a6a9a468228150c034d6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa00fab54fc95a6a9a468228150c034d6">§ </a></span>URL() <span class="overload">[2/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">URL::URL </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classString.html">String</a> & </td>
<td class="paramname"><em>url</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a <a class="el" href="classURL.html" title="Represents a URL and has a bunch of useful functions to manipulate it. ">URL</a> from a string. </p>
<p>This will parse any embedded parameters after a '?' character and store them in the list (see getParameterNames etc). If you don't want this to happen, you can use <a class="el" href="classURL.html#a9a8a3e4344e94b6d074df5f7223f9c77" title="Returns a URL without attempting to remove any embedded parameters from the string. ">createWithoutParsing()</a>. </p>
</div>
</div>
<a id="af069bf0e7621be7f0eec3f1c80f5560a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af069bf0e7621be7f0eec3f1c80f5560a">§ </a></span>URL() <span class="overload">[3/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">URL::URL </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classURL.html">URL</a> & </td>
<td class="paramname"><em>other</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a copy of another <a class="el" href="classURL.html" title="Represents a URL and has a bunch of useful functions to manipulate it. ">URL</a>. </p>
</div>
</div>
<a id="a127152050325ba77075f00ee2630c33c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a127152050325ba77075f00ee2630c33c">§ </a></span>~URL()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">URL::~URL </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Destructor. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a0b7c692abdea0088c065a562559101f2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0b7c692abdea0088c065a562559101f2">§ </a></span>operator=()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classURL.html">URL</a>& URL::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classURL.html">URL</a> & </td>
<td class="paramname"><em>other</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Copies this <a class="el" href="classURL.html" title="Represents a URL and has a bunch of useful functions to manipulate it. ">URL</a> from another one. </p>
</div>
</div>
<a id="ae11344056f9c41f72d509f377fac7d18"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae11344056f9c41f72d509f377fac7d18">§ </a></span>operator==()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool URL::operator== </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classURL.html">URL</a> & </td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Compares two URLs. </p>
<p>All aspects of the URLs must be identical for them to match, including any parameters, upload files, etc. </p>
</div>
</div>
<a id="aeefd67d7e998f755fd7dc68839157a10"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aeefd67d7e998f755fd7dc68839157a10">§ </a></span>operator!=()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool URL::operator!= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classURL.html">URL</a> & </td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a4f8b7e5a18bc152daaad5192c8d0b003"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4f8b7e5a18bc152daaad5192c8d0b003">§ </a></span>toString()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classString.html">String</a> URL::toString </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>includeGetParameters</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a string version of the <a class="el" href="classURL.html" title="Represents a URL and has a bunch of useful functions to manipulate it. ">URL</a>. </p>
<p>If includeGetParameters is true and any parameters have been set with the <a class="el" href="classURL.html#a6a0091935aa905139328516783288bf9" title="Returns a copy of this URL, with a GET or POST parameter added to the end. ">withParameter()</a> method, then the string will have these appended on the end and url-encoded. </p>
</div>
</div>
<a id="a2c4969b6498c3323b02977218ca03989"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2c4969b6498c3323b02977218ca03989">§ </a></span>isEmpty()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool URL::isEmpty </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns true if the <a class="el" href="classURL.html" title="Represents a URL and has a bunch of useful functions to manipulate it. ">URL</a> is an empty string. </p>
</div>
</div>
<a id="a39695b32e1c88d2af575fb1b59c595ed"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a39695b32e1c88d2af575fb1b59c595ed">§ </a></span>isWellFormed()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool URL::isWellFormed </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>True if it seems to be valid. </p>
</div>
</div>
<a id="a3b08cc42c8f6bd9d3db16eb03d4217a5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3b08cc42c8f6bd9d3db16eb03d4217a5">§ </a></span>getDomain()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classString.html">String</a> URL::getDomain </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns just the domain part of the <a class="el" href="classURL.html" title="Represents a URL and has a bunch of useful functions to manipulate it. ">URL</a>. </p>
<p>E.g. for "http://www.xyz.com/foobar", this will return "www.xyz.com". </p>
</div>
</div>
<a id="a8dfc96dd5527805dcacb2382045825e9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8dfc96dd5527805dcacb2382045825e9">§ </a></span>getSubPath()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classString.html">String</a> URL::getSubPath </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the path part of the <a class="el" href="classURL.html" title="Represents a URL and has a bunch of useful functions to manipulate it. ">URL</a>. </p>
<p>E.g. for "http://www.xyz.com/foo/bar?x=1", this will return "foo/bar". </p>
</div>
</div>
<a id="aa35285ea2c98ec55dcfac86eb29d1188"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa35285ea2c98ec55dcfac86eb29d1188">§ </a></span>getScheme()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classString.html">String</a> URL::getScheme </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the scheme of the <a class="el" href="classURL.html" title="Represents a URL and has a bunch of useful functions to manipulate it. ">URL</a>. </p>
<p>E.g. for "http://www.xyz.com/foobar", this will return "http". (It won't include the colon). </p>
</div>
</div>
<a id="a3adb90bf01d4c97529545f27bc21ab16"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3adb90bf01d4c97529545f27bc21ab16">§ </a></span>getPort()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int URL::getPort </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Attempts to read a port number from the <a class="el" href="classURL.html" title="Represents a URL and has a bunch of useful functions to manipulate it. ">URL</a>. </p>
<dl class="section return"><dt>Returns</dt><dd>the port number, or 0 if none is explicitly specified. </dd></dl>
</div>
</div>
<a id="a08e2b52608fa01285e4cef5ae8ab9536"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a08e2b52608fa01285e4cef5ae8ab9536">§ </a></span>withNewDomainAndPath()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classURL.html">URL</a> URL::withNewDomainAndPath </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classString.html">String</a> & </td>
<td class="paramname"><em>newFullPath</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a new version of this <a class="el" href="classURL.html" title="Represents a URL and has a bunch of useful functions to manipulate it. ">URL</a> with a different domain and path. </p>
<p>E.g. if the <a class="el" href="classURL.html" title="Represents a URL and has a bunch of useful functions to manipulate it. ">URL</a> is "http://www.xyz.com/foo?x=1" and you call this with "abc.com/zzz", it'll return "http://abc.com/zzz?x=1". </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="classURL.html#aa35ab990d1011795d9a4de9b9f7a4a24" title="Returns a new version of this URL with a different sub-path. ">withNewSubPath</a> </dd></dl>
</div>
</div>
<a id="aa35ab990d1011795d9a4de9b9f7a4a24"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa35ab990d1011795d9a4de9b9f7a4a24">§ </a></span>withNewSubPath()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classURL.html">URL</a> URL::withNewSubPath </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classString.html">String</a> & </td>
<td class="paramname"><em>newPath</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a new version of this <a class="el" href="classURL.html" title="Represents a URL and has a bunch of useful functions to manipulate it. ">URL</a> with a different sub-path. </p>
<p>E.g. if the <a class="el" href="classURL.html" title="Represents a URL and has a bunch of useful functions to manipulate it. ">URL</a> is "http://www.xyz.com/foo?x=1" and you call this with "bar", it'll return "http://www.xyz.com/bar?x=1". </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="classURL.html#a08e2b52608fa01285e4cef5ae8ab9536" title="Returns a new version of this URL with a different domain and path. ">withNewDomainAndPath</a> </dd></dl>
</div>
</div>
<a id="ad0e7a3f537841e8b40c69e21257ec929"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad0e7a3f537841e8b40c69e21257ec929">§ </a></span>getChildURL()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classURL.html">URL</a> URL::getChildURL </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classString.html">String</a> & </td>
<td class="paramname"><em>subPath</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a new <a class="el" href="classURL.html" title="Represents a URL and has a bunch of useful functions to manipulate it. ">URL</a> that refers to a sub-path relative to this one. </p>
<p>E.g. if the <a class="el" href="classURL.html" title="Represents a URL and has a bunch of useful functions to manipulate it. ">URL</a> is "http://www.xyz.com/foo" and you call this with "bar", it'll return "http://www.xyz.com/foo/bar". Note that there's no way for this method to know whether the original <a class="el" href="classURL.html" title="Represents a URL and has a bunch of useful functions to manipulate it. ">URL</a> is a file or directory, so it's up to you to make sure it's a directory. It also won't attempt to be smart about the content of the childPath string, so if this string is an absolute <a class="el" href="classURL.html" title="Represents a URL and has a bunch of useful functions to manipulate it. ">URL</a>, it'll still just get bolted onto the end of the path.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classFile.html#a087bb8f0a60069234b13ab965fb5014a" title="Returns a file that represents a relative (or absolute) sub-path of the current one. ">File::getChildFile</a> </dd></dl>
</div>
</div>
<a id="a6a0091935aa905139328516783288bf9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6a0091935aa905139328516783288bf9">§ </a></span>withParameter()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classURL.html">URL</a> URL::withParameter </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classString.html">String</a> & </td>
<td class="paramname"><em>parameterName</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>parameterValue</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a copy of this <a class="el" href="classURL.html" title="Represents a URL and has a bunch of useful functions to manipulate it. ">URL</a>, with a GET or POST parameter added to the end. </p>
<p>Any control characters in the value will be encoded.</p>
<p>e.g. calling "withParameter ("amount", "some fish") for the url "www.fish.com" would produce a new url whose toString(true) method would return "www.fish.com?amount=some+fish".</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classURL.html#a10a2d1604d0a3d86381a4b142624c662" title="Returns an array of the names of all the URL's parameters. ">getParameterNames</a>, <a class="el" href="classURL.html#a61b5ddfaf16fd5ba305c22ccd13ee7ee" title="Returns an array of the values of all the URL's parameters. ">getParameterValues</a> </dd></dl>
</div>
</div>
<a id="a54e6339972b23f8750cd7f7eec91c42d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a54e6339972b23f8750cd7f7eec91c42d">§ </a></span>withParameters()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classURL.html">URL</a> URL::withParameters </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classStringPairArray.html">StringPairArray</a> & </td>
<td class="paramname"><em>parametersToAdd</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a copy of this <a class="el" href="classURL.html" title="Represents a URL and has a bunch of useful functions to manipulate it. ">URL</a>, with a set of GET or POST parameters added. </p>
<p>This is a convenience method, equivalent to calling withParameter for each value. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="classURL.html#a6a0091935aa905139328516783288bf9" title="Returns a copy of this URL, with a GET or POST parameter added to the end. ">withParameter</a> </dd></dl>
</div>
</div>
<a id="a9fdd22a9c12fa1270de9b9962ffbd6b7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9fdd22a9c12fa1270de9b9962ffbd6b7">§ </a></span>withFileToUpload()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classURL.html">URL</a> URL::withFileToUpload </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classString.html">String</a> & </td>
<td class="paramname"><em>parameterName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classFile.html">File</a> & </td>
<td class="paramname"><em>fileToUpload</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>mimeType</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a copy of this <a class="el" href="classURL.html" title="Represents a URL and has a bunch of useful functions to manipulate it. ">URL</a>, with a file-upload type parameter added to it. </p>
<p>When performing a POST where one of your parameters is a binary file, this lets you specify the file.</p>
<p>Note that the filename is stored, but the file itself won't actually be read until this <a class="el" href="classURL.html" title="Represents a URL and has a bunch of useful functions to manipulate it. ">URL</a> is later used to create a network input stream. If you want to upload data from memory, use <a class="el" href="classURL.html#a91f4af8697bd103f2400b50b4d8a3958" title="Returns a copy of this URL, with a file-upload type parameter added to it. ">withDataToUpload()</a>.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classURL.html#a91f4af8697bd103f2400b50b4d8a3958" title="Returns a copy of this URL, with a file-upload type parameter added to it. ">withDataToUpload</a> </dd></dl>
</div>
</div>
<a id="a91f4af8697bd103f2400b50b4d8a3958"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a91f4af8697bd103f2400b50b4d8a3958">§ </a></span>withDataToUpload()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classURL.html">URL</a> URL::withDataToUpload </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classString.html">String</a> & </td>
<td class="paramname"><em>parameterName</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>filename</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classMemoryBlock.html">MemoryBlock</a> & </td>
<td class="paramname"><em>fileContentToUpload</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>mimeType</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a copy of this <a class="el" href="classURL.html" title="Represents a URL and has a bunch of useful functions to manipulate it. ">URL</a>, with a file-upload type parameter added to it. </p>
<p>When performing a POST where one of your parameters is a binary file, this lets you specify the file content. Note that the filename parameter should not be a full path, it's just the last part of the filename.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classURL.html#a9fdd22a9c12fa1270de9b9962ffbd6b7" title="Returns a copy of this URL, with a file-upload type parameter added to it. ">withFileToUpload</a> </dd></dl>
</div>
</div>
<a id="a10a2d1604d0a3d86381a4b142624c662"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a10a2d1604d0a3d86381a4b142624c662">§ </a></span>getParameterNames()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classStringArray.html">StringArray</a>& URL::getParameterNames </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns an array of the names of all the <a class="el" href="classURL.html" title="Represents a URL and has a bunch of useful functions to manipulate it. ">URL</a>'s parameters. </p>
<p>E.g. for the url "www.fish.com?type=haddock&amount=some+fish", this array would contain two items: "type" and "amount".</p>
<p>You can call <a class="el" href="classURL.html#a61b5ddfaf16fd5ba305c22ccd13ee7ee" title="Returns an array of the values of all the URL's parameters. ">getParameterValues()</a> to get the corresponding value of each parameter. Note that the list can contain multiple parameters with the same name.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classURL.html#a61b5ddfaf16fd5ba305c22ccd13ee7ee" title="Returns an array of the values of all the URL's parameters. ">getParameterValues</a>, <a class="el" href="classURL.html#a6a0091935aa905139328516783288bf9" title="Returns a copy of this URL, with a GET or POST parameter added to the end. ">withParameter</a> </dd></dl>
</div>
</div>
<a id="a61b5ddfaf16fd5ba305c22ccd13ee7ee"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a61b5ddfaf16fd5ba305c22ccd13ee7ee">§ </a></span>getParameterValues()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classStringArray.html">StringArray</a>& URL::getParameterValues </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns an array of the values of all the <a class="el" href="classURL.html" title="Represents a URL and has a bunch of useful functions to manipulate it. ">URL</a>'s parameters. </p>
<p>E.g. for the url "www.fish.com?type=haddock&amount=some+fish", this array would contain two items: "haddock" and "some fish".</p>
<p>The values returned will have been cleaned up to remove any escape characters.</p>
<p>You can call <a class="el" href="classURL.html#a10a2d1604d0a3d86381a4b142624c662" title="Returns an array of the names of all the URL's parameters. ">getParameterNames()</a> to get the corresponding name of each parameter. Note that the list can contain multiple parameters with the same name.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classURL.html#a10a2d1604d0a3d86381a4b142624c662" title="Returns an array of the names of all the URL's parameters. ">getParameterNames</a>, <a class="el" href="classURL.html#a6a0091935aa905139328516783288bf9" title="Returns a copy of this URL, with a GET or POST parameter added to the end. ">withParameter</a> </dd></dl>
</div>
</div>
<a id="a424c1066a6e5c978ca7bdfab2a757889"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a424c1066a6e5c978ca7bdfab2a757889">§ </a></span>withPOSTData() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classURL.html">URL</a> URL::withPOSTData </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classString.html">String</a> & </td>
<td class="paramname"><em>postData</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a copy of this <a class="el" href="classURL.html" title="Represents a URL and has a bunch of useful functions to manipulate it. ">URL</a>, with a block of data to send as the POST data. </p>
<p>If you're setting the POST data, be careful not to have any parameters set as well, otherwise it'll all get thrown in together, and might not have the desired effect.</p>
<p>If the <a class="el" href="classURL.html" title="Represents a URL and has a bunch of useful functions to manipulate it. ">URL</a> already contains some POST data, this will replace it, rather than being appended to it.</p>
<p>This data will only be used if you specify a post operation when you call <a class="el" href="classURL.html#ad86e302c11f45a556e760d43e3292f3f" title="Attempts to open a stream that can read from this URL. ">createInputStream()</a>. </p>
</div>
</div>
<a id="abbda16851f170d9093ded242f7fdd00f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abbda16851f170d9093ded242f7fdd00f">§ </a></span>withPOSTData() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classURL.html">URL</a> URL::withPOSTData </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classMemoryBlock.html">MemoryBlock</a> & </td>
<td class="paramname"><em>postData</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a copy of this <a class="el" href="classURL.html" title="Represents a URL and has a bunch of useful functions to manipulate it. ">URL</a>, with a block of data to send as the POST data. </p>
<p>If you're setting the POST data, be careful not to have any parameters set as well, otherwise it'll all get thrown in together, and might not have the desired effect.</p>
<p>If the <a class="el" href="classURL.html" title="Represents a URL and has a bunch of useful functions to manipulate it. ">URL</a> already contains some POST data, this will replace it, rather than being appended to it.</p>
<p>This data will only be used if you specify a post operation when you call <a class="el" href="classURL.html#ad86e302c11f45a556e760d43e3292f3f" title="Attempts to open a stream that can read from this URL. ">createInputStream()</a>. </p>
</div>
</div>
<a id="a2c57f1efe99673bf051999f41bc4ef74"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2c57f1efe99673bf051999f41bc4ef74">§ </a></span>getPostData()</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="classString.html">String</a> URL::getPostData </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the data that was set using <a class="el" href="classURL.html#a424c1066a6e5c978ca7bdfab2a757889" title="Returns a copy of this URL, with a block of data to send as the POST data. ">withPOSTData()</a>. </p>
<p>References <a class="el" href="classMemoryBlock.html#a77c0a3fcaf358311744d0998ab0e7b1b">MemoryBlock::toString()</a>.</p>
</div>
</div>
<a id="a6df9b7070b2b92fe20371d649b87d6c7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6df9b7070b2b92fe20371d649b87d6c7">§ </a></span>getPostDataAsMemoryBlock()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classMemoryBlock.html">MemoryBlock</a>& URL::getPostDataAsMemoryBlock </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the data that was set using <a class="el" href="classURL.html#a424c1066a6e5c978ca7bdfab2a757889" title="Returns a copy of this URL, with a block of data to send as the POST data. ">withPOSTData()</a> as <a class="el" href="classMemoryBlock.html" title="A class to hold a resizable block of raw data. ">MemoryBlock</a>. </p>
</div>
</div>
<a id="a2e0faa22cab2447d64c8ac0d01bdccda"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2e0faa22cab2447d64c8ac0d01bdccda">§ </a></span>launchInDefaultBrowser()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool URL::launchInDefaultBrowser </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Tries to launch the system's default browser to open the <a class="el" href="classURL.html" title="Represents a URL and has a bunch of useful functions to manipulate it. ">URL</a>. </p>
<p>Returns true if this seems to have worked. </p>
</div>
</div>
<a id="a99df56e20fd9bf9426538571eaa06909"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a99df56e20fd9bf9426538571eaa06909">§ </a></span>isProbablyAWebsiteURL()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static bool URL::isProbablyAWebsiteURL </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classString.html">String</a> & </td>
<td class="paramname"><em>possibleURL</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Takes a guess as to whether a string might be a valid website address. </p>
<p>This isn't foolproof! </p>
</div>
</div>
<a id="a104e0a0539ab797a3057b19b8c531503"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a104e0a0539ab797a3057b19b8c531503">§ </a></span>isProbablyAnEmailAddress()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static bool URL::isProbablyAnEmailAddress </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classString.html">String</a> & </td>
<td class="paramname"><em>possibleEmailAddress</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Takes a guess as to whether a string might be a valid email address. </p>
<p>This isn't foolproof! </p>
</div>
</div>
<a id="ad86e302c11f45a556e760d43e3292f3f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad86e302c11f45a556e760d43e3292f3f">§ </a></span>createInputStream()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classInputStream.html">InputStream</a>* URL::createInputStream </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>doPostLikeRequest</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classURL.html#ab70af307c2f72ca61378b8ace221ff51">OpenStreamProgressCallback</a> * </td>
<td class="paramname"><em>progressCallback</em> = <code>nullptr</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>progressCallbackContext</em> = <code>nullptr</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classString.html">String</a> </td>
<td class="paramname"><em>extraHeaders</em> = <code><a class="el" href="classString.html">String</a>()</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>connectionTimeOutMs</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classStringPairArray.html">StringPairArray</a> * </td>
<td class="paramname"><em>responseHeaders</em> = <code>nullptr</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int * </td>
<td class="paramname"><em>statusCode</em> = <code>nullptr</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>numRedirectsToFollow</em> = <code>5</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classString.html">String</a> </td>
<td class="paramname"><em>httpRequestCmd</em> = <code><a class="el" href="classString.html">String</a>()</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Attempts to open a stream that can read from this <a class="el" href="classURL.html" title="Represents a URL and has a bunch of useful functions to manipulate it. ">URL</a>. </p>
<p>Note that on some platforms (Android, for example) it's not permitted to do any network action from the message thread, so you must only call it from a background thread.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">doPostLikeRequest</td><td>if true, the parameters added to this class will be transferred via the HTTP headers which is typical for POST requests. Otherwise the parameters will be added to the <a class="el" href="classURL.html" title="Represents a URL and has a bunch of useful functions to manipulate it. ">URL</a> address. Additionally, if the parameter httpRequestCmd is not specified (or empty) then this parameter will determine which HTTP request command will be used (POST or GET). </td></tr>
<tr><td class="paramname">progressCallback</td><td>if this is not a nullptr, it lets you supply a callback function to keep track of the operation's progress. This can be useful for lengthy POST operations, so that you can provide user feedback. </td></tr>
<tr><td class="paramname">progressCallbackContext</td><td>if a callback is specified, this value will be passed to the function </td></tr>
<tr><td class="paramname">extraHeaders</td><td>if not empty, this string is appended onto the headers that are used for the request. It must therefore be a valid set of HTML header directives, separated by newlines. </td></tr>
<tr><td class="paramname">connectionTimeOutMs</td><td>if 0, this will use whatever default setting the OS chooses. If a negative number, it will be infinite. Otherwise it specifies a time in milliseconds. </td></tr>
<tr><td class="paramname">responseHeaders</td><td>if this is non-null, all the (key, value) pairs received as headers in the response will be stored in this array </td></tr>
<tr><td class="paramname">statusCode</td><td>if this is non-null, it will get set to the http status code, if one is known, or 0 if a code isn't available </td></tr>
<tr><td class="paramname">numRedirectsToFollow</td><td>specifies the number of redirects that will be followed before returning a response (ignored for Android which follows up to 5 redirects) </td></tr>
<tr><td class="paramname">httpRequestCmd</td><td>Specify which HTTP Request to use. If this is empty, then doPostRequest will determine the HTTP request. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>an input stream that the caller must delete, or a null pointer if there was an error trying to open it. </dd></dl>
</div>
</div>
<a id="ae80831fe2f20790ca491d27eef884b46"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae80831fe2f20790ca491d27eef884b46">§ </a></span>readEntireBinaryStream()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool URL::readEntireBinaryStream </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classMemoryBlock.html">MemoryBlock</a> & </td>
<td class="paramname"><em>destData</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>usePostCommand</em> = <code>false</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Tries to download the entire contents of this <a class="el" href="classURL.html" title="Represents a URL and has a bunch of useful functions to manipulate it. ">URL</a> into a binary data block. </p>
<p>If it succeeds, this will return true and append the data it read onto the end of the memory block.</p>
<p>Note that on some platforms (Android, for example) it's not permitted to do any network action from the message thread, so you must only call it from a background thread.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">destData</td><td>the memory block to append the new data to </td></tr>
<tr><td class="paramname">usePostCommand</td><td>whether to use a POST command to get the data (uses a GET command if this is false) </td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classURL.html#a0f860c4986e9e67f54ffb7cfb7c1062d" title="Tries to download the entire contents of this URL as a string. ">readEntireTextStream</a>, <a class="el" href="classURL.html#aff3ee88e646fa0bf0602613c6b93e2fa" title="Tries to download the entire contents of this URL and parse it as XML. ">readEntireXmlStream</a> </dd></dl>
</div>
</div>
<a id="a0f860c4986e9e67f54ffb7cfb7c1062d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0f860c4986e9e67f54ffb7cfb7c1062d">§ </a></span>readEntireTextStream()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classString.html">String</a> URL::readEntireTextStream </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>usePostCommand</em> = <code>false</code></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Tries to download the entire contents of this <a class="el" href="classURL.html" title="Represents a URL and has a bunch of useful functions to manipulate it. ">URL</a> as a string. </p>
<p>If it fails, this will return an empty string, otherwise it will return the contents of the downloaded file. If you need to distinguish between a read operation that fails and one that returns an empty string, you'll need to use a different method, such as <a class="el" href="classURL.html#ae80831fe2f20790ca491d27eef884b46" title="Tries to download the entire contents of this URL into a binary data block. ">readEntireBinaryStream()</a>.</p>
<p>Note that on some platforms (Android, for example) it's not permitted to do any network action from the message thread, so you must only call it from a background thread.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">usePostCommand</td><td>whether to use a POST command to get the data (uses a GET command if this is false) </td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classURL.html#ae80831fe2f20790ca491d27eef884b46" title="Tries to download the entire contents of this URL into a binary data block. ">readEntireBinaryStream</a>, <a class="el" href="classURL.html#aff3ee88e646fa0bf0602613c6b93e2fa" title="Tries to download the entire contents of this URL and parse it as XML. ">readEntireXmlStream</a> </dd></dl>
</div>
</div>
<a id="aff3ee88e646fa0bf0602613c6b93e2fa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aff3ee88e646fa0bf0602613c6b93e2fa">§ </a></span>readEntireXmlStream()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classXmlElement.html">XmlElement</a>* URL::readEntireXmlStream </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>usePostCommand</em> = <code>false</code></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Tries to download the entire contents of this <a class="el" href="classURL.html" title="Represents a URL and has a bunch of useful functions to manipulate it. ">URL</a> and parse it as XML. </p>
<p>If it fails, or if the text that it reads can't be parsed as XML, this will return 0.</p>
<p>When it returns a valid <a class="el" href="classXmlElement.html" title="Used to build a tree of elements representing an XML document. ">XmlElement</a> object, the caller is responsibile for deleting this object when no longer needed.</p>
<p>Note that on some platforms (Android, for example) it's not permitted to do any network action from the message thread, so you must only call it from a background thread.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">usePostCommand</td><td>whether to use a POST command to get the data (uses a GET command if this is false)</td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classURL.html#ae80831fe2f20790ca491d27eef884b46" title="Tries to download the entire contents of this URL into a binary data block. ">readEntireBinaryStream</a>, <a class="el" href="classURL.html#a0f860c4986e9e67f54ffb7cfb7c1062d" title="Tries to download the entire contents of this URL as a string. ">readEntireTextStream</a> </dd></dl>
</div>
</div>
<a id="ad2a5f3808099305c73c84112a01ecb1d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad2a5f3808099305c73c84112a01ecb1d">§ </a></span>addEscapeChars()</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="classString.html">String</a> URL::addEscapeChars </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classString.html">String</a> & </td>
<td class="paramname"><em>stringToAddEscapeCharsTo</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>isParameter</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>roundBracketsAreLegal</em> = <code>true</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Adds escape sequences to a string to encode any characters that aren't legal in a <a class="el" href="classURL.html" title="Represents a URL and has a bunch of useful functions to manipulate it. ">URL</a>. </p>
<p>E.g. any spaces will be replaced with "%20".</p>
<p>This is the opposite of <a class="el" href="classURL.html#add07acc3e33e34097c2e93447f6fd0f9" title="Replaces any escape character sequences in a string with their original character codes...">removeEscapeChars()</a>.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">stringToAddEscapeCharsTo</td><td>The string to escape. </td></tr>
<tr><td class="paramname">isParameter</td><td>If true then the string is going to be used as a parameter, so it also encodes '$' and ',' (which would otherwise be legal in a <a class="el" href="classURL.html" title="Represents a URL and has a bunch of useful functions to manipulate it. ">URL</a>. </td></tr>
<tr><td class="paramname">roundBracketsAreLegal</td><td>Technically round brackets are ok in URLs, however, some servers (like AWS) also want round brackets to be escaped.</td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classURL.html#add07acc3e33e34097c2e93447f6fd0f9" title="Replaces any escape character sequences in a string with their original character codes...">removeEscapeChars</a> </dd></dl>
</div>
</div>
<a id="add07acc3e33e34097c2e93447f6fd0f9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#add07acc3e33e34097c2e93447f6fd0f9">§ </a></span>removeEscapeChars()</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="classString.html">String</a> URL::removeEscapeChars </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classString.html">String</a> & </td>
<td class="paramname"><em>stringToRemoveEscapeCharsFrom</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Replaces any escape character sequences in a string with their original character codes. </p>
<p>E.g. any instances of "%20" will be replaced by a space.</p>
<p>This is the opposite of <a class="el" href="classURL.html#ad2a5f3808099305c73c84112a01ecb1d" title="Adds escape sequences to a string to encode any characters that aren't legal in a URL...">addEscapeChars()</a>.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classURL.html#ad2a5f3808099305c73c84112a01ecb1d" title="Adds escape sequences to a string to encode any characters that aren't legal in a URL...">addEscapeChars</a> </dd></dl>
</div>
</div>
<a id="a9a8a3e4344e94b6d074df5f7223f9c77"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9a8a3e4344e94b6d074df5f7223f9c77">§ </a></span>createWithoutParsing()</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="classURL.html">URL</a> URL::createWithoutParsing </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classString.html">String</a> & </td>
<td class="paramname"><em>url</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a <a class="el" href="classURL.html" title="Represents a URL and has a bunch of useful functions to manipulate it. ">URL</a> without attempting to remove any embedded parameters from the string. </p>
<p>This may be necessary if you need to create a request that involves both POST parameters and parameters which are embedded in the <a class="el" href="classURL.html" title="Represents a URL and has a bunch of useful functions to manipulate it. ">URL</a> address itself. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="juce__URL_8h.html">juce_URL.h</a></li>
</ul>
</div><!-- contents -->
<hr class="footer"/>
<address class="footer"><small>All content © ROLI Ltd.</small></address><br/>
</body>
</html>
|