/usr/share/gtk-doc/html/gdata/GDataClientLoginAuthorizer.html is in libgdata-doc 0.17.9-2.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GDataClientLoginAuthorizer: GData Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="GData Reference Manual">
<link rel="up" href="ch05.html" title="Authentication/Authorization API">
<link rel="prev" href="GDataAuthorizationDomain.html" title="GDataAuthorizationDomain">
<link rel="next" href="GDataGoaAuthorizer.html" title="GDataGoaAuthorizer">
<meta name="generator" content="GTK-Doc V1.26.1 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#GDataClientLoginAuthorizer.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#GDataClientLoginAuthorizer.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span>
<a href="#GDataClientLoginAuthorizer.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties"> <span class="dim">|</span>
<a href="#GDataClientLoginAuthorizer.properties" class="shortcut">Properties</a></span><span id="nav_signals"> <span class="dim">|</span>
<a href="#GDataClientLoginAuthorizer.signals" class="shortcut">Signals</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch05.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="GDataAuthorizationDomain.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="GDataGoaAuthorizer.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="GDataClientLoginAuthorizer"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GDataClientLoginAuthorizer.top_of_page"></a>GDataClientLoginAuthorizer</span></h2>
<p>GDataClientLoginAuthorizer — GData ClientLogin authorization interface</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="GDataClientLoginAuthorizer.stability-level"></a><h2>Stability Level</h2>
<acronym title="The intention of a Stable interface is to enable arbitrary third parties to
develop applications to these interfaces, release them, and have confidence that
they will run on all minor releases of the product (after the one in which the
interface was introduced, and within the same major release). Even at a major
release, incompatible changes are expected to be rare, and to have strong
justifications.
"><span class="acronym">Stable</span></acronym>, unless otherwise indicated
</div>
<div class="refsect1">
<a name="GDataClientLoginAuthorizer.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="GDataClientLoginAuthorizer.html" title="GDataClientLoginAuthorizer"><span class="returnvalue">GDataClientLoginAuthorizer</span></a> *
</td>
<td class="function_name">
<a class="link" href="GDataClientLoginAuthorizer.html#gdata-client-login-authorizer-new" title="gdata_client_login_authorizer_new ()">gdata_client_login_authorizer_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="GDataClientLoginAuthorizer.html" title="GDataClientLoginAuthorizer"><span class="returnvalue">GDataClientLoginAuthorizer</span></a> *
</td>
<td class="function_name">
<a class="link" href="GDataClientLoginAuthorizer.html#gdata-client-login-authorizer-new-for-authorization-domains" title="gdata_client_login_authorizer_new_for_authorization_domains ()">gdata_client_login_authorizer_new_for_authorization_domains</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="GDataClientLoginAuthorizer.html#gdata-client-login-authorizer-authenticate" title="gdata_client_login_authorizer_authenticate ()">gdata_client_login_authorizer_authenticate</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GDataClientLoginAuthorizer.html#gdata-client-login-authorizer-authenticate-async" title="gdata_client_login_authorizer_authenticate_async ()">gdata_client_login_authorizer_authenticate_async</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="GDataClientLoginAuthorizer.html#gdata-client-login-authorizer-authenticate-finish" title="gdata_client_login_authorizer_authenticate_finish ()">gdata_client_login_authorizer_authenticate_finish</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="GDataClientLoginAuthorizer.html#gdata-client-login-authorizer-get-client-id" title="gdata_client_login_authorizer_get_client_id ()">gdata_client_login_authorizer_get_client_id</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="GDataClientLoginAuthorizer.html#gdata-client-login-authorizer-get-username" title="gdata_client_login_authorizer_get_username ()">gdata_client_login_authorizer_get_username</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="GDataClientLoginAuthorizer.html#gdata-client-login-authorizer-get-password" title="gdata_client_login_authorizer_get_password ()">gdata_client_login_authorizer_get_password</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">SoupURI</span> *
</td>
<td class="function_name">
<a class="link" href="GDataClientLoginAuthorizer.html#gdata-client-login-authorizer-get-proxy-uri" title="gdata_client_login_authorizer_get_proxy_uri ()">gdata_client_login_authorizer_get_proxy_uri</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GDataClientLoginAuthorizer.html#gdata-client-login-authorizer-set-proxy-uri" title="gdata_client_login_authorizer_set_proxy_uri ()">gdata_client_login_authorizer_set_proxy_uri</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">GProxyResolver</span> *
</td>
<td class="function_name">
<a class="link" href="GDataClientLoginAuthorizer.html#gdata-client-login-authorizer-get-proxy-resolver" title="gdata_client_login_authorizer_get_proxy_resolver ()">gdata_client_login_authorizer_get_proxy_resolver</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GDataClientLoginAuthorizer.html#gdata-client-login-authorizer-set-proxy-resolver" title="gdata_client_login_authorizer_set_proxy_resolver ()">gdata_client_login_authorizer_set_proxy_resolver</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>
</td>
<td class="function_name">
<a class="link" href="GDataClientLoginAuthorizer.html#gdata-client-login-authorizer-get-timeout" title="gdata_client_login_authorizer_get_timeout ()">gdata_client_login_authorizer_get_timeout</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GDataClientLoginAuthorizer.html#gdata-client-login-authorizer-set-timeout" title="gdata_client_login_authorizer_set_timeout ()">gdata_client_login_authorizer_set_timeout</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GDataClientLoginAuthorizer.properties"></a><h2>Properties</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody>
<tr>
<td class="property_type">
<a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td>
<td class="property_name"><a class="link" href="GDataClientLoginAuthorizer.html#GDataClientLoginAuthorizer--client-id" title="The “client-id” property">client-id</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr>
<tr>
<td class="property_type">
<a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td>
<td class="property_name"><a class="link" href="GDataClientLoginAuthorizer.html#GDataClientLoginAuthorizer--password" title="The “password” property">password</a></td>
<td class="property_flags">Read</td>
</tr>
<tr>
<td class="property_type">
<span class="type">GProxyResolver</span> *</td>
<td class="property_name"><a class="link" href="GDataClientLoginAuthorizer.html#GDataClientLoginAuthorizer--proxy-resolver" title="The “proxy-resolver” property">proxy-resolver</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type">
<span class="type">SoupURI</span> *</td>
<td class="property_name"><a class="link" href="GDataClientLoginAuthorizer.html#GDataClientLoginAuthorizer--proxy-uri" title="The “proxy-uri” property">proxy-uri</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a></td>
<td class="property_name"><a class="link" href="GDataClientLoginAuthorizer.html#GDataClientLoginAuthorizer--timeout" title="The “timeout” property">timeout</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type">
<a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td>
<td class="property_name"><a class="link" href="GDataClientLoginAuthorizer.html#GDataClientLoginAuthorizer--username" title="The “username” property">username</a></td>
<td class="property_flags">Read</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GDataClientLoginAuthorizer.signals"></a><h2>Signals</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="signals_return">
<col width="300px" class="signals_name">
<col width="200px" class="signals_flags">
</colgroup>
<tbody><tr>
<td class="signal_type">
<a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a>*</td>
<td class="signal_name"><a class="link" href="GDataClientLoginAuthorizer.html#GDataClientLoginAuthorizer-captcha-challenge" title="The “captcha-challenge” signal">captcha-challenge</a></td>
<td class="signal_flags"><a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GDataClientLoginAuthorizer.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="GDataClientLoginAuthorizer.html#GDataClientLoginAuthorizer-struct" title="GDataClientLoginAuthorizer">GDataClientLoginAuthorizer</a></td>
</tr>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="GDataClientLoginAuthorizer.html#GDataClientLoginAuthorizerClass" title="GDataClientLoginAuthorizerClass">GDataClientLoginAuthorizerClass</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="GDataClientLoginAuthorizer.html#GDataClientLoginAuthorizerError" title="enum GDataClientLoginAuthorizerError">GDataClientLoginAuthorizerError</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GDataClientLoginAuthorizer.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> <a href="../gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
<span class="lineart">╰──</span> GDataClientLoginAuthorizer
</pre>
</div>
<div class="refsect1">
<a name="GDataClientLoginAuthorizer.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
GDataClientLoginAuthorizer implements
<a class="link" href="GDataAuthorizer.html" title="GDataAuthorizer">GDataAuthorizer</a>.</p>
</div>
<div class="refsect1">
<a name="GDataClientLoginAuthorizer.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <gdata/gdata-client-login-authorizer.h>
</pre>
</div>
<div class="refsect1">
<a name="GDataClientLoginAuthorizer.description"></a><h2>Description</h2>
<p><a class="link" href="GDataClientLoginAuthorizer.html" title="GDataClientLoginAuthorizer"><span class="type">GDataClientLoginAuthorizer</span></a> provides an implementation of the <a class="link" href="GDataAuthorizer.html" title="GDataAuthorizer"><span class="type">GDataAuthorizer</span></a> interface for authentication and authorization using the deprecated</p>
<a class="ulink" href="http://code.google.com/apis/accounts/docs/AuthForInstalledApps.html" target="_top">ClientLogin</a> process.
<p>As noted, the ClientLogin process is being deprecated in favour of OAuth 2.0. This API is not (yet) deprecated, however. One of the main reasons
for ClientLogin being deprecated is that it cannot support two-factor authentication as now available to Google Accounts. Any account which has
two-factor authentication enabled has to use a service-specific one-time password instead if a client is authenticating with
<a class="link" href="GDataClientLoginAuthorizer.html" title="GDataClientLoginAuthorizer"><span class="type">GDataClientLoginAuthorizer</span></a>. More documentation about this is</p>
<a class="ulink" href="http://www.google.com/support/accounts/bin/static.py?page=guide.cs&guide=1056283&topic=1056286" target="_top">available online</a>.
<p>Note that newer services cannot be authenticated against using ClientLogin,
and a <a class="link" href="GDataOAuth2Authorizer.html" title="GDataOAuth2Authorizer"><span class="type">GDataOAuth2Authorizer</span></a> must be used instead.</p>
<p>The ClientLogin process is a simple one whereby the user's Google Account username and password are sent over an HTTPS connection to the Google
Account servers (when <a class="link" href="GDataClientLoginAuthorizer.html#gdata-client-login-authorizer-authenticate" title="gdata_client_login_authorizer_authenticate ()"><code class="function">gdata_client_login_authorizer_authenticate()</code></a> is called), which return an authorization token. This token is then attached to
all future requests to the online service. A slight complication is that the Google Accounts service may return a CAPTCHA challenge instead of
immediately returning an authorization token. In this case, the <a class="link" href="GDataClientLoginAuthorizer.html#GDataClientLoginAuthorizer-captcha-challenge" title="The “captcha-challenge” signal"><span class="type">“captcha-challenge”</span></a> signal will be emitted, and the
user's response to the CAPTCHA should be returned by the handler.</p>
<p>ClientLogin does not natively support authorization against multiple authorization domains concurrently with a single authorization token, so it
has to be simulated by maintaining multiple authorization tokens if multiple authorization domains are used. This means that proportionally more
network requests are made when <a class="link" href="GDataClientLoginAuthorizer.html#gdata-client-login-authorizer-authenticate" title="gdata_client_login_authorizer_authenticate ()"><code class="function">gdata_client_login_authorizer_authenticate()</code></a> is called, which will be proportionally slower. Handling of the
multiple authorization tokens is otherwise transparent to the client.</p>
<p>Each authorization token is long lived, so reauthorization is rarely necessary with <a class="link" href="GDataClientLoginAuthorizer.html" title="GDataClientLoginAuthorizer"><span class="type">GDataClientLoginAuthorizer</span></a>. Consequently, refreshing
authorization using <a class="link" href="GDataAuthorizer.html#gdata-authorizer-refresh-authorization" title="gdata_authorizer_refresh_authorization ()"><code class="function">gdata_authorizer_refresh_authorization()</code></a> is not supported by <a class="link" href="GDataClientLoginAuthorizer.html" title="GDataClientLoginAuthorizer"><span class="type">GDataClientLoginAuthorizer</span></a>, and will immediately return <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>
with no error set.</p>
<div class="example">
<a name="id-1.3.5.4.11.10"></a><p class="title"><b>Example 6. Authenticating Asynchronously Using ClientLogin</b></p>
<div class="example-contents">
<table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td class="listing_lines" align="right"><pre>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</pre></td>
<td class="listing_code"><pre class="programlisting"><span class="usertype">GDataSomeService</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">service</span><span class="symbol">;</span>
<span class="usertype">GDataClientLoginAuthorizer</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">authorizer</span><span class="symbol">;</span>
<span class="comment">/* Create an authorizer and authenticate and authorize the service we're using, asynchronously. */</span>
<span class="normal">authorizer </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="GDataClientLoginAuthorizer.html#gdata-client-login-authorizer-new">gdata_client_login_authorizer_new</a></span><span class="normal"> </span><span class="symbol">(</span><span class="string">"companyName-applicationName-versionID"</span><span class="symbol">,</span><span class="normal"> GDATA_TYPE_SOME_SERVICE</span><span class="symbol">);</span>
<span class="function"><a href="GDataClientLoginAuthorizer.html#gdata-client-login-authorizer-authenticate-async">gdata_client_login_authorizer_authenticate_async</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">authorizer</span><span class="symbol">,</span><span class="normal"> username</span><span class="symbol">,</span><span class="normal"> password</span><span class="symbol">,</span><span class="normal"> cancellable</span><span class="symbol">,</span>
<span class="normal"> </span><span class="symbol">(</span><span class="normal">GAsyncReadyCallback</span><span class="symbol">)</span><span class="normal"> authenticate_cb</span><span class="symbol">,</span><span class="normal"> user_data</span><span class="symbol">);</span>
<span class="comment">/* Create a service object and link it with the authorizer */</span>
<span class="normal">service </span><span class="symbol">=</span><span class="normal"> </span><span class="function">gdata_some_service_new</span><span class="normal"> </span><span class="symbol">(</span><span class="function">GDATA_AUTHORIZER</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">authorizer</span><span class="symbol">));</span>
<span class="keyword">static</span><span class="normal"> </span><span class="type">void</span>
<span class="function">authenticate_cb</span><span class="normal"> </span><span class="symbol">(</span><span class="usertype">GDataClientLoginAuthorizer</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">authorizer</span><span class="symbol">,</span><span class="normal"> </span><span class="usertype">GAsyncResult</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">async_result</span><span class="symbol">,</span><span class="normal"> </span><span class="usertype">gpointer</span><span class="normal"> user_data</span><span class="symbol">)</span>
<span class="cbracket">{</span>
<span class="normal"> </span><span class="usertype">GError</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">error </span><span class="symbol">=</span><span class="normal"> <a href="../glib/glib-Standard-Macros.html#NULL:CAPS">NULL</a></span><span class="symbol">;</span>
<span class="normal"> </span><span class="keyword">if</span><span class="normal"> </span><span class="symbol">(</span><span class="function"><a href="GDataClientLoginAuthorizer.html#gdata-client-login-authorizer-authenticate-finish">gdata_client_login_authorizer_authenticate_finish</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">authorizer</span><span class="symbol">,</span><span class="normal"> async_result</span><span class="symbol">,</span><span class="normal"> </span><span class="symbol">&</span><span class="normal">error</span><span class="symbol">)</span><span class="normal"> </span><span class="symbol">==</span><span class="normal"> <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS">FALSE</a></span><span class="symbol">)</span><span class="normal"> </span><span class="cbracket">{</span>
<span class="normal"> </span><span class="comment">/* Notify the user of all errors except cancellation errors */</span>
<span class="normal"> </span><span class="keyword">if</span><span class="normal"> </span><span class="symbol">(!</span><span class="function"><a href="../glib/glib-Error-Reporting.html#g-error-matches">g_error_matches</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">error</span><span class="symbol">,</span><span class="normal"> G_IO_ERROR</span><span class="symbol">,</span><span class="normal"> G_IO_ERROR_CANCELLED</span><span class="symbol">))</span><span class="normal"> </span><span class="cbracket">{</span>
<span class="normal"> </span><span class="function"><a href="../glib/glib-Message-Logging.html#g-error">g_error</a></span><span class="normal"> </span><span class="symbol">(</span><span class="string">"Authentication failed: %s"</span><span class="symbol">,</span><span class="normal"> error</span><span class="symbol">-></span><span class="normal">message</span><span class="symbol">);</span>
<span class="normal"> </span><span class="cbracket">}</span>
<span class="normal"> </span><span class="function"><a href="../glib/glib-Error-Reporting.html#g-error-free">g_error_free</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">error</span><span class="symbol">);</span>
<span class="normal"> </span><span class="keyword">return</span><span class="symbol">;</span>
<span class="normal"> </span><span class="cbracket">}</span>
<span class="normal"> </span><span class="comment">/* (The client is now authenticated and authorized against the service.</span>
<span class="comment"> * It can now proceed to execute queries on the service object which require the user to be authenticated.) */</span>
<span class="cbracket">}</span>
<span class="function"><a href="../gobject/gobject-The-Base-Object-Type.html#g-object-unref">g_object_unref</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">service</span><span class="symbol">);</span>
<span class="function"><a href="../gobject/gobject-The-Base-Object-Type.html#g-object-unref">g_object_unref</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">authorizer</span><span class="symbol">);</span></pre></td>
</tr>
</tbody>
</table>
</div>
</div>
<br class="example-break">
</div>
<div class="refsect1">
<a name="GDataClientLoginAuthorizer.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gdata-client-login-authorizer-new"></a><h3>gdata_client_login_authorizer_new ()</h3>
<pre class="programlisting"><a class="link" href="GDataClientLoginAuthorizer.html" title="GDataClientLoginAuthorizer"><span class="returnvalue">GDataClientLoginAuthorizer</span></a> *
gdata_client_login_authorizer_new (<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *client_id</code></em>,
<em class="parameter"><code><a href="../gobject/gobject-Type-Information.html#GType"><span class="type">GType</span></a> service_type</code></em>);</pre>
<p>Creates a new <a class="link" href="GDataClientLoginAuthorizer.html" title="GDataClientLoginAuthorizer"><span class="type">GDataClientLoginAuthorizer</span></a>. The <em class="parameter"><code>client_id</code></em>
must be unique for your application, and as registered with Google.</p>
<p>The <a class="link" href="GDataAuthorizationDomain.html" title="GDataAuthorizationDomain"><span class="type">GDataAuthorizationDomain</span></a>s for the given <em class="parameter"><code>service_type</code></em>
(i.e. as returned by <a class="link" href="GDataService.html#gdata-service-get-authorization-domains" title="gdata_service_get_authorization_domains ()"><code class="function">gdata_service_get_authorization_domains()</code></a>) are the ones the
user will be logged in to using the provided username and password when <a class="link" href="GDataClientLoginAuthorizer.html#gdata-client-login-authorizer-authenticate" title="gdata_client_login_authorizer_authenticate ()"><code class="function">gdata_client_login_authorizer_authenticate()</code></a> is called. Note that the same
username and password will be used for all domains.</p>
<div class="refsect3">
<a name="gdata-client-login-authorizer-new.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>client_id</p></td>
<td class="parameter_description"><p>your application's client ID</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>service_type</p></td>
<td class="parameter_description"><p>the <a href="../gobject/gobject-Type-Information.html#GType"><span class="type">GType</span></a> of a <a class="link" href="GDataService.html" title="GDataService"><span class="type">GDataService</span></a> subclass which the <a class="link" href="GDataClientLoginAuthorizer.html" title="GDataClientLoginAuthorizer"><span class="type">GDataClientLoginAuthorizer</span></a> will be used with</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gdata-client-login-authorizer-new.returns"></a><h4>Returns</h4>
<p>a new <a class="link" href="GDataClientLoginAuthorizer.html" title="GDataClientLoginAuthorizer"><span class="type">GDataClientLoginAuthorizer</span></a>, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>; unref with <a href="../gobject/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a>. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
<p class="since">Since: <a class="link" href="ix11.html#api-index-0.9.0">0.9.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gdata-client-login-authorizer-new-for-authorization-domains"></a><h3>gdata_client_login_authorizer_new_for_authorization_domains ()</h3>
<pre class="programlisting"><a class="link" href="GDataClientLoginAuthorizer.html" title="GDataClientLoginAuthorizer"><span class="returnvalue">GDataClientLoginAuthorizer</span></a> *
gdata_client_login_authorizer_new_for_authorization_domains
(<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *client_id</code></em>,
<em class="parameter"><code><a href="../glib/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> *authorization_domains</code></em>);</pre>
<p>Creates a new <a class="link" href="GDataClientLoginAuthorizer.html" title="GDataClientLoginAuthorizer"><span class="type">GDataClientLoginAuthorizer</span></a>. The <em class="parameter"><code>client_id</code></em>
must be unique for your application, and as registered with Google. This function is
intended to be used only when the default authorization domain list for a single <a class="link" href="GDataService.html" title="GDataService"><span class="type">GDataService</span></a>, as used by <a class="link" href="GDataClientLoginAuthorizer.html#gdata-client-login-authorizer-new" title="gdata_client_login_authorizer_new ()"><code class="function">gdata_client_login_authorizer_new()</code></a>,
isn't suitable. For example, this could be because the <a class="link" href="GDataClientLoginAuthorizer.html" title="GDataClientLoginAuthorizer"><span class="type">GDataClientLoginAuthorizer</span></a> will be used with multiple <a class="link" href="GDataService.html" title="GDataService"><span class="type">GDataService</span></a> subclasses, or because
the client requires a specific set of authorization domains.</p>
<p>The specified <a class="link" href="GDataAuthorizationDomain.html" title="GDataAuthorizationDomain"><span class="type">GDataAuthorizationDomain</span></a>s are the ones the user will be logged in to using the provided username and password when
<a class="link" href="GDataClientLoginAuthorizer.html#gdata-client-login-authorizer-authenticate" title="gdata_client_login_authorizer_authenticate ()"><code class="function">gdata_client_login_authorizer_authenticate()</code></a> is called. Note that the same username and password will be used for all domains.</p>
<div class="refsect3">
<a name="gdata-client-login-authorizer-new-for-authorization-domains.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>client_id</p></td>
<td class="parameter_description"><p>your application's client ID</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>authorization_domains</p></td>
<td class="parameter_description"><p>a non-empty list of <a class="link" href="GDataAuthorizationDomain.html" title="GDataAuthorizationDomain"><span class="type">GDataAuthorizationDomain</span></a>s to be
authorized against by the <a class="link" href="GDataClientLoginAuthorizer.html" title="GDataClientLoginAuthorizer"><span class="type">GDataClientLoginAuthorizer</span></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> GDataAuthorizationDomain][<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gdata-client-login-authorizer-new-for-authorization-domains.returns"></a><h4>Returns</h4>
<p>a new <a class="link" href="GDataClientLoginAuthorizer.html" title="GDataClientLoginAuthorizer"><span class="type">GDataClientLoginAuthorizer</span></a>, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>; unref with <a href="../gobject/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a>. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
<p class="since">Since: <a class="link" href="ix11.html#api-index-0.9.0">0.9.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gdata-client-login-authorizer-authenticate"></a><h3>gdata_client_login_authorizer_authenticate ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
gdata_client_login_authorizer_authenticate
(<em class="parameter"><code><a class="link" href="GDataClientLoginAuthorizer.html" title="GDataClientLoginAuthorizer"><span class="type">GDataClientLoginAuthorizer</span></a> *self</code></em>,
<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *username</code></em>,
<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *password</code></em>,
<em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
<em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>Authenticates the <a class="link" href="GDataClientLoginAuthorizer.html" title="GDataClientLoginAuthorizer"><span class="type">GDataClientLoginAuthorizer</span></a> with the Google Accounts service using <em class="parameter"><code>username</code></em>
and <em class="parameter"><code>password</code></em>
and authorizes it against all the
service types passed to <a class="link" href="GDataClientLoginAuthorizer.html#gdata-client-login-authorizer-new" title="gdata_client_login_authorizer_new ()"><code class="function">gdata_client_login_authorizer_new()</code></a>; i.e. logs into the service with the given user account. <em class="parameter"><code>username</code></em>
should be a full
e-mail address (e.g. <code class="literal">john.smith@gmail.com</code>). If a full e-mail address is not given, <em class="parameter"><code>username</code></em>
will have
<code class="literal">@gmail.com</code> appended to create an e-mail address</p>
<p>If <em class="parameter"><code>cancellable</code></em>
is not <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, then the operation can be cancelled by triggering the <em class="parameter"><code>cancellable</code></em>
object from another thread.
If the operation was cancelled, the error <code class="literal">G_IO_ERROR_CANCELLED</code> will be returned.</p>
<p>If the operation errors or is cancelled part-way through, <a class="link" href="GDataAuthorizer.html#gdata-authorizer-is-authorized-for-domain" title="gdata_authorizer_is_authorized_for_domain ()"><code class="function">gdata_authorizer_is_authorized_for_domain()</code></a> is guaranteed to return <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>
for all <a class="link" href="GDataAuthorizationDomain.html" title="GDataAuthorizationDomain"><span class="type">GDataAuthorizationDomain</span></a>s, even if authentication has succeeded for some of them already.</p>
<p>A <a class="link" href="GDataClientLoginAuthorizer.html#GDATA-CLIENT-LOGIN-AUTHORIZER-ERROR-BAD-AUTHENTICATION:CAPS"><code class="literal">GDATA_CLIENT_LOGIN_AUTHORIZER_ERROR_BAD_AUTHENTICATION</code></a> will be returned if authentication failed due to an incorrect username or password.
Other <a class="link" href="GDataClientLoginAuthorizer.html#GDataClientLoginAuthorizerError" title="enum GDataClientLoginAuthorizerError"><span class="type">GDataClientLoginAuthorizerError</span></a> errors can be returned for other conditions.</p>
<p>If the service requires a CAPTCHA to be completed, the <a class="link" href="GDataClientLoginAuthorizer.html#GDataClientLoginAuthorizer-captcha-challenge" title="The “captcha-challenge” signal"><span class="type">“captcha-challenge”</span></a> signal will be emitted.
The return value from a signal handler for the signal should be a newly allocated string containing the text from the image. If the text is <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
or empty, authentication will fail with a <a class="link" href="GDataClientLoginAuthorizer.html#GDATA-CLIENT-LOGIN-AUTHORIZER-ERROR-CAPTCHA-REQUIRED:CAPS"><code class="literal">GDATA_CLIENT_LOGIN_AUTHORIZER_ERROR_CAPTCHA_REQUIRED</code></a> error. Otherwise, authentication will be
automatically and transparently restarted with the new CAPTCHA details.</p>
<p>A <a class="link" href="GDataService.html#GDATA-SERVICE-ERROR-PROTOCOL-ERROR:CAPS"><code class="literal">GDATA_SERVICE_ERROR_PROTOCOL_ERROR</code></a> will be returned if the server's responses were invalid.</p>
<div class="refsect3">
<a name="gdata-client-login-authorizer-authenticate.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="GDataClientLoginAuthorizer.html" title="GDataClientLoginAuthorizer"><span class="type">GDataClientLoginAuthorizer</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>username</p></td>
<td class="parameter_description"><p>the user's username</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>password</p></td>
<td class="parameter_description"><p>the user's password</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>cancellable</p></td>
<td class="parameter_description"><p>optional <span class="type">GCancellable</span> object, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>a <a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gdata-client-login-authorizer-authenticate.returns"></a><h4>Returns</h4>
<p> <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if authentication and authorization was successful against all the services, <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise</p>
</div>
<p class="since">Since: <a class="link" href="ix11.html#api-index-0.9.0">0.9.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gdata-client-login-authorizer-authenticate-async"></a><h3>gdata_client_login_authorizer_authenticate_async ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gdata_client_login_authorizer_authenticate_async
(<em class="parameter"><code><a class="link" href="GDataClientLoginAuthorizer.html" title="GDataClientLoginAuthorizer"><span class="type">GDataClientLoginAuthorizer</span></a> *self</code></em>,
<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *username</code></em>,
<em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *password</code></em>,
<em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
<em class="parameter"><code><span class="type">GAsyncReadyCallback</span> callback</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre>
<p>Authenticates the <a class="link" href="GDataClientLoginAuthorizer.html" title="GDataClientLoginAuthorizer"><span class="type">GDataClientLoginAuthorizer</span></a> with the Google accounts service using the given <em class="parameter"><code>username</code></em>
and <em class="parameter"><code>password</code></em>
. <em class="parameter"><code>self</code></em>
, <em class="parameter"><code>username</code></em>
and
<em class="parameter"><code>password</code></em>
are all reffed/copied when this function is called, so can safely be freed after this function returns.</p>
<p>For more details, see <a class="link" href="GDataClientLoginAuthorizer.html#gdata-client-login-authorizer-authenticate" title="gdata_client_login_authorizer_authenticate ()"><code class="function">gdata_client_login_authorizer_authenticate()</code></a>, which is the synchronous version of this function.</p>
<p>When the operation is finished, <em class="parameter"><code>callback</code></em>
will be called. You can then call <a class="link" href="GDataClientLoginAuthorizer.html#gdata-client-login-authorizer-authenticate-finish" title="gdata_client_login_authorizer_authenticate_finish ()"><code class="function">gdata_client_login_authorizer_authenticate_finish()</code></a>
to get the results of the operation.</p>
<div class="refsect3">
<a name="gdata-client-login-authorizer-authenticate-async.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="GDataClientLoginAuthorizer.html" title="GDataClientLoginAuthorizer"><span class="type">GDataClientLoginAuthorizer</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>username</p></td>
<td class="parameter_description"><p>the user's username</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>password</p></td>
<td class="parameter_description"><p>the user's password</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>cancellable</p></td>
<td class="parameter_description"><p>optional <span class="type">GCancellable</span> object, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>callback</p></td>
<td class="parameter_description"><p>a <span class="type">GAsyncReadyCallback</span> to call when authentication is finished</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>data to pass to the <em class="parameter"><code>callback</code></em>
function. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="This parameter is a 'user_data', for callbacks; many bindings can pass NULL here."><span class="acronym">closure</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix11.html#api-index-0.9.0">0.9.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gdata-client-login-authorizer-authenticate-finish"></a><h3>gdata_client_login_authorizer_authenticate_finish ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
gdata_client_login_authorizer_authenticate_finish
(<em class="parameter"><code><a class="link" href="GDataClientLoginAuthorizer.html" title="GDataClientLoginAuthorizer"><span class="type">GDataClientLoginAuthorizer</span></a> *self</code></em>,
<em class="parameter"><code><span class="type">GAsyncResult</span> *async_result</code></em>,
<em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>Finishes an asynchronous authentication operation started with <a class="link" href="GDataClientLoginAuthorizer.html#gdata-client-login-authorizer-authenticate-async" title="gdata_client_login_authorizer_authenticate_async ()"><code class="function">gdata_client_login_authorizer_authenticate_async()</code></a>.</p>
<div class="refsect3">
<a name="gdata-client-login-authorizer-authenticate-finish.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="GDataClientLoginAuthorizer.html" title="GDataClientLoginAuthorizer"><span class="type">GDataClientLoginAuthorizer</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>async_result</p></td>
<td class="parameter_description"><p>a <span class="type">GAsyncResult</span></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>a <a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gdata-client-login-authorizer-authenticate-finish.returns"></a><h4>Returns</h4>
<p> <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if authentication was successful, <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise</p>
</div>
<p class="since">Since: <a class="link" href="ix11.html#api-index-0.9.0">0.9.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gdata-client-login-authorizer-get-client-id"></a><h3>gdata_client_login_authorizer_get_client_id ()</h3>
<pre class="programlisting">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
gdata_client_login_authorizer_get_client_id
(<em class="parameter"><code><a class="link" href="GDataClientLoginAuthorizer.html" title="GDataClientLoginAuthorizer"><span class="type">GDataClientLoginAuthorizer</span></a> *self</code></em>);</pre>
<p>Returns the authorizer's client ID, as specified on constructing the <a class="link" href="GDataClientLoginAuthorizer.html" title="GDataClientLoginAuthorizer"><span class="type">GDataClientLoginAuthorizer</span></a>.</p>
<div class="refsect3">
<a name="gdata-client-login-authorizer-get-client-id.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="GDataClientLoginAuthorizer.html" title="GDataClientLoginAuthorizer"><span class="type">GDataClientLoginAuthorizer</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gdata-client-login-authorizer-get-client-id.returns"></a><h4>Returns</h4>
<p> the authorizer's client ID</p>
</div>
<p class="since">Since: <a class="link" href="ix11.html#api-index-0.9.0">0.9.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gdata-client-login-authorizer-get-username"></a><h3>gdata_client_login_authorizer_get_username ()</h3>
<pre class="programlisting">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
gdata_client_login_authorizer_get_username
(<em class="parameter"><code><a class="link" href="GDataClientLoginAuthorizer.html" title="GDataClientLoginAuthorizer"><span class="type">GDataClientLoginAuthorizer</span></a> *self</code></em>);</pre>
<p>Returns the username of the currently authenticated user, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if nobody is authenticated.</p>
<p>It is not safe to call this while an authentication operation is ongoing.</p>
<div class="refsect3">
<a name="gdata-client-login-authorizer-get-username.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="GDataClientLoginAuthorizer.html" title="GDataClientLoginAuthorizer"><span class="type">GDataClientLoginAuthorizer</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gdata-client-login-authorizer-get-username.returns"></a><h4>Returns</h4>
<p> the username of the currently authenticated user, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p>
</div>
<p class="since">Since: <a class="link" href="ix11.html#api-index-0.9.0">0.9.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gdata-client-login-authorizer-get-password"></a><h3>gdata_client_login_authorizer_get_password ()</h3>
<pre class="programlisting">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
gdata_client_login_authorizer_get_password
(<em class="parameter"><code><a class="link" href="GDataClientLoginAuthorizer.html" title="GDataClientLoginAuthorizer"><span class="type">GDataClientLoginAuthorizer</span></a> *self</code></em>);</pre>
<p>Returns the password of the currently authenticated user, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if nobody is authenticated.</p>
<p>It is not safe to call this while an authentication operation is ongoing.</p>
<p>If libgdata is compiled with libgcr support, the password will be stored in non-pageable memory. Since this function doesn't return
a copy of the password, the returned value is guaranteed to not hit disk. It's advised that any copies of the password made in client programs
also use non-pageable memory.</p>
<div class="refsect3">
<a name="gdata-client-login-authorizer-get-password.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="GDataClientLoginAuthorizer.html" title="GDataClientLoginAuthorizer"><span class="type">GDataClientLoginAuthorizer</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gdata-client-login-authorizer-get-password.returns"></a><h4>Returns</h4>
<p> the password of the currently authenticated user, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p>
</div>
<p class="since">Since: <a class="link" href="ix11.html#api-index-0.9.0">0.9.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gdata-client-login-authorizer-get-proxy-uri"></a><h3>gdata_client_login_authorizer_get_proxy_uri ()</h3>
<pre class="programlisting"><span class="returnvalue">SoupURI</span> *
gdata_client_login_authorizer_get_proxy_uri
(<em class="parameter"><code><a class="link" href="GDataClientLoginAuthorizer.html" title="GDataClientLoginAuthorizer"><span class="type">GDataClientLoginAuthorizer</span></a> *self</code></em>);</pre>
<div class="warning">
<p><code class="literal">gdata_client_login_authorizer_get_proxy_uri</code> has been deprecated since version 0.15.0 and should not be used in newly-written code.</p>
<p>Use <a class="link" href="GDataClientLoginAuthorizer.html#gdata-client-login-authorizer-get-proxy-resolver" title="gdata_client_login_authorizer_get_proxy_resolver ()"><code class="function">gdata_client_login_authorizer_get_proxy_resolver()</code></a> instead, which gives more flexibility over the proxy used.</p>
</div>
<p>Gets the proxy URI on the <a class="link" href="GDataClientLoginAuthorizer.html" title="GDataClientLoginAuthorizer"><span class="type">GDataClientLoginAuthorizer</span></a>'s <span class="type">SoupSession</span>.</p>
<div class="refsect3">
<a name="gdata-client-login-authorizer-get-proxy-uri.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="GDataClientLoginAuthorizer.html" title="GDataClientLoginAuthorizer"><span class="type">GDataClientLoginAuthorizer</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gdata-client-login-authorizer-get-proxy-uri.returns"></a><h4>Returns</h4>
<p>the proxy URI, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>; free with <code class="function">soup_uri_free()</code>. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
<p class="since">Since: <a class="link" href="ix11.html#api-index-0.9.0">0.9.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gdata-client-login-authorizer-set-proxy-uri"></a><h3>gdata_client_login_authorizer_set_proxy_uri ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gdata_client_login_authorizer_set_proxy_uri
(<em class="parameter"><code><a class="link" href="GDataClientLoginAuthorizer.html" title="GDataClientLoginAuthorizer"><span class="type">GDataClientLoginAuthorizer</span></a> *self</code></em>,
<em class="parameter"><code><span class="type">SoupURI</span> *proxy_uri</code></em>);</pre>
<div class="warning">
<p><code class="literal">gdata_client_login_authorizer_set_proxy_uri</code> has been deprecated since version 0.15.0 and should not be used in newly-written code.</p>
<p>Use <a class="link" href="GDataClientLoginAuthorizer.html#gdata-client-login-authorizer-set-proxy-resolver" title="gdata_client_login_authorizer_set_proxy_resolver ()"><code class="function">gdata_client_login_authorizer_set_proxy_resolver()</code></a> instead, which gives more flexibility over the proxy used.</p>
</div>
<p>Sets the proxy URI on the <span class="type">SoupSession</span> used internally by the <a class="link" href="GDataClientLoginAuthorizer.html" title="GDataClientLoginAuthorizer"><span class="type">GDataClientLoginAuthorizer</span></a>. This forces all requests through the given proxy.</p>
<p>If <em class="parameter"><code>proxy_uri</code></em>
is <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, no proxy will be used.</p>
<div class="refsect3">
<a name="gdata-client-login-authorizer-set-proxy-uri.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="GDataClientLoginAuthorizer.html" title="GDataClientLoginAuthorizer"><span class="type">GDataClientLoginAuthorizer</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>proxy_uri</p></td>
<td class="parameter_description"><p>the proxy URI, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix11.html#api-index-0.9.0">0.9.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gdata-client-login-authorizer-get-proxy-resolver"></a><h3>gdata_client_login_authorizer_get_proxy_resolver ()</h3>
<pre class="programlisting"><span class="returnvalue">GProxyResolver</span> *
gdata_client_login_authorizer_get_proxy_resolver
(<em class="parameter"><code><a class="link" href="GDataClientLoginAuthorizer.html" title="GDataClientLoginAuthorizer"><span class="type">GDataClientLoginAuthorizer</span></a> *self</code></em>);</pre>
<div class="warning"><p><code class="literal">gdata_client_login_authorizer_get_proxy_resolver</code> is deprecated and should not be used in newly-written code.</p></div>
<p>Gets the <span class="type">GProxyResolver</span> on the <a class="link" href="GDataClientLoginAuthorizer.html" title="GDataClientLoginAuthorizer"><span class="type">GDataClientLoginAuthorizer</span></a>'s <span class="type">SoupSession</span>.</p>
<div class="refsect3">
<a name="gdata-client-login-authorizer-get-proxy-resolver.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="GDataClientLoginAuthorizer.html" title="GDataClientLoginAuthorizer"><span class="type">GDataClientLoginAuthorizer</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gdata-client-login-authorizer-get-proxy-resolver.returns"></a><h4>Returns</h4>
<p>a <span class="type">GProxyResolver</span>, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>][<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></p>
</div>
<p class="since">Since: <a class="link" href="ix19.html#api-index-0.15.0">0.15.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gdata-client-login-authorizer-set-proxy-resolver"></a><h3>gdata_client_login_authorizer_set_proxy_resolver ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gdata_client_login_authorizer_set_proxy_resolver
(<em class="parameter"><code><a class="link" href="GDataClientLoginAuthorizer.html" title="GDataClientLoginAuthorizer"><span class="type">GDataClientLoginAuthorizer</span></a> *self</code></em>,
<em class="parameter"><code><span class="type">GProxyResolver</span> *proxy_resolver</code></em>);</pre>
<p>Sets the <span class="type">GProxyResolver</span> on the <span class="type">SoupSession</span> used internally by the given <a class="link" href="GDataClientLoginAuthorizer.html" title="GDataClientLoginAuthorizer"><span class="type">GDataClientLoginAuthorizer</span></a>.</p>
<p>Setting this will clear the <a class="link" href="GDataClientLoginAuthorizer.html#GDataClientLoginAuthorizer--proxy-uri" title="The “proxy-uri” property"><span class="type">“proxy-uri”</span></a> property.</p>
<div class="refsect3">
<a name="gdata-client-login-authorizer-set-proxy-resolver.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="GDataClientLoginAuthorizer.html" title="GDataClientLoginAuthorizer"><span class="type">GDataClientLoginAuthorizer</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>proxy_resolver</p></td>
<td class="parameter_description"><p>a <span class="type">GProxyResolver</span>, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix19.html#api-index-0.15.0">0.15.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gdata-client-login-authorizer-get-timeout"></a><h3>gdata_client_login_authorizer_get_timeout ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a>
gdata_client_login_authorizer_get_timeout
(<em class="parameter"><code><a class="link" href="GDataClientLoginAuthorizer.html" title="GDataClientLoginAuthorizer"><span class="type">GDataClientLoginAuthorizer</span></a> *self</code></em>);</pre>
<p>Gets the <a class="link" href="GDataClientLoginAuthorizer.html#GDataClientLoginAuthorizer--timeout" title="The “timeout” property"><span class="type">“timeout”</span></a> property; the network timeout, in seconds.</p>
<div class="refsect3">
<a name="gdata-client-login-authorizer-get-timeout.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="GDataClientLoginAuthorizer.html" title="GDataClientLoginAuthorizer"><span class="type">GDataClientLoginAuthorizer</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gdata-client-login-authorizer-get-timeout.returns"></a><h4>Returns</h4>
<p> the timeout, or <code class="code">0</code></p>
</div>
<p class="since">Since: <a class="link" href="ix11.html#api-index-0.9.0">0.9.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gdata-client-login-authorizer-set-timeout"></a><h3>gdata_client_login_authorizer_set_timeout ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gdata_client_login_authorizer_set_timeout
(<em class="parameter"><code><a class="link" href="GDataClientLoginAuthorizer.html" title="GDataClientLoginAuthorizer"><span class="type">GDataClientLoginAuthorizer</span></a> *self</code></em>,
<em class="parameter"><code><a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> timeout</code></em>);</pre>
<p>Sets the <a class="link" href="GDataClientLoginAuthorizer.html#GDataClientLoginAuthorizer--timeout" title="The “timeout” property"><span class="type">“timeout”</span></a> property; the network timeout, in seconds.</p>
<p>If <em class="parameter"><code>timeout</code></em>
is <code class="code">0</code>, network operations will never time out.</p>
<div class="refsect3">
<a name="gdata-client-login-authorizer-set-timeout.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="GDataClientLoginAuthorizer.html" title="GDataClientLoginAuthorizer"><span class="type">GDataClientLoginAuthorizer</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>timeout</p></td>
<td class="parameter_description"><p>the timeout, or <code class="code">0</code></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix11.html#api-index-0.9.0">0.9.0</a></p>
</div>
</div>
<div class="refsect1">
<a name="GDataClientLoginAuthorizer.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GDataClientLoginAuthorizer-struct"></a><h3>GDataClientLoginAuthorizer</h3>
<pre class="programlisting">typedef struct _GDataClientLoginAuthorizer GDataClientLoginAuthorizer;</pre>
<p>All the fields in the <a class="link" href="GDataClientLoginAuthorizer.html" title="GDataClientLoginAuthorizer"><span class="type">GDataClientLoginAuthorizer</span></a> structure are private and should never be accessed directly.</p>
<p class="since">Since: <a class="link" href="ix11.html#api-index-0.9.0">0.9.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="GDataClientLoginAuthorizerClass"></a><h3>GDataClientLoginAuthorizerClass</h3>
<pre class="programlisting">typedef struct {
} GDataClientLoginAuthorizerClass;
</pre>
<p>All the fields in the <a class="link" href="GDataClientLoginAuthorizer.html#GDataClientLoginAuthorizerClass" title="GDataClientLoginAuthorizerClass"><span class="type">GDataClientLoginAuthorizerClass</span></a> structure are private and should never be accessed directly.</p>
<p class="since">Since: <a class="link" href="ix11.html#api-index-0.9.0">0.9.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="GDataClientLoginAuthorizerError"></a><h3>enum GDataClientLoginAuthorizerError</h3>
<p>Error codes for authentication and authorization operations on <a class="link" href="GDataClientLoginAuthorizer.html" title="GDataClientLoginAuthorizer"><span class="type">GDataClientLoginAuthorizer</span></a>. See the</p>
<a class="ulink" href="http://code.google.com/apis/accounts/docs/AuthForInstalledApps.html#Errors" target="_top">online ClientLogin documentation</a> for
<p>more information.</p>
<div class="refsect3">
<a name="GDataClientLoginAuthorizerError.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="GDATA-CLIENT-LOGIN-AUTHORIZER-ERROR-BAD-AUTHENTICATION:CAPS"></a>GDATA_CLIENT_LOGIN_AUTHORIZER_ERROR_BAD_AUTHENTICATION</p></td>
<td class="enum_member_description">
<p>The login request used a username or password that is not recognized.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GDATA-CLIENT-LOGIN-AUTHORIZER-ERROR-NOT-VERIFIED:CAPS"></a>GDATA_CLIENT_LOGIN_AUTHORIZER_ERROR_NOT_VERIFIED</p></td>
<td class="enum_member_description">
<p>The account email address has not been verified. The user will need to access their Google
account directly to resolve the issue before logging in using a non-Google application.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GDATA-CLIENT-LOGIN-AUTHORIZER-ERROR-TERMS-NOT-AGREED:CAPS"></a>GDATA_CLIENT_LOGIN_AUTHORIZER_ERROR_TERMS_NOT_AGREED</p></td>
<td class="enum_member_description">
<p>The user has not agreed to terms. The user will need to access their Google account directly
to resolve the issue before logging in using a non-Google application.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GDATA-CLIENT-LOGIN-AUTHORIZER-ERROR-CAPTCHA-REQUIRED:CAPS"></a>GDATA_CLIENT_LOGIN_AUTHORIZER_ERROR_CAPTCHA_REQUIRED</p></td>
<td class="enum_member_description">
<p>A CAPTCHA is required. (A response with this error code will also contain an image URI and a
CAPTCHA token.)</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GDATA-CLIENT-LOGIN-AUTHORIZER-ERROR-ACCOUNT-DELETED:CAPS"></a>GDATA_CLIENT_LOGIN_AUTHORIZER_ERROR_ACCOUNT_DELETED</p></td>
<td class="enum_member_description">
<p>The user account has been deleted.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GDATA-CLIENT-LOGIN-AUTHORIZER-ERROR-ACCOUNT-DISABLED:CAPS"></a>GDATA_CLIENT_LOGIN_AUTHORIZER_ERROR_ACCOUNT_DISABLED</p></td>
<td class="enum_member_description">
<p>The user account has been disabled.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GDATA-CLIENT-LOGIN-AUTHORIZER-ERROR-SERVICE-DISABLED:CAPS"></a>GDATA_CLIENT_LOGIN_AUTHORIZER_ERROR_SERVICE_DISABLED</p></td>
<td class="enum_member_description">
<p>The user's access to the specified service has been disabled. (The user account may still be
valid.)</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GDATA-CLIENT-LOGIN-AUTHORIZER-ERROR-ACCOUNT-MIGRATED:CAPS"></a>GDATA_CLIENT_LOGIN_AUTHORIZER_ERROR_ACCOUNT_MIGRATED</p></td>
<td class="enum_member_description">
<p>The user's account login details have been migrated to a new system. (This is used for the
transition from the old YouTube login details to the new ones.)</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GDATA-CLIENT-LOGIN-AUTHORIZER-ERROR-INVALID-SECOND-FACTOR:CAPS"></a>GDATA_CLIENT_LOGIN_AUTHORIZER_ERROR_INVALID_SECOND_FACTOR</p></td>
<td class="enum_member_description">
<p>The user's account requires an application-specific password to be used.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix11.html#api-index-0.9.0">0.9.0</a></p>
</div>
</div>
<div class="refsect1">
<a name="GDataClientLoginAuthorizer.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GDataClientLoginAuthorizer--client-id"></a><h3>The <code class="literal">“client-id”</code> property</h3>
<pre class="programlisting"> “client-id” <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre>
<p>A client ID for your application (see the</p>
<a class="ulink" href="http://code.google.com/apis/accounts/docs/AuthForInstalledApps.html#Request" target="_top">reference documentation</a>).
<p>It is recommended that the ID is of the form <code class="literal"><em class="replaceable"><code>company name</code></em>-<em class="replaceable"><code>application name</code></em>-
<em class="replaceable"><code>version ID</code></em></code>.</p>
<p>Flags: Read / Write / Construct Only</p>
<p>Default value: NULL</p>
<p class="since">Since: <a class="link" href="ix11.html#api-index-0.9.0">0.9.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="GDataClientLoginAuthorizer--password"></a><h3>The <code class="literal">“password”</code> property</h3>
<pre class="programlisting"> “password” <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre>
<p>The user's account password for authentication.</p>
<p>This will only be set after authentication using <a class="link" href="GDataClientLoginAuthorizer.html#gdata-client-login-authorizer-authenticate" title="gdata_client_login_authorizer_authenticate ()"><code class="function">gdata_client_login_authorizer_authenticate()</code></a> is completed successfully. It will
then be set to the password passed to <a class="link" href="GDataClientLoginAuthorizer.html#gdata-client-login-authorizer-authenticate" title="gdata_client_login_authorizer_authenticate ()"><code class="function">gdata_client_login_authorizer_authenticate()</code></a>, and a <a href="../gobject/gobject-The-Base-Object-Type.html#GObject-notify"><span class="type">“notify”</span></a> signal will be emitted. If
authentication fails, it will be set to <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</p>
<p>If libgdata is compiled with libgcr support, the password will be stored in non-pageable memory. However, if it is retrieved
using <a href="../gobject/gobject-The-Base-Object-Type.html#g-object-get"><code class="function">g_object_get()</code></a> (or related functions) it will be copied to non-pageable memory and could end up being written to disk. Accessing
the password using <a class="link" href="GDataClientLoginAuthorizer.html#gdata-client-login-authorizer-get-password" title="gdata_client_login_authorizer_get_password ()"><code class="function">gdata_client_login_authorizer_get_password()</code></a> will not perform any copies, and so maintains privacy.</p>
<p>Flags: Read</p>
<p>Default value: NULL</p>
<p class="since">Since: <a class="link" href="ix11.html#api-index-0.9.0">0.9.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="GDataClientLoginAuthorizer--proxy-resolver"></a><h3>The <code class="literal">“proxy-resolver”</code> property</h3>
<pre class="programlisting"> “proxy-resolver” <span class="type">GProxyResolver</span> *</pre>
<p>The <span class="type">GProxyResolver</span> used to determine a proxy URI. Setting this will clear the <a class="link" href="GDataClientLoginAuthorizer.html#GDataClientLoginAuthorizer--proxy-uri" title="The “proxy-uri” property"><span class="type">“proxy-uri”</span></a> property.</p>
<p>Flags: Read / Write</p>
<p class="since">Since: <a class="link" href="ix19.html#api-index-0.15.0">0.15.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="GDataClientLoginAuthorizer--proxy-uri"></a><h3>The <code class="literal">“proxy-uri”</code> property</h3>
<pre class="programlisting"> “proxy-uri” <span class="type">SoupURI</span> *</pre>
<p>The proxy URI used internally for all network requests.</p>
<div class="warning">
<p><code class="literal">GDataClientLoginAuthorizer:proxy-uri</code> has been deprecated since version 0.15.0 and should not be used in newly-written code.</p>
<p>Use <a class="link" href="GDataClientLoginAuthorizer.html#GDataClientLoginAuthorizer--proxy-resolver" title="The “proxy-resolver” property"><span class="type">“proxy-resolver”</span></a> instead, which gives more flexibility over the proxy used.</p>
</div>
<p>Flags: Read / Write</p>
<p class="since">Since: <a class="link" href="ix11.html#api-index-0.9.0">0.9.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="GDataClientLoginAuthorizer--timeout"></a><h3>The <code class="literal">“timeout”</code> property</h3>
<pre class="programlisting"> “timeout” <a href="../glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a></pre>
<p>A timeout, in seconds, for network operations. If the timeout is exceeded, the operation will be cancelled and
<a class="link" href="GDataService.html#GDATA-SERVICE-ERROR-NETWORK-ERROR:CAPS"><code class="literal">GDATA_SERVICE_ERROR_NETWORK_ERROR</code></a> will be returned.</p>
<p>If the timeout is <code class="code">0</code>, operations will never time out.</p>
<p>Flags: Read / Write</p>
<p>Default value: 0</p>
<p class="since">Since: <a class="link" href="ix11.html#api-index-0.9.0">0.9.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="GDataClientLoginAuthorizer--username"></a><h3>The <code class="literal">“username”</code> property</h3>
<pre class="programlisting"> “username” <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre>
<p>The user's Google username for authentication. This will always be a full e-mail address.</p>
<p>This will only be set after authentication using <a class="link" href="GDataClientLoginAuthorizer.html#gdata-client-login-authorizer-authenticate" title="gdata_client_login_authorizer_authenticate ()"><code class="function">gdata_client_login_authorizer_authenticate()</code></a> is completed successfully. It will
then be set to the username passed to <a class="link" href="GDataClientLoginAuthorizer.html#gdata-client-login-authorizer-authenticate" title="gdata_client_login_authorizer_authenticate ()"><code class="function">gdata_client_login_authorizer_authenticate()</code></a>, and a <a href="../gobject/gobject-The-Base-Object-Type.html#GObject-notify"><span class="type">“notify”</span></a> signal will be emitted. If
authentication fails, it will be set to <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</p>
<p>Flags: Read</p>
<p>Default value: NULL</p>
<p class="since">Since: <a class="link" href="ix11.html#api-index-0.9.0">0.9.0</a></p>
</div>
</div>
<div class="refsect1">
<a name="GDataClientLoginAuthorizer.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="GDataClientLoginAuthorizer-captcha-challenge"></a><h3>The <code class="literal">“captcha-challenge”</code> signal</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a>*
user_function (<a class="link" href="GDataClientLoginAuthorizer.html" title="GDataClientLoginAuthorizer"><span class="type">GDataClientLoginAuthorizer</span></a> *authorizer,
<a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *uri,
<a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre>
<p>The <a class="link" href="GDataClientLoginAuthorizer.html#GDataClientLoginAuthorizer-captcha-challenge" title="The “captcha-challenge” signal"><span class="type">“captcha-challenge”</span></a> signal is emitted during the authentication process if the authorizer requires a CAPTCHA
to be completed. The URI of a CAPTCHA image is given, and the program should display this to the user, and return their response (the text
displayed in the image). There is no timeout imposed by the library for the response.</p>
<div class="refsect3">
<a name="GDataClientLoginAuthorizer-captcha-challenge.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>authorizer</p></td>
<td class="parameter_description"><p>the <a class="link" href="GDataClientLoginAuthorizer.html" title="GDataClientLoginAuthorizer"><span class="type">GDataClientLoginAuthorizer</span></a> which received the challenge</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>uri</p></td>
<td class="parameter_description"><p>the URI of the CAPTCHA image to be used</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="GDataClientLoginAuthorizer-captcha-challenge.returns"></a><h4>Returns</h4>
<p> a newly allocated string containing the text in the CAPTCHA image</p>
</div>
<p>Flags: <a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS">Run Last</a></p>
<p class="since">Since: <a class="link" href="ix11.html#api-index-0.9.0">0.9.0</a></p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.26.1</div>
</body>
</html>
|