/usr/share/gtk-doc/html/libebackend/EServerSideSource.html is in evolution-data-server-doc 3.10.4-0ubuntu1.6.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Evolution-Data-Server Manual: Backend Utilities (libebackend): EServerSideSource</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="Evolution-Data-Server Manual: Backend Utilities (libebackend)">
<link rel="up" href="ch02.html" title="Registry Service Classes">
<link rel="prev" href="EOAuth2Support.html" title="EOAuth2Support">
<link rel="next" href="ESourceRegistryServer.html" title="ESourceRegistryServer">
<meta name="generator" content="GTK-Doc V1.20 (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="10"><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="#EServerSideSource.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#EServerSideSource.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span>
<a href="#EServerSideSource.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties"> <span class="dim">|</span>
<a href="#EServerSideSource.properties" class="shortcut">Properties</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="ch02.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="EOAuth2Support.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="ESourceRegistryServer.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="EServerSideSource"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="EServerSideSource.top_of_page"></a>EServerSideSource</span></h2>
<p>EServerSideSource — A server-side data source</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="EServerSideSource.functions"></a><h2>Functions</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="EServerSideSource.html#e-server-side-source-get-user-dir" title="e_server_side_source_get_user_dir ()">e_server_side_source_get_user_dir</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/gio/GFile.html"><span class="returnvalue">GFile</span></a> *
</td>
<td class="function_name">
<a class="link" href="EServerSideSource.html#e-server-side-source-new-user-file" title="e_server_side_source_new_user_file ()">e_server_side_source_new_user_file</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="EServerSideSource.html#e-server-side-source-uid-from-file" title="e_server_side_source_uid_from_file ()">e_server_side_source_uid_from_file</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">ESource</span> *
</td>
<td class="function_name">
<a class="link" href="EServerSideSource.html#e-server-side-source-new" title="e_server_side_source_new ()">e_server_side_source_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">ESource</span> *
</td>
<td class="function_name">
<a class="link" href="EServerSideSource.html#e-server-side-source-new-memory-only" title="e_server_side_source_new_memory_only ()">e_server_side_source_new_memory_only</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="EServerSideSource.html#e-server-side-source-load" title="e_server_side_source_load ()">e_server_side_source_load</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/gio/GFile.html"><span class="returnvalue">GFile</span></a> *
</td>
<td class="function_name">
<a class="link" href="EServerSideSource.html#e-server-side-source-get-file" title="e_server_side_source_get_file ()">e_server_side_source_get_file</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-N-ary-Trees.html#GNode"><span class="returnvalue">GNode</span></a> *
</td>
<td class="function_name">
<a class="link" href="EServerSideSource.html#e-server-side-source-get-node" title="e_server_side_source_get_node ()">e_server_side_source_get_node</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="ESourceRegistryServer.html" title="ESourceRegistryServer"><span class="returnvalue">ESourceRegistryServer</span></a> *
</td>
<td class="function_name">
<a class="link" href="EServerSideSource.html#e-server-side-source-get-server" title="e_server_side_source_get_server ()">e_server_side_source_get_server</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="EServerSideSource.html#e-server-side-source-get-allow-auth-prompt" title="e_server_side_source_get_allow_auth_prompt ()">e_server_side_source_get_allow_auth_prompt</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="EServerSideSource.html#e-server-side-source-set-allow-auth-prompt" title="e_server_side_source_set_allow_auth_prompt ()">e_server_side_source_set_allow_auth_prompt</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType"><span class="returnvalue">GType</span></a>
</td>
<td class="function_name">
<a class="link" href="EServerSideSource.html#e-server-side-source-get-auth-session-type" title="e_server_side_source_get_auth_session_type ()">e_server_side_source_get_auth_session_type</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="EServerSideSource.html#e-server-side-source-set-auth-session-type" title="e_server_side_source_set_auth_session_type ()">e_server_side_source_set_auth_session_type</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="EServerSideSource.html#e-server-side-source-get-exported" title="e_server_side_source_get_exported ()">e_server_side_source_get_exported</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="EServerSideSource.html#e-server-side-source-get-write-directory" title="e_server_side_source_get_write_directory ()">e_server_side_source_get_write_directory</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="EServerSideSource.html#e-server-side-source-set-write-directory" title="e_server_side_source_set_write_directory ()">e_server_side_source_set_write_directory</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="EServerSideSource.html#e-server-side-source-set-removable" title="e_server_side_source_set_removable ()">e_server_side_source_set_removable</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="EServerSideSource.html#e-server-side-source-set-writable" title="e_server_side_source_set_writable ()">e_server_side_source_set_writable</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="EServerSideSource.html#e-server-side-source-set-remote-creatable" title="e_server_side_source_set_remote_creatable ()">e_server_side_source_set_remote_creatable</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="EServerSideSource.html#e-server-side-source-set-remote-deletable" title="e_server_side_source_set_remote_deletable ()">e_server_side_source_set_remote_deletable</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="EOAuth2Support.html" title="EOAuth2Support"><span class="returnvalue">EOAuth2Support</span></a> *
</td>
<td class="function_name">
<a class="link" href="EServerSideSource.html#e-server-side-source-ref-oauth2-support" title="e_server_side_source_ref_oauth2_support ()">e_server_side_source_ref_oauth2_support</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="EServerSideSource.html#e-server-side-source-set-oauth2-support" title="e_server_side_source_set_oauth2_support ()">e_server_side_source_set_oauth2_support</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="EServerSideSource.properties"></a><h2>Properties</h2>
<div class="informaltable"><table 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="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td>
<td class="property_name"><a class="link" href="EServerSideSource.html#EServerSideSource--allow-auth-prompt" title="The “allow-auth-prompt” property">allow-auth-prompt</a></td>
<td class="property_flags">Read / Write / Construct</td>
</tr>
<tr>
<td class="property_type">
<a href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType"><span class="type">GType</span></a> *</td>
<td class="property_name"><a class="link" href="EServerSideSource.html#EServerSideSource--auth-session-type" title="The “auth-session-type” property">auth-session-type</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td>
<td class="property_name"><a class="link" href="EServerSideSource.html#EServerSideSource--exported" title="The “exported” property">exported</a></td>
<td class="property_flags">Read</td>
</tr>
<tr>
<td class="property_type">
<a href="/usr/share/gtk-doc/html/gio/GFile.html"><span class="type">GFile</span></a> *</td>
<td class="property_name"><a class="link" href="EServerSideSource.html#EServerSideSource--file" title="The “file” property">file</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr>
<tr>
<td class="property_type">
<a class="link" href="EOAuth2Support.html" title="EOAuth2Support"><span class="type">EOAuth2Support</span></a> *</td>
<td class="property_name"><a class="link" href="EServerSideSource.html#EServerSideSource--oauth2-support" title="The “oauth2-support” property">oauth2-support</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td>
<td class="property_name"><a class="link" href="EServerSideSource.html#EServerSideSource--remote-creatable" title="The “remote-creatable” property">remote-creatable</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td>
<td class="property_name"><a class="link" href="EServerSideSource.html#EServerSideSource--remote-deletable" title="The “remote-deletable” property">remote-deletable</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td>
<td class="property_name"><a class="link" href="EServerSideSource.html#EServerSideSource--removable" title="The “removable” property">removable</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type">
<a class="link" href="ESourceRegistryServer.html" title="ESourceRegistryServer"><span class="type">ESourceRegistryServer</span></a> *</td>
<td class="property_name"><a class="link" href="EServerSideSource.html#EServerSideSource--server" title="The “server” property">server</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr>
<tr>
<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td>
<td class="property_name"><a class="link" href="EServerSideSource.html#EServerSideSource--writable" title="The “writable” property">writable</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td>
<td class="property_name"><a class="link" href="EServerSideSource.html#EServerSideSource--write-directory" title="The “write-directory” property">write-directory</a></td>
<td class="property_flags">Read / Write</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="EServerSideSource.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody><tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="EServerSideSource.html#EServerSideSource-struct" title="struct EServerSideSource">EServerSideSource</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="EServerSideSource.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>
<span class="lineart">╰──</span> ESource
<span class="lineart">╰──</span> EServerSideSource
</pre>
</div>
<div class="refsect1">
<a name="EServerSideSource.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
EServerSideSource implements
<a href="/usr/share/gtk-doc/html/gio/GInitable.html">GInitable</a>.</p>
</div>
<div class="refsect1">
<a name="EServerSideSource.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <libebackend/libebackend.h>
</pre>
</div>
<div class="refsect1">
<a name="EServerSideSource.description"></a><h2>Description</h2>
<p>An <a class="link" href="EServerSideSource.html" title="EServerSideSource"><span class="type">EServerSideSource</span></a> is an <span class="type">ESource</span> with some additional capabilities
exclusive to the registry D-Bus service.</p>
</div>
<div class="refsect1">
<a name="EServerSideSource.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="e-server-side-source-get-user-dir"></a><h3>e_server_side_source_get_user_dir ()</h3>
<pre class="programlisting">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
e_server_side_source_get_user_dir (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Returns the directory where user-specific data source files are stored.</p>
<div class="refsect3">
<a name="id-1.3.7.10.2.5"></a><h4>Returns</h4>
<p> the user-specific data source directory</p>
<p></p>
</div>
<p class="since">Since 3.6</p>
</div>
<hr>
<div class="refsect2">
<a name="e-server-side-source-new-user-file"></a><h3>e_server_side_source_new_user_file ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gio/GFile.html"><span class="returnvalue">GFile</span></a> *
e_server_side_source_new_user_file (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *uid</code></em>);</pre>
<p>Generates a unique file name for a new user-specific data source.
If <em class="parameter"><code>uid</code></em>
is non-<a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> it will be used in the basename of the file,
otherwise a unique basename will be generated using <code class="function">e_uid_new()</code>.</p>
<p>The returned <a href="/usr/share/gtk-doc/html/gio/GFile.html"><span class="type">GFile</span></a> can then be passed to <a class="link" href="EServerSideSource.html#e-server-side-source-new" title="e_server_side_source_new ()"><code class="function">e_server_side_source_new()</code></a>.
Unreference the <a href="/usr/share/gtk-doc/html/gio/GFile.html"><span class="type">GFile</span></a> with <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a> when finished with it.</p>
<p>Note the data source file itself is not created here, only its name.</p>
<div class="refsect3">
<a name="id-1.3.7.10.3.7"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>uid</p></td>
<td class="parameter_description"><p>unique identifier for a data source, or <a href="/usr/share/gtk-doc/html/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="id-1.3.7.10.3.8"></a><h4>Returns</h4>
<p> the <a href="/usr/share/gtk-doc/html/gio/GFile.html"><span class="type">GFile</span></a> for a new data source</p>
<p></p>
</div>
<p class="since">Since 3.6</p>
</div>
<hr>
<div class="refsect2">
<a name="e-server-side-source-uid-from-file"></a><h3>e_server_side_source_uid_from_file ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
e_server_side_source_uid_from_file (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gio/GFile.html"><span class="type">GFile</span></a> *file</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>Extracts a unique identity string from the base name of <em class="parameter"><code>file</code></em>
.
If the base name of <em class="parameter"><code>file</code></em>
is missing a '.source' extension, the
function sets <em class="parameter"><code>error</code></em>
and returns <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</p>
<div class="refsect3">
<a name="id-1.3.7.10.4.5"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>file</p></td>
<td class="parameter_description"><p>a <a href="/usr/share/gtk-doc/html/gio/GFile.html"><span class="type">GFile</span></a> for a data source</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>return location for a <a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>, or <a href="/usr/share/gtk-doc/html/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="id-1.3.7.10.4.6"></a><h4>Returns</h4>
<p> the unique identity string for <em class="parameter"><code>file</code></em>
, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p>
<p></p>
</div>
<p class="since">Since 3.6</p>
</div>
<hr>
<div class="refsect2">
<a name="e-server-side-source-new"></a><h3>e_server_side_source_new ()</h3>
<pre class="programlisting"><span class="returnvalue">ESource</span> *
e_server_side_source_new (<em class="parameter"><code><a class="link" href="ESourceRegistryServer.html" title="ESourceRegistryServer"><span class="type">ESourceRegistryServer</span></a> *server</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gio/GFile.html"><span class="type">GFile</span></a> *file</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>Creates a new <a class="link" href="EServerSideSource.html" title="EServerSideSource"><span class="type">EServerSideSource</span></a> which belongs to <em class="parameter"><code>server</code></em>
. If <em class="parameter"><code>file</code></em>
is non-<a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> and points to an existing file, the <a class="link" href="EServerSideSource.html" title="EServerSideSource"><span class="type">EServerSideSource</span></a> is
initialized from the file content. If a read error occurs or the file
contains syntax errors, the function sets <em class="parameter"><code>error</code></em>
and returns <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</p>
<div class="refsect3">
<a name="id-1.3.7.10.5.5"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>server</p></td>
<td class="parameter_description"><p>an <a class="link" href="ESourceRegistryServer.html" title="ESourceRegistryServer"><span class="type">ESourceRegistryServer</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>file</p></td>
<td class="parameter_description"><p>a <a href="/usr/share/gtk-doc/html/gio/GFile.html"><span class="type">GFile</span></a>, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>return location for a <a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>, or <a href="/usr/share/gtk-doc/html/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="id-1.3.7.10.5.6"></a><h4>Returns</h4>
<p> a new <a class="link" href="EServerSideSource.html" title="EServerSideSource"><span class="type">EServerSideSource</span></a>, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p>
<p></p>
</div>
<p class="since">Since 3.6</p>
</div>
<hr>
<div class="refsect2">
<a name="e-server-side-source-new-memory-only"></a><h3>e_server_side_source_new_memory_only ()</h3>
<pre class="programlisting"><span class="returnvalue">ESource</span> *
e_server_side_source_new_memory_only (<em class="parameter"><code><a class="link" href="ESourceRegistryServer.html" title="ESourceRegistryServer"><span class="type">ESourceRegistryServer</span></a> *server</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *uid</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>Creates a memory-only <a class="link" href="EServerSideSource.html" title="EServerSideSource"><span class="type">EServerSideSource</span></a> which belongs to <em class="parameter"><code>server</code></em>
.
No on-disk key file is created for this data source, so it will not
be remembered across sessions.</p>
<p>Data source collections are often populated with memory-only data
sources to serve as proxies for resources discovered on a remote server.
These data sources are usually neither <a class="link" href="EServerSideSource.html#EServerSideSource--writable" title="The “writable” property"><span class="type">“writable”</span></a> nor
<a class="link" href="EServerSideSource.html#EServerSideSource--removable" title="The “removable” property"><span class="type">“removable”</span></a> by clients, at least not directly.</p>
<p>If an error occurs while instantiating the <a class="link" href="EServerSideSource.html" title="EServerSideSource"><span class="type">EServerSideSource</span></a>, the
function sets <em class="parameter"><code>error</code></em>
and returns <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. Although at this time there
are no known error conditions for memory-only data sources.</p>
<div class="refsect3">
<a name="id-1.3.7.10.6.7"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>server</p></td>
<td class="parameter_description"><p>an <a class="link" href="ESourceRegistryServer.html" title="ESourceRegistryServer"><span class="type">ESourceRegistryServer</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>uid</p></td>
<td class="parameter_description"><p>a unique identifier, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>return location for a <a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>, or <a href="/usr/share/gtk-doc/html/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="id-1.3.7.10.6.8"></a><h4>Returns</h4>
<p> a new memory-only <a class="link" href="EServerSideSource.html" title="EServerSideSource"><span class="type">EServerSideSource</span></a>, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p>
<p></p>
</div>
<p class="since">Since 3.6</p>
</div>
<hr>
<div class="refsect2">
<a name="e-server-side-source-load"></a><h3>e_server_side_source_load ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
e_server_side_source_load (<em class="parameter"><code><a class="link" href="EServerSideSource.html" title="EServerSideSource"><span class="type">EServerSideSource</span></a> *source</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gio/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>Reloads data source content from the file pointed to by the
<a class="link" href="EServerSideSource.html#EServerSideSource--file" title="The “file” property"><span class="type">“file”</span></a> property.</p>
<p>If the <a class="link" href="EServerSideSource.html#EServerSideSource--file" title="The “file” property"><span class="type">“file”</span></a> property is <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> or the file it points
to does not exist, the function does nothing and returns <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>.</p>
<p>If a read error occurs or the file contains syntax errors, the function
sets <em class="parameter"><code>error</code></em>
and returns <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>.</p>
<div class="refsect3">
<a name="id-1.3.7.10.7.7"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>source</p></td>
<td class="parameter_description"><p>an <a class="link" href="EServerSideSource.html" title="EServerSideSource"><span class="type">EServerSideSource</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>cancellable</p></td>
<td class="parameter_description"><p>optional <a href="/usr/share/gtk-doc/html/gio/GCancellable.html"><span class="type">GCancellable</span></a> object, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>return location for a <a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>, or <a href="/usr/share/gtk-doc/html/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="id-1.3.7.10.7.8"></a><h4>Returns</h4>
<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success, <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> on failure</p>
<p></p>
</div>
<p class="since">Since 3.6</p>
</div>
<hr>
<div class="refsect2">
<a name="e-server-side-source-get-file"></a><h3>e_server_side_source_get_file ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gio/GFile.html"><span class="returnvalue">GFile</span></a> *
e_server_side_source_get_file (<em class="parameter"><code><a class="link" href="EServerSideSource.html" title="EServerSideSource"><span class="type">EServerSideSource</span></a> *source</code></em>);</pre>
<p>Returns the <a href="/usr/share/gtk-doc/html/gio/GFile.html"><span class="type">GFile</span></a> from which data source content is loaded and to
which changes are saved. Note the <em class="parameter"><code>source</code></em>
may not have a <a href="/usr/share/gtk-doc/html/gio/GFile.html"><span class="type">GFile</span></a>.</p>
<div class="refsect3">
<a name="id-1.3.7.10.8.5"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>source</p></td>
<td class="parameter_description"><p>an <a class="link" href="EServerSideSource.html" title="EServerSideSource"><span class="type">EServerSideSource</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.7.10.8.6"></a><h4>Returns</h4>
<p> the <a href="/usr/share/gtk-doc/html/gio/GFile.html"><span class="type">GFile</span></a> for <em class="parameter"><code>source</code></em>
, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p>
<p></p>
</div>
<p class="since">Since 3.6</p>
</div>
<hr>
<div class="refsect2">
<a name="e-server-side-source-get-node"></a><h3>e_server_side_source_get_node ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-N-ary-Trees.html#GNode"><span class="returnvalue">GNode</span></a> *
e_server_side_source_get_node (<em class="parameter"><code><a class="link" href="EServerSideSource.html" title="EServerSideSource"><span class="type">EServerSideSource</span></a> *source</code></em>);</pre>
<p>Returns the <a href="/usr/share/gtk-doc/html/glib/glib-N-ary-Trees.html#GNode"><span class="type">GNode</span></a> representing the <em class="parameter"><code>source</code></em>
's hierarchical placement,
or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if <em class="parameter"><code>source</code></em>
has not been placed in the data source hierarchy.
The data member of the <a href="/usr/share/gtk-doc/html/glib/glib-N-ary-Trees.html#GNode"><span class="type">GNode</span></a> points back to <em class="parameter"><code>source</code></em>
. This is an easy
way to traverse ancestor and descendant data sources.</p>
<p>Note that accessing other data sources this way is not thread-safe,
and this therefore function may be replaced at some later date.</p>
<div class="refsect3">
<a name="id-1.3.7.10.9.6"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>source</p></td>
<td class="parameter_description"><p>an <a class="link" href="EServerSideSource.html" title="EServerSideSource"><span class="type">EServerSideSource</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.7.10.9.7"></a><h4>Returns</h4>
<p> a <a href="/usr/share/gtk-doc/html/glib/glib-N-ary-Trees.html#GNode"><span class="type">GNode</span></a>, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p>
<p></p>
</div>
<p class="since">Since 3.6</p>
</div>
<hr>
<div class="refsect2">
<a name="e-server-side-source-get-server"></a><h3>e_server_side_source_get_server ()</h3>
<pre class="programlisting"><a class="link" href="ESourceRegistryServer.html" title="ESourceRegistryServer"><span class="returnvalue">ESourceRegistryServer</span></a> *
e_server_side_source_get_server (<em class="parameter"><code><a class="link" href="EServerSideSource.html" title="EServerSideSource"><span class="type">EServerSideSource</span></a> *source</code></em>);</pre>
<p>Returns the <a class="link" href="ESourceRegistryServer.html" title="ESourceRegistryServer"><span class="type">ESourceRegistryServer</span></a> to which <em class="parameter"><code>source</code></em>
belongs.</p>
<div class="refsect3">
<a name="id-1.3.7.10.10.5"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>source</p></td>
<td class="parameter_description"><p>an <a class="link" href="EServerSideSource.html" title="EServerSideSource"><span class="type">EServerSideSource</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.7.10.10.6"></a><h4>Returns</h4>
<p> the <a class="link" href="ESourceRegistryServer.html" title="ESourceRegistryServer"><span class="type">ESourceRegistryServer</span></a> for <em class="parameter"><code>source</code></em>
</p>
<p></p>
</div>
<p class="since">Since 3.6</p>
</div>
<hr>
<div class="refsect2">
<a name="e-server-side-source-get-allow-auth-prompt"></a><h3>e_server_side_source_get_allow_auth_prompt ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
e_server_side_source_get_allow_auth_prompt
(<em class="parameter"><code><a class="link" href="EServerSideSource.html" title="EServerSideSource"><span class="type">EServerSideSource</span></a> *source</code></em>);</pre>
<p>Returns whether an authentication prompt is allowed to be shown
for <em class="parameter"><code>source</code></em>
. <a class="link" href="EAuthenticationSession.html" title="EAuthenticationSession"><span class="type">EAuthenticationSession</span></a> will honor this setting by
dismissing the session if it can't find a valid stored password.</p>
<p>See <a class="link" href="EServerSideSource.html#e-server-side-source-set-allow-auth-prompt" title="e_server_side_source_set_allow_auth_prompt ()"><code class="function">e_server_side_source_set_allow_auth_prompt()</code></a> for further
discussion.</p>
<div class="refsect3">
<a name="id-1.3.7.10.11.6"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>source</p></td>
<td class="parameter_description"><p>an <a class="link" href="EServerSideSource.html" title="EServerSideSource"><span class="type">EServerSideSource</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.7.10.11.7"></a><h4>Returns</h4>
<p> whether auth prompts are allowed for <em class="parameter"><code>source</code></em>
</p>
<p></p>
</div>
<p class="since">Since 3.6</p>
</div>
<hr>
<div class="refsect2">
<a name="e-server-side-source-set-allow-auth-prompt"></a><h3>e_server_side_source_set_allow_auth_prompt ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
e_server_side_source_set_allow_auth_prompt
(<em class="parameter"><code><a class="link" href="EServerSideSource.html" title="EServerSideSource"><span class="type">EServerSideSource</span></a> *source</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> allow_auth_prompt</code></em>);</pre>
<p>Sets whether an authentication prompt is allowed to be shown for <em class="parameter"><code>source</code></em>
.
<a class="link" href="EAuthenticationSession.html" title="EAuthenticationSession"><span class="type">EAuthenticationSession</span></a> will honor this setting by dismissing the session
if it can't find a valid stored password.</p>
<p>If the user declines to provide a password for <em class="parameter"><code>source</code></em>
when prompted
by an <a class="link" href="EAuthenticationSession.html" title="EAuthenticationSession"><span class="type">EAuthenticationSession</span></a>, the <a class="link" href="ESourceRegistryServer.html" title="ESourceRegistryServer"><span class="type">ESourceRegistryServer</span></a> will set this
property to <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> to suppress any further prompting, which would likely
annoy the user. However when an <span class="type">ESourceRegistry</span> instance is created by
a client application, the first thing it does is reset this property to
<a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> for all registered data sources. So suppressing authentication
prompts is only ever temporary.</p>
<div class="refsect3">
<a name="id-1.3.7.10.12.6"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>source</p></td>
<td class="parameter_description"><p>an <a class="link" href="EServerSideSource.html" title="EServerSideSource"><span class="type">EServerSideSource</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>allow_auth_prompt</p></td>
<td class="parameter_description"><p>whether auth prompts are allowed for <em class="parameter"><code>source</code></em>
</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since 3.6</p>
</div>
<hr>
<div class="refsect2">
<a name="e-server-side-source-get-auth-session-type"></a><h3>e_server_side_source_get_auth_session_type ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType"><span class="returnvalue">GType</span></a>
e_server_side_source_get_auth_session_type
(<em class="parameter"><code><a class="link" href="EServerSideSource.html" title="EServerSideSource"><span class="type">EServerSideSource</span></a> *source</code></em>);</pre>
<p>Returns the type of authentication session to use for <em class="parameter"><code>source</code></em>
,
which will get passed to <a class="link" href="ESourceRegistryServer.html#e-source-registry-server-authenticate" title="e_source_registry_server_authenticate ()"><code class="function">e_source_registry_server_authenticate()</code></a>.</p>
<p>This defaults to the <a href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType"><span class="type">GType</span></a> for <a class="link" href="EAuthenticationSession.html" title="EAuthenticationSession"><span class="type">EAuthenticationSession</span></a>.</p>
<div class="refsect3">
<a name="id-1.3.7.10.13.6"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>source</p></td>
<td class="parameter_description"><p>an <a class="link" href="EServerSideSource.html" title="EServerSideSource"><span class="type">EServerSideSource</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.7.10.13.7"></a><h4>Returns</h4>
<p> the type of authentication session to use for <em class="parameter"><code>source</code></em>
</p>
<p></p>
</div>
<p class="since">Since 3.8</p>
</div>
<hr>
<div class="refsect2">
<a name="e-server-side-source-set-auth-session-type"></a><h3>e_server_side_source_set_auth_session_type ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
e_server_side_source_set_auth_session_type
(<em class="parameter"><code><a class="link" href="EServerSideSource.html" title="EServerSideSource"><span class="type">EServerSideSource</span></a> *source</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType"><span class="type">GType</span></a> auth_session_type</code></em>);</pre>
<p>Sets the type of authentication session to use for <em class="parameter"><code>source</code></em>
, which will
get passed to <a class="link" href="ESourceRegistryServer.html#e-source-registry-server-authenticate" title="e_source_registry_server_authenticate ()"><code class="function">e_source_registry_server_authenticate()</code></a>.</p>
<p><em class="parameter"><code>auth_session_type</code></em>
must be derived from <a class="link" href="EAuthenticationSession.html" title="EAuthenticationSession"><span class="type">EAuthenticationSession</span></a>, or else
the function will reject the <a href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType"><span class="type">GType</span></a> with a runtime warning.</p>
<p>This defaults to the <a href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType"><span class="type">GType</span></a> for <a class="link" href="EAuthenticationSession.html" title="EAuthenticationSession"><span class="type">EAuthenticationSession</span></a>.</p>
<div class="refsect3">
<a name="id-1.3.7.10.14.7"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>source</p></td>
<td class="parameter_description"><p>an <a class="link" href="EServerSideSource.html" title="EServerSideSource"><span class="type">EServerSideSource</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>auth_session_type</p></td>
<td class="parameter_description"><p>the type of authentication session to use for <em class="parameter"><code>source</code></em>
</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since 3.8</p>
</div>
<hr>
<div class="refsect2">
<a name="e-server-side-source-get-exported"></a><h3>e_server_side_source_get_exported ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
e_server_side_source_get_exported (<em class="parameter"><code><a class="link" href="EServerSideSource.html" title="EServerSideSource"><span class="type">EServerSideSource</span></a> *source</code></em>);</pre>
<p>Returns whether <em class="parameter"><code>source</code></em>
has been exported over D-Bus.</p>
<p>The function returns <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> after <em class="parameter"><code>source</code></em>
is initially created, <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>
after passing <em class="parameter"><code>source</code></em>
to <code class="function">e_source_registry_add_source()</code> (provided that
<em class="parameter"><code>source</code></em>
's <span class="type">“parent”</span> is also exported), and <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> after passing
<em class="parameter"><code>source</code></em>
to <code class="function">e_source_registry_remove_source()</code>.</p>
<div class="refsect3">
<a name="id-1.3.7.10.15.6"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>source</p></td>
<td class="parameter_description"><p>an <a class="link" href="EServerSideSource.html" title="EServerSideSource"><span class="type">EServerSideSource</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.7.10.15.7"></a><h4>Returns</h4>
<p> whether <em class="parameter"><code>source</code></em>
has been exported</p>
<p></p>
</div>
<p class="since">Since 3.6</p>
</div>
<hr>
<div class="refsect2">
<a name="e-server-side-source-get-write-directory"></a><h3>e_server_side_source_get_write_directory ()</h3>
<pre class="programlisting">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
e_server_side_source_get_write_directory
(<em class="parameter"><code><a class="link" href="EServerSideSource.html" title="EServerSideSource"><span class="type">EServerSideSource</span></a> *source</code></em>);</pre>
<p>Returns the local directory path where changes to <em class="parameter"><code>source</code></em>
are written.</p>
<p>By default, changes are written to the local directory path returned by
<a class="link" href="EServerSideSource.html#e-server-side-source-get-user-dir" title="e_server_side_source_get_user_dir ()"><code class="function">e_server_side_source_get_user_dir()</code></a>, but an <a class="link" href="ECollectionBackend.html" title="ECollectionBackend"><span class="type">ECollectionBackend</span></a> may wish
to override this to use its own private cache directory for data sources
it creates automatically.</p>
<div class="refsect3">
<a name="id-1.3.7.10.16.6"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>source</p></td>
<td class="parameter_description"><p>an <a class="link" href="EServerSideSource.html" title="EServerSideSource"><span class="type">EServerSideSource</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.7.10.16.7"></a><h4>Returns</h4>
<p> the directory where changes are written</p>
<p></p>
</div>
<p class="since">Since 3.6</p>
</div>
<hr>
<div class="refsect2">
<a name="e-server-side-source-set-write-directory"></a><h3>e_server_side_source_set_write_directory ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
e_server_side_source_set_write_directory
(<em class="parameter"><code><a class="link" href="EServerSideSource.html" title="EServerSideSource"><span class="type">EServerSideSource</span></a> *source</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *write_directory</code></em>);</pre>
<p>Sets the local directory path where changes to <em class="parameter"><code>source</code></em>
are to be written.</p>
<p>By default, changes are written to the local directory path returned by
<a class="link" href="EServerSideSource.html#e-server-side-source-get-user-dir" title="e_server_side_source_get_user_dir ()"><code class="function">e_server_side_source_get_user_dir()</code></a>, but an <a class="link" href="ECollectionBackend.html" title="ECollectionBackend"><span class="type">ECollectionBackend</span></a> may wish
to override this to use its own private cache directory for data sources
it creates automatically.</p>
<div class="refsect3">
<a name="id-1.3.7.10.17.6"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>source</p></td>
<td class="parameter_description"><p>an <a class="link" href="EServerSideSource.html" title="EServerSideSource"><span class="type">EServerSideSource</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>write_directory</p></td>
<td class="parameter_description"><p>the directory where changes are to be written</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since 3.6</p>
</div>
<hr>
<div class="refsect2">
<a name="e-server-side-source-set-removable"></a><h3>e_server_side_source_set_removable ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
e_server_side_source_set_removable (<em class="parameter"><code><a class="link" href="EServerSideSource.html" title="EServerSideSource"><span class="type">EServerSideSource</span></a> *source</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> removable</code></em>);</pre>
<p>Sets whether to allow registry clients to remove <em class="parameter"><code>source</code></em>
and its
descendants. If <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, the Removable D-Bus interface is exported at
the object path for <em class="parameter"><code>source</code></em>
. If <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>, the Removable D-Bus interface
is unexported at the object path for <em class="parameter"><code>source</code></em>
, and any attempt by clients
to call <code class="function">e_source_remove()</code> will fail.</p>
<p>Note this is only enforced for clients of the registry D-Bus service.
The service itself may remove any data source at any time.</p>
<div class="refsect3">
<a name="id-1.3.7.10.18.6"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>source</p></td>
<td class="parameter_description"><p>an <a class="link" href="EServerSideSource.html" title="EServerSideSource"><span class="type">EServerSideSource</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>removable</p></td>
<td class="parameter_description"><p>whether to export the Removable interface</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since 3.6</p>
</div>
<hr>
<div class="refsect2">
<a name="e-server-side-source-set-writable"></a><h3>e_server_side_source_set_writable ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
e_server_side_source_set_writable (<em class="parameter"><code><a class="link" href="EServerSideSource.html" title="EServerSideSource"><span class="type">EServerSideSource</span></a> *source</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> writable</code></em>);</pre>
<p>Sets whether to allow registry clients to alter the content of <em class="parameter"><code>source</code></em>
.
If <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, the Writable D-Bus interface is exported at the object path
for <em class="parameter"><code>source</code></em>
. If <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>, the Writable D-Bus interface is unexported at
the object path for <em class="parameter"><code>source</code></em>
, and any attempt by clients to call
<code class="function">e_source_write()</code> will fail.</p>
<p>Note this is only enforced for clients of the registry D-Bus service.
The service itself can write to any data source at any time.</p>
<div class="refsect3">
<a name="id-1.3.7.10.19.6"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>source</p></td>
<td class="parameter_description"><p>an <a class="link" href="EServerSideSource.html" title="EServerSideSource"><span class="type">EServerSideSource</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>writable</p></td>
<td class="parameter_description"><p>whether to export the Writable interface</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since 3.6</p>
</div>
<hr>
<div class="refsect2">
<a name="e-server-side-source-set-remote-creatable"></a><h3>e_server_side_source_set_remote_creatable ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
e_server_side_source_set_remote_creatable
(<em class="parameter"><code><a class="link" href="EServerSideSource.html" title="EServerSideSource"><span class="type">EServerSideSource</span></a> *source</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> remote_creatable</code></em>);</pre>
<p>Indicates whether <em class="parameter"><code>source</code></em>
can be used to create resources on a remote
server. Typically this is only set to <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> for collection sources.</p>
<p>If <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, the RemoteCreatable D-Bus interface is exported at the object
path for <em class="parameter"><code>source</code></em>
. If <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>, the RemoteCreatable D-Bus interface is
unexported at the object path for <em class="parameter"><code>source</code></em>
, and any attempt by clients
to call <code class="function">e_source_remote_create()</code> will fail.</p>
<p>Unlike the <span class="type">“removable”</span> and <span class="type">“writable”</span> properties, this
is enforced for both clients of the registry D-Bus service and within
the registry D-Bus service itself.</p>
<div class="refsect3">
<a name="id-1.3.7.10.20.7"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>source</p></td>
<td class="parameter_description"><p>an <a class="link" href="EServerSideSource.html" title="EServerSideSource"><span class="type">EServerSideSource</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>remote_creatable</p></td>
<td class="parameter_description"><p>whether to export the RemoteCreatable interface</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since 3.6</p>
</div>
<hr>
<div class="refsect2">
<a name="e-server-side-source-set-remote-deletable"></a><h3>e_server_side_source_set_remote_deletable ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
e_server_side_source_set_remote_deletable
(<em class="parameter"><code><a class="link" href="EServerSideSource.html" title="EServerSideSource"><span class="type">EServerSideSource</span></a> *source</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> remote_deletable</code></em>);</pre>
<p>Indicates whether <em class="parameter"><code>source</code></em>
can be used to delete resources on a remote
server. Typically this is only set to <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> for sources created by an
<a class="link" href="ECollectionBackend.html" title="ECollectionBackend"><span class="type">ECollectionBackend</span></a> to represent a remote resource.</p>
<p>If <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, the RemoteDeletable D-Bus interface is exported at the object
path for <em class="parameter"><code>source</code></em>
. If <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>, the RemoteDeletable D-Bus interface is
unexported at the object path for <em class="parameter"><code>source</code></em>
, and any attempt by clients
to call <code class="function">e_source_remote_delete()</code> will fail.</p>
<p>Unlike the <span class="type">“removable”</span> and <span class="type">“writable”</span> properties, this
is enforced for both clients of the registry D-Bus server and within
the registry D-Bus service itself.</p>
<div class="refsect3">
<a name="id-1.3.7.10.21.7"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>source</p></td>
<td class="parameter_description"><p>an <a class="link" href="EServerSideSource.html" title="EServerSideSource"><span class="type">EServerSideSource</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>remote_deletable</p></td>
<td class="parameter_description"><p>whether to export the RemoteDeletable interface</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since 3.6</p>
</div>
<hr>
<div class="refsect2">
<a name="e-server-side-source-ref-oauth2-support"></a><h3>e_server_side_source_ref_oauth2_support ()</h3>
<pre class="programlisting"><a class="link" href="EOAuth2Support.html" title="EOAuth2Support"><span class="returnvalue">EOAuth2Support</span></a> *
e_server_side_source_ref_oauth2_support
(<em class="parameter"><code><a class="link" href="EServerSideSource.html" title="EServerSideSource"><span class="type">EServerSideSource</span></a> *source</code></em>);</pre>
<p>Returns the object implementing the <a class="link" href="EOAuth2Support.html#EOAuth2SupportInterface" title="struct EOAuth2SupportInterface"><span class="type">EOAuth2SupportInterface</span></a>,
or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if <em class="parameter"><code>source</code></em>
does not support OAuth 2.0 authentication.</p>
<p>The returned <a class="link" href="EOAuth2Support.html" title="EOAuth2Support"><span class="type">EOAuth2Support</span></a> object is referenced for thread-safety.
Unreference the object with <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a> when finished with it.</p>
<div class="refsect3">
<a name="id-1.3.7.10.22.6"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>source</p></td>
<td class="parameter_description"><p>an <a class="link" href="EServerSideSource.html" title="EServerSideSource"><span class="type">EServerSideSource</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.7.10.22.7"></a><h4>Returns</h4>
<p> an <a class="link" href="EOAuth2Support.html" title="EOAuth2Support"><span class="type">EOAuth2Support</span></a> object, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p>
<p></p>
</div>
<p class="since">Since 3.8</p>
</div>
<hr>
<div class="refsect2">
<a name="e-server-side-source-set-oauth2-support"></a><h3>e_server_side_source_set_oauth2_support ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
e_server_side_source_set_oauth2_support
(<em class="parameter"><code><a class="link" href="EServerSideSource.html" title="EServerSideSource"><span class="type">EServerSideSource</span></a> *source</code></em>,
<em class="parameter"><code><a class="link" href="EOAuth2Support.html" title="EOAuth2Support"><span class="type">EOAuth2Support</span></a> *oauth2_support</code></em>);</pre>
<p>Indicates whether <em class="parameter"><code>source</code></em>
supports OAuth 2.0 authentication.</p>
<p>If <em class="parameter"><code>oauth2_support</code></em>
is non-<a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, the OAuth2Support D-Bus interface is
exported at the object path for <em class="parameter"><code>source</code></em>
. If <em class="parameter"><code>oauth2_support</code></em>
is <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>,
the OAuth2Support D-Bus interface is unexported at the object path for
<em class="parameter"><code>source</code></em>
, and any attempt by clients to call
<code class="function">e_source_get_oauth2_access_token()</code> will fail.</p>
<p>Requests for OAuth 2.0 access tokens are forwarded to <em class="parameter"><code>oauth2_support</code></em>
,
which implements the <a class="link" href="EOAuth2Support.html#EOAuth2SupportInterface" title="struct EOAuth2SupportInterface"><span class="type">EOAuth2SupportInterface</span></a>.</p>
<div class="refsect3">
<a name="id-1.3.7.10.23.7"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>source</p></td>
<td class="parameter_description"><p>an <a class="link" href="EServerSideSource.html" title="EServerSideSource"><span class="type">EServerSideSource</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>oauth2_support</p></td>
<td class="parameter_description"><p>an <a class="link" href="EOAuth2Support.html" title="EOAuth2Support"><span class="type">EOAuth2Support</span></a> object, or <a href="/usr/share/gtk-doc/html/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>
<p class="since">Since 3.8</p>
</div>
</div>
<div class="refsect1">
<a name="EServerSideSource.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="EServerSideSource-struct"></a><h3>struct EServerSideSource</h3>
<pre class="programlisting">struct EServerSideSource;</pre>
<p>Contains only private data that should be read and manipulated using the
functions below.</p>
<p class="since">Since 3.6</p>
</div>
</div>
<div class="refsect1">
<a name="EServerSideSource.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="EServerSideSource--allow-auth-prompt"></a><h3>The <code class="literal">“allow-auth-prompt”</code> property</h3>
<pre class="programlisting"> “allow-auth-prompt” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre>
<p>Whether authentication sessions may interrupt the user for a password.</p>
<p>Flags: Read / Write / Construct</p>
<p>Default value: TRUE</p>
</div>
<hr>
<div class="refsect2">
<a name="EServerSideSource--auth-session-type"></a><h3>The <code class="literal">“auth-session-type”</code> property</h3>
<pre class="programlisting"> “auth-session-type” <a href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType"><span class="type">GType</span></a> *</pre>
<p>The type of authentication session to instantiate for this source.</p>
<p>Flags: Read / Write</p>
<p>Allowed values: EAuthenticationSession</p>
</div>
<hr>
<div class="refsect2">
<a name="EServerSideSource--exported"></a><h3>The <code class="literal">“exported”</code> property</h3>
<pre class="programlisting"> “exported” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre>
<p>Whether the source has been exported over D-Bus.</p>
<p>Flags: Read</p>
<p>Default value: FALSE</p>
</div>
<hr>
<div class="refsect2">
<a name="EServerSideSource--file"></a><h3>The <code class="literal">“file”</code> property</h3>
<pre class="programlisting"> “file” <a href="/usr/share/gtk-doc/html/gio/GFile.html"><span class="type">GFile</span></a> *</pre>
<p>The key file for the data source.</p>
<p>Flags: Read / Write / Construct Only</p>
</div>
<hr>
<div class="refsect2">
<a name="EServerSideSource--oauth2-support"></a><h3>The <code class="literal">“oauth2-support”</code> property</h3>
<pre class="programlisting"> “oauth2-support” <a class="link" href="EOAuth2Support.html" title="EOAuth2Support"><span class="type">EOAuth2Support</span></a> *</pre>
<p>The object providing OAuth 2.0 support.</p>
<p>Flags: Read / Write</p>
</div>
<hr>
<div class="refsect2">
<a name="EServerSideSource--remote-creatable"></a><h3>The <code class="literal">“remote-creatable”</code> property</h3>
<pre class="programlisting"> “remote-creatable” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre>
<p>Whether the data source can create remote resources.</p>
<p>Flags: Read / Write</p>
<p>Default value: FALSE</p>
</div>
<hr>
<div class="refsect2">
<a name="EServerSideSource--remote-deletable"></a><h3>The <code class="literal">“remote-deletable”</code> property</h3>
<pre class="programlisting"> “remote-deletable” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre>
<p>Whether the data source can delete remote resources.</p>
<p>Flags: Read / Write</p>
<p>Default value: FALSE</p>
</div>
<hr>
<div class="refsect2">
<a name="EServerSideSource--removable"></a><h3>The <code class="literal">“removable”</code> property</h3>
<pre class="programlisting"> “removable” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre>
<p>Whether the data source is removable.</p>
<p>Flags: Read / Write</p>
<p>Default value: FALSE</p>
</div>
<hr>
<div class="refsect2">
<a name="EServerSideSource--server"></a><h3>The <code class="literal">“server”</code> property</h3>
<pre class="programlisting"> “server” <a class="link" href="ESourceRegistryServer.html" title="ESourceRegistryServer"><span class="type">ESourceRegistryServer</span></a> *</pre>
<p>The server to which the data source belongs.</p>
<p>Flags: Read / Write / Construct Only</p>
</div>
<hr>
<div class="refsect2">
<a name="EServerSideSource--writable"></a><h3>The <code class="literal">“writable”</code> property</h3>
<pre class="programlisting"> “writable” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre>
<p>Whether the data source is writable.</p>
<p>Flags: Read / Write</p>
<p>Default value: FALSE</p>
</div>
<hr>
<div class="refsect2">
<a name="EServerSideSource--write-directory"></a><h3>The <code class="literal">“write-directory”</code> property</h3>
<pre class="programlisting"> “write-directory” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre>
<p>Directory in which to write changes to disk.</p>
<p>Flags: Read / Write</p>
<p>Default value: NULL</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.20</div>
</body>
</html>
|