/usr/include/telepathy-qt4/TelepathyQt/_gen/cli-connection.h is in libtelepathy-qt4-dev 0.9.3-3ubuntu1.
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 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 3932 3933 3934 3935 3936 3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 4042 4043 4044 4045 4046 4047 4048 4049 4050 4051 4052 4053 4054 4055 4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 4084 4085 4086 4087 4088 4089 4090 4091 4092 4093 4094 4095 4096 4097 4098 4099 4100 4101 4102 4103 4104 4105 4106 4107 4108 4109 4110 4111 4112 4113 4114 4115 4116 4117 4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128 4129 4130 4131 4132 4133 4134 4135 4136 4137 4138 4139 4140 4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 4159 4160 4161 4162 4163 4164 4165 4166 4167 4168 4169 4170 4171 4172 4173 4174 4175 4176 4177 4178 4179 4180 4181 4182 4183 4184 4185 4186 4187 4188 4189 4190 4191 4192 4193 4194 4195 4196 4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 4209 4210 4211 4212 4213 4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 4246 4247 4248 4249 4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 4280 4281 4282 4283 4284 4285 4286 4287 4288 4289 4290 4291 4292 4293 4294 4295 4296 4297 4298 4299 4300 4301 4302 4303 4304 4305 4306 4307 4308 4309 4310 4311 4312 4313 4314 4315 4316 4317 4318 4319 4320 4321 4322 4323 4324 4325 4326 4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363 4364 4365 4366 4367 4368 4369 4370 4371 4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397 4398 4399 4400 4401 4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413 4414 4415 4416 4417 4418 4419 4420 4421 4422 4423 4424 4425 4426 4427 4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466 4467 4468 4469 4470 4471 4472 4473 4474 4475 4476 4477 4478 4479 4480 4481 4482 4483 4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494 4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 4505 4506 4507 4508 4509 4510 4511 4512 4513 4514 4515 4516 4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 4562 4563 4564 4565 4566 4567 4568 4569 4570 4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593 4594 4595 4596 4597 4598 4599 4600 4601 4602 4603 4604 4605 4606 4607 4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621 4622 4623 4624 4625 4626 4627 4628 4629 4630 4631 4632 4633 4634 4635 4636 4637 4638 4639 4640 4641 4642 4643 4644 4645 4646 4647 4648 4649 4650 4651 4652 4653 4654 4655 4656 4657 4658 4659 4660 4661 4662 4663 4664 4665 4666 4667 4668 4669 4670 4671 4672 4673 4674 4675 4676 4677 4678 4679 4680 4681 4682 4683 4684 4685 4686 4687 4688 4689 4690 4691 4692 4693 4694 4695 4696 4697 4698 4699 4700 4701 4702 4703 4704 4705 4706 4707 4708 4709 4710 4711 4712 4713 4714 4715 4716 4717 4718 4719 4720 4721 4722 4723 4724 4725 4726 4727 4728 4729 4730 4731 4732 4733 4734 4735 4736 4737 4738 4739 4740 4741 4742 4743 4744 4745 4746 4747 4748 4749 4750 4751 4752 4753 4754 4755 4756 4757 4758 4759 4760 4761 4762 4763 4764 4765 4766 4767 4768 4769 4770 4771 4772 4773 4774 4775 4776 4777 4778 4779 4780 4781 4782 4783 4784 4785 4786 4787 4788 4789 4790 4791 4792 4793 4794 4795 4796 4797 4798 4799 4800 4801 4802 4803 4804 4805 4806 4807 4808 4809 4810 4811 4812 4813 4814 4815 4816 4817 4818 4819 4820 4821 4822 4823 4824 4825 4826 4827 4828 4829 4830 4831 4832 4833 4834 4835 4836 4837 4838 4839 4840 4841 4842 4843 4844 4845 4846 4847 4848 4849 4850 4851 4852 4853 4854 4855 4856 4857 4858 4859 4860 4861 4862 4863 4864 4865 4866 4867 4868 4869 4870 4871 4872 4873 4874 4875 4876 4877 4878 4879 4880 4881 4882 4883 4884 4885 4886 4887 4888 4889 4890 4891 4892 4893 4894 4895 4896 4897 4898 4899 4900 4901 4902 4903 4904 4905 4906 4907 4908 4909 4910 4911 4912 4913 4914 4915 4916 4917 4918 4919 4920 4921 4922 4923 4924 4925 4926 4927 4928 4929 4930 4931 4932 4933 4934 4935 4936 4937 4938 4939 4940 4941 4942 4943 4944 4945 4946 4947 4948 4949 4950 4951 4952 4953 4954 4955 4956 4957 4958 4959 4960 4961 4962 4963 4964 4965 4966 4967 4968 4969 4970 4971 4972 4973 4974 4975 4976 4977 4978 4979 4980 4981 4982 4983 4984 4985 4986 4987 4988 4989 4990 4991 4992 4993 4994 4995 4996 4997 4998 4999 5000 5001 5002 5003 5004 5005 5006 5007 5008 5009 5010 5011 5012 5013 5014 5015 5016 5017 5018 5019 5020 5021 5022 5023 5024 5025 5026 5027 5028 5029 5030 5031 5032 5033 5034 5035 5036 5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 5051 5052 5053 5054 5055 5056 5057 5058 5059 5060 5061 5062 5063 5064 5065 5066 5067 5068 5069 5070 5071 5072 5073 5074 5075 5076 5077 5078 5079 5080 5081 5082 5083 5084 5085 5086 5087 5088 5089 5090 5091 5092 5093 5094 5095 5096 5097 5098 5099 5100 5101 5102 5103 5104 5105 5106 5107 5108 5109 5110 5111 5112 5113 5114 5115 5116 5117 5118 5119 5120 5121 5122 5123 5124 5125 5126 5127 5128 5129 5130 5131 5132 5133 5134 5135 5136 5137 5138 5139 5140 5141 5142 5143 5144 5145 5146 5147 5148 5149 5150 5151 5152 5153 5154 5155 5156 5157 5158 5159 5160 5161 5162 5163 5164 5165 5166 5167 5168 5169 5170 5171 5172 5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 5188 5189 5190 5191 5192 5193 5194 5195 5196 5197 5198 5199 5200 5201 5202 5203 5204 5205 5206 5207 5208 5209 5210 5211 5212 5213 5214 5215 5216 5217 5218 5219 5220 5221 5222 5223 5224 5225 5226 5227 5228 5229 5230 5231 5232 5233 5234 5235 5236 5237 5238 5239 5240 5241 5242 5243 5244 5245 5246 5247 5248 5249 5250 5251 5252 5253 5254 5255 5256 5257 5258 5259 5260 5261 5262 5263 5264 5265 5266 5267 5268 5269 5270 5271 5272 5273 5274 5275 5276 5277 5278 5279 5280 5281 5282 5283 5284 5285 5286 5287 5288 5289 5290 5291 5292 5293 5294 5295 5296 5297 5298 5299 5300 5301 5302 5303 5304 5305 5306 5307 5308 5309 5310 5311 5312 5313 5314 5315 5316 5317 5318 5319 5320 5321 5322 5323 5324 5325 5326 5327 5328 5329 5330 5331 5332 5333 5334 5335 5336 5337 5338 5339 5340 5341 5342 5343 5344 5345 5346 5347 5348 5349 5350 5351 5352 5353 5354 5355 5356 5357 5358 5359 5360 5361 5362 5363 5364 5365 5366 5367 5368 5369 5370 5371 5372 5373 5374 5375 5376 5377 5378 5379 5380 5381 5382 5383 5384 5385 5386 5387 5388 5389 5390 5391 5392 5393 5394 5395 5396 5397 5398 5399 5400 5401 5402 5403 5404 5405 5406 5407 5408 5409 5410 5411 5412 5413 5414 5415 5416 5417 5418 5419 5420 5421 5422 5423 5424 5425 5426 5427 5428 5429 5430 5431 5432 5433 5434 5435 5436 5437 5438 5439 5440 5441 5442 5443 5444 5445 5446 5447 5448 5449 5450 5451 5452 5453 5454 5455 5456 5457 5458 5459 5460 5461 5462 5463 5464 5465 5466 5467 5468 5469 5470 5471 5472 5473 5474 5475 5476 5477 5478 5479 5480 5481 5482 5483 5484 5485 5486 5487 5488 5489 5490 5491 5492 5493 5494 5495 5496 5497 5498 5499 5500 5501 5502 5503 5504 5505 5506 5507 5508 5509 5510 5511 5512 5513 5514 5515 5516 5517 5518 5519 5520 5521 5522 5523 5524 5525 5526 5527 5528 5529 5530 5531 5532 5533 5534 5535 5536 5537 5538 5539 5540 5541 5542 5543 5544 5545 5546 5547 5548 5549 5550 5551 5552 5553 5554 5555 5556 5557 5558 5559 5560 5561 5562 5563 5564 5565 5566 5567 5568 5569 5570 5571 5572 5573 5574 5575 5576 5577 5578 5579 5580 5581 5582 5583 5584 5585 5586 5587 5588 5589 5590 5591 5592 5593 5594 5595 5596 5597 5598 5599 5600 5601 5602 5603 5604 5605 5606 5607 5608 5609 5610 5611 5612 5613 5614 5615 5616 5617 5618 5619 5620 5621 5622 5623 5624 5625 5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 5636 5637 5638 5639 5640 5641 5642 5643 5644 5645 5646 5647 5648 5649 5650 5651 5652 5653 5654 5655 5656 5657 5658 5659 5660 5661 5662 5663 5664 5665 5666 5667 5668 5669 5670 5671 5672 5673 5674 5675 5676 5677 5678 5679 5680 5681 5682 5683 5684 5685 5686 5687 5688 5689 5690 5691 5692 5693 5694 5695 5696 5697 5698 5699 5700 5701 5702 5703 5704 5705 5706 5707 5708 5709 5710 5711 5712 5713 5714 5715 5716 5717 5718 5719 5720 5721 5722 5723 5724 5725 5726 5727 5728 5729 5730 5731 5732 5733 5734 5735 5736 5737 5738 5739 5740 5741 5742 5743 5744 5745 5746 5747 5748 5749 5750 5751 5752 5753 5754 5755 5756 5757 5758 5759 5760 5761 5762 5763 5764 5765 5766 5767 5768 5769 5770 5771 5772 5773 5774 5775 5776 5777 5778 5779 5780 5781 5782 5783 5784 5785 5786 5787 5788 5789 5790 5791 5792 5793 5794 5795 5796 5797 5798 5799 5800 5801 5802 5803 5804 5805 5806 5807 5808 5809 5810 5811 5812 5813 5814 5815 5816 5817 5818 5819 5820 5821 5822 5823 5824 5825 5826 5827 5828 5829 5830 5831 5832 5833 5834 5835 5836 5837 5838 5839 5840 5841 5842 5843 5844 5845 5846 5847 5848 5849 5850 5851 5852 5853 5854 5855 5856 5857 5858 5859 5860 5861 5862 5863 5864 5865 5866 5867 5868 5869 5870 5871 5872 5873 5874 5875 5876 5877 5878 5879 5880 5881 5882 5883 5884 5885 5886 5887 5888 5889 5890 5891 5892 5893 5894 5895 5896 5897 5898 5899 5900 5901 5902 5903 5904 5905 5906 5907 5908 5909 5910 5911 5912 5913 5914 5915 5916 5917 5918 5919 5920 5921 5922 5923 5924 5925 5926 5927 5928 5929 5930 5931 5932 5933 5934 5935 5936 5937 5938 5939 5940 5941 5942 5943 5944 5945 5946 5947 5948 5949 5950 5951 5952 5953 5954 5955 5956 5957 5958 5959 5960 5961 5962 5963 5964 5965 5966 5967 5968 5969 5970 5971 5972 5973 5974 5975 5976 5977 5978 5979 5980 5981 5982 5983 5984 5985 5986 5987 5988 5989 5990 5991 5992 5993 5994 5995 5996 5997 5998 5999 6000 6001 6002 6003 6004 6005 6006 6007 6008 6009 6010 6011 6012 6013 6014 6015 6016 6017 6018 6019 6020 6021 6022 6023 6024 6025 6026 6027 6028 6029 6030 6031 6032 6033 6034 6035 6036 6037 6038 6039 6040 6041 6042 6043 6044 6045 6046 6047 6048 6049 6050 6051 6052 6053 6054 6055 6056 6057 6058 6059 6060 6061 6062 6063 6064 6065 6066 6067 6068 6069 6070 6071 6072 6073 6074 6075 6076 6077 6078 6079 6080 6081 6082 6083 6084 6085 6086 6087 6088 6089 6090 6091 6092 6093 6094 6095 6096 6097 6098 6099 6100 6101 6102 6103 6104 6105 6106 6107 6108 6109 6110 6111 6112 6113 6114 6115 6116 6117 6118 6119 6120 6121 6122 6123 6124 6125 6126 6127 6128 6129 6130 6131 6132 6133 6134 6135 6136 6137 6138 6139 6140 6141 6142 6143 6144 6145 6146 6147 6148 6149 6150 6151 6152 6153 6154 6155 6156 6157 6158 6159 6160 6161 6162 6163 6164 6165 6166 6167 6168 6169 6170 6171 6172 6173 6174 6175 6176 6177 6178 6179 6180 6181 6182 6183 6184 6185 6186 6187 6188 6189 6190 6191 6192 6193 6194 6195 6196 6197 6198 6199 6200 6201 6202 6203 6204 6205 6206 6207 6208 6209 6210 6211 6212 6213 6214 6215 6216 6217 6218 6219 6220 6221 6222 6223 6224 6225 6226 6227 6228 6229 6230 6231 6232 6233 6234 6235 6236 6237 6238 6239 6240 6241 6242 6243 6244 6245 6246 6247 6248 6249 6250 6251 6252 6253 6254 6255 6256 6257 6258 6259 6260 6261 6262 6263 6264 6265 6266 6267 6268 6269 6270 6271 6272 6273 6274 6275 6276 6277 6278 6279 6280 6281 6282 6283 6284 6285 6286 6287 6288 6289 6290 6291 6292 6293 6294 6295 6296 6297 6298 6299 6300 6301 6302 6303 6304 6305 6306 6307 6308 6309 6310 6311 6312 6313 6314 6315 6316 6317 6318 6319 6320 6321 6322 6323 6324 6325 6326 6327 6328 6329 6330 6331 6332 6333 6334 6335 6336 6337 6338 6339 6340 6341 6342 6343 6344 6345 6346 6347 6348 6349 6350 6351 6352 6353 6354 6355 6356 6357 6358 6359 6360 6361 6362 6363 6364 6365 6366 6367 6368 6369 6370 6371 6372 6373 6374 6375 6376 6377 6378 6379 6380 6381 6382 6383 6384 6385 6386 6387 6388 6389 6390 6391 6392 6393 6394 6395 6396 6397 6398 6399 6400 6401 6402 6403 6404 6405 6406 6407 6408 6409 6410 6411 6412 6413 6414 6415 6416 6417 6418 6419 6420 6421 6422 6423 6424 6425 6426 6427 6428 6429 6430 6431 6432 6433 6434 6435 6436 6437 6438 6439 6440 6441 6442 6443 6444 6445 6446 6447 6448 6449 6450 6451 6452 6453 6454 6455 6456 6457 6458 6459 6460 6461 6462 6463 6464 6465 6466 6467 6468 6469 6470 6471 6472 6473 6474 6475 6476 6477 6478 6479 6480 6481 6482 6483 6484 6485 6486 6487 6488 6489 6490 6491 6492 6493 6494 6495 6496 6497 6498 6499 6500 6501 6502 6503 6504 6505 6506 6507 6508 6509 6510 6511 6512 6513 6514 6515 6516 6517 6518 6519 6520 6521 6522 6523 6524 6525 6526 6527 6528 6529 6530 6531 6532 6533 6534 6535 6536 6537 6538 6539 6540 6541 6542 6543 6544 6545 6546 6547 6548 6549 6550 6551 6552 6553 6554 6555 6556 6557 6558 6559 6560 6561 6562 6563 6564 6565 6566 6567 6568 6569 6570 6571 6572 6573 6574 6575 6576 6577 6578 6579 6580 6581 6582 6583 6584 6585 6586 6587 6588 6589 6590 6591 6592 6593 6594 6595 6596 6597 6598 6599 6600 6601 6602 6603 6604 6605 6606 6607 6608 6609 6610 6611 6612 6613 6614 6615 6616 6617 6618 6619 6620 6621 6622 6623 6624 6625 6626 6627 6628 6629 6630 6631 6632 6633 6634 6635 6636 6637 6638 6639 6640 6641 6642 6643 6644 6645 6646 6647 6648 6649 6650 6651 6652 6653 6654 6655 6656 6657 6658 6659 6660 6661 6662 6663 6664 6665 6666 6667 6668 6669 6670 6671 6672 6673 6674 6675 6676 6677 6678 6679 6680 6681 6682 6683 6684 6685 6686 6687 6688 6689 6690 6691 6692 6693 6694 6695 6696 6697 6698 6699 6700 6701 6702 6703 6704 6705 6706 6707 6708 6709 6710 6711 6712 6713 6714 6715 6716 6717 6718 6719 6720 6721 6722 6723 6724 6725 6726 6727 6728 6729 6730 6731 6732 6733 6734 6735 6736 6737 6738 6739 6740 6741 6742 6743 6744 6745 6746 6747 6748 6749 6750 6751 6752 6753 6754 6755 6756 6757 6758 6759 6760 6761 6762 6763 6764 6765 6766 6767 6768 6769 6770 6771 6772 6773 6774 6775 6776 6777 6778 6779 6780 6781 6782 6783 6784 6785 6786 6787 6788 6789 6790 6791 6792 6793 6794 6795 6796 6797 6798 6799 6800 6801 6802 6803 6804 6805 6806 6807 6808 6809 6810 6811 6812 6813 6814 6815 6816 6817 6818 6819 6820 6821 6822 6823 6824 6825 6826 6827 6828 6829 6830 6831 6832 6833 6834 6835 6836 6837 6838 6839 6840 6841 6842 6843 6844 6845 6846 6847 6848 6849 6850 6851 6852 6853 6854 6855 6856 6857 6858 6859 6860 6861 6862 6863 6864 6865 6866 6867 6868 6869 6870 6871 6872 6873 6874 6875 6876 6877 6878 6879 6880 6881 6882 6883 6884 6885 6886 6887 6888 6889 6890 6891 6892 6893 6894 6895 6896 6897 6898 6899 6900 6901 6902 6903 6904 6905 6906 6907 6908 6909 6910 6911 6912 6913 6914 6915 6916 6917 6918 6919 6920 6921 6922 6923 6924 6925 6926 6927 6928 6929 6930 6931 6932 6933 6934 6935 6936 6937 6938 6939 6940 6941 6942 6943 6944 6945 6946 6947 6948 6949 6950 6951 6952 6953 6954 6955 6956 6957 6958 6959 6960 6961 6962 6963 6964 6965 6966 6967 6968 6969 6970 6971 6972 6973 6974 6975 6976 6977 6978 6979 6980 6981 6982 6983 6984 6985 6986 6987 6988 6989 6990 6991 6992 6993 6994 6995 6996 6997 6998 6999 7000 7001 7002 7003 7004 7005 7006 7007 7008 7009 7010 7011 7012 7013 7014 7015 7016 7017 7018 7019 7020 7021 7022 7023 7024 7025 7026 7027 7028 7029 7030 7031 7032 7033 7034 7035 7036 7037 7038 7039 7040 7041 7042 7043 7044 7045 7046 7047 7048 7049 7050 7051 7052 7053 7054 7055 7056 7057 7058 7059 7060 7061 7062 7063 7064 7065 7066 7067 7068 7069 7070 7071 7072 7073 7074 7075 7076 7077 7078 7079 7080 7081 7082 7083 7084 7085 7086 7087 7088 7089 7090 7091 7092 7093 7094 7095 7096 7097 7098 7099 7100 7101 7102 7103 7104 7105 7106 7107 7108 7109 7110 7111 7112 7113 7114 7115 7116 7117 7118 7119 7120 7121 7122 7123 7124 7125 7126 7127 7128 7129 7130 7131 7132 7133 7134 7135 7136 7137 7138 7139 7140 7141 7142 7143 7144 7145 7146 7147 7148 7149 7150 7151 7152 7153 7154 7155 7156 7157 7158 7159 7160 7161 7162 7163 7164 7165 7166 7167 7168 7169 7170 7171 7172 7173 7174 7175 7176 7177 7178 7179 7180 7181 7182 7183 7184 7185 7186 7187 7188 7189 7190 7191 7192 7193 7194 7195 7196 7197 7198 7199 7200 7201 7202 7203 7204 7205 7206 7207 7208 7209 7210 7211 7212 7213 7214 7215 7216 7217 7218 7219 7220 7221 7222 7223 7224 7225 7226 7227 7228 7229 7230 7231 7232 7233 7234 7235 7236 7237 7238 7239 7240 7241 7242 7243 7244 7245 7246 7247 7248 7249 7250 7251 7252 7253 7254 7255 7256 7257 7258 7259 7260 7261 7262 7263 7264 7265 7266 7267 7268 7269 7270 7271 7272 7273 7274 7275 7276 7277 7278 7279 7280 7281 7282 7283 7284 7285 7286 7287 7288 7289 7290 7291 7292 7293 7294 7295 7296 7297 7298 7299 7300 7301 7302 7303 7304 7305 7306 7307 7308 7309 7310 7311 7312 7313 7314 7315 7316 7317 7318 7319 7320 7321 7322 7323 7324 7325 7326 7327 7328 7329 7330 7331 7332 7333 7334 7335 7336 7337 7338 7339 7340 7341 7342 7343 7344 7345 7346 7347 7348 7349 7350 7351 7352 7353 7354 7355 7356 7357 7358 7359 7360 7361 7362 7363 7364 7365 7366 7367 7368 7369 7370 7371 7372 7373 7374 7375 7376 7377 7378 7379 7380 7381 7382 7383 7384 7385 7386 7387 7388 7389 7390 7391 7392 7393 7394 7395 7396 7397 7398 7399 7400 7401 7402 7403 7404 7405 7406 7407 7408 7409 7410 7411 7412 7413 7414 7415 7416 7417 7418 7419 7420 7421 7422 7423 7424 7425 7426 7427 7428 7429 7430 7431 7432 7433 7434 7435 7436 7437 7438 7439 7440 7441 7442 7443 7444 7445 7446 7447 7448 7449 7450 7451 7452 7453 7454 7455 7456 7457 7458 7459 7460 7461 7462 7463 7464 7465 7466 7467 7468 7469 7470 7471 7472 7473 7474 7475 7476 7477 7478 7479 7480 7481 7482 7483 7484 7485 7486 7487 7488 7489 7490 7491 7492 7493 7494 7495 7496 7497 7498 7499 7500 7501 7502 7503 7504 7505 7506 7507 7508 7509 7510 7511 7512 7513 7514 7515 7516 7517 7518 7519 7520 7521 7522 7523 7524 7525 7526 7527 7528 7529 7530 7531 7532 7533 7534 7535 7536 7537 7538 7539 7540 7541 7542 7543 7544 7545 7546 7547 7548 7549 7550 7551 7552 7553 7554 7555 7556 7557 7558 7559 7560 7561 7562 7563 7564 7565 7566 7567 7568 7569 7570 7571 7572 7573 7574 7575 7576 7577 7578 7579 7580 7581 7582 7583 7584 7585 7586 7587 7588 7589 7590 7591 7592 7593 7594 7595 7596 7597 7598 7599 7600 7601 7602 7603 7604 7605 7606 7607 7608 7609 7610 7611 7612 7613 7614 7615 7616 7617 7618 7619 7620 7621 7622 7623 7624 7625 7626 7627 7628 7629 7630 7631 7632 7633 7634 7635 7636 7637 7638 7639 7640 7641 7642 7643 7644 7645 7646 7647 7648 7649 7650 7651 7652 7653 7654 7655 7656 7657 7658 7659 7660 7661 7662 7663 7664 7665 7666 7667 7668 7669 7670 7671 7672 7673 7674 7675 7676 7677 7678 7679 7680 7681 7682 7683 7684 7685 7686 7687 7688 7689 7690 7691 7692 7693 7694 7695 7696 7697 7698 7699 7700 7701 7702 7703 7704 7705 7706 7707 7708 7709 7710 7711 7712 7713 7714 7715 7716 7717 7718 7719 7720 7721 7722 7723 7724 7725 7726 7727 7728 7729 7730 7731 7732 7733 7734 7735 7736 7737 7738 7739 7740 7741 7742 7743 7744 7745 7746 7747 7748 7749 7750 7751 7752 7753 7754 7755 7756 7757 7758 7759 7760 7761 7762 7763 7764 7765 7766 7767 7768 7769 7770 7771 7772 7773 7774 7775 7776 7777 7778 7779 7780 | /*
* This file contains D-Bus client proxy classes generated by qt-client-gen.py.
*
* This file can be distributed under the same terms as the specification from
* which it was generated.
*/
#ifndef IN_TP_QT_HEADER
#error IN_TP_QT_HEADER
#endif
#include <TelepathyQt/Types>
#include <QtGlobal>
#include <QString>
#include <QObject>
#include <QVariant>
#include <QDBusPendingReply>
#include <TelepathyQt/AbstractInterface>
#include <TelepathyQt/DBusProxy>
#include <TelepathyQt/Global>
namespace Tp
{
class PendingVariant;
class PendingOperation;
}
namespace Tp
{
namespace Client
{
/**
* \class ConnectionInterface
* \headerfile TelepathyQt/connection.h <TelepathyQt/Connection>
* \ingroup clientconn
*
* Proxy class providing a 1:1 mapping of the D-Bus interface "org.freedesktop.Telepathy.Connection".
*/
class TP_QT_EXPORT ConnectionInterface : public Tp::AbstractInterface
{
Q_OBJECT
public:
/**
* Returns the name of the interface "org.freedesktop.Telepathy.Connection", which this class
* represents.
*
* \return The D-Bus interface name.
*/
static inline QLatin1String staticInterfaceName()
{
return QLatin1String("org.freedesktop.Telepathy.Connection");
}
/**
* Creates a ConnectionInterface associated with the given object on the session bus.
*
* \param busName Name of the service the object is on.
* \param objectPath Path to the object on the service.
* \param parent Passed to the parent class constructor.
*/
ConnectionInterface(
const QString& busName,
const QString& objectPath,
QObject* parent = 0
);
/**
* Creates a ConnectionInterface associated with the given object on the given bus.
*
* \param connection The bus via which the object can be reached.
* \param busName Name of the service the object is on.
* \param objectPath Path to the object on the service.
* \param parent Passed to the parent class constructor.
*/
ConnectionInterface(
const QDBusConnection& connection,
const QString& busName,
const QString& objectPath,
QObject* parent = 0
);
/**
* Creates a ConnectionInterface associated with the same object as the given proxy.
*
* \param proxy The proxy to use. It will also be the QObject::parent()
* for this object.
*/
ConnectionInterface(Tp::DBusProxy *proxy);
/**
* Asynchronous getter for the remote object property \c Interfaces of type \c QStringList.
*
*
* \htmlonly
* <p>The set of optional interfaces supported by this connection.
* Before the connection status changes to CONNECTED,
* this property may change at any time, but it is guaranteed that
* interfaces will only be added, not removed. After the connection
* status changes to CONNECTED, this property cannot
* change further.</p>
*
* <p>There is no explicit change notification; reasonable behaviour
* for a client would be to retrieve the interfaces list once
* initially, and once more when it becomes CONNECTED.</p>
*
* <div class="rationale">
* <p>In some connection managers, certain capabilities of a connection
* are known to be implemented for all connections (e.g. support
* for SimplePresence), and some interfaces (like SimplePresence) can
* even be used before connecting. Other capabilities may
* or may not exist, depending on server functionality; by the time
* the connection goes CONNECTED, the connection manager is expected
* to have evaluated the server's functionality and enabled any extra
* interfaces for the remainder of the Connection's lifetime.</p>
* </div>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyInterfaces() const
{
return internalRequestProperty(QLatin1String("Interfaces"));
}
/**
* Asynchronous getter for the remote object property \c SelfHandle of type \c uint.
*
*
* The handle which represents the user on this connection, which will
* remain valid for the lifetime of this connection, or until a change in
* the user's identifier is signalled by the SelfHandleChanged
* signal. If the connection is not yet in the CONNECTED state, the value
* of this property MAY be zero.
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertySelfHandle() const
{
return internalRequestProperty(QLatin1String("SelfHandle"));
}
/**
* Asynchronous getter for the remote object property \c Status of type \c uint.
*
*
* \htmlonly
* <p>The current status of the connection. Change notification is via
* the \endhtmlonly StatusChanged() \htmlonly signal.</p>
*
* <p>If retrieval of property succeeds and yields the value Disconnected,
* this indicates that the connection has not yet been established.
* If connection has been attempted and failed, the Connection object
* SHOULD be removed from the bus entirely, meaning that retrieval of
* this property SHOULD fail.</p>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyStatus() const
{
return internalRequestProperty(QLatin1String("Status"));
}
/**
* Asynchronous getter for the remote object property \c HasImmortalHandles of type \c bool.
*
*
* \htmlonly
* <p>True if handles last for the whole lifetime of the Connection.
* This SHOULD be the case in all connection managers, but clients
* MUST interoperate with older connection managers
* (which reference-count handles).</p>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyHasImmortalHandles() const
{
return internalRequestProperty(QLatin1String("HasImmortalHandles"));
}
/**
* Request all of the DBus properties on the interface.
*
* \return A pending variant map which will emit finished when the properties have
* been retrieved.
*/
Tp::PendingVariantMap *requestAllProperties() const
{
return internalRequestAllProperties();
}
public Q_SLOTS:
/**
* Begins a call to the D-Bus method \c Connect on the remote object.
*
* \htmlonly
* <p>Request that the connection be established. This will be done
* asynchronously and errors will be returned by emitting
* \endhtmlonly StatusChanged() \htmlonly signals.</p>
*
* <p>Calling this method on a Connection that is already connecting
* or connected is allowed, and has no effect.</p>
* \endhtmlonly
*
* Note that \a timeout is ignored as of now. It will be used once
* http://bugreports.qt.nokia.com/browse/QTBUG-11775 is fixed.
*
* \param timeout The timeout in milliseconds.
*/
inline QDBusPendingReply<> Connect(int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("Connect"));
return this->connection().asyncCall(callMessage, timeout);
}
/**
* Begins a call to the D-Bus method \c Disconnect on the remote object.
*
* Request that the connection be closed. This closes the connection if
* it's not already in DISCONNECTED state, and destroys the
* connection object.
*
* Note that \a timeout is ignored as of now. It will be used once
* http://bugreports.qt.nokia.com/browse/QTBUG-11775 is fixed.
*
* \param timeout The timeout in milliseconds.
*/
inline QDBusPendingReply<> Disconnect(int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("Disconnect"));
return this->connection().asyncCall(callMessage, timeout);
}
/**
* Begins a call to the D-Bus method \c GetInterfaces on the remote object.
*
* \htmlonly
* <p>Returns the set of optional interfaces supported by this
* connection. See \endhtmlonly \link requestPropertyInterfaces() Interfaces \endlink \htmlonly for more
* details.</p>
* \endhtmlonly
*
* Note that \a timeout is ignored as of now. It will be used once
* http://bugreports.qt.nokia.com/browse/QTBUG-11775 is fixed.
*
* \param timeout The timeout in milliseconds.
*
* \return
*
* The value of the Interfaces property
*/
inline QDBusPendingReply<QStringList> GetInterfaces(int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<QStringList>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("GetInterfaces"));
return this->connection().asyncCall(callMessage, timeout);
}
/**
* Begins a call to the D-Bus method \c GetProtocol on the remote object.
*
* Get the protocol this connection is using.
*
* Note that \a timeout is ignored as of now. It will be used once
* http://bugreports.qt.nokia.com/browse/QTBUG-11775 is fixed.
*
* \param timeout The timeout in milliseconds.
*
* \return
*
* A string identifier for the protocol
*/
inline QDBusPendingReply<QString> GetProtocol(int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<QString>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("GetProtocol"));
return this->connection().asyncCall(callMessage, timeout);
}
/**
* Begins a call to the D-Bus method \c GetSelfHandle on the remote object.
*
* Returns the value of the SelfHandle property. Change notification is
* via the SelfHandleChanged signal.
*
* Note that \a timeout is ignored as of now. It will be used once
* http://bugreports.qt.nokia.com/browse/QTBUG-11775 is fixed.
*
* \param timeout The timeout in milliseconds.
*
* \return
*
* The value of the SelfHandle property
*/
inline QDBusPendingReply<uint> GetSelfHandle(int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<uint>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("GetSelfHandle"));
return this->connection().asyncCall(callMessage, timeout);
}
/**
* Begins a call to the D-Bus method \c GetStatus on the remote object.
*
* Get the current status as defined in the StatusChanged signal.
*
* Note that \a timeout is ignored as of now. It will be used once
* http://bugreports.qt.nokia.com/browse/QTBUG-11775 is fixed.
*
* \param timeout The timeout in milliseconds.
*
* \return
*
* The value of the Status property
*/
inline QDBusPendingReply<uint> GetStatus(int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<uint>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("GetStatus"));
return this->connection().asyncCall(callMessage, timeout);
}
/**
* Begins a call to the D-Bus method \c HoldHandles on the remote object.
*
* \htmlonly
* <p>If \endhtmlonly \link requestPropertyHasImmortalHandles() HasImmortalHandles \endlink \htmlonly is true,
* which SHOULD always be the case in this version of telepathy-spec,
* this method does nothing and returns successfully, unless
* the given handle type or any of the given handles is invalid.</p>
*
* <p>In older connection managers, this method
* notifies the connection manger that your client is holding a copy
* of handles which may not be in use in any existing channel or
* list, and were not obtained by using the
* \endhtmlonly RequestHandles() \htmlonly method. For
* example, a handle observed in an emitted signal, or displayed
* somewhere in the UI that is not associated with a channel. The
* connection manager must not deallocate a handle where any clients
* have used this method to indicate it is in use until the
* \endhtmlonly ReleaseHandles() \htmlonly
* method is called, or the clients disappear from the bus.</p>
*
* <p>Note that HoldHandles is idempotent - calling it multiple times
* is equivalent to calling it once. If a handle is "referenced" by
* several components which share a D-Bus unique name, the client
* should perform reference counting internally, and only call
* ReleaseHandles when none of the cooperating components need the
* handle any longer.</p>
* \endhtmlonly
*
* Note that \a timeout is ignored as of now. It will be used once
* http://bugreports.qt.nokia.com/browse/QTBUG-11775 is fixed.
*
*
* \param handleType
*
* The type of handle to be held
*
* \param handles
*
* A array of integer handles to hold
* \param timeout The timeout in milliseconds.
*/
inline QDBusPendingReply<> HoldHandles(uint handleType, const Tp::UIntList& handles, int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("HoldHandles"));
callMessage << QVariant::fromValue(handleType) << QVariant::fromValue(handles);
return this->connection().asyncCall(callMessage, timeout);
}
/**
* Begins a call to the D-Bus method \c InspectHandles on the remote object.
*
* Return a string representation for a number of handles of a given type.
*
* Note that \a timeout is ignored as of now. It will be used once
* http://bugreports.qt.nokia.com/browse/QTBUG-11775 is fixed.
*
*
* \param handleType
*
* The type of handle to be inspected
*
* \param handles
*
* An array of integer handles of this type
* \param timeout The timeout in milliseconds.
*
* \return
*
* An array of identifiers corresponding to the given handles, in the
* same order.
*/
inline QDBusPendingReply<QStringList> InspectHandles(uint handleType, const Tp::UIntList& handles, int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<QStringList>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("InspectHandles"));
callMessage << QVariant::fromValue(handleType) << QVariant::fromValue(handles);
return this->connection().asyncCall(callMessage, timeout);
}
/**
* Begins a call to the D-Bus method \c ListChannels on the remote object.
*
* List all the channels which currently exist on this connection.
*
* Note that \a timeout is ignored as of now. It will be used once
* http://bugreports.qt.nokia.com/browse/QTBUG-11775 is fixed.
*
* \param timeout The timeout in milliseconds.
*
* \return
*
* An array of structs representing channels.
*/
inline QDBusPendingReply<Tp::ChannelInfoList> ListChannels(int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<Tp::ChannelInfoList>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("ListChannels"));
return this->connection().asyncCall(callMessage, timeout);
}
/**
* Begins a call to the D-Bus method \c ReleaseHandles on the remote object.
*
* If HasImmortalHandles is true, which SHOULD always be the case in this
* version of telepathy-spec, this method does nothing and returns
* successfully, unless the given handle type or any of the given handles
* is invalid. In older connection managers, this method explicitly
* notifies the connection manager that your client is no longer holding
* any references to the given handles, and that they may be deallocated
* if they are not held by any other clients or referenced by any existing
* channels. See HoldHandles for notes.
*
* Note that \a timeout is ignored as of now. It will be used once
* http://bugreports.qt.nokia.com/browse/QTBUG-11775 is fixed.
*
*
* \param handleType
*
* An integer handle type (as defined in RequestHandle)
*
* \param handles
*
* An array of integer handles being held by the client
* \param timeout The timeout in milliseconds.
*/
inline QDBusPendingReply<> ReleaseHandles(uint handleType, const Tp::UIntList& handles, int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("ReleaseHandles"));
callMessage << QVariant::fromValue(handleType) << QVariant::fromValue(handles);
return this->connection().asyncCall(callMessage, timeout);
}
/**
* Begins a call to the D-Bus method \c RequestChannel on the remote object.
*
* \htmlonly
* <p>Request a channel satisfying the specified type and communicating
* with the contact, room, list etc. indicated by the given
* handle_type and handle. The handle_type and handle may both be
* zero to request the creation of a new, empty channel, which may
* or may not be possible, depending on the protocol and channel
* type.</p>
*
* <p>On success, the returned channel will always be of the requested
* type (i.e. implement the requested channel-type interface).</p>
*
* <p>If a new, empty channel is requested, on success the returned
* channel will always be an "anonymous" channel for which the type
* and handle are both zero.</p>
*
* <p>If a channel to a contact, room etc. is requested, on success, the
* returned channel may either be a new or existing channel to
* the requested entity (i.e. its
* \endhtmlonly \link ChannelInterface::requestPropertyTargetHandleType() ChannelInterface::TargetHandleType \endlink \htmlonly
* and \endhtmlonly \link ChannelInterface::requestPropertyTargetHandle() ChannelInterface::TargetHandle \endlink \htmlonly
* properties are the
* requested handle type and handle), or a newly created "anonymous"
* channel associated with the requested handle in some
* implementation-specific way.</p>
*
* <p>For example, for a contact handle, the returned channel
* might be "anonymous", but implement the groups interface and have
* the requested contact already present among the members.</p>
*
* <p>If the request cannot be satisfied, an error is raised and no
* channel is created.</p>
* \endhtmlonly
*
* Note that \a timeout is ignored as of now. It will be used once
* http://bugreports.qt.nokia.com/browse/QTBUG-11775 is fixed.
*
*
* \param type
*
* A D-Bus interface name representing base channel type
*
* \param handleType
*
* An integer representing the handle type, or Handle_Type_None if no
* handle is specified
*
* \param handle
*
* A nonzero integer handle representing a contact, room, list etc.
* according to handle_type, or zero if the handle_type is
* Handle_Type_None
*
* \param suppressHandler
*
* Clients SHOULD always set this to true. The historical meaning was
* that clients that did not intend to take responsibility for
* displaying the channel to the user could set this to FALSE, in
* which case the channel dispatcher would launch an appropriate
* channel handler. However, clients whose functionality relies on
* having a working channel dispatcher should obtain that
* functionality by calling methods on the channel dispatcher, so that
* they will get an appropriate error if the channel dispatcher is
* missing or not working. The channel dispatcher itself should set
* this to true too, so that it will ignore the NewChannel signal that
* results from the creation of the channel. It can then dispatch the
* channel returned from this method to an appropriate handler. So,
* there is no sensible use-case for setting this to false, and
* setting it to false can result in unhandled channels (in the case
* where clients assume that a channel dispatcher is present, but it
* isn't).
* \param timeout The timeout in milliseconds.
*
* \return
*
* The D-Bus object path for the channel created or retrieved
*/
inline QDBusPendingReply<QDBusObjectPath> RequestChannel(const QString& type, uint handleType, uint handle, bool suppressHandler, int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<QDBusObjectPath>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("RequestChannel"));
callMessage << QVariant::fromValue(type) << QVariant::fromValue(handleType) << QVariant::fromValue(handle) << QVariant::fromValue(suppressHandler);
return this->connection().asyncCall(callMessage, timeout);
}
/**
* Begins a call to the D-Bus method \c RequestHandles on the remote object.
*
* \htmlonly
* <p>Request several handles from the connection manager which represent a
* number of contacts, rooms or server-stored lists on the service.</p>
*
* <p>If \endhtmlonly \link requestPropertyHasImmortalHandles() HasImmortalHandles \endlink \htmlonly is true,
* which SHOULD always be the case in this version of telepathy-spec,
* the handles remain valid until the connection disconnects.</p>
*
* <p>The implementation of this method in older connection managers
* must record that these handles are in use by the
* client who invokes this method, and must not deallocate the handles
* until the client disconnects from the bus or calls the
* \endhtmlonly ReleaseHandles() \htmlonly
* method. Where the identifier refers to an entity that already has a
* handle in this connection manager, this handle should be returned
* instead. The handle number 0 must not be returned by the connection
* manager.</p>
* \endhtmlonly
*
* Note that \a timeout is ignored as of now. It will be used once
* http://bugreports.qt.nokia.com/browse/QTBUG-11775 is fixed.
*
*
* \param handleType
*
* The type of handle required
*
* \param identifiers
*
* An array of identifiers of entities to request handles for
* \param timeout The timeout in milliseconds.
*
* \return
*
* An array of integer handle numbers in the same order as the given
* identifiers.
*/
inline QDBusPendingReply<Tp::UIntList> RequestHandles(uint handleType, const QStringList& identifiers, int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<Tp::UIntList>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("RequestHandles"));
callMessage << QVariant::fromValue(handleType) << QVariant::fromValue(identifiers);
return this->connection().asyncCall(callMessage, timeout);
}
/**
* Begins a call to the D-Bus method \c AddClientInterest on the remote object.
*
* \htmlonly
* <p>Register a client's interest in notifications related to one or
* more interfaces.</p>
*
* <p>Groups of notifications are identified by a token which is either
* a D-Bus interface name, or a string that starts with a D-Bus
* interface name. The meaning of each token is given by that D-Bus
* interface, which MUST define it in its documentation.</p>
*
* <div class="rationale">
* <p>Initially, all interests are in entire interface, but allowing
* other strings allows subscription to part of an interface; for
* instance, an interest in ...MailNotification/count could track
* the number of messages without caring about their detailed
* content.</p>
* </div>
*
* <p>For each token with which this method interacts, the
* Connection tracks an "interest count" (like a reference count) for
* each unique bus name that has called this method. When a client
* calls this method, for each token, the interest count for its
* unique bus name is incremented; when
* \endhtmlonly RemoveClientInterest() \htmlonly is called,
* all interest counts for that unique bus name are decremented.
* If the unique bus name leaves the bus (for instance, if the
* client crashes or exits), all interest counts for that unique bus
* name are set to zero.</p>
*
* <p>The Connection can then use these reference counts to
* avoid subscribing to protocol-level notifications unless at least
* one client has a non-zero interest count for the relevant
* token.</p>
*
* <div class="rationale">
* <p>This method exists to reduce memory and network overhead when
* there is no active subscription.</p>
*
* <p>One situation where this is useful is \endhtmlonly ConnectionInterfaceLocationInterface \htmlonly : on XMPP, location updates are received
* over PEP. If the Connection advertises the
* <code>geoloc+notify</code> capability, it will be sent location
* updates for all contacts. To avoid consuming resources for this,
* the connection should avoid advertising that capability until
* a client has expressed an interest in contacts' locations.</p>
*
* <p>Another example of a protocol that benefits from this method is
* the Google XMPP Mail Notification extension, which can be used
* to implement \endhtmlonly ConnectionInterfaceMailNotificationInterface \htmlonly . In this protocol, the CM
* receives a notification that something has changed, but to get
* more information, the CM must request this information. Knowing
* that nobody is currently interested in this information, the CM
* can avoid generating useless network traffic. Similarly, the CM
* may free the list of unread messages to reduce memory overhead.</p>
* </div>
*
* <p>If this method is called for an interface that might require
* protocol-level subscription, but the connection cannot set up
* that subscription yet (for instance because the
* \endhtmlonly \link requestPropertyStatus() Status \endlink \htmlonly is not Connected yet), the
* Connection MUST remember the client's interest, and attempt to
* subscribe to the appropriate protocol feature when this becomes
* possible.</p>
*
* <p>Clients MAY ignore any errors raised by this method; it is intended
* to be called with the reply ignored.</p>
*
* <div class="rationale">
* <p>The only reason it could fail is if it's unimplemented, in which
* case the only thing the client can usefully do is to proceed as if
* it had succeeded.</p>
* </div>
* \endhtmlonly
*
* Note that \a timeout is ignored as of now. It will be used once
* http://bugreports.qt.nokia.com/browse/QTBUG-11775 is fixed.
*
*
* \param tokens
*
* \htmlonly
* <p>Interfaces or parts of interfaces in which to register an
* interest, represented by either a
* <tp:type>DBus_Interface</tp:type>, or a string prefixed with a
* <tp:type>DBus_Interface</tp:type>.</p>
*
* <p>If the Connection does not support one of these tokens, this
* is not considered to be an error; the unsupported token is
* simply ignored.</p>
* \endhtmlonly
* \param timeout The timeout in milliseconds.
*/
inline QDBusPendingReply<> AddClientInterest(const QStringList& tokens, int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("AddClientInterest"));
callMessage << QVariant::fromValue(tokens);
return this->connection().asyncCall(callMessage, timeout);
}
/**
* Begins a call to the D-Bus method \c RemoveClientInterest on the remote object.
*
* \htmlonly
* <p>Release an interest registered using
* \endhtmlonly AddClientInterest() \htmlonly . See that
* method's documentation for details.</p>
*
* <p>Clients MAY ignore any errors raised by this method; it is intended
* to be called with the reply ignored.</p>
*
* <div class="rationale">
* <p>The only reasons it could fail are if it's unimplemented, or if
* the client's reference-counting is wrong and it has tried to
* remove a client interest that it did not add. In both cases,
* there's nothing the client could do about it.</p>
* </div>
* \endhtmlonly
*
* Note that \a timeout is ignored as of now. It will be used once
* http://bugreports.qt.nokia.com/browse/QTBUG-11775 is fixed.
*
*
* \param tokens
*
* \htmlonly
* <p>Interfaces or parts of interfaces that were previously passed to
* \endhtmlonly AddClientInterest() \htmlonly .</p>
* \endhtmlonly
* \param timeout The timeout in milliseconds.
*/
inline QDBusPendingReply<> RemoveClientInterest(const QStringList& tokens, int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("RemoveClientInterest"));
callMessage << QVariant::fromValue(tokens);
return this->connection().asyncCall(callMessage, timeout);
}
Q_SIGNALS:
/**
* Represents the signal \c SelfHandleChanged on the remote object.
*
* Emitted whenever the SelfHandle property changes. If the connection is
* not yet in the CONNECTED state, this signal is not guaranteed to be
* emitted.
*
* \param selfHandle
*
* The new value of the SelfHandle property.
*/
void SelfHandleChanged(uint selfHandle);
/**
* Represents the signal \c NewChannel on the remote object.
*
* Emitted when a new Channel object is created, either through user
* request or incoming information from the service.
*
* \param objectPath
*
* A D-Bus object path for the channel object on this service
*
* \param channelType
*
* A D-Bus interface name representing the channel type
*
* \param handleType
*
* An integer representing the type of handle this channel
* communicates with, or Handle_Type_None if no handle is specified
*
* \param handle
*
* A handle indicating the specific contact, room or list this channel
* communicates with, or zero if no handle is specified
*
* \param suppressHandler
*
* \htmlonly
* <p>If true, the channel was requested by a client that intends to
* present it to the user itself (i.e. it passed suppress_handler=TRUE
* to the \endhtmlonly RequestChannel() \htmlonly method), so no
* other handler should be
* launched. Clients MAY assume that channels where this is true
* were created by a user request.</p>
*
* <p>If false, either the channel was created due to incoming
* information from the service, or the channel was requested by
* a local client that does not intend to handle the channel itself
* (this usage is deprecated).</p>
*
* <p>Clients MUST NOT assume that only incoming channels will have
* this flag set to false.</p>
* \endhtmlonly
*/
void NewChannel(const QDBusObjectPath& objectPath, const QString& channelType, uint handleType, uint handle, bool suppressHandler);
/**
* Represents the signal \c ConnectionError on the remote object.
*
* \htmlonly
* <p>Emitted when an error occurs that renders this connection unusable.
* </p>
*
* <p>Whenever this signal is emitted, it MUST immediately be followed by
* a \endhtmlonly StatusChanged() \htmlonly signal with status
* Connection_Status_Disconnected and an appropriate reason
* code.</p>
*
* <p>Connection managers SHOULD emit this signal on disconnection, but
* need not do so. Clients MUST support connection managers that emit
* StatusChanged(Disconnected, ...) without first emitting
* ConnectionError.</p>
*
* <div class="rationale">
* <p>This signal provides additional information about the reason
* for disconnection. The reason for connection is always
* straightforward - it was requested - so it does not need further
* explanation. However, on errors, it can be useful to provide
* additional information.</p>
*
* <p>The <tp:type>Connection_Status_Reason</tp:type> is not given
* here, since it will be signalled in
* \endhtmlonly StatusChanged() \htmlonly . A reasonable client
* implementation would be to store the information given by this
* signal until StatusChanged is received, at which point the
* information given by this signal can be used to supplement the
* StatusChanged signal.</p>
* </div>
* \endhtmlonly
*
* \param error
*
* The name of a D-Bus error describing the error that occurred, which
* may correspond to a Connection_Status_Reason, or may be a more
* specific Telepathy error (such as
* org.freedesktop.Telepathy.Error.ConnectionRefused for
* Connection_Status_Reason_Network_Error) or a protocol-specific or
* connection-manager-specific error in a suitable namespace. For
* instance, a SIP connection manager could signal "402 Payment
* Required" as an error in a connection-manager-specific
* namespace, or a link-local XMPP implementation that used Avahi
* could provide the error given to it by the avahi-daemon.
*
* \param details
*
* \htmlonly
* <p>Additional information about the error, which may include
* the following well-known keys:</p>
*
* <dl>
* <dt>debug-message (s)</dt>
* <dd>Debugging information on the change, corresponding to the
* message part of a D-Bus error message, which SHOULD NOT be
* displayed to users under normal circumstances</dd>
*
* <dt>server-message (s)</dt>
* <dd>A human-readable message from the server explaining what
* happened. This may be in the user's native language, or in the
* server operator's native language, or even in Lojban.</dd>
*
* <dt>user-requested (b), expected-hostname (s), certificate-hostname (s)</dt>
* <dd>The same details defined in <tp:type>TLS_Certificate_Rejection</tp:type>.</dd>
* </dl>
* \endhtmlonly
*/
void ConnectionError(const QString& error, const QVariantMap& details);
/**
* Represents the signal \c StatusChanged on the remote object.
*
* Emitted when the status of the connection changes. All states and
* reasons have numerical values, as defined in ConnectionStatus and
* ConnectionStatusReason.
*
* \param status
*
* An integer indicating the new status, as defined by ConnectionStatus
*
* \param reason
*
* An integer indicating the reason for the status change, as defined
* by ConnectionStatusReason
*/
void StatusChanged(uint status, uint reason);
protected:
virtual void invalidate(Tp::DBusProxy *, const QString &, const QString &);
};
/**
* \class ConnectionInterfaceAddressingInterface
* \headerfile TelepathyQt/connection.h <TelepathyQt/Connection>
* \ingroup clientconn
*
* Proxy class providing a 1:1 mapping of the D-Bus interface "org.freedesktop.Telepathy.Connection.Interface.Addressing1".
*/
class TP_QT_EXPORT ConnectionInterfaceAddressingInterface : public Tp::AbstractInterface
{
Q_OBJECT
public:
/**
* Returns the name of the interface "org.freedesktop.Telepathy.Connection.Interface.Addressing1", which this class
* represents.
*
* \return The D-Bus interface name.
*/
static inline QLatin1String staticInterfaceName()
{
return QLatin1String("org.freedesktop.Telepathy.Connection.Interface.Addressing1");
}
/**
* Creates a ConnectionInterfaceAddressingInterface associated with the given object on the session bus.
*
* \param busName Name of the service the object is on.
* \param objectPath Path to the object on the service.
* \param parent Passed to the parent class constructor.
*/
ConnectionInterfaceAddressingInterface(
const QString& busName,
const QString& objectPath,
QObject* parent = 0
);
/**
* Creates a ConnectionInterfaceAddressingInterface associated with the given object on the given bus.
*
* \param connection The bus via which the object can be reached.
* \param busName Name of the service the object is on.
* \param objectPath Path to the object on the service.
* \param parent Passed to the parent class constructor.
*/
ConnectionInterfaceAddressingInterface(
const QDBusConnection& connection,
const QString& busName,
const QString& objectPath,
QObject* parent = 0
);
/**
* Creates a ConnectionInterfaceAddressingInterface associated with the same object as the given proxy.
*
* \param proxy The proxy to use. It will also be the QObject::parent()
* for this object.
*/
ConnectionInterfaceAddressingInterface(Tp::DBusProxy *proxy);
/**
* Creates a ConnectionInterfaceAddressingInterface associated with the same object as the given proxy.
* Additionally, the created proxy will have the same parent as the given
* proxy.
*
* \param mainInterface The proxy to use.
*/
explicit ConnectionInterfaceAddressingInterface(const Tp::Client::ConnectionInterface& mainInterface);
/**
* Creates a ConnectionInterfaceAddressingInterface associated with the same object as the given proxy.
* However, a different parent object can be specified.
*
* \param mainInterface The proxy to use.
* \param parent Passed to the parent class constructor.
*/
ConnectionInterfaceAddressingInterface(const Tp::Client::ConnectionInterface& mainInterface, QObject* parent);
/**
* Request all of the DBus properties on the interface.
*
* \return A pending variant map which will emit finished when the properties have
* been retrieved.
*/
Tp::PendingVariantMap *requestAllProperties() const
{
return internalRequestAllProperties();
}
public Q_SLOTS:
/**
* Begins a call to the D-Bus method \c GetContactsByVCardField on the remote object.
*
* \htmlonly
* <p>Request contacts and retrieve their attributes using a given field
* in their vCards.</p>
*
* <p>The connection manager should record that these handles are in
* use by the client who invokes this method, and must not
* deallocate the handles until the client disconnects from the
* bus or calls the
* \endhtmlonly ConnectionInterface::ReleaseHandles() \htmlonly
* method.</p>
* \endhtmlonly
*
* Note that \a timeout is ignored as of now. It will be used once
* http://bugreports.qt.nokia.com/browse/QTBUG-11775 is fixed.
*
*
* \param field
*
* \htmlonly
* <p>The vCard field of the addresses we are requesting. The
* field name SHOULD be in lower case. Supported
* fields can be found in
* \endhtmlonly \link ProtocolInterfaceAddressingInterface::requestPropertyAddressableVCardFields() ProtocolInterfaceAddressingInterface::AddressableVCardFields \endlink \htmlonly .</p>
*
* <p>The <code>url</code> vCard field MUST NOT appear here; see
* \endhtmlonly GetContactsByURI() \htmlonly instead.</p>
*
* <div class="rationale">
* <p>In practice, protocols have a limited set of URI
* schemes that make sense to resolve as a contact.</p>
* </div>
* \endhtmlonly
*
* \param addresses
*
* The addresses to get contact handles for. The address types should
* match the given vCard field.
*
* \param interfaces
*
* \htmlonly
* <p>A list of strings indicating which D-Bus interfaces the calling
* process is interested in. All supported attributes from these
* interfaces, whose values can be obtained without additional network
* activity, will be in the reply.</p>
*
* <p>Attributes from this interface and from
* \endhtmlonly ConnectionInterface \htmlonly
* are always returned, and need not be requested
* explicitly.</p>
*
* <p>The behavior of this parameter is similar to the same
* parameter in
* \endhtmlonly ConnectionInterfaceContactsInterface::GetContactAttributes() \htmlonly .</p>
* \endhtmlonly
* \param timeout The timeout in milliseconds.
*
* \return
*
* \htmlonly
* <p>A mapping from requested vCard addresses to the corresponding
* contact handles.</p>
*
* <p>Requested addresses that are not valid or understood for this protocol
* MUST be omitted from the mapping.</p>
* \endhtmlonly
*
* \return
*
* \htmlonly
* <p>A dictionary mapping the contact handles to contact attributes.
* If any of the requested addresses are in fact invalid, they are
* simply omitted from this mapping. If contact attributes are not
* immediately known, the behaviour is defined by the interface;
* the attribute should either be omitted from the result or
* replaced with a default value.</p>
*
* <p>Requested addresses that are not valid or understood for this protocol
* MUST be omitted from the mapping.</p>
*
* <p>Each contact's attributes will always include at least the
* identifier that would be obtained by inspecting the handle
* (<code>org.freedesktop.Telepathy.Connection/contact-id</code>).
* </p>
* \endhtmlonly
*/
inline QDBusPendingReply<Tp::AddressingNormalizationMap, Tp::ContactAttributesMap> GetContactsByVCardField(const QString& field, const QStringList& addresses, const QStringList& interfaces, int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<Tp::AddressingNormalizationMap, Tp::ContactAttributesMap>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("GetContactsByVCardField"));
callMessage << QVariant::fromValue(field) << QVariant::fromValue(addresses) << QVariant::fromValue(interfaces);
return this->connection().asyncCall(callMessage, timeout);
}
/**
* Begins a call to the D-Bus method \c GetContactsByURI on the remote object.
*
* \htmlonly
* <p>Request contacts and retrieve their attributes using URI addresses.</p>
*
* <p>The connection manager should record that these handles are in
* use by the client who invokes this method, and must not
* deallocate the handles until the client disconnects from the
* bus or calls the
* \endhtmlonly ConnectionInterface::ReleaseHandles() \htmlonly
* method.</p>
* \endhtmlonly
*
* Note that \a timeout is ignored as of now. It will be used once
* http://bugreports.qt.nokia.com/browse/QTBUG-11775 is fixed.
*
*
* \param URIs
*
* The URI addresses to get contact handles for. Supported schemes can
* be found in AddressableURISchemes.
*
* \param interfaces
*
* \htmlonly
* <p>A list of strings indicating which D-Bus interfaces the calling
* process is interested in. All supported attributes from these
* interfaces, whose values can be obtained without additional network
* activity, will be in the reply.</p>
*
* <p>Attributes from this interface and from
* \endhtmlonly ConnectionInterface \htmlonly
* are always returned, and need not be requested
* explicitly.</p>
*
* <p>The behavior of this parameter is similar to the same
* parameter in
* \endhtmlonly ConnectionInterfaceContactsInterface::GetContactAttributes() \htmlonly .</p>
* \endhtmlonly
* \param timeout The timeout in milliseconds.
*
* \return
*
* \htmlonly
* <p>A mapping of requested URIs to the corresponding contact handles.</p>
*
* <p>Requested URIs that are not valid or understood for this protocol
* MUST be omitted from the mapping.</p>
* \endhtmlonly
*
* \return
*
* \htmlonly
* <p>A dictionary mapping the contact handles to contact attributes.
* If any of the requested addresses are in fact invalid, they are
* simply omitted from this mapping. If contact attributes are not
* immediately known, the behaviour is defined by the interface;
* the attribute should either be omitted from the result or
* replaced with a default value.</p>
*
* <p>Requested URIs that are not valid or understood for this protocol
* MUST be omitted from the mapping.</p>
*
* <p>Each contact's attributes will always include at least the
* identifier that would be obtained by inspecting the handle
* (<code>org.freedesktop.Telepathy.Connection/contact-id</code>).
* </p>
* \endhtmlonly
*/
inline QDBusPendingReply<Tp::AddressingNormalizationMap, Tp::ContactAttributesMap> GetContactsByURI(const QStringList& URIs, const QStringList& interfaces, int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<Tp::AddressingNormalizationMap, Tp::ContactAttributesMap>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("GetContactsByURI"));
callMessage << QVariant::fromValue(URIs) << QVariant::fromValue(interfaces);
return this->connection().asyncCall(callMessage, timeout);
}
protected:
virtual void invalidate(Tp::DBusProxy *, const QString &, const QString &);
};
/**
* \class ConnectionInterfaceAliasingInterface
* \headerfile TelepathyQt/connection.h <TelepathyQt/Connection>
* \ingroup clientconn
*
* Proxy class providing a 1:1 mapping of the D-Bus interface "org.freedesktop.Telepathy.Connection.Interface.Aliasing".
*/
class TP_QT_EXPORT ConnectionInterfaceAliasingInterface : public Tp::AbstractInterface
{
Q_OBJECT
public:
/**
* Returns the name of the interface "org.freedesktop.Telepathy.Connection.Interface.Aliasing", which this class
* represents.
*
* \return The D-Bus interface name.
*/
static inline QLatin1String staticInterfaceName()
{
return QLatin1String("org.freedesktop.Telepathy.Connection.Interface.Aliasing");
}
/**
* Creates a ConnectionInterfaceAliasingInterface associated with the given object on the session bus.
*
* \param busName Name of the service the object is on.
* \param objectPath Path to the object on the service.
* \param parent Passed to the parent class constructor.
*/
ConnectionInterfaceAliasingInterface(
const QString& busName,
const QString& objectPath,
QObject* parent = 0
);
/**
* Creates a ConnectionInterfaceAliasingInterface associated with the given object on the given bus.
*
* \param connection The bus via which the object can be reached.
* \param busName Name of the service the object is on.
* \param objectPath Path to the object on the service.
* \param parent Passed to the parent class constructor.
*/
ConnectionInterfaceAliasingInterface(
const QDBusConnection& connection,
const QString& busName,
const QString& objectPath,
QObject* parent = 0
);
/**
* Creates a ConnectionInterfaceAliasingInterface associated with the same object as the given proxy.
*
* \param proxy The proxy to use. It will also be the QObject::parent()
* for this object.
*/
ConnectionInterfaceAliasingInterface(Tp::DBusProxy *proxy);
/**
* Creates a ConnectionInterfaceAliasingInterface associated with the same object as the given proxy.
* Additionally, the created proxy will have the same parent as the given
* proxy.
*
* \param mainInterface The proxy to use.
*/
explicit ConnectionInterfaceAliasingInterface(const Tp::Client::ConnectionInterface& mainInterface);
/**
* Creates a ConnectionInterfaceAliasingInterface associated with the same object as the given proxy.
* However, a different parent object can be specified.
*
* \param mainInterface The proxy to use.
* \param parent Passed to the parent class constructor.
*/
ConnectionInterfaceAliasingInterface(const Tp::Client::ConnectionInterface& mainInterface, QObject* parent);
/**
* Request all of the DBus properties on the interface.
*
* \return A pending variant map which will emit finished when the properties have
* been retrieved.
*/
Tp::PendingVariantMap *requestAllProperties() const
{
return internalRequestAllProperties();
}
public Q_SLOTS:
/**
* Begins a call to the D-Bus method \c GetAliasFlags on the remote object.
*
* Return a bitwise OR of flags detailing the behaviour of aliases on this
* connection.
*
* Note that \a timeout is ignored as of now. It will be used once
* http://bugreports.qt.nokia.com/browse/QTBUG-11775 is fixed.
*
* \param timeout The timeout in milliseconds.
*
* \return
*
* An integer with a bitwise OR of flags from ConnectionAliasFlags
*/
inline QDBusPendingReply<uint> GetAliasFlags(int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<uint>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("GetAliasFlags"));
return this->connection().asyncCall(callMessage, timeout);
}
/**
* Begins a call to the D-Bus method \c RequestAliases on the remote object.
*
* Request the value of several contacts' aliases at once.
*
* Note that \a timeout is ignored as of now. It will be used once
* http://bugreports.qt.nokia.com/browse/QTBUG-11775 is fixed.
*
*
* \param contacts
*
* An array of handles representing contacts
* \param timeout The timeout in milliseconds.
*
* \return
*
* A list of aliases in the same order as the contact handles
*/
inline QDBusPendingReply<QStringList> RequestAliases(const Tp::UIntList& contacts, int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<QStringList>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("RequestAliases"));
callMessage << QVariant::fromValue(contacts);
return this->connection().asyncCall(callMessage, timeout);
}
/**
* Begins a call to the D-Bus method \c GetAliases on the remote object.
*
* Request the value of several contacts' aliases at once. This
* SHOULD only return cached aliases, falling back on the contact
* identifier (i.e. the string corresponding to the handle) if none is
* present. Also if there was no cached alias, a request SHOULD be started
* of which the result is later signalled by AliasesChanged.
*
* Note that \a timeout is ignored as of now. It will be used once
* http://bugreports.qt.nokia.com/browse/QTBUG-11775 is fixed.
*
*
* \param contacts
*
* An array of handles representing contacts
* \param timeout The timeout in milliseconds.
*
* \return
*
* A dictionary mapping contact handles to aliases
*/
inline QDBusPendingReply<Tp::AliasMap> GetAliases(const Tp::UIntList& contacts, int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<Tp::AliasMap>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("GetAliases"));
callMessage << QVariant::fromValue(contacts);
return this->connection().asyncCall(callMessage, timeout);
}
/**
* Begins a call to the D-Bus method \c SetAliases on the remote object.
*
* Request that the alias of the given contact be changed. Success will be
* indicated by emitting an AliasesChanged signal. On connections where
* the CONNECTION_ALIAS_FLAG_USER_SET flag is not set, this method will
* only ever succeed if the contact is the user's own handle (as
* returned by Connection.GetSelfHandle).
*
* Note that \a timeout is ignored as of now. It will be used once
* http://bugreports.qt.nokia.com/browse/QTBUG-11775 is fixed.
*
*
* \param aliases
*
* A dictionary mapping integer handles of contacts to strings of the
* new alias to set.
* \param timeout The timeout in milliseconds.
*/
inline QDBusPendingReply<> SetAliases(const Tp::AliasMap& aliases, int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("SetAliases"));
callMessage << QVariant::fromValue(aliases);
return this->connection().asyncCall(callMessage, timeout);
}
Q_SIGNALS:
/**
* Represents the signal \c AliasesChanged on the remote object.
*
* Signal emitted when a contact's alias (or that of the user) is
* changed.
*
* \param aliases
*
* \htmlonly
* An array containing structs of:
* <ul>
* <li>the handle representing the contact</li>
* <li>the new alias</li>
* </ul>
* \endhtmlonly
*/
void AliasesChanged(const Tp::AliasPairList& aliases);
protected:
virtual void invalidate(Tp::DBusProxy *, const QString &, const QString &);
};
/**
* \class ConnectionInterfaceAnonymityInterface
* \headerfile TelepathyQt/connection.h <TelepathyQt/Connection>
* \ingroup clientconn
*
* Proxy class providing a 1:1 mapping of the D-Bus interface "org.freedesktop.Telepathy.Connection.Interface.Anonymity".
*/
class TP_QT_EXPORT ConnectionInterfaceAnonymityInterface : public Tp::AbstractInterface
{
Q_OBJECT
public:
/**
* Returns the name of the interface "org.freedesktop.Telepathy.Connection.Interface.Anonymity", which this class
* represents.
*
* \return The D-Bus interface name.
*/
static inline QLatin1String staticInterfaceName()
{
return QLatin1String("org.freedesktop.Telepathy.Connection.Interface.Anonymity");
}
/**
* Creates a ConnectionInterfaceAnonymityInterface associated with the given object on the session bus.
*
* \param busName Name of the service the object is on.
* \param objectPath Path to the object on the service.
* \param parent Passed to the parent class constructor.
*/
ConnectionInterfaceAnonymityInterface(
const QString& busName,
const QString& objectPath,
QObject* parent = 0
);
/**
* Creates a ConnectionInterfaceAnonymityInterface associated with the given object on the given bus.
*
* \param connection The bus via which the object can be reached.
* \param busName Name of the service the object is on.
* \param objectPath Path to the object on the service.
* \param parent Passed to the parent class constructor.
*/
ConnectionInterfaceAnonymityInterface(
const QDBusConnection& connection,
const QString& busName,
const QString& objectPath,
QObject* parent = 0
);
/**
* Creates a ConnectionInterfaceAnonymityInterface associated with the same object as the given proxy.
*
* \param proxy The proxy to use. It will also be the QObject::parent()
* for this object.
*/
ConnectionInterfaceAnonymityInterface(Tp::DBusProxy *proxy);
/**
* Creates a ConnectionInterfaceAnonymityInterface associated with the same object as the given proxy.
* Additionally, the created proxy will have the same parent as the given
* proxy.
*
* \param mainInterface The proxy to use.
*/
explicit ConnectionInterfaceAnonymityInterface(const Tp::Client::ConnectionInterface& mainInterface);
/**
* Creates a ConnectionInterfaceAnonymityInterface associated with the same object as the given proxy.
* However, a different parent object can be specified.
*
* \param mainInterface The proxy to use.
* \param parent Passed to the parent class constructor.
*/
ConnectionInterfaceAnonymityInterface(const Tp::Client::ConnectionInterface& mainInterface, QObject* parent);
/**
* Asynchronous getter for the remote object property \c SupportedAnonymityModes of type \c uint.
*
*
* The anonymity modes supported by the CM for this connection. Once
* Connection.Status has moved to Connected, this property MUST NOT change.
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertySupportedAnonymityModes() const
{
return internalRequestProperty(QLatin1String("SupportedAnonymityModes"));
}
/**
* Asynchronous getter for the remote object property \c AnonymityMandatory of type \c bool.
*
*
* This specifies whether or not the anonymity settings MUST be respected
* by the CM and any intermediaries between the local and remote contacts.
* If this is set to true but anonymity settings cannot be followed, then
* the session MUST be denied with a
* org.freedesktop.Telepathy.Error.WouldBreakAnonymity error. Any client
* that sets AnonymityModes SHOULD also set this property first (rather
* than accepting the CM's default value).
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyAnonymityMandatory() const
{
return internalRequestProperty(QLatin1String("AnonymityMandatory"));
}
/**
* Asynchronous setter for the remote object property \c AnonymityMandatory of type \c bool.
*
*
* This specifies whether or not the anonymity settings MUST be respected
* by the CM and any intermediaries between the local and remote contacts.
* If this is set to true but anonymity settings cannot be followed, then
* the session MUST be denied with a
* org.freedesktop.Telepathy.Error.WouldBreakAnonymity error. Any client
* that sets AnonymityModes SHOULD also set this property first (rather
* than accepting the CM's default value).
*
* \return A pending operation which will emit finished when the property has been
* set.
*/
inline Tp::PendingOperation *setPropertyAnonymityMandatory(bool newValue)
{
return internalSetProperty(QLatin1String("AnonymityMandatory"), QVariant::fromValue(newValue));
}
/**
* Asynchronous getter for the remote object property \c AnonymityModes of type \c uint.
*
*
* The currently enabled anonymity modes for the connection. Setting has
* the effect of requesting new modes for the connection, and may raise an
* error if the unsupported modes are set. Successfully changing the modes
* will result in emission of AnonymityModesChanged signal.
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyAnonymityModes() const
{
return internalRequestProperty(QLatin1String("AnonymityModes"));
}
/**
* Asynchronous setter for the remote object property \c AnonymityModes of type \c uint.
*
*
* The currently enabled anonymity modes for the connection. Setting has
* the effect of requesting new modes for the connection, and may raise an
* error if the unsupported modes are set. Successfully changing the modes
* will result in emission of AnonymityModesChanged signal.
*
* \return A pending operation which will emit finished when the property has been
* set.
*/
inline Tp::PendingOperation *setPropertyAnonymityModes(uint newValue)
{
return internalSetProperty(QLatin1String("AnonymityModes"), QVariant::fromValue(newValue));
}
/**
* Request all of the DBus properties on the interface.
*
* \return A pending variant map which will emit finished when the properties have
* been retrieved.
*/
Tp::PendingVariantMap *requestAllProperties() const
{
return internalRequestAllProperties();
}
Q_SIGNALS:
/**
* Represents the signal \c AnonymityModesChanged on the remote object.
*
* Emitted when the anonymity mode has changed.
*
* \param modes
*
* The new anonymity modes for this connection.
*/
void AnonymityModesChanged(uint modes);
protected:
virtual void invalidate(Tp::DBusProxy *, const QString &, const QString &);
};
/**
* \class ConnectionInterfaceAvatarsInterface
* \headerfile TelepathyQt/connection.h <TelepathyQt/Connection>
* \ingroup clientconn
*
* Proxy class providing a 1:1 mapping of the D-Bus interface "org.freedesktop.Telepathy.Connection.Interface.Avatars".
*/
class TP_QT_EXPORT ConnectionInterfaceAvatarsInterface : public Tp::AbstractInterface
{
Q_OBJECT
public:
/**
* Returns the name of the interface "org.freedesktop.Telepathy.Connection.Interface.Avatars", which this class
* represents.
*
* \return The D-Bus interface name.
*/
static inline QLatin1String staticInterfaceName()
{
return QLatin1String("org.freedesktop.Telepathy.Connection.Interface.Avatars");
}
/**
* Creates a ConnectionInterfaceAvatarsInterface associated with the given object on the session bus.
*
* \param busName Name of the service the object is on.
* \param objectPath Path to the object on the service.
* \param parent Passed to the parent class constructor.
*/
ConnectionInterfaceAvatarsInterface(
const QString& busName,
const QString& objectPath,
QObject* parent = 0
);
/**
* Creates a ConnectionInterfaceAvatarsInterface associated with the given object on the given bus.
*
* \param connection The bus via which the object can be reached.
* \param busName Name of the service the object is on.
* \param objectPath Path to the object on the service.
* \param parent Passed to the parent class constructor.
*/
ConnectionInterfaceAvatarsInterface(
const QDBusConnection& connection,
const QString& busName,
const QString& objectPath,
QObject* parent = 0
);
/**
* Creates a ConnectionInterfaceAvatarsInterface associated with the same object as the given proxy.
*
* \param proxy The proxy to use. It will also be the QObject::parent()
* for this object.
*/
ConnectionInterfaceAvatarsInterface(Tp::DBusProxy *proxy);
/**
* Creates a ConnectionInterfaceAvatarsInterface associated with the same object as the given proxy.
* Additionally, the created proxy will have the same parent as the given
* proxy.
*
* \param mainInterface The proxy to use.
*/
explicit ConnectionInterfaceAvatarsInterface(const Tp::Client::ConnectionInterface& mainInterface);
/**
* Creates a ConnectionInterfaceAvatarsInterface associated with the same object as the given proxy.
* However, a different parent object can be specified.
*
* \param mainInterface The proxy to use.
* \param parent Passed to the parent class constructor.
*/
ConnectionInterfaceAvatarsInterface(const Tp::Client::ConnectionInterface& mainInterface, QObject* parent);
/**
* Asynchronous getter for the remote object property \c SupportedAvatarMIMETypes of type \c QStringList.
*
*
* An array of supported MIME types (e.g. "image/jpeg"). Clients
* MAY assume that the first type in this array is preferred. This
* property cannot change after the Connection goes to the Connected state.
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertySupportedAvatarMIMETypes() const
{
return internalRequestProperty(QLatin1String("SupportedAvatarMIMETypes"));
}
/**
* Asynchronous getter for the remote object property \c MinimumAvatarHeight of type \c uint.
*
*
* The minimum height in pixels of an avatar on this protocol, which MAY
* be 0. This property cannot change after the Connection goes to the
* Connected state.
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyMinimumAvatarHeight() const
{
return internalRequestProperty(QLatin1String("MinimumAvatarHeight"));
}
/**
* Asynchronous getter for the remote object property \c MinimumAvatarWidth of type \c uint.
*
*
* The minimum width in pixels of an avatar on this protocol, which MAY be
* 0. This property cannot change after the Connection goes to the
* Connected state.
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyMinimumAvatarWidth() const
{
return internalRequestProperty(QLatin1String("MinimumAvatarWidth"));
}
/**
* Asynchronous getter for the remote object property \c RecommendedAvatarHeight of type \c uint.
*
*
* The recommended height in pixels of an avatar on this protocol, or 0 if
* there is no preferred height. This property cannot change after the
* Connection goes to the Connected state. In XMPP a recommended width is
* given by the protocol specification; in proprietary protocols, using
* the same avatar size as the proprietary client is likely to lead to the
* best display to other users.
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyRecommendedAvatarHeight() const
{
return internalRequestProperty(QLatin1String("RecommendedAvatarHeight"));
}
/**
* Asynchronous getter for the remote object property \c RecommendedAvatarWidth of type \c uint.
*
*
* The recommended width in pixels of an avatar on this protocol, or 0 if
* there is no preferred width. This property cannot change after the
* Connection goes to the Connected state. The rationale is the same as
* for RecommendedAvatarHeight.
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyRecommendedAvatarWidth() const
{
return internalRequestProperty(QLatin1String("RecommendedAvatarWidth"));
}
/**
* Asynchronous getter for the remote object property \c MaximumAvatarHeight of type \c uint.
*
*
* The maximum height in pixels of an avatar on this protocol, or 0 if
* there is no limit. This property cannot change after the Connection
* goes to the Connected state.
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyMaximumAvatarHeight() const
{
return internalRequestProperty(QLatin1String("MaximumAvatarHeight"));
}
/**
* Asynchronous getter for the remote object property \c MaximumAvatarWidth of type \c uint.
*
*
* The maximum width in pixels of an avatar on this protocol, or 0 if
* there is no limit. This property cannot change after the Connection
* goes to the Connected state.
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyMaximumAvatarWidth() const
{
return internalRequestProperty(QLatin1String("MaximumAvatarWidth"));
}
/**
* Asynchronous getter for the remote object property \c MaximumAvatarBytes of type \c uint.
*
*
* The maximum size in bytes of an avatar on this protocol, or 0 if there
* is no limit. This property cannot change after the Connection goes to
* the Connected state.
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyMaximumAvatarBytes() const
{
return internalRequestProperty(QLatin1String("MaximumAvatarBytes"));
}
/**
* Request all of the DBus properties on the interface.
*
* \return A pending variant map which will emit finished when the properties have
* been retrieved.
*/
Tp::PendingVariantMap *requestAllProperties() const
{
return internalRequestAllProperties();
}
public Q_SLOTS:
/**
* Begins a call to the D-Bus method \c GetAvatarRequirements on the remote object.
*
* Get the required format of avatars on this connection.
*
* Note that \a timeout is ignored as of now. It will be used once
* http://bugreports.qt.nokia.com/browse/QTBUG-11775 is fixed.
*
* \param timeout The timeout in milliseconds.
*
* \return
*
* An array of supported MIME types (eg image/jpeg)
*
* \return
*
* The minimum image width in pixels
*
* \return
*
* The minimum image height in pixels
*
* \return
*
* The maximum image width in pixels, or 0 if there is no limit
*
* \return
*
* The maximum image height in pixels, or 0 if there is no limit
*
* \return
*
* The maximum image size in bytes, or 0 if there is no limit
*/
inline QDBusPendingReply<QStringList, ushort, ushort, ushort, ushort, uint> GetAvatarRequirements(int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<QStringList, ushort, ushort, ushort, ushort, uint>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("GetAvatarRequirements"));
return this->connection().asyncCall(callMessage, timeout);
}
/**
* Begins a call to the D-Bus method \c GetAvatarTokens on the remote object.
*
* Get the unique tokens for all of the given contacts' avatars.
* Using this method in new Telepathy clients is deprecated; use
* GetKnownAvatarTokens instead.
*
* Note that \a timeout is ignored as of now. It will be used once
* http://bugreports.qt.nokia.com/browse/QTBUG-11775 is fixed.
*
*
* \param contacts
*
* An array of handles representing contacts
* \param timeout The timeout in milliseconds.
*
* \return
*
* An array of avatar tokens or empty strings (if no avatar is set) in
* the same order as the given array of contact handles
*/
inline QDBusPendingReply<QStringList> GetAvatarTokens(const Tp::UIntList& contacts, int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<QStringList>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("GetAvatarTokens"));
callMessage << QVariant::fromValue(contacts);
return this->connection().asyncCall(callMessage, timeout);
}
/**
* Begins a call to the D-Bus method \c GetKnownAvatarTokens on the remote object.
*
* Get the unique tokens for the given contacts' avatars. These
* tokens can be persisted across connections, and should be used by the
* client to check whether the avatars have been updated. For handles
* other than the self handle, only tokens that are already known are
* returned; an empty token means the given contact has no avatar.
* However, a CM must always have the tokens for the self handle if one is
* set (even if it is set to no avatar). On protocols where the avatar
* does not persist between connections, a CM should omit the self handle
* from the returned map until an avatar is explicitly set or cleared.
*
* Note that \a timeout is ignored as of now. It will be used once
* http://bugreports.qt.nokia.com/browse/QTBUG-11775 is fixed.
*
*
* \param contacts
*
* An array of handles representing contacts
* \param timeout The timeout in milliseconds.
*
* \return
*
* A dictionary of handles mapped to avatar tokens, containing only
* the known avatar tokens.
*/
inline QDBusPendingReply<Tp::AvatarTokenMap> GetKnownAvatarTokens(const Tp::UIntList& contacts, int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<Tp::AvatarTokenMap>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("GetKnownAvatarTokens"));
callMessage << QVariant::fromValue(contacts);
return this->connection().asyncCall(callMessage, timeout);
}
/**
* Begins a call to the D-Bus method \c RequestAvatar on the remote object.
*
* Request the avatar for a given contact. Using this method in new
* Telepathy clients is deprecated; use RequestAvatars instead.
*
* Note that \a timeout is ignored as of now. It will be used once
* http://bugreports.qt.nokia.com/browse/QTBUG-11775 is fixed.
*
*
* \param contact
*
* An integer handle for the contact to request the avatar for
* \param timeout The timeout in milliseconds.
*
* \return
*
* An array of bytes containing the image data
*
* \return
*
* A string containing the image MIME type (eg image/jpeg), or empty
* if unknown
*/
inline QDBusPendingReply<QByteArray, QString> RequestAvatar(uint contact, int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<QByteArray, QString>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("RequestAvatar"));
callMessage << QVariant::fromValue(contact);
return this->connection().asyncCall(callMessage, timeout);
}
/**
* Begins a call to the D-Bus method \c RequestAvatars on the remote object.
*
* Request avatars for a number of contacts. The AvatarRetrieved signal is
* emitted for each avatar retrieved. If the handles are valid but
* retrieving an avatar fails (for any reason, including the contact not
* having an avatar) the AvatarRetrieved signal is not emitted for that
* contact.
*
* Note that \a timeout is ignored as of now. It will be used once
* http://bugreports.qt.nokia.com/browse/QTBUG-11775 is fixed.
*
*
* \param contacts
*
* The contacts to retrieve avatars for
* \param timeout The timeout in milliseconds.
*/
inline QDBusPendingReply<> RequestAvatars(const Tp::UIntList& contacts, int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("RequestAvatars"));
callMessage << QVariant::fromValue(contacts);
return this->connection().asyncCall(callMessage, timeout);
}
/**
* Begins a call to the D-Bus method \c SetAvatar on the remote object.
*
* Set a new avatar image for this connection. The avatar image must
* respect the requirements obtained by GetAvatarRequirements.
*
* Note that \a timeout is ignored as of now. It will be used once
* http://bugreports.qt.nokia.com/browse/QTBUG-11775 is fixed.
*
*
* \param avatar
*
* An array of bytes representing the avatar image data
*
* \param MIMEType
*
* A string representing the image MIME type
* \param timeout The timeout in milliseconds.
*
* \return
*
* The string token of the new avatar
*/
inline QDBusPendingReply<QString> SetAvatar(const QByteArray& avatar, const QString& MIMEType, int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<QString>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("SetAvatar"));
callMessage << QVariant::fromValue(avatar) << QVariant::fromValue(MIMEType);
return this->connection().asyncCall(callMessage, timeout);
}
/**
* Begins a call to the D-Bus method \c ClearAvatar on the remote object.
*
* Remove the avatar image for this connection.
*
* Note that \a timeout is ignored as of now. It will be used once
* http://bugreports.qt.nokia.com/browse/QTBUG-11775 is fixed.
*
* \param timeout The timeout in milliseconds.
*/
inline QDBusPendingReply<> ClearAvatar(int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("ClearAvatar"));
return this->connection().asyncCall(callMessage, timeout);
}
Q_SIGNALS:
/**
* Represents the signal \c AvatarUpdated on the remote object.
*
* Emitted when the avatar for a contact has been updated, or first
* discovered on this connection. If the token differs from the token
* associated with the client's cached avatar for this contact, the
* new avatar should be requested with RequestAvatars.
*
* \param contact
*
* An integer handle for the contact whose avatar has changed
*
* \param newAvatarToken
*
* Unique token for their new avatar
*/
void AvatarUpdated(uint contact, const QString& newAvatarToken);
/**
* Represents the signal \c AvatarRetrieved on the remote object.
*
* Emitted when the avatar for a contact has been retrieved.
*
* \param contact
*
* The contact whose avatar has been retrieved
*
* \param token
*
* The token corresponding to the avatar
*
* \param avatar
*
* An array of bytes containing the image data
*
* \param type
*
* A string containing the image MIME type (eg image/jpeg), or empty
* if unknown
*/
void AvatarRetrieved(uint contact, const QString& token, const QByteArray& avatar, const QString& type);
protected:
virtual void invalidate(Tp::DBusProxy *, const QString &, const QString &);
};
/**
* \class ConnectionInterfaceBalanceInterface
* \headerfile TelepathyQt/connection.h <TelepathyQt/Connection>
* \ingroup clientconn
*
* Proxy class providing a 1:1 mapping of the D-Bus interface "org.freedesktop.Telepathy.Connection.Interface.Balance".
*/
class TP_QT_EXPORT ConnectionInterfaceBalanceInterface : public Tp::AbstractInterface
{
Q_OBJECT
public:
/**
* Returns the name of the interface "org.freedesktop.Telepathy.Connection.Interface.Balance", which this class
* represents.
*
* \return The D-Bus interface name.
*/
static inline QLatin1String staticInterfaceName()
{
return QLatin1String("org.freedesktop.Telepathy.Connection.Interface.Balance");
}
/**
* Creates a ConnectionInterfaceBalanceInterface associated with the given object on the session bus.
*
* \param busName Name of the service the object is on.
* \param objectPath Path to the object on the service.
* \param parent Passed to the parent class constructor.
*/
ConnectionInterfaceBalanceInterface(
const QString& busName,
const QString& objectPath,
QObject* parent = 0
);
/**
* Creates a ConnectionInterfaceBalanceInterface associated with the given object on the given bus.
*
* \param connection The bus via which the object can be reached.
* \param busName Name of the service the object is on.
* \param objectPath Path to the object on the service.
* \param parent Passed to the parent class constructor.
*/
ConnectionInterfaceBalanceInterface(
const QDBusConnection& connection,
const QString& busName,
const QString& objectPath,
QObject* parent = 0
);
/**
* Creates a ConnectionInterfaceBalanceInterface associated with the same object as the given proxy.
*
* \param proxy The proxy to use. It will also be the QObject::parent()
* for this object.
*/
ConnectionInterfaceBalanceInterface(Tp::DBusProxy *proxy);
/**
* Creates a ConnectionInterfaceBalanceInterface associated with the same object as the given proxy.
* Additionally, the created proxy will have the same parent as the given
* proxy.
*
* \param mainInterface The proxy to use.
*/
explicit ConnectionInterfaceBalanceInterface(const Tp::Client::ConnectionInterface& mainInterface);
/**
* Creates a ConnectionInterfaceBalanceInterface associated with the same object as the given proxy.
* However, a different parent object can be specified.
*
* \param mainInterface The proxy to use.
* \param parent Passed to the parent class constructor.
*/
ConnectionInterfaceBalanceInterface(const Tp::Client::ConnectionInterface& mainInterface, QObject* parent);
/**
* Asynchronous getter for the remote object property \c AccountBalance of type \c Tp::CurrencyAmount.
*
*
* \htmlonly
* <p>The user's balance on the account corresponding to this \endhtmlonly ConnectionInterface \htmlonly .
* A negative amount may be possible on some services, and indicates
* that the user owes money to the service provider.</p>
*
* <p>On initial connection, this property may have an unknown
* value, represented by <var>Amount</var> = <tt>0</tt>,
* <var>Scale</var> = <tt>2**32 - 1</tt> (the largest possible 32-bit
* unsigned integer) and <var>Currency</var> = <tt>""</tt>.</p>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyAccountBalance() const
{
return internalRequestProperty(QLatin1String("AccountBalance"));
}
/**
* Asynchronous getter for the remote object property \c ManageCreditURI of type \c QString.
*
*
* A URI the user may visit via the web browser to manage and top-up their
* account balance. This property is not guaranteed to be well-defined
* until the connection becomes Connected; there is no change
* notification. Different protocols and even servers or gateways (e.g.
* SIP and XMPP PSTN gateways) will have a different website used to
* manage a user's account balance. This property enables the client
* to provide that to the user. A Connection Manager MAY set this itself
* (because it is static or discoverable), or expose it as a connection
* parameter.
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyManageCreditURI() const
{
return internalRequestProperty(QLatin1String("ManageCreditURI"));
}
/**
* Request all of the DBus properties on the interface.
*
* \return A pending variant map which will emit finished when the properties have
* been retrieved.
*/
Tp::PendingVariantMap *requestAllProperties() const
{
return internalRequestAllProperties();
}
Q_SIGNALS:
/**
* Represents the signal \c BalanceChanged on the remote object.
*
* \htmlonly
* <p>Emitted when the user's balance has changed.</p>
* \endhtmlonly
*
* \param balance
*
* \htmlonly
* <p>The new value of the \endhtmlonly \link requestPropertyAccountBalance() AccountBalance \endlink \htmlonly
* property.</p>
* \endhtmlonly
*/
void BalanceChanged(const Tp::CurrencyAmount& balance);
protected:
virtual void invalidate(Tp::DBusProxy *, const QString &, const QString &);
};
/**
* \class ConnectionInterfaceCapabilitiesInterface
* \headerfile TelepathyQt/connection.h <TelepathyQt/Connection>
* \ingroup clientconn
*
* Proxy class providing a 1:1 mapping of the D-Bus interface "org.freedesktop.Telepathy.Connection.Interface.Capabilities".
*/
class TP_QT_EXPORT ConnectionInterfaceCapabilitiesInterface : public Tp::AbstractInterface
{
Q_OBJECT
public:
/**
* Returns the name of the interface "org.freedesktop.Telepathy.Connection.Interface.Capabilities", which this class
* represents.
*
* \return The D-Bus interface name.
*/
static inline QLatin1String staticInterfaceName()
{
return QLatin1String("org.freedesktop.Telepathy.Connection.Interface.Capabilities");
}
/**
* Creates a ConnectionInterfaceCapabilitiesInterface associated with the given object on the session bus.
*
* \param busName Name of the service the object is on.
* \param objectPath Path to the object on the service.
* \param parent Passed to the parent class constructor.
*/
ConnectionInterfaceCapabilitiesInterface(
const QString& busName,
const QString& objectPath,
QObject* parent = 0
);
/**
* Creates a ConnectionInterfaceCapabilitiesInterface associated with the given object on the given bus.
*
* \param connection The bus via which the object can be reached.
* \param busName Name of the service the object is on.
* \param objectPath Path to the object on the service.
* \param parent Passed to the parent class constructor.
*/
ConnectionInterfaceCapabilitiesInterface(
const QDBusConnection& connection,
const QString& busName,
const QString& objectPath,
QObject* parent = 0
);
/**
* Creates a ConnectionInterfaceCapabilitiesInterface associated with the same object as the given proxy.
*
* \param proxy The proxy to use. It will also be the QObject::parent()
* for this object.
*/
ConnectionInterfaceCapabilitiesInterface(Tp::DBusProxy *proxy);
/**
* Creates a ConnectionInterfaceCapabilitiesInterface associated with the same object as the given proxy.
* Additionally, the created proxy will have the same parent as the given
* proxy.
*
* \param mainInterface The proxy to use.
*/
explicit ConnectionInterfaceCapabilitiesInterface(const Tp::Client::ConnectionInterface& mainInterface);
/**
* Creates a ConnectionInterfaceCapabilitiesInterface associated with the same object as the given proxy.
* However, a different parent object can be specified.
*
* \param mainInterface The proxy to use.
* \param parent Passed to the parent class constructor.
*/
ConnectionInterfaceCapabilitiesInterface(const Tp::Client::ConnectionInterface& mainInterface, QObject* parent);
/**
* Request all of the DBus properties on the interface.
*
* \return A pending variant map which will emit finished when the properties have
* been retrieved.
*/
Tp::PendingVariantMap *requestAllProperties() const
{
return internalRequestAllProperties();
}
public Q_SLOTS:
/**
* Begins a call to the D-Bus method \c AdvertiseCapabilities on the remote object.
*
* \htmlonly
* <p>Used by user interfaces to indicate which channel types they are able
* to handle on this connection. Because these may be provided by
* different client processes, this method accepts channel types to add
* and remove from the set already advertised on this connection. The type
* of advertised capabilities (create versus invite) is protocol-dependent
* and hence cannot be set by the this method. In the case of a client
* adding an already advertised channel type but with new channel type
* specific flags, the connection manager should simply add the new flags
* to the set of advertised capabilities.</p>
*
* <p>Upon a successful invocation of this method, the
* \endhtmlonly CapabilitiesChanged() \htmlonly
* signal will be emitted for the user's own handle ( \endhtmlonly ConnectionInterface::GetSelfHandle() \htmlonly )
* by the connection manager to indicate the changes
* that have been made. This signal should also be monitored to ensure
* that the set is kept accurate - for example, a client may remove
* capabilities or type specific capability flags when it exits
* which are still provided by another client.</p>
*
* <p>On connections managed by the \endhtmlonly ChannelDispatcherInterface \htmlonly ,
* this method SHOULD NOT be used by clients other than the
* ChannelDispatcher itself.</p>
* \endhtmlonly
*
* Note that \a timeout is ignored as of now. It will be used once
* http://bugreports.qt.nokia.com/browse/QTBUG-11775 is fixed.
*
*
* \param add
*
* \htmlonly
* An array of structures containing:
* <ul>
* <li>a string channel type</li>
* <li>a bitwise OR of type specific capability flags</li>
* </ul>
* \endhtmlonly
*
* \param remove
*
* An array of D-Bus interface names of channel types to remove
* \param timeout The timeout in milliseconds.
*
* \return
*
* An array of structures describing the current capabilities
* containing: a string channel type a bitwise OR of type specific
* capability flags
*/
inline QDBusPendingReply<Tp::CapabilityPairList> AdvertiseCapabilities(const Tp::CapabilityPairList& add, const QStringList& remove, int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<Tp::CapabilityPairList>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("AdvertiseCapabilities"));
callMessage << QVariant::fromValue(add) << QVariant::fromValue(remove);
return this->connection().asyncCall(callMessage, timeout);
}
/**
* Begins a call to the D-Bus method \c GetCapabilities on the remote object.
*
* Returns an array of capabilities for the given contact handles.
*
* Note that \a timeout is ignored as of now. It will be used once
* http://bugreports.qt.nokia.com/browse/QTBUG-11775 is fixed.
*
*
* \param handles
*
* \htmlonly
* <p>An array of contact handles for this connection.</p>
*
* <p>This may include zero, which originally meant a query for
* capabilities available on the connection itself. This usage
* is deprecated; clients SHOULD NOT do this, and connection managers
* SHOULD proceed as though zero had not been present in this
* list.</p>
* \endhtmlonly
* \param timeout The timeout in milliseconds.
*
* \return
*
* \htmlonly
* An array of structures containing:
* <ul>
* <li>an integer handle representing the contact</li>
* <li>a string channel type</li>
* <li>a bitwise OR of generic capability flags for the type</li>
* <li>a bitwise OR of type specific capability flags for the type</li>
* </ul>
* \endhtmlonly
*/
inline QDBusPendingReply<Tp::ContactCapabilityList> GetCapabilities(const Tp::UIntList& handles, int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<Tp::ContactCapabilityList>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("GetCapabilities"));
callMessage << QVariant::fromValue(handles);
return this->connection().asyncCall(callMessage, timeout);
}
Q_SIGNALS:
/**
* Represents the signal \c CapabilitiesChanged on the remote object.
*
* \htmlonly
* <p>Announce that there has been a change of capabilities on the
* given handle.</p>
*
* <p>If the handle is zero, the capabilities refer to the connection
* itself, in some poorly defined way. This usage is deprecated and
* clients should ignore it.</p>
* \endhtmlonly
*
* \param caps
*
* \htmlonly
* An array of structures containing:
* <ul>
* <li>an integer handle representing the contact</li>
* <li>a string channel type</li>
* <li>a bitwise OR of the contact's old generic capability flags</li>
* <li>a bitwise OR of the contact's new generic capability flags</li>
* <li>a bitwise OR of the contact's old type specific capability flags</li>
* <li>a bitwise OR of the contact's new type specific capability flags</li>
* </ul>
* \endhtmlonly
*/
void CapabilitiesChanged(const Tp::CapabilityChangeList& caps);
protected:
virtual void invalidate(Tp::DBusProxy *, const QString &, const QString &);
};
/**
* \class ConnectionInterfaceCellularInterface
* \headerfile TelepathyQt/connection.h <TelepathyQt/Connection>
* \ingroup clientconn
*
* Proxy class providing a 1:1 mapping of the D-Bus interface "org.freedesktop.Telepathy.Connection.Interface.Cellular".
*/
class TP_QT_EXPORT ConnectionInterfaceCellularInterface : public Tp::AbstractInterface
{
Q_OBJECT
public:
/**
* Returns the name of the interface "org.freedesktop.Telepathy.Connection.Interface.Cellular", which this class
* represents.
*
* \return The D-Bus interface name.
*/
static inline QLatin1String staticInterfaceName()
{
return QLatin1String("org.freedesktop.Telepathy.Connection.Interface.Cellular");
}
/**
* Creates a ConnectionInterfaceCellularInterface associated with the given object on the session bus.
*
* \param busName Name of the service the object is on.
* \param objectPath Path to the object on the service.
* \param parent Passed to the parent class constructor.
*/
ConnectionInterfaceCellularInterface(
const QString& busName,
const QString& objectPath,
QObject* parent = 0
);
/**
* Creates a ConnectionInterfaceCellularInterface associated with the given object on the given bus.
*
* \param connection The bus via which the object can be reached.
* \param busName Name of the service the object is on.
* \param objectPath Path to the object on the service.
* \param parent Passed to the parent class constructor.
*/
ConnectionInterfaceCellularInterface(
const QDBusConnection& connection,
const QString& busName,
const QString& objectPath,
QObject* parent = 0
);
/**
* Creates a ConnectionInterfaceCellularInterface associated with the same object as the given proxy.
*
* \param proxy The proxy to use. It will also be the QObject::parent()
* for this object.
*/
ConnectionInterfaceCellularInterface(Tp::DBusProxy *proxy);
/**
* Creates a ConnectionInterfaceCellularInterface associated with the same object as the given proxy.
* Additionally, the created proxy will have the same parent as the given
* proxy.
*
* \param mainInterface The proxy to use.
*/
explicit ConnectionInterfaceCellularInterface(const Tp::Client::ConnectionInterface& mainInterface);
/**
* Creates a ConnectionInterfaceCellularInterface associated with the same object as the given proxy.
* However, a different parent object can be specified.
*
* \param mainInterface The proxy to use.
* \param parent Passed to the parent class constructor.
*/
ConnectionInterfaceCellularInterface(const Tp::Client::ConnectionInterface& mainInterface, QObject* parent);
/**
* Asynchronous getter for the remote object property \c MessageValidityPeriod of type \c uint.
*
*
* \htmlonly
* <p>Define how long should the service centre try message delivery before
* giving up, failing delivery and deleting the message. A value of 0
* means to use the service centre's default period.</p>
*
* <p>The value specified is in seconds. Note that various protocols or
* implementations may round the value up (eg. to a minute or hour
* precision). The maximum validity period may vary depending on
* protocol or provider.</p>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyMessageValidityPeriod() const
{
return internalRequestProperty(QLatin1String("MessageValidityPeriod"));
}
/**
* Asynchronous setter for the remote object property \c MessageValidityPeriod of type \c uint.
*
*
* \htmlonly
* <p>Define how long should the service centre try message delivery before
* giving up, failing delivery and deleting the message. A value of 0
* means to use the service centre's default period.</p>
*
* <p>The value specified is in seconds. Note that various protocols or
* implementations may round the value up (eg. to a minute or hour
* precision). The maximum validity period may vary depending on
* protocol or provider.</p>
* \endhtmlonly
*
* \return A pending operation which will emit finished when the property has been
* set.
*/
inline Tp::PendingOperation *setPropertyMessageValidityPeriod(uint newValue)
{
return internalSetProperty(QLatin1String("MessageValidityPeriod"), QVariant::fromValue(newValue));
}
/**
* Asynchronous getter for the remote object property \c OverrideMessageServiceCentre of type \c bool.
*
*
* \htmlonly
* <p>If <code>True</code>, SMSes will be sent via the service centre
* specified by \endhtmlonly \link requestPropertyMessageServiceCentre() MessageServiceCentre \endlink \htmlonly . If
* <code>False</code>, the SIM's default SMSC will be used, ignoring the
* value of MessageServiceCentre.</p>
*
* <div class="rationale">
* <p>It could be desirable for a configuration interface to remember
* the user's previous choice of custom SMSC, even if it's not in use.
* This boolean allows that choice to be saved as an account parameter
* by Mission Control, rather than the UI needing to save it elsewhere
* to be restored if the user wants to reactivate it.</p>
* </div>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyOverrideMessageServiceCentre() const
{
return internalRequestProperty(QLatin1String("OverrideMessageServiceCentre"));
}
/**
* Asynchronous setter for the remote object property \c OverrideMessageServiceCentre of type \c bool.
*
*
* \htmlonly
* <p>If <code>True</code>, SMSes will be sent via the service centre
* specified by \endhtmlonly \link requestPropertyMessageServiceCentre() MessageServiceCentre \endlink \htmlonly . If
* <code>False</code>, the SIM's default SMSC will be used, ignoring the
* value of MessageServiceCentre.</p>
*
* <div class="rationale">
* <p>It could be desirable for a configuration interface to remember
* the user's previous choice of custom SMSC, even if it's not in use.
* This boolean allows that choice to be saved as an account parameter
* by Mission Control, rather than the UI needing to save it elsewhere
* to be restored if the user wants to reactivate it.</p>
* </div>
* \endhtmlonly
*
* \return A pending operation which will emit finished when the property has been
* set.
*/
inline Tp::PendingOperation *setPropertyOverrideMessageServiceCentre(bool newValue)
{
return internalSetProperty(QLatin1String("OverrideMessageServiceCentre"), QVariant::fromValue(newValue));
}
/**
* Asynchronous getter for the remote object property \c MessageServiceCentre of type \c QString.
*
*
* \htmlonly
* <p>Address for the messaging service centre. Typically (as is the case
* for GSM's SMSC), it's the ISDN / telephony address (ie. a phone
* number). If
* \endhtmlonly \link requestPropertyOverrideMessageServiceCentre() OverrideMessageServiceCentre \endlink \htmlonly is
* <code>False</code>, this property's value should be ignored by the CM
* in favour of the SIM's default SMSC.</p>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyMessageServiceCentre() const
{
return internalRequestProperty(QLatin1String("MessageServiceCentre"));
}
/**
* Asynchronous setter for the remote object property \c MessageServiceCentre of type \c QString.
*
*
* \htmlonly
* <p>Address for the messaging service centre. Typically (as is the case
* for GSM's SMSC), it's the ISDN / telephony address (ie. a phone
* number). If
* \endhtmlonly \link requestPropertyOverrideMessageServiceCentre() OverrideMessageServiceCentre \endlink \htmlonly is
* <code>False</code>, this property's value should be ignored by the CM
* in favour of the SIM's default SMSC.</p>
* \endhtmlonly
*
* \return A pending operation which will emit finished when the property has been
* set.
*/
inline Tp::PendingOperation *setPropertyMessageServiceCentre(QString newValue)
{
return internalSetProperty(QLatin1String("MessageServiceCentre"), QVariant::fromValue(newValue));
}
/**
* Asynchronous getter for the remote object property \c IMSI of type \c QString.
*
*
* \htmlonly
* <p>The International Mobile Subscriber Identifier, if it exists. This
* would originate from a SIM card. If the IMSI is unknown, this will
* contain an empty string ("").</p>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyIMSI() const
{
return internalRequestProperty(QLatin1String("IMSI"));
}
/**
* Asynchronous getter for the remote object property \c MessageReducedCharacterSet of type \c bool.
*
*
* \htmlonly
* <p>Determines how to encode SMSes containing characters that do not
* fit into a non-Unicode character set.
* If <code>False</code> (which SHOULD be the default), messages will
* be encoded as UCS-2 and sent with no loss of fidelity (at the
* potential financial cost of using twice as many SMSes); if
* <code>True</code>, the message will be recoded in an
* implementation‐specific way to fit into a GSM reduced character
* set.</p>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyMessageReducedCharacterSet() const
{
return internalRequestProperty(QLatin1String("MessageReducedCharacterSet"));
}
/**
* Asynchronous setter for the remote object property \c MessageReducedCharacterSet of type \c bool.
*
*
* \htmlonly
* <p>Determines how to encode SMSes containing characters that do not
* fit into a non-Unicode character set.
* If <code>False</code> (which SHOULD be the default), messages will
* be encoded as UCS-2 and sent with no loss of fidelity (at the
* potential financial cost of using twice as many SMSes); if
* <code>True</code>, the message will be recoded in an
* implementation‐specific way to fit into a GSM reduced character
* set.</p>
* \endhtmlonly
*
* \return A pending operation which will emit finished when the property has been
* set.
*/
inline Tp::PendingOperation *setPropertyMessageReducedCharacterSet(bool newValue)
{
return internalSetProperty(QLatin1String("MessageReducedCharacterSet"), QVariant::fromValue(newValue));
}
/**
* Asynchronous getter for the remote object property \c MessageNationalCharacterSet of type \c QString.
*
*
* \htmlonly
* <p>Hint for the connection manager for the GSM character set that
* should be used to send SMSes. The connection manager SHOULD follow
* this hint unless it has other ways to determine a better encoding.
* If the value is <code>"gsm"</code> (which SHOULD be the default),
* SMSes will be encoded in the normal 7-bit GSM character set,
* eventually falling back to UCS-2; see the
* \endhtmlonly \link requestPropertyMessageReducedCharacterSet() MessageReducedCharacterSet \endlink \htmlonly property
* for details.
* Other valid character sets are specified in the
* <a href="http://www.3gpp.org/ftp/specs/archive/23_series/23.038/">GSM standard</a> and are, for instance, <code>"turkey"</code>,
* <code>"spain"</code> or <code>"portugal"</code>.
* If the SMS cannot be encoded using the requested character set the
* behaviour is implementation-specific, but it is RECOMMENDED that
* the connection manager should behave as if this property was set
* to <code>"gsm"</code>.</p>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyMessageNationalCharacterSet() const
{
return internalRequestProperty(QLatin1String("MessageNationalCharacterSet"));
}
/**
* Asynchronous setter for the remote object property \c MessageNationalCharacterSet of type \c QString.
*
*
* \htmlonly
* <p>Hint for the connection manager for the GSM character set that
* should be used to send SMSes. The connection manager SHOULD follow
* this hint unless it has other ways to determine a better encoding.
* If the value is <code>"gsm"</code> (which SHOULD be the default),
* SMSes will be encoded in the normal 7-bit GSM character set,
* eventually falling back to UCS-2; see the
* \endhtmlonly \link requestPropertyMessageReducedCharacterSet() MessageReducedCharacterSet \endlink \htmlonly property
* for details.
* Other valid character sets are specified in the
* <a href="http://www.3gpp.org/ftp/specs/archive/23_series/23.038/">GSM standard</a> and are, for instance, <code>"turkey"</code>,
* <code>"spain"</code> or <code>"portugal"</code>.
* If the SMS cannot be encoded using the requested character set the
* behaviour is implementation-specific, but it is RECOMMENDED that
* the connection manager should behave as if this property was set
* to <code>"gsm"</code>.</p>
* \endhtmlonly
*
* \return A pending operation which will emit finished when the property has been
* set.
*/
inline Tp::PendingOperation *setPropertyMessageNationalCharacterSet(QString newValue)
{
return internalSetProperty(QLatin1String("MessageNationalCharacterSet"), QVariant::fromValue(newValue));
}
/**
* Request all of the DBus properties on the interface.
*
* \return A pending variant map which will emit finished when the properties have
* been retrieved.
*/
Tp::PendingVariantMap *requestAllProperties() const
{
return internalRequestAllProperties();
}
Q_SIGNALS:
/**
* Represents the signal \c IMSIChanged on the remote object.
*
* Emitted when the IMSI for the connection changes. This sort of thing is
* rare, but could happen on cellular phones that allow hot-swapping of
* SIM cards. In the case of SIM swapping, this signal would be emitted
* twice; the first time while the SIM is being ejected (with an empty
* string), and the second time after a new SIM has been inserted
* (assuming that the IMSI can be determined from the new SIM).
*
* \param IMSI
*
* The new IMSI value. This may be an empty string in the case where
* the IMSI is being reset or removed.
*/
void IMSIChanged(const QString& IMSI);
protected:
virtual void invalidate(Tp::DBusProxy *, const QString &, const QString &);
};
/**
* \class ConnectionInterfaceClientTypesInterface
* \headerfile TelepathyQt/connection.h <TelepathyQt/Connection>
* \ingroup clientconn
*
* Proxy class providing a 1:1 mapping of the D-Bus interface "org.freedesktop.Telepathy.Connection.Interface.ClientTypes".
*/
class TP_QT_EXPORT ConnectionInterfaceClientTypesInterface : public Tp::AbstractInterface
{
Q_OBJECT
public:
/**
* Returns the name of the interface "org.freedesktop.Telepathy.Connection.Interface.ClientTypes", which this class
* represents.
*
* \return The D-Bus interface name.
*/
static inline QLatin1String staticInterfaceName()
{
return QLatin1String("org.freedesktop.Telepathy.Connection.Interface.ClientTypes");
}
/**
* Creates a ConnectionInterfaceClientTypesInterface associated with the given object on the session bus.
*
* \param busName Name of the service the object is on.
* \param objectPath Path to the object on the service.
* \param parent Passed to the parent class constructor.
*/
ConnectionInterfaceClientTypesInterface(
const QString& busName,
const QString& objectPath,
QObject* parent = 0
);
/**
* Creates a ConnectionInterfaceClientTypesInterface associated with the given object on the given bus.
*
* \param connection The bus via which the object can be reached.
* \param busName Name of the service the object is on.
* \param objectPath Path to the object on the service.
* \param parent Passed to the parent class constructor.
*/
ConnectionInterfaceClientTypesInterface(
const QDBusConnection& connection,
const QString& busName,
const QString& objectPath,
QObject* parent = 0
);
/**
* Creates a ConnectionInterfaceClientTypesInterface associated with the same object as the given proxy.
*
* \param proxy The proxy to use. It will also be the QObject::parent()
* for this object.
*/
ConnectionInterfaceClientTypesInterface(Tp::DBusProxy *proxy);
/**
* Creates a ConnectionInterfaceClientTypesInterface associated with the same object as the given proxy.
* Additionally, the created proxy will have the same parent as the given
* proxy.
*
* \param mainInterface The proxy to use.
*/
explicit ConnectionInterfaceClientTypesInterface(const Tp::Client::ConnectionInterface& mainInterface);
/**
* Creates a ConnectionInterfaceClientTypesInterface associated with the same object as the given proxy.
* However, a different parent object can be specified.
*
* \param mainInterface The proxy to use.
* \param parent Passed to the parent class constructor.
*/
ConnectionInterfaceClientTypesInterface(const Tp::Client::ConnectionInterface& mainInterface, QObject* parent);
/**
* Request all of the DBus properties on the interface.
*
* \return A pending variant map which will emit finished when the properties have
* been retrieved.
*/
Tp::PendingVariantMap *requestAllProperties() const
{
return internalRequestAllProperties();
}
public Q_SLOTS:
/**
* Begins a call to the D-Bus method \c GetClientTypes on the remote object.
*
* Return the client types of the given contacts, if they are already
* known. If any of the given contacts' client types are not known,
* request their current client types, but return immediately without
* waiting for a reply; if a reply with a non-empty client type array is
* later received for those contacts, the ClientTypesUpdated signal will
* be emitted for them. This method is appropriate for "lazy"
* client type finding, for instance displaying the client types (if
* available) of everyone in your contact list.
*
* Note that \a timeout is ignored as of now. It will be used once
* http://bugreports.qt.nokia.com/browse/QTBUG-11775 is fixed.
*
*
* \param contacts
*
* The contacts whose client types should be returned or signalled.
* \param timeout The timeout in milliseconds.
*
* \return
*
* The contacts' client types, if already known. Contacts whose
* client types are not already known are omitted from the mapping;
* contacts known to have no client type information appear in the
* mapping with an empty list.
*/
inline QDBusPendingReply<Tp::ContactClientTypes> GetClientTypes(const Tp::UIntList& contacts, int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<Tp::ContactClientTypes>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("GetClientTypes"));
callMessage << QVariant::fromValue(contacts);
return this->connection().asyncCall(callMessage, timeout);
}
/**
* Begins a call to the D-Bus method \c RequestClientTypes on the remote object.
*
* Return the current client types of the given contact. If necessary,
* make a request to the server for up-to-date information, and wait for a
* reply. This method is appropriate for use in a "Contact
* Information..." dialog; it can be used to show progress
* information (while waiting for the method to return), and can
* distinguish between various error conditions.
*
* Note that \a timeout is ignored as of now. It will be used once
* http://bugreports.qt.nokia.com/browse/QTBUG-11775 is fixed.
*
*
* \param contact
*
* The contact whose client types should be returned.
* \param timeout The timeout in milliseconds.
*
* \return
*
* The contact's client types. It MAY be empty, indicating that
* no client type information was found.
*/
inline QDBusPendingReply<QStringList> RequestClientTypes(uint contact, int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<QStringList>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("RequestClientTypes"));
callMessage << QVariant::fromValue(contact);
return this->connection().asyncCall(callMessage, timeout);
}
Q_SIGNALS:
/**
* Represents the signal \c ClientTypesUpdated on the remote object.
*
* Emitted when a contact's client types change or become known.
*
* \param contact
*
* The contact.
*
* \param clientTypes
*
* The contact's client types, or an empty list to indicate that
* nothing is known about the contact's client types.
*/
void ClientTypesUpdated(uint contact, const QStringList& clientTypes);
protected:
virtual void invalidate(Tp::DBusProxy *, const QString &, const QString &);
};
/**
* \class ConnectionInterfaceContactBlockingInterface
* \headerfile TelepathyQt/connection.h <TelepathyQt/Connection>
* \ingroup clientconn
*
* Proxy class providing a 1:1 mapping of the D-Bus interface "org.freedesktop.Telepathy.Connection.Interface.ContactBlocking".
*/
class TP_QT_EXPORT ConnectionInterfaceContactBlockingInterface : public Tp::AbstractInterface
{
Q_OBJECT
public:
/**
* Returns the name of the interface "org.freedesktop.Telepathy.Connection.Interface.ContactBlocking", which this class
* represents.
*
* \return The D-Bus interface name.
*/
static inline QLatin1String staticInterfaceName()
{
return QLatin1String("org.freedesktop.Telepathy.Connection.Interface.ContactBlocking");
}
/**
* Creates a ConnectionInterfaceContactBlockingInterface associated with the given object on the session bus.
*
* \param busName Name of the service the object is on.
* \param objectPath Path to the object on the service.
* \param parent Passed to the parent class constructor.
*/
ConnectionInterfaceContactBlockingInterface(
const QString& busName,
const QString& objectPath,
QObject* parent = 0
);
/**
* Creates a ConnectionInterfaceContactBlockingInterface associated with the given object on the given bus.
*
* \param connection The bus via which the object can be reached.
* \param busName Name of the service the object is on.
* \param objectPath Path to the object on the service.
* \param parent Passed to the parent class constructor.
*/
ConnectionInterfaceContactBlockingInterface(
const QDBusConnection& connection,
const QString& busName,
const QString& objectPath,
QObject* parent = 0
);
/**
* Creates a ConnectionInterfaceContactBlockingInterface associated with the same object as the given proxy.
*
* \param proxy The proxy to use. It will also be the QObject::parent()
* for this object.
*/
ConnectionInterfaceContactBlockingInterface(Tp::DBusProxy *proxy);
/**
* Creates a ConnectionInterfaceContactBlockingInterface associated with the same object as the given proxy.
* Additionally, the created proxy will have the same parent as the given
* proxy.
*
* \param mainInterface The proxy to use.
*/
explicit ConnectionInterfaceContactBlockingInterface(const Tp::Client::ConnectionInterface& mainInterface);
/**
* Creates a ConnectionInterfaceContactBlockingInterface associated with the same object as the given proxy.
* However, a different parent object can be specified.
*
* \param mainInterface The proxy to use.
* \param parent Passed to the parent class constructor.
*/
ConnectionInterfaceContactBlockingInterface(const Tp::Client::ConnectionInterface& mainInterface, QObject* parent);
/**
* Asynchronous getter for the remote object property \c ContactBlockingCapabilities of type \c uint.
*
*
* \htmlonly
* <p>Additional capabilities for contact blocking; currently, this is
* limited to whether contacts may be reported as abusive.</p>
*
* <p>Note that there is no capability for supporting blocking itself:
* the presence of this interface on a \endhtmlonly ConnectionInterface \htmlonly indicates that blocking
* contacts is supported.</p>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyContactBlockingCapabilities() const
{
return internalRequestProperty(QLatin1String("ContactBlockingCapabilities"));
}
/**
* Request all of the DBus properties on the interface.
*
* \return A pending variant map which will emit finished when the properties have
* been retrieved.
*/
Tp::PendingVariantMap *requestAllProperties() const
{
return internalRequestAllProperties();
}
public Q_SLOTS:
/**
* Begins a call to the D-Bus method \c BlockContacts on the remote object.
*
* \htmlonly
* <p>Direct the server to block some contacts. The precise effect is
* protocol-dependent, but SHOULD include ignoring all current and
* subsequent communications from the given contacts, avoiding sending
* presence to them in future, and if they were already receiving the
* local user's presence, behaving as if the local user went
* offline.</p>
* \endhtmlonly
*
* Note that \a timeout is ignored as of now. It will be used once
* http://bugreports.qt.nokia.com/browse/QTBUG-11775 is fixed.
*
*
* \param contacts
*
* Some contacts to block. If some of the contacts in this list are
* already blocked, the connection manager MUST act as if they were
* not specified in this list.
*
* \param reportAbusive
*
* \htmlonly
* <p>In addition to blocking, report these contacts as abusive to the
* server administrators.</p>
*
* <p>Clients can determine whether this capability is available by
* checking the
* \endhtmlonly \link requestPropertyContactBlockingCapabilities() ContactBlockingCapabilities \endlink \htmlonly
* property. If this argument is set to <code>True</code> by a client
* despite \endhtmlonly \link requestPropertyContactBlockingCapabilities() ContactBlockingCapabilities \endlink \htmlonly
* not containing the <code>Can_Report_Abusive</code> flag, the
* connection manager SHOULD act as if it were <code>False</code> and
* simply block the supplied contacts.</p>
*
* <div class="rationale">
* <p>A correct user interface shouldn't get this far without knowing
* that reporting abusive contacts is not supported. If it does,
* then the user has expressed their intention to block these
* contacts. Returning an error would leave the UI with three
* options:</p>
*
* <ul>
* <li>Ignore the error, leaving the contacts not actually blocked;</li>
* <li>Display an error to the user;</li>
* <li>Call this method again, passing <code>False</code> for this
* argument.</li>
* </ul>
*
* <p>None of these seem preferable to the CM just ignoring this flag
* if it doesn't support it: that way, the contacts will be blocked,
* as the user requested, and UIs have fewer ways to mess up
* entirely.</p>
* </div>
* \endhtmlonly
* \param timeout The timeout in milliseconds.
*/
inline QDBusPendingReply<> BlockContacts(const Tp::UIntList& contacts, bool reportAbusive, int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("BlockContacts"));
callMessage << QVariant::fromValue(contacts) << QVariant::fromValue(reportAbusive);
return this->connection().asyncCall(callMessage, timeout);
}
/**
* Begins a call to the D-Bus method \c UnblockContacts on the remote object.
*
* \htmlonly
* <p>Direct the server to unblock some contacts.</p>
* \endhtmlonly
*
* Note that \a timeout is ignored as of now. It will be used once
* http://bugreports.qt.nokia.com/browse/QTBUG-11775 is fixed.
*
*
* \param contacts
*
* Some contacts to unblock. If some of the contacts in this list are
* not currently blocked, the connection manager MUST act as if they
* were not specified in this list.
* \param timeout The timeout in milliseconds.
*/
inline QDBusPendingReply<> UnblockContacts(const Tp::UIntList& contacts, int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("UnblockContacts"));
callMessage << QVariant::fromValue(contacts);
return this->connection().asyncCall(callMessage, timeout);
}
/**
* Begins a call to the D-Bus method \c RequestBlockedContacts on the remote object.
*
* \htmlonly
* <p>List the contacts that are blocked.</p>
*
* <p>Clients SHOULD allow a relatively long timeout for calls to this
* method, since on some protocols contact blocking is part of the
* contact list, which can take a significant time to retrieve.</p>
* \endhtmlonly
*
* Note that \a timeout is ignored as of now. It will be used once
* http://bugreports.qt.nokia.com/browse/QTBUG-11775 is fixed.
*
* \param timeout The timeout in milliseconds.
*
* \return
*
* The blocked contacts’ handles, together with their identifiers.
*/
inline QDBusPendingReply<Tp::HandleIdentifierMap> RequestBlockedContacts(int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<Tp::HandleIdentifierMap>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("RequestBlockedContacts"));
return this->connection().asyncCall(callMessage, timeout);
}
Q_SIGNALS:
/**
* Represents the signal \c BlockedContactsChanged on the remote object.
*
* \htmlonly
* <p>Emitted when the list of blocked contacts is first retrieved
* (before returning from any pending calls to
* \endhtmlonly RequestBlockedContacts() \htmlonly ), and
* whenever the list of blocked contacts subsequently changes.</p>
* \endhtmlonly
*
* \param blockedContacts
*
* Contacts added to the result of RequestBlockedContacts.
*
* \param unblockedContacts
*
* Contacts removed from the result of RequestBlockedContacts.
*/
void BlockedContactsChanged(const Tp::HandleIdentifierMap& blockedContacts, const Tp::HandleIdentifierMap& unblockedContacts);
protected:
virtual void invalidate(Tp::DBusProxy *, const QString &, const QString &);
};
/**
* \class ConnectionInterfaceContactCapabilitiesInterface
* \headerfile TelepathyQt/connection.h <TelepathyQt/Connection>
* \ingroup clientconn
*
* Proxy class providing a 1:1 mapping of the D-Bus interface "org.freedesktop.Telepathy.Connection.Interface.ContactCapabilities".
*/
class TP_QT_EXPORT ConnectionInterfaceContactCapabilitiesInterface : public Tp::AbstractInterface
{
Q_OBJECT
public:
/**
* Returns the name of the interface "org.freedesktop.Telepathy.Connection.Interface.ContactCapabilities", which this class
* represents.
*
* \return The D-Bus interface name.
*/
static inline QLatin1String staticInterfaceName()
{
return QLatin1String("org.freedesktop.Telepathy.Connection.Interface.ContactCapabilities");
}
/**
* Creates a ConnectionInterfaceContactCapabilitiesInterface associated with the given object on the session bus.
*
* \param busName Name of the service the object is on.
* \param objectPath Path to the object on the service.
* \param parent Passed to the parent class constructor.
*/
ConnectionInterfaceContactCapabilitiesInterface(
const QString& busName,
const QString& objectPath,
QObject* parent = 0
);
/**
* Creates a ConnectionInterfaceContactCapabilitiesInterface associated with the given object on the given bus.
*
* \param connection The bus via which the object can be reached.
* \param busName Name of the service the object is on.
* \param objectPath Path to the object on the service.
* \param parent Passed to the parent class constructor.
*/
ConnectionInterfaceContactCapabilitiesInterface(
const QDBusConnection& connection,
const QString& busName,
const QString& objectPath,
QObject* parent = 0
);
/**
* Creates a ConnectionInterfaceContactCapabilitiesInterface associated with the same object as the given proxy.
*
* \param proxy The proxy to use. It will also be the QObject::parent()
* for this object.
*/
ConnectionInterfaceContactCapabilitiesInterface(Tp::DBusProxy *proxy);
/**
* Creates a ConnectionInterfaceContactCapabilitiesInterface associated with the same object as the given proxy.
* Additionally, the created proxy will have the same parent as the given
* proxy.
*
* \param mainInterface The proxy to use.
*/
explicit ConnectionInterfaceContactCapabilitiesInterface(const Tp::Client::ConnectionInterface& mainInterface);
/**
* Creates a ConnectionInterfaceContactCapabilitiesInterface associated with the same object as the given proxy.
* However, a different parent object can be specified.
*
* \param mainInterface The proxy to use.
* \param parent Passed to the parent class constructor.
*/
ConnectionInterfaceContactCapabilitiesInterface(const Tp::Client::ConnectionInterface& mainInterface, QObject* parent);
/**
* Request all of the DBus properties on the interface.
*
* \return A pending variant map which will emit finished when the properties have
* been retrieved.
*/
Tp::PendingVariantMap *requestAllProperties() const
{
return internalRequestAllProperties();
}
public Q_SLOTS:
/**
* Begins a call to the D-Bus method \c UpdateCapabilities on the remote object.
*
* \htmlonly
* <p>Alter the connection's advertised capabilities to include
* the intersection of the given clients' capabilities with what the
* connection manager is able to implement.</p>
*
* <p>On connections managed by the ChannelDispatcher, processes other
* than the ChannelDispatcher SHOULD NOT call this method, and the
* ChannelDispatcher SHOULD use this method to advertise the
* capabilities of all the registered \endhtmlonly ClientHandlerInterface \htmlonly
* implementations.On connections not managed by the ChannelDispatcher,
* clients MAY use this method directly, to indicate the channels they
* will handle and the extra capabilities they have.</p>
*
* <p>Upon a successful invocation of this method, the connection manager
* will only emit the
* \endhtmlonly ContactCapabilitiesChanged() \htmlonly signal
* for the user's \endhtmlonly \link ConnectionInterface::requestPropertySelfHandle() ConnectionInterface::SelfHandle \endlink \htmlonly
* if, in the underlying protocol, the new capabilities are distinct
* from the previous state.</p>
*
* <div class="rationale">
* <p>The connection manager will essentially intersect the provided
* capabilities and the channel classes it implements. Therefore,
* certain properties which are never fixed for a channel class
* (such as the target handle, or the Parameters property of a tube
* channel) will almost certainly not be advertised.</p>
* </div>
*
* <p>This method MAY be called on a newly-created connection while it
* is still in the DISCONNECTED state, to request that when the
* connection connects, it will do so with the appropriate
* capabilities. Doing so MUST NOT fail.</p>
* \endhtmlonly
*
* Note that \a timeout is ignored as of now. It will be used once
* http://bugreports.qt.nokia.com/browse/QTBUG-11775 is fixed.
*
*
* \param handlerCapabilities
*
* The capabilities of one or more clients. For each client in the
* given list, any capabilities previously advertised for the same
* client name are discarded, then replaced by the capabilities
* indicated. As a result, if a client becomes unavailable, this
* method SHOULD be called with a Handler_Capabilities structure
* containing its name, an empty list of channel classes, and an empty
* list of capabilities. When this is done, the connection manager
* SHOULD free all memory associated with that client name. This
* method takes a list of clients so that when the channel dispatcher
* first calls it (with a list of all the Handlers that are initially
* available), the changes can be made atomically, with only one
* transmission of updated capabilities to the network. Afterwards,
* the channel dispatcher will call this method with a single-element
* list every time a Handler becomes available or unavailable. The
* connection manager MUST ignore any channel classes and client
* capabilities for which there is no representation in the protocol
* or no support in the connection manager.
* \param timeout The timeout in milliseconds.
*/
inline QDBusPendingReply<> UpdateCapabilities(const Tp::HandlerCapabilitiesList& handlerCapabilities, int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("UpdateCapabilities"));
callMessage << QVariant::fromValue(handlerCapabilities);
return this->connection().asyncCall(callMessage, timeout);
}
/**
* Begins a call to the D-Bus method \c GetContactCapabilities on the remote object.
*
* \htmlonly
* <p>Returns an array of requestable channel classes for the given
* contact handles, representing the channel requests that are
* expected to succeed.</p>
* \endhtmlonly
*
* Note that \a timeout is ignored as of now. It will be used once
* http://bugreports.qt.nokia.com/browse/QTBUG-11775 is fixed.
*
*
* \param handles
*
* \htmlonly
* <p>An array of contact handles for this connection.</p>
*
* <p>The handle zero MUST NOT be included in the request.</p>
* \endhtmlonly
* \param timeout The timeout in milliseconds.
*
* \return
*
* \htmlonly
* <p>A map from contact handles to lists of requestable channel
* classes, representing the channel requests that are expected
* to succeed for that contact.</p>
*
* <p>Contacts listed among Handles whose capabilities are unknown
* SHOULD be omitted from this map; contacts known to have an empty
* set of capabilities SHOULD be included in the keys of this map,
* with an empty array as the corresponding value.</p>
* \endhtmlonly
*/
inline QDBusPendingReply<Tp::ContactCapabilitiesMap> GetContactCapabilities(const Tp::UIntList& handles, int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<Tp::ContactCapabilitiesMap>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("GetContactCapabilities"));
callMessage << QVariant::fromValue(handles);
return this->connection().asyncCall(callMessage, timeout);
}
Q_SIGNALS:
/**
* Represents the signal \c ContactCapabilitiesChanged on the remote object.
*
* \htmlonly
* <p>Announce that there has been a change of capabilities on the
* given handles. A single signal can be emitted for several
* contacts.</p>
*
* <div class="rationale">
* <p>The underlying protocol can get several contacts' capabilities at
* the same time.</p>
* </div>
* \endhtmlonly
*
* \param caps
*
* \htmlonly
* All the capabilities of the contacts
* \endhtmlonly
*/
void ContactCapabilitiesChanged(const Tp::ContactCapabilitiesMap& caps);
protected:
virtual void invalidate(Tp::DBusProxy *, const QString &, const QString &);
};
/**
* \class ConnectionInterfaceContactGroupsInterface
* \headerfile TelepathyQt/connection.h <TelepathyQt/Connection>
* \ingroup clientconn
*
* Proxy class providing a 1:1 mapping of the D-Bus interface "org.freedesktop.Telepathy.Connection.Interface.ContactGroups".
*/
class TP_QT_EXPORT ConnectionInterfaceContactGroupsInterface : public Tp::AbstractInterface
{
Q_OBJECT
public:
/**
* Returns the name of the interface "org.freedesktop.Telepathy.Connection.Interface.ContactGroups", which this class
* represents.
*
* \return The D-Bus interface name.
*/
static inline QLatin1String staticInterfaceName()
{
return QLatin1String("org.freedesktop.Telepathy.Connection.Interface.ContactGroups");
}
/**
* Creates a ConnectionInterfaceContactGroupsInterface associated with the given object on the session bus.
*
* \param busName Name of the service the object is on.
* \param objectPath Path to the object on the service.
* \param parent Passed to the parent class constructor.
*/
ConnectionInterfaceContactGroupsInterface(
const QString& busName,
const QString& objectPath,
QObject* parent = 0
);
/**
* Creates a ConnectionInterfaceContactGroupsInterface associated with the given object on the given bus.
*
* \param connection The bus via which the object can be reached.
* \param busName Name of the service the object is on.
* \param objectPath Path to the object on the service.
* \param parent Passed to the parent class constructor.
*/
ConnectionInterfaceContactGroupsInterface(
const QDBusConnection& connection,
const QString& busName,
const QString& objectPath,
QObject* parent = 0
);
/**
* Creates a ConnectionInterfaceContactGroupsInterface associated with the same object as the given proxy.
*
* \param proxy The proxy to use. It will also be the QObject::parent()
* for this object.
*/
ConnectionInterfaceContactGroupsInterface(Tp::DBusProxy *proxy);
/**
* Creates a ConnectionInterfaceContactGroupsInterface associated with the same object as the given proxy.
* Additionally, the created proxy will have the same parent as the given
* proxy.
*
* \param mainInterface The proxy to use.
*/
explicit ConnectionInterfaceContactGroupsInterface(const Tp::Client::ConnectionInterface& mainInterface);
/**
* Creates a ConnectionInterfaceContactGroupsInterface associated with the same object as the given proxy.
* However, a different parent object can be specified.
*
* \param mainInterface The proxy to use.
* \param parent Passed to the parent class constructor.
*/
ConnectionInterfaceContactGroupsInterface(const Tp::Client::ConnectionInterface& mainInterface, QObject* parent);
/**
* Asynchronous getter for the remote object property \c DisjointGroups of type \c bool.
*
*
* \htmlonly
* <p>True if each contact can be in at most one group; false if each
* contact can be in many groups.</p>
*
* <p>This property cannot change after the connection has moved to the
* Connected state. Until then, its value is undefined, and it may
* change at any time, without notification.</p>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyDisjointGroups() const
{
return internalRequestProperty(QLatin1String("DisjointGroups"));
}
/**
* Asynchronous getter for the remote object property \c GroupStorage of type \c uint.
*
*
* Indicates the extent to which contacts' groups can be set and
* stored. This property cannot change after the connection has moved to
* the Connected state. Until then, its value is undefined, and it may
* change at any time, without notification.
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyGroupStorage() const
{
return internalRequestProperty(QLatin1String("GroupStorage"));
}
/**
* Asynchronous getter for the remote object property \c Groups of type \c QStringList.
*
*
* \htmlonly
* <p>The names of all groups that currently exist. This may be a
* larger set than the union of all contacts' <code>groups</code>
* contact attributes, if the connection allows groups to be
* empty.</p>
*
* <p>Change notification is via
* \endhtmlonly GroupsCreated() \htmlonly and
* \endhtmlonly GroupsRemoved() \htmlonly ; clients can also
* distinguish between a create/remove pair and a renamed group by
* receiving \endhtmlonly GroupRenamed() \htmlonly .</p>
*
* <p>This property's value is not meaningful until the
* \endhtmlonly \link ConnectionInterfaceContactListInterface::requestPropertyContactListState() ConnectionInterfaceContactListInterface::ContactListState \endlink \htmlonly has become Success.</p>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyGroups() const
{
return internalRequestProperty(QLatin1String("Groups"));
}
/**
* Request all of the DBus properties on the interface.
*
* \return A pending variant map which will emit finished when the properties have
* been retrieved.
*/
Tp::PendingVariantMap *requestAllProperties() const
{
return internalRequestAllProperties();
}
public Q_SLOTS:
/**
* Begins a call to the D-Bus method \c SetContactGroups on the remote object.
*
* \htmlonly
* <p>Add the given contact to the given groups (creating new groups
* if necessary), and remove them from all other groups.</p>
*
* <div class="rationale">
* <p>This is the easiest and most correct way to implement user
* interfaces that display a single contact with a list of groups,
* resulting in a user expectation that when they apply the changes,
* the contact's set of groups will become exactly what was
* displayed.</p>
* </div>
*
* <p>If the user is removed from a group of which they were the only
* member, the group MAY be removed automatically.</p>
*
* <div class="rationale">
* <p>In protocols like XMPP where groups behave like tags, a group
* with no members has no protocol representation.</p>
* </div>
*
* <p>Any \endhtmlonly GroupsCreated() \htmlonly ,
* \endhtmlonly GroupsChanged() \htmlonly and
* \endhtmlonly GroupsRemoved() \htmlonly signals that result from
* this method call MUST be emitted before the method returns.</p>
*
* <p>This method SHOULD NOT be called until the
* \endhtmlonly \link ConnectionInterfaceContactListInterface::requestPropertyContactListState() ConnectionInterfaceContactListInterface::ContactListState \endlink \htmlonly changes to Success.
* If the ContactListState is Failure, this method SHOULD raise the
* same error as
* \endhtmlonly ConnectionInterfaceContactListInterface::GetContactListAttributes() \htmlonly .</p>
* \endhtmlonly
*
* Note that \a timeout is ignored as of now. It will be used once
* http://bugreports.qt.nokia.com/browse/QTBUG-11775 is fixed.
*
*
* \param contact
*
* The contact to alter.
*
* \param groups
*
* The set of groups which the contact should be in.
* \param timeout The timeout in milliseconds.
*/
inline QDBusPendingReply<> SetContactGroups(uint contact, const QStringList& groups, int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("SetContactGroups"));
callMessage << QVariant::fromValue(contact) << QVariant::fromValue(groups);
return this->connection().asyncCall(callMessage, timeout);
}
/**
* Begins a call to the D-Bus method \c SetGroupMembers on the remote object.
*
* \htmlonly
* <p>Add the given members to the given group (creating it if necessary),
* and remove all other members.</p>
*
* <div class="rationale">
* <p>This is the easiest and most correct way to implement user
* interfaces that display a single group with a list of contacts,
* resulting in a user expectation that when they apply the changes,
* the groups's set of members will become exactly what was
* displayed.</p>
* </div>
*
* <p>If \endhtmlonly \link requestPropertyDisjointGroups() DisjointGroups \endlink \htmlonly is true,
* this will also remove each member from their previous group.</p>
*
* <p>If the user is removed from a group of which they were the only
* member, the group MAY be removed automatically.</p>
*
* <p>Any \endhtmlonly GroupsCreated() \htmlonly ,
* \endhtmlonly GroupsChanged() \htmlonly and
* \endhtmlonly GroupsRemoved() \htmlonly signals that result from
* this method call MUST be emitted before the method returns.</p>
*
* <p>This method SHOULD NOT be called until the
* \endhtmlonly \link ConnectionInterfaceContactListInterface::requestPropertyContactListState() ConnectionInterfaceContactListInterface::ContactListState \endlink \htmlonly changes to Success.
* If the ContactListState is Failure, this method SHOULD raise the
* same error as
* \endhtmlonly ConnectionInterfaceContactListInterface::GetContactListAttributes() \htmlonly .</p>
* \endhtmlonly
*
* Note that \a timeout is ignored as of now. It will be used once
* http://bugreports.qt.nokia.com/browse/QTBUG-11775 is fixed.
*
*
* \param group
*
* The group to alter.
*
* \param members
*
* The set of members for the group. If this set is empty, this method
* MAY remove the group.
* \param timeout The timeout in milliseconds.
*/
inline QDBusPendingReply<> SetGroupMembers(const QString& group, const Tp::UIntList& members, int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("SetGroupMembers"));
callMessage << QVariant::fromValue(group) << QVariant::fromValue(members);
return this->connection().asyncCall(callMessage, timeout);
}
/**
* Begins a call to the D-Bus method \c AddToGroup on the remote object.
*
* \htmlonly
* <p>Add the given members to the given group, creating it if
* necessary.</p>
*
* <p>If \endhtmlonly \link requestPropertyDisjointGroups() DisjointGroups \endlink \htmlonly is true,
* this will also remove each member from their previous group.</p>
*
* <div class="rationale">
* <p>This is good for user interfaces in which you can edit groups
* via drag-and-drop.</p>
* </div>
*
* <p>Any \endhtmlonly GroupsCreated() \htmlonly ,
* \endhtmlonly GroupsChanged() \htmlonly and
* \endhtmlonly GroupsRemoved() \htmlonly signals that result from
* this method call MUST be emitted before the method returns.</p>
*
* <p>This method SHOULD NOT be called until the
* \endhtmlonly \link ConnectionInterfaceContactListInterface::requestPropertyContactListState() ConnectionInterfaceContactListInterface::ContactListState \endlink \htmlonly changes to Success.
* If the ContactListState is Failure, this method SHOULD raise the
* same error as
* \endhtmlonly ConnectionInterfaceContactListInterface::GetContactListAttributes() \htmlonly .</p>
* \endhtmlonly
*
* Note that \a timeout is ignored as of now. It will be used once
* http://bugreports.qt.nokia.com/browse/QTBUG-11775 is fixed.
*
*
* \param group
*
* The group to alter.
*
* \param members
*
* The set of members to include in the group.
* \param timeout The timeout in milliseconds.
*/
inline QDBusPendingReply<> AddToGroup(const QString& group, const Tp::UIntList& members, int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("AddToGroup"));
callMessage << QVariant::fromValue(group) << QVariant::fromValue(members);
return this->connection().asyncCall(callMessage, timeout);
}
/**
* Begins a call to the D-Bus method \c RemoveFromGroup on the remote object.
*
* \htmlonly
* <p>Remove the given members from the given group.</p>
*
* <div class="rationale">
* <p>This is good for user interfaces in which you can edit groups
* via drag-and-drop.</p>
* </div>
*
* <p>Any \endhtmlonly GroupsChanged() \htmlonly or
* \endhtmlonly GroupsRemoved() \htmlonly signals that result from
* this method call MUST be emitted before the method returns.</p>
*
* <p>This method SHOULD NOT be called until the
* \endhtmlonly \link ConnectionInterfaceContactListInterface::requestPropertyContactListState() ConnectionInterfaceContactListInterface::ContactListState \endlink \htmlonly changes to Success.
* If the ContactListState is Failure, this method SHOULD raise the
* same error as
* \endhtmlonly ConnectionInterfaceContactListInterface::GetContactListAttributes() \htmlonly .</p>
* \endhtmlonly
*
* Note that \a timeout is ignored as of now. It will be used once
* http://bugreports.qt.nokia.com/browse/QTBUG-11775 is fixed.
*
*
* \param group
*
* The group to alter. If it does not exist, then it has no members by
* definition, so this method SHOULD return successfully.
*
* \param members
*
* The set of members to remove from the group. It is not an error to
* remove members who are already not in the group. If there are no
* members left in the group afterwards, the group MAY itself be
* removed.
* \param timeout The timeout in milliseconds.
*/
inline QDBusPendingReply<> RemoveFromGroup(const QString& group, const Tp::UIntList& members, int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("RemoveFromGroup"));
callMessage << QVariant::fromValue(group) << QVariant::fromValue(members);
return this->connection().asyncCall(callMessage, timeout);
}
/**
* Begins a call to the D-Bus method \c RemoveGroup on the remote object.
*
* \htmlonly
* <p>Remove all members from the given group, then remove the group
* itself. If the group already does not exist, this method SHOULD
* return successfully.</p>
*
* <p>Any \endhtmlonly GroupsChanged() \htmlonly or
* \endhtmlonly GroupsRemoved() \htmlonly signals that result from
* this method call MUST be emitted before the method returns.</p>
*
* <p>This method SHOULD NOT be called until the
* \endhtmlonly \link ConnectionInterfaceContactListInterface::requestPropertyContactListState() ConnectionInterfaceContactListInterface::ContactListState \endlink \htmlonly changes to Success.
* If the ContactListState is Failure, this method SHOULD raise the
* same error as
* \endhtmlonly ConnectionInterfaceContactListInterface::GetContactListAttributes() \htmlonly .</p>
* \endhtmlonly
*
* Note that \a timeout is ignored as of now. It will be used once
* http://bugreports.qt.nokia.com/browse/QTBUG-11775 is fixed.
*
*
* \param group
*
* The group to remove.
* \param timeout The timeout in milliseconds.
*/
inline QDBusPendingReply<> RemoveGroup(const QString& group, int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("RemoveGroup"));
callMessage << QVariant::fromValue(group);
return this->connection().asyncCall(callMessage, timeout);
}
/**
* Begins a call to the D-Bus method \c RenameGroup on the remote object.
*
* \htmlonly
* <p>Rename the given group.</p>
*
* <p>On protocols where groups behave like tags, this is an API
* short-cut for adding all of the group's members to a group with
* the new name, then removing the old group.</p>
*
* <div class="rationale">
* <p>Otherwise, clients can't perform this operation atomically, even
* if the connection could.</p>
* </div>
*
* <p>Any \endhtmlonly GroupRenamed() \htmlonly or
* \endhtmlonly GroupsRemoved() \htmlonly signals that result from
* this method call MUST be emitted before the method returns.</p>
*
* <p>This method SHOULD NOT be called until the
* \endhtmlonly \link ConnectionInterfaceContactListInterface::requestPropertyContactListState() ConnectionInterfaceContactListInterface::ContactListState \endlink \htmlonly changes to Success.
* If the ContactListState is Failure, this method SHOULD raise the
* same error as
* \endhtmlonly ConnectionInterfaceContactListInterface::GetContactListAttributes() \htmlonly .</p>
* \endhtmlonly
*
* Note that \a timeout is ignored as of now. It will be used once
* http://bugreports.qt.nokia.com/browse/QTBUG-11775 is fixed.
*
*
* \param oldName
*
* The group to rename.
*
* \param newName
*
* The new name for the group.
* \param timeout The timeout in milliseconds.
*/
inline QDBusPendingReply<> RenameGroup(const QString& oldName, const QString& newName, int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("RenameGroup"));
callMessage << QVariant::fromValue(oldName) << QVariant::fromValue(newName);
return this->connection().asyncCall(callMessage, timeout);
}
Q_SIGNALS:
/**
* Represents the signal \c GroupsChanged on the remote object.
*
* Emitted when contacts' groups change.
*
* \param contact
*
* The relevant contacts.
*
* \param added
*
* The names of groups to which the contacts were added.
*
* \param removed
*
* The names of groups from which the contacts were removed.
*/
void GroupsChanged(const Tp::UIntList& contact, const QStringList& added, const QStringList& removed);
/**
* Represents the signal \c GroupsCreated on the remote object.
*
* Emitted when new, empty groups are created. This will often be followed
* by GroupsChanged signals that add some members.
*
* \param names
*
* The names of the new groups.
*/
void GroupsCreated(const QStringList& names);
/**
* Represents the signal \c GroupRenamed on the remote object.
*
* \htmlonly
* <p>Emitted when a group is renamed, in protocols where this can
* be distinguished from group creation, removal and membership
* changes.</p>
*
* <p>Immediately after this signal is emitted,
* \endhtmlonly GroupsCreated() \htmlonly MUST signal the
* creation of a group with the new name, and
* \endhtmlonly GroupsRemoved() \htmlonly MUST signal the
* removal of a group with the old name.</p>
*
* <div class="rationale">
* <p>Emitting these extra signals, in this order, means that clients
* that are interested in the set of groups that exist (but treat a
* rename and a create/remove pair identically) can ignore the
* GroupRenamed signal entirely.</p>
* </div>
*
* <p>If the group was not empty, immediately after those signals are
* emitted, \endhtmlonly GroupsChanged() \htmlonly MUST signal
* that the members of that group were removed from the old name
* and added to the new name.</p>
*
* <p>On connection managers where groups behave like tags, renaming a
* group MAY be signalled as a set of
* \endhtmlonly GroupsCreated() \htmlonly ,
* \endhtmlonly GroupsRemoved() \htmlonly and
* \endhtmlonly GroupsChanged() \htmlonly signals, instead of
* emitting this signal.</p>
*
* <div class="rationale">
* <p>On protocols like XMPP, another resource "renaming a group" is
* indistinguishable from changing contacts' groups individually.</p>
* </div>
* \endhtmlonly
*
* \param oldName
*
* The old name of the group.
*
* \param newName
*
* The new name of the group.
*/
void GroupRenamed(const QString& oldName, const QString& newName);
/**
* Represents the signal \c GroupsRemoved on the remote object.
*
* \htmlonly
* <p>Emitted when one or more groups are removed. If they had members at
* the time that they were removed, then immediately after this signal
* is emitted, \endhtmlonly GroupsChanged() \htmlonly MUST signal
* that their members were removed.</p>
*
* <div class="rationale">
* <p>Emitting the signals in this order allows for two modes of
* operation. A client interested only in a contact's set of groups
* can ignore \endhtmlonly GroupsRemoved() \htmlonly and rely
* on the \endhtmlonly GroupsChanged() \htmlonly signal that
* will follow; a more elaborate client wishing to distinguish between
* all of a group's members being removed, and the group itself
* being removed, can additionally watch for
* \endhtmlonly GroupsRemoved() \htmlonly and use it to
* disambiguate.</p>
* </div>
* \endhtmlonly
*
* \param names
*
* The names of the groups.
*/
void GroupsRemoved(const QStringList& names);
protected:
virtual void invalidate(Tp::DBusProxy *, const QString &, const QString &);
};
/**
* \class ConnectionInterfaceContactInfoInterface
* \headerfile TelepathyQt/connection.h <TelepathyQt/Connection>
* \ingroup clientconn
*
* Proxy class providing a 1:1 mapping of the D-Bus interface "org.freedesktop.Telepathy.Connection.Interface.ContactInfo".
*/
class TP_QT_EXPORT ConnectionInterfaceContactInfoInterface : public Tp::AbstractInterface
{
Q_OBJECT
public:
/**
* Returns the name of the interface "org.freedesktop.Telepathy.Connection.Interface.ContactInfo", which this class
* represents.
*
* \return The D-Bus interface name.
*/
static inline QLatin1String staticInterfaceName()
{
return QLatin1String("org.freedesktop.Telepathy.Connection.Interface.ContactInfo");
}
/**
* Creates a ConnectionInterfaceContactInfoInterface associated with the given object on the session bus.
*
* \param busName Name of the service the object is on.
* \param objectPath Path to the object on the service.
* \param parent Passed to the parent class constructor.
*/
ConnectionInterfaceContactInfoInterface(
const QString& busName,
const QString& objectPath,
QObject* parent = 0
);
/**
* Creates a ConnectionInterfaceContactInfoInterface associated with the given object on the given bus.
*
* \param connection The bus via which the object can be reached.
* \param busName Name of the service the object is on.
* \param objectPath Path to the object on the service.
* \param parent Passed to the parent class constructor.
*/
ConnectionInterfaceContactInfoInterface(
const QDBusConnection& connection,
const QString& busName,
const QString& objectPath,
QObject* parent = 0
);
/**
* Creates a ConnectionInterfaceContactInfoInterface associated with the same object as the given proxy.
*
* \param proxy The proxy to use. It will also be the QObject::parent()
* for this object.
*/
ConnectionInterfaceContactInfoInterface(Tp::DBusProxy *proxy);
/**
* Creates a ConnectionInterfaceContactInfoInterface associated with the same object as the given proxy.
* Additionally, the created proxy will have the same parent as the given
* proxy.
*
* \param mainInterface The proxy to use.
*/
explicit ConnectionInterfaceContactInfoInterface(const Tp::Client::ConnectionInterface& mainInterface);
/**
* Creates a ConnectionInterfaceContactInfoInterface associated with the same object as the given proxy.
* However, a different parent object can be specified.
*
* \param mainInterface The proxy to use.
* \param parent Passed to the parent class constructor.
*/
ConnectionInterfaceContactInfoInterface(const Tp::Client::ConnectionInterface& mainInterface, QObject* parent);
/**
* Asynchronous getter for the remote object property \c ContactInfoFlags of type \c uint.
*
*
* \htmlonly
* <p>An integer representing the bitwise-OR of flags on this
* connection.</p>
*
* <p>This property MAY change, without change notification, at any time
* before the connection moves to status Connection_Status_Connected.
* It MUST NOT change after that point.</p>
*
* <div class="rationale">
* <p>Some XMPP servers, like Facebook Chat, do not allow the vCard to
* be changed (and so would not have the Can_Set flag). Whether the
* user's server is one of these cannot necessarily be detected until
* quite late in the connection process.</p>
* </div>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyContactInfoFlags() const
{
return internalRequestProperty(QLatin1String("ContactInfoFlags"));
}
/**
* Asynchronous getter for the remote object property \c SupportedFields of type \c Tp::FieldSpecs.
*
*
* \htmlonly
* <p>A list of field specifications describing the kinds of fields which may
* be passed to \endhtmlonly SetContactInfo() \htmlonly . The empty
* list indicates that arbitrary vCard fields are permitted. This
* property SHOULD be the empty list, and be ignored by clients, if
* \endhtmlonly \link requestPropertyContactInfoFlags() ContactInfoFlags \endlink \htmlonly does not contain the
* Can_Set flag.</p>
*
* <p>For example, a protocol in which arbitrary vCards were stored
* as-is would set this property to the
* empty list. A protocol whose notion of contact information is one
* each of personal phone number, mobile phone number, location, email
* address and date of birth, with no attributes allowed on each piece
* of information, would set this property to (in Python-like
* syntax):</p>
*
* <pre>
* [
* ('tel', ['type=home'], Parameters_Exact, 1),
* ('tel', ['type=cell'], Parameters_Exact, 1),
* ('adr', [], Parameters_Exact, 1),
* ('bday', [], Parameters_Exact, 1),
* ('email', ['type=internet'], Parameters_Exact, 1),
* ]</pre>
*
* <p>A protocol which allows users to specify up to four phone numbers,
* which may be labelled as personal and/or mobile, would set this
* property to
* <code>[ ('tel', ['type=home', 'type=cell'], 0, 4), ]</code>.</p>
*
* <div class="rationale">
* <p>Studying existing IM protocols shows that in practice protocols
* allow either a very restricted set of fields (such as MSN, which
* seems to correspond roughly to the largest example above), or
* something mapping 1:1 to a large subset of vCard (such as XMPP's
* XEP-0054).</p>
* </div>
*
* <p>This property MAY change, without change notification, at any time
* before the connection moves to status Connection_Status_Connected.
* It MUST NOT change after that point.</p>
*
* <div class="rationale">
* <p>Some XMPP servers, like Google Talk, only allow a small subset of
* the "vcard-temp" protocol. Whether the user's server is one of
* these cannot be detected until quite late in the connection
* process.</p>
* </div>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertySupportedFields() const
{
return internalRequestProperty(QLatin1String("SupportedFields"));
}
/**
* Request all of the DBus properties on the interface.
*
* \return A pending variant map which will emit finished when the properties have
* been retrieved.
*/
Tp::PendingVariantMap *requestAllProperties() const
{
return internalRequestAllProperties();
}
public Q_SLOTS:
/**
* Begins a call to the D-Bus method \c GetContactInfo on the remote object.
*
* Request information on several contacts at once. This SHOULD only
* return cached information, omitting handles for which no information is
* cached from the returned map.
*
* Note that \a timeout is ignored as of now. It will be used once
* http://bugreports.qt.nokia.com/browse/QTBUG-11775 is fixed.
*
*
* \param contacts
*
* An array of handles representing contacts.
* \param timeout The timeout in milliseconds.
*
* \return
*
* A dictionary mapping contact handles to information, whose keys are
* the subset of the requested list of handles for which information
* was cached.
*/
inline QDBusPendingReply<Tp::ContactInfoMap> GetContactInfo(const Tp::UIntList& contacts, int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<Tp::ContactInfoMap>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("GetContactInfo"));
callMessage << QVariant::fromValue(contacts);
return this->connection().asyncCall(callMessage, timeout);
}
/**
* Begins a call to the D-Bus method \c RefreshContactInfo on the remote object.
*
* Retrieve information for the given contact, requesting it from the
* network if an up-to-date version is not cached locally. This method
* SHOULD return immediately, emitting ContactInfoChanged when the
* contacts' updated contact information is returned. This method
* allows a client with cached contact information to update its cache
* after a number of days.
*
* Note that \a timeout is ignored as of now. It will be used once
* http://bugreports.qt.nokia.com/browse/QTBUG-11775 is fixed.
*
*
* \param contacts
*
* Integer handles for contacts.
* \param timeout The timeout in milliseconds.
*/
inline QDBusPendingReply<> RefreshContactInfo(const Tp::UIntList& contacts, int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("RefreshContactInfo"));
callMessage << QVariant::fromValue(contacts);
return this->connection().asyncCall(callMessage, timeout);
}
/**
* Begins a call to the D-Bus method \c RequestContactInfo on the remote object.
*
* Retrieve information for a contact, requesting it from the network if
* it is not cached locally. This method is appropriate for an explicit
* user request to show a contact's information; it allows a UI to
* wait for the contact info to be returned.
*
* Note that \a timeout is ignored as of now. It will be used once
* http://bugreports.qt.nokia.com/browse/QTBUG-11775 is fixed.
*
*
* \param contact
*
* An integer handle for a contact.
* \param timeout The timeout in milliseconds.
*
* \return
*
* Information about that contact.
*/
inline QDBusPendingReply<Tp::ContactInfoFieldList> RequestContactInfo(uint contact, int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<Tp::ContactInfoFieldList>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("RequestContactInfo"));
callMessage << QVariant::fromValue(contact);
return this->connection().asyncCall(callMessage, timeout);
}
/**
* Begins a call to the D-Bus method \c SetContactInfo on the remote object.
*
* Set new contact information for this connection, replacing existing
* information. This method is only suppported if ContactInfoFlags
* contains Can_Set, and may only be passed fields conforming to
* SupportedFields.
*
* Note that \a timeout is ignored as of now. It will be used once
* http://bugreports.qt.nokia.com/browse/QTBUG-11775 is fixed.
*
*
* \param contactInfo
*
* The new information to be set.
* \param timeout The timeout in milliseconds.
*/
inline QDBusPendingReply<> SetContactInfo(const Tp::ContactInfoFieldList& contactInfo, int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("SetContactInfo"));
callMessage << QVariant::fromValue(contactInfo);
return this->connection().asyncCall(callMessage, timeout);
}
Q_SIGNALS:
/**
* Represents the signal \c ContactInfoChanged on the remote object.
*
* Emitted when a contact's information has changed or been received
* for the first time on this connection.
*
* \param contact
*
* An integer handle for the contact whose info has changed.
*
* \param contactInfo
*
* \htmlonly
* An array of fields representing information about this contact.
* \endhtmlonly
*/
void ContactInfoChanged(uint contact, const Tp::ContactInfoFieldList& contactInfo);
protected:
virtual void invalidate(Tp::DBusProxy *, const QString &, const QString &);
};
/**
* \class ConnectionInterfaceContactListInterface
* \headerfile TelepathyQt/connection.h <TelepathyQt/Connection>
* \ingroup clientconn
*
* Proxy class providing a 1:1 mapping of the D-Bus interface "org.freedesktop.Telepathy.Connection.Interface.ContactList".
*/
class TP_QT_EXPORT ConnectionInterfaceContactListInterface : public Tp::AbstractInterface
{
Q_OBJECT
public:
/**
* Returns the name of the interface "org.freedesktop.Telepathy.Connection.Interface.ContactList", which this class
* represents.
*
* \return The D-Bus interface name.
*/
static inline QLatin1String staticInterfaceName()
{
return QLatin1String("org.freedesktop.Telepathy.Connection.Interface.ContactList");
}
/**
* Creates a ConnectionInterfaceContactListInterface associated with the given object on the session bus.
*
* \param busName Name of the service the object is on.
* \param objectPath Path to the object on the service.
* \param parent Passed to the parent class constructor.
*/
ConnectionInterfaceContactListInterface(
const QString& busName,
const QString& objectPath,
QObject* parent = 0
);
/**
* Creates a ConnectionInterfaceContactListInterface associated with the given object on the given bus.
*
* \param connection The bus via which the object can be reached.
* \param busName Name of the service the object is on.
* \param objectPath Path to the object on the service.
* \param parent Passed to the parent class constructor.
*/
ConnectionInterfaceContactListInterface(
const QDBusConnection& connection,
const QString& busName,
const QString& objectPath,
QObject* parent = 0
);
/**
* Creates a ConnectionInterfaceContactListInterface associated with the same object as the given proxy.
*
* \param proxy The proxy to use. It will also be the QObject::parent()
* for this object.
*/
ConnectionInterfaceContactListInterface(Tp::DBusProxy *proxy);
/**
* Creates a ConnectionInterfaceContactListInterface associated with the same object as the given proxy.
* Additionally, the created proxy will have the same parent as the given
* proxy.
*
* \param mainInterface The proxy to use.
*/
explicit ConnectionInterfaceContactListInterface(const Tp::Client::ConnectionInterface& mainInterface);
/**
* Creates a ConnectionInterfaceContactListInterface associated with the same object as the given proxy.
* However, a different parent object can be specified.
*
* \param mainInterface The proxy to use.
* \param parent Passed to the parent class constructor.
*/
ConnectionInterfaceContactListInterface(const Tp::Client::ConnectionInterface& mainInterface, QObject* parent);
/**
* Asynchronous getter for the remote object property \c ContactListState of type \c uint.
*
*
* The progress made in retrieving the contact list. Change notification
* is via ContactListStateChanged.
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyContactListState() const
{
return internalRequestProperty(QLatin1String("ContactListState"));
}
/**
* Asynchronous getter for the remote object property \c ContactListPersists of type \c bool.
*
*
* \htmlonly
* <p>If true, presence subscriptions (in both directions) on this
* connection are stored by the server or other infrastructure.</p>
*
* <div class="rationale">
* <p>XMPP, MSN, ICQ, etc. all behave like this.</p>
* </div>
*
* <p>If false, presence subscriptions on this connection are not
* stored.</p>
*
* <div class="rationale">
* <p>In SIMPLE (SIP), <em>clients</em> are expected to keep a record
* of subscriptions, as described below. In link-local XMPP,
* subscriptions are implicit (everyone on the local network receives
* presence from everyone else) so nothing is ever stored.</p>
* </div>
*
* <p>If \endhtmlonly \link requestPropertyCanChangeContactList() CanChangeContactList \endlink \htmlonly
* is true, Telepathy clients (e.g. user interfaces or address books)
* MAY keep a record of permission to publish and requests to subscribe
* locally, and attempt to restore it for each Connection. If
* ContactListPersists is false, clients MAY do this for all contacts;
* if ContactListPersists is true, clients SHOULD NOT change the state
* of contacts that were not changed locally.</p>
*
* <div class="rationale">
* <p>In SIMPLE (SIP), ContactListPersists is false, but
* CanChangeContactList is true. Presence will not be received
* unless clients renew any subscriptions they have for each
* connection, in the way described. There is no server-side storage,
* so clients have no alternative but to maintain independent contact
* lists.</p>
*
* <p>In protocols like XMPP and MSN, it may be useful for clients to
* queue up subscription requests or removals made while offline and
* process them next time the connection is online. However, clients
* should only replay the changes, rather than resetting the contact
* list to match a stored copy, to avoid overwriting changes that
* were made on the server.</p>
* </div>
*
* <p>Clients that replay requests like this SHOULD do so by calling
* AuthorizePublication to pre-approve publication of presence to the
* appropriate contacts, followed by RequestSubscription to request the
* appropriate contacts' presences.</p>
*
* <p>This property cannot change after the connection has moved to the
* Connected state. Until then, its value is undefined, and it may
* change at any time, without notification.</p>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyContactListPersists() const
{
return internalRequestProperty(QLatin1String("ContactListPersists"));
}
/**
* Asynchronous getter for the remote object property \c CanChangeContactList of type \c bool.
*
*
* \htmlonly
* <p>If true, presence subscription and publication can be changed
* using the
* \endhtmlonly RequestSubscription() \htmlonly ,
* \endhtmlonly AuthorizePublication() \htmlonly and
* \endhtmlonly RemoveContacts() \htmlonly methods.</p>
*
* <p>If false, all of those methods will always fail; they SHOULD raise
* the error org.freedesktop.Telepathy.Error.NotImplemented.</p>
*
* <div class="rationale">
* <p>In XEP-0174 "Serverless Messaging" (link-local XMPP), presence is
* implicitly published to everyone in the local subnet, so the user
* cannot control their presence publication.</p>
* </div>
*
* <p>This property cannot change after the connection has moved to the
* Connected state. Until then, its value is undefined, and it may
* change at any time, without notification.</p>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyCanChangeContactList() const
{
return internalRequestProperty(QLatin1String("CanChangeContactList"));
}
/**
* Asynchronous getter for the remote object property \c RequestUsesMessage of type \c bool.
*
*
* \htmlonly
* <p>If true, the Message parameter to
* \endhtmlonly RequestSubscription() \htmlonly is likely to be
* significant, and user interfaces SHOULD prompt the user for a
* message to send with the request; a message such as "I would like
* to add you to my contact list", translated into the local user's
* language, might make a suitable default.</p>
*
* <div class="rationale">
* <p>This matches user expectations in XMPP and ICQ, for instance.</p>
* </div>
*
* <p>If false, the parameter is ignored; user interfaces SHOULD avoid
* prompting the user, and SHOULD pass an empty string to
* RequestSubscription.</p>
*
* <div class="rationale">
* <p><em>FIXME: is there any such protocol?</em></p>
* </div>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyRequestUsesMessage() const
{
return internalRequestProperty(QLatin1String("RequestUsesMessage"));
}
/**
* Asynchronous getter for the remote object property \c DownloadAtConnection of type \c bool.
*
*
* \htmlonly
* <p>If true, the contact list is automatically downloaded at
* connection. If false, the contact list is only downloaded
* when requested explicitely with
* \endhtmlonly Download() \htmlonly .</p>
*
* <div class="rationale">
* <p>Downloading the contact list uses bandwidth and is not always
* necessary or desired. For example, a client could cache the
* contact list from previous connections and accept less regular
* updates, it could get the contact list from an out-of-band
* protocol-specific way, or it could not need the contact list at
* all.</p>
* </div>
*
* <p>Connection managers MUST default to true.</p>
*
* <div class="rationale">
* <p>If a connection manager starts supporting this property but
* defaults to false, it would break all existing clients that don't
* call \endhtmlonly Download() \htmlonly .</p>
* </div>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyDownloadAtConnection() const
{
return internalRequestProperty(QLatin1String("DownloadAtConnection"));
}
/**
* Request all of the DBus properties on the interface.
*
* \return A pending variant map which will emit finished when the properties have
* been retrieved.
*/
Tp::PendingVariantMap *requestAllProperties() const
{
return internalRequestAllProperties();
}
public Q_SLOTS:
/**
* Begins a call to the D-Bus method \c GetContactListAttributes on the remote object.
*
* \htmlonly
* <p>Return some contact attributes for a list of contacts
* associated with the user. This list MUST include at least:</p>
*
* <ul>
* <li>all contacts whose <tp:token-ref>subscribe</tp:token-ref>
* attribute is not No</li>
* <li>all contacts whose <tp:token-ref>publish</tp:token-ref>
* attribute is not No</li>
* </ul>
*
* <p>but MAY contain other contacts.</p>
*
* <div class="rationale">
* <p>For instance, on XMPP, all contacts on the roster would appear
* here even if they have subscription="none", unless there's
* reason to believe the user does not want to see them (such as
* having been blocked).</p>
* </div>
*
* <p>This list does not need to contain every visible contact: for
* instance, contacts seen in XMPP or IRC chatrooms SHOULD NOT appear
* here. Blocked contacts SHOULD NOT appear here, unless they still
* have a non-<tt>No</tt> <tp:token-ref>subscribe</tp:token-ref> or
* <tp:token-ref>publish</tp:token-ref> attribute
* for some reason.</p>
*
* <div class="rationale">
* <p>It's reasonable to assume that blocked contacts should not be
* visible to the user unless they specifically go looking for them,
* at least in protocols like XMPP where blocking a contact
* suppresses presence.</p>
* </div>
* \endhtmlonly
*
* Note that \a timeout is ignored as of now. It will be used once
* http://bugreports.qt.nokia.com/browse/QTBUG-11775 is fixed.
*
*
* \param interfaces
*
* \htmlonly
* <p>A list of strings indicating which D-Bus interfaces the calling
* process is interested in. Equivalent to the corresponding argument
* to \endhtmlonly ConnectionInterfaceContactsInterface::GetContactAttributes() \htmlonly ,
* except that if this list does not contain the ContactList
* interface itself, it is treated as though that interface was also
* requested.</p>
* \endhtmlonly
*
* \param hold
*
* \htmlonly
* <p>If true, all handles that appear as keys in the result have been
* held on behalf of the calling process, as if by a call to
* \endhtmlonly ConnectionInterface::HoldHandles() \htmlonly .
* (If \endhtmlonly \link ConnectionInterface::requestPropertyHasImmortalHandles() ConnectionInterface::HasImmortalHandles \endlink \htmlonly is true, which SHOULD be the
* case in all new connection managers, this has no effect.)</p>
* \endhtmlonly
* \param timeout The timeout in milliseconds.
*
* \return
*
* \htmlonly
* <p>A dictionary mapping the contact handles to contact attributes,
* equivalent to the result of \endhtmlonly ConnectionInterfaceContactsInterface::GetContactAttributes() \htmlonly .</p>
* \endhtmlonly
*/
inline QDBusPendingReply<Tp::ContactAttributesMap> GetContactListAttributes(const QStringList& interfaces, bool hold, int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<Tp::ContactAttributesMap>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("GetContactListAttributes"));
callMessage << QVariant::fromValue(interfaces) << QVariant::fromValue(hold);
return this->connection().asyncCall(callMessage, timeout);
}
/**
* Begins a call to the D-Bus method \c RequestSubscription on the remote object.
*
* \htmlonly
* <p>Request that the given contacts allow the local user to
* subscribe to their presence, i.e. that their subscribe attribute
* becomes Yes.</p>
*
* <p>Connection managers SHOULD NOT attempt to enforce a
* mutual-subscription policy (i.e. when this method is called, they
* should not automatically allow the contacts to see the local user's
* presence). User interfaces that require mutual subscription
* MAY call \endhtmlonly AuthorizePublication() \htmlonly
* at the same time as this method.</p>
*
* <div class="rationale">
* <p>Whether to enforce mutual subscription is a matter of policy,
* so it is left to the user interface and/or the server.</p>
* </div>
*
* <p>Before calling this method on a connection where \endhtmlonly ConnectionInterfaceAliasingInterface::GetAliasFlags() \htmlonly returns the <code>User_Set</code> flag,
* user interfaces SHOULD obtain, from the user, an alias to
* identify the contact in future, and store it using \endhtmlonly ConnectionInterfaceAliasingInterface::SetAliases() \htmlonly .</p>
*
* <p>The user MAY be
* prompted using the contact's current self-assigned nickname, or
* something derived from the contact's (presumably self-assigned)
* identifier, as a default, but these names chosen by the contact
* SHOULD NOT be used without user approval.</p>
*
* <div class="rationale">
* <p>This is a generalization of
* <a href="http://xmpp.org/extensions/xep-0165.html">XEP-0165 "Best Practices to Discourage JID Mimicking"</a>)
* to protocols other than XMPP. A reasonable user interface for
* this, as used in many XMPP clients, is to have a text entry
* for the alias adjacent to the text entry for the identifier
* to add.</p>
* </div>
*
* <p>For contacts with subscribe=Yes, this method has no effect.
* It MUST return successfully if all contacts are in this state.</p>
*
* <p>For contacts with subscribe=Ask, this method SHOULD send a new
* request, with the given message, if allowed by the underlying
* protocol.</p>
*
* <p>For contacts with subscribe=No or subscribe=Rejected, this method
* SHOULD request that the contact allows the local user to subscribe
* to their presence; in general, this will change their publish
* attribute to Ask (although it could change directly to Yes in some
* situations).</p>
*
* <p>Any state changes that immediately result from this request MUST
* be signalled via \endhtmlonly ContactsChanged() \htmlonly
* before this method returns.</p>
*
* <div class="rationale">
* <p>This makes it easy for user interfaces to see what practical
* effect this method had.</p>
* </div>
*
* <p>If the remote contact accepts the request, their subscribe
* attribute will later change from Ask to Yes.</p>
*
* <p>If the remote contact explicitly rejects the request (in protocols
* that allow this), their subscribe attribute will later change from
* Ask to Rejected.</p>
*
* <p>If the subscription request is cancelled by the local user, the
* contact's subscribe attribute will change from Ask to No.</p>
*
* <p>This method SHOULD NOT be called until the
* \endhtmlonly \link requestPropertyContactListState() ContactListState \endlink \htmlonly changes to Success.
* If the \endhtmlonly \link requestPropertyContactListState() ContactListState \endlink \htmlonly changes to
* Failure, this method SHOULD raise the same error as
* \endhtmlonly GetContactListAttributes() \htmlonly .</p>
* \endhtmlonly
*
* Note that \a timeout is ignored as of now. It will be used once
* http://bugreports.qt.nokia.com/browse/QTBUG-11775 is fixed.
*
*
* \param contacts
*
* \htmlonly
* <p>One or more contacts to whom requests are to be sent.</p>
* \endhtmlonly
*
* \param message
*
* \htmlonly
* <p>An optional plain-text message from the user, to send to those
* contacts with the subscription request. The
* \endhtmlonly \link requestPropertyRequestUsesMessage() RequestUsesMessage \endlink \htmlonly property
* indicates whether this message will be used or ignored.</p>
*
* <p>Clients SHOULD NOT send a non-empty message without first giving
* the user an opportunity to edit it.</p>
*
* <div class="rationale">
* <p>These messages are typically presented to the remote contact
* as if the user had typed them, so as a minimum, the user should be
* allowed to see what the UI will be saying on their behalf.</p>
* </div>
*
* <p>Connections where this message is not useful MUST still allow it to
* be non-empty.</p>
* \endhtmlonly
* \param timeout The timeout in milliseconds.
*/
inline QDBusPendingReply<> RequestSubscription(const Tp::UIntList& contacts, const QString& message, int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("RequestSubscription"));
callMessage << QVariant::fromValue(contacts) << QVariant::fromValue(message);
return this->connection().asyncCall(callMessage, timeout);
}
/**
* Begins a call to the D-Bus method \c AuthorizePublication on the remote object.
*
* \htmlonly
* <p>For each of the given contacts, request that the local user's
* presence is sent to that contact, i.e. that their publish attribute
* becomes Yes.</p>
*
* <p>Connection managers SHOULD NOT attempt to enforce a
* mutual-subscription policy (i.e. when this method is called, they
* should not automatically request that the contacts allow the user to
* subscribe to their presence). User interfaces that require mutual
* subscription MAY call
* \endhtmlonly RequestSubscription() \htmlonly at the same time
* as this method.</p>
*
* <div class="rationale">
* <p>Whether to enforce mutual subscription is a matter of policy,
* so it is left to the user interface and/or the server.</p>
* </div>
*
* <p>For contacts with publish=Yes, this method has no effect; it
* MUST return successfully if all contacts given have this state.</p>
*
* <p>For contacts with publish=Ask, this method accepts the
* contact's request to see the local user's presence, changing
* their publish attribute from Ask to Yes.</p>
*
* <p>For contacts with publish=No, if the protocol allows it, this
* method allows the contacts to see the local user's presence even
* though they have not requested it, changing their publish attribute
* from No to Yes. Otherwise, it merely records the fact that
* presence publication to those contacts is allowed; if any of
* those contacts ask to receive the local user's presence
* later in the lifetime of the connection, the connection SHOULD
* immediately allow them to do so, changing their publish
* attribute directly from No to Yes.</p>
*
* <div class="rationale">
* <p>This makes it easy to implement the common UI policy that if
* the user attempts to subscribe to a contact's presence, requests
* for reciprocal subscription are automatically approved.</p>
* </div>
*
* <p>Any state changes that immediately result from this request MUST
* be signalled via \endhtmlonly ContactsChanged() \htmlonly
* before this method returns.</p>
*
* <div class="rationale">
* <p>This makes it easy for user interfaces to see what practical
* effect this method had.</p>
* </div>
*
* <p>This method SHOULD NOT be called until the
* \endhtmlonly \link requestPropertyContactListState() ContactListState \endlink \htmlonly changes to Success.
* If the \endhtmlonly \link requestPropertyContactListState() ContactListState \endlink \htmlonly changes to
* Failure, this method SHOULD raise the same error as
* \endhtmlonly GetContactListAttributes() \htmlonly .</p>
* \endhtmlonly
*
* Note that \a timeout is ignored as of now. It will be used once
* http://bugreports.qt.nokia.com/browse/QTBUG-11775 is fixed.
*
*
* \param contacts
*
* \htmlonly
* <p>One or more contacts to authorize.</p>
* \endhtmlonly
* \param timeout The timeout in milliseconds.
*/
inline QDBusPendingReply<> AuthorizePublication(const Tp::UIntList& contacts, int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("AuthorizePublication"));
callMessage << QVariant::fromValue(contacts);
return this->connection().asyncCall(callMessage, timeout);
}
/**
* Begins a call to the D-Bus method \c RemoveContacts on the remote object.
*
* \htmlonly
* <p>Remove the given contacts from the contact list entirely. It is
* protocol-dependent whether this works, and under which
* circumstances.</p>
*
* <p>If possible, this method SHOULD set the contacts' subscribe and
* publish attributes to No, remove any stored aliases for those
* contacts, and remove the contacts from the result of
* \endhtmlonly GetContactListAttributes() \htmlonly .</p>
*
* <p>This method SHOULD succeed even if it was not possible to carry out
* the request entirely or for all contacts (for instance, if there is an
* outstanding request to subscribe to the contact's presence, and it's
* not possible to cancel such requests). However, all signals that
* immediately result from this method call MUST be emitted before it
* returns, so that clients can interpret the result.</p>
*
* <div class="rationale">
* <p>User interfaces removing a contact from the contact list are
* unlikely to want spurious failure notifications resulting from
* limitations of a particular protocol. However, emitting the
* signals first means that if a client does want to check exactly
* what happened, it can wait for the method to return (while
* applying change-notification signals to its local cache of the
* contact list's state), then consult its local cache of the
* contact list's state to see whether the contact is still there.</p>
* </div>
*
* <p>This method SHOULD NOT be called until the
* \endhtmlonly \link requestPropertyContactListState() ContactListState \endlink \htmlonly changes to Success.
* If the \endhtmlonly \link requestPropertyContactListState() ContactListState \endlink \htmlonly changes to
* Failure, this method SHOULD raise the same error as
* \endhtmlonly GetContactListAttributes() \htmlonly .</p>
* \endhtmlonly
*
* Note that \a timeout is ignored as of now. It will be used once
* http://bugreports.qt.nokia.com/browse/QTBUG-11775 is fixed.
*
*
* \param contacts
*
* \htmlonly
* <p>One or more contacts to remove.</p>
* \endhtmlonly
* \param timeout The timeout in milliseconds.
*/
inline QDBusPendingReply<> RemoveContacts(const Tp::UIntList& contacts, int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("RemoveContacts"));
callMessage << QVariant::fromValue(contacts);
return this->connection().asyncCall(callMessage, timeout);
}
/**
* Begins a call to the D-Bus method \c Unsubscribe on the remote object.
*
* \htmlonly
* <p>Attempt to set the given contacts' subscribe attribute to No,
* i.e. stop receiving their presence.</p>
*
* <p>For contacts with subscribe=Ask, this attempts to cancel
* an earlier request to subscribe to the contact's presence; for
* contacts with subscribe=Yes, this attempts to
* unsubscribe from the contact's presence.</p>
*
* <p>As with \endhtmlonly RemoveContacts() \htmlonly , this method
* SHOULD succeed even if it was not possible to carry out the request
* entirely or for all contacts; however, all signals that
* immediately result from this method call MUST be emitted before it
* returns.</p>
*
* <p>This method SHOULD NOT be called until the
* \endhtmlonly \link requestPropertyContactListState() ContactListState \endlink \htmlonly changes to Success.
* If the \endhtmlonly \link requestPropertyContactListState() ContactListState \endlink \htmlonly changes to
* Failure, this method SHOULD raise the same error as
* \endhtmlonly GetContactListAttributes() \htmlonly .</p>
* \endhtmlonly
*
* Note that \a timeout is ignored as of now. It will be used once
* http://bugreports.qt.nokia.com/browse/QTBUG-11775 is fixed.
*
*
* \param contacts
*
* \htmlonly
* <p>One or more contacts to remove.</p>
* \endhtmlonly
* \param timeout The timeout in milliseconds.
*/
inline QDBusPendingReply<> Unsubscribe(const Tp::UIntList& contacts, int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("Unsubscribe"));
callMessage << QVariant::fromValue(contacts);
return this->connection().asyncCall(callMessage, timeout);
}
/**
* Begins a call to the D-Bus method \c Unpublish on the remote object.
*
* \htmlonly
* <p>Attempt to set the given contacts' publish attribute to No,
* i.e. stop sending presence to them.</p>
*
* <p>For contacts with publish=Ask, this method explicitly rejects the
* contact's request to subscribe to the user's presence; for
* contacts with publish=Yes, this method attempts to prevent the
* user's presence from being received by the contact.</p>
*
* <p>As with \endhtmlonly RemoveContacts() \htmlonly , this method
* SHOULD succeed even if it was not possible to carry out the request
* entirely or for all contacts; however, all signals that
* immediately result from this method call MUST be emitted before it
* returns.</p>
*
* <p>This method SHOULD NOT be called until the
* \endhtmlonly \link requestPropertyContactListState() ContactListState \endlink \htmlonly changes to Success.
* If the \endhtmlonly \link requestPropertyContactListState() ContactListState \endlink \htmlonly changes to
* Failure, this method SHOULD raise the same error as
* \endhtmlonly GetContactListAttributes() \htmlonly .</p>
* \endhtmlonly
*
* Note that \a timeout is ignored as of now. It will be used once
* http://bugreports.qt.nokia.com/browse/QTBUG-11775 is fixed.
*
*
* \param contacts
*
* \htmlonly
* <p>One or more contacts to remove.</p>
* \endhtmlonly
* \param timeout The timeout in milliseconds.
*/
inline QDBusPendingReply<> Unpublish(const Tp::UIntList& contacts, int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("Unpublish"));
callMessage << QVariant::fromValue(contacts);
return this->connection().asyncCall(callMessage, timeout);
}
/**
* Begins a call to the D-Bus method \c Download on the remote object.
*
* \htmlonly
* <p>Download the contact list from the server. If
* \endhtmlonly \link requestPropertyDownloadAtConnection() DownloadAtConnection \endlink \htmlonly is true,
* Download does nothing.</p>
* \endhtmlonly
*
* Note that \a timeout is ignored as of now. It will be used once
* http://bugreports.qt.nokia.com/browse/QTBUG-11775 is fixed.
*
* \param timeout The timeout in milliseconds.
*/
inline QDBusPendingReply<> Download(int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("Download"));
return this->connection().asyncCall(callMessage, timeout);
}
Q_SIGNALS:
/**
* Represents the signal \c ContactListStateChanged on the remote object.
*
* Emitted when ContactListState changes.
*
* \param contactListState
*
* The new value of ContactListState.
*/
void ContactListStateChanged(uint contactListState);
/**
* Represents the signal \c ContactsChangedWithID on the remote object.
*
* \htmlonly
* <p>Emitted when the contact list becomes available, when contacts'
* basic stored properties change, when new contacts are added to the
* list that would be returned by
* \endhtmlonly GetContactListAttributes() \htmlonly ,
* or when contacts are removed from that list.</p>
*
* <div class="rationale">
* <p>This provides change notification for that list, and for
* contacts' <tp:token-ref>subscribe</tp:token-ref>,
* <tp:token-ref>publish</tp:token-ref> and
* <tp:token-ref>publish-request</tp:token-ref> attributes.</p>
* </div>
*
* <p>Connection managers SHOULD also emit this signal when a contact
* requests that the user's presence is published to them, even if
* that contact's <tp:token>publish</tp:token> attribute is already
* Ask and the <tp:token>publish-request</tp:token> has not changed.</p>
*
* <div class="rationale">
* <p>If the same contact sends 10 identical requests, 10 identical
* signals should be emitted.</p>
* </div>
* \endhtmlonly
*
* \param changes
*
* The new subscribe, publish and publish-request attributes of all
* the contacts that have been added, and all the contacts for which
* those attributes have changed.
*
* \param identifiers
*
* \htmlonly
* The identifiers of the contacts in the <var>Changes</var> map.
* \endhtmlonly
*
* \param removals
*
* \htmlonly
* The contacts that have been removed from the list that would be
* returned by
* \endhtmlonly GetContactListAttributes() \htmlonly .
* This also implies that they have subscribe = No and publish = No;
* contacts MUST NOT be listed both here and in <var>Changes</var>.
* \endhtmlonly
*/
void ContactsChangedWithID(const Tp::ContactSubscriptionMap& changes, const Tp::HandleIdentifierMap& identifiers, const Tp::HandleIdentifierMap& removals);
/**
* Represents the signal \c ContactsChanged on the remote object.
*
* \htmlonly
* <p>Emitted immediately after
* \endhtmlonly ContactsChangedWithID() \htmlonly , under the same
* circumstances.</p>
*
* <p>If clients receive this signal without first receiving a
* corresponding \endhtmlonly ContactsChangedWithID() \htmlonly ,
* they MUST assume that only this signal will be emitted.</p>
* \endhtmlonly
*
* \param changes
*
* The same as the corresponding argument to ContactsChangedWithID.
*
* \param removals
*
* The same as the corresponding argument to ContactsChangedWithID,
* except that it only includes handles and not identifiers.
*/
void ContactsChanged(const Tp::ContactSubscriptionMap& changes, const Tp::UIntList& removals);
protected:
virtual void invalidate(Tp::DBusProxy *, const QString &, const QString &);
};
/**
* \class ConnectionInterfaceContactsInterface
* \headerfile TelepathyQt/connection.h <TelepathyQt/Connection>
* \ingroup clientconn
*
* Proxy class providing a 1:1 mapping of the D-Bus interface "org.freedesktop.Telepathy.Connection.Interface.Contacts".
*/
class TP_QT_EXPORT ConnectionInterfaceContactsInterface : public Tp::AbstractInterface
{
Q_OBJECT
public:
/**
* Returns the name of the interface "org.freedesktop.Telepathy.Connection.Interface.Contacts", which this class
* represents.
*
* \return The D-Bus interface name.
*/
static inline QLatin1String staticInterfaceName()
{
return QLatin1String("org.freedesktop.Telepathy.Connection.Interface.Contacts");
}
/**
* Creates a ConnectionInterfaceContactsInterface associated with the given object on the session bus.
*
* \param busName Name of the service the object is on.
* \param objectPath Path to the object on the service.
* \param parent Passed to the parent class constructor.
*/
ConnectionInterfaceContactsInterface(
const QString& busName,
const QString& objectPath,
QObject* parent = 0
);
/**
* Creates a ConnectionInterfaceContactsInterface associated with the given object on the given bus.
*
* \param connection The bus via which the object can be reached.
* \param busName Name of the service the object is on.
* \param objectPath Path to the object on the service.
* \param parent Passed to the parent class constructor.
*/
ConnectionInterfaceContactsInterface(
const QDBusConnection& connection,
const QString& busName,
const QString& objectPath,
QObject* parent = 0
);
/**
* Creates a ConnectionInterfaceContactsInterface associated with the same object as the given proxy.
*
* \param proxy The proxy to use. It will also be the QObject::parent()
* for this object.
*/
ConnectionInterfaceContactsInterface(Tp::DBusProxy *proxy);
/**
* Creates a ConnectionInterfaceContactsInterface associated with the same object as the given proxy.
* Additionally, the created proxy will have the same parent as the given
* proxy.
*
* \param mainInterface The proxy to use.
*/
explicit ConnectionInterfaceContactsInterface(const Tp::Client::ConnectionInterface& mainInterface);
/**
* Creates a ConnectionInterfaceContactsInterface associated with the same object as the given proxy.
* However, a different parent object can be specified.
*
* \param mainInterface The proxy to use.
* \param parent Passed to the parent class constructor.
*/
ConnectionInterfaceContactsInterface(const Tp::Client::ConnectionInterface& mainInterface, QObject* parent);
/**
* Asynchronous getter for the remote object property \c ContactAttributeInterfaces of type \c QStringList.
*
*
* A list of D-Bus interfaces for which GetContactAttributes is expected
* to work. This cannot change during the lifetime of the Connection.
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyContactAttributeInterfaces() const
{
return internalRequestProperty(QLatin1String("ContactAttributeInterfaces"));
}
/**
* Request all of the DBus properties on the interface.
*
* \return A pending variant map which will emit finished when the properties have
* been retrieved.
*/
Tp::PendingVariantMap *requestAllProperties() const
{
return internalRequestAllProperties();
}
public Q_SLOTS:
/**
* Begins a call to the D-Bus method \c GetContactAttributes on the remote object.
*
* Return any number of contact attributes for the given handles.
*
* Note that \a timeout is ignored as of now. It will be used once
* http://bugreports.qt.nokia.com/browse/QTBUG-11775 is fixed.
*
*
* \param handles
*
* An array of handles representing contacts.
*
* \param interfaces
*
* \htmlonly
* <p>A list of strings indicating which D-Bus interfaces the calling
* process is interested in. All supported attributes from these
* interfaces, whose values can be obtained without additional network
* activity, will be in the reply.</p>
*
* <p>Connection managers SHOULD ignore interfaces requested which they
* do not support (i.e. those not mentioned in the
* \endhtmlonly \link requestPropertyContactAttributeInterfaces() ContactAttributeInterfaces \endlink \htmlonly
* property.)</p>
*
* <div class="rationale">
* <p>This simplifies client-side code. Clients which care may
* distinguish between unsupported interfaces (e.g. this Connection
* does not support Avatars), and interfaces on which no information
* is known for these contacts (e.g. we don't know the avatar tokens
* of any of the contacts, so we omitted them all) by inspecting
* \endhtmlonly \link requestPropertyContactAttributeInterfaces() ContactAttributeInterfaces \endlink \htmlonly .</p>
* </div>
*
* <p>Attributes from the interface
* \endhtmlonly ConnectionInterface \htmlonly
* are always returned, and need not be requested explicitly.</p>
*
* <p>As well as returning cached information immediately, the
* connection MAY start asynchronous requests to obtain better
* values for the contact attributes. If better values are later
* obtained by this process, they will be indicated with the usual
* signals (such as \endhtmlonly ConnectionInterfaceAliasingInterface::AliasesChanged() \htmlonly ).</p>
*
* <div class="rationale">
* For instance, an XMPP connection manager could download vCards
* in response to a request for \endhtmlonly ConnectionInterfaceAliasingInterface \htmlonly
* attributes.
* </div>
* \endhtmlonly
*
* \param hold
*
* \htmlonly
* <p>If true, all handles that appear as keys in the result have been
* held on behalf of the calling process, as if by a call to
* \endhtmlonly ConnectionInterface::HoldHandles() \htmlonly .
* (If \endhtmlonly \link ConnectionInterface::requestPropertyHasImmortalHandles() ConnectionInterface::HasImmortalHandles \endlink \htmlonly is true, which SHOULD be the
* case in all new connection managers, this has no effect.)</p>
*
* <div class="rationale">
* <p>For further round-trip avoidance.</p>
* </div>
* \endhtmlonly
* \param timeout The timeout in milliseconds.
*
* \return
*
* \htmlonly
* <p>A dictionary mapping the contact handles to contact attributes.
* If any of the requested handles are in fact invalid, they are
* simply omitted from this mapping. If contact attributes are not
* immediately known, the behaviour is defined by the interface;
* the attribute should either be omitted from the result or
* replaced with a default value.</p>
*
* <p>Each contact's attributes will always include at least the
* identifier that would be obtained by inspecting the handle
* (<code>org.freedesktop.Telepathy.Connection/contact-id</code>).</p>
* \endhtmlonly
*/
inline QDBusPendingReply<Tp::ContactAttributesMap> GetContactAttributes(const Tp::UIntList& handles, const QStringList& interfaces, bool hold, int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<Tp::ContactAttributesMap>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("GetContactAttributes"));
callMessage << QVariant::fromValue(handles) << QVariant::fromValue(interfaces) << QVariant::fromValue(hold);
return this->connection().asyncCall(callMessage, timeout);
}
protected:
virtual void invalidate(Tp::DBusProxy *, const QString &, const QString &);
};
/**
* \class ConnectionInterfaceLocationInterface
* \headerfile TelepathyQt/connection.h <TelepathyQt/Connection>
* \ingroup clientconn
*
* Proxy class providing a 1:1 mapping of the D-Bus interface "org.freedesktop.Telepathy.Connection.Interface.Location".
*/
class TP_QT_EXPORT ConnectionInterfaceLocationInterface : public Tp::AbstractInterface
{
Q_OBJECT
public:
/**
* Returns the name of the interface "org.freedesktop.Telepathy.Connection.Interface.Location", which this class
* represents.
*
* \return The D-Bus interface name.
*/
static inline QLatin1String staticInterfaceName()
{
return QLatin1String("org.freedesktop.Telepathy.Connection.Interface.Location");
}
/**
* Creates a ConnectionInterfaceLocationInterface associated with the given object on the session bus.
*
* \param busName Name of the service the object is on.
* \param objectPath Path to the object on the service.
* \param parent Passed to the parent class constructor.
*/
ConnectionInterfaceLocationInterface(
const QString& busName,
const QString& objectPath,
QObject* parent = 0
);
/**
* Creates a ConnectionInterfaceLocationInterface associated with the given object on the given bus.
*
* \param connection The bus via which the object can be reached.
* \param busName Name of the service the object is on.
* \param objectPath Path to the object on the service.
* \param parent Passed to the parent class constructor.
*/
ConnectionInterfaceLocationInterface(
const QDBusConnection& connection,
const QString& busName,
const QString& objectPath,
QObject* parent = 0
);
/**
* Creates a ConnectionInterfaceLocationInterface associated with the same object as the given proxy.
*
* \param proxy The proxy to use. It will also be the QObject::parent()
* for this object.
*/
ConnectionInterfaceLocationInterface(Tp::DBusProxy *proxy);
/**
* Creates a ConnectionInterfaceLocationInterface associated with the same object as the given proxy.
* Additionally, the created proxy will have the same parent as the given
* proxy.
*
* \param mainInterface The proxy to use.
*/
explicit ConnectionInterfaceLocationInterface(const Tp::Client::ConnectionInterface& mainInterface);
/**
* Creates a ConnectionInterfaceLocationInterface associated with the same object as the given proxy.
* However, a different parent object can be specified.
*
* \param mainInterface The proxy to use.
* \param parent Passed to the parent class constructor.
*/
ConnectionInterfaceLocationInterface(const Tp::Client::ConnectionInterface& mainInterface, QObject* parent);
/**
* Asynchronous getter for the remote object property \c LocationAccessControlTypes of type \c Tp::UIntList.
*
*
* The types of access control that are supported by this connection.
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyLocationAccessControlTypes() const
{
return internalRequestProperty(QLatin1String("LocationAccessControlTypes"));
}
/**
* Asynchronous getter for the remote object property \c LocationAccessControl of type \c Tp::RichPresenceAccessControl.
*
*
* The current access control mechanism and settings for this connection.
* Before publishing location for the first time, if this has not been set
* by a client, implementations SHOULD set it to be as restrictive as
* possible (an empty whitelist, if supported).
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyLocationAccessControl() const
{
return internalRequestProperty(QLatin1String("LocationAccessControl"));
}
/**
* Asynchronous setter for the remote object property \c LocationAccessControl of type \c Tp::RichPresenceAccessControl.
*
*
* The current access control mechanism and settings for this connection.
* Before publishing location for the first time, if this has not been set
* by a client, implementations SHOULD set it to be as restrictive as
* possible (an empty whitelist, if supported).
*
* \return A pending operation which will emit finished when the property has been
* set.
*/
inline Tp::PendingOperation *setPropertyLocationAccessControl(Tp::RichPresenceAccessControl newValue)
{
return internalSetProperty(QLatin1String("LocationAccessControl"), QVariant::fromValue(newValue));
}
/**
* Asynchronous getter for the remote object property \c SupportedLocationFeatures of type \c uint.
*
*
* \htmlonly
* Indicates the Location features supported by this connection. This
* property MAY be undefined before \endhtmlonly \link ConnectionInterface::requestPropertyStatus() ConnectionInterface::Status \endlink \htmlonly
* becomes <code>Connected</code>, but MUST remain constant thereafter.
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertySupportedLocationFeatures() const
{
return internalRequestProperty(QLatin1String("SupportedLocationFeatures"));
}
/**
* Request all of the DBus properties on the interface.
*
* \return A pending variant map which will emit finished when the properties have
* been retrieved.
*/
Tp::PendingVariantMap *requestAllProperties() const
{
return internalRequestAllProperties();
}
public Q_SLOTS:
/**
* Begins a call to the D-Bus method \c GetLocations on the remote object.
*
* \htmlonly
* <p>Return the current locations of the given contacts, if they are
* already known. If any of the given contacts' locations are not known,
* request their current locations, but return immediately without waiting
* for a reply; if a reply with a non-empty location is later received
* for those contacts, the \endhtmlonly LocationUpdated() \htmlonly
* signal will be emitted for them.</p>
*
* <div class="rationale">
* <p>This method is appropriate for "lazy" location finding, for instance
* displaying the location (if available) of everyone in your contact
* list.</p>
* </div>
*
* <p>For backwards compatibility, if this method is called by a client
* whose "interest count" for this interface, as defined by \endhtmlonly ConnectionInterface::AddClientInterest() \htmlonly , is zero, the
* Connection SHOULD behave as if AddClientInterest had been called for
* this interface just before that method call. Clients that do not
* explicitly call AddClientInterest SHOULD NOT call \endhtmlonly ConnectionInterface::RemoveClientInterest() \htmlonly either.</p>
* \endhtmlonly
*
* Note that \a timeout is ignored as of now. It will be used once
* http://bugreports.qt.nokia.com/browse/QTBUG-11775 is fixed.
*
*
* \param contacts
*
* The contacts whose locations should be returned or signalled.
* \param timeout The timeout in milliseconds.
*
* \return
*
* The contacts' locations, if already known. Contacts whose
* locations are not already known are omitted from the mapping;
* contacts known to have no location information appear in the
* mapping with an empty Location dictionary.
*/
inline QDBusPendingReply<Tp::ContactLocations> GetLocations(const Tp::UIntList& contacts, int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<Tp::ContactLocations>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("GetLocations"));
callMessage << QVariant::fromValue(contacts);
return this->connection().asyncCall(callMessage, timeout);
}
/**
* Begins a call to the D-Bus method \c RequestLocation on the remote object.
*
* Return the current location of the given contact. If necessary, make a
* request to the server for up-to-date information, and wait for a reply.
* This method is appropriate for use in a "Contact
* Information..." dialog; it can be used to show progress
* information (while waiting for the method to return), and can
* distinguish between various error conditions.
*
* Note that \a timeout is ignored as of now. It will be used once
* http://bugreports.qt.nokia.com/browse/QTBUG-11775 is fixed.
*
*
* \param contact
*
* The contact whose location should be returned.
* \param timeout The timeout in milliseconds.
*
* \return
*
* The contact's location. It MAY be empty, indicating that no
* location information was found.
*/
inline QDBusPendingReply<QVariantMap> RequestLocation(uint contact, int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<QVariantMap>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("RequestLocation"));
callMessage << QVariant::fromValue(contact);
return this->connection().asyncCall(callMessage, timeout);
}
/**
* Begins a call to the D-Bus method \c SetLocation on the remote object.
*
* Set the local user's own location.
*
* Note that \a timeout is ignored as of now. It will be used once
* http://bugreports.qt.nokia.com/browse/QTBUG-11775 is fixed.
*
*
* \param location
*
* The location to advertise. If the user wants to obscure their exact
* location by reducing the precision or accuracy, clients MUST do
* this themselves, rather than relying on the connection manager to
* do so. Clients that interact with more than one connection SHOULD
* advertise the same reduced-accuracy location to all of them, so
* that contacts cannot obtain an undesirably accurate location by
* assuming that random errors have been added and averaging the
* locations advertised on multiple connections.
* \param timeout The timeout in milliseconds.
*/
inline QDBusPendingReply<> SetLocation(const QVariantMap& location, int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("SetLocation"));
callMessage << QVariant::fromValue(location);
return this->connection().asyncCall(callMessage, timeout);
}
Q_SIGNALS:
/**
* Represents the signal \c LocationUpdated on the remote object.
*
* Emitted when a contact's location changes or becomes known.
*
* \param contact
*
* The contact
*
* \param location
*
* The contact's location, or empty to indicate that nothing is
* known about the contact's location.
*/
void LocationUpdated(uint contact, const QVariantMap& location);
protected:
virtual void invalidate(Tp::DBusProxy *, const QString &, const QString &);
};
/**
* \class ConnectionInterfaceMailNotificationInterface
* \headerfile TelepathyQt/connection.h <TelepathyQt/Connection>
* \ingroup clientconn
*
* Proxy class providing a 1:1 mapping of the D-Bus interface "org.freedesktop.Telepathy.Connection.Interface.MailNotification".
*/
class TP_QT_EXPORT ConnectionInterfaceMailNotificationInterface : public Tp::AbstractInterface
{
Q_OBJECT
public:
/**
* Returns the name of the interface "org.freedesktop.Telepathy.Connection.Interface.MailNotification", which this class
* represents.
*
* \return The D-Bus interface name.
*/
static inline QLatin1String staticInterfaceName()
{
return QLatin1String("org.freedesktop.Telepathy.Connection.Interface.MailNotification");
}
/**
* Creates a ConnectionInterfaceMailNotificationInterface associated with the given object on the session bus.
*
* \param busName Name of the service the object is on.
* \param objectPath Path to the object on the service.
* \param parent Passed to the parent class constructor.
*/
ConnectionInterfaceMailNotificationInterface(
const QString& busName,
const QString& objectPath,
QObject* parent = 0
);
/**
* Creates a ConnectionInterfaceMailNotificationInterface associated with the given object on the given bus.
*
* \param connection The bus via which the object can be reached.
* \param busName Name of the service the object is on.
* \param objectPath Path to the object on the service.
* \param parent Passed to the parent class constructor.
*/
ConnectionInterfaceMailNotificationInterface(
const QDBusConnection& connection,
const QString& busName,
const QString& objectPath,
QObject* parent = 0
);
/**
* Creates a ConnectionInterfaceMailNotificationInterface associated with the same object as the given proxy.
*
* \param proxy The proxy to use. It will also be the QObject::parent()
* for this object.
*/
ConnectionInterfaceMailNotificationInterface(Tp::DBusProxy *proxy);
/**
* Creates a ConnectionInterfaceMailNotificationInterface associated with the same object as the given proxy.
* Additionally, the created proxy will have the same parent as the given
* proxy.
*
* \param mainInterface The proxy to use.
*/
explicit ConnectionInterfaceMailNotificationInterface(const Tp::Client::ConnectionInterface& mainInterface);
/**
* Creates a ConnectionInterfaceMailNotificationInterface associated with the same object as the given proxy.
* However, a different parent object can be specified.
*
* \param mainInterface The proxy to use.
* \param parent Passed to the parent class constructor.
*/
ConnectionInterfaceMailNotificationInterface(const Tp::Client::ConnectionInterface& mainInterface, QObject* parent);
/**
* Asynchronous getter for the remote object property \c MailNotificationFlags of type \c uint.
*
*
* Integer representing the bitwise-OR of supported features for e-mails
* notification on this server. This property MUST NOT change after the
* Connection becomes CONNECTED. This property indicates the behavior and
* availability of the other properties and signals within this interface.
* A connection manager that cannot at least set one of the flags in the
* Mail_Notification_Flags SHOULD NOT provide this interface.
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyMailNotificationFlags() const
{
return internalRequestProperty(QLatin1String("MailNotificationFlags"));
}
/**
* Asynchronous getter for the remote object property \c UnreadMailCount of type \c uint.
*
*
* \htmlonly
* <p>The number of unread messages in the Inbox. Change notification is
* via \endhtmlonly UnreadMailsChanged() \htmlonly .</p>
*
* <p>This property is only useful if <tt>Supports_Unread_Mail_Count</tt>
* is set in the \endhtmlonly \link requestPropertyMailNotificationFlags() MailNotificationFlags \endlink \htmlonly ;
* otherwise, it MUST be zero.</p>
*
* <p>If <tt>Thread_Based</tt> appears in the
* \endhtmlonly \link requestPropertyMailNotificationFlags() MailNotificationFlags \endlink \htmlonly , this property
* counts the number of threads, not the number of mails.</p>
*
* <p>Note that this count MAY be bigger than the number of items in
* \endhtmlonly \link requestPropertyUnreadMails() UnreadMails \endlink \htmlonly . See
* \endhtmlonly \link requestPropertyUnreadMails() UnreadMails \endlink \htmlonly for more details.</p>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyUnreadMailCount() const
{
return internalRequestProperty(QLatin1String("UnreadMailCount"));
}
/**
* Asynchronous getter for the remote object property \c UnreadMails of type \c Tp::MailList.
*
*
* An array of unread Mails. Change notification is via
* UnreadMailsChanged. This property is only useful if
* Supports_Unread_Mails is set in MailNotificationFlags; otherwise, it
* MUST be an empty list. The array size MAY be shorter than
* UnreadMailCount. Some servers may limits the amount of detailed e-mails
* sent. This can significantly reduce the network traffic for large
* inbox. For this reason, it is normal that UnreadMailCount be bigger or
* equal to the size of this array.
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyUnreadMails() const
{
return internalRequestProperty(QLatin1String("UnreadMails"));
}
/**
* Asynchronous getter for the remote object property \c MailAddress of type \c QString.
*
*
* A string representing the e-mail address of the account. The CMs MUST
* provide this information. In close integration of MailNotification with
* other e-mail services, the e-mail address can be used has a unique
* identifier for the account. Possible integration could be between
* Telepathy and Evolution where the e-mail address is the common
* information in both interfaces.
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyMailAddress() const
{
return internalRequestProperty(QLatin1String("MailAddress"));
}
/**
* Request all of the DBus properties on the interface.
*
* \return A pending variant map which will emit finished when the properties have
* been retrieved.
*/
Tp::PendingVariantMap *requestAllProperties() const
{
return internalRequestAllProperties();
}
public Q_SLOTS:
/**
* Begins a call to the D-Bus method \c RequestInboxURL on the remote object.
*
* This method creates and returns a URL and an optional POST data that
* allow opening the Inbox folder of a webmail account. This URL MAY
* contain tokens with a short lifetime, so clients SHOULD request a new
* URL for each visit to the webmail interface. This method is implemented
* only if the Supports_Request_Inbox_URL flag is set in
* MailNotificationFlags. We are not using properties here because the
* tokens are unsuitable for sharing between clients, and network
* round-trips may be required to obtain the information that leads to
* authentication free webmail access.
*
* Note that \a timeout is ignored as of now. It will be used once
* http://bugreports.qt.nokia.com/browse/QTBUG-11775 is fixed.
*
* \param timeout The timeout in milliseconds.
*
* \return
*
* A struture containing a URL and optional additional data to open a
* webmail client, without re-authentication if possible.
*/
inline QDBusPendingReply<Tp::MailURL> RequestInboxURL(int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<Tp::MailURL>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("RequestInboxURL"));
return this->connection().asyncCall(callMessage, timeout);
}
/**
* Begins a call to the D-Bus method \c RequestMailURL on the remote object.
*
* This method creates and returns a URL and optional POST data that allow
* opening a specific mail in a webmail interface. This method is
* implemented only if Supports_Request_Mail_URL flag is set in
* MailNotificationFlags. See RequestInboxURL for design rationale.
*
* Note that \a timeout is ignored as of now. It will be used once
* http://bugreports.qt.nokia.com/browse/QTBUG-11775 is fixed.
*
*
* \param ID
*
* The mail's id as found in the Mail structure, or the empty
* string if no id key was provided.
*
* \param URLData
*
* Whatever url-data was found in the Mail structure, or the boolean
* value False (D-Bus type 'b') if no url-data was provided
* in the Mail.
* \param timeout The timeout in milliseconds.
*
* \return
*
* A struture that contains a URL and optional additional data to open
* a webmail client, without re-authentication if possible.
*/
inline QDBusPendingReply<Tp::MailURL> RequestMailURL(const QString& ID, const QDBusVariant& URLData, int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<Tp::MailURL>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("RequestMailURL"));
callMessage << QVariant::fromValue(ID) << QVariant::fromValue(URLData);
return this->connection().asyncCall(callMessage, timeout);
}
Q_SIGNALS:
/**
* Represents the signal \c MailsReceived on the remote object.
*
* Emitted when new e-mails messages arrive to the inbox associated with
* this connection. This signal is used for protocols that are not able to
* maintain the UnreadMails list, but do provide real-time notification
* about newly arrived e-mails. It MUST NOT be emitted unless
* Emits_Mails_Received is set in MailNotificationFlags.
*
* \param mails
*
* \htmlonly
* <p>An array of <tp:type>Mail</tp:type>s. Those e-mail MUST NOT have
* the "id" key.</p>
*
* <div class="rationale">
* <p>On connections that emit this signal, it's impossible to tell
* when a mail has been removed, and hence when "id" has become
* invalid.</p>
* </div>
* \endhtmlonly
*/
void MailsReceived(const Tp::MailList& mails);
/**
* Represents the signal \c UnreadMailsChanged on the remote object.
*
* \htmlonly
* <p>Emitted when \endhtmlonly \link requestPropertyUnreadMails() UnreadMails \endlink \htmlonly or
* \endhtmlonly \link requestPropertyUnreadMailCount() UnreadMailCount \endlink \htmlonly have changed. It MUST
* NOT be emited if <tt>Supports_Unread_Mail_Count</tt> flag is not set
* in \endhtmlonly \link requestPropertyMailNotificationFlags() MailNotificationFlags \endlink \htmlonly .</p>
*
* <p><tt>Mails_Added</tt> and
* <tt>Mails_Removed</tt> MUST be empty if the
* <tt>Supports_Unread_Mails</tt> flag is not set.</p>
* \endhtmlonly
*
* \param count
*
* Number of unread messages in the inbox (the new value of
* UnreadMailCount).
*
* \param mailsAdded
*
* \htmlonly
* <p>A list of <tp:type>Mail</tp:type> that are being added or updated
* in \endhtmlonly \link requestPropertyUnreadMails() UnreadMails \endlink \htmlonly .</p>
*
* <div class="rationale">
* <p>Mails may be updated when the URL information (URL and POST data)
* have changed, or senders were added or removed from an e-mail
* thread.</p>
* </div>
*
* <p>If the <tt>Supports_Unread_Mails</tt> flag is not set, this list
* MUST be empty, even if Count has increased.</p>
* \endhtmlonly
*
* \param mailsRemoved
*
* A list of e-mail IDs that are being removed from UnreadMails. If
* the Supports_Unread_Mails flag is not set, this list MUST be empty,
* even if Count has decreased.
*/
void UnreadMailsChanged(uint count, const Tp::MailList& mailsAdded, const QStringList& mailsRemoved);
protected:
virtual void invalidate(Tp::DBusProxy *, const QString &, const QString &);
};
/**
* \class ConnectionInterfacePowerSavingInterface
* \headerfile TelepathyQt/connection.h <TelepathyQt/Connection>
* \ingroup clientconn
*
* Proxy class providing a 1:1 mapping of the D-Bus interface "org.freedesktop.Telepathy.Connection.Interface.PowerSaving".
*/
class TP_QT_EXPORT ConnectionInterfacePowerSavingInterface : public Tp::AbstractInterface
{
Q_OBJECT
public:
/**
* Returns the name of the interface "org.freedesktop.Telepathy.Connection.Interface.PowerSaving", which this class
* represents.
*
* \return The D-Bus interface name.
*/
static inline QLatin1String staticInterfaceName()
{
return QLatin1String("org.freedesktop.Telepathy.Connection.Interface.PowerSaving");
}
/**
* Creates a ConnectionInterfacePowerSavingInterface associated with the given object on the session bus.
*
* \param busName Name of the service the object is on.
* \param objectPath Path to the object on the service.
* \param parent Passed to the parent class constructor.
*/
ConnectionInterfacePowerSavingInterface(
const QString& busName,
const QString& objectPath,
QObject* parent = 0
);
/**
* Creates a ConnectionInterfacePowerSavingInterface associated with the given object on the given bus.
*
* \param connection The bus via which the object can be reached.
* \param busName Name of the service the object is on.
* \param objectPath Path to the object on the service.
* \param parent Passed to the parent class constructor.
*/
ConnectionInterfacePowerSavingInterface(
const QDBusConnection& connection,
const QString& busName,
const QString& objectPath,
QObject* parent = 0
);
/**
* Creates a ConnectionInterfacePowerSavingInterface associated with the same object as the given proxy.
*
* \param proxy The proxy to use. It will also be the QObject::parent()
* for this object.
*/
ConnectionInterfacePowerSavingInterface(Tp::DBusProxy *proxy);
/**
* Creates a ConnectionInterfacePowerSavingInterface associated with the same object as the given proxy.
* Additionally, the created proxy will have the same parent as the given
* proxy.
*
* \param mainInterface The proxy to use.
*/
explicit ConnectionInterfacePowerSavingInterface(const Tp::Client::ConnectionInterface& mainInterface);
/**
* Creates a ConnectionInterfacePowerSavingInterface associated with the same object as the given proxy.
* However, a different parent object can be specified.
*
* \param mainInterface The proxy to use.
* \param parent Passed to the parent class constructor.
*/
ConnectionInterfacePowerSavingInterface(const Tp::Client::ConnectionInterface& mainInterface, QObject* parent);
/**
* Asynchronous getter for the remote object property \c PowerSavingActive of type \c bool.
*
*
* \htmlonly
* <p><code>True</code> if protocol-level power saving features are
* currently activated. This property can be changed using the
* \endhtmlonly SetPowerSaving() \htmlonly method; change
* notifications is via the
* \endhtmlonly PowerSavingChanged() \htmlonly signal.</p>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyPowerSavingActive() const
{
return internalRequestProperty(QLatin1String("PowerSavingActive"));
}
/**
* Request all of the DBus properties on the interface.
*
* \return A pending variant map which will emit finished when the properties have
* been retrieved.
*/
Tp::PendingVariantMap *requestAllProperties() const
{
return internalRequestAllProperties();
}
public Q_SLOTS:
/**
* Begins a call to the D-Bus method \c SetPowerSaving on the remote object.
*
* \htmlonly
* <p>Turn power saving mode on or off.</p>
*
* <div class="rationale">
* <p>Depending on the device's activity level, the
* connection can have its power saving mode turned on or off.</p>
* </div>
*
* <p>Errors raised by this method indicate that power saving could not be
* enabled, which SHOULD NOT generally be treated as fatal.</p>
*
* <div class="rationale">
* If the CM cannot switch modes, either because of the
* protocol (<code>NotImplemented</code>), or because of the service
* (<code>NotAvailable</code>), Mission Control (or whoever manages this)
* should be made aware. The error could be ignored or, in the extreme,
* be fascist and disconnect the account.
* </div>
* \endhtmlonly
*
* Note that \a timeout is ignored as of now. It will be used once
* http://bugreports.qt.nokia.com/browse/QTBUG-11775 is fixed.
*
*
* \param activate
*
* True if protocol-level power saving features should be activated;
* False if they should be de-activated.
* \param timeout The timeout in milliseconds.
*/
inline QDBusPendingReply<> SetPowerSaving(bool activate, int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("SetPowerSaving"));
callMessage << QVariant::fromValue(activate);
return this->connection().asyncCall(callMessage, timeout);
}
Q_SIGNALS:
/**
* Represents the signal \c PowerSavingChanged on the remote object.
*
* \htmlonly
* The \endhtmlonly \link requestPropertyPowerSavingActive() PowerSavingActive \endlink \htmlonly
* property changed.
* \endhtmlonly
*
* \param active
*
* The new state of the power saving feature.
*/
void PowerSavingChanged(bool active);
protected:
virtual void invalidate(Tp::DBusProxy *, const QString &, const QString &);
};
/**
* \class ConnectionInterfacePresenceInterface
* \headerfile TelepathyQt/connection.h <TelepathyQt/Connection>
* \ingroup clientconn
*
* Proxy class providing a 1:1 mapping of the D-Bus interface "org.freedesktop.Telepathy.Connection.Interface.Presence".
*/
class TP_QT_EXPORT ConnectionInterfacePresenceInterface : public Tp::AbstractInterface
{
Q_OBJECT
public:
/**
* Returns the name of the interface "org.freedesktop.Telepathy.Connection.Interface.Presence", which this class
* represents.
*
* \return The D-Bus interface name.
*/
static inline QLatin1String staticInterfaceName()
{
return QLatin1String("org.freedesktop.Telepathy.Connection.Interface.Presence");
}
/**
* Creates a ConnectionInterfacePresenceInterface associated with the given object on the session bus.
*
* \param busName Name of the service the object is on.
* \param objectPath Path to the object on the service.
* \param parent Passed to the parent class constructor.
*/
ConnectionInterfacePresenceInterface(
const QString& busName,
const QString& objectPath,
QObject* parent = 0
);
/**
* Creates a ConnectionInterfacePresenceInterface associated with the given object on the given bus.
*
* \param connection The bus via which the object can be reached.
* \param busName Name of the service the object is on.
* \param objectPath Path to the object on the service.
* \param parent Passed to the parent class constructor.
*/
ConnectionInterfacePresenceInterface(
const QDBusConnection& connection,
const QString& busName,
const QString& objectPath,
QObject* parent = 0
);
/**
* Creates a ConnectionInterfacePresenceInterface associated with the same object as the given proxy.
*
* \param proxy The proxy to use. It will also be the QObject::parent()
* for this object.
*/
ConnectionInterfacePresenceInterface(Tp::DBusProxy *proxy);
/**
* Creates a ConnectionInterfacePresenceInterface associated with the same object as the given proxy.
* Additionally, the created proxy will have the same parent as the given
* proxy.
*
* \param mainInterface The proxy to use.
*/
explicit ConnectionInterfacePresenceInterface(const Tp::Client::ConnectionInterface& mainInterface);
/**
* Creates a ConnectionInterfacePresenceInterface associated with the same object as the given proxy.
* However, a different parent object can be specified.
*
* \param mainInterface The proxy to use.
* \param parent Passed to the parent class constructor.
*/
ConnectionInterfacePresenceInterface(const Tp::Client::ConnectionInterface& mainInterface, QObject* parent);
/**
* Request all of the DBus properties on the interface.
*
* \return A pending variant map which will emit finished when the properties have
* been retrieved.
*/
Tp::PendingVariantMap *requestAllProperties() const
{
return internalRequestAllProperties();
}
public Q_SLOTS:
/**
* Begins a call to the D-Bus method \c AddStatus on the remote object.
*
* Request that a single presence status is published for the user, along
* with any desired parameters. Changes will be indicated by
* PresenceUpdate signals being emitted.
*
* Note that \a timeout is ignored as of now. It will be used once
* http://bugreports.qt.nokia.com/browse/QTBUG-11775 is fixed.
*
*
* \param status
*
* The string identifier of the desired status
*
* \param parameters
*
* A dictionary of optional parameter names mapped to their
* variant-boxed values
* \param timeout The timeout in milliseconds.
*/
inline QDBusPendingReply<> AddStatus(const QString& status, const QVariantMap& parameters, int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("AddStatus"));
callMessage << QVariant::fromValue(status) << QVariant::fromValue(parameters);
return this->connection().asyncCall(callMessage, timeout);
}
/**
* Begins a call to the D-Bus method \c ClearStatus on the remote object.
*
* Request that all of a user's presence statuses be removed. Be
* aware that this request may simply result in the statuses being
* replaced by a default available status. Changes will be indicated by
* PresenceUpdate signals being emitted.
*
* Note that \a timeout is ignored as of now. It will be used once
* http://bugreports.qt.nokia.com/browse/QTBUG-11775 is fixed.
*
* \param timeout The timeout in milliseconds.
*/
inline QDBusPendingReply<> ClearStatus(int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("ClearStatus"));
return this->connection().asyncCall(callMessage, timeout);
}
/**
* Begins a call to the D-Bus method \c GetPresence on the remote object.
*
* Get presence previously emitted by PresenceUpdate for the given
* contacts. Data is returned in the same structure as the PresenceUpdate
* signal. Using this method in favour of RequestPresence has the
* advantage that it will not wake up each client connected to the
* PresenceUpdate signal.
*
* Note that \a timeout is ignored as of now. It will be used once
* http://bugreports.qt.nokia.com/browse/QTBUG-11775 is fixed.
*
*
* \param contacts
*
* An array of the contacts whose presence should be obtained
* \param timeout The timeout in milliseconds.
*
* \return
*
* Presence information in the same format as for the PresenceUpdate
* signal
*/
inline QDBusPendingReply<Tp::ContactPresences> GetPresence(const Tp::UIntList& contacts, int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<Tp::ContactPresences>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("GetPresence"));
callMessage << QVariant::fromValue(contacts);
return this->connection().asyncCall(callMessage, timeout);
}
/**
* Begins a call to the D-Bus method \c GetStatuses on the remote object.
*
* Get a dictionary of the valid presence statuses for this connection.
* This is only available when online because only some statuses will be
* available on some servers.
*
* Note that \a timeout is ignored as of now. It will be used once
* http://bugreports.qt.nokia.com/browse/QTBUG-11775 is fixed.
*
* \param timeout The timeout in milliseconds.
*
* \return
*
* A dictionary of string identifiers mapped to a struct for each
* status, containing: a type value from one of the values above a
* boolean to indicate if this status may be set on yourself a boolean
* to indicate if this is an exclusive status which you may not set
* alongside any other a dictionary of valid optional string argument
* names mapped to their types
*/
inline QDBusPendingReply<Tp::StatusSpecMap> GetStatuses(int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<Tp::StatusSpecMap>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("GetStatuses"));
return this->connection().asyncCall(callMessage, timeout);
}
/**
* Begins a call to the D-Bus method \c RemoveStatus on the remote object.
*
* Request that the given presence status is no longer published for the
* user. Changes will be indicated by PresenceUpdate signals being
* emitted. As with ClearStatus, removing a status may actually result in
* it being replaced by a default available status.
*
* Note that \a timeout is ignored as of now. It will be used once
* http://bugreports.qt.nokia.com/browse/QTBUG-11775 is fixed.
*
*
* \param status
*
* The string identifier of the status not to publish anymore for the
* user
* \param timeout The timeout in milliseconds.
*/
inline QDBusPendingReply<> RemoveStatus(const QString& status, int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("RemoveStatus"));
callMessage << QVariant::fromValue(status);
return this->connection().asyncCall(callMessage, timeout);
}
/**
* Begins a call to the D-Bus method \c RequestPresence on the remote object.
*
* Request the presence for contacts on this connection. A PresenceUpdate
* signal will be emitted when they are received. This is not the same as
* subscribing to the presence of a contact, which must be done using the
* 'subscription' ContactList, and on some protocols presence
* information may not be available unless a subscription exists.
*
* Note that \a timeout is ignored as of now. It will be used once
* http://bugreports.qt.nokia.com/browse/QTBUG-11775 is fixed.
*
*
* \param contacts
*
* An array of the contacts whose presence should be obtained
* \param timeout The timeout in milliseconds.
*/
inline QDBusPendingReply<> RequestPresence(const Tp::UIntList& contacts, int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("RequestPresence"));
callMessage << QVariant::fromValue(contacts);
return this->connection().asyncCall(callMessage, timeout);
}
/**
* Begins a call to the D-Bus method \c SetLastActivityTime on the remote object.
*
* Request that the recorded last activity time for the user be updated on
* the server.
*
* Note that \a timeout is ignored as of now. It will be used once
* http://bugreports.qt.nokia.com/browse/QTBUG-11775 is fixed.
*
*
* \param time
*
* A UNIX timestamp of the user's last activity time (in UTC)
* \param timeout The timeout in milliseconds.
*/
inline QDBusPendingReply<> SetLastActivityTime(uint time, int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("SetLastActivityTime"));
callMessage << QVariant::fromValue(time);
return this->connection().asyncCall(callMessage, timeout);
}
/**
* Begins a call to the D-Bus method \c SetStatus on the remote object.
*
* \htmlonly
* <p>Request that the user's presence be changed to the given statuses
* and desired parameters. Changes will be reflected by
* \endhtmlonly PresenceUpdate() \htmlonly
* signals being emitted.</p>
*
* <p>Statuses whose <tp:type>Connection_Presence_Type</tp:type>
* is Offline, Error or Unknown MUST NOT be passed to this
* function. Connection managers SHOULD reject these statuses.</p>
*
* <div class="rationale">
* <p>The same rationale as for \endhtmlonly ConnectionInterfaceSimplePresenceInterface::SetPresence() \htmlonly
* applies.</p>
* </div>
*
* <p>On certain protocols, this method may be
* called on a newly-created connection which is still in the
* DISCONNECTED state, and will sign on with the requested status.
* If the requested status is not available after signing on,
* NotAvailable will be returned and the connection will remain
* offline, or if the protocol does not support signing on with
* a certain status, Disconnected will be returned.</p>
* \endhtmlonly
*
* Note that \a timeout is ignored as of now. It will be used once
* http://bugreports.qt.nokia.com/browse/QTBUG-11775 is fixed.
*
*
* \param statuses
*
* A dictionary mapping status identifiers to dictionaries, which map
* optional parameter names to their variant-boxed values
* \param timeout The timeout in milliseconds.
*/
inline QDBusPendingReply<> SetStatus(const Tp::MultipleStatusMap& statuses, int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("SetStatus"));
callMessage << QVariant::fromValue(statuses);
return this->connection().asyncCall(callMessage, timeout);
}
Q_SIGNALS:
/**
* Represents the signal \c PresenceUpdate on the remote object.
*
* This signal should be emitted when your own presence has been changed,
* or the presence of the member of any of the connection's channels
* has been changed, or when the presence requested by RequestPresence is
* available.
*
* \param presence
*
* A dictionary of contact handles mapped to a struct containing a
* UNIX timestamp of the last activity time (in UTC), and a dictionary
* mapping the contact's current status identifiers to a
* dictionary of optional parameter names mapped to their
* variant-boxed values
*/
void PresenceUpdate(const Tp::ContactPresences& presence);
protected:
virtual void invalidate(Tp::DBusProxy *, const QString &, const QString &);
};
/**
* \class ConnectionInterfaceRequestsInterface
* \headerfile TelepathyQt/connection.h <TelepathyQt/Connection>
* \ingroup clientconn
*
* Proxy class providing a 1:1 mapping of the D-Bus interface "org.freedesktop.Telepathy.Connection.Interface.Requests".
*/
class TP_QT_EXPORT ConnectionInterfaceRequestsInterface : public Tp::AbstractInterface
{
Q_OBJECT
public:
/**
* Returns the name of the interface "org.freedesktop.Telepathy.Connection.Interface.Requests", which this class
* represents.
*
* \return The D-Bus interface name.
*/
static inline QLatin1String staticInterfaceName()
{
return QLatin1String("org.freedesktop.Telepathy.Connection.Interface.Requests");
}
/**
* Creates a ConnectionInterfaceRequestsInterface associated with the given object on the session bus.
*
* \param busName Name of the service the object is on.
* \param objectPath Path to the object on the service.
* \param parent Passed to the parent class constructor.
*/
ConnectionInterfaceRequestsInterface(
const QString& busName,
const QString& objectPath,
QObject* parent = 0
);
/**
* Creates a ConnectionInterfaceRequestsInterface associated with the given object on the given bus.
*
* \param connection The bus via which the object can be reached.
* \param busName Name of the service the object is on.
* \param objectPath Path to the object on the service.
* \param parent Passed to the parent class constructor.
*/
ConnectionInterfaceRequestsInterface(
const QDBusConnection& connection,
const QString& busName,
const QString& objectPath,
QObject* parent = 0
);
/**
* Creates a ConnectionInterfaceRequestsInterface associated with the same object as the given proxy.
*
* \param proxy The proxy to use. It will also be the QObject::parent()
* for this object.
*/
ConnectionInterfaceRequestsInterface(Tp::DBusProxy *proxy);
/**
* Creates a ConnectionInterfaceRequestsInterface associated with the same object as the given proxy.
* Additionally, the created proxy will have the same parent as the given
* proxy.
*
* \param mainInterface The proxy to use.
*/
explicit ConnectionInterfaceRequestsInterface(const Tp::Client::ConnectionInterface& mainInterface);
/**
* Creates a ConnectionInterfaceRequestsInterface associated with the same object as the given proxy.
* However, a different parent object can be specified.
*
* \param mainInterface The proxy to use.
* \param parent Passed to the parent class constructor.
*/
ConnectionInterfaceRequestsInterface(const Tp::Client::ConnectionInterface& mainInterface, QObject* parent);
/**
* Asynchronous getter for the remote object property \c Channels of type \c Tp::ChannelDetailsList.
*
*
* A list of all the channels which currently exist on this connection.
* Change notification is via the NewChannels and ChannelClosed signals.
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyChannels() const
{
return internalRequestProperty(QLatin1String("Channels"));
}
/**
* Asynchronous getter for the remote object property \c RequestableChannelClasses of type \c Tp::RequestableChannelClassList.
*
*
* \htmlonly
* <p>The classes of channel that are expected to be available on this
* connection, i.e. those for which
* \endhtmlonly CreateChannel() \htmlonly can reasonably
* be expected to succeed. User interfaces can use this information
* to show or hide UI components.</p>
*
* <p>This property cannot change after the connection has gone to
* state Connection_Status_Connected, so there is no change
* notification (if the connection has context-dependent capabilities,
* it SHOULD advertise support for all classes of channel that it might
* support during its lifetime). Before this state has been reached,
* the value of this property is undefined.</p>
*
* <div class="rationale">
* <p>This is not on an optional interface, because connection
* managers can always offer some sort of clue about the channel
* classes they expect to support (at worst, they can announce
* support for everything for which they have code).</p>
* </div>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyRequestableChannelClasses() const
{
return internalRequestProperty(QLatin1String("RequestableChannelClasses"));
}
/**
* Request all of the DBus properties on the interface.
*
* \return A pending variant map which will emit finished when the properties have
* been retrieved.
*/
Tp::PendingVariantMap *requestAllProperties() const
{
return internalRequestAllProperties();
}
public Q_SLOTS:
/**
* Begins a call to the D-Bus method \c CreateChannel on the remote object.
*
* \htmlonly
* <p>Request that an entirely new channel is created.</p>
*
* <div class="rationale">
* <p>There is deliberately no flag corresponding to the
* suppress_handler argument to
* \endhtmlonly ConnectionInterface::RequestChannel() \htmlonly ,
* because passing a FALSE value for that argument is deprecated.
* Requests made using this interface always behave as though
* suppress_handler was TRUE.</p>
* </div>
* \endhtmlonly
*
* Note that \a timeout is ignored as of now. It will be used once
* http://bugreports.qt.nokia.com/browse/QTBUG-11775 is fixed.
*
*
* \param request
*
* \htmlonly
* <p>A dictionary containing desirable properties, which MUST include
* \endhtmlonly \link ChannelInterface::requestPropertyChannelType() ChannelInterface::ChannelType \endlink \htmlonly .
* Some properties
* are defined such that only an exact match makes sense, and
* connection managers MUST NOT satisfy a request with a channel
* where that property does not match; some properties are defined
* such that the connection manager MAY treat the request as merely
* a hint, and make a best-effort attempt to satisfy it. This is
* documented separately for each property.</p>
*
* <p>If this dictionary contains a property whose semantics
* are not known to the connection manager, this method MUST fail
* without side-effects (in particular it must not create a new
* channel).</p>
*
* <div class="rationale">
* <p>This is necessary if we want to be able to invent properties
* in future that, when used in a request, are hard requirements
* rather than just hints. A connection manager that did not know
* the semantics of those properties could incorrectly return a
* new channel that did not satisfy the requirements.</p>
* </div>
*
* <p>The connection manager MUST NOT respond successfully,
* and SHOULD NOT create a new channel or cause any other
* side-effects, unless it can create a new channel that satisfies
* the client's requirements.</p>
*
* <p>Properties that will be set by this argument need not have write
* access after the channel has been created - indeed, it is
* expected that most will be read-only.</p>
* \endhtmlonly
* \param timeout The timeout in milliseconds.
*
* \return
*
* \htmlonly
* <p>The Channel object, which MUST NOT be signalled with
* \endhtmlonly NewChannels() \htmlonly until after this method
* returns.</p>
*
* <div class="rationale">
* <p>This allows the requester to alter its handling of
* NewChannels by knowing whether one of the channels satisfied
* a request it made.</p>
* </div>
* \endhtmlonly
*
* \return
*
* \htmlonly
* <p>Properties of the channel that was produced, equivalent to
* the properties in <tp:type>Channel_Details</tp:type>.
* Connection managers MUST NOT include properties here whose
* values can change, for the same reasons as in
* <tp:type>Channel_Details</tp:type>.</p>
* \endhtmlonly
*/
inline QDBusPendingReply<QDBusObjectPath, QVariantMap> CreateChannel(const QVariantMap& request, int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<QDBusObjectPath, QVariantMap>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("CreateChannel"));
callMessage << QVariant::fromValue(request);
return this->connection().asyncCall(callMessage, timeout);
}
/**
* Begins a call to the D-Bus method \c EnsureChannel on the remote object.
*
* \htmlonly
* <p>Request that channels are ensured to exist.</p>
*
* <div class="rationale">
* <p>The connection manager is in the best position to determine which
* existing channels could satisfy which requests.</p>
* </div>
* \endhtmlonly
*
* Note that \a timeout is ignored as of now. It will be used once
* http://bugreports.qt.nokia.com/browse/QTBUG-11775 is fixed.
*
*
* \param request
*
* \htmlonly
* <p>A dictionary containing desirable properties, with the same
* semantics as the corresponding parameter to
* \endhtmlonly CreateChannel() \htmlonly .</p>
* \endhtmlonly
* \param timeout The timeout in milliseconds.
*
* \return
*
* \htmlonly
* <p>If false, the caller of EnsureChannel MUST assume that some
* other process is handling this channel; if true, the caller of
* EnsureChannel SHOULD handle it themselves or delegate it to another
* client.</p>
*
* <p>If the creation of a channel makes several calls to EnsureChannel
* (and no other requests) successful, exactly one of those calls MUST
* return a true value for this argument.</p>
*
* <p>If the creation of a channel makes other requests successful,
* the value returned for this argument MUST be such that exactly
* one of the clients making requests ends up responsible for the
* channel. In particular, if
* \endhtmlonly CreateChannel() \htmlonly returns a channel
* <em>C</em>, any EnsureChannel calls that also return <em>C</em>
* MUST return a false value for this argument.</p>
* \endhtmlonly
*
* \return
*
* The Channel object. If it was created as a result of this method
* call, it MUST NOT be signalled by NewChannels until after this
* method returns. This allows the requester to alter its handling of
* NewChannels by knowing whether one of the channels satisfied a
* request it made.
*
* \return
*
* \htmlonly
* <p>Properties of the channel that was produced, equivalent to
* the properties in <tp:type>Channel_Details</tp:type>.
* Connection managers MUST NOT include properties here whose
* values can change, for the same reasons as in
* <tp:type>Channel_Details</tp:type>.</p>
* \endhtmlonly
*/
inline QDBusPendingReply<bool, QDBusObjectPath, QVariantMap> EnsureChannel(const QVariantMap& request, int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<bool, QDBusObjectPath, QVariantMap>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("EnsureChannel"));
callMessage << QVariant::fromValue(request);
return this->connection().asyncCall(callMessage, timeout);
}
Q_SIGNALS:
/**
* Represents the signal \c NewChannels on the remote object.
*
* \htmlonly
* <p>New channels have been created. The connection manager SHOULD emit
* a single signal for any group of closely related channels that are
* created at the same time, so that the channel dispatcher can try to
* dispatch them to a handler as a unit.</p>
*
* <p>In particular, if additional channels are created as a side-effect
* of a call to \endhtmlonly CreateChannel() \htmlonly ,
* these channels SHOULD appear in the same NewChannels signal as
* the channel that satisfies the request.</p>
*
* <div class="rationale">
* <p>Joining a MUC Tube in XMPP requires joining the corresponding
* MUC (chatroom), so a \endhtmlonly ChannelTypeTextInterface \htmlonly
* channel can be created as a side-effect.</p>
* </div>
*
* <p>Every time NewChannels is emitted, it MUST be followed by
* a \endhtmlonly ConnectionInterface::NewChannel() \htmlonly
* signal for each channel.</p>
*
* <div class="rationale">
* <p>The double signal emission is for the benefit of older Telepathy
* clients, which won't be listening for NewChannels.</p>
*
* <p>The more informative NewChannels signal comes first so that
* clients that did not examine the connection to find
* out whether Requests is supported will see the more informative
* signal for each channel first, and then ignore the less
* informative signal because it announces a new channel of which
* they are already aware.</p>
* </div>
* \endhtmlonly
*
* \param channels
*
* The channels and their details. All channels that are signalled
* together like this MUST have the same Bundle property, which may
* either refer to an existing bundle, or establish a new bundle.
*/
void NewChannels(const Tp::ChannelDetailsList& channels);
/**
* Represents the signal \c ChannelClosed on the remote object.
*
* Emitted when a channel is closed and hence disappears from the Channels
* property. This is redundant with the Closed signal on the channel
* itself, but it does provide full change notification for the Channels
* property.
*
* \param removed
*
* The channel which has been removed from the Channels property
*/
void ChannelClosed(const QDBusObjectPath& removed);
protected:
virtual void invalidate(Tp::DBusProxy *, const QString &, const QString &);
};
/**
* \class ConnectionInterfaceServicePointInterface
* \headerfile TelepathyQt/connection.h <TelepathyQt/Connection>
* \ingroup clientconn
*
* Proxy class providing a 1:1 mapping of the D-Bus interface "org.freedesktop.Telepathy.Connection.Interface.ServicePoint".
*/
class TP_QT_EXPORT ConnectionInterfaceServicePointInterface : public Tp::AbstractInterface
{
Q_OBJECT
public:
/**
* Returns the name of the interface "org.freedesktop.Telepathy.Connection.Interface.ServicePoint", which this class
* represents.
*
* \return The D-Bus interface name.
*/
static inline QLatin1String staticInterfaceName()
{
return QLatin1String("org.freedesktop.Telepathy.Connection.Interface.ServicePoint");
}
/**
* Creates a ConnectionInterfaceServicePointInterface associated with the given object on the session bus.
*
* \param busName Name of the service the object is on.
* \param objectPath Path to the object on the service.
* \param parent Passed to the parent class constructor.
*/
ConnectionInterfaceServicePointInterface(
const QString& busName,
const QString& objectPath,
QObject* parent = 0
);
/**
* Creates a ConnectionInterfaceServicePointInterface associated with the given object on the given bus.
*
* \param connection The bus via which the object can be reached.
* \param busName Name of the service the object is on.
* \param objectPath Path to the object on the service.
* \param parent Passed to the parent class constructor.
*/
ConnectionInterfaceServicePointInterface(
const QDBusConnection& connection,
const QString& busName,
const QString& objectPath,
QObject* parent = 0
);
/**
* Creates a ConnectionInterfaceServicePointInterface associated with the same object as the given proxy.
*
* \param proxy The proxy to use. It will also be the QObject::parent()
* for this object.
*/
ConnectionInterfaceServicePointInterface(Tp::DBusProxy *proxy);
/**
* Creates a ConnectionInterfaceServicePointInterface associated with the same object as the given proxy.
* Additionally, the created proxy will have the same parent as the given
* proxy.
*
* \param mainInterface The proxy to use.
*/
explicit ConnectionInterfaceServicePointInterface(const Tp::Client::ConnectionInterface& mainInterface);
/**
* Creates a ConnectionInterfaceServicePointInterface associated with the same object as the given proxy.
* However, a different parent object can be specified.
*
* \param mainInterface The proxy to use.
* \param parent Passed to the parent class constructor.
*/
ConnectionInterfaceServicePointInterface(const Tp::Client::ConnectionInterface& mainInterface, QObject* parent);
/**
* Asynchronous getter for the remote object property \c KnownServicePoints of type \c Tp::ServicePointInfoList.
*
*
* \htmlonly
* The list of all (known) service points.
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyKnownServicePoints() const
{
return internalRequestProperty(QLatin1String("KnownServicePoints"));
}
/**
* Request all of the DBus properties on the interface.
*
* \return A pending variant map which will emit finished when the properties have
* been retrieved.
*/
Tp::PendingVariantMap *requestAllProperties() const
{
return internalRequestAllProperties();
}
Q_SIGNALS:
/**
* Represents the signal \c ServicePointsChanged on the remote object.
*
* Emitted when the list of known service points (or their IDs) has
* changed.
*
* \param servicePoints
*
* \htmlonly
* <p>The new value of
* \endhtmlonly \link requestPropertyKnownServicePoints() KnownServicePoints \endlink \htmlonly .</p>
* \endhtmlonly
*/
void ServicePointsChanged(const Tp::ServicePointInfoList& servicePoints);
protected:
virtual void invalidate(Tp::DBusProxy *, const QString &, const QString &);
};
/**
* \class ConnectionInterfaceSimplePresenceInterface
* \headerfile TelepathyQt/connection.h <TelepathyQt/Connection>
* \ingroup clientconn
*
* Proxy class providing a 1:1 mapping of the D-Bus interface "org.freedesktop.Telepathy.Connection.Interface.SimplePresence".
*/
class TP_QT_EXPORT ConnectionInterfaceSimplePresenceInterface : public Tp::AbstractInterface
{
Q_OBJECT
public:
/**
* Returns the name of the interface "org.freedesktop.Telepathy.Connection.Interface.SimplePresence", which this class
* represents.
*
* \return The D-Bus interface name.
*/
static inline QLatin1String staticInterfaceName()
{
return QLatin1String("org.freedesktop.Telepathy.Connection.Interface.SimplePresence");
}
/**
* Creates a ConnectionInterfaceSimplePresenceInterface associated with the given object on the session bus.
*
* \param busName Name of the service the object is on.
* \param objectPath Path to the object on the service.
* \param parent Passed to the parent class constructor.
*/
ConnectionInterfaceSimplePresenceInterface(
const QString& busName,
const QString& objectPath,
QObject* parent = 0
);
/**
* Creates a ConnectionInterfaceSimplePresenceInterface associated with the given object on the given bus.
*
* \param connection The bus via which the object can be reached.
* \param busName Name of the service the object is on.
* \param objectPath Path to the object on the service.
* \param parent Passed to the parent class constructor.
*/
ConnectionInterfaceSimplePresenceInterface(
const QDBusConnection& connection,
const QString& busName,
const QString& objectPath,
QObject* parent = 0
);
/**
* Creates a ConnectionInterfaceSimplePresenceInterface associated with the same object as the given proxy.
*
* \param proxy The proxy to use. It will also be the QObject::parent()
* for this object.
*/
ConnectionInterfaceSimplePresenceInterface(Tp::DBusProxy *proxy);
/**
* Creates a ConnectionInterfaceSimplePresenceInterface associated with the same object as the given proxy.
* Additionally, the created proxy will have the same parent as the given
* proxy.
*
* \param mainInterface The proxy to use.
*/
explicit ConnectionInterfaceSimplePresenceInterface(const Tp::Client::ConnectionInterface& mainInterface);
/**
* Creates a ConnectionInterfaceSimplePresenceInterface associated with the same object as the given proxy.
* However, a different parent object can be specified.
*
* \param mainInterface The proxy to use.
* \param parent Passed to the parent class constructor.
*/
ConnectionInterfaceSimplePresenceInterface(const Tp::Client::ConnectionInterface& mainInterface, QObject* parent);
/**
* Asynchronous getter for the remote object property \c Statuses of type \c Tp::SimpleStatusSpecMap.
*
*
* \htmlonly
* <p>A dictionary where the keys are the presence statuses that are
* available on this connection, and the values are the corresponding
* presence types.</p>
*
* <p>While the connection is in the DISCONNECTED state, it contains
* the set of presence statuses allowed to be set before connecting.
* The connection manager will attempt to set the appropriate status
* when the connection becomes connected, but cannot necessarily
* guarantee it. The available statuses cannot change until the
* connection status changes, so there is no change notification.</p>
*
* <p>While the connection is in the CONNECTED state, this property
* contains the set of presence statuses which are actually available
* on this protocol. This set is constant for the remaining lifetime
* of the connection, so again, there is no change notification.</p>
*
* <p>While the connection is in the CONNECTING state, the value of
* this property is undefined and SHOULD NOT be used. It can change
* at any time without notification (in particular, any cached values
* from when the connection was in the DISCONNECTED or CONNECTING
* state MUST NOT be assumed to still be correct when the state has
* become CONNECTED).</p>
*
* <p>This property MUST include the special statuses "unknown" and
* "error" if and only if the connection manager can emit them
* as a contact's status.</p>
*
* <div class="rationale">
* For instance, connection managers for local-xmpp (XEP-0174) would
* omit "unknown" since there is no such concept.
* </div>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyStatuses() const
{
return internalRequestProperty(QLatin1String("Statuses"));
}
/**
* Asynchronous getter for the remote object property \c MaximumStatusMessageLength of type \c uint.
*
*
* \htmlonly
* <p>The maximum length in characters for any individual status
* message, or 0 if there is no limit.</p>
*
* <p>While the connection is in the DISCONNECTED state, this property will
* be 0. The connection manager will attempt to set the appropriate value
* when the connection becomes connected, but cannot necessarily
* guarantee it. The maximum length cannot change until the
* connection status changes, so there is no change notification.</p>
*
* <p>While the connection is in the CONNECTED state, this property
* contains the maximum length in characters for any individual status
* message which is actually allowed on this protocol.
* This value is constant for the remaining lifetime
* of the connection, so again, there is no change notification.</p>
*
* <p>While the connection is in the CONNECTING state, the value of
* this property is undefined and SHOULD NOT be used. It can change
* at any time without notification (in particular, any cached values
* from when the connection was in the DISCONNECTED or CONNECTING
* state MUST NOT be assumed to still be correct when the state has
* become CONNECTED).</p>
*
* <p>If a message passed to \endhtmlonly SetPresence() \htmlonly is
* longer than allowed by this property, the connection manager MUST
* truncate the supplied message; when emitting
* \endhtmlonly PresencesChanged() \htmlonly , the truncated version
* of the message MUST be used.</p>
*
* <div class="rationale">
* <p>Some XMPP servers, like Google Talk, define a maximum length for
* status messages. Whether the user's server is one of
* these cannot be detected until quite late in the connection
* process.</p>
* </div>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyMaximumStatusMessageLength() const
{
return internalRequestProperty(QLatin1String("MaximumStatusMessageLength"));
}
/**
* Request all of the DBus properties on the interface.
*
* \return A pending variant map which will emit finished when the properties have
* been retrieved.
*/
Tp::PendingVariantMap *requestAllProperties() const
{
return internalRequestAllProperties();
}
public Q_SLOTS:
/**
* Begins a call to the D-Bus method \c SetPresence on the remote object.
*
* \htmlonly
* <p>Request that the presence status and status message are published for
* the connection. Changes will be indicated by
* \endhtmlonly PresencesChanged() \htmlonly
* signals being emitted.</p>
*
* <p>This method may be called on a newly-created connection while it
* is still in the DISCONNECTED state, to request that when the
* connection connects, it will do so with the selected status.</p>
*
* <p>In DISCONNECTED state the
* \endhtmlonly \link requestPropertyStatuses() Statuses \endlink \htmlonly
* property will indicate which statuses are allowed to be set
* while DISCONNECTED (none, if the Connection Manager doesn't allow
* this). This value MUST NOT be cached, as the set of allowed
* presences might change upon connecting.</p>
* \endhtmlonly
*
* Note that \a timeout is ignored as of now. It will be used once
* http://bugreports.qt.nokia.com/browse/QTBUG-11775 is fixed.
*
*
* \param status
*
* \htmlonly
* <p>The string identifier of the desired status. Possible status
* identifiers are defined in the
* \endhtmlonly \link requestPropertyStatuses() Statuses \endlink \htmlonly property.</p>
*
* <p>Clients MUST NOT set a status whose string value they do not
* recognise, even if its presence type in Statuses
* matches what the user requested.</p>
*
* <div class="rationale">
* <p>Suppose a protocol has statuses that include 'phone' (of type
* BUSY) and 'in-a-meeting' (of type BUSY), but there is no
* generic 'busy' status.</p>
*
* <p>If the user requests "Busy" status from a menu, a
* client author might be tempted to pick an arbitrary status
* that has type BUSY. However, on this protocol, neither of
* the choices would be appropriate, and incorrect information
* about the user would be conveyed.</p>
* </div>
*
* <p>Statuses whose <tp:type>Connection_Presence_Type</tp:type>
* is Offline, Error or Unknown MUST NOT be passed to this
* function. Connection managers SHOULD reject these statuses.</p>
*
* <div class="rationale">
* <p>To go offline, call \endhtmlonly ConnectionInterface::Disconnect() \htmlonly
* instead. The "error" and "unknown" statuses make no sense.</p>
* </div>
* \endhtmlonly
*
* \param statusMessage
*
* The status message associated with the current status.
* \param timeout The timeout in milliseconds.
*/
inline QDBusPendingReply<> SetPresence(const QString& status, const QString& statusMessage, int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("SetPresence"));
callMessage << QVariant::fromValue(status) << QVariant::fromValue(statusMessage);
return this->connection().asyncCall(callMessage, timeout);
}
/**
* Begins a call to the D-Bus method \c GetPresences on the remote object.
*
* Get presence previously emitted by PresencesChanged for the given
* contacts. Data is returned in the same structure as the
* PresencesChanged signal; no additional network requests are made.
*
* Note that \a timeout is ignored as of now. It will be used once
* http://bugreports.qt.nokia.com/browse/QTBUG-11775 is fixed.
*
*
* \param contacts
*
* An array of the contacts whose presence should be obtained.
* \param timeout The timeout in milliseconds.
*
* \return
*
* \htmlonly
* <p>Presence information in the same format as for the
* \endhtmlonly PresencesChanged() \htmlonly signal.
* The returned mapping MUST include an entry for each contact
* in the method's argument.</p>
*
* <p>The definition of the connection presence types Unknown
* and Offline means that if a connection manager will return
* Unknown for contacts not on the subscribe list, it MUST delay
* the reply to this method call until it has found out which
* contacts are, in fact, on the subscribe list.</p>
* \endhtmlonly
*/
inline QDBusPendingReply<Tp::SimpleContactPresences> GetPresences(const Tp::UIntList& contacts, int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<Tp::SimpleContactPresences>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("GetPresences"));
callMessage << QVariant::fromValue(contacts);
return this->connection().asyncCall(callMessage, timeout);
}
Q_SIGNALS:
/**
* Represents the signal \c PresencesChanged on the remote object.
*
* This signal should be emitted when your own presence has been changed,
* or the presence of the member of any of the connection's channels
* has been changed.
*
* \param presence
*
* A dictionary of contact handles mapped to the status, presence type
* and status message.
*/
void PresencesChanged(const Tp::SimpleContactPresences& presence);
protected:
virtual void invalidate(Tp::DBusProxy *, const QString &, const QString &);
};
}
}
Q_DECLARE_METATYPE(Tp::Client::ConnectionInterface*)
Q_DECLARE_METATYPE(Tp::Client::ConnectionInterfaceAddressingInterface*)
Q_DECLARE_METATYPE(Tp::Client::ConnectionInterfaceAliasingInterface*)
Q_DECLARE_METATYPE(Tp::Client::ConnectionInterfaceAnonymityInterface*)
Q_DECLARE_METATYPE(Tp::Client::ConnectionInterfaceAvatarsInterface*)
Q_DECLARE_METATYPE(Tp::Client::ConnectionInterfaceBalanceInterface*)
Q_DECLARE_METATYPE(Tp::Client::ConnectionInterfaceCapabilitiesInterface*)
Q_DECLARE_METATYPE(Tp::Client::ConnectionInterfaceCellularInterface*)
Q_DECLARE_METATYPE(Tp::Client::ConnectionInterfaceClientTypesInterface*)
Q_DECLARE_METATYPE(Tp::Client::ConnectionInterfaceContactBlockingInterface*)
Q_DECLARE_METATYPE(Tp::Client::ConnectionInterfaceContactCapabilitiesInterface*)
Q_DECLARE_METATYPE(Tp::Client::ConnectionInterfaceContactGroupsInterface*)
Q_DECLARE_METATYPE(Tp::Client::ConnectionInterfaceContactInfoInterface*)
Q_DECLARE_METATYPE(Tp::Client::ConnectionInterfaceContactListInterface*)
Q_DECLARE_METATYPE(Tp::Client::ConnectionInterfaceContactsInterface*)
Q_DECLARE_METATYPE(Tp::Client::ConnectionInterfaceLocationInterface*)
Q_DECLARE_METATYPE(Tp::Client::ConnectionInterfaceMailNotificationInterface*)
Q_DECLARE_METATYPE(Tp::Client::ConnectionInterfacePowerSavingInterface*)
Q_DECLARE_METATYPE(Tp::Client::ConnectionInterfacePresenceInterface*)
Q_DECLARE_METATYPE(Tp::Client::ConnectionInterfaceRequestsInterface*)
Q_DECLARE_METATYPE(Tp::Client::ConnectionInterfaceServicePointInterface*)
Q_DECLARE_METATYPE(Tp::Client::ConnectionInterfaceSimplePresenceInterface*)
|