/usr/share/gtk-doc/html/libaccounts-glib/AgAccountService.html is in libaccounts-glib-doc 1.23+17.04.20161104-0ubuntu1.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>AgAccountService: libaccounts-glib Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="libaccounts-glib Reference Manual">
<link rel="up" href="account-management.html" title="Account management">
<link rel="prev" href="AgAccount.html" title="AgAccount">
<link rel="next" href="AgAuthData.html" title="AgAuthData">
<meta name="generator" content="GTK-Doc V1.25 (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="#AgAccountService.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#AgAccountService.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span>
<a href="#AgAccountService.properties" class="shortcut">Properties</a></span><span id="nav_signals"> <span class="dim">|</span>
<a href="#AgAccountService.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="account-management.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="AgAccount.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="AgAuthData.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="AgAccountService"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="AgAccountService.top_of_page"></a>AgAccountService</span></h2>
<p>AgAccountService — Account settings for a specific service</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="AgAccountService.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="AgAccount.html" title="AgAccount"><span class="returnvalue">AgAccount</span></a> *
</td>
<td class="function_name">
<a class="link" href="AgAccountService.html#ag-account-service-get-account" title="ag_account_service_get_account ()">ag_account_service_get_account</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gchar</span> **
</td>
<td class="function_name">
<a class="link" href="AgAccountService.html#ag-account-service-get-changed-fields" title="ag_account_service_get_changed_fields ()">ag_account_service_get_changed_fields</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="AgAccountService.html#ag-account-service-get-enabled" title="ag_account_service_get_enabled ()">ag_account_service_get_enabled</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="AgService.html" title="AgService"><span class="returnvalue">AgService</span></a> *
</td>
<td class="function_name">
<a class="link" href="AgAccountService.html#ag-account-service-get-service" title="ag_account_service_get_service ()">ag_account_service_get_service</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="AgAccount.html#AgAccountSettingIter"><span class="returnvalue">AgAccountSettingIter</span></a> *
</td>
<td class="function_name">
<a class="link" href="AgAccountService.html#ag-account-service-get-settings-iter" title="ag_account_service_get_settings_iter ()">ag_account_service_get_settings_iter</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="AgAccount.html#AgSettingSource" title="enum AgSettingSource"><span class="returnvalue">AgSettingSource</span></a>
</td>
<td class="function_name">
<a class="link" href="AgAccountService.html#ag-account-service-get-value" title="ag_account_service_get_value ()">ag_account_service_get_value</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="AgAccountService.html" title="AgAccountService"><span class="returnvalue">AgAccountService</span></a> *
</td>
<td class="function_name">
<a class="link" href="AgAccountService.html#ag-account-service-new" title="ag_account_service_new ()">ag_account_service_new</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="AgAccountService.html#ag-account-service-set-value" title="ag_account_service_set_value ()">ag_account_service_set_value</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">GVariant</span> *
</td>
<td class="function_name">
<a class="link" href="AgAccountService.html#ag-account-service-get-variant" title="ag_account_service_get_variant ()">ag_account_service_get_variant</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="AgAccountService.html#ag-account-service-set-variant" title="ag_account_service_set_variant ()">ag_account_service_set_variant</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="AgAccountService.html#ag-account-service-settings-iter-init" title="ag_account_service_settings_iter_init ()">ag_account_service_settings_iter_init</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="AgAccountService.html#ag-account-service-settings-iter-next" title="ag_account_service_settings_iter_next ()">ag_account_service_settings_iter_next</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="AgAuthData.html" title="AgAuthData"><span class="returnvalue">AgAuthData</span></a> *
</td>
<td class="function_name">
<a class="link" href="AgAccountService.html#ag-account-service-get-auth-data" title="ag_account_service_get_auth_data ()">ag_account_service_get_auth_data</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="AgAccountService.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 class="link" href="AgAccount.html" title="AgAccount"><span class="type">AgAccount</span></a> *</td>
<td class="property_name"><a class="link" href="AgAccountService.html#AgAccountService--account" title="The “account” property">account</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr>
<tr>
<td class="property_type"><span class="type">gboolean</span></td>
<td class="property_name"><a class="link" href="AgAccountService.html#AgAccountService--enabled" title="The “enabled” property">enabled</a></td>
<td class="property_flags">Read</td>
</tr>
<tr>
<td class="property_type">
<a class="link" href="AgService.html" title="AgService"><span class="type">AgService</span></a> *</td>
<td class="property_name"><a class="link" href="AgAccountService.html#AgAccountService--service" title="The “service” property">service</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="AgAccountService.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"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="AgAccountService.html#AgAccountService-changed" title="The “changed” signal">changed</a></td>
<td class="signal_flags">Run Last</td>
</tr>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="AgAccountService.html#AgAccountService-enabled" title="The “enabled” signal">enabled</a></td>
<td class="signal_flags">Run Last</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="AgAccountService.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="AgAccountService.html#AgAccountService-struct" title="AgAccountService">AgAccountService</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="AgAccountService.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> GObject
<span class="lineart">╰──</span> AgAccountService
</pre>
</div>
<div class="refsect1">
<a name="AgAccountService.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <libaccounts-glib/ag-account-service.h>
</pre>
</div>
<div class="refsect1">
<a name="AgAccountService.description"></a><h2>Description</h2>
<p>The <a class="link" href="AgAccountService.html" title="AgAccountService"><span class="type">AgAccountService</span></a> object provides access to the account settings for a
specific service type. It is meant to be easier to use than the <a class="link" href="AgAccount.html" title="AgAccount"><span class="type">AgAccount</span></a>
class because it hides the complexity of the account structure and gives
access to only the limited subset of account settings which are relevant to
a service.</p>
<p>To get an <a class="link" href="AgAccountService.html" title="AgAccountService"><span class="type">AgAccountService</span></a> one can use the <a class="link" href="AgManager.html" title="AgManager"><span class="type">AgManager</span></a> methods
<a class="link" href="AgManager.html#ag-manager-get-account-services" title="ag_manager_get_account_services ()"><code class="function">ag_manager_get_account_services()</code></a> or
<a class="link" href="AgManager.html#ag-manager-get-enabled-account-services" title="ag_manager_get_enabled_account_services ()"><code class="function">ag_manager_get_enabled_account_services()</code></a>, which both return a <span class="type">GList</span> of
account services. Note that if the <a class="link" href="AgManager.html" title="AgManager"><span class="type">AgManager</span></a> was instantiated for a
specific service type, these lists will contain only those account services
matching that service type.
Another way to get an <a class="link" href="AgAccountService.html" title="AgAccountService"><span class="type">AgAccountService</span></a> is to instantiate one using
<a class="link" href="AgAccountService.html#ag-account-service-new" title="ag_account_service_new ()"><code class="function">ag_account_service_new()</code></a>: this is useful if one already has an <a class="link" href="AgAccount.html" title="AgAccount"><span class="type">AgAccount</span></a>
instance.</p>
<p>This is intended to be a convenient wrapper over the accounts settings
specific for a service; as such, it doesn't offer all the editing
possibilities offered by the <a class="link" href="AgAccount.html" title="AgAccount"><span class="type">AgAccount</span></a> class, such as enabling the service
itself: these operations should ideally not be performed by consumer
applications, but by the account editing UI only.</p>
<div class="example">
<a name="id-1.3.3.4.9.5"></a><p class="title"><b>Example 2. Querying available e-mail services</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
32
33
34
35
36
37
38
39</pre></td>
<td class="listing_code"><pre class="programlisting">AgManager <span class="gtkdoc opt">*</span>manager<span class="gtkdoc opt">;</span>
GList <span class="gtkdoc opt">*</span>services<span class="gtkdoc opt">, *</span>list<span class="gtkdoc opt">;</span>
<span class="gtkdoc slc">// Instantiate an account manager interested in e-mail services only.</span>
manager <span class="gtkdoc opt">=</span> <span class="function"><a href="AgManager.html#ag-manager-new-for-service-type">ag_manager_new_for_service_type</a></span> <span class="gtkdoc opt">(</span><span class="string">"e-mail"</span><span class="gtkdoc opt">);</span>
<span class="gtkdoc slc">// Get the list of enabled AgAccountService objects of type e-mail.</span>
services <span class="gtkdoc opt">=</span> <span class="function"><a href="AgManager.html#ag-manager-get-enabled-account-services">ag_manager_get_enabled_account_services</a></span> <span class="gtkdoc opt">(</span>manager<span class="gtkdoc opt">);</span>
<span class="gtkdoc slc">// Loop through the account services and do something useful with them.</span>
<span class="keyword">for</span> <span class="gtkdoc opt">(</span>list <span class="gtkdoc opt">=</span> services<span class="gtkdoc opt">;</span> list <span class="gtkdoc opt">!=</span> NULL<span class="gtkdoc opt">;</span> list <span class="gtkdoc opt">=</span> list<span class="gtkdoc opt">-></span>next<span class="gtkdoc opt">)</span>
<span class="gtkdoc opt">{</span>
AgAccountService <span class="gtkdoc opt">*</span>service <span class="gtkdoc opt">=</span> <span class="function">AG_ACCOUNT_SERVICE</span> <span class="gtkdoc opt">(</span>list<span class="gtkdoc opt">-></span>data<span class="gtkdoc opt">);</span>
GVariant <span class="gtkdoc opt">*</span>v_server<span class="gtkdoc opt">, *</span>v_port<span class="gtkdoc opt">, *</span>v_username<span class="gtkdoc opt">;</span>
gchar <span class="gtkdoc opt">*</span>server <span class="gtkdoc opt">=</span> NULL<span class="gtkdoc opt">, *</span>username <span class="gtkdoc opt">=</span> NULL<span class="gtkdoc opt">;</span>
gint port<span class="gtkdoc opt">;</span>
AgAccount <span class="gtkdoc opt">*</span>account<span class="gtkdoc opt">;</span>
v_server <span class="gtkdoc opt">=</span> <span class="function"><a href="AgAccountService.html#ag-account-service-get-variant">ag_account_service_get_variant</a></span> <span class="gtkdoc opt">(</span>service<span class="gtkdoc opt">,</span> <span class="string">"pop3/hostname"</span><span class="gtkdoc opt">,</span> NULL<span class="gtkdoc opt">);</span>
<span class="keyword">if</span> <span class="gtkdoc opt">(</span>v_server <span class="gtkdoc opt">!=</span> NULL<span class="gtkdoc opt">)</span>
server <span class="gtkdoc opt">=</span> <span class="function">g_variant_dup_string</span> <span class="gtkdoc opt">(</span>v_server<span class="gtkdoc opt">,</span> NULL<span class="gtkdoc opt">);</span>
v_port <span class="gtkdoc opt">=</span> <span class="function"><a href="AgAccountService.html#ag-account-service-get-variant">ag_account_service_get_variant</a></span> <span class="gtkdoc opt">(</span>service<span class="gtkdoc opt">,</span> <span class="string">"pop3/port"</span><span class="gtkdoc opt">,</span> NULL<span class="gtkdoc opt">);</span>
<span class="keyword">if</span> <span class="gtkdoc opt">(</span>v_port <span class="gtkdoc opt">!=</span> NULL<span class="gtkdoc opt">)</span>
port <span class="gtkdoc opt">=</span> <span class="function">g_variant_get_int16</span> <span class="gtkdoc opt">(&</span>v_port<span class="gtkdoc opt">);</span>
<span class="gtkdoc slc">// Suppose that the e-mail address is stored in the global account</span>
<span class="gtkdoc slc">// settings; let's get it from there:</span>
account <span class="gtkdoc opt">=</span> <span class="function"><a href="AgAccountService.html#ag-account-service-get-account">ag_account_service_get_account</a></span> <span class="gtkdoc opt">(</span>service<span class="gtkdoc opt">);</span>
<span class="function"><a href="AgAccount.html#ag-account-select-service">ag_account_select_service</a></span> <span class="gtkdoc opt">(</span>NULL<span class="gtkdoc opt">);</span>
v_username <span class="gtkdoc opt">=</span> <span class="function"><a href="AgAccount.html#ag-account-get-variant">ag_account_get_variant</a></span> <span class="gtkdoc opt">(</span>account<span class="gtkdoc opt">,</span> <span class="string">"username"</span><span class="gtkdoc opt">,</span> NULL<span class="gtkdoc opt">);</span>
<span class="keyword">if</span> <span class="gtkdoc opt">(</span>v_username <span class="gtkdoc opt">!=</span> NULL<span class="gtkdoc opt">)</span>
username <span class="gtkdoc opt">=</span> <span class="function">g_variant_dup_string</span> <span class="gtkdoc opt">(&</span>v_username<span class="gtkdoc opt">);</span>
<span class="gtkdoc opt">...</span>
<span class="function">g_free</span> <span class="gtkdoc opt">(</span>username<span class="gtkdoc opt">);</span>
<span class="function">g_free</span> <span class="gtkdoc opt">(</span>server<span class="gtkdoc opt">);</span>
<span class="gtkdoc opt">}</span></pre></td>
</tr>
</tbody>
</table>
</div>
</div>
<br class="example-break"><div class="note"><p>
User applications (with the notable exception of the accounts editing
application) should never use account services which are not enabled, and
should stop using an account when the account service becomes disabled. The
latter can be done by connecting to the <a class="link" href="AgAccountService.html#AgAccountService-changed" title="The “changed” signal"><span class="type">“changed”</span></a> signal
and checking if <a class="link" href="AgAccountService.html#ag-account-service-get-enabled" title="ag_account_service_get_enabled ()"><code class="function">ag_account_service_get_enabled()</code></a> still returns <code class="literal">TRUE</code>.
Note that if the account gets deleted, it will always get disabled first;
so, there is no need to connect to the <a class="link" href="AgAccount.html#AgAccount-deleted" title="The “deleted” signal"><span class="type">“deleted”</span></a> signal; one can
just monitor the <a class="link" href="AgAccountService.html#AgAccountService-changed" title="The “changed” signal"><span class="type">“changed”</span></a> signal.
</p></div>
</div>
<div class="refsect1">
<a name="AgAccountService.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="ag-account-service-get-account"></a><h3>ag_account_service_get_account ()</h3>
<pre class="programlisting"><a class="link" href="AgAccount.html" title="AgAccount"><span class="returnvalue">AgAccount</span></a> *
ag_account_service_get_account (<em class="parameter"><code><a class="link" href="AgAccountService.html" title="AgAccountService"><span class="type">AgAccountService</span></a> *self</code></em>);</pre>
<p>Get the <a class="link" href="AgAccount.html" title="AgAccount"><span class="type">AgAccount</span></a> associated with <em class="parameter"><code>self</code></em>
.</p>
<div class="refsect3">
<a name="ag-account-service-get-account.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>the <a class="link" href="AgAccountService.html" title="AgAccountService"><span class="type">AgAccountService</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="ag-account-service-get-account.returns"></a><h4>Returns</h4>
<p> the underlying <a class="link" href="AgAccount.html" title="AgAccount"><span class="type">AgAccount</span></a>. The reference count on
it is not incremented, so if you need to use it beyond the lifetime of
<em class="parameter"><code>self</code></em>
, you need to call <code class="function">g_object_ref()</code> on it yourself. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="ag-account-service-get-changed-fields"></a><h3>ag_account_service_get_changed_fields ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> **
ag_account_service_get_changed_fields (<em class="parameter"><code><a class="link" href="AgAccountService.html" title="AgAccountService"><span class="type">AgAccountService</span></a> *self</code></em>);</pre>
<p>This method should be called only in the context of a handler of the
<a class="link" href="AgAccountService.html#AgAccountService-changed" title="The “changed” signal"><span class="type">“changed”</span></a> signal, and can be used to retrieve the set of
changes.</p>
<div class="refsect3">
<a name="ag-account-service-get-changed-fields.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>the <a class="link" href="AgAccountService.html" title="AgAccountService"><span class="type">AgAccountService</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="ag-account-service-get-changed-fields.returns"></a><h4>Returns</h4>
<p> a newly allocated array of strings describing the
keys of the fields which have been altered. It must be free'd with
<code class="function">g_strfreev()</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>
</div>
<hr>
<div class="refsect2">
<a name="ag-account-service-get-enabled"></a><h3>ag_account_service_get_enabled ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
ag_account_service_get_enabled (<em class="parameter"><code><a class="link" href="AgAccountService.html" title="AgAccountService"><span class="type">AgAccountService</span></a> *self</code></em>);</pre>
<p>Checks whether the underlying <a class="link" href="AgAccount.html" title="AgAccount"><span class="type">AgAccount</span></a> is enabled and the selected
<a class="link" href="AgService.html" title="AgService"><span class="type">AgService</span></a> is enabled on it. If this method returns <code class="literal">FALSE</code>, applications
should not try to use this object.</p>
<div class="refsect3">
<a name="ag-account-service-get-enabled.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>the <a class="link" href="AgAccountService.html" title="AgAccountService"><span class="type">AgAccountService</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="ag-account-service-get-enabled.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if the service is enabled, <code class="literal">FALSE</code> otherwise.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="ag-account-service-get-service"></a><h3>ag_account_service_get_service ()</h3>
<pre class="programlisting"><a class="link" href="AgService.html" title="AgService"><span class="returnvalue">AgService</span></a> *
ag_account_service_get_service (<em class="parameter"><code><a class="link" href="AgAccountService.html" title="AgAccountService"><span class="type">AgAccountService</span></a> *self</code></em>);</pre>
<p>Get the <a class="link" href="AgService.html" title="AgService"><span class="type">AgService</span></a> associated with <em class="parameter"><code>self</code></em>
.</p>
<div class="refsect3">
<a name="ag-account-service-get-service.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>the <a class="link" href="AgAccountService.html" title="AgAccountService"><span class="type">AgAccountService</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="ag-account-service-get-service.returns"></a><h4>Returns</h4>
<p> the underlying <a class="link" href="AgService.html" title="AgService"><span class="type">AgService</span></a>. The reference count on
it is not incremented, so if you need to use it beyond the lifetime of
<em class="parameter"><code>self</code></em>
, you need to call <a class="link" href="AgService.html#ag-service-ref" title="ag_service_ref ()"><code class="function">ag_service_ref()</code></a> on it yourself. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="ag-account-service-get-settings-iter"></a><h3>ag_account_service_get_settings_iter ()</h3>
<pre class="programlisting"><a class="link" href="AgAccount.html#AgAccountSettingIter"><span class="returnvalue">AgAccountSettingIter</span></a> *
ag_account_service_get_settings_iter (<em class="parameter"><code><a class="link" href="AgAccountService.html" title="AgAccountService"><span class="type">AgAccountService</span></a> *self</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *key_prefix</code></em>);</pre>
<p>Creates a new iterator. This method is useful for language bindings only.</p>
<div class="refsect3">
<a name="ag-account-service-get-settings-iter.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>the <a class="link" href="AgAccountService.html" title="AgAccountService"><span class="type">AgAccountService</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>key_prefix</p></td>
<td class="parameter_description"><p> enumerate only the settings whose key starts with
<em class="parameter"><code>key_prefix</code></em>
. </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>
<div class="refsect3">
<a name="ag-account-service-get-settings-iter.returns"></a><h4>Returns</h4>
<p> an <a class="link" href="AgAccount.html#AgAccountSettingIter"><span class="type">AgAccountSettingIter</span></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>
</div>
<hr>
<div class="refsect2">
<a name="ag-account-service-get-value"></a><h3>ag_account_service_get_value ()</h3>
<pre class="programlisting"><a class="link" href="AgAccount.html#AgSettingSource" title="enum AgSettingSource"><span class="returnvalue">AgSettingSource</span></a>
ag_account_service_get_value (<em class="parameter"><code><a class="link" href="AgAccountService.html" title="AgAccountService"><span class="type">AgAccountService</span></a> *self</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *key</code></em>,
<em class="parameter"><code><span class="type">GValue</span> *value</code></em>);</pre>
<div class="warning">
<p><code class="literal">ag_account_service_get_value</code> has been deprecated since version 1.4 and should not be used in newly-written code.</p>
<p>Use <a class="link" href="AgAccountService.html#ag-account-service-get-variant" title="ag_account_service_get_variant ()"><code class="function">ag_account_service_get_variant()</code></a> instead.</p>
</div>
<p>Gets the value of the configuration setting <em class="parameter"><code>key</code></em>
: <em class="parameter"><code>value</code></em>
must be a
<span class="type">GValue</span> initialized to the type of the setting.</p>
<div class="refsect3">
<a name="ag-account-service-get-value.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>the <a class="link" href="AgAccountService.html" title="AgAccountService"><span class="type">AgAccountService</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>key</p></td>
<td class="parameter_description"><p>the name of the setting to retrieve.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>value</p></td>
<td class="parameter_description"><p> an initialized <span class="type">GValue</span> to receive the setting's value. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for input and for returning results. Default is transfer full."><span class="acronym">inout</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="ag-account-service-get-value.returns"></a><h4>Returns</h4>
<p> one of <span class="type"><a class="link" href="AgAccount.html#AgSettingSource" title="enum AgSettingSource"><span class="type">AgSettingSource</span></a></span>: <a class="link" href="AgAccount.html#AG-SETTING-SOURCE-NONE:CAPS"><code class="literal">AG_SETTING_SOURCE_NONE</code></a> if
the setting is not present, <a class="link" href="AgAccount.html#AG-SETTING-SOURCE-ACCOUNT:CAPS"><code class="literal">AG_SETTING_SOURCE_ACCOUNT</code></a> if the setting comes
from the account configuration, or <a class="link" href="AgAccount.html#AG-SETTING-SOURCE-PROFILE:CAPS"><code class="literal">AG_SETTING_SOURCE_PROFILE</code></a> if the value
comes as predefined in the profile.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="ag-account-service-new"></a><h3>ag_account_service_new ()</h3>
<pre class="programlisting"><a class="link" href="AgAccountService.html" title="AgAccountService"><span class="returnvalue">AgAccountService</span></a> *
ag_account_service_new (<em class="parameter"><code><a class="link" href="AgAccount.html" title="AgAccount"><span class="type">AgAccount</span></a> *account</code></em>,
<em class="parameter"><code><a class="link" href="AgService.html" title="AgService"><span class="type">AgService</span></a> *service</code></em>);</pre>
<p>Constructor. If <em class="parameter"><code>service</code></em>
is <code class="literal">NULL</code>, the returned object will operate on the
global account settings.</p>
<div class="refsect3">
<a name="ag-account-service-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>account</p></td>
<td class="parameter_description"><p> an <a class="link" href="AgAccount.html" title="AgAccount"><span class="type">AgAccount</span></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>service</p></td>
<td class="parameter_description"><p> an <a class="link" href="AgService.html" title="AgService"><span class="type">AgService</span></a> supported by <em class="parameter"><code>account</code></em>
. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>][<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>
<div class="refsect3">
<a name="ag-account-service-new.returns"></a><h4>Returns</h4>
<p> a new <a class="link" href="AgAccountService.html" title="AgAccountService"><span class="type">AgAccountService</span></a>; call <code class="function">g_object_unref()</code> when you don't need
this object anymore.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="ag-account-service-set-value"></a><h3>ag_account_service_set_value ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
ag_account_service_set_value (<em class="parameter"><code><a class="link" href="AgAccountService.html" title="AgAccountService"><span class="type">AgAccountService</span></a> *self</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *key</code></em>,
<em class="parameter"><code>const <span class="type">GValue</span> *value</code></em>);</pre>
<div class="warning">
<p><code class="literal">ag_account_service_set_value</code> has been deprecated since version 1.4 and should not be used in newly-written code.</p>
<p>Use <a class="link" href="AgAccountService.html#ag-account-service-set-variant" title="ag_account_service_set_variant ()"><code class="function">ag_account_service_set_variant()</code></a> instead.</p>
</div>
<p>Sets the value of the configuration setting <em class="parameter"><code>key</code></em>
to the value <em class="parameter"><code>value</code></em>
.
If <em class="parameter"><code>value</code></em>
is <code class="literal">NULL</code>, then the setting is unset.</p>
<div class="refsect3">
<a name="ag-account-service-set-value.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>the <a class="link" href="AgAccountService.html" title="AgAccountService"><span class="type">AgAccountService</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>key</p></td>
<td class="parameter_description"><p>the name of the setting to change.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>value</p></td>
<td class="parameter_description"><p> a <span class="type">GValue</span> holding the new setting's value. </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>
</div>
<hr>
<div class="refsect2">
<a name="ag-account-service-get-variant"></a><h3>ag_account_service_get_variant ()</h3>
<pre class="programlisting"><span class="returnvalue">GVariant</span> *
ag_account_service_get_variant (<em class="parameter"><code><a class="link" href="AgAccountService.html" title="AgAccountService"><span class="type">AgAccountService</span></a> *self</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *key</code></em>,
<em class="parameter"><code><a class="link" href="AgAccount.html#AgSettingSource" title="enum AgSettingSource"><span class="type">AgSettingSource</span></a> *source</code></em>);</pre>
<p>Gets the value of the configuration setting <em class="parameter"><code>key</code></em>
.</p>
<div class="refsect3">
<a name="ag-account-service-get-variant.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>the <a class="link" href="AgAccountService.html" title="AgAccountService"><span class="type">AgAccountService</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>key</p></td>
<td class="parameter_description"><p>the name of the setting to retrieve.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>source</p></td>
<td class="parameter_description"><p> a pointer to an
<a class="link" href="AgAccount.html#AgSettingSource" title="enum AgSettingSource"><span class="type">AgSettingSource</span></a> variable which will tell whether the setting was
retrieved from the accounts DB or from a service template. </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>][<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="ag-account-service-get-variant.returns"></a><h4>Returns</h4>
<p> a <span class="type">GVariant</span> holding the setting value, or
<code class="literal">NULL</code>. The returned <span class="type">GVariant</span> is owned by the account, and no guarantees
are made about its lifetime. If the client wishes to keep it, it should
call <code class="function">g_variant_ref()</code> on it. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
<p class="since">Since: <a class="link" href="api-index-1-4.html#api-index-1.4">1.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="ag-account-service-set-variant"></a><h3>ag_account_service_set_variant ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
ag_account_service_set_variant (<em class="parameter"><code><a class="link" href="AgAccountService.html" title="AgAccountService"><span class="type">AgAccountService</span></a> *self</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *key</code></em>,
<em class="parameter"><code><span class="type">GVariant</span> *value</code></em>);</pre>
<p>Sets the value of the configuration setting <em class="parameter"><code>key</code></em>
to the value <em class="parameter"><code>value</code></em>
.
If <em class="parameter"><code>value</code></em>
has a floating reference, the <em class="parameter"><code>account</code></em>
will take ownership
of it.
If <em class="parameter"><code>value</code></em>
is <code class="literal">NULL</code>, then the setting is unset.</p>
<div class="refsect3">
<a name="ag-account-service-set-variant.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>the <a class="link" href="AgAccountService.html" title="AgAccountService"><span class="type">AgAccountService</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>key</p></td>
<td class="parameter_description"><p>the name of the setting to change.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>value</p></td>
<td class="parameter_description"><p> a <span class="type">GVariant</span> holding the new setting's value. </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="api-index-1-4.html#api-index-1.4">1.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="ag-account-service-settings-iter-init"></a><h3>ag_account_service_settings_iter_init ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
ag_account_service_settings_iter_init (<em class="parameter"><code><a class="link" href="AgAccountService.html" title="AgAccountService"><span class="type">AgAccountService</span></a> *self</code></em>,
<em class="parameter"><code><a class="link" href="AgAccount.html#AgAccountSettingIter"><span class="type">AgAccountSettingIter</span></a> *iter</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *key_prefix</code></em>);</pre>
<p>Initializes <em class="parameter"><code>iter</code></em>
to iterate over the account settings. If <em class="parameter"><code>key_prefix</code></em>
is
not <code class="literal">NULL</code>, only keys whose names start with <em class="parameter"><code>key_prefix</code></em>
will be iterated
over.
After calling this method, one would typically call
<a class="link" href="AgAccount.html#ag-account-settings-iter-get-next" title="ag_account_settings_iter_get_next ()"><code class="function">ag_account_settings_iter_get_next()</code></a> to read the settings one by one.</p>
<div class="refsect3">
<a name="ag-account-service-settings-iter-init.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>the <a class="link" href="AgAccountService.html" title="AgAccountService"><span class="type">AgAccountService</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>iter</p></td>
<td class="parameter_description"><p>an uninitialized <a class="link" href="AgAccount.html#AgAccountSettingIter"><span class="type">AgAccountSettingIter</span></a> structure.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>key_prefix</p></td>
<td class="parameter_description"><p> enumerate only the settings whose key starts with
<em class="parameter"><code>key_prefix</code></em>
. </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>
</div>
<hr>
<div class="refsect2">
<a name="ag-account-service-settings-iter-next"></a><h3>ag_account_service_settings_iter_next ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
ag_account_service_settings_iter_next (<em class="parameter"><code><a class="link" href="AgAccount.html#AgAccountSettingIter"><span class="type">AgAccountSettingIter</span></a> *iter</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> **key</code></em>,
<em class="parameter"><code>const <span class="type">GValue</span> **value</code></em>);</pre>
<div class="warning">
<p><code class="literal">ag_account_service_settings_iter_next</code> has been deprecated since version 1.4 and should not be used in newly-written code.</p>
<p>Use <a class="link" href="AgAccount.html#ag-account-settings-iter-get-next" title="ag_account_settings_iter_get_next ()"><code class="function">ag_account_settings_iter_get_next()</code></a> instead.</p>
</div>
<p>Iterates over the account keys. <em class="parameter"><code>iter</code></em>
must be an iterator previously
initialized with <a class="link" href="AgAccountService.html#ag-account-service-settings-iter-init" title="ag_account_service_settings_iter_init ()"><code class="function">ag_account_service_settings_iter_init()</code></a>.</p>
<div class="refsect3">
<a name="ag-account-service-settings-iter-next.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>iter</p></td>
<td class="parameter_description"><p>an initialized <a class="link" href="AgAccount.html#AgAccountSettingIter"><span class="type">AgAccountSettingIter</span></a> structure.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>key</p></td>
<td class="parameter_description"><p> a pointer to a string
receiving the key name. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Out parameter, where caller must allocate storage."><span class="acronym">out callee-allocates</span></acronym>][<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>value</p></td>
<td class="parameter_description"><p> a pointer to a pointer to a
<span class="type">GValue</span>, to receive the key value. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Out parameter, where caller must allocate storage."><span class="acronym">out callee-allocates</span></acronym>][<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="ag-account-service-settings-iter-next.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if <em class="parameter"><code>key</code></em>
and <em class="parameter"><code>value</code></em>
have been set, <code class="literal">FALSE</code> if we there are no
more account settings to iterate over.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="ag-account-service-get-auth-data"></a><h3>ag_account_service_get_auth_data ()</h3>
<pre class="programlisting"><a class="link" href="AgAuthData.html" title="AgAuthData"><span class="returnvalue">AgAuthData</span></a> *
ag_account_service_get_auth_data (<em class="parameter"><code><a class="link" href="AgAccountService.html" title="AgAccountService"><span class="type">AgAccountService</span></a> *self</code></em>);</pre>
<p>Reads the authentication data stored in the account (merging the
service-specific settings with the global account settings) and returns an
<a class="link" href="AgAuthData.html" title="AgAuthData"><span class="type">AgAuthData</span></a> structure.
The method and mechanism are read from the "auth/method" and
"auth/mechanism" keys, respectively. The authentication parameters are
found under the "auth/<method>/<mechanism>/" group.</p>
<div class="refsect3">
<a name="ag-account-service-get-auth-data.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>the <a class="link" href="AgAccountService.html" title="AgAccountService"><span class="type">AgAccountService</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="ag-account-service-get-auth-data.returns"></a><h4>Returns</h4>
<p> a newly allocated <a class="link" href="AgAuthData.html" title="AgAuthData"><span class="type">AgAuthData</span></a> structure. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
</div>
</div>
<div class="refsect1">
<a name="AgAccountService.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="AgAccountService-struct"></a><h3>AgAccountService</h3>
<pre class="programlisting">typedef struct _AgAccountService AgAccountService;</pre>
<p>Opaque structure. Use related accessor functions.</p>
</div>
</div>
<div class="refsect1">
<a name="AgAccountService.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="AgAccountService--account"></a><h3>The <code class="literal">“account”</code> property</h3>
<pre class="programlisting"> “account” <a class="link" href="AgAccount.html" title="AgAccount"><span class="type">AgAccount</span></a> *</pre>
<p>The <a class="link" href="AgAccount.html" title="AgAccount"><span class="type">AgAccount</span></a> used by the account service.</p>
<p>Flags: Read / Write / Construct Only</p>
<p class="since">Since: <a class="link" href="api-index-1-4.html#api-index-1.4">1.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="AgAccountService--enabled"></a><h3>The <code class="literal">“enabled”</code> property</h3>
<pre class="programlisting"> “enabled” <span class="type">gboolean</span></pre>
<p>Whether the account service is currently enabled. The value of
this property is <code class="literal">TRUE</code> if and only if the underlying <a class="link" href="AgAccount.html" title="AgAccount"><span class="type">AgAccount</span></a>
is enabled and the selected <a class="link" href="AgService.html" title="AgService"><span class="type">AgService</span></a> is enabled on it. If this
property is <code class="literal">FALSE</code>, applications should not try to use this
object.</p>
<p>Flags: Read</p>
<p>Default value: FALSE</p>
<p class="since">Since: <a class="link" href="api-index-1-4.html#api-index-1.4">1.4</a></p>
</div>
<hr>
<div class="refsect2">
<a name="AgAccountService--service"></a><h3>The <code class="literal">“service”</code> property</h3>
<pre class="programlisting"> “service” <a class="link" href="AgService.html" title="AgService"><span class="type">AgService</span></a> *</pre>
<p>The <a class="link" href="AgService.html" title="AgService"><span class="type">AgService</span></a> used by the account service.</p>
<p>Flags: Read / Write / Construct Only</p>
<p class="since">Since: <a class="link" href="api-index-1-4.html#api-index-1.4">1.4</a></p>
</div>
</div>
<div class="refsect1">
<a name="AgAccountService.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="AgAccountService-changed"></a><h3>The <code class="literal">“changed”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="AgAccountService.html" title="AgAccountService"><span class="type">AgAccountService</span></a> *self,
<span class="type">gpointer</span> user_data)</pre>
<p>Emitted when some setting has changed on the account service. You can
use the <a class="link" href="AgAccountService.html#ag-account-service-get-changed-fields" title="ag_account_service_get_changed_fields ()"><code class="function">ag_account_service_get_changed_fields()</code></a> method to retrieve the
list of the settings which have changed.</p>
<div class="refsect3">
<a name="AgAccountService-changed.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>the <a class="link" href="AgAccountService.html" title="AgAccountService"><span class="type">AgAccountService</span></a>.</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>
<p>Flags: Run Last</p>
</div>
<hr>
<div class="refsect2">
<a name="AgAccountService-enabled"></a><h3>The <code class="literal">“enabled”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="AgAccountService.html" title="AgAccountService"><span class="type">AgAccountService</span></a> *self,
<span class="type">gboolean</span> enabled,
<span class="type">gpointer</span> user_data)</pre>
<p>Emitted when the service enabled state changes.</p>
<div class="refsect3">
<a name="AgAccountService-enabled.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>the <a class="link" href="AgAccountService.html" title="AgAccountService"><span class="type">AgAccountService</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>enabled</p></td>
<td class="parameter_description"><p>whether the service is enabled.</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>
<p>Flags: Run Last</p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.25</div>
</body>
</html>
|