/usr/include/telepathy-qt4/TelepathyQt/_gen/cli-channel.h is in libtelepathy-qt4-dev 0.9.6~git1-0ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 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 7781 7782 7783 7784 7785 7786 7787 7788 7789 7790 7791 7792 7793 7794 7795 7796 7797 7798 7799 7800 7801 7802 7803 7804 7805 7806 7807 7808 7809 7810 7811 7812 7813 7814 7815 7816 7817 7818 7819 7820 7821 7822 7823 7824 7825 7826 7827 7828 7829 7830 7831 7832 7833 7834 7835 7836 7837 7838 7839 7840 7841 7842 7843 7844 7845 7846 7847 7848 7849 7850 7851 7852 7853 7854 7855 7856 7857 7858 7859 7860 7861 7862 7863 7864 7865 7866 7867 7868 7869 7870 7871 7872 7873 7874 7875 7876 7877 7878 7879 7880 7881 7882 7883 7884 7885 7886 7887 7888 7889 7890 7891 7892 7893 7894 7895 7896 7897 7898 7899 7900 7901 7902 7903 7904 7905 7906 7907 7908 7909 7910 7911 7912 7913 7914 7915 7916 7917 7918 7919 7920 7921 7922 7923 7924 7925 7926 7927 7928 7929 7930 7931 7932 7933 7934 7935 7936 7937 7938 7939 7940 7941 7942 7943 7944 7945 7946 7947 7948 7949 7950 7951 7952 7953 7954 7955 7956 7957 7958 7959 7960 7961 7962 7963 7964 7965 7966 7967 7968 7969 7970 7971 7972 7973 7974 7975 7976 7977 7978 7979 7980 7981 7982 7983 7984 7985 7986 7987 7988 7989 7990 7991 7992 7993 7994 7995 7996 7997 7998 7999 8000 8001 8002 8003 8004 8005 8006 8007 8008 8009 8010 8011 8012 8013 8014 8015 8016 8017 8018 8019 8020 8021 8022 8023 8024 8025 8026 8027 8028 8029 8030 8031 8032 8033 8034 8035 8036 8037 8038 8039 8040 8041 8042 8043 8044 8045 8046 8047 8048 8049 8050 8051 8052 8053 8054 8055 8056 8057 8058 8059 8060 8061 8062 8063 8064 8065 8066 8067 8068 8069 8070 8071 8072 8073 8074 8075 8076 8077 8078 8079 8080 8081 8082 8083 8084 8085 8086 8087 8088 8089 8090 8091 8092 8093 8094 8095 8096 8097 8098 8099 8100 8101 8102 8103 8104 8105 8106 8107 8108 8109 8110 8111 8112 8113 8114 8115 8116 8117 8118 8119 8120 8121 8122 8123 8124 8125 8126 8127 8128 8129 8130 8131 8132 8133 8134 8135 8136 8137 8138 8139 8140 8141 8142 8143 8144 8145 8146 8147 8148 8149 8150 8151 8152 8153 8154 8155 8156 8157 8158 8159 8160 8161 8162 8163 8164 8165 8166 8167 8168 8169 8170 8171 8172 8173 8174 8175 8176 8177 8178 8179 8180 8181 8182 8183 8184 8185 8186 8187 8188 8189 8190 8191 8192 8193 8194 8195 8196 8197 8198 8199 8200 8201 8202 8203 8204 8205 8206 8207 8208 8209 8210 8211 8212 8213 8214 8215 8216 8217 8218 8219 8220 8221 8222 8223 8224 8225 8226 8227 8228 8229 8230 8231 8232 8233 8234 8235 8236 8237 8238 8239 8240 8241 8242 8243 8244 8245 8246 8247 8248 8249 8250 8251 8252 8253 8254 8255 8256 8257 8258 8259 8260 8261 8262 8263 8264 8265 8266 8267 8268 8269 8270 8271 8272 8273 8274 8275 8276 8277 8278 8279 8280 8281 8282 8283 8284 8285 8286 8287 8288 8289 8290 8291 8292 8293 8294 8295 8296 8297 8298 8299 8300 8301 8302 8303 8304 8305 8306 8307 8308 8309 8310 8311 8312 8313 8314 8315 8316 8317 8318 8319 8320 8321 8322 8323 8324 8325 8326 8327 8328 8329 8330 8331 8332 8333 8334 8335 8336 8337 8338 8339 8340 8341 8342 8343 8344 8345 8346 8347 8348 8349 8350 8351 8352 8353 8354 8355 8356 8357 8358 8359 8360 8361 8362 8363 8364 8365 8366 8367 8368 8369 8370 8371 8372 8373 8374 8375 8376 8377 8378 8379 8380 8381 8382 8383 8384 8385 8386 8387 8388 8389 8390 8391 8392 8393 8394 8395 8396 8397 8398 8399 8400 8401 8402 8403 8404 8405 8406 8407 8408 8409 8410 8411 8412 8413 8414 8415 8416 8417 8418 8419 8420 8421 8422 8423 8424 8425 8426 8427 8428 8429 8430 8431 8432 8433 8434 8435 8436 8437 8438 8439 8440 8441 8442 8443 8444 8445 8446 8447 8448 8449 8450 8451 8452 8453 8454 8455 8456 8457 8458 8459 8460 8461 8462 8463 8464 8465 8466 8467 8468 8469 8470 8471 8472 8473 8474 8475 8476 8477 8478 8479 8480 8481 8482 8483 8484 8485 8486 8487 8488 8489 8490 8491 8492 8493 8494 8495 8496 8497 8498 8499 8500 8501 8502 8503 8504 8505 8506 8507 8508 8509 8510 8511 8512 8513 8514 8515 8516 8517 8518 8519 8520 8521 8522 8523 8524 8525 8526 8527 8528 8529 8530 8531 8532 8533 8534 8535 8536 8537 8538 8539 8540 8541 8542 8543 8544 8545 8546 8547 8548 8549 8550 8551 8552 8553 8554 8555 8556 8557 8558 8559 8560 8561 8562 8563 8564 8565 8566 8567 8568 8569 8570 8571 8572 8573 8574 8575 8576 8577 8578 8579 8580 8581 8582 8583 8584 8585 8586 8587 8588 8589 8590 8591 8592 8593 8594 8595 8596 8597 8598 8599 8600 8601 8602 8603 8604 8605 8606 8607 8608 8609 8610 8611 8612 8613 8614 8615 8616 8617 8618 8619 8620 8621 8622 8623 8624 8625 8626 8627 8628 8629 8630 8631 8632 8633 8634 8635 8636 8637 8638 8639 8640 8641 8642 8643 8644 8645 8646 8647 8648 8649 8650 8651 8652 8653 8654 8655 8656 8657 8658 8659 8660 8661 8662 8663 8664 8665 8666 8667 8668 8669 8670 8671 8672 8673 8674 8675 8676 8677 8678 8679 8680 8681 8682 8683 8684 8685 8686 8687 8688 8689 8690 8691 8692 8693 8694 8695 8696 8697 8698 8699 8700 8701 8702 8703 8704 8705 8706 8707 8708 8709 8710 8711 8712 8713 8714 8715 8716 8717 8718 8719 8720 8721 8722 8723 8724 8725 8726 8727 8728 8729 8730 8731 8732 8733 8734 8735 8736 8737 8738 8739 8740 8741 8742 8743 8744 8745 8746 8747 8748 8749 8750 8751 8752 8753 8754 8755 8756 8757 8758 8759 8760 8761 8762 8763 8764 8765 8766 8767 8768 8769 8770 8771 8772 8773 8774 8775 8776 8777 8778 8779 8780 8781 8782 8783 8784 8785 8786 8787 8788 8789 8790 8791 8792 8793 8794 8795 8796 8797 8798 8799 8800 8801 8802 8803 8804 8805 8806 8807 8808 8809 8810 8811 8812 8813 8814 8815 8816 8817 8818 8819 8820 8821 8822 8823 8824 8825 8826 8827 8828 8829 8830 8831 8832 8833 8834 8835 8836 8837 8838 8839 8840 8841 8842 8843 8844 8845 8846 8847 8848 8849 8850 8851 8852 8853 8854 8855 8856 8857 8858 8859 8860 8861 8862 8863 8864 8865 8866 8867 8868 8869 8870 8871 8872 8873 8874 8875 8876 8877 8878 8879 8880 8881 8882 8883 8884 8885 8886 8887 8888 8889 8890 8891 8892 8893 8894 8895 8896 8897 8898 8899 8900 8901 8902 8903 8904 8905 8906 8907 8908 8909 8910 8911 8912 8913 8914 8915 8916 8917 8918 8919 8920 8921 8922 8923 8924 8925 8926 8927 8928 8929 8930 8931 8932 8933 8934 8935 8936 8937 8938 8939 8940 8941 8942 8943 8944 8945 8946 8947 8948 8949 8950 8951 8952 8953 8954 8955 8956 8957 8958 8959 8960 8961 8962 8963 8964 8965 8966 8967 8968 8969 8970 8971 8972 8973 8974 8975 8976 8977 8978 8979 8980 8981 8982 8983 8984 8985 8986 8987 8988 8989 8990 8991 8992 8993 8994 8995 8996 8997 8998 8999 9000 9001 9002 9003 9004 9005 9006 9007 9008 9009 9010 9011 9012 9013 9014 9015 9016 9017 9018 9019 9020 9021 9022 9023 9024 9025 9026 9027 9028 9029 9030 9031 9032 9033 9034 9035 9036 9037 9038 9039 9040 9041 9042 9043 9044 9045 9046 9047 9048 9049 9050 9051 9052 9053 9054 9055 9056 9057 9058 9059 9060 9061 9062 9063 9064 9065 9066 9067 9068 9069 9070 9071 9072 9073 9074 9075 9076 9077 9078 9079 9080 9081 9082 9083 9084 9085 9086 9087 9088 9089 9090 9091 9092 9093 9094 9095 9096 9097 9098 9099 9100 9101 9102 9103 9104 9105 9106 9107 9108 9109 9110 9111 9112 9113 9114 9115 9116 9117 9118 9119 9120 9121 9122 9123 9124 9125 9126 9127 9128 9129 9130 9131 9132 9133 9134 9135 9136 9137 9138 9139 9140 9141 9142 9143 9144 9145 9146 9147 9148 9149 9150 9151 9152 9153 9154 9155 9156 9157 9158 9159 9160 9161 9162 9163 9164 9165 9166 9167 9168 9169 9170 9171 9172 9173 9174 9175 9176 9177 9178 9179 9180 9181 9182 9183 9184 9185 9186 9187 9188 9189 9190 9191 9192 9193 9194 9195 9196 9197 9198 9199 9200 9201 9202 9203 9204 9205 9206 9207 9208 9209 9210 9211 9212 9213 9214 9215 9216 9217 9218 9219 9220 9221 9222 9223 9224 9225 9226 9227 9228 9229 9230 9231 9232 9233 9234 9235 9236 9237 9238 9239 9240 9241 9242 9243 9244 9245 9246 9247 9248 9249 9250 9251 9252 9253 9254 9255 9256 9257 9258 9259 9260 9261 9262 9263 9264 9265 9266 9267 9268 9269 9270 9271 9272 9273 9274 9275 9276 9277 9278 9279 9280 9281 9282 9283 9284 9285 9286 9287 9288 9289 9290 9291 9292 9293 9294 9295 9296 9297 9298 9299 9300 9301 9302 9303 9304 9305 9306 9307 9308 9309 9310 9311 9312 9313 9314 9315 9316 9317 9318 9319 9320 9321 9322 9323 9324 9325 9326 9327 9328 9329 9330 9331 9332 9333 9334 9335 9336 9337 9338 9339 9340 9341 9342 9343 9344 9345 9346 9347 9348 9349 9350 9351 9352 9353 9354 9355 9356 9357 9358 9359 9360 9361 9362 9363 9364 9365 9366 9367 9368 9369 9370 9371 9372 9373 9374 9375 9376 9377 9378 9379 9380 9381 9382 9383 9384 9385 9386 9387 9388 9389 9390 9391 9392 9393 9394 9395 9396 9397 9398 9399 9400 9401 9402 9403 9404 9405 9406 9407 9408 9409 9410 9411 9412 9413 9414 9415 9416 9417 9418 9419 9420 9421 9422 9423 9424 9425 9426 9427 9428 9429 9430 9431 9432 9433 9434 9435 9436 9437 9438 9439 9440 9441 9442 9443 9444 9445 9446 9447 9448 9449 9450 9451 9452 9453 9454 9455 9456 9457 9458 9459 9460 9461 9462 9463 9464 9465 9466 9467 9468 9469 9470 9471 9472 9473 9474 9475 9476 9477 9478 9479 9480 9481 9482 9483 9484 9485 9486 9487 9488 9489 9490 9491 9492 9493 9494 9495 9496 9497 9498 9499 9500 9501 9502 9503 9504 9505 9506 9507 9508 9509 9510 9511 9512 9513 9514 9515 9516 9517 9518 9519 9520 9521 9522 9523 9524 9525 9526 9527 9528 9529 9530 9531 9532 9533 9534 9535 9536 9537 9538 9539 9540 9541 9542 9543 9544 9545 9546 9547 9548 9549 9550 9551 9552 9553 9554 9555 9556 9557 9558 9559 9560 9561 9562 9563 9564 9565 9566 9567 9568 9569 9570 9571 9572 9573 9574 9575 9576 9577 9578 9579 9580 9581 9582 9583 9584 9585 9586 9587 9588 9589 9590 9591 9592 9593 9594 9595 9596 9597 9598 9599 9600 9601 9602 9603 9604 9605 9606 9607 9608 9609 9610 9611 9612 9613 9614 9615 9616 9617 9618 9619 9620 9621 9622 9623 9624 9625 9626 9627 9628 9629 9630 9631 9632 9633 9634 9635 9636 9637 9638 9639 9640 9641 9642 9643 9644 9645 9646 9647 9648 9649 9650 9651 9652 9653 9654 9655 9656 9657 9658 9659 9660 9661 9662 9663 9664 9665 9666 9667 9668 9669 9670 9671 9672 9673 9674 9675 9676 9677 9678 9679 9680 9681 9682 9683 9684 9685 9686 9687 9688 9689 9690 9691 9692 9693 9694 9695 9696 9697 9698 9699 9700 9701 9702 9703 9704 9705 9706 9707 9708 9709 9710 9711 9712 9713 9714 9715 9716 9717 9718 9719 9720 9721 9722 9723 9724 9725 9726 9727 9728 9729 9730 9731 9732 9733 9734 9735 9736 9737 9738 9739 9740 9741 9742 9743 9744 9745 9746 9747 9748 9749 9750 9751 9752 9753 9754 9755 9756 9757 9758 9759 9760 9761 9762 9763 9764 9765 9766 9767 9768 9769 9770 9771 9772 9773 9774 9775 9776 9777 9778 9779 9780 9781 9782 9783 9784 9785 9786 9787 9788 9789 9790 9791 9792 9793 9794 9795 9796 9797 9798 9799 9800 9801 9802 9803 9804 9805 9806 9807 9808 9809 9810 9811 9812 9813 9814 9815 9816 9817 9818 9819 9820 9821 9822 9823 9824 9825 9826 9827 9828 9829 9830 9831 9832 9833 9834 9835 9836 9837 9838 9839 9840 9841 9842 9843 9844 9845 9846 9847 9848 9849 9850 9851 9852 9853 9854 9855 9856 9857 9858 9859 9860 9861 9862 9863 9864 9865 9866 9867 9868 9869 9870 9871 9872 9873 9874 9875 9876 9877 9878 9879 9880 9881 9882 9883 9884 9885 9886 9887 9888 9889 9890 9891 9892 9893 9894 9895 9896 9897 9898 9899 9900 9901 9902 9903 9904 9905 9906 9907 9908 9909 9910 9911 9912 9913 9914 9915 9916 9917 9918 9919 9920 9921 9922 9923 9924 9925 9926 9927 9928 9929 9930 9931 9932 9933 9934 9935 9936 9937 9938 9939 9940 9941 9942 9943 9944 9945 9946 9947 9948 9949 9950 9951 9952 9953 9954 9955 9956 9957 9958 9959 9960 9961 9962 9963 9964 9965 9966 9967 9968 9969 9970 9971 9972 9973 9974 9975 9976 9977 9978 9979 9980 9981 9982 9983 9984 9985 9986 9987 9988 9989 9990 9991 9992 9993 9994 9995 9996 9997 9998 9999 10000 10001 10002 10003 10004 10005 10006 10007 10008 10009 10010 10011 10012 10013 10014 10015 10016 10017 10018 10019 10020 10021 10022 10023 10024 10025 10026 10027 10028 10029 10030 10031 10032 10033 10034 10035 10036 10037 10038 10039 10040 10041 10042 10043 10044 10045 10046 10047 10048 10049 10050 10051 10052 10053 10054 10055 10056 10057 10058 10059 10060 10061 10062 10063 10064 10065 10066 10067 10068 10069 10070 10071 10072 10073 10074 10075 10076 10077 10078 10079 10080 10081 10082 10083 10084 10085 10086 10087 10088 10089 10090 10091 10092 10093 10094 10095 10096 10097 10098 10099 10100 10101 10102 10103 10104 10105 10106 10107 10108 10109 10110 10111 10112 10113 10114 10115 10116 10117 10118 10119 10120 10121 10122 10123 10124 10125 10126 10127 10128 10129 10130 10131 10132 10133 10134 10135 10136 10137 10138 10139 10140 10141 10142 10143 10144 10145 10146 10147 10148 10149 10150 10151 10152 10153 10154 10155 10156 10157 10158 10159 10160 10161 10162 10163 10164 10165 10166 10167 10168 10169 10170 10171 10172 10173 10174 10175 10176 10177 10178 10179 10180 10181 10182 10183 10184 10185 10186 10187 10188 10189 10190 10191 10192 10193 10194 10195 10196 10197 10198 10199 10200 10201 10202 10203 10204 10205 10206 10207 10208 10209 10210 10211 10212 10213 10214 10215 10216 10217 10218 10219 10220 10221 10222 10223 10224 10225 10226 10227 10228 10229 10230 10231 10232 10233 10234 10235 10236 10237 10238 10239 10240 10241 10242 10243 10244 10245 10246 10247 10248 10249 10250 10251 10252 10253 10254 10255 10256 10257 10258 10259 10260 10261 10262 10263 10264 10265 10266 10267 10268 10269 10270 10271 10272 10273 10274 10275 10276 10277 10278 10279 10280 10281 10282 10283 10284 10285 10286 10287 10288 10289 10290 10291 10292 10293 10294 10295 10296 10297 10298 10299 10300 10301 10302 10303 10304 10305 10306 10307 10308 10309 10310 10311 10312 10313 10314 10315 10316 10317 10318 10319 10320 10321 10322 10323 10324 10325 10326 10327 10328 10329 10330 10331 10332 10333 10334 10335 10336 10337 10338 10339 10340 10341 10342 10343 10344 10345 10346 10347 10348 10349 10350 10351 10352 10353 10354 10355 10356 10357 10358 10359 10360 10361 10362 10363 10364 10365 10366 10367 10368 10369 10370 10371 10372 10373 10374 10375 10376 10377 10378 10379 10380 10381 10382 10383 10384 10385 10386 10387 10388 10389 10390 10391 10392 10393 10394 10395 10396 10397 10398 10399 10400 10401 10402 10403 10404 10405 10406 10407 10408 10409 10410 10411 10412 10413 10414 10415 10416 10417 10418 10419 10420 10421 10422 10423 10424 10425 10426 10427 10428 10429 10430 10431 10432 10433 10434 10435 10436 10437 10438 10439 10440 10441 10442 10443 10444 10445 10446 10447 10448 10449 10450 10451 10452 10453 10454 10455 10456 10457 10458 10459 10460 10461 10462 10463 10464 10465 10466 10467 10468 10469 10470 10471 10472 10473 10474 10475 10476 10477 10478 10479 10480 10481 10482 10483 10484 10485 10486 10487 10488 10489 10490 10491 10492 10493 10494 10495 10496 10497 10498 10499 10500 10501 10502 10503 10504 10505 10506 10507 10508 10509 10510 10511 10512 10513 10514 10515 10516 10517 10518 10519 10520 10521 10522 10523 10524 10525 10526 10527 10528 10529 10530 10531 10532 10533 10534 10535 10536 10537 10538 10539 10540 10541 10542 10543 10544 10545 10546 10547 10548 10549 10550 10551 10552 10553 10554 10555 10556 10557 10558 10559 10560 10561 10562 10563 10564 10565 10566 10567 10568 10569 10570 10571 10572 10573 10574 10575 10576 10577 10578 10579 10580 10581 10582 10583 10584 10585 10586 10587 10588 10589 10590 10591 10592 10593 10594 10595 10596 10597 10598 10599 10600 10601 10602 10603 10604 10605 10606 10607 10608 10609 10610 10611 10612 10613 10614 10615 10616 10617 10618 10619 10620 10621 10622 10623 10624 10625 10626 10627 10628 10629 10630 10631 10632 10633 10634 10635 10636 10637 10638 10639 10640 10641 10642 10643 10644 10645 10646 10647 10648 10649 10650 10651 10652 10653 10654 10655 10656 10657 10658 10659 10660 10661 10662 10663 10664 10665 10666 10667 10668 10669 10670 10671 10672 10673 10674 10675 10676 10677 10678 10679 10680 10681 10682 10683 10684 10685 10686 10687 10688 10689 10690 10691 10692 10693 10694 10695 10696 10697 10698 10699 10700 10701 10702 10703 10704 10705 10706 10707 10708 10709 10710 10711 10712 10713 10714 10715 10716 10717 10718 10719 10720 10721 10722 10723 10724 10725 10726 10727 10728 10729 10730 10731 10732 10733 10734 10735 10736 10737 10738 10739 10740 10741 10742 10743 10744 10745 10746 10747 10748 10749 10750 10751 10752 10753 10754 10755 10756 10757 10758 10759 10760 10761 10762 10763 10764 10765 10766 10767 10768 10769 10770 10771 10772 10773 10774 10775 10776 10777 10778 10779 10780 10781 10782 10783 10784 10785 10786 10787 10788 10789 10790 10791 10792 10793 10794 10795 10796 10797 10798 10799 10800 10801 10802 10803 10804 10805 10806 10807 10808 10809 10810 10811 10812 10813 10814 10815 10816 10817 10818 10819 10820 10821 10822 10823 10824 10825 10826 10827 10828 10829 10830 10831 10832 10833 10834 10835 10836 10837 10838 10839 10840 10841 10842 10843 10844 10845 10846 10847 10848 10849 10850 10851 10852 10853 10854 10855 10856 10857 10858 10859 10860 10861 10862 10863 10864 10865 10866 10867 10868 10869 10870 10871 10872 10873 10874 10875 10876 10877 10878 10879 10880 10881 10882 10883 10884 10885 10886 10887 10888 10889 10890 10891 10892 10893 10894 10895 10896 10897 10898 10899 10900 10901 10902 10903 10904 10905 10906 10907 10908 10909 10910 10911 10912 10913 10914 10915 10916 10917 10918 10919 10920 10921 10922 10923 10924 10925 10926 10927 10928 10929 10930 10931 10932 10933 10934 10935 10936 10937 10938 10939 10940 10941 10942 10943 10944 10945 10946 10947 10948 10949 10950 10951 10952 10953 10954 10955 10956 10957 10958 10959 10960 10961 10962 10963 10964 10965 10966 10967 10968 10969 10970 10971 10972 10973 10974 10975 10976 10977 10978 10979 10980 10981 10982 10983 10984 10985 10986 10987 10988 10989 10990 10991 10992 10993 10994 10995 10996 10997 10998 10999 11000 11001 11002 11003 11004 11005 11006 11007 11008 11009 11010 11011 11012 11013 11014 11015 11016 11017 11018 11019 11020 11021 11022 11023 11024 11025 11026 11027 11028 11029 11030 11031 11032 11033 11034 11035 11036 11037 11038 11039 11040 11041 11042 11043 11044 11045 11046 11047 11048 11049 11050 11051 11052 11053 11054 11055 11056 11057 11058 11059 11060 11061 11062 11063 11064 11065 11066 11067 11068 11069 11070 11071 11072 11073 11074 11075 11076 11077 11078 11079 11080 11081 11082 11083 11084 11085 11086 11087 11088 11089 11090 11091 11092 11093 11094 11095 11096 11097 11098 11099 11100 11101 11102 11103 11104 11105 11106 11107 11108 11109 11110 11111 11112 11113 11114 11115 11116 11117 11118 11119 11120 11121 11122 11123 11124 11125 11126 11127 11128 11129 11130 11131 11132 11133 11134 11135 11136 11137 11138 11139 11140 11141 11142 11143 11144 11145 11146 11147 11148 11149 11150 11151 11152 11153 11154 11155 11156 11157 11158 11159 11160 11161 11162 11163 11164 11165 11166 11167 11168 11169 11170 11171 11172 11173 11174 11175 11176 11177 11178 11179 11180 11181 11182 11183 11184 11185 11186 11187 11188 11189 11190 11191 11192 11193 11194 11195 11196 11197 11198 11199 11200 11201 11202 11203 11204 11205 11206 11207 11208 11209 11210 11211 11212 11213 11214 11215 11216 11217 11218 11219 11220 11221 11222 11223 11224 11225 11226 11227 11228 11229 11230 11231 11232 11233 11234 11235 11236 11237 11238 11239 11240 11241 11242 11243 11244 11245 11246 11247 11248 11249 11250 11251 11252 11253 11254 11255 11256 11257 11258 11259 11260 11261 11262 11263 11264 11265 11266 11267 11268 11269 11270 11271 11272 11273 11274 11275 11276 11277 11278 11279 11280 11281 11282 11283 11284 11285 11286 11287 11288 11289 11290 11291 11292 11293 11294 11295 11296 11297 11298 11299 11300 11301 11302 11303 11304 11305 11306 11307 11308 11309 11310 11311 11312 11313 11314 11315 11316 11317 11318 11319 11320 11321 11322 11323 11324 11325 11326 11327 11328 11329 11330 11331 11332 11333 11334 11335 11336 11337 11338 11339 11340 11341 11342 11343 11344 11345 11346 11347 11348 11349 11350 11351 11352 11353 11354 11355 11356 11357 11358 11359 11360 11361 11362 11363 11364 11365 11366 11367 11368 11369 11370 11371 11372 11373 11374 11375 11376 11377 11378 11379 11380 11381 11382 11383 11384 11385 11386 11387 11388 11389 11390 11391 11392 11393 11394 11395 11396 11397 11398 11399 11400 11401 11402 11403 11404 11405 11406 11407 11408 11409 11410 11411 11412 11413 11414 11415 11416 11417 11418 11419 11420 11421 11422 11423 11424 11425 11426 11427 11428 11429 11430 11431 11432 11433 11434 11435 11436 11437 11438 11439 11440 11441 11442 11443 11444 11445 11446 11447 11448 11449 11450 11451 11452 11453 11454 11455 11456 11457 11458 11459 11460 11461 11462 11463 11464 11465 11466 11467 11468 11469 11470 11471 11472 11473 11474 11475 11476 11477 11478 11479 11480 11481 11482 11483 11484 11485 11486 11487 11488 11489 11490 11491 11492 11493 11494 11495 11496 11497 11498 11499 11500 11501 11502 11503 11504 11505 11506 11507 11508 11509 11510 11511 11512 11513 11514 11515 11516 11517 11518 11519 11520 11521 11522 11523 11524 11525 11526 11527 11528 11529 11530 11531 11532 11533 11534 11535 11536 11537 11538 11539 11540 11541 11542 11543 11544 11545 11546 11547 11548 11549 11550 11551 | /*
* 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 ChannelInterface
* \headerfile TelepathyQt/channel.h <TelepathyQt/Channel>
* \ingroup clientchannel
*
* Proxy class providing a 1:1 mapping of the D-Bus interface "org.freedesktop.Telepathy.Channel".
*/
class TP_QT_EXPORT ChannelInterface : public Tp::AbstractInterface
{
Q_OBJECT
public:
/**
* Returns the name of the interface "org.freedesktop.Telepathy.Channel", which this class
* represents.
*
* \return The D-Bus interface name.
*/
static inline QLatin1String staticInterfaceName()
{
return QLatin1String("org.freedesktop.Telepathy.Channel");
}
/**
* Creates a ChannelInterface 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.
*/
ChannelInterface(
const QString& busName,
const QString& objectPath,
QObject* parent = 0
);
/**
* Creates a ChannelInterface 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.
*/
ChannelInterface(
const QDBusConnection& connection,
const QString& busName,
const QString& objectPath,
QObject* parent = 0
);
/**
* Creates a ChannelInterface 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.
*/
ChannelInterface(Tp::DBusProxy *proxy);
/**
* Asynchronous getter for the remote object property \c ChannelType of type \c QString.
*
*
* \htmlonly
* <p>The channel's type. This cannot change once the channel has
* been created.</p>
*
* <p>For compatibility between older connection managers and newer
* clients, if this is unavailable or is an empty string,
* clients MUST use the result of calling
* \endhtmlonly GetChannelType() \htmlonly .</p>
*
* <div class="rationale">
* The GetAll method lets clients retrieve all properties in one
* round-trip, which is desirable.
* </div>
*
* <p>When requesting a channel, the request MUST specify a channel
* type, and the request MUST fail if the specified channel type
* cannot be supplied.</p>
*
* <div class="rationale">
* Common sense.
* </div>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyChannelType() const
{
return internalRequestProperty(QLatin1String("ChannelType"));
}
/**
* Asynchronous getter for the remote object property \c Interfaces of type \c QStringList.
*
*
* \htmlonly
* <p>Extra interfaces provided by this channel. This SHOULD NOT include
* the channel type and the Channel interface itself, and cannot
* change once the channel has been created.</p>
*
* <p>For compatibility between older connection managers and newer
* clients, if this is unavailable, or if this is an empty list and
* \endhtmlonly \link requestPropertyChannelType() ChannelType \endlink \htmlonly is an empty string,
* clients MUST use the result of calling
* \endhtmlonly GetInterfaces() \htmlonly instead. If this is an
* empty list but ChannelType is non-empty, clients SHOULD NOT call
* GetInterfaces; this implies that connection managers that implement
* the ChannelType property MUST also implement the Interfaces property
* correctly.</p>
*
* <div class="rationale">
* The GetAll method lets clients retrieve all properties in one
* round-trip, which is desirable.
* </div>
*
* <p>When requesting a channel with a particular value for this
* property, the request must fail without side-effects unless the
* connection manager expects to be able to provide a channel whose
* interfaces include at least the interfaces requested.</p>
* \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 TargetHandle of type \c uint.
*
*
* \htmlonly
* <p>The handle (a representation for the identifier) of the contact,
* chatroom, etc. with which this handle communicates. Its type
* is given by the \endhtmlonly \link requestPropertyTargetHandleType() TargetHandleType \endlink \htmlonly
* property.</p>
*
* <p>This is fixed for the lifetime of the channel, so channels which
* could potentially be used to communicate with multiple contacts,
* and do not have an identity of their own (such as a Handle_Type_Room
* handle), must have TargetHandleType set to Handle_Type_None and
* TargetHandle set to 0.</p>
*
* <p>Unlike in the telepathy-spec 0.16 API, there is no particular
* uniqueness guarantee - there can be many channels with the same
* (channel type, handle type, handle) tuple. This is necessary
* to support conversation threads in XMPP and SIP, for example.</p>
*
* <p>If this is present in a channel request, it must be nonzero,
* \endhtmlonly \link requestPropertyTargetHandleType() TargetHandleType \endlink \htmlonly
* MUST be present and not Handle_Type_None, and
* \endhtmlonly \link requestPropertyTargetID() TargetID \endlink \htmlonly MUST NOT be
* present. Properties from
* \endhtmlonly org.freedesktop.Telepathy.Channel.Interface.Addressing1 \htmlonly
* MUST NOT be present.</p>
*
* <p>The channel that satisfies the request MUST either:</p>
*
* <ul>
* <li>have the specified TargetHandle property; or</li>
* <li>have \endhtmlonly \link requestPropertyTargetHandleType() TargetHandleType \endlink \htmlonly =
* Handle_Type_None, TargetHandle = 0, and be configured such that
* it could communicate with the specified handle in some other way
* (e.g. have the requested contact handle in its Group
* interface)</li>
* </ul>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyTargetHandle() const
{
return internalRequestProperty(QLatin1String("TargetHandle"));
}
/**
* Asynchronous getter for the remote object property \c TargetID of type \c QString.
*
*
* \htmlonly
* <p>The string that would result from inspecting the
* \endhtmlonly \link requestPropertyTargetHandle() TargetHandle \endlink \htmlonly
* property (i.e. the identifier in the IM protocol of the contact,
* room, etc. with which this channel communicates), or the empty
* string if the TargetHandle is 0.</p>
*
* <div class="rationale">
* <p>The presence of this property avoids the following race
* condition:</p>
*
* <ul>
* <li>New channel C is signalled with target handle T</li>
* <li>Client calls \endhtmlonly ConnectionInterface::InspectHandles() \htmlonly (CONTACT,
* [T])</li>
* <li>Channel C closes, removing the last reference to handle T</li>
* <li> \endhtmlonly ConnectionInterface::InspectHandles() \htmlonly (CONTACT,
* [T]) returns an error</li>
* </ul>
* </div>
*
* <p>If this is present in a channel request,
* \endhtmlonly \link requestPropertyTargetHandleType() TargetHandleType \endlink \htmlonly
* MUST be present and not Handle_Type_None, and
* \endhtmlonly \link requestPropertyTargetHandle() TargetHandle \endlink \htmlonly MUST NOT be
* present. Properties from
* \endhtmlonly org.freedesktop.Telepathy.Channel.Interface.Addressing1 \htmlonly
* MUST NOT be present.The request MUST fail with error InvalidHandle,
* without side-effects, if the requested TargetID would not be
* accepted by
* \endhtmlonly ConnectionInterface::RequestHandles() \htmlonly .</p>
*
* <p>The returned channel must be related to the handle corresponding
* to the given identifier, in the same way as if TargetHandle
* had been part of the request instead.</p>
*
* <div class="rationale">
* <p>Requesting channels with a string identifier saves a round-trip
* (the call to RequestHandles). It also allows the channel
* dispatcher to accept a channel request for an account that is not
* yet connected (and thus has no valid handles), bring the account
* online, and pass on the same parameters to the new connection's
* CreateChannel method.</p>
* </div>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyTargetID() const
{
return internalRequestProperty(QLatin1String("TargetID"));
}
/**
* Asynchronous getter for the remote object property \c TargetHandleType of type \c uint.
*
*
* \htmlonly
* <p>The type of \endhtmlonly \link requestPropertyTargetHandle() TargetHandle \endlink \htmlonly .</p>
*
* <p>If this is omitted from a channel request, connection managers
* SHOULD treat this as equivalent to Handle_Type_None.</p>
*
* <p>If this is omitted or is Handle_Type_None,
* \endhtmlonly \link requestPropertyTargetHandle() TargetHandle \endlink \htmlonly and
* \endhtmlonly \link requestPropertyTargetID() TargetID \endlink \htmlonly MUST be omitted from the
* request.</p>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyTargetHandleType() const
{
return internalRequestProperty(QLatin1String("TargetHandleType"));
}
/**
* Asynchronous getter for the remote object property \c Requested of type \c bool.
*
*
* \htmlonly
* <p>True if this channel was created in response to a local request,
* such as a call to
* \endhtmlonly ConnectionInterface::RequestChannel() \htmlonly
* or
* \endhtmlonly ConnectionInterfaceRequestsInterface::CreateChannel() \htmlonly .</p>
*
* <div class="rationale">
* <p>The idea of this property is to distinguish between "incoming"
* and "outgoing" channels, in a way that doesn't break down when
* considering special cases like contact lists that are automatically
* created on connection to the server, or chatrooms that an
* IRC proxy/bouncer like irssi-proxy or bip was already in.</p>
*
* <p>The reason we want to make that distinction is that UIs for
* things that the user explicitly requested should start up
* automatically, whereas for incoming messages and VoIP calls we
* should first ask the user whether they want to open the messaging
* UI or accept the call.</p>
* </div>
*
* <p>If the channel was not explicitly requested (even if it was
* created as a side-effect of a call to one of those functions,
* e.g. because joining a Tube in a MUC context on XMPP implies
* joining that MUC), then this property is false.</p>
*
* <p>For compatibility with older connection managers, clients SHOULD
* assume that this property is true if they see a channel announced
* by the
* \endhtmlonly ConnectionInterface::NewChannel() \htmlonly
* signal with the suppress_handler parameter set to true.</p>
*
* <div class="rationale">
* <p>In a correct connection manager, the only way to get such a
* channel is to request it.</p>
* </div>
*
* <p>Clients MAY additionally assume that this property is false
* if they see a channel announced by the NewChannel signal with the
* suppress_handler parameter set to false.</p>
*
* <div class="rationale">
* <p>This is more controversial, since it's possible to get that
* parameter set to false by requesting a channel. However, there's
* no good reason to do so, and we've deprecated this practice.</p>
*
* <p>In the particular case of the channel dispatcher, the only
* side-effect of wrongly thinking a channel is unrequested
* is likely to be that the user has to confirm that they want to
* use it, so it seems fairly harmless to assume in the channel
* dispatcher that channels with suppress_handler false are
* indeed unrequested.</p>
* </div>
*
* <p>It does not make sense for this property to be in channel
* requests—it will always be true for channels returned by
* CreateChannel, and callers of EnsureChannel cannot control whether an
* existing channel was originally requested locally—so it MUST NOT
* be accepted.</p>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyRequested() const
{
return internalRequestProperty(QLatin1String("Requested"));
}
/**
* Asynchronous getter for the remote object property \c InitiatorHandle of type \c uint.
*
*
* \htmlonly
* <p>The contact who initiated the channel; for instance, the contact
* who invited the local user to a chatroom, or the contact who
* initiated a call.</p>
*
* <p>This does <em>not</em> necessarily represent the contact who
* created the underlying protocol-level construct. For instance, if
* Rob creates a chatroom, Will joins that chatroom, and Will invites Simon
* to join it, then Simon will see Will as the InitiatorHandle of the
* channel representing the chatroom.</p>
*
* <div class="rationale">
* <p>The room creator is generally a less useful piece of information
* than the inviter, is less likely to be available at invitation
* time (i.e. can't necessarily be an immutable property), and is
* less likely to be available at all. The creator of a chatroom
* is not currently available via Telepathy; if added in future, it
* is likely to be made available as a property on the Chatroom
* interface (<a href="http://bugs.freedesktop.org/show_bug.cgi?id=23151">bug 23151</a>).</p>
* </div>
*
* <p>For channels requested by the
* local user, this MUST be the value of
* \endhtmlonly \link ConnectionInterface::requestPropertySelfHandle() ConnectionInterface::SelfHandle \endlink \htmlonly
* at the time the channel was created (i.e. not a channel-specific
* handle).</p>
*
* <div class="rationale">
* <p>On some protocols, the SelfHandle may change (as signalled by
* \endhtmlonly ConnectionInterface::SelfContactChanged() \htmlonly ),
* but this property is immutable. Hence, locally-requested channels'
* InitiatorHandle and InitiatorID may not match the current
* SelfHandle; \endhtmlonly \link requestPropertyRequested() Requested \endlink \htmlonly can be used to
* determine whether the channel was created locally.</p>
* </div>
*
* <p>For channels requested by a remote user, this MUST be their handle.
* If unavailable or not applicable, this MUST be 0 (for instance,
* contact lists are not really initiated by anyone in particular, and
* it's easy to imagine a protocol where chatroom invitations can be
* anonymous).</p>
*
* <p>For channels with the \endhtmlonly ChannelInterfaceGroupInterface \htmlonly
* interface, this SHOULD be the same
* contact who is signalled as the "Actor" causing the self-handle
* to be placed in the local-pending set.</p>
*
* <p>This SHOULD NOT be a channel-specific handle, if possible.</p>
*
* <p>It does not make sense for this property to be in channel
* requests - the initiator will always be the local user - so it
* MUST NOT be accepted.</p>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyInitiatorHandle() const
{
return internalRequestProperty(QLatin1String("InitiatorHandle"));
}
/**
* Asynchronous getter for the remote object property \c InitiatorID of type \c QString.
*
*
* \htmlonly
* <p>The string that would result from inspecting the
* \endhtmlonly \link requestPropertyInitiatorHandle() InitiatorHandle \endlink \htmlonly
* property (i.e. the initiator's identifier in the IM protocol).</p>
*
* <div class="rationale">
* <p>The presence of this property avoids the following race
* condition:</p>
*
* <ul>
* <li>New StreamedMedia channel C is signalled with initiator
* handle I</li>
* <li>Client calls \endhtmlonly ConnectionInterface::InspectHandles() \htmlonly (CONTACT,
* [I])</li>
* <li>Channel C closes, removing the last reference to handle I</li>
* <li> \endhtmlonly ConnectionInterface::InspectHandles() \htmlonly (CONTACT,
* [I]) returns an error</li>
* <li>Client can indicate that a call was missed, but not who
* called!</li>
* </ul>
* </div>
*
* <p>It does not make sense for this property to be in channel
* requests - the initiator will always be the local user - so it
* MUST NOT be accepted.</p>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyInitiatorID() const
{
return internalRequestProperty(QLatin1String("InitiatorID"));
}
/**
* 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 Close on the remote object.
*
* Request that the channel be closed. This is not the case until the
* Closed signal has been emitted, and depending on the connection manager
* this may simply remove you from the channel on the server, rather than
* causing it to stop existing entirely. Some channels such as contact
* list channels may not be closed.
*
* 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<> Close(int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("Close"));
return this->connection().asyncCall(callMessage, timeout);
}
/**
* Begins a call to the D-Bus method \c GetChannelType on the remote object.
*
* Returns the interface name for the type of this channel. Clients SHOULD
* use the ChannelType property instead, falling back to this method only
* if necessary. The GetAll method lets clients retrieve all properties in
* one round-trip.
*
* 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 interface name
*/
inline QDBusPendingReply<QString> GetChannelType(int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<QString>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("GetChannelType"));
return this->connection().asyncCall(callMessage, timeout);
}
/**
* Begins a call to the D-Bus method \c GetHandle on the remote object.
*
* Returns the handle type and number if this channel represents a
* communication with a particular contact, room or server-stored list, or
* zero if it is transient and defined only by its contents. Clients
* SHOULD use the TargetHandle and TargetHandleType properties instead,
* falling back to this method only if necessary. The GetAll method lets
* clients retrieve all properties in one round-trip.
*
* 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 same as TargetHandleType.
*
* \return
*
* The same as TargetHandle.
*/
inline QDBusPendingReply<uint, uint> GetHandle(int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<uint, uint>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("GetHandle"));
return this->connection().asyncCall(callMessage, timeout);
}
/**
* Begins a call to the D-Bus method \c GetInterfaces on the remote object.
*
* Get the optional interfaces implemented by the channel. Clients SHOULD
* use the Interfaces property instead, falling back to this method only
* if necessary. The GetAll method lets clients retrieve all properties in
* one round-trip.
*
* 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 the D-Bus interface names
*/
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);
}
Q_SIGNALS:
/**
* Represents the signal \c Closed on the remote object.
*
* Emitted when the channel has been closed. Method calls on the channel
* are no longer valid after this signal has been emitted, and the
* connection manager may then remove the object from the bus at any point.
*/
void Closed();
protected:
virtual void invalidate(Tp::DBusProxy *, const QString &, const QString &);
};
/**
* \class ChannelInterfaceAnonymityInterface
* \headerfile TelepathyQt/channel.h <TelepathyQt/Channel>
* \ingroup clientchannel
*
* Proxy class providing a 1:1 mapping of the D-Bus interface "org.freedesktop.Telepathy.Channel.Interface.Anonymity".
*/
class TP_QT_EXPORT ChannelInterfaceAnonymityInterface : public Tp::AbstractInterface
{
Q_OBJECT
public:
/**
* Returns the name of the interface "org.freedesktop.Telepathy.Channel.Interface.Anonymity", which this class
* represents.
*
* \return The D-Bus interface name.
*/
static inline QLatin1String staticInterfaceName()
{
return QLatin1String("org.freedesktop.Telepathy.Channel.Interface.Anonymity");
}
/**
* Creates a ChannelInterfaceAnonymityInterface 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.
*/
ChannelInterfaceAnonymityInterface(
const QString& busName,
const QString& objectPath,
QObject* parent = 0
);
/**
* Creates a ChannelInterfaceAnonymityInterface 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.
*/
ChannelInterfaceAnonymityInterface(
const QDBusConnection& connection,
const QString& busName,
const QString& objectPath,
QObject* parent = 0
);
/**
* Creates a ChannelInterfaceAnonymityInterface 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.
*/
ChannelInterfaceAnonymityInterface(Tp::DBusProxy *proxy);
/**
* Creates a ChannelInterfaceAnonymityInterface 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 ChannelInterfaceAnonymityInterface(const Tp::Client::ChannelInterface& mainInterface);
/**
* Creates a ChannelInterfaceAnonymityInterface 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.
*/
ChannelInterfaceAnonymityInterface(const Tp::Client::ChannelInterface& mainInterface, QObject* parent);
/**
* Asynchronous getter for the remote object property \c AnonymityModes of type \c uint.
*
*
* \htmlonly
* The list of initially requested anonymity modes on the channel. This
* MUST NOT change, and is Requestable.
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyAnonymityModes() const
{
return internalRequestProperty(QLatin1String("AnonymityModes"));
}
/**
* Asynchronous getter for the remote object property \c AnonymityMandatory of type \c bool.
*
*
* Whether or not the anonymity settings are required for this channel.
* This MUST NOT change, and is Requestable.
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyAnonymityMandatory() const
{
return internalRequestProperty(QLatin1String("AnonymityMandatory"));
}
/**
* Asynchronous getter for the remote object property \c AnonymousID of type \c QString.
*
*
* \htmlonly
* <p>This is the ID that the remote user of the channel MAY see
* (assuming there's a single ID). For example, for SIP connections
* where the From address has been scrambled by the CM, the scrambled
* address would be available here for the client to see. This is
* completely optional, and MAY be an empty string ("") in
* cases where anonymity modes are not set, or the CM doesn't know
* what the remote contact will see, or any other case where this
* doesn't make sense.</p>
*
* <p>This MAY change over the lifetime of the channel, and SHOULD NOT
* be used with the Request interface.</p>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyAnonymousID() const
{
return internalRequestProperty(QLatin1String("AnonymousID"));
}
/**
* 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();
}
protected:
virtual void invalidate(Tp::DBusProxy *, const QString &, const QString &);
};
/**
* \class ChannelInterfaceCallStateInterface
* \headerfile TelepathyQt/channel.h <TelepathyQt/Channel>
* \ingroup clientchannel
*
* Proxy class providing a 1:1 mapping of the D-Bus interface "org.freedesktop.Telepathy.Channel.Interface.CallState".
*/
class TP_QT_EXPORT ChannelInterfaceCallStateInterface : public Tp::AbstractInterface
{
Q_OBJECT
public:
/**
* Returns the name of the interface "org.freedesktop.Telepathy.Channel.Interface.CallState", which this class
* represents.
*
* \return The D-Bus interface name.
*/
static inline QLatin1String staticInterfaceName()
{
return QLatin1String("org.freedesktop.Telepathy.Channel.Interface.CallState");
}
/**
* Creates a ChannelInterfaceCallStateInterface 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.
*/
ChannelInterfaceCallStateInterface(
const QString& busName,
const QString& objectPath,
QObject* parent = 0
);
/**
* Creates a ChannelInterfaceCallStateInterface 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.
*/
ChannelInterfaceCallStateInterface(
const QDBusConnection& connection,
const QString& busName,
const QString& objectPath,
QObject* parent = 0
);
/**
* Creates a ChannelInterfaceCallStateInterface 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.
*/
ChannelInterfaceCallStateInterface(Tp::DBusProxy *proxy);
/**
* Creates a ChannelInterfaceCallStateInterface 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 ChannelInterfaceCallStateInterface(const Tp::Client::ChannelInterface& mainInterface);
/**
* Creates a ChannelInterfaceCallStateInterface 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.
*/
ChannelInterfaceCallStateInterface(const Tp::Client::ChannelInterface& 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 GetCallStates on the remote object.
*
* Get the current call states for all contacts involved in this call.
*
* 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 current call states. Participants where the call state flags
* would be 0 (all unset) may be omitted from this mapping.
*/
inline QDBusPendingReply<Tp::ChannelCallStateMap> GetCallStates(int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<Tp::ChannelCallStateMap>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("GetCallStates"));
return this->connection().asyncCall(callMessage, timeout);
}
Q_SIGNALS:
/**
* Represents the signal \c CallStateChanged on the remote object.
*
* Emitted when the state of a member of the channel has changed.
*
* \param contact
*
* An integer handle for the contact.
*
* \param state
*
* The new state for this contact.
*/
void CallStateChanged(uint contact, uint state);
protected:
virtual void invalidate(Tp::DBusProxy *, const QString &, const QString &);
};
/**
* \class ChannelInterfaceCaptchaAuthenticationInterface
* \headerfile TelepathyQt/channel.h <TelepathyQt/Channel>
* \ingroup clientchannel
*
* Proxy class providing a 1:1 mapping of the D-Bus interface "org.freedesktop.Telepathy.Channel.Interface.CaptchaAuthentication1".
*/
class TP_QT_EXPORT ChannelInterfaceCaptchaAuthenticationInterface : public Tp::AbstractInterface
{
Q_OBJECT
public:
/**
* Returns the name of the interface "org.freedesktop.Telepathy.Channel.Interface.CaptchaAuthentication1", which this class
* represents.
*
* \return The D-Bus interface name.
*/
static inline QLatin1String staticInterfaceName()
{
return QLatin1String("org.freedesktop.Telepathy.Channel.Interface.CaptchaAuthentication1");
}
/**
* Creates a ChannelInterfaceCaptchaAuthenticationInterface 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.
*/
ChannelInterfaceCaptchaAuthenticationInterface(
const QString& busName,
const QString& objectPath,
QObject* parent = 0
);
/**
* Creates a ChannelInterfaceCaptchaAuthenticationInterface 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.
*/
ChannelInterfaceCaptchaAuthenticationInterface(
const QDBusConnection& connection,
const QString& busName,
const QString& objectPath,
QObject* parent = 0
);
/**
* Creates a ChannelInterfaceCaptchaAuthenticationInterface 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.
*/
ChannelInterfaceCaptchaAuthenticationInterface(Tp::DBusProxy *proxy);
/**
* Creates a ChannelInterfaceCaptchaAuthenticationInterface 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 ChannelInterfaceCaptchaAuthenticationInterface(const Tp::Client::ChannelInterface& mainInterface);
/**
* Creates a ChannelInterfaceCaptchaAuthenticationInterface 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.
*/
ChannelInterfaceCaptchaAuthenticationInterface(const Tp::Client::ChannelInterface& mainInterface, QObject* parent);
/**
* Asynchronous getter for the remote object property \c CanRetryCaptcha of type \c bool.
*
*
* \htmlonly
* <p>If true, \endhtmlonly GetCaptchas() \htmlonly
* can be expected to return new captcha information when
* in the Local_Pending state. If false,
* \endhtmlonly GetCaptchas() \htmlonly will return
* NotAvailable on subsequent calls.</p>
*
* <div class="rationale">
* <p>Refreshing the captcha isn't required to work, although
* some protocols and implementations allow it. This is usually
* done in case a given captcha is unintelligible.</p>
* </div>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyCanRetryCaptcha() const
{
return internalRequestProperty(QLatin1String("CanRetryCaptcha"));
}
/**
* Asynchronous getter for the remote object property \c CaptchaStatus of type \c uint.
*
*
* \htmlonly
* <p>The current status of this channel.</p>
*
* <p>Because only the Handler should call methods on this interface,
* the Handler MAY reduce round-trips by not fetching the initial
* value of this property, and instead assume that is initially
* Local_Pending.</p>
*
* <div class="rationale">
* <p>This assumption normally avoids the need to call GetAll(),
* since the values of \endhtmlonly \link requestPropertyCaptchaError() CaptchaError \endlink \htmlonly
* and \endhtmlonly \link requestPropertyCaptchaErrorDetails() CaptchaErrorDetails \endlink \htmlonly
* are also implied by this assumption, and the only other
* property is \endhtmlonly \link requestPropertyCanRetryCaptcha() CanRetryCaptcha \endlink \htmlonly ,
* which is immutable.</p>
* </div>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyCaptchaStatus() const
{
return internalRequestProperty(QLatin1String("CaptchaStatus"));
}
/**
* Asynchronous getter for the remote object property \c CaptchaError of type \c QString.
*
*
* \htmlonly
* <p>The reason for the \endhtmlonly \link requestPropertyCaptchaStatus() CaptchaStatus \endlink \htmlonly , or
* an empty string if the state is neither Try_Again nor Failed.</p>
*
* <p>Typical values: "", Cancelled, AuthenticationFailed,
* CaptchaNotSupported</p>
*
* <p>In particular, an ordinary authentication failure (as would
* be produced for an incorrect answer) SHOULD be represented by
* <tp:error-ref>AuthenticationFailed</tp:error-ref>,
* cancellation by the user's request SHOULD be represented
* by <tp:error-ref>Cancelled</tp:error-ref>, cancellation due
* to the inability to display the captcha to the user or otherwise
* answer it SHOULD be represented by
* <tp:error-ref>CaptchaNotSupported</tp:error-ref>, and
* cancellation by a local process due to inconsistent or invalid
* challenges from the server SHOULD be represented by
* <tp:error-ref>ServiceConfused</tp:error-ref>.</p>
*
* <p>If this interface appears on a \endhtmlonly ChannelTypeServerAuthenticationInterface \htmlonly
* channel, and connection to the server fails with an authentication
* failure, this error code SHOULD be copied into the
* \endhtmlonly ConnectionInterface::ConnectionError() \htmlonly
* signal.</p>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyCaptchaError() const
{
return internalRequestProperty(QLatin1String("CaptchaError"));
}
/**
* Asynchronous getter for the remote object property \c CaptchaErrorDetails of type \c QVariantMap.
*
*
* \htmlonly
* <p>If \endhtmlonly \link requestPropertyCaptchaError() CaptchaError \endlink \htmlonly is non-empty,
* any additional information about the last
* disconnection; otherwise, the empty map. The keys and values are
* the same as for the second argument of
* \endhtmlonly ConnectionInterface::ConnectionError() \htmlonly .</p>
*
* <p>If this interface appears on a \endhtmlonly ChannelTypeServerAuthenticationInterface \htmlonly
* channel, and connection to the server fails with an authentication
* failure, these details SHOULD be copied into the
* \endhtmlonly ConnectionInterface::ConnectionError() \htmlonly
* signal.</p>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyCaptchaErrorDetails() const
{
return internalRequestProperty(QLatin1String("CaptchaErrorDetails"));
}
/**
* 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 GetCaptchas on the remote object.
*
* \htmlonly
* <p>Gets information regarding each of the captcha methods
* available and which and how many need to be successfully answered</p>
*
* <p>To call this method successfully, the state must be Local_Pending
* or Try_Again. If it is Local_Pending, it remains Local_Pending. If
* called more than once while in Local_Pending state, or if the state
* is Try_Again, this method fetches a new set of captcha challenges,
* if possible, and the state returns to Local_Pending.</p>
*
* <div class="rationale">
* <p>For instance, you could call GetCaptchas again from Local_Pending
* state if the user indicates that they can't understand the
* initially-offered captcha.</p>
*
* <p>This is a method, not a property, so that it can be used to
* fetch more than one set of captcha challenges, and so that
* change notification is not required. Only the Handler should
* call this method and calling GetAll would not reduce round-trips,
* so the usual reasons to prefer a property do not apply here.</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 timeout The timeout in milliseconds.
*
* \return
*
* \htmlonly
* Information about each of the available captcha methods.
* \endhtmlonly
*
* \return
*
* \htmlonly
* The number of captcha methods required to be answered
* in order to successfully complete this captcha challenge
* (most frequently 1, but XMPP allows servers to demand that
* more than one captcha is answered).
* \endhtmlonly
*
* \return
*
* \htmlonly
* The language of each Label in Captcha_Info if available,
* for instance en_US, or "" if unknown.
* \endhtmlonly
*/
inline QDBusPendingReply<Tp::CaptchaInfoList, uint, QString> GetCaptchas(int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<Tp::CaptchaInfoList, uint, QString>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("GetCaptchas"));
return this->connection().asyncCall(callMessage, timeout);
}
/**
* Begins a call to the D-Bus method \c GetCaptchaData on the remote object.
*
* \htmlonly
* <p>Fetch and return the captcha data. In protocols
* where captchas are downloaded out-of-band (for instance via HTTP),
* the connection manager is expected to do so.</p>
* <p>Returns an empty array if the type was "qa"</p>
* <div class="rationale">
* <p>If audio-based and image-based captchas are both available,
* we don't want to waste time downloading the audio until/unless
* the user asks to hear it. The extra D-Bus round-trips are not
* a problem, since they are expected to be quick compared with
* the time taken for the user to solve the captcha.</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 ID
*
* The ID of the captcha of which to retrieve data.
*
* \param mimeType
*
* MIME type picked by the Handler, chosen from the list of MIME types
* received in GetCaptchas. XEP-0158 allows the same captcha to be
* made available in multiple formats, for instance the same spoken
* question as audio/x-wav, application/ogg and audio/speex.
* \param timeout The timeout in milliseconds.
*
* \return
*
* Captcha data as requested.
*/
inline QDBusPendingReply<QByteArray> GetCaptchaData(uint ID, const QString& mimeType, int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<QByteArray>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("GetCaptchaData"));
callMessage << QVariant::fromValue(ID) << QVariant::fromValue(mimeType);
return this->connection().asyncCall(callMessage, timeout);
}
/**
* Begins a call to the D-Bus method \c AnswerCaptchas on the remote object.
*
* \htmlonly
* <p>Answer as many captchas as desired and/or required.</p>
* <p>Callable in state Local_Pending only. State changes to
* Remote_Pending.</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 answers
*
* The mapping of captcha IDs to answer strings.
* \param timeout The timeout in milliseconds.
*/
inline QDBusPendingReply<> AnswerCaptchas(const Tp::CaptchaAnswers& answers, int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("AnswerCaptchas"));
callMessage << QVariant::fromValue(answers);
return this->connection().asyncCall(callMessage, timeout);
}
/**
* Begins a call to the D-Bus method \c CancelCaptcha on the remote object.
*
* \htmlonly
* <p>Cancel. State changes to Failed with error NotAvailable or
* Cancelled if it isn't already Failed. All you can do now is
* to close the channel.</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 reason
*
* Reason for cancelling. This MAY be used to choose an error response
* to the remote server, and SHOULD also be reflected in the
* CaptchaError.
*
* \param debugMessage
*
* A textual description of the reason for cancelling, supplied by the
* Handler. This message SHOULD NOT be sent to the remote server, but
* SHOULD be copied into the 'debug-message' field of the
* CaptchaErrorDetails and ConnectionError.
* \param timeout The timeout in milliseconds.
*/
inline QDBusPendingReply<> CancelCaptcha(uint reason, const QString& debugMessage, int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("CancelCaptcha"));
callMessage << QVariant::fromValue(reason) << QVariant::fromValue(debugMessage);
return this->connection().asyncCall(callMessage, timeout);
}
protected:
virtual void invalidate(Tp::DBusProxy *, const QString &, const QString &);
};
/**
* \class ChannelInterfaceChatStateInterface
* \headerfile TelepathyQt/channel.h <TelepathyQt/Channel>
* \ingroup clientchannel
*
* Proxy class providing a 1:1 mapping of the D-Bus interface "org.freedesktop.Telepathy.Channel.Interface.ChatState".
*/
class TP_QT_EXPORT ChannelInterfaceChatStateInterface : public Tp::AbstractInterface
{
Q_OBJECT
public:
/**
* Returns the name of the interface "org.freedesktop.Telepathy.Channel.Interface.ChatState", which this class
* represents.
*
* \return The D-Bus interface name.
*/
static inline QLatin1String staticInterfaceName()
{
return QLatin1String("org.freedesktop.Telepathy.Channel.Interface.ChatState");
}
/**
* Creates a ChannelInterfaceChatStateInterface 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.
*/
ChannelInterfaceChatStateInterface(
const QString& busName,
const QString& objectPath,
QObject* parent = 0
);
/**
* Creates a ChannelInterfaceChatStateInterface 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.
*/
ChannelInterfaceChatStateInterface(
const QDBusConnection& connection,
const QString& busName,
const QString& objectPath,
QObject* parent = 0
);
/**
* Creates a ChannelInterfaceChatStateInterface 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.
*/
ChannelInterfaceChatStateInterface(Tp::DBusProxy *proxy);
/**
* Creates a ChannelInterfaceChatStateInterface 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 ChannelInterfaceChatStateInterface(const Tp::Client::ChannelInterface& mainInterface);
/**
* Creates a ChannelInterfaceChatStateInterface 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.
*/
ChannelInterfaceChatStateInterface(const Tp::Client::ChannelInterface& mainInterface, QObject* parent);
/**
* Asynchronous getter for the remote object property \c ChatStates of type \c Tp::ChatStateMap.
*
*
* \htmlonly
* <p>A map containing the chat states of all contacts in this
* channel whose chat state is not Inactive.</p>
*
* <p>Contacts in this channel, but who are not listed in this map,
* may be assumed to be in the Inactive state.</p>
*
* <p>In implementations that do not have this property, its value may be
* assumed to be empty until a
* \endhtmlonly ChatStateChanged() \htmlonly signal indicates
* otherwise.</p>
*
* <div class="rationale">
* <p>This property was not present in older versions of telepathy-spec,
* because chat states in XMPP are not state-recoverable (if you
* miss the change notification signal, there's no way to know the
* state). However, this property still allows clients to recover
* state changes that were seen by the CM before the client started
* to deal with the channel.</p>
*
* <p>In CMs that follow older spec versions, assuming Inactive will
* mean that initial chat states will always be assumed to be
* Inactive, which is the best we can do. XEP 0085 specifies
* Inactive as the "neutral" state to be assumed unless told
* otherwise.</p>
* </div>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyChatStates() const
{
return internalRequestProperty(QLatin1String("ChatStates"));
}
/**
* 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 SetChatState on the remote object.
*
* Set the local state and notify other members of the channel that it has
* changed.
*
* 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 state
*
* The new state.
* \param timeout The timeout in milliseconds.
*/
inline QDBusPendingReply<> SetChatState(uint state, int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("SetChatState"));
callMessage << QVariant::fromValue(state);
return this->connection().asyncCall(callMessage, timeout);
}
Q_SIGNALS:
/**
* Represents the signal \c ChatStateChanged on the remote object.
*
* Emitted when the state of a member of the channel has changed. This
* includes local state.
*
* \param contact
*
* An integer handle for the contact.
*
* \param state
*
* The new state of this contact.
*/
void ChatStateChanged(uint contact, uint state);
protected:
virtual void invalidate(Tp::DBusProxy *, const QString &, const QString &);
};
/**
* \class ChannelInterfaceConferenceInterface
* \headerfile TelepathyQt/channel.h <TelepathyQt/Channel>
* \ingroup clientchannel
*
* Proxy class providing a 1:1 mapping of the D-Bus interface "org.freedesktop.Telepathy.Channel.Interface.Conference".
*/
class TP_QT_EXPORT ChannelInterfaceConferenceInterface : public Tp::AbstractInterface
{
Q_OBJECT
public:
/**
* Returns the name of the interface "org.freedesktop.Telepathy.Channel.Interface.Conference", which this class
* represents.
*
* \return The D-Bus interface name.
*/
static inline QLatin1String staticInterfaceName()
{
return QLatin1String("org.freedesktop.Telepathy.Channel.Interface.Conference");
}
/**
* Creates a ChannelInterfaceConferenceInterface 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.
*/
ChannelInterfaceConferenceInterface(
const QString& busName,
const QString& objectPath,
QObject* parent = 0
);
/**
* Creates a ChannelInterfaceConferenceInterface 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.
*/
ChannelInterfaceConferenceInterface(
const QDBusConnection& connection,
const QString& busName,
const QString& objectPath,
QObject* parent = 0
);
/**
* Creates a ChannelInterfaceConferenceInterface 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.
*/
ChannelInterfaceConferenceInterface(Tp::DBusProxy *proxy);
/**
* Creates a ChannelInterfaceConferenceInterface 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 ChannelInterfaceConferenceInterface(const Tp::Client::ChannelInterface& mainInterface);
/**
* Creates a ChannelInterfaceConferenceInterface 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.
*/
ChannelInterfaceConferenceInterface(const Tp::Client::ChannelInterface& mainInterface, QObject* parent);
/**
* Asynchronous getter for the remote object property \c Channels of type \c Tp::ObjectPathList.
*
*
* \htmlonly
* <p>The individual \endhtmlonly ChannelInterface \htmlonly s that
* are continued by this conference, which have the same \endhtmlonly \link ChannelInterface::requestPropertyChannelType() ChannelInterface::ChannelType \endlink \htmlonly as this one, but with \endhtmlonly \link ChannelInterface::requestPropertyTargetHandleType() ChannelInterface::TargetHandleType \endlink \htmlonly = CONTACT.</p>
*
* <p>This property MUST NOT be requestable; instead, the
* \endhtmlonly \link requestPropertyInitialChannels() InitialChannels \endlink \htmlonly property may be
* specified when requesting a channel.</p>
*
* <div class="rationale">
* <p>This is consistent with requesting
* \endhtmlonly \link requestPropertyInitialInviteeHandles() InitialInviteeHandles \endlink \htmlonly and
* \endhtmlonly \link requestPropertyInitialInviteeIDs() InitialInviteeIDs \endlink \htmlonly , rather than
* requesting \endhtmlonly \link ChannelInterfaceGroupInterface::requestPropertyMembers() ChannelInterfaceGroupInterface::Members \endlink \htmlonly
* and some hypothetical ID version of that property.</p>
* </div>
*
* <p>Change notification is via the
* \endhtmlonly ChannelMerged() \htmlonly and
* \endhtmlonly ChannelRemoved() \htmlonly signals.</p>
* \endhtmlonly
*
* \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 InitialChannels of type \c Tp::ObjectPathList.
*
*
* \htmlonly
* <p>The initial value of \endhtmlonly \link requestPropertyChannels() Channels \endlink \htmlonly .</p>
*
* <p>This property SHOULD be requestable. Omitting it from a request is
* equivalent to providing it with an empty list as value. Requests
* where its value has at least two channel paths SHOULD be expected to
* succeed on any implementation of this interface. If
* \endhtmlonly \link requestPropertyInitialInviteeHandles() InitialInviteeHandles \endlink \htmlonly and
* \endhtmlonly \link requestPropertyInitialInviteeIDs() InitialInviteeIDs \endlink \htmlonly are
* <var>Allowed_Properties</var> in \endhtmlonly \link ConnectionInterfaceRequestsInterface::requestPropertyRequestableChannelClasses() ConnectionInterfaceRequestsInterface::RequestableChannelClasses \endlink \htmlonly , then requests with zero
* or one channel paths SHOULD also succeed; otherwise, clients SHOULD
* NOT make requests with zero or one paths for this property.</p>
*
* <div class="rationale">
* <p>In GSM, a pair of calls can be merged into a conference, but you
* can't start a conference call from zero or one existing calls. In
* XMPP and MSN, you can create a new chatroom, or upgrade one 1-1
* channel into a chatroom; however, on these protocols, it is also
* possible to fake GSM-style merging by upgrading the first channel,
* then inviting the targets of all the other channels into it.</p>
* </div>
*
* <p>If possible, the \endhtmlonly \link requestPropertyChannels() Channels \endlink \htmlonly ' states SHOULD
* NOT be altered by merging them into a conference. However, depending on
* the protocol, the Channels MAY be placed in a "frozen" state by placing
* them in this property's value or by calling
* \endhtmlonly org.freedesktop.Telepathy.Channel.Interface.MergeableConference.DRAFT.Merge \htmlonly on them.</p>
*
* <div class="rationale">
* <p>In Jingle, nothing special will happen to merged calls. UIs MAY
* automatically place calls on hold before merging them, if that is
* the desired behaviour; this SHOULD always work. Not doing
* an implicit hold/unhold seems to preserve least-astonishment.</p>
*
* <p>In GSM, the calls that are merged go into a state similar to
* Hold, but they cannot be unheld, only split from the conference
* call using \endhtmlonly org.freedesktop.Telepathy.Channel.Interface.Splittable.DRAFT.Split \htmlonly .</p>
* </div>
*
* <p>Depending on the protocol, it might be signalled to remote users
* that this channel is a continuation of all the requested channels,
* or that it is only a continuation of the first channel in the
* list.</p>
*
* <div class="rationale">
* <p>In MSN, the conference steals the underlying switchboard (protocol
* construct) from one of its component channels, so the conference
* appears to remote users to be a continuation of that channel and no
* other. The connection manager has to make some arbitrary choice, so
* we arbitrarily mandate that it SHOULD choose the first channel in
* the list as the one to continue.</p>
* </div>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyInitialChannels() const
{
return internalRequestProperty(QLatin1String("InitialChannels"));
}
/**
* Asynchronous getter for the remote object property \c InitialInviteeHandles of type \c Tp::UIntList.
*
*
* \htmlonly
* <p>A list of additional contacts invited to this conference when it
* was created.</p>
*
* <p>If it is possible to invite new contacts when creating a conference
* (as opposed to merging several channels into one new conference
* channel), this property SHOULD be requestable, and appear in the allowed
* properties in \endhtmlonly \link ConnectionInterfaceRequestsInterface::requestPropertyRequestableChannelClasses() ConnectionInterfaceRequestsInterface::RequestableChannelClasses \endlink \htmlonly . Otherwise, this property
* SHOULD NOT be requestable, and its value SHOULD always be the empty
* list.</p>
*
* <div class="rationale">
* <p>On GSM you have to place a 1-1 call before you can merge it into a
* conference; on the other hand, you can invite new contacts to XMPP
* Muji calls and XMPP/MSN/Skype ad-hoc chat rooms without starting a
* 1-1 channel with them first.</p>
* </div>
*
* <p>If included in a request, the given contacts are automatically
* invited into the new channel, as if they had been added with
* \endhtmlonly ChannelInterfaceGroupInterface::AddMembers() \htmlonly (InitialInviteeHandles,
* \endhtmlonly \link requestPropertyInvitationMessage() InvitationMessage \endlink \htmlonly ) immediately after
* the channel was created.</p>
*
* <div class="rationale">
* <p>This is a simple convenience API for the common case that a UI
* upgrades a 1-1 chat to a multi-user chat solely in order to invite
* someone else to participate.</p>
* </div>
*
* <p>If the local user was not the initiator of this channel, the
* \endhtmlonly \link ChannelInterfaceGroupInterface::requestPropertySelfHandle() ChannelInterfaceGroupInterface::SelfHandle \endlink \htmlonly SHOULD appear in the value of this
* property, together with any other contacts invited at the same time
* (if that information is known).</p>
*
* <p>InitialInviteeHandles, InitialInviteeIDs and InitialChannels MAY be
* combined in a single request.</p>
*
* <div class="rationale">
* <p>For example, if you have a 1-1 channel C1 with Rob, and you want
* to invite Sjoerd to join the discussion, you can do so by
* requesting a channel with InitialChannels=[C1] and
* InitialInviteeHandles=[sjoerd],
* or InitialChannels=[C1] and
* InitialInviteeIDs=["sjoerd@example.com"].</p>
* </div>
*
* <p>If a request includes some combination of InitialInviteeHandles,
* InitialInviteeIDs and InitialChannels, then the value of
* InitialInviteeHandles on the resulting channel SHOULD be the union of
* the handles from InitialInviteeHandles, the handles corresponding
* to the InitialInviteeIDs, and the target handles of the
* InitialChannels, with any duplicate handles removed. Because this
* property is immutable, its value SHOULD be computed before the
* channel is announced via the NewChannels signal.</p>
*
* <div class="rationale">
* <p>This simplifies identification of new channels in clients - they
* only have to look at one of the properties, not both. For example,
* after either of the requests mentioned above, the NewChannels
* signal would announce the channel with InitialChannels=[C1],
* InitialInviteeHandles=[rob, sjoerd], and
* InitialInviteeIDs=["rob@example.net", "sjoerd.example.com"].</p>
* </div>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyInitialInviteeHandles() const
{
return internalRequestProperty(QLatin1String("InitialInviteeHandles"));
}
/**
* Asynchronous getter for the remote object property \c InitialInviteeIDs of type \c QStringList.
*
*
* \htmlonly
* <p>A list of additional contacts invited to this conference when it
* was created.</p>
*
* <p>This property SHOULD be requestable if and only if
* \endhtmlonly \link requestPropertyInitialInviteeHandles() InitialInviteeHandles \endlink \htmlonly is requestable.
* Its semantics are the same, except that it takes a list of the
* string representations of contact handles; invitations are sent to
* any contact present in either or both of these properties.</p>
*
* <p>When a channel is created, the values of InitialInviteeHandles and
* InitialInviteeIDs MUST correspond to each other. In particular, this
* means that the value of InitialInviteeIDs will include the TargetID
* of each channel in InitialChannels, and the ID corresponding to each
* handle in InitialInviteeHandles.</p>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyInitialInviteeIDs() const
{
return internalRequestProperty(QLatin1String("InitialInviteeIDs"));
}
/**
* Asynchronous getter for the remote object property \c InvitationMessage of type \c QString.
*
*
* \htmlonly
* <p>The message that was sent to the
* \endhtmlonly \link requestPropertyInitialInviteeHandles() InitialInviteeHandles \endlink \htmlonly when they were
* invited.</p>
*
* <p>This property SHOULD be requestable, and appear in the allowed
* properties in \endhtmlonly \link ConnectionInterfaceRequestsInterface::requestPropertyRequestableChannelClasses() ConnectionInterfaceRequestsInterface::RequestableChannelClasses \endlink \htmlonly , in protocols where
* invitations can have an accompanying text message.</p>
*
* <div class="rationale">
* <p>This allows invitations with a message to be sent when using
* \endhtmlonly \link requestPropertyInitialInviteeHandles() InitialInviteeHandles \endlink \htmlonly or
* \endhtmlonly \link requestPropertyInitialInviteeIDs() InitialInviteeIDs \endlink \htmlonly .</p>
* </div>
*
* <p>If the local user was not the initiator of this channel, the
* message with which they were invited (if any) SHOULD appear in the
* value of this property.</p>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyInvitationMessage() const
{
return internalRequestProperty(QLatin1String("InvitationMessage"));
}
/**
* Asynchronous getter for the remote object property \c OriginalChannels of type \c Tp::ChannelOriginatorMap.
*
*
* \htmlonly
* <p>On GSM conference calls, it is possible to have the same phone
* number in a conference twice; for instance, it could be the number of
* a corporate switchboard. This is represented using channel-specific
* handles; whether or not a channel uses channel-specific handles is
* reported in \endhtmlonly \link ChannelInterfaceGroupInterface::requestPropertyGroupFlags() ChannelInterfaceGroupInterface::GroupFlags \endlink \htmlonly .
* The \endhtmlonly \link ChannelInterfaceGroupInterface::requestPropertyHandleOwners() ChannelInterfaceGroupInterface::HandleOwners \endlink \htmlonly
* property specifies the mapping from opaque channel-specific handles
* to actual numbers; this property specifies the original 1-1 channel
* corresponding to each channel-specific handle in the conference.</p>
*
* <p>In protocols where this situation cannot arise, such as XMPP,
* this property MAY remain empty.</p>
*
* <p>For example, consider this situation:</p>
*
* <ol>
* <li>Place a call (with path <tt>/call/to/simon</tt>) to the contact
* <tt>+441234567890</tt> (which is assigned the handle <var>h</var>,
* say), and ask to be put through to Simon McVittie;</li>
* <li>Put that call on hold;</li>
* <li>Place another call (with path <tt>/call/to/jonny</tt>) to
* <tt>+441234567890</tt>, and ask to be put
* through to Jonny Lamb;</li>
* <li>Request a new channel with
* \endhtmlonly \link requestPropertyInitialChannels() InitialChannels \endlink \htmlonly :
* <tt>['/call/to/simon', '/call/to/jonny']</tt>.</li>
* </ol>
*
* <p>The new channel will have the following properties, for some handles
* <var>s</var> and <var>j</var>:</p>
*
* <blockquote>
* <code>{<br/>
* ... \endhtmlonly \link ChannelInterfaceGroupInterface::requestPropertyGroupFlags() ChannelInterfaceGroupInterface::GroupFlags \endlink \htmlonly :
* Channel_Specific_Handles | (other flags),<br/>
* ... \endhtmlonly \link ChannelInterfaceGroupInterface::requestPropertyMembers() ChannelInterfaceGroupInterface::Members \endlink \htmlonly :
* [self_handle, s, j],<br/>
* ... \endhtmlonly \link ChannelInterfaceGroupInterface::requestPropertyHandleOwners() ChannelInterfaceGroupInterface::HandleOwners \endlink \htmlonly :
* { s: h, j: h },<br/>
* ... \endhtmlonly \link requestPropertyInitialChannels() InitialChannels \endlink \htmlonly :
* ['/call/to/simon', '/call/to/jonny'],<br/>
* ... \endhtmlonly \link requestPropertyChannels() Channels \endlink \htmlonly :
* ['/call/to/simon', '/call/to/jonny'],<br/>
* ... \endhtmlonly \link requestPropertyOriginalChannels() OriginalChannels \endlink \htmlonly :
* { s: '/call/to/simon', j: '/call/to/jonny' },<br/>
* # ...standard properties like ChannelType: Group elided...<br/>
* }</code>
* </blockquote>
*
* <p>Change notification is via the
* \endhtmlonly ChannelMerged() \htmlonly and
* \endhtmlonly ChannelRemoved() \htmlonly signals: if
* <var>Channel_Specific_Handle</var> in the former is non-zero, this
* property SHOULD be updated to map that handle to the merged channel's
* path.</p>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyOriginalChannels() const
{
return internalRequestProperty(QLatin1String("OriginalChannels"));
}
/**
* 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 ChannelMerged on the remote object.
*
* \htmlonly
* <p>Emitted when a new channel is added to the value of
* \endhtmlonly \link requestPropertyChannels() Channels \endlink \htmlonly .</p>
* \endhtmlonly
*
* \param channel
*
* The channel that was added to Channels.
*
* \param channelSpecificHandle
*
* A new channel-specific handle for the TargetHandle of Channel, as
* will appear in OriginalChannels, or 0 if a global handle is used
* for Channel's TargetHandle on the Group interface of this
* channel.
*
* \param properties
*
* Channel's immutable properties.
*/
void ChannelMerged(const QDBusObjectPath& channel, uint channelSpecificHandle, const QVariantMap& properties);
/**
* Represents the signal \c ChannelRemoved on the remote object.
*
* \htmlonly
* <p>Emitted when a channel is removed from the value of
* \endhtmlonly \link requestPropertyChannels() Channels \endlink \htmlonly , either because it closed
* or because it was split using the \endhtmlonly org.freedesktop.Telepathy.Channel.Interface.Splittable.DRAFT.Split \htmlonly method.</p>
*
* <p>If a channel is removed because it was closed, \endhtmlonly ChannelInterface::Closed() \htmlonly should be emitted
* before this signal.</p>
* \endhtmlonly
*
* \param channel
*
* The channel that was removed from Channels.
*
* \param details
*
* \htmlonly
* Additional information about the removal, which may include
* the same well-known keys as the Details argument of
* \endhtmlonly ChannelInterfaceGroupInterface::MembersChangedDetailed() \htmlonly , with the same semantics.
* \endhtmlonly
*/
void ChannelRemoved(const QDBusObjectPath& channel, const QVariantMap& details);
protected:
virtual void invalidate(Tp::DBusProxy *, const QString &, const QString &);
};
/**
* \class ChannelInterfaceDTMFInterface
* \headerfile TelepathyQt/channel.h <TelepathyQt/Channel>
* \ingroup clientchannel
*
* Proxy class providing a 1:1 mapping of the D-Bus interface "org.freedesktop.Telepathy.Channel.Interface.DTMF".
*/
class TP_QT_EXPORT ChannelInterfaceDTMFInterface : public Tp::AbstractInterface
{
Q_OBJECT
public:
/**
* Returns the name of the interface "org.freedesktop.Telepathy.Channel.Interface.DTMF", which this class
* represents.
*
* \return The D-Bus interface name.
*/
static inline QLatin1String staticInterfaceName()
{
return QLatin1String("org.freedesktop.Telepathy.Channel.Interface.DTMF");
}
/**
* Creates a ChannelInterfaceDTMFInterface 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.
*/
ChannelInterfaceDTMFInterface(
const QString& busName,
const QString& objectPath,
QObject* parent = 0
);
/**
* Creates a ChannelInterfaceDTMFInterface 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.
*/
ChannelInterfaceDTMFInterface(
const QDBusConnection& connection,
const QString& busName,
const QString& objectPath,
QObject* parent = 0
);
/**
* Creates a ChannelInterfaceDTMFInterface 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.
*/
ChannelInterfaceDTMFInterface(Tp::DBusProxy *proxy);
/**
* Creates a ChannelInterfaceDTMFInterface 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 ChannelInterfaceDTMFInterface(const Tp::Client::ChannelInterface& mainInterface);
/**
* Creates a ChannelInterfaceDTMFInterface 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.
*/
ChannelInterfaceDTMFInterface(const Tp::Client::ChannelInterface& mainInterface, QObject* parent);
/**
* Asynchronous getter for the remote object property \c CurrentlySendingTones of type \c bool.
*
*
* Indicates whether there are DTMF tones currently being sent in the
* channel. If so, the client should wait for StoppedTones signal before
* trying to send more tones.
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyCurrentlySendingTones() const
{
return internalRequestProperty(QLatin1String("CurrentlySendingTones"));
}
/**
* Asynchronous getter for the remote object property \c InitialTones of type \c QString.
*
*
* If non-empty in a channel request that will create a new channel, the
* connection manager should send the tones immediately after at least one
* eligible audio stream has been created in the channel. This should only
* be used with InitialAudio=true. This property is immutable (cannot
* change).
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyInitialTones() const
{
return internalRequestProperty(QLatin1String("InitialTones"));
}
/**
* Asynchronous getter for the remote object property \c DeferredTones of type \c QString.
*
*
* \htmlonly
* <p>The tones waiting for the user to continue, if any.</p>
*
* <p>When this property is set to a non-empty value,
* \endhtmlonly TonesDeferred() \htmlonly is emitted.
* When any tones are played (i.e. whenever
* \endhtmlonly SendingTones() \htmlonly is emitted),
* this property is reset to the empty string.</p>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyDeferredTones() const
{
return internalRequestProperty(QLatin1String("DeferredTones"));
}
/**
* 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 StartTone on the remote object.
*
* Start sending a DTMF tone to all eligible streams in the channel. Where
* possible, the tone will continue until StopTone is called. On certain
* protocols, it may only be possible to send events with a predetermined
* length. In this case, the implementation MAY emit a fixed-length tone,
* and the StopTone method call SHOULD return NotAvailable. The client may
* wish to control the exact duration and timing of the tones sent as a
* result of user's interaction with the dialpad, thus starting and
* stopping the tone sending explicitly. Tone overlaping or queueing is
* not supported, so this method can only be called if no DTMF tones are
* already being played.
*
* 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 streamID
*
* A stream ID as defined in the StreamedMedia channel type. This
* argument is included for backwards compatibility and MUST be
* ignored by the implementations - the tone SHOULD be sent to all
* eligible streams in the channel.
*
* \param event
*
* A numeric event code from the DTMF_Event enum.
* \param timeout The timeout in milliseconds.
*/
inline QDBusPendingReply<> StartTone(uint streamID, uchar event, int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("StartTone"));
callMessage << QVariant::fromValue(streamID) << QVariant::fromValue(event);
return this->connection().asyncCall(callMessage, timeout);
}
/**
* Begins a call to the D-Bus method \c StopTone on the remote object.
*
* Stop sending any DTMF tones which have been started using the StartTone
* or MultipleTones methods. If there is no current tone, this method will
* do nothing. If MultipleTones was used, the client should not assume the
* sending has stopped immediately; instead, the client should wait for
* the StoppedTones signal. On some protocols it might be impossible to
* cancel queued tones immediately.
*
* 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 streamID
*
* A stream ID as defined in the StreamedMedia channel type. This
* argument is included for backwards compatibility and MUST be
* ignored by the implementations - the sending SHOULD be stoped in
* all eligible streams in the channel.
* \param timeout The timeout in milliseconds.
*/
inline QDBusPendingReply<> StopTone(uint streamID, int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("StopTone"));
callMessage << QVariant::fromValue(streamID);
return this->connection().asyncCall(callMessage, timeout);
}
/**
* Begins a call to the D-Bus method \c MultipleTones on the remote object.
*
* Send multiple DTMF events to all eligible streams in the channel. Each
* tone will be played for an implementation-defined number of
* milliseconds (typically 250ms), followed by a gap before the next tone
* is played (typically 100ms). The duration and gap are defined by the
* protocol or connection manager. In cases where the client knows in
* advance the tone sequence it wants to send, it's easier to use
* this method than manually start and stop each tone in the sequence. The
* tone and gap lengths may need to vary for interoperability, according
* to the protocol and other implementations' ability to recognise
* tones. At the time of writing, GStreamer uses a minimum of 250ms tones
* and 100ms gaps when playing in-band DTMF in the normal audio stream, or
* 70ms tones and 50ms gaps when encoding DTMF as audio/telephone-event.
* Tone overlaping or queueing is not supported, so this method can only
* be called if no DTMF tones are already being played.
*
* 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 tones
*
* \htmlonly
* <p>A string representation of one or more DTMF
* events. Implementations of this method MUST support all of the
* following characters in this string:</p>
*
* <ul>
* <li>the digits 0-9, letters A-D and a-d, and symbols '*' and '#'
* correspond to the members of <tp:type>DTMF_Event</tp:type></li>
*
* <li>any of 'p', 'P', 'x', 'X' or ',' (comma) results in an
* implementation-defined pause, typically for 3 seconds</li>
*
* <li>'w' or 'W' waits for the user to continue, by stopping
* interpretation of the string, and if there is more to be played,
* emitting the \endhtmlonly TonesDeferred() \htmlonly signal
* with the rest of the string as its argument: see that signal
* for details</li>
* </ul>
* \endhtmlonly
* \param timeout The timeout in milliseconds.
*/
inline QDBusPendingReply<> MultipleTones(const QString& tones, int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("MultipleTones"));
callMessage << QVariant::fromValue(tones);
return this->connection().asyncCall(callMessage, timeout);
}
Q_SIGNALS:
/**
* Represents the signal \c TonesDeferred on the remote object.
*
* \htmlonly
* <p>Emitted when 'w' or 'W', indicating "wait for the user to continue",
* is encountered while playing a DTMF string queued by
* \endhtmlonly MultipleTones() \htmlonly or
* \endhtmlonly \link requestPropertyInitialTones() InitialTones \endlink \htmlonly . Any queued DTMF events
* after the 'w', which have not yet been played, are placed in the
* \endhtmlonly \link requestPropertyDeferredTones() DeferredTones \endlink \htmlonly property and copied
* into this signal's argument.</p>
*
* <p>When the channel handler is ready to continue, it MAY pass the
* value of \endhtmlonly \link requestPropertyDeferredTones() DeferredTones \endlink \htmlonly to
* \endhtmlonly MultipleTones() \htmlonly , to resume sending.
* Alternatively, it MAY ignore the deferred tones, or even play
* different tones instead. Any deferred tones are discarded the next
* time a tone is played.</p>
*
* <p>This signal SHOULD NOT be emitted if there is nothing left to play,
* i.e. if the 'w' was the last character in the DTMF string.</p>
* \endhtmlonly
*
* \param tones
*
* The new non-empty value of DeferredTones.
*/
void TonesDeferred(const QString& tones);
/**
* Represents the signal \c SendingTones on the remote object.
*
* \htmlonly
* <p>DTMF tone(s)are being sent to all eligible streams in the channel.
* The signal is provided to indicating the fact that the streams are
* currently being used to send one or more DTMF tones, so any other
* media input is not getting through to the audio stream. It also
* serves as a cue for the
* \endhtmlonly StopTone() \htmlonly method.</p>
* \endhtmlonly
*
* \param tones
*
* DTMF string (one or more events) that is to be played.
*/
void SendingTones(const QString& tones);
/**
* Represents the signal \c StoppedTones on the remote object.
*
* \htmlonly
* <p>DTMF tones have finished playing on streams in this channel.</p>
* \endhtmlonly
*
* \param cancelled
*
* True if the DTMF tones were actively cancelled via StopTone.
*/
void StoppedTones(bool cancelled);
protected:
virtual void invalidate(Tp::DBusProxy *, const QString &, const QString &);
};
/**
* \class ChannelInterfaceDestroyableInterface
* \headerfile TelepathyQt/channel.h <TelepathyQt/Channel>
* \ingroup clientchannel
*
* Proxy class providing a 1:1 mapping of the D-Bus interface "org.freedesktop.Telepathy.Channel.Interface.Destroyable".
*/
class TP_QT_EXPORT ChannelInterfaceDestroyableInterface : public Tp::AbstractInterface
{
Q_OBJECT
public:
/**
* Returns the name of the interface "org.freedesktop.Telepathy.Channel.Interface.Destroyable", which this class
* represents.
*
* \return The D-Bus interface name.
*/
static inline QLatin1String staticInterfaceName()
{
return QLatin1String("org.freedesktop.Telepathy.Channel.Interface.Destroyable");
}
/**
* Creates a ChannelInterfaceDestroyableInterface 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.
*/
ChannelInterfaceDestroyableInterface(
const QString& busName,
const QString& objectPath,
QObject* parent = 0
);
/**
* Creates a ChannelInterfaceDestroyableInterface 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.
*/
ChannelInterfaceDestroyableInterface(
const QDBusConnection& connection,
const QString& busName,
const QString& objectPath,
QObject* parent = 0
);
/**
* Creates a ChannelInterfaceDestroyableInterface 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.
*/
ChannelInterfaceDestroyableInterface(Tp::DBusProxy *proxy);
/**
* Creates a ChannelInterfaceDestroyableInterface 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 ChannelInterfaceDestroyableInterface(const Tp::Client::ChannelInterface& mainInterface);
/**
* Creates a ChannelInterfaceDestroyableInterface 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.
*/
ChannelInterfaceDestroyableInterface(const Tp::Client::ChannelInterface& 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 Destroy on the remote object.
*
* \htmlonly
* <p>Close the channel abruptly, possibly with loss of data. The
* connection manager MUST NOT re-create the channel unless/until
* more events occur.</p>
*
* <div class="rationale">
* <p>The main motivating situation for this method is that when a Text
* channel with pending messages is closed with Close, it comes back
* as an incoming channel (to avoid a race between Close and an
* incoming message). If Destroy is called on a Text channel, the CM
* should delete all pending messages and close the channel, and
* the channel shouldn't be re-created until/unless another message
* arrives.</p>
* </div>
*
* <p>Most clients SHOULD call
* \endhtmlonly ChannelInterface::Close() \htmlonly
* instead. However, if a client explicitly intends to destroy the
* channel with possible loss of data, it SHOULD call this method
* if this interface is supported (according to the
* \endhtmlonly \link ChannelInterface::requestPropertyInterfaces() ChannelInterface::Interfaces \endlink \htmlonly
* property), falling back to Close if not.</p>
*
* <p>In particular, channel dispatchers SHOULD use this method if
* available when terminating channels that cannot be handled
* correctly (for instance, if no handler has been installed for
* a channel type, or if the handler crashes repeatedly).</p>
*
* <p>Connection managers do not need to implement this interface on
* channels where Close and Destroy would be equivalent.</p>
*
* <div class="rationale">
* <p>Callers need to be able to fall back to Close in any case.</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 timeout The timeout in milliseconds.
*/
inline QDBusPendingReply<> Destroy(int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("Destroy"));
return this->connection().asyncCall(callMessage, timeout);
}
protected:
virtual void invalidate(Tp::DBusProxy *, const QString &, const QString &);
};
/**
* \class ChannelInterfaceFileTransferMetadataInterface
* \headerfile TelepathyQt/channel.h <TelepathyQt/Channel>
* \ingroup clientchannel
*
* Proxy class providing a 1:1 mapping of the D-Bus interface "org.freedesktop.Telepathy.Channel.Interface.FileTransfer.Metadata".
*/
class TP_QT_EXPORT ChannelInterfaceFileTransferMetadataInterface : public Tp::AbstractInterface
{
Q_OBJECT
public:
/**
* Returns the name of the interface "org.freedesktop.Telepathy.Channel.Interface.FileTransfer.Metadata", which this class
* represents.
*
* \return The D-Bus interface name.
*/
static inline QLatin1String staticInterfaceName()
{
return QLatin1String("org.freedesktop.Telepathy.Channel.Interface.FileTransfer.Metadata");
}
/**
* Creates a ChannelInterfaceFileTransferMetadataInterface 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.
*/
ChannelInterfaceFileTransferMetadataInterface(
const QString& busName,
const QString& objectPath,
QObject* parent = 0
);
/**
* Creates a ChannelInterfaceFileTransferMetadataInterface 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.
*/
ChannelInterfaceFileTransferMetadataInterface(
const QDBusConnection& connection,
const QString& busName,
const QString& objectPath,
QObject* parent = 0
);
/**
* Creates a ChannelInterfaceFileTransferMetadataInterface 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.
*/
ChannelInterfaceFileTransferMetadataInterface(Tp::DBusProxy *proxy);
/**
* Creates a ChannelInterfaceFileTransferMetadataInterface 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 ChannelInterfaceFileTransferMetadataInterface(const Tp::Client::ChannelInterface& mainInterface);
/**
* Creates a ChannelInterfaceFileTransferMetadataInterface 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.
*/
ChannelInterfaceFileTransferMetadataInterface(const Tp::Client::ChannelInterface& mainInterface, QObject* parent);
/**
* Asynchronous getter for the remote object property \c ServiceName of type \c QString.
*
*
* \htmlonly
* <p>A string representing the service name that will be used
* over the file transfer channel. This property is equivalent
* to the \endhtmlonly \link ChannelTypeDBusTubeInterface::requestPropertyServiceName() ChannelTypeDBusTubeInterface::ServiceName \endlink \htmlonly
* and \endhtmlonly \link ChannelTypeStreamTubeInterface::requestPropertyService() ChannelTypeStreamTubeInterface::Service \endlink \htmlonly
* properties. If no service name is given then this property
* will be the empty string.</p>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyServiceName() const
{
return internalRequestProperty(QLatin1String("ServiceName"));
}
/**
* Asynchronous setter for the remote object property \c ServiceName of type \c QString.
*
*
* \htmlonly
* <p>A string representing the service name that will be used
* over the file transfer channel. This property is equivalent
* to the \endhtmlonly \link ChannelTypeDBusTubeInterface::requestPropertyServiceName() ChannelTypeDBusTubeInterface::ServiceName \endlink \htmlonly
* and \endhtmlonly \link ChannelTypeStreamTubeInterface::requestPropertyService() ChannelTypeStreamTubeInterface::Service \endlink \htmlonly
* properties. If no service name is given then this property
* will be the empty string.</p>
* \endhtmlonly
*
* \return A pending operation which will emit finished when the property has been
* set.
*/
inline Tp::PendingOperation *setPropertyServiceName(QString newValue)
{
return internalSetProperty(QLatin1String("ServiceName"), QVariant::fromValue(newValue));
}
/**
* Asynchronous getter for the remote object property \c Metadata of type \c Tp::Metadata.
*
*
* \htmlonly
* <p>Additional information about the file transfer set by the
* channel initiator. If no additional information is given then
* this property will be empty.</p>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyMetadata() const
{
return internalRequestProperty(QLatin1String("Metadata"));
}
/**
* Asynchronous setter for the remote object property \c Metadata of type \c Tp::Metadata.
*
*
* \htmlonly
* <p>Additional information about the file transfer set by the
* channel initiator. If no additional information is given then
* this property will be empty.</p>
* \endhtmlonly
*
* \return A pending operation which will emit finished when the property has been
* set.
*/
inline Tp::PendingOperation *setPropertyMetadata(Tp::Metadata newValue)
{
return internalSetProperty(QLatin1String("Metadata"), 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();
}
protected:
virtual void invalidate(Tp::DBusProxy *, const QString &, const QString &);
};
/**
* \class ChannelInterfaceGroupInterface
* \headerfile TelepathyQt/channel.h <TelepathyQt/Channel>
* \ingroup clientchannel
*
* Proxy class providing a 1:1 mapping of the D-Bus interface "org.freedesktop.Telepathy.Channel.Interface.Group".
*/
class TP_QT_EXPORT ChannelInterfaceGroupInterface : public Tp::AbstractInterface
{
Q_OBJECT
public:
/**
* Returns the name of the interface "org.freedesktop.Telepathy.Channel.Interface.Group", which this class
* represents.
*
* \return The D-Bus interface name.
*/
static inline QLatin1String staticInterfaceName()
{
return QLatin1String("org.freedesktop.Telepathy.Channel.Interface.Group");
}
/**
* Creates a ChannelInterfaceGroupInterface 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.
*/
ChannelInterfaceGroupInterface(
const QString& busName,
const QString& objectPath,
QObject* parent = 0
);
/**
* Creates a ChannelInterfaceGroupInterface 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.
*/
ChannelInterfaceGroupInterface(
const QDBusConnection& connection,
const QString& busName,
const QString& objectPath,
QObject* parent = 0
);
/**
* Creates a ChannelInterfaceGroupInterface 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.
*/
ChannelInterfaceGroupInterface(Tp::DBusProxy *proxy);
/**
* Creates a ChannelInterfaceGroupInterface 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 ChannelInterfaceGroupInterface(const Tp::Client::ChannelInterface& mainInterface);
/**
* Creates a ChannelInterfaceGroupInterface 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.
*/
ChannelInterfaceGroupInterface(const Tp::Client::ChannelInterface& mainInterface, QObject* parent);
/**
* Asynchronous getter for the remote object property \c GroupFlags of type \c uint.
*
*
* An integer representing the bitwise-OR of flags on this channel. The
* user interface can use this to present information about which
* operations are currently valid. Change notification is via the
* GroupFlagsChanged signal.
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyGroupFlags() const
{
return internalRequestProperty(QLatin1String("GroupFlags"));
}
/**
* Asynchronous getter for the remote object property \c HandleOwners of type \c Tp::HandleOwnerMap.
*
*
* A map from channel-specific handles to their owners, including at least
* all of the channel-specific handles in this channel's members,
* local-pending or remote-pending sets as keys. Any handle not in the
* keys of this mapping is not channel-specific in this channel. Handles
* which are channel-specific, but for which the owner is unknown, MUST
* appear in this mapping with 0 as owner. Change notification is via the
* HandleOwnersChanged signal.
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyHandleOwners() const
{
return internalRequestProperty(QLatin1String("HandleOwners"));
}
/**
* Asynchronous getter for the remote object property \c LocalPendingMembers of type \c Tp::LocalPendingInfoList.
*
*
* An array of structs containing handles representing contacts requesting
* channel membership and awaiting local approval with AddMembers.
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyLocalPendingMembers() const
{
return internalRequestProperty(QLatin1String("LocalPendingMembers"));
}
/**
* Asynchronous getter for the remote object property \c Members of type \c Tp::UIntList.
*
*
* The members of this channel.
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyMembers() const
{
return internalRequestProperty(QLatin1String("Members"));
}
/**
* Asynchronous getter for the remote object property \c RemotePendingMembers of type \c Tp::UIntList.
*
*
* An array of handles representing contacts who have been invited to the
* channel and are awaiting remote approval.
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyRemotePendingMembers() const
{
return internalRequestProperty(QLatin1String("RemotePendingMembers"));
}
/**
* Asynchronous getter for the remote object property \c SelfHandle of type \c uint.
*
*
* The handle for the user on this channel (which can also be a local or
* remote pending member), or 0 if the user is not a member at all (which
* is likely to be the case, for instance, on ContactList channels). Note
* that this is different from the result of Connection.GetSelfHandle on
* some protocols, so the value of this handle should always be used with
* the methods of this interface.
*
* \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 MemberIdentifiers of type \c Tp::HandleIdentifierMap.
*
*
* The string identifiers for handles mentioned in this channel, to give
* clients the minimal information necessary to create contacts without
* waiting for round-trips. Connection managers MUST include at least the
* identifiers for SelfHandle, Members, LocalPendingMembers (and their
* actors if any), RemotePendingMembers and HandleOwners.
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyMemberIdentifiers() const
{
return internalRequestProperty(QLatin1String("MemberIdentifiers"));
}
/**
* 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 AddMembers on the remote object.
*
* \htmlonly
* <p>Invite all the given contacts into the channel, or accept requests for
* channel membership for contacts on the pending local list.</p>
*
* <p>A message may be provided along with the request, which will be sent
* to the server if supported. See the CHANNEL_GROUP_FLAG_MESSAGE_ADD and
* CHANNEL_GROUP_FLAG_MESSAGE_ACCEPT
* \endhtmlonly \link requestPropertyGroupFlags() GroupFlags \endlink \htmlonly to see in which cases this
* message should be provided.</p>
*
* <p>Attempting to add contacts who are already members is allowed;
* connection managers must silently accept this, without error.</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
*
* An array of contact handles to invite to the channel
*
* \param message
*
* A string message, which can be blank if desired
* \param timeout The timeout in milliseconds.
*/
inline QDBusPendingReply<> AddMembers(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("AddMembers"));
callMessage << QVariant::fromValue(contacts) << QVariant::fromValue(message);
return this->connection().asyncCall(callMessage, timeout);
}
/**
* Begins a call to the D-Bus method \c GetAllMembers on the remote object.
*
* Returns arrays of all current, local and remote pending channel members.
*
* 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
*
* array of handles of current members
*
* \return
*
* array of handles of local pending members
*
* \return
*
* array of handles of remote pending members
*/
inline QDBusPendingReply<Tp::UIntList, Tp::UIntList, Tp::UIntList> GetAllMembers(int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<Tp::UIntList, Tp::UIntList, Tp::UIntList>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("GetAllMembers"));
return this->connection().asyncCall(callMessage, timeout);
}
/**
* Begins a call to the D-Bus method \c GetGroupFlags on the remote object.
*
* Returns the value of the GroupFlags property.
*
* 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 GroupFlags property
*/
inline QDBusPendingReply<uint> GetGroupFlags(int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<uint>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("GetGroupFlags"));
return this->connection().asyncCall(callMessage, timeout);
}
/**
* Begins a call to the D-Bus method \c GetHandleOwners on the remote object.
*
* If the CHANNEL_GROUP_FLAG_CHANNEL_SPECIFIC_HANDLES flag is set on the
* channel, then the handles of the group members are specific to this
* channel, and are not meaningful in a connection-wide context such as
* contact lists. This method allows you to find the owner of the handle
* if it can be discovered in this channel, or 0 if the owner is not
* available.
*
* 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
*
* A list of integer handles representing members of the channel
* \param timeout The timeout in milliseconds.
*
* \return
*
* An array of integer handles representing the owner handles of the
* given room members, in the same order, or 0 if the owner is not
* available
*/
inline QDBusPendingReply<Tp::UIntList> GetHandleOwners(const Tp::UIntList& handles, 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("GetHandleOwners"));
callMessage << QVariant::fromValue(handles);
return this->connection().asyncCall(callMessage, timeout);
}
/**
* Begins a call to the D-Bus method \c GetLocalPendingMembers on the remote object.
*
* Returns the To_Be_Added handle (only) for each structure in the
* LocalPendingMembers property.
*
* 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<Tp::UIntList> GetLocalPendingMembers(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("GetLocalPendingMembers"));
return this->connection().asyncCall(callMessage, timeout);
}
/**
* Begins a call to the D-Bus method \c GetLocalPendingMembersWithInfo on the remote object.
*
* Returns the LocalPendingMembers property.
*
* 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 containing: A handle representing the contact
* requesting channel membership A handle representing the contact
* making the request, or 0 if unknown The reason for the request: one
* of the values of Channel_Group_Change_Reason A string message
* containing the reason for the request if any (or blank if none)
*/
inline QDBusPendingReply<Tp::LocalPendingInfoList> GetLocalPendingMembersWithInfo(int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<Tp::LocalPendingInfoList>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("GetLocalPendingMembersWithInfo"));
return this->connection().asyncCall(callMessage, timeout);
}
/**
* Begins a call to the D-Bus method \c GetMembers on the remote object.
*
* Returns the Members property.
*
* 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<Tp::UIntList> GetMembers(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("GetMembers"));
return this->connection().asyncCall(callMessage, timeout);
}
/**
* Begins a call to the D-Bus method \c GetRemotePendingMembers on the remote object.
*
* Returns an array of handles representing contacts who have been invited
* to the channel and are awaiting remote approval.
*
* 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<Tp::UIntList> GetRemotePendingMembers(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("GetRemotePendingMembers"));
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.
*
* 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<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 RemoveMembers on the remote object.
*
* \htmlonly
* <p>Requests the removal of contacts from a channel, reject their
* request for channel membership on the pending local list, or
* rescind their invitation on the pending remote list.</p>
*
* <p>If the \endhtmlonly \link requestPropertySelfHandle() SelfHandle \endlink \htmlonly is in a Group,
* it can be removed via this method, in order to leave the group
* gracefully. This is the recommended way to leave a chatroom, close
* or reject a \endhtmlonly ChannelTypeStreamedMediaInterface \htmlonly
* call, and so on.</p>
*
* <p>Accordingly, connection managers SHOULD support
* doing this, regardless of the value of
* \endhtmlonly \link requestPropertyGroupFlags() GroupFlags \endlink \htmlonly .
* If doing so fails with PermissionDenied, this is considered to a bug
* in the connection manager, but clients MUST recover by falling back
* to closing the channel with the \endhtmlonly ChannelInterface::Close() \htmlonly
* method.</p>
*
* <p>Removing any contact from the local pending list is always
* allowed. Removing contacts other than the
* \endhtmlonly \link requestPropertySelfHandle() SelfHandle \endlink \htmlonly from the channel's members
* is allowed if and only if Channel_Group_Flag_Can_Remove is in the
* \endhtmlonly \link requestPropertyGroupFlags() GroupFlags \endlink \htmlonly ,
* while removing contacts other than the
* \endhtmlonly \link requestPropertySelfHandle() SelfHandle \endlink \htmlonly from the remote pending list
* is allowed if and only if Channel_Group_Flag_Can_Rescind is in the
* \endhtmlonly \link requestPropertyGroupFlags() GroupFlags \endlink \htmlonly .</p>
*
* <p>A message may be provided along with the request, which will be
* sent to the server if supported. See the
* Channel_Group_Flag_Message_Remove,
* Channel_Group_Flag_Message_Depart,
* Channel_Group_Flag_Message_Reject and
* Channel_Group_Flag_Message_Rescind
* \endhtmlonly \link requestPropertyGroupFlags() GroupFlags \endlink \htmlonly to see in which cases this
* message should be provided.</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
*
* An array of contact handles to remove from the channel
*
* \param message
*
* A string message, which can be blank if desired
* \param timeout The timeout in milliseconds.
*/
inline QDBusPendingReply<> RemoveMembers(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("RemoveMembers"));
callMessage << QVariant::fromValue(contacts) << QVariant::fromValue(message);
return this->connection().asyncCall(callMessage, timeout);
}
/**
* Begins a call to the D-Bus method \c RemoveMembersWithReason on the remote object.
*
* As RemoveMembers, but a reason code may be provided where appropriate.
* The reason code may be ignored if the underlying protocol is unable to
* represent the given reason.
*
* 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 contact handles to remove from the channel
*
* \param message
*
* A string message, which can be blank if desired
*
* \param reason
*
* A reason for the change
* \param timeout The timeout in milliseconds.
*/
inline QDBusPendingReply<> RemoveMembersWithReason(const Tp::UIntList& contacts, const QString& message, uint reason, int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("RemoveMembersWithReason"));
callMessage << QVariant::fromValue(contacts) << QVariant::fromValue(message) << QVariant::fromValue(reason);
return this->connection().asyncCall(callMessage, timeout);
}
Q_SIGNALS:
/**
* Represents the signal \c HandleOwnersChanged on the remote object.
*
* Emitted whenever the HandleOwners property changes.
*
* \param added
*
* A map from channel-specific handles to their owners, in which the
* keys include all the handles that were added to the keys of the
* HandleOwners property, and all the handles in that property whose
* owner has changed
*
* \param removed
*
* The channel-specific handles that were removed from the keys of the
* HandleOwners property, as a result of the contact leaving this
* group in a previous MembersChanged signal
*/
void HandleOwnersChanged(const Tp::HandleOwnerMap& added, const Tp::UIntList& removed);
/**
* Represents the signal \c HandleOwnersChangedDetailed on the remote object.
*
* Emitted whenever the HandleOwners property changes. Clients can assume
* this signal is emitted by the Connection Manager if the
* MemberIdentifiers property exists
*
* \param added
*
* A map from channel-specific handles to their owners, in which the
* keys include all the handles that were added to the keys of the
* HandleOwners property, and all the handles in that property whose
* owner has changed
*
* \param removed
*
* The channel-specific handles that were removed from the keys of the
* HandleOwners property, as a result of the contact leaving this
* group in a previous MembersChanged signal
*
* \param identifiers
*
* The string identifiers for handles mentioned in this signal, to
* give clients the minimal information necessary to create contacts
* without waiting for round-trips. Connection managers MUST include
* at least the identifiers for all handles in the Added map, and MAY
* include those from Removed array.
*/
void HandleOwnersChangedDetailed(const Tp::HandleOwnerMap& added, const Tp::UIntList& removed, const Tp::HandleIdentifierMap& identifiers);
/**
* Represents the signal \c SelfHandleChanged on the remote object.
*
* Emitted whenever the SelfHandle property changes.
*
* \param selfHandle
*
* The new value of the SelfHandle property.
*/
void SelfHandleChanged(uint selfHandle);
/**
* Represents the signal \c SelfContactChanged on the remote object.
*
* Emitted whenever the SelfHandle property changes. Clients can assume
* this signal is emitted by the Connection Manager if the
* MemberIdentifiers property exists.
*
* \param selfHandle
*
* The new value of the SelfHandle property.
*
* \param selfID
*
* The new value of the SelfHandle property's identifier.
*/
void SelfContactChanged(uint selfHandle, const QString& selfID);
/**
* Represents the signal \c GroupFlagsChanged on the remote object.
*
* Emitted when the flags as returned by GetGroupFlags are changed. The
* user interface should be updated as appropriate.
*
* \param added
*
* A bitwise OR of the flags which have been set
*
* \param removed
*
* A bitwise OR of the flags which have been cleared
*/
void GroupFlagsChanged(uint added, uint removed);
/**
* Represents the signal \c MembersChanged on the remote object.
*
* \htmlonly
* <p>Emitted when contacts join any of the three lists (members, local
* pending or remote pending) or when they leave any of the three lists.
* There may also be a message from the server regarding this change,
* which may be displayed to the user if desired.</p>
*
* <p>All channel-specific handles that are mentioned in this signal
* MUST be represented in the value of the
* \endhtmlonly \link requestPropertyHandleOwners() HandleOwners \endlink \htmlonly property.
* In practice, this will mean that
* \endhtmlonly HandleOwnersChanged() \htmlonly is
* emitted <em>before</em> emitting a MembersChanged signal in which
* channel-specific handles are added, but that it is emitted
* <em>after</em> emitting a MembersChanged signal in which
* channel-specific handles are removed.</p>
*
* <p>See \endhtmlonly ChannelTypeStreamedMediaInterface \htmlonly
* for an overview of how group state changes are used to indicate the
* progress of a call.</p>
* \endhtmlonly
*
* \param message
*
* A string message from the server, or blank if not
*
* \param added
*
* A list of members added to the channel
*
* \param removed
*
* A list of members removed from the channel
*
* \param localPending
*
* A list of members who are pending local approval
*
* \param remotePending
*
* A list of members who are pending remote approval
*
* \param actor
*
* The contact handle of the person who made the change, or 0 if not
* known
*
* \param reason
*
* A reason for the change
*/
void MembersChanged(const QString& message, const Tp::UIntList& added, const Tp::UIntList& removed, const Tp::UIntList& localPending, const Tp::UIntList& remotePending, uint actor, uint reason);
/**
* Represents the signal \c MembersChangedDetailed on the remote object.
*
* \htmlonly
* <p>Emitted when contacts join any of the three lists (members, local
* pending or remote pending) or when they leave any of the three
* lists. This signal provides a superset of the information provided by
* \endhtmlonly MembersChanged() \htmlonly ;
* if the channel's \endhtmlonly \link requestPropertyGroupFlags() GroupFlags \endlink \htmlonly
* contains Members_Changed_Detailed, then clients may listen exclusively
* to this signal in preference to that signal.</p>
*
* <p>All channel-specific handles that are mentioned in this signal
* MUST be represented in the value of the
* \endhtmlonly \link requestPropertyHandleOwners() HandleOwners \endlink \htmlonly property. In practice,
* this will mean that
* \endhtmlonly HandleOwnersChanged() \htmlonly is emitted
* <em>before</em> emitting a MembersChangedDetailed signal in which
* channel-specific handles are added, but that it is emitted
* <em>after</em> emitting a MembersChangedDetailed signal in which
* channel-specific handles are removed.</p>
*
* <p>See \endhtmlonly ChannelTypeStreamedMediaInterface \htmlonly
* for an overview of how group state changes are used to indicate the
* progress of a call.</p>
* \endhtmlonly
*
* \param added
*
* A list of members added to the channel
*
* \param removed
*
* A list of members removed from the channel
*
* \param localPending
*
* A list of members who are pending local approval
*
* \param remotePending
*
* A list of members who are pending remote approval
*
* \param details
*
* \htmlonly
* <p>Information about the change, which may include the following
* well-known keys:</p>
*
* <dl>
* <dt>actor (u — <tp:type>Contact_Handle</tp:type>)</dt>
* <dd>The contact handle of the person who made the change; 0 or
* omitted if unknown or not applicable.</dd>
*
* <dt>change-reason (u — <tp:type>Channel_Group_Change_Reason</tp:type>)</dt>
* <dd>A reason for the change.</dd>
*
* <dt>contact-ids (a{us} — <tp:type>Handle_Identifier_Map</tp:type>)</dt>
* <dd>
* <p>The string identifiers for handles mentioned in this signal, to
* give clients the minimal information necessary to react to the
* event without waiting for round-trips. Connection managers
* SHOULD include the identifiers for members added to the group and
* for the actor (if any); they MAY omit the identifiers for handles
* which have been removed from the group.</p>
*
* <div class="rationale">
* <p>On IRC, an event such as a netsplit could cause the vast
* majority of a channel to leave. Given that clients should
* already know the identifiers of a channel's members, including
* potentially hundreds of strings in the netsplit signal is
* unnecessary.</p>
* </div>
*
* <p>Clients MUST NOT assume that the presence or absence of a
* handle in this mapping is meaningful. This mapping is merely
* an optimization for round-trip reduction, and connection
* managers MAY add additional handles, omit some handles, or
* omit the mapping completely.</p>
* </dd>
*
* <dt>message (s)</dt>
* <dd>A string message from the server regarding the change</dd>
*
* <dt>error (s — <tp:type>DBus_Error_Name</tp:type>)</dt>
* <dd>A (possibly implementation-specific) DBus error describing the
* change, providing more specific information than the
* <tp:type>Channel_Group_Change_Reason</tp:type> enum allows. This
* MUST only be present if it is strictly more informative than
* 'change-reason'; if present, 'change-reason' MUST be set to the
* closest available reason.
*
* <div class="rationale">
* A SIP connection manager might want to signal "402 Payment
* required" as something more specific than Error or
* Permission_Denied so that a SIP-aware UI could handle it
* specially; including a namespaced error permits this to be done
* without <tp:type>Channel_Group_Change_Reason</tp:type> being
* extended to encompass every error any CM ever wants to report.
* </div>
* </dd>
*
* <dt>debug-message (s)</dt>
* <dd>Debugging information on the change. SHOULD NOT be shown to
* users in normal circumstances.</dd>
* </dl>
* \endhtmlonly
*/
void MembersChangedDetailed(const Tp::UIntList& added, const Tp::UIntList& removed, const Tp::UIntList& localPending, const Tp::UIntList& remotePending, const QVariantMap& details);
protected:
virtual void invalidate(Tp::DBusProxy *, const QString &, const QString &);
};
/**
* \class ChannelInterfaceHoldInterface
* \headerfile TelepathyQt/channel.h <TelepathyQt/Channel>
* \ingroup clientchannel
*
* Proxy class providing a 1:1 mapping of the D-Bus interface "org.freedesktop.Telepathy.Channel.Interface.Hold".
*/
class TP_QT_EXPORT ChannelInterfaceHoldInterface : public Tp::AbstractInterface
{
Q_OBJECT
public:
/**
* Returns the name of the interface "org.freedesktop.Telepathy.Channel.Interface.Hold", which this class
* represents.
*
* \return The D-Bus interface name.
*/
static inline QLatin1String staticInterfaceName()
{
return QLatin1String("org.freedesktop.Telepathy.Channel.Interface.Hold");
}
/**
* Creates a ChannelInterfaceHoldInterface 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.
*/
ChannelInterfaceHoldInterface(
const QString& busName,
const QString& objectPath,
QObject* parent = 0
);
/**
* Creates a ChannelInterfaceHoldInterface 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.
*/
ChannelInterfaceHoldInterface(
const QDBusConnection& connection,
const QString& busName,
const QString& objectPath,
QObject* parent = 0
);
/**
* Creates a ChannelInterfaceHoldInterface 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.
*/
ChannelInterfaceHoldInterface(Tp::DBusProxy *proxy);
/**
* Creates a ChannelInterfaceHoldInterface 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 ChannelInterfaceHoldInterface(const Tp::Client::ChannelInterface& mainInterface);
/**
* Creates a ChannelInterfaceHoldInterface 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.
*/
ChannelInterfaceHoldInterface(const Tp::Client::ChannelInterface& 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 GetHoldState on the remote object.
*
* Return whether the local user has placed the channel on hold.
*
* 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 state of the channel
*
* \return
*
* The reason why the channel is in that state
*/
inline QDBusPendingReply<uint, uint> GetHoldState(int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<uint, uint>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("GetHoldState"));
return this->connection().asyncCall(callMessage, timeout);
}
/**
* Begins a call to the D-Bus method \c RequestHold on the remote object.
*
* \htmlonly
* <p>Request that the channel be put on hold (be instructed not to send
* any media streams to you) or be taken off hold.</p>
*
* <p>If the connection manager can immediately tell that the requested
* state change could not possibly succeed, this method SHOULD
* return the NotAvailable error. If the requested state is the
* same as the current state, this method SHOULD return successfully
* without doing anything.</p>
*
* <p>Otherwise, this method SHOULD immediately set the hold state to
* Local_Hold_State_Pending_Hold or Local_Hold_State_Pending_Unhold
* (as appropriate), emitting
* \endhtmlonly HoldStateChanged() \htmlonly if this is a change,
* and return successfully.</p>
*
* <p>The eventual success or failure of the request is indicated by a
* subsequent HoldStateChanged signal, changing the hold state to
* Local_Hold_State_Held or Local_Hold_State_Unheld.</p>
*
* <p>If the channel has multiple streams, and the connection manager
* succeeds in changing the hold state of one stream but fails to
* change the hold state of another, it SHOULD attempt to revert
* all streams to their previous hold states.</p>
*
* <p>The following state transitions SHOULD be used, where
* appropriate:</p>
*
* <ul>
* <li>Successful hold:
* (Unheld, any reason) → (Pending_Hold, Requested) →
* (Held, Requested)
* </li>
* <li>Successful unhold:
* (Held, any reason) → (Pending_Unhold, Requested) →
* (Unheld, Requested)
* </li>
* <li>Attempting to unhold fails at the first attempt to acquire a
* resource:
* (Held, any reason) → (Pending_Unhold, Requested) →
* (Held, Resource_Not_Available)
* </li>
* <li>Attempting to unhold acquires one resource, but fails to acquire
* a second, and takes time to release the first:
* (Held, any reason) → (Pending_Unhold, Requested) →
* (Pending_Hold, Resource_Not_Available) →
* (Held, Resource_Not_Available)
* </li>
* </ul>
* \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 hold
*
* A boolean indicating whether or not the channel should be on hold
* \param timeout The timeout in milliseconds.
*/
inline QDBusPendingReply<> RequestHold(bool hold, int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("RequestHold"));
callMessage << QVariant::fromValue(hold);
return this->connection().asyncCall(callMessage, timeout);
}
Q_SIGNALS:
/**
* Represents the signal \c HoldStateChanged on the remote object.
*
* Emitted to indicate that the hold state has changed for this channel.
* This may occur as a consequence of you requesting a change with
* RequestHold, or the state changing as a result of a request from
* another process.
*
* \param holdState
*
* The state of the channel
*
* \param reason
*
* The reason for the state change
*/
void HoldStateChanged(uint holdState, uint reason);
protected:
virtual void invalidate(Tp::DBusProxy *, const QString &, const QString &);
};
/**
* \class ChannelInterfaceMediaSignallingInterface
* \headerfile TelepathyQt/channel.h <TelepathyQt/Channel>
* \ingroup clientchannel
*
* Proxy class providing a 1:1 mapping of the D-Bus interface "org.freedesktop.Telepathy.Channel.Interface.MediaSignalling".
*/
class TP_QT_EXPORT ChannelInterfaceMediaSignallingInterface : public Tp::AbstractInterface
{
Q_OBJECT
public:
/**
* Returns the name of the interface "org.freedesktop.Telepathy.Channel.Interface.MediaSignalling", which this class
* represents.
*
* \return The D-Bus interface name.
*/
static inline QLatin1String staticInterfaceName()
{
return QLatin1String("org.freedesktop.Telepathy.Channel.Interface.MediaSignalling");
}
/**
* Creates a ChannelInterfaceMediaSignallingInterface 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.
*/
ChannelInterfaceMediaSignallingInterface(
const QString& busName,
const QString& objectPath,
QObject* parent = 0
);
/**
* Creates a ChannelInterfaceMediaSignallingInterface 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.
*/
ChannelInterfaceMediaSignallingInterface(
const QDBusConnection& connection,
const QString& busName,
const QString& objectPath,
QObject* parent = 0
);
/**
* Creates a ChannelInterfaceMediaSignallingInterface 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.
*/
ChannelInterfaceMediaSignallingInterface(Tp::DBusProxy *proxy);
/**
* Creates a ChannelInterfaceMediaSignallingInterface 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 ChannelInterfaceMediaSignallingInterface(const Tp::Client::ChannelInterface& mainInterface);
/**
* Creates a ChannelInterfaceMediaSignallingInterface 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.
*/
ChannelInterfaceMediaSignallingInterface(const Tp::Client::ChannelInterface& 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 GetSessionHandlers on the remote object.
*
* Returns all currently active session handlers on this channel as a list
* of (session_handler_path, 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 timeout The timeout in milliseconds.
*/
inline QDBusPendingReply<Tp::MediaSessionHandlerInfoList> GetSessionHandlers(int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<Tp::MediaSessionHandlerInfoList>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("GetSessionHandlers"));
return this->connection().asyncCall(callMessage, timeout);
}
Q_SIGNALS:
/**
* Represents the signal \c NewSessionHandler on the remote object.
*
* Signal that a session handler object has been created. The client
* should create a session object and create streams for the streams
* within.
*
* \param sessionHandler
*
* Object path of the new Media.SessionHandler object
*
* \param sessionType
*
* String indicating type of session, eg "rtp"
*/
void NewSessionHandler(const QDBusObjectPath& sessionHandler, const QString& sessionType);
protected:
virtual void invalidate(Tp::DBusProxy *, const QString &, const QString &);
};
/**
* \class ChannelInterfaceMessagesInterface
* \headerfile TelepathyQt/channel.h <TelepathyQt/Channel>
* \ingroup clientchannel
*
* Proxy class providing a 1:1 mapping of the D-Bus interface "org.freedesktop.Telepathy.Channel.Interface.Messages".
*/
class TP_QT_EXPORT ChannelInterfaceMessagesInterface : public Tp::AbstractInterface
{
Q_OBJECT
public:
/**
* Returns the name of the interface "org.freedesktop.Telepathy.Channel.Interface.Messages", which this class
* represents.
*
* \return The D-Bus interface name.
*/
static inline QLatin1String staticInterfaceName()
{
return QLatin1String("org.freedesktop.Telepathy.Channel.Interface.Messages");
}
/**
* Creates a ChannelInterfaceMessagesInterface 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.
*/
ChannelInterfaceMessagesInterface(
const QString& busName,
const QString& objectPath,
QObject* parent = 0
);
/**
* Creates a ChannelInterfaceMessagesInterface 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.
*/
ChannelInterfaceMessagesInterface(
const QDBusConnection& connection,
const QString& busName,
const QString& objectPath,
QObject* parent = 0
);
/**
* Creates a ChannelInterfaceMessagesInterface 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.
*/
ChannelInterfaceMessagesInterface(Tp::DBusProxy *proxy);
/**
* Creates a ChannelInterfaceMessagesInterface 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 ChannelInterfaceMessagesInterface(const Tp::Client::ChannelInterface& mainInterface);
/**
* Creates a ChannelInterfaceMessagesInterface 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.
*/
ChannelInterfaceMessagesInterface(const Tp::Client::ChannelInterface& mainInterface, QObject* parent);
/**
* Asynchronous getter for the remote object property \c SupportedContentTypes of type \c QStringList.
*
*
* \htmlonly
* <p>A list of MIME types supported by this channel, with more preferred
* MIME types appearing earlier in the list. The list MAY include "*/*"
* to indicate that attachments with arbitrary MIME types can be sent.
* This list MUST NOT be empty, since all Messages implementations
* MUST accept messages containing a single "text/plain" part.</p>
*
* <p>Items in this list MUST be normalized to lower-case.</p>
*
* <p>Some examples of how this property interacts with the
* \endhtmlonly \link requestPropertyMessagePartSupportFlags() MessagePartSupportFlags \endlink \htmlonly :</p>
*
* <dl>
* <dt>A simple IM implementation: only plain text messages are
* allowed</dt>
* <dd>SupportedContentTypes = ['text/plain'],
* MessagePartSupportFlags = 0</dd>
*
* <dt>Formatted text with a plain text alternative is allowed (see the
* HTML interface draft)</dt>
* <dd>SupportedContentTypes = ['text/html', 'text/plain'],
* MessagePartSupportFlags = 0</dd>
*
* <dt>JPEG or PNG images may be sent, but without any attached
* text</dt>
* <dd>SupportedContentTypes = ['text/plain', 'image/jpeg',
* 'image/png'], MessagePartSupportFlags = 0</dd>
*
* <dt>Unformatted text to which an optional JPEG or PNG image may be
* attached</dt>
* <dd>SupportedContentTypes = ['text/plain', 'image/jpeg',
* 'image/png'], MessagePartSupportFlags = One_Attachment</dd>
*
* <dt>Formatted text to which arbitrarily many images may be
* attached</dt>
* <dd>SupportedContentTypes = ['text/html', 'text/plain', 'image/jpeg',
* 'image/png', 'image/x-ms-bmp'], MessagePartSupportFlags =
* One_Attachment | Multiple_Attachments</dd>
*
* <dt>A full SIP implementation: arbitrary MIME messages are
* allowed</dt>
* <dd>SupportedContentTypes = ['*/*'], MessagePartSupportFlags =
* One_Attachment | Multiple_Attachments</dd>
* </dl>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertySupportedContentTypes() const
{
return internalRequestProperty(QLatin1String("SupportedContentTypes"));
}
/**
* Asynchronous getter for the remote object property \c MessageTypes of type \c Tp::UIntList.
*
*
* \htmlonly
* <p>A list of message types which may be sent on this channel.</p>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyMessageTypes() const
{
return internalRequestProperty(QLatin1String("MessageTypes"));
}
/**
* Asynchronous getter for the remote object property \c MessagePartSupportFlags of type \c uint.
*
*
* Flags indicating the level of support for message parts on this channel.
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyMessagePartSupportFlags() const
{
return internalRequestProperty(QLatin1String("MessagePartSupportFlags"));
}
/**
* Asynchronous getter for the remote object property \c PendingMessages of type \c Tp::MessagePartListList.
*
*
* \htmlonly
* <p>A list of incoming messages that have neither been acknowledged nor
* rejected. This list is a more detailed version of the one returned
* by \endhtmlonly ChannelTypeTextInterface::ListPendingMessages() \htmlonly ,
* and contains the same messages, uniquely identified by the same
* pending message IDs. Its items can be removed using
* \endhtmlonly ChannelTypeTextInterface::AcknowledgePendingMessages() \htmlonly .</p>
*
* <p>Change notification is via
* \endhtmlonly MessageReceived() \htmlonly and
* \endhtmlonly PendingMessagesRemoved() \htmlonly .</p>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyPendingMessages() const
{
return internalRequestProperty(QLatin1String("PendingMessages"));
}
/**
* Asynchronous getter for the remote object property \c DeliveryReportingSupport of type \c uint.
*
*
* A bitfield indicating features supported by this channel.
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyDeliveryReportingSupport() const
{
return internalRequestProperty(QLatin1String("DeliveryReportingSupport"));
}
/**
* 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 SendMessage on the remote object.
*
* \htmlonly
* <p>Submit a message to the server for sending.
* If this method returns successfully, the message has been submitted
* to the server and the \endhtmlonly MessageSent() \htmlonly
* signal is emitted. A corresponding
* \endhtmlonly ChannelTypeTextInterface::Sent() \htmlonly
* signal on the Text interface MUST also be emitted.</p>
*
* <p>This method MUST return before the MessageSent signal is
* emitted.</p>
*
* <div class="rationale">
* <p>This means that the process sending the message is the first
* to see the <tp:type>Protocol_Message_Token</tp:type>, and can
* relate the message to the corresponding
* \endhtmlonly MessageSent() \htmlonly signal by comparing
* message tokens (if supported by the protocol).</p>
* </div>
*
* <p>If this method fails, message submission to the server has failed
* and no signal on this interface (or the Text interface) is
* emitted.</p>
*
* <p>If this method succeeds, message submission to the server has
* succeeded, but the message has not necessarily reached its intended
* recipient. If a delivery failure is detected later, this is
* signalled by receiving a message whose <code>message-type</code>
* header maps to
* <tp:value-ref type="Channel_Text_Message_Type">Delivery_Report</tp:value-ref>.
* Similarly, if delivery is detected to have been successful
* (which is not possible in all protocols), a successful delivery
* report will be signalled.</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 message
*
* The message content, including any attachments or alternatives.
* This MUST NOT include the following headers, or any others that do
* not make sense for a client to specify: message-sender,
* message-sender-id, message-sent, message-received,
* pending-message-id.
*
* \param flags
*
* Flags affecting how the message is sent. The channel MAY ignore
* some or all flags, depending on DeliveryReportingSupport; the flags
* that were handled by the CM are provided in MessageSent.
* \param timeout The timeout in milliseconds.
*
* \return
*
* An opaque token used to match any incoming delivery or failure
* reports against this message, or an empty string if the message is
* not readily identifiable.
*/
inline QDBusPendingReply<QString> SendMessage(const Tp::MessagePartList& message, uint flags, int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<QString>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("SendMessage"));
callMessage << QVariant::fromValue(message) << QVariant::fromValue(flags);
return this->connection().asyncCall(callMessage, timeout);
}
/**
* Begins a call to the D-Bus method \c GetPendingMessageContent on the remote object.
*
* Retrieve the content of one or more parts of a pending message. Note
* that this function may take a considerable amount of time to return if
* the part's 'needs-retrieval' flag is true; consider
* extending the default D-Bus method call timeout. Additional API is
* likely to be added in future, to stream large message parts.
*
* 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 messageID
*
* The ID of a pending message
*
* \param parts
*
* The desired entries in the array of message parts, identified by
* their position. The "headers" part (which is not a valid
* argument to this method) is considered to be part 0, so the valid
* part numbers start at 1 (for the second Message_Part).
* \param timeout The timeout in milliseconds.
*
* \return
*
* \htmlonly
* <p>The content of the requested parts. The keys in this mapping
* are positions in the array of message parts; the values are
* either of type 's' or 'ay' (UTF-8 text string, or byte array),
* following the same rules as for the value of the 'content' key in
* the <tp:type>Message_Part</tp:type> mappings.</p>
*
* <p>If the one of the requested part numbers was greater than zero
* but referred to a part that had no content (i.e. it had no
* 'content-type' key or no 'content' key), it is simply omitted from
* this mapping; this is not considered to be an error condition.</p>
* \endhtmlonly
*/
inline QDBusPendingReply<Tp::MessagePartContentMap> GetPendingMessageContent(uint messageID, const Tp::UIntList& parts, int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<Tp::MessagePartContentMap>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("GetPendingMessageContent"));
callMessage << QVariant::fromValue(messageID) << QVariant::fromValue(parts);
return this->connection().asyncCall(callMessage, timeout);
}
Q_SIGNALS:
/**
* Represents the signal \c MessageSent on the remote object.
*
* \htmlonly
* <p>Signals that a message has been submitted for sending. This
* MUST be emitted exactly once per emission of the \endhtmlonly ChannelTypeTextInterface::Sent() \htmlonly
* signal on the Text interface, for backwards-compatibility; clients
* SHOULD ignore the latter if this interface is present, as mentioned
* in the introduction.</p>
*
* <p>This SHOULD be emitted as soon as the CM determines it's
* theoretically possible to send the message (e.g. the parameters are
* supported and correct).</p>
*
* <div class="rationale">
* <p>This signal allows a process that is not the caller of
* SendMessage to log sent messages.</p>
* </div>
* \endhtmlonly
*
* \param content
*
* \htmlonly
* <p>The message content (see <tp:type>Message_Part</tp:type> for full
* details). If the message that was passed to
* \endhtmlonly SendMessage() \htmlonly has a formatted text
* part that the connection manager recognises, but no
* <tt>text/plain</tt> alternative, the CM MUST use the formatted text
* part to generate a <tt>text/plain</tt> alternative which is also
* included in this signal argument.</p>
*
* <p>The connection manager SHOULD include the
* <code>message-sender</code>, <code>message-sender-id</code> and
* <code>message-sent</code> headers in the representation of the
* message that is signalled here. If the channel has
* channel-specific handles, the <code>message-sender</code> and
* <code>message-sender-id</code> SHOULD reflect the sender that
* other contacts will see.</p>
*
* <p>If the connection manager can predict that the message will be
* altered during transmission, this argument SHOULD reflect what
* other contacts will receive, rather than being a copy of the
* argument to SendMessage (if the message is truncated,
* formatting or alternatives are dropped, etc., then the edited
* version SHOULD appear in this signal).</p>
* \endhtmlonly
*
* \param flags
*
* Flags affecting how the message was sent. The flags might be a
* subset of those passed to SendMessage if the caller requested
* unsupported flags.
*
* \param messageToken
*
* An opaque token used to match any incoming delivery or failure
* reports against this message, or an empty string if the message is
* not readily identifiable.
*/
void MessageSent(const Tp::MessagePartList& content, uint flags, const QString& messageToken);
/**
* Represents the signal \c PendingMessagesRemoved on the remote object.
*
* The messages with the given IDs have been removed from the
* PendingMessages list. Clients SHOULD NOT attempt to acknowledge those
* messages. This completes change notification for the PendingMessages
* property (previously, there was change notification when pending
* messages were added, but not when they were removed).
*
* \param messageIDs
*
* The messages that have been removed from the pending message list.
*/
void PendingMessagesRemoved(const Tp::UIntList& messageIDs);
/**
* Represents the signal \c MessageReceived on the remote object.
*
* Signals that a message has been received and added to the pending
* messages queue. This MUST be emitted exactly once per emission of the
* Received signal on the Text interface, for backwards-compatibility;
* clients SHOULD ignore the latter in favour of this signal if this
* interface is present, as mentioned in the introduction.
*
* \param message
*
* \htmlonly
* <p>The message content, including any attachments or alternatives. If
* the incoming message contains formatted text without a plain text
* alternative, the connection manager MUST generate a
* <tt>text/plain</tt> alternative from the formatted text, and
* include it in this message (both here, and in the
* \endhtmlonly \link requestPropertyPendingMessages() PendingMessages \endlink \htmlonly property).</p>
* \endhtmlonly
*/
void MessageReceived(const Tp::MessagePartList& message);
protected:
virtual void invalidate(Tp::DBusProxy *, const QString &, const QString &);
};
/**
* \class ChannelInterfacePasswordInterface
* \headerfile TelepathyQt/channel.h <TelepathyQt/Channel>
* \ingroup clientchannel
*
* Proxy class providing a 1:1 mapping of the D-Bus interface "org.freedesktop.Telepathy.Channel.Interface.Password".
*/
class TP_QT_EXPORT ChannelInterfacePasswordInterface : public Tp::AbstractInterface
{
Q_OBJECT
public:
/**
* Returns the name of the interface "org.freedesktop.Telepathy.Channel.Interface.Password", which this class
* represents.
*
* \return The D-Bus interface name.
*/
static inline QLatin1String staticInterfaceName()
{
return QLatin1String("org.freedesktop.Telepathy.Channel.Interface.Password");
}
/**
* Creates a ChannelInterfacePasswordInterface 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.
*/
ChannelInterfacePasswordInterface(
const QString& busName,
const QString& objectPath,
QObject* parent = 0
);
/**
* Creates a ChannelInterfacePasswordInterface 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.
*/
ChannelInterfacePasswordInterface(
const QDBusConnection& connection,
const QString& busName,
const QString& objectPath,
QObject* parent = 0
);
/**
* Creates a ChannelInterfacePasswordInterface 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.
*/
ChannelInterfacePasswordInterface(Tp::DBusProxy *proxy);
/**
* Creates a ChannelInterfacePasswordInterface 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 ChannelInterfacePasswordInterface(const Tp::Client::ChannelInterface& mainInterface);
/**
* Creates a ChannelInterfacePasswordInterface 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.
*/
ChannelInterfacePasswordInterface(const Tp::Client::ChannelInterface& 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 GetPasswordFlags on the remote object.
*
* Returns the bitwise-OR of the flags relevant to the password on this
* channel. The user interface can use this to present information about
* which operations are currently valid.
*
* 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 the logical OR of all the flags set (values of
* ChannelPasswordFlags)
*/
inline QDBusPendingReply<uint> GetPasswordFlags(int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<uint>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("GetPasswordFlags"));
return this->connection().asyncCall(callMessage, timeout);
}
/**
* Begins a call to the D-Bus method \c ProvidePassword on the remote object.
*
* Provide the password so that the channel can be joined. Must be called
* with the correct password in order for channel joining to proceed if
* the 'provide' password flag is set.
*
* 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 password
*
* The password
* \param timeout The timeout in milliseconds.
*
* \return
*
* A boolean indicating whether or not the password was correct
*/
inline QDBusPendingReply<bool> ProvidePassword(const QString& password, int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<bool>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("ProvidePassword"));
callMessage << QVariant::fromValue(password);
return this->connection().asyncCall(callMessage, timeout);
}
Q_SIGNALS:
/**
* Represents the signal \c PasswordFlagsChanged on the remote object.
*
* Emitted when the flags as returned by GetPasswordFlags are changed. The
* user interface should be updated as appropriate.
*
* \param added
*
* A bitwise OR of the flags which have been set
*
* \param removed
*
* A bitwise OR of the flags which have been cleared
*/
void PasswordFlagsChanged(uint added, uint removed);
protected:
virtual void invalidate(Tp::DBusProxy *, const QString &, const QString &);
};
/**
* \class ChannelInterfaceRoomConfigInterface
* \headerfile TelepathyQt/channel.h <TelepathyQt/Channel>
* \ingroup clientchannel
*
* Proxy class providing a 1:1 mapping of the D-Bus interface "org.freedesktop.Telepathy.Channel.Interface.RoomConfig1".
*/
class TP_QT_EXPORT ChannelInterfaceRoomConfigInterface : public Tp::AbstractInterface
{
Q_OBJECT
public:
/**
* Returns the name of the interface "org.freedesktop.Telepathy.Channel.Interface.RoomConfig1", which this class
* represents.
*
* \return The D-Bus interface name.
*/
static inline QLatin1String staticInterfaceName()
{
return QLatin1String("org.freedesktop.Telepathy.Channel.Interface.RoomConfig1");
}
/**
* Creates a ChannelInterfaceRoomConfigInterface 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.
*/
ChannelInterfaceRoomConfigInterface(
const QString& busName,
const QString& objectPath,
QObject* parent = 0
);
/**
* Creates a ChannelInterfaceRoomConfigInterface 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.
*/
ChannelInterfaceRoomConfigInterface(
const QDBusConnection& connection,
const QString& busName,
const QString& objectPath,
QObject* parent = 0
);
/**
* Creates a ChannelInterfaceRoomConfigInterface 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.
*/
ChannelInterfaceRoomConfigInterface(Tp::DBusProxy *proxy);
/**
* Creates a ChannelInterfaceRoomConfigInterface 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 ChannelInterfaceRoomConfigInterface(const Tp::Client::ChannelInterface& mainInterface);
/**
* Creates a ChannelInterfaceRoomConfigInterface 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.
*/
ChannelInterfaceRoomConfigInterface(const Tp::Client::ChannelInterface& mainInterface, QObject* parent);
/**
* Asynchronous getter for the remote object property \c Anonymous of type \c bool.
*
*
* True if people may join the channel without other members being made
* aware of their identity.
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyAnonymous() const
{
return internalRequestProperty(QLatin1String("Anonymous"));
}
/**
* Asynchronous getter for the remote object property \c InviteOnly of type \c bool.
*
*
* True if people may not join the channel until they have been invited.
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyInviteOnly() const
{
return internalRequestProperty(QLatin1String("InviteOnly"));
}
/**
* Asynchronous getter for the remote object property \c Limit of type \c uint.
*
*
* The limit to the number of members; or 0 if there is no limit.
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyLimit() const
{
return internalRequestProperty(QLatin1String("Limit"));
}
/**
* Asynchronous getter for the remote object property \c Moderated of type \c bool.
*
*
* True if channel membership is not sufficient to allow participation.
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyModerated() const
{
return internalRequestProperty(QLatin1String("Moderated"));
}
/**
* Asynchronous getter for the remote object property \c Title of type \c QString.
*
*
* \htmlonly
* A human-visible name for the channel, if it differs from \endhtmlonly \link ChannelInterfaceRoomInterface::requestPropertyRoomName() ChannelInterfaceRoomInterface::RoomName \endlink \htmlonly ; the
* empty string, otherwise.
*
* <div class="rationale">
* <p>On XMPP, this represents the <code>muc#roomconfig_roomname</code>
* field of the <a href="http://xmpp.org/extensions/xep-0045.html#registrar-formtype-owner"><code>muc#roomconfig</code></a>
* form. So for <code>jdev@conference.jabber.org</code>, for example:</p>
*
* <ul>
* <li> \endhtmlonly \link ChannelInterfaceRoomInterface::requestPropertyRoomName() ChannelInterfaceRoomInterface::RoomName \endlink \htmlonly
* = <code>"jdev"</code>;</li>
* <li> \endhtmlonly \link ChannelInterfaceRoomInterface::requestPropertyServer() ChannelInterfaceRoomInterface::Server \endlink \htmlonly
* = <code>"conference.jabber.org"</code>;</li>
* <li> \endhtmlonly \link requestPropertyTitle() Title \endlink \htmlonly = <code>"General Jabber
* development discussion"</code>.</li>
* </ul>
*
* <p>XEP-0045 is awful.</p>
* </div>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyTitle() const
{
return internalRequestProperty(QLatin1String("Title"));
}
/**
* Asynchronous getter for the remote object property \c Description of type \c QString.
*
*
* A human-readable description of the channel's overall purpose; if
* any.
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyDescription() const
{
return internalRequestProperty(QLatin1String("Description"));
}
/**
* Asynchronous getter for the remote object property \c Persistent of type \c bool.
*
*
* \htmlonly
* <code>True</code> if the channel will remain in existence on the server after all
* members have left it.
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyPersistent() const
{
return internalRequestProperty(QLatin1String("Persistent"));
}
/**
* Asynchronous getter for the remote object property \c Private of type \c bool.
*
*
* \htmlonly
* <code>True</code> if the channel is not visible to non-members.
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyPrivate() const
{
return internalRequestProperty(QLatin1String("Private"));
}
/**
* Asynchronous getter for the remote object property \c PasswordProtected of type \c bool.
*
*
* \htmlonly
* <code>True</code> if contacts joining this channel must provide a
* password to be granted entry. Note that this property does not
* indicate that a password is required <em>right now</em>; see the
* \endhtmlonly ChannelInterfacePasswordInterface \htmlonly
* interface for the API used to provide a password while joining a room.
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyPasswordProtected() const
{
return internalRequestProperty(QLatin1String("PasswordProtected"));
}
/**
* Asynchronous getter for the remote object property \c Password of type \c QString.
*
*
* \htmlonly
* If \endhtmlonly \link requestPropertyPasswordProtected() PasswordProtected \endlink \htmlonly is
* <code>True</code>, the password required to enter the channel, if
* known. If the password is unknown, or
* \endhtmlonly \link requestPropertyPasswordProtected() PasswordProtected \endlink \htmlonly is
* <code>False</code>, the empty string.
*
* <div class="rationale">
* On XMPP—bless its cotton socks!—non-owners of a MUC cannot see its
* current password, even if they just provided the password in order to
* join the room…
* </div>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyPassword() const
{
return internalRequestProperty(QLatin1String("Password"));
}
/**
* Asynchronous getter for the remote object property \c PasswordHint of type \c QString.
*
*
* \htmlonly
* <p>If \endhtmlonly \link requestPropertyPasswordProtected() PasswordProtected \endlink \htmlonly is
* <code>True</code>, an optional hint for the password.</p>
*
* <p>On protocols supporting PasswordHint (indicated by its presence
* in \endhtmlonly \link requestPropertyMutableProperties() MutableProperties \endlink \htmlonly ),
* \endhtmlonly \link requestPropertyPassword() Password \endlink \htmlonly and PasswordHint MUST be
* set in a single call to
* \endhtmlonly UpdateConfiguration() \htmlonly .</p>
*
* <div class="rationale">
* Skype requires that the password and its hint be supplied together.
* </div>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyPasswordHint() const
{
return internalRequestProperty(QLatin1String("PasswordHint"));
}
/**
* Asynchronous getter for the remote object property \c CanUpdateConfiguration of type \c bool.
*
*
* \htmlonly
* If <code>True</code>, the user may call
* \endhtmlonly UpdateConfiguration() \htmlonly to change the values
* of the properties listed in
* \endhtmlonly \link requestPropertyMutableProperties() MutableProperties \endlink \htmlonly .
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyCanUpdateConfiguration() const
{
return internalRequestProperty(QLatin1String("CanUpdateConfiguration"));
}
/**
* Asynchronous getter for the remote object property \c MutableProperties of type \c QStringList.
*
*
* \htmlonly
* <p>A list of (unqualified) property names on this interface which may
* be modified using \endhtmlonly UpdateConfiguration() \htmlonly
* (if \endhtmlonly \link requestPropertyCanUpdateConfiguration() CanUpdateConfiguration \endlink \htmlonly is
* <code>True</code>). Properties not listed here cannot be
* modified.</p>
*
* <p>For example, IRC does not have the concept of joining a room without
* other participants knowing your true identity; so on IRC the
* \endhtmlonly \link requestPropertyAnonymous() Anonymous \endlink \htmlonly property will always be
* <code>False</code>, and
* \endhtmlonly \link requestPropertyMutableProperties() MutableProperties \endlink \htmlonly will not include
* <code>"Anonymous"</code>.</p>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyMutableProperties() const
{
return internalRequestProperty(QLatin1String("MutableProperties"));
}
/**
* Asynchronous getter for the remote object property \c ConfigurationRetrieved of type \c bool.
*
*
* \htmlonly
* <p><code>True</code> once the initial room configuration has been
* retrieved, or <code>False</code> otherwise. On some services, this
* may take some time after you've joined a room to fetch the
* configuration. Once this property changes to <code>True</code>, the
* other properties on this interface can be assumed to be accurate;
* this property MUST not change to <code>False</code> after it becomes
* <code>True</code>.</p>
*
* <div class="rationale">
* <p>An application's “configure this room” dialog might choose to
* display a spinner while this property is <code>False</code>, rather
* than allowing the user to edit probably-inaccurate
* configuration.</p>
* </div>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyConfigurationRetrieved() const
{
return internalRequestProperty(QLatin1String("ConfigurationRetrieved"));
}
/**
* 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 UpdateConfiguration on the remote object.
*
* \htmlonly
* <p>If \endhtmlonly \link requestPropertyCanUpdateConfiguration() CanUpdateConfiguration \endlink \htmlonly is
* <code>True</code>, modifies the current values of one or more
* room properties. This method SHOULD NOT return until the change has
* been accepted or declined by the server.</p>
*
* <p>Note that the server may ostensibly accept the changes (thus
* allowing this method to return success) but signal different values;
* for example, the server might truncate
* \endhtmlonly \link requestPropertyTitle() Title \endlink \htmlonly to some maximum length. Callers
* SHOULD continue to listen for the <code>PropertiesChanged</code>
* signal, and trust the values it signals over those provided to this
* 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 properties
*
* \htmlonly
* <p>
* The new values of one or more properties on this interface, which
* must be listed in
* \endhtmlonly \link requestPropertyMutableProperties() MutableProperties \endlink \htmlonly . For
* instance, to set up a channel for discussing top-secret corporate
* merge plans, this parameter might be:
* </p>
*
* <blockquote>
* <pre>{
* 'Private': True,
* 'InviteOnly': True,
* 'Description': "The first rule of #inteltakeover is: do not talk about #inteltakeover",
* }</pre></blockquote>
* \endhtmlonly
* \param timeout The timeout in milliseconds.
*/
inline QDBusPendingReply<> UpdateConfiguration(const QVariantMap& properties, int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("UpdateConfiguration"));
callMessage << QVariant::fromValue(properties);
return this->connection().asyncCall(callMessage, timeout);
}
protected:
virtual void invalidate(Tp::DBusProxy *, const QString &, const QString &);
};
/**
* \class ChannelInterfaceRoomInterface
* \headerfile TelepathyQt/channel.h <TelepathyQt/Channel>
* \ingroup clientchannel
*
* Proxy class providing a 1:1 mapping of the D-Bus interface "org.freedesktop.Telepathy.Channel.Interface.Room2".
*/
class TP_QT_EXPORT ChannelInterfaceRoomInterface : public Tp::AbstractInterface
{
Q_OBJECT
public:
/**
* Returns the name of the interface "org.freedesktop.Telepathy.Channel.Interface.Room2", which this class
* represents.
*
* \return The D-Bus interface name.
*/
static inline QLatin1String staticInterfaceName()
{
return QLatin1String("org.freedesktop.Telepathy.Channel.Interface.Room2");
}
/**
* Creates a ChannelInterfaceRoomInterface 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.
*/
ChannelInterfaceRoomInterface(
const QString& busName,
const QString& objectPath,
QObject* parent = 0
);
/**
* Creates a ChannelInterfaceRoomInterface 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.
*/
ChannelInterfaceRoomInterface(
const QDBusConnection& connection,
const QString& busName,
const QString& objectPath,
QObject* parent = 0
);
/**
* Creates a ChannelInterfaceRoomInterface 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.
*/
ChannelInterfaceRoomInterface(Tp::DBusProxy *proxy);
/**
* Creates a ChannelInterfaceRoomInterface 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 ChannelInterfaceRoomInterface(const Tp::Client::ChannelInterface& mainInterface);
/**
* Creates a ChannelInterfaceRoomInterface 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.
*/
ChannelInterfaceRoomInterface(const Tp::Client::ChannelInterface& mainInterface, QObject* parent);
/**
* Asynchronous getter for the remote object property \c RoomName of type \c QString.
*
*
* \htmlonly
* <p>The human-readable identifier of a chat room. Note that if
* non-empty, this property (and perhaps also
* \endhtmlonly \link requestPropertyServer() Server \endlink \htmlonly ) should be sufficient in
* a channel request to join the room. XMPP MUCs have a room name
* concept which is more like a topic, except more
* persistent. This D-Bus property is <strong>not</strong> this
* XMPP room name, but the bit before the @ in the room jid; see
* \endhtmlonly \link ChannelInterfaceRoomConfigInterface::requestPropertyTitle() ChannelInterfaceRoomConfigInterface::Title \endlink \htmlonly
* for that concept.</p>
*
* <p>This property cannot change during the lifetime of the channel. It
* should appear in the <var>Allowed_Properties</var> of a
* <tp:type>Requestable_Channel_Class</tp:type> for the connection if
* rooms on this connection have human-readable names, and can be joined
* by name.</p>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyRoomName() const
{
return internalRequestProperty(QLatin1String("RoomName"));
}
/**
* Asynchronous getter for the remote object property \c Server of type \c QString.
*
*
* \htmlonly
* <p>For protocols with a concept of chatrooms on multiple servers with
* different DNS names (like XMPP), the DNS name of the server hosting
* this channel (for example, <tt>"conference.jabber.org"</tt> or
* <tt>"groupchat.google.com"</tt>). For other protocols, the empty
* string.</p>
*
* <p>This property cannot change during the lifetime of the channel. It
* should appear in the <var>Allowed_Properties</var> of a
* <tp:type>Requestable_Channel_Class</tp:type> for the connection if
* and only if non-empty values are supported.</p>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyServer() const
{
return internalRequestProperty(QLatin1String("Server"));
}
/**
* Asynchronous getter for the remote object property \c Creator of type \c QString.
*
*
* \htmlonly
* The normalized contact ID representing who created the room; or
* the empty string if unknown.
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyCreator() const
{
return internalRequestProperty(QLatin1String("Creator"));
}
/**
* Asynchronous getter for the remote object property \c CreatorHandle of type \c uint.
*
*
* \htmlonly
* The handle corresponding to \endhtmlonly \link requestPropertyCreator() Creator \endlink \htmlonly ;
* or 0 if \endhtmlonly \link requestPropertyCreator() Creator \endlink \htmlonly is unknown.
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyCreatorHandle() const
{
return internalRequestProperty(QLatin1String("CreatorHandle"));
}
/**
* Asynchronous getter for the remote object property \c CreationTimestamp of type \c qlonglong.
*
*
* \htmlonly
* A unix timestamp indicating when the room was created; or
* <code>INT_MAX64</code> if unknown.
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyCreationTimestamp() const
{
return internalRequestProperty(QLatin1String("CreationTimestamp"));
}
/**
* 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();
}
protected:
virtual void invalidate(Tp::DBusProxy *, const QString &, const QString &);
};
/**
* \class ChannelInterfaceSASLAuthenticationInterface
* \headerfile TelepathyQt/channel.h <TelepathyQt/Channel>
* \ingroup clientchannel
*
* Proxy class providing a 1:1 mapping of the D-Bus interface "org.freedesktop.Telepathy.Channel.Interface.SASLAuthentication".
*/
class TP_QT_EXPORT ChannelInterfaceSASLAuthenticationInterface : public Tp::AbstractInterface
{
Q_OBJECT
public:
/**
* Returns the name of the interface "org.freedesktop.Telepathy.Channel.Interface.SASLAuthentication", which this class
* represents.
*
* \return The D-Bus interface name.
*/
static inline QLatin1String staticInterfaceName()
{
return QLatin1String("org.freedesktop.Telepathy.Channel.Interface.SASLAuthentication");
}
/**
* Creates a ChannelInterfaceSASLAuthenticationInterface 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.
*/
ChannelInterfaceSASLAuthenticationInterface(
const QString& busName,
const QString& objectPath,
QObject* parent = 0
);
/**
* Creates a ChannelInterfaceSASLAuthenticationInterface 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.
*/
ChannelInterfaceSASLAuthenticationInterface(
const QDBusConnection& connection,
const QString& busName,
const QString& objectPath,
QObject* parent = 0
);
/**
* Creates a ChannelInterfaceSASLAuthenticationInterface 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.
*/
ChannelInterfaceSASLAuthenticationInterface(Tp::DBusProxy *proxy);
/**
* Creates a ChannelInterfaceSASLAuthenticationInterface 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 ChannelInterfaceSASLAuthenticationInterface(const Tp::Client::ChannelInterface& mainInterface);
/**
* Creates a ChannelInterfaceSASLAuthenticationInterface 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.
*/
ChannelInterfaceSASLAuthenticationInterface(const Tp::Client::ChannelInterface& mainInterface, QObject* parent);
/**
* Asynchronous getter for the remote object property \c AvailableMechanisms of type \c QStringList.
*
*
* \htmlonly
* <p>The SASL mechanisms as offered by the server, plus any
* pseudo-SASL mechanisms supported by the connection manager for
* credentials transfer. For instance, in a protocol that
* natively uses SASL (like XMPP), this might be
* <code>[ "X-TELEPATHY-PASSWORD", "PLAIN", "DIGEST-MD5",
* "SCRAM-SHA-1" ]</code>.</p>
*
* <p>To make it possible to implement a very simple password-querying
* user interface without knowledge of any particular SASL mechanism,
* implementations of this interface MUST implement the
* pseudo-mechanism <code>X-TELEPATHY-PASSWORD</code>, unless none
* of the available mechanisms use a password at all.</p>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyAvailableMechanisms() const
{
return internalRequestProperty(QLatin1String("AvailableMechanisms"));
}
/**
* Asynchronous getter for the remote object property \c HasInitialData of type \c bool.
*
*
* \htmlonly
* <p>If true, \endhtmlonly StartMechanismWithData() \htmlonly
* can be expected to work for SASL mechanisms not starting with
* <code>X-TELEPATHY-</code> (this is the case in most, but not all,
* protocols). If false, \endhtmlonly StartMechanism() \htmlonly
* must be used instead.</p>
*
* <p>This property does not affect the <code>X-TELEPATHY-</code>
* pseudo-mechanisms such as <code>X-TELEPATHY-PASSWORD</code>,
* which can use
* \endhtmlonly StartMechanismWithData() \htmlonly regardless
* of the value of this property.</p>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyHasInitialData() const
{
return internalRequestProperty(QLatin1String("HasInitialData"));
}
/**
* Asynchronous getter for the remote object property \c CanTryAgain of type \c bool.
*
*
* \htmlonly
* <p>If true, \endhtmlonly StartMechanism() \htmlonly and (if
* supported) \endhtmlonly StartMechanismWithData() \htmlonly
* can be expected to work when in one of the Failed states. If
* false, the only thing you can do after failure is to close the
* channel.</p>
*
* <div class="rationale">
* <p>Retrying isn't required to work, although some protocols and
* implementations allow it.</p>
* </div>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyCanTryAgain() const
{
return internalRequestProperty(QLatin1String("CanTryAgain"));
}
/**
* Asynchronous getter for the remote object property \c SASLStatus of type \c uint.
*
*
* \htmlonly
* The current status of this channel.
* Change notification is via the
* \endhtmlonly SASLStatusChanged() \htmlonly signal.
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertySASLStatus() const
{
return internalRequestProperty(QLatin1String("SASLStatus"));
}
/**
* Asynchronous getter for the remote object property \c SASLError of type \c QString.
*
*
* \htmlonly
* <p>The reason for the \endhtmlonly \link requestPropertySASLStatus() SASLStatus \endlink \htmlonly , or
* an empty string if the state is neither
* Server_Failed nor Client_Failed.</p>
*
* <p>In particular, an ordinary authentication failure (as would
* be produced for an incorrect password) SHOULD be represented by
* <tp:error-ref>AuthenticationFailed</tp:error-ref>,
* cancellation by the user's request SHOULD be represented
* by <tp:error-ref>Cancelled</tp:error-ref>, and
* cancellation by a local process due to inconsistent or invalid
* challenges from the server SHOULD be represented by
* <tp:error-ref>ServiceConfused</tp:error-ref>.</p>
*
* <p>If this interface appears on a \endhtmlonly ChannelTypeServerAuthenticationInterface \htmlonly
* channel, and connection to the server fails with an authentication
* failure, this error code SHOULD be copied into the
* \endhtmlonly ConnectionInterface::ConnectionError() \htmlonly
* signal.</p>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertySASLError() const
{
return internalRequestProperty(QLatin1String("SASLError"));
}
/**
* Asynchronous getter for the remote object property \c SASLErrorDetails of type \c QVariantMap.
*
*
* \htmlonly
* <p>If \endhtmlonly \link requestPropertySASLError() SASLError \endlink \htmlonly is non-empty,
* any additional information about the last
* disconnection; otherwise, the empty map. The keys and values are
* the same as for the second argument of
* \endhtmlonly ConnectionInterface::ConnectionError() \htmlonly .</p>
*
* <p>If this interface appears on a \endhtmlonly ChannelTypeServerAuthenticationInterface \htmlonly
* channel, and connection to the server fails with an authentication
* failure, these details SHOULD be copied into the
* \endhtmlonly ConnectionInterface::ConnectionError() \htmlonly
* signal.</p>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertySASLErrorDetails() const
{
return internalRequestProperty(QLatin1String("SASLErrorDetails"));
}
/**
* Asynchronous getter for the remote object property \c AuthorizationIdentity of type \c QString.
*
*
* \htmlonly
* <p>The identity for which authorization is being attempted,
* typically the 'account' from the \endhtmlonly ConnectionManagerInterface::RequestConnection() \htmlonly
* parameters, normalized and formatted according to the
* conventions used for SASL in this protocol.</p>
*
* <div class="rationale">
* <p>The normalization used for SASL might not be the same
* normalization used elsewhere: for instance, in a protocol
* with email-like identifiers such as XMPP or SIP, the user
* "juliet@example.com" might have to authenticate to the
* example.com server via SASL PLAIN as "juliet".</p>
* </div>
*
* <p>This is usually achieved by using the authorization identity for
* authentication, but an advanced Handler could offer the option
* to authenticate under a different identity.</p>
*
* <p>The terminology used here is that the authorization identity
* is who you want to act as, and the authentication identity is
* used to prove that you may do so. For instance, if Juliet is
* authorized to access a role account, "sysadmin@example.com",
* and act on its behalf, it might be possible to authenticate
* as "juliet@example.com" with her own password, but request to
* be authorized as "sysadmin@example.com" instead of her own
* account. See
* <a href="http://tools.ietf.org/html/rfc4422#section-3.4.1">RFC
* 4422 §3.4.1</a> for more details.</p>
*
* <div class="rationale">
* <p>In SASL the authorization identity is normally guessed from
* the authentication identity, but the information available
* to the connection manager is the identity for which
* authorization is required, such as the desired JID in XMPP,
* so that's what we signal to UIs; it's up to the UI to
* choose whether to authenticate as the authorization identity
* or some other identity.</p>
*
* <p>As a concrete example, the "sysadmin" XMPP account mentioned
* above would have <code>{ 'account': 'sysadmin@example.com' }</code>
* in its Parameters, and this property would also be
* 'sysadmin@example.com'. A simple Handler would
* merely prompt for sysadmin@example.com's password,
* and use that JID as both the authorization and authentication
* identity, which might result in SASL PLAIN authentication with the
* initial response
* '\\000sysadmin@example.com\\000root'.</p>
*
* <p>A more advanced Handler might also ask for an authentication
* identity, defaulting to 'sysadmin@example.com'; if Juliet
* provided authentication identity 'juliet@example.com' and
* password 'romeo', the Handler might perform SASL PLAIN
* authentication using the initial response
* 'sysadmin@example.com\\000juliet@example.com\\000romeo'.</p>
* </div>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyAuthorizationIdentity() const
{
return internalRequestProperty(QLatin1String("AuthorizationIdentity"));
}
/**
* Asynchronous getter for the remote object property \c DefaultUsername of type \c QString.
*
*
* \htmlonly
* <p>The default username for use with SASL mechanisms that deal
* with a "simple username" (as defined in <a href="http://tools.ietf.org/html/rfc4422">RFC 4422</a>). If
* such a SASL mechanism is in use, clients SHOULD default to
* using the DefaultUsername; also, if the client uses
* the DefaultUsername, it SHOULD assume that the authorization
* identity \endhtmlonly \link requestPropertyAuthorizationIdentity() AuthorizationIdentity \endlink \htmlonly
* will be derived from it by the server.</p>
*
* <div class="rationale">
* <p>In XMPP, <a href="http://trac.tools.ietf.org/wg/xmpp/trac/ticket/49">
* servers typically expect</a> "user@example.com" to
* authenticate with username "user"; this was a SHOULD in <a href="http://tools.ietf.org/html/rfc3920">RFC 3920</a>.</p>
*
* <p><a href="http://tools.ietf.org/html/draft-ietf-xmpp-3920bis-19">3920bis</a>
* weakens that SHOULD to "in the absence of local information
* provided by the server, an XMPP client SHOULD assume that
* the authentication identity for such a SASL mechanism is the
* combination of a user name and password, where the simple
* user name is the localpart of the user's JID".</p>
* </div>
*
* <p>For example, in the simple case, if the user connects with
* \endhtmlonly ConnectionManagerInterface::RequestConnection() \htmlonly ({
* account: "<tt>user@example.com</tt>" }) and use PLAIN with
* password "password", he or she should authenticate like so:
* "<tt>\\0user\\0password</tt>" and the channel will look like
* this:</p>
*
* <blockquote><pre>{ "... \endhtmlonly \link requestPropertyDefaultUsername() DefaultUsername \endlink \htmlonly ": "user",
* "... \endhtmlonly \link requestPropertyAuthorizationIdentity() AuthorizationIdentity \endlink \htmlonly ": "user@example.com }
* </pre></blockquote>
*
* <p>In the complex case, if the same user is using his or her
* sysadmin powers to log in as the "announcements" role address,
* he or she would connect with \endhtmlonly ConnectionManagerInterface::RequestConnection() \htmlonly ({
* account: "<tt>announcements@example.com</tt>" }) and the SASL
* channel would look like this:</p>
*
* <blockquote><pre>{ "... \endhtmlonly \link requestPropertyDefaultUsername() DefaultUsername \endlink \htmlonly ": "announcements",
* "... \endhtmlonly \link requestPropertyAuthorizationIdentity() AuthorizationIdentity \endlink \htmlonly ": "announcements@example.com }
* </pre></blockquote>
*
* <p>A sufficiently elaborate UI could give the opportunity
* to override the username from "announcements" to "user".
* The user's simple username is still "user", and the password is
* still "password", but this time he or she is trying to authorize
* to act as <tt>announcements@example.com</tt>, so the UI would
* have to perform SASL PLAIN with this string:
* "<tt>announcements@example.com\\0user\\0password</tt>", where
* "announcements@example.com" is the
* \endhtmlonly \link requestPropertyAuthorizationIdentity() AuthorizationIdentity \endlink \htmlonly .</p>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyDefaultUsername() const
{
return internalRequestProperty(QLatin1String("DefaultUsername"));
}
/**
* Asynchronous getter for the remote object property \c DefaultRealm of type \c QString.
*
*
* \htmlonly
* <p>The default realm (as defined in
* <a href="http://tools.ietf.org/html/rfc2831#section-2.1.1">RFC
* 2831</a>) to use for authentication, if the server does not
* supply one.</p>
*
* <div class="rationale">
* <p>The server is not required to provide a realm; if it doesn't,
* the client is expected to ask the user or provide a sensible
* default, typically the requested DNS name of the server.
* In some implementations of <code>DIGEST-MD5</code>, the
* server does not specify a realm, but expects that the client
* will choose a particular default, and authentication will
* fail if the client's default is different. Connection
* managers for protocols where this occurs are more easily able
* to work around these implementations than a generic client
* would be.</p>
* </div>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyDefaultRealm() const
{
return internalRequestProperty(QLatin1String("DefaultRealm"));
}
/**
* Asynchronous getter for the remote object property \c MaySaveResponse of type \c bool.
*
*
* \htmlonly
* <p>Whether or not the client can save the authentication response and
* re-use it to automate future authentication challenges.</p>
*
* <p>If this property is <code>False</code>, the client SHOULD NOT attempt
* to cache the authentication response in its own keyring.</p>
*
* <p>If this property is not specified, it should be treated as if it were
* <code>True</code>.</p>
*
* <div class="rationale">Some protocols or services may have terms and conditions
* that prohibit caching a user's credentials.</div>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyMaySaveResponse() const
{
return internalRequestProperty(QLatin1String("MaySaveResponse"));
}
/**
* 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 StartMechanism on the remote object.
*
* \htmlonly
* <p>Start an authentication try using <var>Mechanism</var>, without
* sending initial data (an "initial response" as defined in RFC
* 4422).</p>
*
* <div class="rationale">
* <p>This method is appropriate for mechanisms where the client
* cannot send anything until it receives a challenge from the
* server, such as
* <code><a href="http://tools.ietf.org/html/rfc2831">DIGEST-MD5</a></code>
* in "initial authentication" mode.</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 mechanism
*
* The chosen mechanism.
* \param timeout The timeout in milliseconds.
*/
inline QDBusPendingReply<> StartMechanism(const QString& mechanism, int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("StartMechanism"));
callMessage << QVariant::fromValue(mechanism);
return this->connection().asyncCall(callMessage, timeout);
}
/**
* Begins a call to the D-Bus method \c StartMechanismWithData on the remote object.
*
* \htmlonly
* <p>Start an authentication try using <var>Mechanism</var>, and send
* <var>Initial_Data</var> as the "initial response" defined in
* <a href="http://tools.ietf.org/html/rfc4422#section-3.3">RFC 4422
* §3.3</a>.</p>
*
* <div class="rationale">
* <p>This method is appropriate for mechanisms where the client may
* send data first, such as <code>PLAIN</code>, or must send data
* first, such as
* <code><a href="http://tools.ietf.org/html/rfc2831">DIGEST-MD5</a></code>
* in "subsequent authentication" mode.</p>
*
* <p>Having two methods allows any mechanism where it makes a difference
* to distinguish between the absence of an initial response
* ( \endhtmlonly StartMechanism() \htmlonly ) and a zero-byte
* initial response (StartMechanismWithData, with Initial_Data
* empty).</p>
* </div>
*
* <p>If the \endhtmlonly \link requestPropertyHasInitialData() HasInitialData \endlink \htmlonly
* property is false, this indicates that the underlying protocol
* does not make it possible to send initial data. In such protocols,
* this method may only be used for the <code>X-TELEPATHY-</code>
* pseudo-mechanisms (such as <code>X-TELEPATHY-PASSWORD</code>),
* and will fail if used with an ordinary SASL mechanism.</p>
*
* <div class="rationale">
* <p>For instance, the IRC SASL extension implemented in Charybdis and
* Atheme does not support initial data - the first message in the
* exchange only carries the mechanism. This is significant if using
* <code><a href="http://tools.ietf.org/html/rfc2831">DIGEST-MD5</a></code>,
* which cannot be used in the faster "subsequent authentication"
* mode on a protocol not supporting initial data.</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 mechanism
*
* The chosen mechanism.
*
* \param initialData
*
* Initial data (an "initial response" in RFC 4422's
* terminology) to send with the mechanism.
* \param timeout The timeout in milliseconds.
*/
inline QDBusPendingReply<> StartMechanismWithData(const QString& mechanism, const QByteArray& initialData, int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("StartMechanismWithData"));
callMessage << QVariant::fromValue(mechanism) << QVariant::fromValue(initialData);
return this->connection().asyncCall(callMessage, timeout);
}
/**
* Begins a call to the D-Bus method \c Respond on the remote object.
*
* \htmlonly
* <p>Send a response to the the last challenge received via
* \endhtmlonly NewChallenge() \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 responseData
*
* The response data.
* \param timeout The timeout in milliseconds.
*/
inline QDBusPendingReply<> Respond(const QByteArray& responseData, int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("Respond"));
callMessage << QVariant::fromValue(responseData);
return this->connection().asyncCall(callMessage, timeout);
}
/**
* Begins a call to the D-Bus method \c AcceptSASL on the remote object.
*
* \htmlonly
* <p>If the channel's status is SASL_Status_Server_Succeeded,
* this method confirms successful authentication and advances
* the status of the channel to SASL_Status_Succeeded.</p>
*
* <p>If the channel's status is SASL_Status_In_Progress, calling this
* method indicates that the last
* \endhtmlonly NewChallenge() \htmlonly signal was in fact
* additional data sent after a successful SASL negotiation, and
* declares that from the client's point of view, authentication
* was successful. This advances the state of the channel to
* SASL_Status_Client_Accepted.</p>
*
* <p>In mechanisms where the server authenticates itself to the client,
* calling this method indicates that the client considers this to have
* been successful. In the case of \endhtmlonly ChannelTypeServerAuthenticationInterface \htmlonly
* channels, this means that the connection manager MAY continue to
* connect, and MAY advance the \endhtmlonly \link ConnectionInterface::requestPropertyStatus() ConnectionInterface::Status \endlink \htmlonly to Connected.</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<> AcceptSASL(int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("AcceptSASL"));
return this->connection().asyncCall(callMessage, timeout);
}
/**
* Begins a call to the D-Bus method \c AbortSASL on the remote object.
*
* \htmlonly
* <p>Abort the current authentication try.</p>
*
* <p>If the current status is SASL_Status_Server_Failed or
* SASL_Status_Client_Failed, this method returns successfully, but has
* no further effect. If the current status is SASL_Status_Succeeded
* or SASL_Status_Client_Accepted then NotAvailable is raised.
* Otherwise, it changes the channel's state to
* SASL_Status_Client_Failed, with an appropriate error name and
* reason code.</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 reason
*
* Reason for abort.
*
* \param debugMessage
*
* Debug message for abort.
* \param timeout The timeout in milliseconds.
*/
inline QDBusPendingReply<> AbortSASL(uint reason, const QString& debugMessage, int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("AbortSASL"));
callMessage << QVariant::fromValue(reason) << QVariant::fromValue(debugMessage);
return this->connection().asyncCall(callMessage, timeout);
}
Q_SIGNALS:
/**
* Represents the signal \c SASLStatusChanged on the remote object.
*
* Emitted when the status of the channel changes.
*
* \param status
*
* The new value of SASLStatus.
*
* \param reason
*
* The new value of SASLError.
*
* \param details
*
* The new value of SASLErrorDetails.
*/
void SASLStatusChanged(uint status, const QString& reason, const QVariantMap& details);
/**
* Represents the signal \c NewChallenge on the remote object.
*
* \htmlonly
* <p>Emitted when a new challenge is received from the server, or when
* a message indicating successful authentication and containing
* additional data is received from the server.</p>
*
* <p>When the channel's handler is ready to proceed, it should respond
* to the challenge by calling \endhtmlonly Respond() \htmlonly ,
* or respond to the additional data by calling
* \endhtmlonly AcceptSASL() \htmlonly . Alternatively, it may call
* \endhtmlonly AbortSASL() \htmlonly to abort authentication.</p>
* \endhtmlonly
*
* \param challengeData
*
* The challenge data or additional data from the server.
*/
void NewChallenge(const QByteArray& challengeData);
protected:
virtual void invalidate(Tp::DBusProxy *, const QString &, const QString &);
};
/**
* \class ChannelInterfaceSMSInterface
* \headerfile TelepathyQt/channel.h <TelepathyQt/Channel>
* \ingroup clientchannel
*
* Proxy class providing a 1:1 mapping of the D-Bus interface "org.freedesktop.Telepathy.Channel.Interface.SMS".
*/
class TP_QT_EXPORT ChannelInterfaceSMSInterface : public Tp::AbstractInterface
{
Q_OBJECT
public:
/**
* Returns the name of the interface "org.freedesktop.Telepathy.Channel.Interface.SMS", which this class
* represents.
*
* \return The D-Bus interface name.
*/
static inline QLatin1String staticInterfaceName()
{
return QLatin1String("org.freedesktop.Telepathy.Channel.Interface.SMS");
}
/**
* Creates a ChannelInterfaceSMSInterface 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.
*/
ChannelInterfaceSMSInterface(
const QString& busName,
const QString& objectPath,
QObject* parent = 0
);
/**
* Creates a ChannelInterfaceSMSInterface 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.
*/
ChannelInterfaceSMSInterface(
const QDBusConnection& connection,
const QString& busName,
const QString& objectPath,
QObject* parent = 0
);
/**
* Creates a ChannelInterfaceSMSInterface 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.
*/
ChannelInterfaceSMSInterface(Tp::DBusProxy *proxy);
/**
* Creates a ChannelInterfaceSMSInterface 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 ChannelInterfaceSMSInterface(const Tp::Client::ChannelInterface& mainInterface);
/**
* Creates a ChannelInterfaceSMSInterface 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.
*/
ChannelInterfaceSMSInterface(const Tp::Client::ChannelInterface& mainInterface, QObject* parent);
/**
* Asynchronous getter for the remote object property \c Flash of type \c bool.
*
*
* \htmlonly
* <p>If <code>True</code>, then this channel is exclusively for
* receiving class 0 SMSes (and no SMSes can be sent using \endhtmlonly ChannelInterfaceMessagesInterface::SendMessage() \htmlonly
* on this channel). If <code>False</code>, no incoming class 0 SMSes
* will appear on this channel.</p>
*
* <p>This property is immutable (cannot change), and therefore SHOULD
* appear wherever immutable properties are reported, e.g. \endhtmlonly ConnectionInterfaceRequestsInterface::NewChannels() \htmlonly signals.</p>
*
* <div class="rationale">
* <p>Class 0 SMSes should be displayed immediately to the user, and
* need not be saved to the device memory unless the user explicitly
* chooses to do so. This is unlike “normal”, class 1 SMSes, which
* must be stored, but need not be shown immediately in their entirity
* to the user.</p>
*
* <p>Separating class 0 SMSes into their own channel with this
* immutable property allows them to be dispatched to a different
* \endhtmlonly ClientHandlerInterface \htmlonly —which
* would include this property in its \endhtmlonly \link ClientHandlerInterface::requestPropertyHandlerChannelFilter() ClientHandlerInterface::HandlerChannelFilter \endlink \htmlonly —avoiding the normal Text
* channel handler having to decide for each message whether it should
* be displayed to the user immediately or handled normally.</p>
*
* <p>Currently, no mechanism is defined for <em>sending</em> class 0
* SMSes. It seems reasonable to support specifying the class of an
* outgoing SMS in its header <tp:type>Message_Part</tp:type>, rather
* than requiring the UI to request a special channel for such SMSes;
* hence, we define here that channels with Flash set to
* <code>True</code> are read-only.</p>
* </div>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyFlash() const
{
return internalRequestProperty(QLatin1String("Flash"));
}
/**
* Asynchronous getter for the remote object property \c SMSChannel of type \c bool.
*
*
* \htmlonly
* <p>If TRUE, messages sent and received on this channel are transmitted
* via SMS.</p>
*
* <p>If this property is included in the channel request, the
* Connection Manager MUST return an appropriate channel (i.e. if TRUE
* the channel must be for SMSes, if FALSE it must not), or else fail
* to provide the requested channel with the
* <tp:error-ref>NotCapable</tp:error-ref>
* error.</p>
*
* <p>For example, to explicitly request an SMS channel to a contact.
* You might construct a channel request like:</p>
*
* <blockquote><pre>{
* Channel.Type: Channel.Type.Text,
* Channel.TargetHandleType: Handle_Type_Contact,
* Channel.TargetID: escher.cat,
* Channel.Interface.SMS.SMSChannel: True,
* }</pre></blockquote>
*
* <div class="rationale">
* Some protocols allow us to send SMSes to a remote contact, without
* knowing the phone number to which those SMSes will be sent. This
* provides a mechanism to request such channels.
* </div>
*
* <p>If this property is not included in the channel request, the
* Connection Manager MAY return an SMS channel if that is the most
* appropriate medium (i.e. if the channel target is a phone
* number).</p>
*
* <div class="rationale">
* To some types of identifiers (i.e. phone numbers) it only makes
* sense to return an SMS channel, this is what happens currently with
* telepathy-ring. We don't want to break this behaviour when we are
* not explicit about the type of channel we want. Alternatively, for
* protocols where there is an SMS fallback for IM messages, it's
* possible that we don't care what sort of channel we get, and simply
* want notification of the transport.
* </div>
*
* <p>Some protocols have a fallback to deliver IM messages via SMS.
* On these protocols, the Connection Manager SHOULD set the property
* value as appropriate, and notify its change with
* \endhtmlonly SMSChannelChanged() \htmlonly .</p>
*
* <div class="rationale">
* Protocols such as MSN can fall back to delivering IM messages via
* SMS. Where possible we want clients to be able to inform the user
* that their messages are going to be redirected to the remote
* contact's phone.
* </div>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertySMSChannel() const
{
return internalRequestProperty(QLatin1String("SMSChannel"));
}
/**
* 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 GetSMSLength on the remote object.
*
* \htmlonly
* <p>Returns the number of 140 octet chunks required to send a message
* via SMS, as well as the number of remaining characters available in
* the final chunk and, if possible, an estimate of the cost.</p>
*
* <div class="rationale">
* <p>There are a number of different SMS encoding mechanisms, and the
* client doesn't know which mechanisms an individual CM might support.
* This method allows the client, without any knowledge of the
* encoding mechanism, to provide length details to the user.</p>
* </div>
*
* <p>Clients SHOULD limit the frequency with which this method is called
* and SHOULD NOT call it for every keystroke. Clients MAY estimate the
* remaining size between single keystrokes.</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 message
*
* The message the user wishes to send.
* \param timeout The timeout in milliseconds.
*
* \return
*
* \htmlonly
* <p>The number of 140 octet chunks required to send this message.</p>
*
* <p>For example, in the GSM standard 7-bit encoding, a 162 character
* message would require 2 chunks.</p>
* \endhtmlonly
*
* \return
*
* \htmlonly
* <p>The number of further characters that can be fit in the final
* chunk. A negative value indicates that the message will be
* truncated by <code>abs(Remaining_Characters)</code>. The value
* <code>MIN_INT32</code> (<code>-2<sup>31</sup></code>)
* indicates the message will be truncated by an unknown amount.</p>
*
* <p>For example, in the GSM standard 7-bit encoding, a 162 character
* message would return 144 remaining characters (because of the
* space required for the multipart SMS header).</p>
* \endhtmlonly
*
* \return
*
* \htmlonly
* <p>The estimated cost of sending this message. The currency and
* scale of this value are the same as the
* \endhtmlonly \link ConnectionInterfaceBalanceInterface::requestPropertyAccountBalance() ConnectionInterfaceBalanceInterface::AccountBalance \endlink \htmlonly
* property.</p>
*
* <p>A value of <code>-1</code> indicates the cost could not be
* estimated.</p>
* \endhtmlonly
*/
inline QDBusPendingReply<uint, int, int> GetSMSLength(const Tp::MessagePartList& message, int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<uint, int, int>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("GetSMSLength"));
callMessage << QVariant::fromValue(message);
return this->connection().asyncCall(callMessage, timeout);
}
Q_SIGNALS:
/**
* Represents the signal \c SMSChannelChanged on the remote object.
*
* This signal indicates a change in the SMSChannel property.
*
* \param SMSChannel
*
* The new value for SMSChannel.
*/
void SMSChannelChanged(bool SMSChannel);
protected:
virtual void invalidate(Tp::DBusProxy *, const QString &, const QString &);
};
/**
* \class ChannelInterfaceSecurableInterface
* \headerfile TelepathyQt/channel.h <TelepathyQt/Channel>
* \ingroup clientchannel
*
* Proxy class providing a 1:1 mapping of the D-Bus interface "org.freedesktop.Telepathy.Channel.Interface.Securable".
*/
class TP_QT_EXPORT ChannelInterfaceSecurableInterface : public Tp::AbstractInterface
{
Q_OBJECT
public:
/**
* Returns the name of the interface "org.freedesktop.Telepathy.Channel.Interface.Securable", which this class
* represents.
*
* \return The D-Bus interface name.
*/
static inline QLatin1String staticInterfaceName()
{
return QLatin1String("org.freedesktop.Telepathy.Channel.Interface.Securable");
}
/**
* Creates a ChannelInterfaceSecurableInterface 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.
*/
ChannelInterfaceSecurableInterface(
const QString& busName,
const QString& objectPath,
QObject* parent = 0
);
/**
* Creates a ChannelInterfaceSecurableInterface 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.
*/
ChannelInterfaceSecurableInterface(
const QDBusConnection& connection,
const QString& busName,
const QString& objectPath,
QObject* parent = 0
);
/**
* Creates a ChannelInterfaceSecurableInterface 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.
*/
ChannelInterfaceSecurableInterface(Tp::DBusProxy *proxy);
/**
* Creates a ChannelInterfaceSecurableInterface 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 ChannelInterfaceSecurableInterface(const Tp::Client::ChannelInterface& mainInterface);
/**
* Creates a ChannelInterfaceSecurableInterface 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.
*/
ChannelInterfaceSecurableInterface(const Tp::Client::ChannelInterface& mainInterface, QObject* parent);
/**
* Asynchronous getter for the remote object property \c Encrypted of type \c bool.
*
*
* \htmlonly
* <p>True if this channel occurs over an encrypted
* connection. This <strong>does not</strong> imply that steps
* have been taken to avoid man-in-the-middle attacks.</p>
*
* <div class="rationale">
* <p>For future support for <a href="http://tools.ietf.org/html/rfc5056">RFC 5056 Channel
* Binding</a> it is desirable to be able to use some SASL
* mechanisms over an encrypted connection to an unverified peer,
* which can prove that it is the desired destination during
* the SASL negotiation.</p>
* </div>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyEncrypted() const
{
return internalRequestProperty(QLatin1String("Encrypted"));
}
/**
* Asynchronous getter for the remote object property \c Verified of type \c bool.
*
*
* \htmlonly
* <p>True if this channel occurs over a connection that is
* protected against tampering, and has been verified to be with
* the desired destination: for instance, one where TLS was
* previously negotiated, and the TLS certificate has been
* verified against a configured certificate authority or
* accepted by the user.</p>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyVerified() const
{
return internalRequestProperty(QLatin1String("Verified"));
}
/**
* 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();
}
protected:
virtual void invalidate(Tp::DBusProxy *, const QString &, const QString &);
};
/**
* \class ChannelInterfaceServicePointInterface
* \headerfile TelepathyQt/channel.h <TelepathyQt/Channel>
* \ingroup clientchannel
*
* Proxy class providing a 1:1 mapping of the D-Bus interface "org.freedesktop.Telepathy.Channel.Interface.ServicePoint".
*/
class TP_QT_EXPORT ChannelInterfaceServicePointInterface : public Tp::AbstractInterface
{
Q_OBJECT
public:
/**
* Returns the name of the interface "org.freedesktop.Telepathy.Channel.Interface.ServicePoint", which this class
* represents.
*
* \return The D-Bus interface name.
*/
static inline QLatin1String staticInterfaceName()
{
return QLatin1String("org.freedesktop.Telepathy.Channel.Interface.ServicePoint");
}
/**
* Creates a ChannelInterfaceServicePointInterface 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.
*/
ChannelInterfaceServicePointInterface(
const QString& busName,
const QString& objectPath,
QObject* parent = 0
);
/**
* Creates a ChannelInterfaceServicePointInterface 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.
*/
ChannelInterfaceServicePointInterface(
const QDBusConnection& connection,
const QString& busName,
const QString& objectPath,
QObject* parent = 0
);
/**
* Creates a ChannelInterfaceServicePointInterface 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.
*/
ChannelInterfaceServicePointInterface(Tp::DBusProxy *proxy);
/**
* Creates a ChannelInterfaceServicePointInterface 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 ChannelInterfaceServicePointInterface(const Tp::Client::ChannelInterface& mainInterface);
/**
* Creates a ChannelInterfaceServicePointInterface 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.
*/
ChannelInterfaceServicePointInterface(const Tp::Client::ChannelInterface& mainInterface, QObject* parent);
/**
* Asynchronous getter for the remote object property \c InitialServicePoint of type \c Tp::ServicePoint.
*
*
* \htmlonly
* <p>This property is used to indicate that the channel target is a
* well-known service point. Please note that the CM (or lower layers
* of the stack or network) may forward the connection to other other
* service points, which the CM SHOULD indicate via
* \endhtmlonly ServicePointChanged() \htmlonly
* signal.</p>
*
* <p>This property SHOULD be set for channel requests that are
* specifically targeting service points.</p>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyInitialServicePoint() const
{
return internalRequestProperty(QLatin1String("InitialServicePoint"));
}
/**
* Asynchronous getter for the remote object property \c CurrentServicePoint of type \c Tp::ServicePoint.
*
*
* The service point that the channel is connected to. If the channel is
* not connected to a service point, the CM MUST set the
* Service_Point_Type field to None; for instance, this will be the case
* for ordinary calls.
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyCurrentServicePoint() const
{
return internalRequestProperty(QLatin1String("CurrentServicePoint"));
}
/**
* 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 ServicePointChanged on the remote object.
*
* Emitted when a channel changes the service point that it's
* connected to. This might be a new call being connected to a service, a
* call connected to a service being routed to a different service (ie, an
* emergency call being routed from a generic emergency PSAP to a poison
* control PSAP), or any number of other things. Note that this should be
* emitted as soon as the CM has been notified of the switch, and has
* updated its internal state. The CM MAY still be in the process of
* connecting to the new service point.
*
* \param servicePoint
*
* The new service point that is being used.
*/
void ServicePointChanged(const Tp::ServicePoint& servicePoint);
protected:
virtual void invalidate(Tp::DBusProxy *, const QString &, const QString &);
};
/**
* \class ChannelInterfaceSubjectInterface
* \headerfile TelepathyQt/channel.h <TelepathyQt/Channel>
* \ingroup clientchannel
*
* Proxy class providing a 1:1 mapping of the D-Bus interface "org.freedesktop.Telepathy.Channel.Interface.Subject2".
*/
class TP_QT_EXPORT ChannelInterfaceSubjectInterface : public Tp::AbstractInterface
{
Q_OBJECT
public:
/**
* Returns the name of the interface "org.freedesktop.Telepathy.Channel.Interface.Subject2", which this class
* represents.
*
* \return The D-Bus interface name.
*/
static inline QLatin1String staticInterfaceName()
{
return QLatin1String("org.freedesktop.Telepathy.Channel.Interface.Subject2");
}
/**
* Creates a ChannelInterfaceSubjectInterface 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.
*/
ChannelInterfaceSubjectInterface(
const QString& busName,
const QString& objectPath,
QObject* parent = 0
);
/**
* Creates a ChannelInterfaceSubjectInterface 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.
*/
ChannelInterfaceSubjectInterface(
const QDBusConnection& connection,
const QString& busName,
const QString& objectPath,
QObject* parent = 0
);
/**
* Creates a ChannelInterfaceSubjectInterface 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.
*/
ChannelInterfaceSubjectInterface(Tp::DBusProxy *proxy);
/**
* Creates a ChannelInterfaceSubjectInterface 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 ChannelInterfaceSubjectInterface(const Tp::Client::ChannelInterface& mainInterface);
/**
* Creates a ChannelInterfaceSubjectInterface 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.
*/
ChannelInterfaceSubjectInterface(const Tp::Client::ChannelInterface& mainInterface, QObject* parent);
/**
* Asynchronous getter for the remote object property \c Subject of type \c QString.
*
*
* \htmlonly
* <p>The human-readable subject on the channel such as the topic
* in an IRC channel, or the room name in XMPP MUCs.</p>
*
* <div class="rationale">This property replaces the subject Telepathy
* property of Text channels, as Telepathy properties are soon to
* be deprecated completely.</div>
*
* <p>This property may change during the lifetime of the channel and
* MUST not be included in a channel request.</p>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertySubject() const
{
return internalRequestProperty(QLatin1String("Subject"));
}
/**
* Asynchronous getter for the remote object property \c Actor of type \c QString.
*
*
* \htmlonly
* <p>The normalized contact ID representing who last modified
* the subject, or the empty string if it is not known.</p>
*
* <div class="rationale">This property replaces the subject-contact
* Telepathy property of Text channels, as Telepathy properties
* are soon to be deprecated completely.</div>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyActor() const
{
return internalRequestProperty(QLatin1String("Actor"));
}
/**
* Asynchronous getter for the remote object property \c ActorHandle of type \c uint.
*
*
* \htmlonly
* <p>The handle corresponding to \endhtmlonly \link requestPropertyActor() Actor \endlink \htmlonly ,
* or 0 if the \endhtmlonly \link requestPropertyActor() Actor \endlink \htmlonly is unknown.</p>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyActorHandle() const
{
return internalRequestProperty(QLatin1String("ActorHandle"));
}
/**
* Asynchronous getter for the remote object property \c Timestamp of type \c qlonglong.
*
*
* \htmlonly
* <p>A unix timestamp indicating when the subject was last
* modified, or <code>INT_MAX64</code> if unknown.</p>
*
* <div class="rationale">This property replaces the subject-timestamp
* Telepathy property of Text channels, as Telepathy properties
* are soon to be deprecated completely.</div>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyTimestamp() const
{
return internalRequestProperty(QLatin1String("Timestamp"));
}
/**
* Asynchronous getter for the remote object property \c CanSet of type \c bool.
*
*
* \htmlonly
* <p>TRUE if the \endhtmlonly \link requestPropertySubject() Subject \endlink \htmlonly property
* can be set by the user by calling
* \endhtmlonly SetSubject() \htmlonly , otherwise
* FALSE.</p>
*
* <p>If implementations are unsure of what this value should be
* it SHOULD still be set to what it believes the value
* is. As a result, clients should be aware that
* \endhtmlonly SetSubject() \htmlonly can still fail
* even with this property set to TRUE.</p>
*
* <div class="rationale">In XMPP it is impossible to know whether an
* occupant can set the subject as XMPP server implementations
* are wildly inconsistent.</div>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyCanSet() const
{
return internalRequestProperty(QLatin1String("CanSet"));
}
/**
* 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 SetSubject on the remote object.
*
* \htmlonly
* <p>Set the room's subject. Clients SHOULD look at the subject
* flags before calling this method as the user might not have
* permission to set the subject.</p>
*
* <p>A successful return of this method indicates a successful
* change in subject, but clients should still listen for changes
* to the \endhtmlonly \link requestPropertySubject() Subject \endlink \htmlonly property for
* further changes by other users or the server.</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 subject
*
* The new subject.
* \param timeout The timeout in milliseconds.
*/
inline QDBusPendingReply<> SetSubject(const QString& subject, int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("SetSubject"));
callMessage << QVariant::fromValue(subject);
return this->connection().asyncCall(callMessage, timeout);
}
protected:
virtual void invalidate(Tp::DBusProxy *, const QString &, const QString &);
};
/**
* \class ChannelInterfaceTubeInterface
* \headerfile TelepathyQt/channel.h <TelepathyQt/Channel>
* \ingroup clientchannel
*
* Proxy class providing a 1:1 mapping of the D-Bus interface "org.freedesktop.Telepathy.Channel.Interface.Tube".
*/
class TP_QT_EXPORT ChannelInterfaceTubeInterface : public Tp::AbstractInterface
{
Q_OBJECT
public:
/**
* Returns the name of the interface "org.freedesktop.Telepathy.Channel.Interface.Tube", which this class
* represents.
*
* \return The D-Bus interface name.
*/
static inline QLatin1String staticInterfaceName()
{
return QLatin1String("org.freedesktop.Telepathy.Channel.Interface.Tube");
}
/**
* Creates a ChannelInterfaceTubeInterface 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.
*/
ChannelInterfaceTubeInterface(
const QString& busName,
const QString& objectPath,
QObject* parent = 0
);
/**
* Creates a ChannelInterfaceTubeInterface 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.
*/
ChannelInterfaceTubeInterface(
const QDBusConnection& connection,
const QString& busName,
const QString& objectPath,
QObject* parent = 0
);
/**
* Creates a ChannelInterfaceTubeInterface 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.
*/
ChannelInterfaceTubeInterface(Tp::DBusProxy *proxy);
/**
* Creates a ChannelInterfaceTubeInterface 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 ChannelInterfaceTubeInterface(const Tp::Client::ChannelInterface& mainInterface);
/**
* Creates a ChannelInterfaceTubeInterface 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.
*/
ChannelInterfaceTubeInterface(const Tp::Client::ChannelInterface& mainInterface, QObject* parent);
/**
* Asynchronous getter for the remote object property \c Parameters of type \c QVariantMap.
*
*
* \htmlonly
* <p>Each tube has a dictionary of arbitrary parameters. Parameters are
* commonly used to bootstrap legacy protocols where you can't
* negotiate parameters in-band. The allowable keys,
* types and values are defined by the service, but connection managers
* must support the value being a string (D-Bus type <tt>'s'</tt>),
* array of bytes (D-Bus type <tt>'ay'</tt>), unsigned integer (D-Bus
* type <tt>'u'</tt>), integer (D-Bus type <tt>'i'</tt>) and boolean
* (D-Bus type <tt>'b'</tt>).</p>
*
* <p>When the tube is offered, the parameters are transmitted with the
* offer and appear as a property of the incoming tube for other
* participants.</p>
*
* <p>For example, a stream tube for \endhtmlonly \link ChannelTypeStreamTubeInterface::requestPropertyService() ChannelTypeStreamTubeInterface::Service \endlink \htmlonly
* <tt>"smb"</tt> (<cite>Server Message Block over TCP/IP</cite>) might
* use the following properties, as defined in <a href="http://www.dns-sd.org/ServiceTypes.html">DNS SRV (RFC 2782)
* Service Types</a>:</p>
*
* <pre>
* { 'u': 'some-username',
* 'p': 'top-secret-password',
* 'path': '/etc/passwd',
* }</pre>
*
* <p>When requesting a tube with
* \endhtmlonly ConnectionInterfaceRequestsInterface::CreateChannel() \htmlonly ,
* this property MUST NOT be included in the request; instead, it is set
* when \endhtmlonly ChannelTypeStreamTubeInterface::Offer() \htmlonly
* or \endhtmlonly ChannelTypeDBusTubeInterface::Offer() \htmlonly
* (as appropriate) is called. Its value is undefined until the tube is
* offered; once set, its value MUST NOT change.</p>
*
* <p>When receiving an incoming tube, this property is immutable and so advertised in the
* \endhtmlonly ConnectionInterfaceRequestsInterface::NewChannels() \htmlonly
* signal.</p>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyParameters() const
{
return internalRequestProperty(QLatin1String("Parameters"));
}
/**
* Asynchronous getter for the remote object property \c State of type \c uint.
*
*
* \htmlonly
* <p>State of the tube in this channel.</p>
*
* <p>When requesting a tube with
* \endhtmlonly ConnectionInterfaceRequestsInterface::CreateChannel() \htmlonly ,
* this property MUST NOT be included in the request.</p>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyState() const
{
return internalRequestProperty(QLatin1String("State"));
}
/**
* 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 TubeChannelStateChanged on the remote object.
*
* Emitted when the state of the tube channel changes. Valid state
* transitions are documented with Tube_Channel_State.
*
* \param state
*
* The new state of the tube.
*/
void TubeChannelStateChanged(uint state);
protected:
virtual void invalidate(Tp::DBusProxy *, const QString &, const QString &);
};
/**
* \class ChannelTypeCallInterface
* \headerfile TelepathyQt/channel.h <TelepathyQt/Channel>
* \ingroup clientchannel
*
* Proxy class providing a 1:1 mapping of the D-Bus interface "org.freedesktop.Telepathy.Channel.Type.Call1".
*/
class TP_QT_EXPORT ChannelTypeCallInterface : public Tp::AbstractInterface
{
Q_OBJECT
public:
/**
* Returns the name of the interface "org.freedesktop.Telepathy.Channel.Type.Call1", which this class
* represents.
*
* \return The D-Bus interface name.
*/
static inline QLatin1String staticInterfaceName()
{
return QLatin1String("org.freedesktop.Telepathy.Channel.Type.Call1");
}
/**
* Creates a ChannelTypeCallInterface 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.
*/
ChannelTypeCallInterface(
const QString& busName,
const QString& objectPath,
QObject* parent = 0
);
/**
* Creates a ChannelTypeCallInterface 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.
*/
ChannelTypeCallInterface(
const QDBusConnection& connection,
const QString& busName,
const QString& objectPath,
QObject* parent = 0
);
/**
* Creates a ChannelTypeCallInterface 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.
*/
ChannelTypeCallInterface(Tp::DBusProxy *proxy);
/**
* Creates a ChannelTypeCallInterface 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 ChannelTypeCallInterface(const Tp::Client::ChannelInterface& mainInterface);
/**
* Creates a ChannelTypeCallInterface 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.
*/
ChannelTypeCallInterface(const Tp::Client::ChannelInterface& mainInterface, QObject* parent);
/**
* Asynchronous getter for the remote object property \c Contents of type \c Tp::ObjectPathList.
*
*
* \htmlonly
* <p>The list of \endhtmlonly CallContentInterface \htmlonly objects that
* are part of this call. Change notification is via the
* \endhtmlonly ContentAdded() \htmlonly and
* \endhtmlonly ContentRemoved() \htmlonly signals.
* </p>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyContents() const
{
return internalRequestProperty(QLatin1String("Contents"));
}
/**
* Asynchronous getter for the remote object property \c CallStateDetails of type \c QVariantMap.
*
*
* \htmlonly
* <p>A map used to provide optional extensible details for the
* \endhtmlonly \link requestPropertyCallState() CallState \endlink \htmlonly ,
* \endhtmlonly \link requestPropertyCallFlags() CallFlags \endlink \htmlonly and/or
* \endhtmlonly \link requestPropertyCallStateReason() CallStateReason \endlink \htmlonly .</p>
*
* <p>Well-known keys and their corresponding value types include:</p>
*
* <dl>
* <dt>hangup-message - s</dt>
* <dd>An optional human-readable message sent when the call was ended,
* corresponding to the Message argument to the
* \endhtmlonly Hangup() \htmlonly method. This is only
* applicable when the call state is <tp:value-ref type="Call_State">Ended</tp:value-ref>.
* <div class="rationale">
* XMPP Jingle can send such messages.
* </div>
* </dd>
*
* <dt>queue-message - s</dt>
* <dd>An optional human-readable message sent when the local contact
* is being held in a queue. This is only applicable when
* <tp:value-ref type="Call_Flags">Locally_Queued</tp:value-ref> is in the call flags.
* <div class="rationale">
* SIP 182 notifications can have human-readable messages attached.
* </div>
* </dd>
*
* <dt>debug-message - s</dt>
* <dd>A message giving further details of any error indicated by the
* \endhtmlonly \link requestPropertyCallStateReason() CallStateReason \endlink \htmlonly . This will not
* normally be localized or suitable for display to users, and is only
* applicable when the call state is
* <tp:value-ref type="Call_State">Ended</tp:value-ref>.</dd>
*
* <dt>balance-required - i</dt>
* <dd>Optionally included when a call cannot be connected because
* there is <tp:error-ref>InsufficientBalance</tp:error-ref>,
* indicating what the required balance would be to place this call.
* The value of this key has the same units and scale as
* \endhtmlonly \link ConnectionInterfaceBalanceInterface::requestPropertyAccountBalance() ConnectionInterfaceBalanceInterface::AccountBalance \endlink \htmlonly .
* </dd>
*
* <dt>forwarded-to - u</dt>
* <dd>Optionally included when the
* \endhtmlonly \link requestPropertyCallStateReason() CallStateReason \endlink \htmlonly is
* Forwarded. It indicates the handle to whom the Call was
* forwarded.</dd>
*
* <dt>forwarded-to-id - s</dt>
* <dd>The string that would result from inspecting the
* <code>forwarded-to</code> key
* (i.e. the contact's identifier in the IM protocol).</dd>
* </dl>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyCallStateDetails() const
{
return internalRequestProperty(QLatin1String("CallStateDetails"));
}
/**
* Asynchronous getter for the remote object property \c CallState of type \c uint.
*
*
* \htmlonly
* <p>The current high-level state of this call. The
* \endhtmlonly \link requestPropertyCallFlags() CallFlags \endlink \htmlonly provide additional
* information, and the \endhtmlonly \link requestPropertyCallStateReason() CallStateReason \endlink \htmlonly
* and \endhtmlonly \link requestPropertyCallStateDetails() CallStateDetails \endlink \htmlonly explain the
* reason for the current values for those properties.</p>
*
* <p>Note that when in a conference call, this property is
* purely to show your state in joining the call. The receiver
* (or remote contact) in this context is the conference server
* itself. The property does not change when other call members'
* states change.</p>
*
* <p>Clients MAY consider unknown values in this property to be an
* error.</p>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyCallState() const
{
return internalRequestProperty(QLatin1String("CallState"));
}
/**
* Asynchronous getter for the remote object property \c CallFlags of type \c uint.
*
*
* \htmlonly
* <p>Flags representing the status of the call as a whole,
* providing more specific information than the
* \endhtmlonly \link requestPropertyCallState() CallState \endlink \htmlonly .</p>
*
* <p>Clients are expected to ignore unknown flags in this property,
* without error.</p>
*
* <p>When an ongoing call is active and not on hold or has any
* other problems, this property will be 0.</p>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyCallFlags() const
{
return internalRequestProperty(QLatin1String("CallFlags"));
}
/**
* Asynchronous getter for the remote object property \c CallStateReason of type \c Tp::CallStateReason.
*
*
* \htmlonly
* <p>The reason for the last change to the
* \endhtmlonly \link requestPropertyCallState() CallState \endlink \htmlonly and/or
* \endhtmlonly \link requestPropertyCallFlags() CallFlags \endlink \htmlonly . The
* \endhtmlonly \link requestPropertyCallStateDetails() CallStateDetails \endlink \htmlonly MAY provide additional
* information.</p>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyCallStateReason() const
{
return internalRequestProperty(QLatin1String("CallStateReason"));
}
/**
* Asynchronous getter for the remote object property \c HardwareStreaming of type \c bool.
*
*
* \htmlonly
* <p>If this property is True, all of the media streaming is done by some
* mechanism outside the scope of Telepathy.</p>
*
* <div class="rationale">
* <p>A connection manager might be intended for a specialized hardware
* device, which will take care of the audio streaming (e.g.
* telepathy-ring, which uses GSM hardware which does the actual
* audio streaming for the call).</p>
* </div>
*
* <p>If this is False, the handler is responsible for doing the actual
* media streaming for at least some contents itself. Those contents
* will have the \endhtmlonly CallContentInterfaceMediaInterface \htmlonly interface, to communicate the necessary
* information to a streaming implementation. Connection managers SHOULD
* operate like this, if possible.</p>
*
* <div class="rationale">
* <p>Many connection managers (such as telepathy-gabble) only do the
* call signalling, and expect the client to do the actual streaming
* using something like
* <a href="http://farsight.freedesktop.org/">Farsight</a>, to improve
* latency and allow better UI integration.</p>
* </div>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyHardwareStreaming() const
{
return internalRequestProperty(QLatin1String("HardwareStreaming"));
}
/**
* Asynchronous getter for the remote object property \c CallMembers of type \c Tp::CallMemberMap.
*
*
* \htmlonly
* <p>A mapping from the remote contacts that are part of this call to flags
* describing their status. This mapping never has the local user's handle
* as a key.</p>
*
* <p>When the call ends, this property should be an empty list,
* and notified with
* \endhtmlonly CallMembersChanged() \htmlonly </p>
*
* <p>If the Call implements
* \endhtmlonly ChannelInterfaceGroupInterface \htmlonly and the Group members are
* channel-specific handles, then this call SHOULD also use
* channel-specific handles.</p>
*
* <p>Anonymous members are exposed as channel-specific handles
* with no owner.</p>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyCallMembers() const
{
return internalRequestProperty(QLatin1String("CallMembers"));
}
/**
* Asynchronous getter for the remote object property \c MemberIdentifiers of type \c Tp::HandleIdentifierMap.
*
*
* The string identifiers for handles mentioned in CallMembers, to give
* clients the minimal information necessary to create contacts without
* waiting for round-trips.
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyMemberIdentifiers() const
{
return internalRequestProperty(QLatin1String("MemberIdentifiers"));
}
/**
* Asynchronous getter for the remote object property \c InitialTransport of type \c uint.
*
*
* \htmlonly
* <p>If set on a requested channel, this indicates the transport that
* should be used for this call. Where not applicable, this property
* is defined to be <tp:value-ref type="Stream_Transport_Type">Unknown</tp:value-ref>,
* in particular, on CMs with hardware streaming.</p>
*
* <div class="rationale">
* When implementing a voip gateway one wants the outgoing leg of the
* gatewayed to have the same transport as the incoming leg. This
* property allows the gateway to request a Call with the right
* transport from the CM.
* </div>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyInitialTransport() const
{
return internalRequestProperty(QLatin1String("InitialTransport"));
}
/**
* Asynchronous getter for the remote object property \c InitialAudio of type \c bool.
*
*
* \htmlonly
* <p>If set to True in a channel request that will create a new channel,
* the connection manager should immediately attempt to establish an
* audio stream to the remote contact, making it unnecessary for the
* client to call \endhtmlonly ChannelTypeCallInterface::AddContent() \htmlonly .</p>
*
* <p>If this property, or InitialVideo, is passed to EnsureChannel
* (as opposed to CreateChannel), the connection manager SHOULD ignore
* these properties when checking whether it can return an existing
* channel as suitable; these properties only become significant when
* the connection manager has decided to create a new channel.</p>
*
* <p>If True on a requested channel, this indicates that the audio
* stream has already been requested and the client does not need to
* call RequestStreams, although it MAY still do so.</p>
*
* <p>If True on an unrequested (incoming) channel, this indicates that
* the remote contact initially requested an audio stream; this does
* not imply that that audio stream is still active (as indicated by
* \endhtmlonly \link ChannelTypeCallInterface::requestPropertyContents() ChannelTypeCallInterface::Contents \endlink \htmlonly ).</p>
*
* <p>The name of this new content can be decided by using the
* \endhtmlonly \link requestPropertyInitialAudioName() InitialAudioName \endlink \htmlonly property.</p>
*
* <p>Connection managers that support the \endhtmlonly ConnectionInterfaceContactCapabilitiesInterface \htmlonly
* interface SHOULD represent the capabilities of receiving audio
* and/or video calls by including a channel class in
* a contact's capabilities with ChannelType = Call
* in the fixed properties dictionary, and InitialAudio and/or
* InitialVideo in the allowed properties list. Clients wishing to
* discover whether a particular contact is likely to be able to
* receive audio and/or video calls SHOULD use this information.</p>
*
* <div class="rationale">
* <p>Not all clients support video calls, and it would also be
* possible (although unlikely) to have a client which could only
* stream video, not audio.</p>
* </div>
*
* <p>Clients that are willing to receive audio and/or video calls
* SHOULD include the following among their channel classes if
* calling \endhtmlonly ConnectionInterfaceContactCapabilitiesInterface::UpdateCapabilities() \htmlonly
* (clients of a \endhtmlonly ChannelDispatcherInterface \htmlonly
* SHOULD instead arrange for the ChannelDispatcher to do this,
* by including the filters in their \endhtmlonly \link ClientHandlerInterface::requestPropertyHandlerChannelFilter() ClientHandlerInterface::HandlerChannelFilter \endlink \htmlonly
* properties):</p>
*
* <ul>
* <li>{ ChannelType = Call }</li>
* <li>{ ChannelType = Call, InitialAudio = True }
* if receiving calls with audio is supported</li>
* <li>{ ChannelType = Call, InitialVideo = True }
* if receiving calls with video is supported</li>
* </ul>
*
* <div class="rationale">
* <p>Connection managers for protocols with capability discovery,
* like XMPP, need this information to advertise the appropriate
* capabilities for their protocol.</p>
* </div>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyInitialAudio() const
{
return internalRequestProperty(QLatin1String("InitialAudio"));
}
/**
* Asynchronous getter for the remote object property \c InitialVideo of type \c bool.
*
*
* \htmlonly
* <p>The same as \endhtmlonly \link requestPropertyInitialAudio() InitialAudio \endlink \htmlonly , but for
* a video stream. This property is immutable (cannot change).</p>
*
* <p>In particular, note that if this property is False, this does not
* imply that an active video stream has not been added, only that no
* video stream was active at the time the channel appeared.</p>
*
* <p>This property is the correct way to discover whether connection
* managers, contacts etc. support video calls; it appears in
* capabilities structures in the same way as InitialAudio.</p>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyInitialVideo() const
{
return internalRequestProperty(QLatin1String("InitialVideo"));
}
/**
* Asynchronous getter for the remote object property \c InitialAudioName of type \c QString.
*
*
* \htmlonly
* <p>If \endhtmlonly \link requestPropertyInitialAudio() InitialAudio \endlink \htmlonly is set to
* True, then this property will name the intial audio content
* with the value of this property.</p>
*
* <div class="rationale">
* <p>Content names are meant to be significant, but if no name
* can be given to initial audio content, then its name cannot
* be meaningful or even localized.</p>
* </div>
*
* <p>If this property is empty or missing from the channel
* request and InitialAudio is True, then the CM must come up
* with a sensible for the content, such as "audio".</p>
*
* <p>If the protocol has no concept of stream names then this
* property will not show up in the allowed properties list of
* the Requestable Channel Classes for call channels.</p>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyInitialAudioName() const
{
return internalRequestProperty(QLatin1String("InitialAudioName"));
}
/**
* Asynchronous getter for the remote object property \c InitialVideoName of type \c QString.
*
*
* \htmlonly
* <p>The same as
* \endhtmlonly \link requestPropertyInitialAudioName() InitialAudioName \endlink \htmlonly , but for a
* video stream created by setting
* \endhtmlonly \link requestPropertyInitialVideo() InitialVideo \endlink \htmlonly to True. This
* property is immutable and so cannot change.</p>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyInitialVideoName() const
{
return internalRequestProperty(QLatin1String("InitialVideoName"));
}
/**
* Asynchronous getter for the remote object property \c MutableContents of type \c bool.
*
*
* \htmlonly
* <p>If True, a stream of a different content type can be added
* after the Channel has been requested </p>
*
* <p>If this property is missing, clients SHOULD assume that it is False,
* and thus that the channel's streams cannot be changed once the call
* has started.</p>
*
* <p>If this property isn't present in the "allowed" set in any of the
* Call entries contact capabilities, then user interfaces MAY choose to
* show a separate "call" option for each class of call.</p>
*
* <div class="rationale">
* <p>For example, once an audio-only Google Talk call has started,
* it is not possible to add a video stream; both audio and video
* must be requested at the start of the call if video is desired.
* User interfaces may use this pseudo-capability as a hint to
* display separate "Audio call" and "Video call" buttons, rather
* than a single "Call1" button with the option to add and remove
* video once the call has started for contacts without this flag.
* </p>
* </div>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyMutableContents() const
{
return internalRequestProperty(QLatin1String("MutableContents"));
}
/**
* 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 SetRinging on the remote object.
*
* \htmlonly
* <p>Indicate that the local user has been alerted about the incoming
* call.</p>
*
* <p>This method is only useful if the
* channel's \endhtmlonly \link ChannelInterface::requestPropertyRequested() ChannelInterface::Requested \endlink \htmlonly
* property is False, and
* the \endhtmlonly \link requestPropertyCallState() CallState \endlink \htmlonly is
* <tp:value-ref type="Call_State">Initialised</tp:value-ref> (an incoming
* call is ready and waiting for the user to be notified). Calling this method
* SHOULD set \endhtmlonly \link requestPropertyCallFlags() CallFlags \endlink \htmlonly ' bit
* <tp:value-ref type="Call_Flags">Locally_Ringing</tp:value-ref>, and notify the
* remote contact that the local user has been alerted (if the
* protocol supports this); repeated calls to this method
* SHOULD succeed, but have no further effect.</p>
*
* <p>In all other states, this method SHOULD fail with the error
* NotAvailable.</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<> SetRinging(int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("SetRinging"));
return this->connection().asyncCall(callMessage, timeout);
}
/**
* Begins a call to the D-Bus method \c SetQueued on the remote object.
*
* \htmlonly
* <p>Notifies the CM that the local user is already in a call, so this
* call has been put in a call-waiting style queue.</p>
*
* <p>This method is only useful if the
* channel's \endhtmlonly \link ChannelInterface::requestPropertyRequested() ChannelInterface::Requested \endlink \htmlonly
* property is False, and
* the \endhtmlonly \link requestPropertyCallState() CallState \endlink \htmlonly is
* <tp:value-ref type="Call_State">Initialising</tp:value-ref> or
* <tp:value-ref type="Call_State">Initialised</tp:value-ref>. Calling this method
* SHOULD set \endhtmlonly \link requestPropertyCallFlags() CallFlags \endlink \htmlonly ' bit
* <tp:value-ref type="Call_Flags">Locally_Queued</tp:value-ref>, and notify the
* remote contact that the call is in a queue (if the
* protocol supports this); repeated calls to this method
* SHOULD succeed, but have no further effect.</p>
*
* <p>Locally_Queued is a little like Locally_Held, but applies to calls that have not
* been Accepted (the Locally_Queued flag should be unset by the CM when Accept
* is called). It should also be set in response to the state of the
* world, rather than in response to user action.</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<> SetQueued(int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("SetQueued"));
return this->connection().asyncCall(callMessage, timeout);
}
/**
* Begins a call to the D-Bus method \c Accept on the remote object.
*
* \htmlonly
* <p>For incoming calls in state
* <tp:value-ref type="Call_State">Initialised</tp:value-ref>, accept the incoming call.
* This changes the \endhtmlonly \link requestPropertyCallState() CallState \endlink \htmlonly to
* <tp:value-ref type="Call_State">Accepted</tp:value-ref>.</p>
*
* <p>For outgoing calls in state
* <tp:value-ref type="Call_State">Pending_Initiator</tp:value-ref>, actually
* call the remote contact; this changes the
* \endhtmlonly \link requestPropertyCallState() CallState \endlink \htmlonly to
* <tp:value-ref type="Call_State">Initialising</tp:value-ref>.</p>
*
* <p>Otherwise, this method SHOULD fail with the error NotAvailable.</p>
*
* <p>This method should be called exactly once per Call, by whatever
* client (user interface) is handling the channel.</p>
*
* <p>When this method is called, for each \endhtmlonly CallContentInterface \htmlonly whose
* \endhtmlonly \link CallContentInterface::requestPropertyDisposition() CallContentInterface::Disposition \endlink \htmlonly is
* <tp:value-ref type="Call_Content_Disposition">Initial</tp:value-ref>, any
* streams where the \endhtmlonly \link CallStreamInterface::requestPropertyLocalSendingState() CallStreamInterface::LocalSendingState \endlink \htmlonly
* is <tp:value-ref type="Sending_State">Pending_Send</tp:value-ref> will be
* moved to <tp:value-ref type="Sending_State">Sending</tp:value-ref> as if
* \endhtmlonly CallStreamInterface::SetSending() \htmlonly (True) had been called.</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<> Accept(int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("Accept"));
return this->connection().asyncCall(callMessage, timeout);
}
/**
* Begins a call to the D-Bus method \c Hangup on the remote object.
*
* Request that the call is ended. All contents will be removed from the
* Call so that the Contents property will be the empty 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 reason
*
* A generic hangup reason.
*
* \param detailedHangupReason
*
* A more specific reason for the call hangup, if one is available, or
* an empty string otherwise.
*
* \param message
*
* A human-readable message to be sent to the remote contact(s). XMPP
* Jingle allows calls to be terminated with a human-readable message.
* \param timeout The timeout in milliseconds.
*/
inline QDBusPendingReply<> Hangup(uint reason, const QString& detailedHangupReason, 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("Hangup"));
callMessage << QVariant::fromValue(reason) << QVariant::fromValue(detailedHangupReason) << QVariant::fromValue(message);
return this->connection().asyncCall(callMessage, timeout);
}
/**
* Begins a call to the D-Bus method \c AddContent on the remote object.
*
* Request that a new Content of type Content_Type is added to the Call1.
* Handlers should check the value of the MutableContents property before
* trying to add another content as it might not be allowed.
*
* 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 contentName
*
* The suggested name of the content to add. The content name property
* should be meaningful, so should be given a name which is
* significant to the user. The name could be a localized
* "audio", "video" or perhaps include some string
* identifying the source, such as a webcam identifier. If there is
* already a content with the same name as this property then a
* sensible suffix should be added. For example, if this argument is
* "audio" but a content of the same name already exists, a
* sensible suffix such as " (1)" is appended to name the
* new content "audio (1)". A further content with the name
* "audio" would then be named "audio (2)".
*
* \param contentType
*
* The media stream type of the content to be added to the call.
*
* \param initialDirection
*
* The requested initial direction of the new content.
* \param timeout The timeout in milliseconds.
*
* \return
*
* Path to the newly-created Call1.Content object.
*/
inline QDBusPendingReply<QDBusObjectPath> AddContent(const QString& contentName, uint contentType, uint initialDirection, int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<QDBusObjectPath>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("AddContent"));
callMessage << QVariant::fromValue(contentName) << QVariant::fromValue(contentType) << QVariant::fromValue(initialDirection);
return this->connection().asyncCall(callMessage, timeout);
}
Q_SIGNALS:
/**
* Represents the signal \c ContentAdded on the remote object.
*
* \htmlonly
* <p>Emitted when a new \endhtmlonly CallContentInterface \htmlonly is added to the call.</p>
* \endhtmlonly
*
* \param content
*
* Path to the newly-created Content object.
*/
void ContentAdded(const QDBusObjectPath& content);
/**
* Represents the signal \c ContentRemoved on the remote object.
*
* \htmlonly
* <p>Emitted when a \endhtmlonly CallContentInterface \htmlonly is removed from the call.</p>
* \endhtmlonly
*
* \param content
*
* The Content which was removed.
*
* \param reason
*
* Why the content was removed.
*/
void ContentRemoved(const QDBusObjectPath& content, const Tp::CallStateReason& reason);
/**
* Represents the signal \c CallStateChanged on the remote object.
*
* \htmlonly
* <p>Emitted when the state of the call as a whole changes.</p>
*
* <p>This signal is emitted for any change in the properties
* corresponding to its arguments, even if the other properties
* referenced remain unchanged.</p>
* \endhtmlonly
*
* \param callState
*
* The new value of the CallState property.
*
* \param callFlags
*
* The new value of the CallFlags property.
*
* \param callStateReason
*
* The new value of the CallStateReason property.
*
* \param callStateDetails
*
* The new value of the CallStateDetails property.
*/
void CallStateChanged(uint callState, uint callFlags, const Tp::CallStateReason& callStateReason, const QVariantMap& callStateDetails);
/**
* Represents the signal \c CallMembersChanged on the remote object.
*
* Emitted when the CallMembers property changes in any way, either
* because contacts have been added to the call, contacts have been
* removed from the call, or contacts' flags have changed.
*
* \param flagsChanged
*
* A map from members of the call to their new call member flags,
* including at least the members who have been added to CallMembers,
* and the members whose flags have changed.
*
* \param identifiers
*
* \htmlonly
* The identifiers of the contacts in the <var>Flags_Changed</var> map.
* \endhtmlonly
*
* \param removed
*
* A list of members who have left the call, i.e. keys to be removed
* from CallMembers.
*
* \param reason
*
* A structured reason for the change.
*/
void CallMembersChanged(const Tp::CallMemberMap& flagsChanged, const Tp::HandleIdentifierMap& identifiers, const Tp::UIntList& removed, const Tp::CallStateReason& reason);
protected:
virtual void invalidate(Tp::DBusProxy *, const QString &, const QString &);
};
/**
* \class ChannelTypeContactListInterface
* \headerfile TelepathyQt/channel.h <TelepathyQt/Channel>
* \ingroup clientchannel
*
* Proxy class providing a 1:1 mapping of the D-Bus interface "org.freedesktop.Telepathy.Channel.Type.ContactList".
*/
class TP_QT_EXPORT ChannelTypeContactListInterface : public Tp::AbstractInterface
{
Q_OBJECT
public:
/**
* Returns the name of the interface "org.freedesktop.Telepathy.Channel.Type.ContactList", which this class
* represents.
*
* \return The D-Bus interface name.
*/
static inline QLatin1String staticInterfaceName()
{
return QLatin1String("org.freedesktop.Telepathy.Channel.Type.ContactList");
}
/**
* Creates a ChannelTypeContactListInterface 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.
*/
ChannelTypeContactListInterface(
const QString& busName,
const QString& objectPath,
QObject* parent = 0
);
/**
* Creates a ChannelTypeContactListInterface 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.
*/
ChannelTypeContactListInterface(
const QDBusConnection& connection,
const QString& busName,
const QString& objectPath,
QObject* parent = 0
);
/**
* Creates a ChannelTypeContactListInterface 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.
*/
ChannelTypeContactListInterface(Tp::DBusProxy *proxy);
/**
* Creates a ChannelTypeContactListInterface 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 ChannelTypeContactListInterface(const Tp::Client::ChannelInterface& mainInterface);
/**
* Creates a ChannelTypeContactListInterface 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.
*/
ChannelTypeContactListInterface(const Tp::Client::ChannelInterface& 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();
}
protected:
virtual void invalidate(Tp::DBusProxy *, const QString &, const QString &);
};
/**
* \class ChannelTypeContactSearchInterface
* \headerfile TelepathyQt/channel.h <TelepathyQt/Channel>
* \ingroup clientchannel
*
* Proxy class providing a 1:1 mapping of the D-Bus interface "org.freedesktop.Telepathy.Channel.Type.ContactSearch".
*/
class TP_QT_EXPORT ChannelTypeContactSearchInterface : public Tp::AbstractInterface
{
Q_OBJECT
public:
/**
* Returns the name of the interface "org.freedesktop.Telepathy.Channel.Type.ContactSearch", which this class
* represents.
*
* \return The D-Bus interface name.
*/
static inline QLatin1String staticInterfaceName()
{
return QLatin1String("org.freedesktop.Telepathy.Channel.Type.ContactSearch");
}
/**
* Creates a ChannelTypeContactSearchInterface 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.
*/
ChannelTypeContactSearchInterface(
const QString& busName,
const QString& objectPath,
QObject* parent = 0
);
/**
* Creates a ChannelTypeContactSearchInterface 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.
*/
ChannelTypeContactSearchInterface(
const QDBusConnection& connection,
const QString& busName,
const QString& objectPath,
QObject* parent = 0
);
/**
* Creates a ChannelTypeContactSearchInterface 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.
*/
ChannelTypeContactSearchInterface(Tp::DBusProxy *proxy);
/**
* Creates a ChannelTypeContactSearchInterface 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 ChannelTypeContactSearchInterface(const Tp::Client::ChannelInterface& mainInterface);
/**
* Creates a ChannelTypeContactSearchInterface 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.
*/
ChannelTypeContactSearchInterface(const Tp::Client::ChannelInterface& mainInterface, QObject* parent);
/**
* Asynchronous getter for the remote object property \c SearchState of type \c uint.
*
*
* The current state of this search channel object. Change notification is
* via SearchStateChanged.
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertySearchState() const
{
return internalRequestProperty(QLatin1String("SearchState"));
}
/**
* Asynchronous getter for the remote object property \c Limit of type \c uint.
*
*
* \htmlonly
* <p>If supported by the protocol, the maximum number of results that
* should be returned, where <code>0</code> represents no limit. If the
* protocol does not support limiting results, this should be
* <code>0</code>.</p>
*
* <p>For example, if the terms passed to
* \endhtmlonly Search() \htmlonly match <i>Antonius</i>,
* <i>Bridget</i> and <i>Charles</i> and this property is
* <code>2</code>, the search service SHOULD only return <i>Antonius</i>
* and <i>Bridget</i>.</p>
*
* <p>This property SHOULD be requestable if and only if the protocol
* supports specifying a limit; implementations SHOULD use
* <code>0</code> as the default if possible, or a protocol-specific
* sensible default otherwise.</p>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyLimit() const
{
return internalRequestProperty(QLatin1String("Limit"));
}
/**
* Asynchronous getter for the remote object property \c AvailableSearchKeys of type \c QStringList.
*
*
* The set of search keys supported by this channel. Example values
* include [""] (for protocols where several address fields are
* implicitly searched) or ["x-n-given", "x-n-family",
* "nickname", "email"] (for XMPP XEP-0055, without
* extensibility via Data Forms). It can be in the NewChannels signal for
* round-trip reduction.
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyAvailableSearchKeys() const
{
return internalRequestProperty(QLatin1String("AvailableSearchKeys"));
}
/**
* Asynchronous getter for the remote object property \c Server of type \c QString.
*
*
* For protocols which support searching for contacts on multiple servers
* with different DNS names (like XMPP), the DNS name of the server being
* searched by this channel, e.g. "characters.shakespeare.lit".
* Otherwise, the empty string. XEP 0055 defines a mechanism for XMPP
* clients to search services of their choice for contacts, such as
* users.jabber.org (the "Jabber User Directory"). This property
* SHOULD be requestable if and only if the protocol supports querying
* multiple different servers; implementations SHOULD use a sensible
* default if possible if this property is not specified in a channel
* request. This allows a client to perform searches on a protocol it
* knows nothing about without requiring the user to guess a valid
* server's hostname.
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyServer() const
{
return internalRequestProperty(QLatin1String("Server"));
}
/**
* 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 Search on the remote object.
*
* Send a request to start a search for contacts on this connection. This
* may only be called while the SearchState is Not_Started; a valid search
* request will cause the SearchStateChanged signal to be emitted with the
* state In_Progress.
*
* 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 terms
*
* A dictionary mapping search key names to the desired values
* \param timeout The timeout in milliseconds.
*/
inline QDBusPendingReply<> Search(const Tp::ContactSearchMap& terms, int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("Search"));
callMessage << QVariant::fromValue(terms);
return this->connection().asyncCall(callMessage, timeout);
}
/**
* Begins a call to the D-Bus method \c More on the remote object.
*
* \htmlonly
* Request that a search in \endhtmlonly \link requestPropertySearchState() SearchState \endlink \htmlonly
* <code>More_Available</code> move back to state <code>In_Progress</code>
* and continue listing up to \endhtmlonly \link requestPropertyLimit() Limit \endlink \htmlonly more results.
* \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<> More(int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("More"));
return this->connection().asyncCall(callMessage, timeout);
}
/**
* Begins a call to the D-Bus method \c Stop on the remote object.
*
* \htmlonly
* <p>Stop the current search. This may not be called while the
* \endhtmlonly \link requestPropertySearchState() SearchState \endlink \htmlonly is Not_Started. If called
* while the SearchState is In_Progress,
* \endhtmlonly SearchStateChanged() \htmlonly will be emitted,
* with the state Failed and the error
* <code>org.freedesktop.Telepathy.Error.<tp:error-ref>Cancelled</tp:error-ref></code>.</p>
*
* <p>Calling this method on a search in state Completed or Failed
* succeeds, but has no effect.</p>
*
* <div class="rationale">
* <p>Specifying Stop to succeed when the search has finished means that
* clients who call Stop just before receiving
* \endhtmlonly SearchStateChanged() \htmlonly don't have to
* handle a useless error.</p>
* </div>
*
* <p>Depending on the protocol, the connection manager may not be
* able to prevent the server from sending further results after this
* method returns; if this is the case, it MUST ignore any further
* results.</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<> Stop(int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("Stop"));
return this->connection().asyncCall(callMessage, timeout);
}
Q_SIGNALS:
/**
* Represents the signal \c SearchStateChanged on the remote object.
*
* \htmlonly
* <p>Emitted when the \endhtmlonly \link requestPropertySearchState() SearchState \endlink \htmlonly property
* changes. The implementation MUST NOT make transitions other than the
* following:</p>
*
* <ul>
* <li><code>Not_Started</code> → <code>In_Progress</code></li>
* <li><code>In_Progress</code> → <code>More_Available</code></li>
* <li><code>More_Available</code> → <code>In_Progress</code></li>
* <li><code>In_Progress</code> → <code>Completed</code></li>
* <li><code>In_Progress</code> → <code>Failed</code></li>
* </ul>
* \endhtmlonly
*
* \param state
*
* The new search state
*
* \param error
*
* \htmlonly
* If the new state is <code>Failed</code>, the name of a D-Bus error
* describing what went wrong. Otherwise, the empty string.
* \endhtmlonly
*
* \param details
*
* \htmlonly
* <p>Additional information about the state transition, 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>
* </dl>
*
* <div class="rationale">
* <p>This argument allows for future extensions. For instance,
* if moving to state <code>Failed</code> because the server
* rejected one of our search terms, we could define a key
* that indicates which terms were invalid.</p>
* </div>
* \endhtmlonly
*/
void SearchStateChanged(uint state, const QString& error, const QVariantMap& details);
/**
* Represents the signal \c SearchResultReceived on the remote object.
*
* Emitted when a some search results are received from the server. This
* signal can be fired arbitrarily many times so clients MUST NOT assume
* they'll get only one signal.
*
* \param result
*
* A mapping from contact identifier to an array of fields
* representing information about this contact.
*/
void SearchResultReceived(const Tp::ContactSearchResultMap& result);
protected:
virtual void invalidate(Tp::DBusProxy *, const QString &, const QString &);
};
/**
* \class ChannelTypeDBusTubeInterface
* \headerfile TelepathyQt/channel.h <TelepathyQt/Channel>
* \ingroup clientchannel
*
* Proxy class providing a 1:1 mapping of the D-Bus interface "org.freedesktop.Telepathy.Channel.Type.DBusTube".
*/
class TP_QT_EXPORT ChannelTypeDBusTubeInterface : public Tp::AbstractInterface
{
Q_OBJECT
public:
/**
* Returns the name of the interface "org.freedesktop.Telepathy.Channel.Type.DBusTube", which this class
* represents.
*
* \return The D-Bus interface name.
*/
static inline QLatin1String staticInterfaceName()
{
return QLatin1String("org.freedesktop.Telepathy.Channel.Type.DBusTube");
}
/**
* Creates a ChannelTypeDBusTubeInterface 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.
*/
ChannelTypeDBusTubeInterface(
const QString& busName,
const QString& objectPath,
QObject* parent = 0
);
/**
* Creates a ChannelTypeDBusTubeInterface 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.
*/
ChannelTypeDBusTubeInterface(
const QDBusConnection& connection,
const QString& busName,
const QString& objectPath,
QObject* parent = 0
);
/**
* Creates a ChannelTypeDBusTubeInterface 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.
*/
ChannelTypeDBusTubeInterface(Tp::DBusProxy *proxy);
/**
* Creates a ChannelTypeDBusTubeInterface 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 ChannelTypeDBusTubeInterface(const Tp::Client::ChannelInterface& mainInterface);
/**
* Creates a ChannelTypeDBusTubeInterface 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.
*/
ChannelTypeDBusTubeInterface(const Tp::Client::ChannelInterface& mainInterface, QObject* parent);
/**
* Asynchronous getter for the remote object property \c ServiceName of type \c QString.
*
*
* \htmlonly
* <p>A string representing the service name that will be used over the
* tube. It SHOULD be a well-known D-Bus service name, of the form
* <tt>com.example.ServiceName</tt>.</p>
* <p>When the tube is offered, the service name is transmitted to the
* other end.</p>
* <p>When requesting a channel with
* \endhtmlonly ConnectionInterfaceRequestsInterface::CreateChannel() \htmlonly ,
* this property MUST be included in the request.</p>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyServiceName() const
{
return internalRequestProperty(QLatin1String("ServiceName"));
}
/**
* Asynchronous getter for the remote object property \c DBusNames of type \c Tp::DBusTubeParticipants.
*
*
* For a multi-user (i.e. Handle_Type_Room) D-Bus tube, a mapping between
* contact handles and their unique bus names on this tube. For a
* peer-to-peer (i.e. Handle_Type_Contact) D-Bus tube, the empty
* dictionary. Change notification is via DBusNamesChanged.
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyDBusNames() const
{
return internalRequestProperty(QLatin1String("DBusNames"));
}
/**
* Asynchronous getter for the remote object property \c SupportedAccessControls of type \c Tp::UIntList.
*
*
* \htmlonly
* <p>A list of the access control types that are supported with this channel.
* Note that only Socket_Access_Control_Localhost and
* Socket_Access_Control_Credentials can be used with D-Bus tubes.
* Using Socket_Access_Control_Credentials is recommended.</p>
*
* <div class="rationale">
* <p>Socket_Access_Control_Credentials is easy to implement for a
* D-Bus tube, because typical D-Bus library implementations like
* libdbus and GDBus already have to support it to be able to
* connect to the system or session bus, and usually enable it
* by default; so there's typically no good reason to relax
* access control to Localhost.</p>
* </div>
*
* <p>When requesting a channel with
* \endhtmlonly ConnectionInterfaceRequestsInterface::CreateChannel() \htmlonly ,
* this property MUST NOT be included in the request.</p>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertySupportedAccessControls() const
{
return internalRequestProperty(QLatin1String("SupportedAccessControls"));
}
/**
* 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 Offer on the remote object.
*
* Offers a D-Bus tube providing the service specified.
*
* 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 parameters
*
* The dictionary of arbitrary Parameters to send with the tube offer.
*
* \param accesscontrol
*
* The access control the connection manager applies to the D-Bus
* socket.
* \param timeout The timeout in milliseconds.
*
* \return
*
* The string describing the address of the private bus. The client
* SHOULD NOT attempt to connect to the address until the tube is open.
*/
inline QDBusPendingReply<QString> Offer(const QVariantMap& parameters, uint accesscontrol, int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<QString>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("Offer"));
callMessage << QVariant::fromValue(parameters) << QVariant::fromValue(accesscontrol);
return this->connection().asyncCall(callMessage, timeout);
}
/**
* Begins a call to the D-Bus method \c Accept on the remote object.
*
* Accept a D-Bus tube that's in the "local pending" state.
* The connection manager will attempt to open the tube. The tube remains
* in the "local pending" state until the
* TubeChannelStateChanged signal is 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 accesscontrol
*
* The access control the connection manager applies to the D-Bus
* socket.
* \param timeout The timeout in milliseconds.
*
* \return
*
* The string describing the address of the private bus. The client
* SHOULD NOT attempt to connect to the address until the tube is open.
*/
inline QDBusPendingReply<QString> Accept(uint accesscontrol, int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<QString>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("Accept"));
callMessage << QVariant::fromValue(accesscontrol);
return this->connection().asyncCall(callMessage, timeout);
}
Q_SIGNALS:
/**
* Represents the signal \c DBusNamesChanged on the remote object.
*
* Emitted on a multi-user (i.e. Handle_Type_Room) D-Bus tube when a
* participant opens or closes the tube. This provides change notification
* for the DBusNames property.
*
* \param added
*
* Array of handles and D-Bus names of new participants.
*
* \param removed
*
* Array of handles of former participants.
*/
void DBusNamesChanged(const Tp::DBusTubeParticipants& added, const Tp::UIntList& removed);
protected:
virtual void invalidate(Tp::DBusProxy *, const QString &, const QString &);
};
/**
* \class ChannelTypeFileTransferInterface
* \headerfile TelepathyQt/channel.h <TelepathyQt/Channel>
* \ingroup clientchannel
*
* Proxy class providing a 1:1 mapping of the D-Bus interface "org.freedesktop.Telepathy.Channel.Type.FileTransfer".
*/
class TP_QT_EXPORT ChannelTypeFileTransferInterface : public Tp::AbstractInterface
{
Q_OBJECT
public:
/**
* Returns the name of the interface "org.freedesktop.Telepathy.Channel.Type.FileTransfer", which this class
* represents.
*
* \return The D-Bus interface name.
*/
static inline QLatin1String staticInterfaceName()
{
return QLatin1String("org.freedesktop.Telepathy.Channel.Type.FileTransfer");
}
/**
* Creates a ChannelTypeFileTransferInterface 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.
*/
ChannelTypeFileTransferInterface(
const QString& busName,
const QString& objectPath,
QObject* parent = 0
);
/**
* Creates a ChannelTypeFileTransferInterface 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.
*/
ChannelTypeFileTransferInterface(
const QDBusConnection& connection,
const QString& busName,
const QString& objectPath,
QObject* parent = 0
);
/**
* Creates a ChannelTypeFileTransferInterface 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.
*/
ChannelTypeFileTransferInterface(Tp::DBusProxy *proxy);
/**
* Creates a ChannelTypeFileTransferInterface 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 ChannelTypeFileTransferInterface(const Tp::Client::ChannelInterface& mainInterface);
/**
* Creates a ChannelTypeFileTransferInterface 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.
*/
ChannelTypeFileTransferInterface(const Tp::Client::ChannelInterface& mainInterface, QObject* parent);
/**
* Asynchronous getter for the remote object property \c State of type \c uint.
*
*
* \htmlonly
* <p>The state of the file transfer as described by the
* File_Transfer_State enum.</p>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyState() const
{
return internalRequestProperty(QLatin1String("State"));
}
/**
* Asynchronous getter for the remote object property \c ContentType of type \c QString.
*
*
* \htmlonly
* <p>The file's MIME type. This cannot change once the channel has
* been created.</p>
*
* <p>This property is mandatory when requesting the channel with the
* \endhtmlonly ConnectionInterfaceRequestsInterface::CreateChannel() \htmlonly
* method. Protocols which do not have a content-type property with file
* transfers should set this value to application/octet-stream.</p>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyContentType() const
{
return internalRequestProperty(QLatin1String("ContentType"));
}
/**
* Asynchronous getter for the remote object property \c Filename of type \c QString.
*
*
* \htmlonly
* <p>The name of the file on the sender's side. This is therefore given
* as a suggested filename for the receiver. This cannot change
* once the channel has been created.</p>
*
* <p>This property should be the basename of the file being sent. For example,
* if the sender sends the file /home/user/monkey.pdf then this property should
* be set to monkey.pdf.</p>
*
* <p>This property is mandatory when requesting the channel with the
* \endhtmlonly ConnectionInterfaceRequestsInterface::CreateChannel() \htmlonly
* method. This property cannot be empty and MUST be set to a sensible value.</p>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyFilename() const
{
return internalRequestProperty(QLatin1String("Filename"));
}
/**
* Asynchronous getter for the remote object property \c Size of type \c qulonglong.
*
*
* \htmlonly
* <p>The size of the file. If this property is set, then the file
* transfer is guaranteed to be this size. This cannot change once
* the channel has been created.</p>
*
* <p>When you are creating a channel with this property, its value
* MUST be accurate and in bytes. However, when receiving a file, this
* property still MUST be in bytes but might not be entirely accurate
* to the byte.</p>
*
* <p>This property is mandatory when requesting the channel with the
* \endhtmlonly ConnectionInterfaceRequestsInterface::CreateChannel() \htmlonly
* method. If this information isn't provided in the protocol, connection managers MUST set it
* to UINT64_MAX.</p>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertySize() const
{
return internalRequestProperty(QLatin1String("Size"));
}
/**
* Asynchronous getter for the remote object property \c ContentHashType of type \c uint.
*
*
* \htmlonly
* <p>The type of the \endhtmlonly \link requestPropertyContentHash() ContentHash \endlink \htmlonly property.</p>
*
* <p>This property is optional when requesting the channel with the
* \endhtmlonly ConnectionInterfaceRequestsInterface::CreateChannel() \htmlonly
* method. However, if you wish to include the \endhtmlonly \link requestPropertyContentHash() ContentHash \endlink \htmlonly
* property you MUST also include this property. If you omit this property from a
* \endhtmlonly ConnectionInterfaceRequestsInterface::CreateChannel() \htmlonly
* method call then its value will be assumed to be File_Hash_Type_None.</p>
*
* <p>For each supported hash type, implementations SHOULD include an entry
* in \endhtmlonly \link ConnectionInterfaceRequestsInterface::requestPropertyRequestableChannelClasses() ConnectionInterfaceRequestsInterface::RequestableChannelClasses \endlink \htmlonly
* with this property fixed to that hash type. If the protocol supports
* offering a file without a content hash, implementations SHOULD list
* this property in Allowed in a requestable channel class, mapping hash
* types they don't understand to None.
* </p>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyContentHashType() const
{
return internalRequestProperty(QLatin1String("ContentHashType"));
}
/**
* Asynchronous getter for the remote object property \c ContentHash of type \c QString.
*
*
* \htmlonly
* <p>Hash of the contents of the file transfer, of type described
* in the value of the \endhtmlonly \link requestPropertyContentHashType() ContentHashType \endlink \htmlonly
* property.</p>
*
* <p>This property is optional when requesting the channel with the
* \endhtmlonly ConnectionInterfaceRequestsInterface::CreateChannel() \htmlonly
* method. Its value MUST correspond to the appropriate type of the
* \endhtmlonly \link requestPropertyContentHashType() ContentHashType \endlink \htmlonly property. If the
* ContentHashType property is not set, or set to File_Hash_Type_None,
* then this property will not even be looked at.</p>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyContentHash() const
{
return internalRequestProperty(QLatin1String("ContentHash"));
}
/**
* Asynchronous getter for the remote object property \c Description of type \c QString.
*
*
* \htmlonly
* <p>Description of the file transfer. This cannot change once the
* channel has been created.</p>
*
* <p>This property is optional when requesting the channel with the
* \endhtmlonly ConnectionInterfaceRequestsInterface::CreateChannel() \htmlonly
* method. If this property was not provided by the remote party, connection managers MUST set it to
* the empty string.</p>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyDescription() const
{
return internalRequestProperty(QLatin1String("Description"));
}
/**
* Asynchronous getter for the remote object property \c Date of type \c qlonglong.
*
*
* \htmlonly
* <p>The last modification time of the file being transferred. This
* cannot change once the channel has been created</p>
*
* <p>This property is optional when requesting the channel with the
* \endhtmlonly ConnectionInterfaceRequestsInterface::CreateChannel() \htmlonly
* method.</p>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyDate() const
{
return internalRequestProperty(QLatin1String("Date"));
}
/**
* Asynchronous getter for the remote object property \c AvailableSocketTypes of type \c Tp::SupportedSocketMap.
*
*
* \htmlonly
* <p>A mapping from address types (members of Socket_Address_Type) to
* arrays of access-control type (members of Socket_Access_Control)
* that the connection manager supports for sockets with that
* address type. For simplicity, if a CM supports offering a
* particular type of file transfer, it is assumed to support accepting
* it. Connection Managers MUST support at least Socket_Address_Type_IPv4.</p>
*
* <p>A typical value for a host without IPv6 support:</p>
*
* <pre>
* {
* Socket_Address_Type_IPv4:
* [Socket_Access_Control_Localhost, Socket_Access_Control_Port,
* Socket_Access_Control_Netmask],
* Socket_Address_Type_Unix:
* [Socket_Access_Control_Localhost, Socket_Access_Control_Credentials]
* }
* </pre>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyAvailableSocketTypes() const
{
return internalRequestProperty(QLatin1String("AvailableSocketTypes"));
}
/**
* Asynchronous getter for the remote object property \c TransferredBytes of type \c qulonglong.
*
*
* \htmlonly
* <p>The number of bytes that have been transferred at the time of
* requesting the property. This will be updated as the file transfer
* continues.</p>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyTransferredBytes() const
{
return internalRequestProperty(QLatin1String("TransferredBytes"));
}
/**
* Asynchronous getter for the remote object property \c InitialOffset of type \c qulonglong.
*
*
* \htmlonly
* <p>The offset in bytes from where the file should be sent. This MUST
* be respected by both the receiver and the sender after the state
* becomes Open, but before any data is sent or received. Until the
* \endhtmlonly InitialOffsetDefined() \htmlonly signal
* is emitted, this property is undefined.</p>
*
* <p>Before setting the \endhtmlonly \link requestPropertyState() State \endlink \htmlonly property to
* Open, the connection manager MUST set the InitialOffset property,
* possibly to 0.</p>
*
* <p>This property MUST NOT change after the state of the transfer has
* changed to Open.</p>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyInitialOffset() const
{
return internalRequestProperty(QLatin1String("InitialOffset"));
}
/**
* Asynchronous getter for the remote object property \c URI of type \c QString.
*
*
* \htmlonly
* <p>For outgoing file transfers, this requestable property allows the channel
* requester to inform observers (and the handler, if it is not the requester
* itself) of the URI of the file being transferred. Note that the
* connection manager SHOULD NOT read this file directly; the handler
* streams the file into the CM through the socket negotiated using
* \endhtmlonly ProvideFile() \htmlonly .</p>
*
* <p>On outgoing file transfers, this property MUST NOT change after the channel
* is requested.</p>
*
* <p>For incoming file transfers, this property MAY be set by the channel
* handler before calling \endhtmlonly AcceptFile() \htmlonly to
* inform observers where the incoming file will be saved. If set by an
* approver, the handler MUST save the file to that location.
* Setting this property once \endhtmlonly AcceptFile() \htmlonly
* has been called MUST fail. Once this property has been set
* \endhtmlonly URIDefined() \htmlonly is emitted.</p>
*
* <p>If set, this URI SHOULD generally point to a file on the local system, as
* defined by <a href="http://www.apps.ietf.org/rfc/rfc1738.html#sec-3.10">
* RFC 1738 §3.10</a>; that is, it should be of the form
* <tt>file:///path/to/file</tt> or <tt>file://localhost/path/to/file</tt>.
* For outgoing files, this URI MAY use a different scheme, such as
* <tt>http:</tt>, if a remote resource is being transferred
* to a contact.</p>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyURI() const
{
return internalRequestProperty(QLatin1String("URI"));
}
/**
* Asynchronous setter for the remote object property \c URI of type \c QString.
*
*
* \htmlonly
* <p>For outgoing file transfers, this requestable property allows the channel
* requester to inform observers (and the handler, if it is not the requester
* itself) of the URI of the file being transferred. Note that the
* connection manager SHOULD NOT read this file directly; the handler
* streams the file into the CM through the socket negotiated using
* \endhtmlonly ProvideFile() \htmlonly .</p>
*
* <p>On outgoing file transfers, this property MUST NOT change after the channel
* is requested.</p>
*
* <p>For incoming file transfers, this property MAY be set by the channel
* handler before calling \endhtmlonly AcceptFile() \htmlonly to
* inform observers where the incoming file will be saved. If set by an
* approver, the handler MUST save the file to that location.
* Setting this property once \endhtmlonly AcceptFile() \htmlonly
* has been called MUST fail. Once this property has been set
* \endhtmlonly URIDefined() \htmlonly is emitted.</p>
*
* <p>If set, this URI SHOULD generally point to a file on the local system, as
* defined by <a href="http://www.apps.ietf.org/rfc/rfc1738.html#sec-3.10">
* RFC 1738 §3.10</a>; that is, it should be of the form
* <tt>file:///path/to/file</tt> or <tt>file://localhost/path/to/file</tt>.
* For outgoing files, this URI MAY use a different scheme, such as
* <tt>http:</tt>, if a remote resource is being transferred
* to a contact.</p>
* \endhtmlonly
*
* \return A pending operation which will emit finished when the property has been
* set.
*/
inline Tp::PendingOperation *setPropertyURI(QString newValue)
{
return internalSetProperty(QLatin1String("URI"), QVariant::fromValue(newValue));
}
/**
* Asynchronous getter for the remote object property \c FileCollection of type \c QString.
*
*
* \htmlonly
* <p>The collection of files to which this channel belongs,
* or the empty string if this channel does not belong to
* a collection of files.</p>
*
* <p>A channel's FileCollection property can never change.</p>
*
* <p>At least on GTalk and apparently also on iChat the user can
* send a set of files to a contact and that contact can then
* pick and choose which files to actually receive.</p>
*
* <p> The CM should emit all new FT channels belonging to one collection
* at the same time. UIs supporting this feature can then
* bundle all these channels together in some way, and show a
* nice UI. UIs not supporting it will treat them as separate
* transfers, which is not great but a reasonable fallback.</p>
*
* <p>No mechanism is currently defined to indicate whether the UI
* should expect any more files in the same collection. UIs
* SHOULD assume that more file transfers may be added to a
* collection. It is possible that a "no more channels in this
* collection" indication will be added in a future version of
* this specification.</p>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyFileCollection() const
{
return internalRequestProperty(QLatin1String("FileCollection"));
}
/**
* 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 AcceptFile on the remote object.
*
* Accept a file transfer that's in the Pending state. The file
* transfer's state becomes Accepted after this method is called. At
* this point the client can connect to the socket. CM MUST emit
* InitialOffsetDefined and change the state to Open before writing to the
* socket. Then InitialOffset should be respected in case its value
* differs from the offset that was specified as an argument to AcceptFile.
*
* 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 addressType
*
* The type of address the connection manager should listen on.
*
* \param accessControl
*
* The type of access control the connection manager should apply to
* the socket.
*
* \param accessControlParam
*
* A parameter for the access control type, to be interpreted as
* specified in the documentation for the Socket_Access_Control enum.
*
* \param offset
*
* The desired offset in bytes where the file transfer should start.
* The offset is taken from the beginning of the file. Specifying an
* offset of zero will start the transfer from the beginning of the
* file. The offset that is actually given in the InitialOffset
* property can differ from this argument where the requested offset
* is not supported. (For example, some protocols do not support
* offsets at all so the InitialOffset property will always be 0.)
* \param timeout The timeout in milliseconds.
*
* \return
*
* The address on which the connection manager will listen for
* connections for this file transfer.
*/
inline QDBusPendingReply<QDBusVariant> AcceptFile(uint addressType, uint accessControl, const QDBusVariant& accessControlParam, qulonglong offset, int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<QDBusVariant>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("AcceptFile"));
callMessage << QVariant::fromValue(addressType) << QVariant::fromValue(accessControl) << QVariant::fromValue(accessControlParam) << QVariant::fromValue(offset);
return this->connection().asyncCall(callMessage, timeout);
}
/**
* Begins a call to the D-Bus method \c ProvideFile on the remote object.
*
* Provide the file for an outgoing file transfer which has been offered.
* Opens a socket that the client can use to provide a file to the
* connection manager. The channel MUST have been requested, and will
* change state to Open when this method is called if its state was
* Accepted.
*
* 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 addressType
*
* The type of address the connection manager should listen on.
*
* \param accessControl
*
* The type of access control the connection manager should apply to
* the socket.
*
* \param accessControlParam
*
* A parameter for the access control type, to be interpreted as
* specified in the documentation for the Socket_Access_Control enum.
* \param timeout The timeout in milliseconds.
*
* \return
*
* The address on which the connection manager will listen for
* connections for this file transfer.
*/
inline QDBusPendingReply<QDBusVariant> ProvideFile(uint addressType, uint accessControl, const QDBusVariant& accessControlParam, int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<QDBusVariant>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("ProvideFile"));
callMessage << QVariant::fromValue(addressType) << QVariant::fromValue(accessControl) << QVariant::fromValue(accessControlParam);
return this->connection().asyncCall(callMessage, timeout);
}
Q_SIGNALS:
/**
* Represents the signal \c FileTransferStateChanged on the remote object.
*
* Emitted when the state of a file transfer changes.
*
* \param state
*
* The new state of the file transfer; see the File_Transfer_State
* enumeration.
*
* \param reason
*
* The reason for the state change; see the
* File_Transfer_State_Change_Reason enumeration. The value will
* always be File_Transfer_State_Change_Reason_None, except when
* changing state to cancelled.
*/
void FileTransferStateChanged(uint state, uint reason);
/**
* Represents the signal \c TransferredBytesChanged on the remote object.
*
* Emitted when the number of transferred bytes changes. This will not be
* signalled with every single byte change. Instead, the most frequent
* this signal will be emitted is once a second. This should be
* sufficient, and the TransferredBytes property SHOULD NOT be polled.
*
* \param count
*
* The number of already transferred bytes.
*/
void TransferredBytesChanged(qulonglong count);
/**
* Represents the signal \c InitialOffsetDefined on the remote object.
*
* Emitted when the value of the InitialOffset property has been
* negotiated. This signal MUST be emitted before the channel becomes Open
* and clients have to use this offset when transferring the file.
*
* \param initialOffset
*
* The value of the InitialOffset property.
*/
void InitialOffsetDefined(qulonglong initialOffset);
/**
* Represents the signal \c URIDefined on the remote object.
*
* Emitted when the value of the URI property has been set. This signal
* MUST only be emitted on incoming file transfers, and only if the
* handler sets the URI property before accepting the file.
*
* \param URI
*
* The value of the URI property.
*/
void URIDefined(const QString& URI);
protected:
virtual void invalidate(Tp::DBusProxy *, const QString &, const QString &);
};
/**
* \class ChannelTypeRoomListInterface
* \headerfile TelepathyQt/channel.h <TelepathyQt/Channel>
* \ingroup clientchannel
*
* Proxy class providing a 1:1 mapping of the D-Bus interface "org.freedesktop.Telepathy.Channel.Type.RoomList".
*/
class TP_QT_EXPORT ChannelTypeRoomListInterface : public Tp::AbstractInterface
{
Q_OBJECT
public:
/**
* Returns the name of the interface "org.freedesktop.Telepathy.Channel.Type.RoomList", which this class
* represents.
*
* \return The D-Bus interface name.
*/
static inline QLatin1String staticInterfaceName()
{
return QLatin1String("org.freedesktop.Telepathy.Channel.Type.RoomList");
}
/**
* Creates a ChannelTypeRoomListInterface 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.
*/
ChannelTypeRoomListInterface(
const QString& busName,
const QString& objectPath,
QObject* parent = 0
);
/**
* Creates a ChannelTypeRoomListInterface 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.
*/
ChannelTypeRoomListInterface(
const QDBusConnection& connection,
const QString& busName,
const QString& objectPath,
QObject* parent = 0
);
/**
* Creates a ChannelTypeRoomListInterface 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.
*/
ChannelTypeRoomListInterface(Tp::DBusProxy *proxy);
/**
* Creates a ChannelTypeRoomListInterface 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 ChannelTypeRoomListInterface(const Tp::Client::ChannelInterface& mainInterface);
/**
* Creates a ChannelTypeRoomListInterface 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.
*/
ChannelTypeRoomListInterface(const Tp::Client::ChannelInterface& mainInterface, QObject* parent);
/**
* Asynchronous getter for the remote object property \c Server of type \c QString.
*
*
* For protocols with a concept of chatrooms on multiple servers with
* different DNS names (like XMPP), the DNS name of the server whose rooms
* are listed by this channel, e.g. "conference.jabber.org".
* Otherwise, the empty string. This property cannot change during the
* lifetime of the channel.
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyServer() const
{
return internalRequestProperty(QLatin1String("Server"));
}
/**
* 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 GetListingRooms on the remote object.
*
* Check to see if there is already a room list request in progress on
* this channel.
*
* 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 boolean indicating if room listing is in progress
*/
inline QDBusPendingReply<bool> GetListingRooms(int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<bool>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("GetListingRooms"));
return this->connection().asyncCall(callMessage, timeout);
}
/**
* Begins a call to the D-Bus method \c ListRooms on the remote object.
*
* Request the list of rooms from the server. The ListingRooms (True)
* signal should be emitted when this request is being processed, GotRooms
* when any room information is received, and ListingRooms (False) when
* the request is complete.
*
* 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<> ListRooms(int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("ListRooms"));
return this->connection().asyncCall(callMessage, timeout);
}
/**
* Begins a call to the D-Bus method \c StopListing on the remote object.
*
* Stop the room listing if it's in progress, but don't close
* the channel. The ListingRooms (False) signal should be emitted when the
* listing stops.
*
* 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<> StopListing(int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("StopListing"));
return this->connection().asyncCall(callMessage, timeout);
}
Q_SIGNALS:
/**
* Represents the signal \c GotRooms on the remote object.
*
* \htmlonly
* <p>Emitted when information about rooms on the server becomes available.
* The array contains the room handle (as can be passed to the
* \endhtmlonly ConnectionInterface::RequestChannel() \htmlonly
* method with HANDLE_TYPE_ROOM), the channel
* type, and a dictionary containing further information about the
* room as available. The following well-known keys and types are
* recommended for use where appropriate:</p>
*
* <dl>
* <dt>handle-name (s)</dt>
* <dd>The identifier of the room (as would be returned by
* \endhtmlonly ConnectionInterface::InspectHandles() \htmlonly ).
* This property is mandatory.</dd>
*
* <dt>name (s)</dt>
* <dd>The human-readable name of the room if different from the handle</dd>
*
* <dt>description (s)</dt>
* <dd>A description of the room's overall purpose</dd>
*
* <dt>subject (s)</dt>
* <dd>The current subject of conversation in the room (as would
* be returned by getting the string part of the \endhtmlonly \link ChannelInterfaceSubjectInterface::requestPropertySubject() ChannelInterfaceSubjectInterface::Subject \endlink \htmlonly property)</dd>
*
* <dt>members (u)</dt>
* <dd>The number of members in the room</dd>
*
* <dt>password (b)</dt>
* <dd>True if the room requires a password to enter</dd>
*
* <dt>invite-only (b)</dt>
* <dd>True if you cannot join the room, but must be invited</dd>
*
* <dt>room-id (s)</dt>
* <dd>The human-readable identifier of a chat room (as would be
* returned by getting the \endhtmlonly \link ChannelInterfaceRoomInterface::requestPropertyRoomName() ChannelInterfaceRoomInterface::RoomName \endlink \htmlonly property)</dd>
*
* <dt>server (s)</dt>
* <dd>The DNS name of the server hosting these channels (as would be
* returned by getting the \endhtmlonly \link ChannelInterfaceRoomInterface::requestPropertyServer() ChannelInterfaceRoomInterface::Server \endlink \htmlonly property)</dd>
* </dl>
* \endhtmlonly
*
* \param rooms
*
* \htmlonly
* An array of structs containing:
* <ul>
* <li>an integer room handle</li>
* <li>a string representing the D-Bus interface name of the channel type</li>
* <li>a dictionary mapping string keys to variant boxed information</li>
* </ul>
* \endhtmlonly
*/
void GotRooms(const Tp::RoomInfoList& rooms);
/**
* Represents the signal \c ListingRooms on the remote object.
*
* Emitted to indicate whether or not room listing request is currently in
* progress.
*
* \param listing
*
* A boolean indicating if room listing is in progress
*/
void ListingRooms(bool listing);
protected:
virtual void invalidate(Tp::DBusProxy *, const QString &, const QString &);
};
/**
* \class ChannelTypeServerAuthenticationInterface
* \headerfile TelepathyQt/channel.h <TelepathyQt/Channel>
* \ingroup clientchannel
*
* Proxy class providing a 1:1 mapping of the D-Bus interface "org.freedesktop.Telepathy.Channel.Type.ServerAuthentication".
*/
class TP_QT_EXPORT ChannelTypeServerAuthenticationInterface : public Tp::AbstractInterface
{
Q_OBJECT
public:
/**
* Returns the name of the interface "org.freedesktop.Telepathy.Channel.Type.ServerAuthentication", which this class
* represents.
*
* \return The D-Bus interface name.
*/
static inline QLatin1String staticInterfaceName()
{
return QLatin1String("org.freedesktop.Telepathy.Channel.Type.ServerAuthentication");
}
/**
* Creates a ChannelTypeServerAuthenticationInterface 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.
*/
ChannelTypeServerAuthenticationInterface(
const QString& busName,
const QString& objectPath,
QObject* parent = 0
);
/**
* Creates a ChannelTypeServerAuthenticationInterface 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.
*/
ChannelTypeServerAuthenticationInterface(
const QDBusConnection& connection,
const QString& busName,
const QString& objectPath,
QObject* parent = 0
);
/**
* Creates a ChannelTypeServerAuthenticationInterface 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.
*/
ChannelTypeServerAuthenticationInterface(Tp::DBusProxy *proxy);
/**
* Creates a ChannelTypeServerAuthenticationInterface 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 ChannelTypeServerAuthenticationInterface(const Tp::Client::ChannelInterface& mainInterface);
/**
* Creates a ChannelTypeServerAuthenticationInterface 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.
*/
ChannelTypeServerAuthenticationInterface(const Tp::Client::ChannelInterface& mainInterface, QObject* parent);
/**
* Asynchronous getter for the remote object property \c AuthenticationMethod of type \c QString.
*
*
* \htmlonly
* <p>This property defines the method used for the authentication step
* represented by this channel, which MUST be one of this channel's
* \endhtmlonly \link ChannelInterface::requestPropertyInterfaces() ChannelInterface::Interfaces \endlink \htmlonly .</p>
*
* <p>The initially-defined interface that can be used here is
* \endhtmlonly ChannelInterfaceSASLAuthenticationInterface \htmlonly .</p>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyAuthenticationMethod() const
{
return internalRequestProperty(QLatin1String("AuthenticationMethod"));
}
/**
* 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();
}
protected:
virtual void invalidate(Tp::DBusProxy *, const QString &, const QString &);
};
/**
* \class ChannelTypeServerTLSConnectionInterface
* \headerfile TelepathyQt/channel.h <TelepathyQt/Channel>
* \ingroup clientchannel
*
* Proxy class providing a 1:1 mapping of the D-Bus interface "org.freedesktop.Telepathy.Channel.Type.ServerTLSConnection".
*/
class TP_QT_EXPORT ChannelTypeServerTLSConnectionInterface : public Tp::AbstractInterface
{
Q_OBJECT
public:
/**
* Returns the name of the interface "org.freedesktop.Telepathy.Channel.Type.ServerTLSConnection", which this class
* represents.
*
* \return The D-Bus interface name.
*/
static inline QLatin1String staticInterfaceName()
{
return QLatin1String("org.freedesktop.Telepathy.Channel.Type.ServerTLSConnection");
}
/**
* Creates a ChannelTypeServerTLSConnectionInterface 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.
*/
ChannelTypeServerTLSConnectionInterface(
const QString& busName,
const QString& objectPath,
QObject* parent = 0
);
/**
* Creates a ChannelTypeServerTLSConnectionInterface 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.
*/
ChannelTypeServerTLSConnectionInterface(
const QDBusConnection& connection,
const QString& busName,
const QString& objectPath,
QObject* parent = 0
);
/**
* Creates a ChannelTypeServerTLSConnectionInterface 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.
*/
ChannelTypeServerTLSConnectionInterface(Tp::DBusProxy *proxy);
/**
* Creates a ChannelTypeServerTLSConnectionInterface 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 ChannelTypeServerTLSConnectionInterface(const Tp::Client::ChannelInterface& mainInterface);
/**
* Creates a ChannelTypeServerTLSConnectionInterface 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.
*/
ChannelTypeServerTLSConnectionInterface(const Tp::Client::ChannelInterface& mainInterface, QObject* parent);
/**
* Asynchronous getter for the remote object property \c ServerCertificate of type \c QDBusObjectPath.
*
*
* A TLSCertificate containing the certificate chain as sent by the
* server, and other relevant information.
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyServerCertificate() const
{
return internalRequestProperty(QLatin1String("ServerCertificate"));
}
/**
* Asynchronous getter for the remote object property \c Hostname of type \c QString.
*
*
* The hostname or domain that the user expects to connect to. Clients
* SHOULD use the ReferenceIdentities property to verify the identity of
* the certificate. Clients MAY display this hostname to the user as the
* expected identity. Clients SHOULD use this property to lookup pinned
* certificates or other user preferences for the connection.
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyHostname() const
{
return internalRequestProperty(QLatin1String("Hostname"));
}
/**
* Asynchronous getter for the remote object property \c ReferenceIdentities of type \c QStringList.
*
*
* The identities of the server we expect ServerCertificate to certify;
* clients SHOULD verify that ServerCertificate matches one of these
* identities when checking its validity. This property MUST NOT be the
* empty list; it MUST contain the value of the Hostname property. All
* other identities included in this property MUST be derived from
* explicit user input or choices, such as Parameters passed to
* RequestConnection. The primary use for this property is for XMPP
* services hosted by Google Apps. When connecting to Google Talk using an
* @gmail.com JID, the server correctly presents a certificate for
* gmail.com; however, for domains hosted via Google Apps, a certificate
* for talk.google.com is offered, due to unresolved technical
* limitations. If the user has explicitly chosen to create a Google Talk
* account, then trusting a certificate for talk.google.com is reasonable.
* To handle this case, the connection manager may add the values of any
* or all of the server, fallback-server and extra-identities parameters;
* the Google Talk account creation user interface may set these
* parameters appropriately, or the user may set them for accounts with
* other services.
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyReferenceIdentities() const
{
return internalRequestProperty(QLatin1String("ReferenceIdentities"));
}
/**
* 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();
}
protected:
virtual void invalidate(Tp::DBusProxy *, const QString &, const QString &);
};
/**
* \class ChannelTypeStreamTubeInterface
* \headerfile TelepathyQt/channel.h <TelepathyQt/Channel>
* \ingroup clientchannel
*
* Proxy class providing a 1:1 mapping of the D-Bus interface "org.freedesktop.Telepathy.Channel.Type.StreamTube".
*/
class TP_QT_EXPORT ChannelTypeStreamTubeInterface : public Tp::AbstractInterface
{
Q_OBJECT
public:
/**
* Returns the name of the interface "org.freedesktop.Telepathy.Channel.Type.StreamTube", which this class
* represents.
*
* \return The D-Bus interface name.
*/
static inline QLatin1String staticInterfaceName()
{
return QLatin1String("org.freedesktop.Telepathy.Channel.Type.StreamTube");
}
/**
* Creates a ChannelTypeStreamTubeInterface 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.
*/
ChannelTypeStreamTubeInterface(
const QString& busName,
const QString& objectPath,
QObject* parent = 0
);
/**
* Creates a ChannelTypeStreamTubeInterface 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.
*/
ChannelTypeStreamTubeInterface(
const QDBusConnection& connection,
const QString& busName,
const QString& objectPath,
QObject* parent = 0
);
/**
* Creates a ChannelTypeStreamTubeInterface 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.
*/
ChannelTypeStreamTubeInterface(Tp::DBusProxy *proxy);
/**
* Creates a ChannelTypeStreamTubeInterface 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 ChannelTypeStreamTubeInterface(const Tp::Client::ChannelInterface& mainInterface);
/**
* Creates a ChannelTypeStreamTubeInterface 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.
*/
ChannelTypeStreamTubeInterface(const Tp::Client::ChannelInterface& mainInterface, QObject* parent);
/**
* Asynchronous getter for the remote object property \c Service of type \c QString.
*
*
* \htmlonly
* <p> A string representing the service name that will be used over the
* tube. It should be a well-known TCP service name as defined by
* <a href="http://www.iana.org/assignments/port-numbers">
* http://www.iana.org/assignments/port-numbers</a> or
* <a href="http://www.dns-sd.org/ServiceTypes.html">
* http://www.dns-sd.org/ServiceTypes.html</a>, for instance
* "rsync" or "daap".</p>
* <p>When the tube is offered, the service name is transmitted to the
* other end.</p>
* <p>When requesting a channel with
* \endhtmlonly ConnectionInterfaceRequestsInterface::CreateChannel() \htmlonly ,
* this property MUST be included in the request.</p>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyService() const
{
return internalRequestProperty(QLatin1String("Service"));
}
/**
* Asynchronous getter for the remote object property \c SupportedSocketTypes of type \c Tp::SupportedSocketMap.
*
*
* \htmlonly
* <p>A mapping from address types (members of Socket_Address_Type) to
* arrays of access-control type (members of Socket_Access_Control)
* that the connection manager supports for stream tubes with that
* address type. For simplicity, if a CM supports offering a
* particular type of tube, it is assumed to support accepting it.</p>
*
* <p>A typical value for a host without IPv6 support:</p>
*
* <pre>
* {
* Socket_Address_Type_IPv4:
* [Socket_Access_Control_Localhost, Socket_Access_Control_Port,
* Socket_Access_Control_Netmask],
* Socket_Address_Type_Unix:
* [Socket_Access_Control_Localhost, Socket_Access_Control_Credentials]
* }
* </pre>
*
* <p>Connection Managers MUST support at least IPv4 with the localhost
* access control.</p>
*
* <p>When requesting a channel with
* \endhtmlonly ConnectionInterfaceRequestsInterface::CreateChannel() \htmlonly ,
* this property MUST NOT be included in the request.</p>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertySupportedSocketTypes() const
{
return internalRequestProperty(QLatin1String("SupportedSocketTypes"));
}
/**
* 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 Offer on the remote object.
*
* Offer a stream tube exporting the local socket specified.
*
* 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 addresstype
*
* The type of the listening address of the local service, as a member
* of Socket_Address_Type.
*
* \param address
*
* The listening address of the local service, as indicated by the
* address_type.
*
* \param accesscontrol
*
* The access control the local service applies to the local socket,
* specified so the connection manager can behave appropriately when
* it connects.
*
* \param parameters
*
* The dictionary of arbitrary Parameters to send with the tube offer.
* \param timeout The timeout in milliseconds.
*/
inline QDBusPendingReply<> Offer(uint addresstype, const QDBusVariant& address, uint accesscontrol, 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("Offer"));
callMessage << QVariant::fromValue(addresstype) << QVariant::fromValue(address) << QVariant::fromValue(accesscontrol) << QVariant::fromValue(parameters);
return this->connection().asyncCall(callMessage, timeout);
}
/**
* Begins a call to the D-Bus method \c Accept on the remote object.
*
* Accept a stream tube that's in the "local pending"
* state. The connection manager will attempt to open the tube. The tube
* remains in the "local pending" state until the
* TubeChannelStateChanged signal is 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 addresstype
*
* The type of address the connection manager should listen on.
*
* \param accesscontrol
*
* \htmlonly
* <p>The type of access control the connection manager should apply to
* the socket.</p>
*
* <p>Note that if you plan to establish more than one connection
* through the tube, the Socket_Access_Control_Port access control
* can't be used as you can't connect more than once from the same
* port.</p>
* \endhtmlonly
*
* \param accesscontrolparam
*
* A parameter for the access control type, to be interpreted as
* specified in the documentation for the Socket_Access_Control enum.
* \param timeout The timeout in milliseconds.
*
* \return
*
* The address on which the connection manager will listen for
* connections to this tube. The client should not attempt to connect
* to the address until the tube is open.
*/
inline QDBusPendingReply<QDBusVariant> Accept(uint addresstype, uint accesscontrol, const QDBusVariant& accesscontrolparam, int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<QDBusVariant>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("Accept"));
callMessage << QVariant::fromValue(addresstype) << QVariant::fromValue(accesscontrol) << QVariant::fromValue(accesscontrolparam);
return this->connection().asyncCall(callMessage, timeout);
}
Q_SIGNALS:
/**
* Represents the signal \c NewRemoteConnection on the remote object.
*
* \htmlonly
* <p>Emitted each time a participant opens a new connection to its
* socket.</p>
*
* <p>This signal is only fired on the offering side.</p>
* \endhtmlonly
*
* \param handle
*
* The handle of the participant who opened the new connection
*
* \param connectionParam
*
* \htmlonly
* <p>A parameter which can be used by the listening process to identify
* the connection. Note that this parameter has a meaningful value
* only in the Socket_Access_Control_Port and
* Socket_Access_Control_Credentials cases. If a different
* Socket_Access_Control has been chosen when offering the tube, this
* parameter should be ignored.</p>
*
* <p>In the Socket_Access_Control_Port case, the variant
* contains a struct Socket_Address_IPv4 (or Socket_Address_IPv6)
* containing the address from which the CM is connected to the client
* application.</p>
*
* <p>In the Socket_Access_Control_Credentials case, the variant
* contains the byte (D-Bus signature 'y') that has been sent with
* the credentials.</p>
* \endhtmlonly
*
* \param connectionID
*
* The unique ID associated with this connection. This ID will be used
* to identifiy the connection when reporting errors with
* ConnectionClosed.
*/
void NewRemoteConnection(uint handle, const QDBusVariant& connectionParam, uint connectionID);
/**
* Represents the signal \c NewLocalConnection on the remote object.
*
* \htmlonly
* <p>Emitted when the tube application connects to the CM's socket.</p>
*
* <p>This signal is only fired on the accepting side.</p>
* \endhtmlonly
*
* \param connectionID
*
* The unique ID associated with this connection. This ID will be used
* to identifiy the connection when reporting errors with
* ConnectionClosed.
*/
void NewLocalConnection(uint connectionID);
/**
* Represents the signal \c ConnectionClosed on the remote object.
*
* \htmlonly
* <p>Emitted when a connection has been closed.</p>
* \endhtmlonly
*
* \param connectionID
*
* The ID of the connection.
*
* \param error
*
* \htmlonly
* <p>The name of a D-Bus error describing the error that occurred.</p>
*
* <p>The following errors can be used:</p>
* <ul>
* <li><code>org.freedesktop.Telepathy.Error.Cancelled</code>:
* user closed the socket or the tube.</li>
* <li><code>org.freedesktop.Telepathy.Error.ConnectionLost</code>:
* the bytestream relaying connection's data has been broken.</li>
* <li><code>org.freedesktop.Telepathy.Error.ConnectionRefused</code>:
* the tube offer refused the connection.</li>
* </ul>
* \endhtmlonly
*
* \param message
*
* A debug message.
*/
void ConnectionClosed(uint connectionID, const QString& error, const QString& message);
protected:
virtual void invalidate(Tp::DBusProxy *, const QString &, const QString &);
};
/**
* \class ChannelTypeStreamedMediaInterface
* \headerfile TelepathyQt/channel.h <TelepathyQt/Channel>
* \ingroup clientchannel
*
* Proxy class providing a 1:1 mapping of the D-Bus interface "org.freedesktop.Telepathy.Channel.Type.StreamedMedia".
*/
class TP_QT_EXPORT ChannelTypeStreamedMediaInterface : public Tp::AbstractInterface
{
Q_OBJECT
public:
/**
* Returns the name of the interface "org.freedesktop.Telepathy.Channel.Type.StreamedMedia", which this class
* represents.
*
* \return The D-Bus interface name.
*/
static inline QLatin1String staticInterfaceName()
{
return QLatin1String("org.freedesktop.Telepathy.Channel.Type.StreamedMedia");
}
/**
* Creates a ChannelTypeStreamedMediaInterface 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.
*/
ChannelTypeStreamedMediaInterface(
const QString& busName,
const QString& objectPath,
QObject* parent = 0
);
/**
* Creates a ChannelTypeStreamedMediaInterface 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.
*/
ChannelTypeStreamedMediaInterface(
const QDBusConnection& connection,
const QString& busName,
const QString& objectPath,
QObject* parent = 0
);
/**
* Creates a ChannelTypeStreamedMediaInterface 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.
*/
ChannelTypeStreamedMediaInterface(Tp::DBusProxy *proxy);
/**
* Creates a ChannelTypeStreamedMediaInterface 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 ChannelTypeStreamedMediaInterface(const Tp::Client::ChannelInterface& mainInterface);
/**
* Creates a ChannelTypeStreamedMediaInterface 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.
*/
ChannelTypeStreamedMediaInterface(const Tp::Client::ChannelInterface& mainInterface, QObject* parent);
/**
* Asynchronous getter for the remote object property \c InitialAudio of type \c bool.
*
*
* \htmlonly
* <p>If set to true in a channel request that will create a new channel,
* the connection manager should immediately attempt to establish an
* audio stream to the remote contact, making it unnecessary for the
* client to call \endhtmlonly ChannelTypeStreamedMediaInterface::RequestStreams() \htmlonly .</p>
*
* <p>If this property, or InitialVideo, is passed to EnsureChannel
* (as opposed to CreateChannel), the connection manager SHOULD ignore
* these properties when checking whether it can return an existing
* channel as suitable; these properties only become significant when
* the connection manager has decided to create a new channel.</p>
*
* <p>If true on a requested channel, this indicates that the audio
* stream has already been requested and the client does not need to
* call RequestStreams, although it MAY still do so.</p>
*
* <p>If true on an unrequested (incoming) channel, this indicates that
* the remote contact initially requested an audio stream; this does
* not imply that that audio stream is still active (as indicated by
* \endhtmlonly ChannelTypeStreamedMediaInterface::ListStreams() \htmlonly ).</p>
*
* <p>This property is immutable (cannot change), and therefore SHOULD
* appear wherever immutable properties are reported, e.g. \endhtmlonly ConnectionInterfaceRequestsInterface::NewChannels() \htmlonly
* signals.</p>
*
* <div class="rationale"><p>This reduces D-Bus round trips.</p></div>
*
* <p>Connection managers capable of signalling audio calls to contacts
* SHOULD include a channel class in \endhtmlonly \link ConnectionInterfaceRequestsInterface::requestPropertyRequestableChannelClasses() ConnectionInterfaceRequestsInterface::RequestableChannelClasses \endlink \htmlonly
* with \endhtmlonly \link ChannelInterface::requestPropertyChannelType() ChannelInterface::ChannelType \endlink \htmlonly
* = \endhtmlonly ChannelTypeStreamedMediaInterface \htmlonly
* and \endhtmlonly \link ChannelInterface::requestPropertyTargetHandleType() ChannelInterface::TargetHandleType \endlink \htmlonly
* = Contact in the fixed properties dictionary, and InitialAudio
* (and also InitialVideo, if applicable) in the allowed properties
* list. Clients wishing to discover whether a connection manager
* can signal audio and/or video calls SHOULD use this information.</p>
*
* <div class="rationale">
* <p>Not all protocols support signalling video calls, and it would be
* possible (although unlikely) to have a protocol where only video,
* and not audio, could be signalled.</p>
* </div>
*
* <p>Connection managers that support the \endhtmlonly ConnectionInterfaceContactCapabilitiesInterface \htmlonly
* interface SHOULD represent the capabilities of receiving audio
* and/or video calls by including a channel class in
* a contact's capabilities with ChannelType = StreamedMedia
* in the fixed properties dictionary, and InitialAudio and/or
* InitialVideo in the allowed properties list. Clients wishing to
* discover whether a particular contact is likely to be able to
* receive audio and/or video calls SHOULD use this information.</p>
*
* <div class="rationale">
* <p>Not all clients support video calls, and it would also be
* possible (although unlikely) to have a client which could only
* stream video, not audio.</p>
* </div>
*
* <p>Clients that are willing to receive audio and/or video calls
* SHOULD include the following among their channel classes if
* calling \endhtmlonly ConnectionInterfaceContactCapabilitiesInterface::UpdateCapabilities() \htmlonly
* (clients of a \endhtmlonly ChannelDispatcherInterface \htmlonly
* SHOULD instead arrange for the ChannelDispatcher to do this,
* by including the filters in their \endhtmlonly \link ClientHandlerInterface::requestPropertyHandlerChannelFilter() ClientHandlerInterface::HandlerChannelFilter \endlink \htmlonly
* properties):</p>
*
* <ul>
* <li>{ ChannelType = StreamedMedia }</li>
* <li>{ ChannelType = StreamedMedia, InitialAudio = true }
* if receiving calls with audio is supported</li>
* <li>{ ChannelType = StreamedMedia, InitialVideo = true }
* if receiving calls with video is supported</li>
* </ul>
*
* <div class="rationale">
* <p>Connection managers for protocols with capability discovery,
* like XMPP, need this information to advertise the appropriate
* capabilities for their protocol.</p>
* </div>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyInitialAudio() const
{
return internalRequestProperty(QLatin1String("InitialAudio"));
}
/**
* Asynchronous getter for the remote object property \c InitialVideo of type \c bool.
*
*
* \htmlonly
* <p>The same as \endhtmlonly \link requestPropertyInitialAudio() InitialAudio \endlink \htmlonly , but for
* a video stream. This property is immutable (cannot change).</p>
*
* <p>In particular, note that if this property is false, this does not
* imply that an active video stream has not been added, only that no
* video stream was active at the time the channel appeared.</p>
*
* <p>This property is the correct way to discover whether connection
* managers, contacts etc. support video calls; it appears in
* capabilities structures in the same way as InitialAudio.</p>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyInitialVideo() const
{
return internalRequestProperty(QLatin1String("InitialVideo"));
}
/**
* Asynchronous getter for the remote object property \c ImmutableStreams of type \c bool.
*
*
* \htmlonly
* <p>If <tt>True</tt>, once streams have been requested for this channel
* (either by setting \endhtmlonly \link requestPropertyInitialAudio() InitialAudio \endlink \htmlonly or
* \endhtmlonly \link requestPropertyInitialVideo() InitialVideo \endlink \htmlonly when the channel is
* requested, or by calling
* \endhtmlonly RequestStreams() \htmlonly on a channel with no
* streams), a stream of a different content type cannot be added;
* subsequent calls to \endhtmlonly RequestStreams() \htmlonly
* that attempt to do so will fail.</p>
*
* <p>If this property is missing, clients SHOULD assume that it is false,
* and thus that the channel's streams can be changed once the call has
* started.</p>
*
* <p>If this property is present in the "allowed" set in all of the
* StreamedMedia entries in a contact's capabilities, then user
* interfaces MAY choose to show a separate "call" option for each
* class of call.</p>
*
* <div class="rationale">
* <p>For example, once an audio-only Google Talk call has started,
* it is not possible to add a video stream; both audio and video
* must be requested at the start of the call if video is desired.
* User interfaces may use this pseudo-capability as a hint to
* display separate "Audio call" and "Video call" buttons, rather
* than a single "Call" button with the option to add and remove
* video once the call has started for contacts without this flag.
* </p>
* </div>
*
* <p>This property is immutable, and therefore SHOULD be announced
* in \endhtmlonly ConnectionInterfaceRequestsInterface::NewChannels() \htmlonly ,
* etc.</p>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyImmutableStreams() const
{
return internalRequestProperty(QLatin1String("ImmutableStreams"));
}
/**
* 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 ListStreams on the remote object.
*
* Returns an array of structs representing the streams currently active
* within this channel. Each stream is identified by an unsigned integer
* which is unique for each stream within the channel.
*
* 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
*
* \htmlonly
* An array of structs containing:
* <ul>
* <li>the stream identifier</li>
* <li>the contact handle who the stream is with (or 0 if the stream
* represents more than a single member)</li>
* <li>the type of the stream</li>
* <li>the current stream state</li>
* <li>the current direction of the stream</li>
* <li>the current pending send flags</li>
* </ul>
* \endhtmlonly
*/
inline QDBusPendingReply<Tp::MediaStreamInfoList> ListStreams(int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<Tp::MediaStreamInfoList>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("ListStreams"));
return this->connection().asyncCall(callMessage, timeout);
}
/**
* Begins a call to the D-Bus method \c RemoveStreams on the remote object.
*
* \htmlonly
* <p>Request that the given streams are removed. If all streams are
* removed, the channel MAY close.</p>
*
* <p>Clients SHOULD NOT attempt to terminate calls by removing all the
* streams; instead, clients SHOULD terminate calls by removing the
* \endhtmlonly \link ChannelInterfaceGroupInterface::requestPropertySelfHandle() ChannelInterfaceGroupInterface::SelfHandle \endlink \htmlonly
* from the channel, using either
* \endhtmlonly ChannelInterfaceGroupInterface::RemoveMembers() \htmlonly
* or
* \endhtmlonly ChannelInterfaceGroupInterface::RemoveMembersWithReason() \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 streams
*
* An array of stream identifiers (as defined in ListStreams)
* \param timeout The timeout in milliseconds.
*/
inline QDBusPendingReply<> RemoveStreams(const Tp::UIntList& streams, int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("RemoveStreams"));
callMessage << QVariant::fromValue(streams);
return this->connection().asyncCall(callMessage, timeout);
}
/**
* Begins a call to the D-Bus method \c RequestStreamDirection on the remote object.
*
* \htmlonly
* <p>Request a change in the direction of an existing stream. In particular,
* this might be useful to stop sending media of a particular type,
* or inform the peer that you are no longer using media that is being
* sent to you.</p>
*
* <p>Depending on the protocol, streams which are no longer sending in
* either direction should be removed and a
* \endhtmlonly StreamRemoved() \htmlonly signal emitted.
* Some direction changes can be enforced locally (for example,
* BIDIRECTIONAL -> RECEIVE can be achieved by merely stopping sending),
* others may not be possible on some protocols, and some need agreement
* from the remote end. In this case, the MEDIA_STREAM_PENDING_REMOTE_SEND
* flag will be set in the
* \endhtmlonly StreamDirectionChanged() \htmlonly signal, and the
* signal
* emitted again without the flag to indicate the resulting direction when
* the remote end has accepted or rejected the change.</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 streamID
*
* The stream identifier (as defined in ListStreams)
*
* \param streamDirection
*
* The desired stream direction (a value of MediaStreamDirection)
* \param timeout The timeout in milliseconds.
*/
inline QDBusPendingReply<> RequestStreamDirection(uint streamID, uint streamDirection, int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("RequestStreamDirection"));
callMessage << QVariant::fromValue(streamID) << QVariant::fromValue(streamDirection);
return this->connection().asyncCall(callMessage, timeout);
}
/**
* Begins a call to the D-Bus method \c RequestStreams on the remote object.
*
* \htmlonly
* <p>Request that streams be established to exchange the given types of
* media with the given member. In general this will try and establish a
* bidirectional stream, but on some protocols it may not be possible to
* indicate to the peer that you would like to receive media, so a
* send-only stream will be created initially. In the cases where the
* stream requires remote agreement (eg you wish to receive media from
* them), the \endhtmlonly StreamDirectionChanged() \htmlonly signal
* will be emitted with the
* MEDIA_STREAM_PENDING_REMOTE_SEND flag set, and the signal emitted again
* with the flag cleared when the remote end has replied.</p>
*
* <p>If streams of the requested types already exist, calling this
* method results in the creation of additional streams. Accordingly,
* clients wishing to have exactly one audio stream or exactly one
* video stream SHOULD check for the current streams using
* \endhtmlonly ListStreams() \htmlonly before calling this
* 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 contactHandle
*
* A contact handle with whom to establish the streams
*
* \param types
*
* An array of stream types (values of MediaStreamType)
* \param timeout The timeout in milliseconds.
*
* \return
*
* \htmlonly
* An array of structs (in the same order as the given stream types)
* containing:
* <ul>
* <li>the stream identifier</li>
* <li>the contact handle who the stream is with (or 0 if the stream
* represents more than a single member)</li>
* <li>the type of the stream</li>
* <li>the current stream state</li>
* <li>the current direction of the stream</li>
* <li>the current pending send flags</li>
* </ul>
* \endhtmlonly
*/
inline QDBusPendingReply<Tp::MediaStreamInfoList> RequestStreams(uint contactHandle, const Tp::UIntList& types, int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<Tp::MediaStreamInfoList>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("RequestStreams"));
callMessage << QVariant::fromValue(contactHandle) << QVariant::fromValue(types);
return this->connection().asyncCall(callMessage, timeout);
}
Q_SIGNALS:
/**
* Represents the signal \c StreamAdded on the remote object.
*
* \htmlonly
* <p>Emitted when a new stream has been added to this channel.
* Clients SHOULD assume that the stream's
* <tp:type>Media_Stream_State</tp:type> is initially Disconnected.</p>
*
* <p>If a connection manager needs to represent the addition of a stream
* whose state is already Connecting or Connected, it MUST do this
* by emitting StreamAdded, closely followed by
* \endhtmlonly StreamStateChanged() \htmlonly indicating a
* change to the appropriate state.</p>
*
* <div class="rationale">
* <p>Historically, it was not clear from the StreamAdded signal what
* the state of the stream was. telepathy-spec 0.17.22
* clarified this.</p>
* </div>
*
* <p>Similarly, clients SHOULD assume that the initial
* <tp:type>Media_Stream_Direction</tp:type> of a newly added stream
* is Receive, and that the initial
* <tp:type>Media_Stream_Pending_Send</tp:type> is
* Pending_Local_Send.</p>
*
* <p>If a connection manager needs to represent the addition of a stream
* whose direction or pending-send differs from those initial values,
* it MUST do so by emitting StreamAdded, closely followed by
* \endhtmlonly StreamDirectionChanged() \htmlonly indicating a
* change to the appropriate direction and pending-send state.</p>
*
* <div class="rationale">
* <p>StreamAdded doesn't itself indicate the stream's direction; this
* is unfortunate, but is preserved for compatibility.</p>
*
* <p>This is the appropriate direction for streams added by a remote
* contact on existing connection managers, and does not violate
* user privacy by automatically sending audio or video (audio streams
* start off muted, video streams start off not sending). For
* streams added by the local user using the client receiving the
* signal, the true direction can also be determined from the return
* value of the \endhtmlonly RequestStreams() \htmlonly
* method.</p>
*
* <p>Existing clients typically operate by maintaining a separate
* idea of the directions that they would like the streams to have,
* and enforcing these intended directions by calling
* \endhtmlonly RequestStreamDirection() \htmlonly whenever
* needed.</p>
* </div>
* \endhtmlonly
*
* \param streamID
*
* The stream identifier (as defined in ListStreams)
*
* \param contactHandle
*
* The contact handle who the stream is with (or 0 if it represents
* more than a single member)
*
* \param streamType
*
* The stream type (a value from MediaStreamType)
*/
void StreamAdded(uint streamID, uint contactHandle, uint streamType);
/**
* Represents the signal \c StreamDirectionChanged on the remote object.
*
* \htmlonly
* <p>Emitted when the direction or pending flags of a stream are
* changed.</p>
*
* <p>If the MEDIA_STREAM_PENDING_LOCAL_SEND flag is set, the remote user
* has requested that we begin sending on this stream.
* \endhtmlonly RequestStreamDirection() \htmlonly
* should be called to indicate whether or not this change is
* acceptable.</p>
*
* <div class="rationale">
* <p>This allows for a MSN-style user interface, "Fred has asked you
* to enable your webcam. (Accept | Reject)", if desired.</p>
* </div>
* \endhtmlonly
*
* \param streamID
*
* The stream identifier (as defined in ListStreams)
*
* \param streamDirection
*
* The new stream direction (as defined in ListStreams)
*
* \param pendingFlags
*
* The new pending send flags (as defined in ListStreams)
*/
void StreamDirectionChanged(uint streamID, uint streamDirection, uint pendingFlags);
/**
* Represents the signal \c StreamError on the remote object.
*
* Emitted when a stream encounters an error.
*
* \param streamID
*
* The stream identifier (as defined in ListStreams)
*
* \param errorCode
*
* A stream error number, one of the values of MediaStreamError
*
* \param message
*
* A string describing the error (for debugging purposes only)
*/
void StreamError(uint streamID, uint errorCode, const QString& message);
/**
* Represents the signal \c StreamRemoved on the remote object.
*
* Emitted when a stream has been removed from this channel.
*
* \param streamID
*
* stream_id - the stream identifier (as defined in ListStreams)
*/
void StreamRemoved(uint streamID);
/**
* Represents the signal \c StreamStateChanged on the remote object.
*
* Emitted when a member's stream's state changes.
*
* \param streamID
*
* The stream identifier (as defined in ListStreams)
*
* \param streamState
*
* The new stream state (as defined in ListStreams)
*/
void StreamStateChanged(uint streamID, uint streamState);
protected:
virtual void invalidate(Tp::DBusProxy *, const QString &, const QString &);
};
/**
* \class ChannelTypeTextInterface
* \headerfile TelepathyQt/channel.h <TelepathyQt/Channel>
* \ingroup clientchannel
*
* Proxy class providing a 1:1 mapping of the D-Bus interface "org.freedesktop.Telepathy.Channel.Type.Text".
*/
class TP_QT_EXPORT ChannelTypeTextInterface : public Tp::AbstractInterface
{
Q_OBJECT
public:
/**
* Returns the name of the interface "org.freedesktop.Telepathy.Channel.Type.Text", which this class
* represents.
*
* \return The D-Bus interface name.
*/
static inline QLatin1String staticInterfaceName()
{
return QLatin1String("org.freedesktop.Telepathy.Channel.Type.Text");
}
/**
* Creates a ChannelTypeTextInterface 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.
*/
ChannelTypeTextInterface(
const QString& busName,
const QString& objectPath,
QObject* parent = 0
);
/**
* Creates a ChannelTypeTextInterface 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.
*/
ChannelTypeTextInterface(
const QDBusConnection& connection,
const QString& busName,
const QString& objectPath,
QObject* parent = 0
);
/**
* Creates a ChannelTypeTextInterface 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.
*/
ChannelTypeTextInterface(Tp::DBusProxy *proxy);
/**
* Creates a ChannelTypeTextInterface 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 ChannelTypeTextInterface(const Tp::Client::ChannelInterface& mainInterface);
/**
* Creates a ChannelTypeTextInterface 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.
*/
ChannelTypeTextInterface(const Tp::Client::ChannelInterface& 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 AcknowledgePendingMessages on the remote object.
*
* Inform the channel that you have handled messages by displaying them to
* the user (or equivalent), so they can be removed from the pending queue.
*
* 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 IDs
*
* The IDs of the messages to acknowledge
* \param timeout The timeout in milliseconds.
*/
inline QDBusPendingReply<> AcknowledgePendingMessages(const Tp::UIntList& IDs, int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("AcknowledgePendingMessages"));
callMessage << QVariant::fromValue(IDs);
return this->connection().asyncCall(callMessage, timeout);
}
/**
* Begins a call to the D-Bus method \c GetMessageTypes on the remote object.
*
* Return an array indicating which types of message may be sent on this
* channel.
*
* 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 integer message types (ChannelTextMessageType)
*/
inline QDBusPendingReply<Tp::UIntList> GetMessageTypes(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("GetMessageTypes"));
return this->connection().asyncCall(callMessage, timeout);
}
/**
* Begins a call to the D-Bus method \c ListPendingMessages on the remote object.
*
* List the messages currently in the pending queue, and optionally remove
* then all.
*
* 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 clear
*
* If true, behave as if AcknowledgePendingMessages had also been
* called.
* \param timeout The timeout in milliseconds.
*
* \return
*
* \htmlonly
* An array of structs representing the pending queue. Each contains:
* <ul>
* <li>a numeric identifier</li>
* <li>a Unix timestamp indicating when the message was received</li>
* <li>the contact handle for the contact who sent the message</li>
* <li>the message type, taken from ChannelTextMessageType</li>
* <li>the bitwise-OR of the message flags from ChannelTextMessageFlags</li>
* <li>the text of the message</li>
* </ul>
* \endhtmlonly
*/
inline QDBusPendingReply<Tp::PendingTextMessageList> ListPendingMessages(bool clear, int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<Tp::PendingTextMessageList>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("ListPendingMessages"));
callMessage << QVariant::fromValue(clear);
return this->connection().asyncCall(callMessage, timeout);
}
/**
* Begins a call to the D-Bus method \c Send on the remote object.
*
* \htmlonly
* <p>Request that a message be sent on this channel. When the message has
* been submitted for delivery, this method will return and the
* \endhtmlonly Sent() \htmlonly signal will be emitted. If the
* message cannot be submitted for delivery, the method returns an error
* and no signal is emitted.</p>
*
* <p>This method SHOULD return before the Sent signal is
* emitted.</p>
*
* <div class="rationale">
* <p>When a Text channel implements the \endhtmlonly ChannelInterfaceMessagesInterface \htmlonly
* interface, that "SHOULD" becomes a "MUST".</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 type
*
* An integer indicating the type of the message
*
* \param text
*
* The message to send
* \param timeout The timeout in milliseconds.
*/
inline QDBusPendingReply<> Send(uint type, const QString& text, int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("Send"));
callMessage << QVariant::fromValue(type) << QVariant::fromValue(text);
return this->connection().asyncCall(callMessage, timeout);
}
Q_SIGNALS:
/**
* Represents the signal \c LostMessage on the remote object.
*
* This signal is emitted to indicate that an incoming message was not
* able to be stored and forwarded by the connection manager due to lack
* of memory.
*/
void LostMessage();
/**
* Represents the signal \c Received on the remote object.
*
* Signals that a message with the given id, timestamp, sender, type and
* text has been received on this channel. Applications that catch this
* signal and reliably inform the user of the message should acknowledge
* that they have dealt with the message with the
* AcknowledgePendingMessages method.
*
* \param ID
*
* A numeric identifier for acknowledging the message
*
* \param timestamp
*
* A Unix timestamp indicating when the message was received
*
* \param sender
*
* The handle of the contact who sent the message
*
* \param type
*
* The type of the message (normal, action, notice, etc.)
*
* \param flags
*
* A bitwise OR of the message flags
*
* \param text
*
* The text of the message
*/
void Received(uint ID, uint timestamp, uint sender, uint type, uint flags, const QString& text);
/**
* Represents the signal \c SendError on the remote object.
*
* \htmlonly
* <p>Signals that an outgoing message has failed to send. The error
* will be one of the values from ChannelTextSendError.</p>
*
* <p>This signal should only be emitted for messages for which
* \endhtmlonly Sent() \htmlonly has already been emitted and
* \endhtmlonly Send() \htmlonly has already returned success.</p>
* \endhtmlonly
*
* \param error
*
* The error that occurred
*
* \param timestamp
*
* The Unix timestamp indicating when the message was sent
*
* \param type
*
* The message type
*
* \param text
*
* The text of the message
*/
void SendError(uint error, uint timestamp, uint type, const QString& text);
/**
* Represents the signal \c Sent on the remote object.
*
* \htmlonly
* <p>Signals that a message has been submitted for sending.</p>
* \endhtmlonly
*
* \param timestamp
*
* Unix timestamp indicating when the message was sent
*
* \param type
*
* The message type (normal, action, notice, etc) from
* ChannelTextMessageType
*
* \param text
*
* The text of the message. If the message was, or will be, altered
* during transmission, this argument SHOULD reflect what other
* contacts will receive rather than being a copy of the argument to
* Send.
*/
void Sent(uint timestamp, uint type, const QString& text);
protected:
virtual void invalidate(Tp::DBusProxy *, const QString &, const QString &);
};
/**
* \class ChannelTypeTubesInterface
* \headerfile TelepathyQt/channel.h <TelepathyQt/Channel>
* \ingroup clientchannel
*
* Proxy class providing a 1:1 mapping of the D-Bus interface "org.freedesktop.Telepathy.Channel.Type.Tubes".
*/
class TP_QT_EXPORT ChannelTypeTubesInterface : public Tp::AbstractInterface
{
Q_OBJECT
public:
/**
* Returns the name of the interface "org.freedesktop.Telepathy.Channel.Type.Tubes", which this class
* represents.
*
* \return The D-Bus interface name.
*/
static inline QLatin1String staticInterfaceName()
{
return QLatin1String("org.freedesktop.Telepathy.Channel.Type.Tubes");
}
/**
* Creates a ChannelTypeTubesInterface 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.
*/
ChannelTypeTubesInterface(
const QString& busName,
const QString& objectPath,
QObject* parent = 0
);
/**
* Creates a ChannelTypeTubesInterface 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.
*/
ChannelTypeTubesInterface(
const QDBusConnection& connection,
const QString& busName,
const QString& objectPath,
QObject* parent = 0
);
/**
* Creates a ChannelTypeTubesInterface 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.
*/
ChannelTypeTubesInterface(Tp::DBusProxy *proxy);
/**
* Creates a ChannelTypeTubesInterface 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 ChannelTypeTubesInterface(const Tp::Client::ChannelInterface& mainInterface);
/**
* Creates a ChannelTypeTubesInterface 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.
*/
ChannelTypeTubesInterface(const Tp::Client::ChannelInterface& 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 GetAvailableStreamTubeTypes on the remote object.
*
* List the available address types and access-control types for stream
* tubes.
*
* 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
*
* \htmlonly
* <p>A mapping from address types (members of Socket_Address_Type) to
* arrays of access-control type (members of Socket_Access_Control)
* that the connection manager supports for stream tubes with that
* address type. For simplicity, if a CM supports offering a
* particular type of tube, it is assumed to support accepting it.</p>
*
* <p>A typical value for a host without IPv6 support:</p>
*
* <pre>
* {
* Socket_Address_Type_IPv4:
* [Socket_Access_Control_Localhost, Socket_Access_Control_Port,
* Socket_Access_Control_Netmask],
* Socket_Address_Type_Unix:
* [Socket_Access_Control_Localhost, Socket_Access_Control_Credentials]
* }
* </pre>
*
* <p>If stream tubes are not supported, this will be an empty
* dictionary.</p>
* \endhtmlonly
*/
inline QDBusPendingReply<Tp::SupportedSocketMap> GetAvailableStreamTubeTypes(int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<Tp::SupportedSocketMap>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("GetAvailableStreamTubeTypes"));
return this->connection().asyncCall(callMessage, timeout);
}
/**
* Begins a call to the D-Bus method \c GetAvailableTubeTypes on the remote 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.
*
* \return
*
* An array of the available tube types, as defined by the Tube_Type
* enum.
*/
inline QDBusPendingReply<Tp::UIntList> GetAvailableTubeTypes(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("GetAvailableTubeTypes"));
return this->connection().asyncCall(callMessage, timeout);
}
/**
* Begins a call to the D-Bus method \c ListTubes on the remote 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.
*
* \return
*
* Return an array of tuples, each representing a tube, with the
* following members: the tube's ID the tube's initiator the
* tube's type the tube's service the tube's parameters
* the tube's state
*/
inline QDBusPendingReply<Tp::TubeInfoList> ListTubes(int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<Tp::TubeInfoList>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("ListTubes"));
return this->connection().asyncCall(callMessage, timeout);
}
/**
* Begins a call to the D-Bus method \c OfferDBusTube on the remote object.
*
* Offers a D-Bus tube providing the service specified.
*
* 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 service
*
* A string representing the service name that will be used over the
* tube. It should be a well-known D-Bus service name, of the form
* com.example.ServiceName.
*
* \param parameters
*
* A dictionary of properties for the new tube; the allowable keys,
* types and values are defined by the service. Connection managers
* must support the value being any primitive (non-container) D-Bus
* type, or a byte array 'ay'.
* \param timeout The timeout in milliseconds.
*
* \return
*
* The ID of the new tube.
*/
inline QDBusPendingReply<uint> OfferDBusTube(const QString& service, const QVariantMap& parameters, int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<uint>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("OfferDBusTube"));
callMessage << QVariant::fromValue(service) << QVariant::fromValue(parameters);
return this->connection().asyncCall(callMessage, timeout);
}
/**
* Begins a call to the D-Bus method \c OfferStreamTube on the remote object.
*
* Offer a stream tube exporting the local socket specified.
*
* 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 service
*
* \htmlonly
* A string representing the service name that will be used over the
* tube.
* It should be a well-known TCP service name as defined by
* <a href="http://www.iana.org/assignments/port-numbers">
* http://www.iana.org/assignments/port-numbers</a> or
* <a href="http://www.dns-sd.org/ServiceTypes.html">
* http://www.dns-sd.org/ServiceTypes.html</a>, for instance
* "rsync" or "daap".
* \endhtmlonly
*
* \param parameters
*
* \htmlonly
* <p>A dictionary of properties for the new tube; the allowable keys,
* types and values are defined by the service. Connection managers
* must support the value being any primitive (non-container)
* D-Bus type, or a byte array 'ay'.</p>
* <p>These should usually be the same key-value pairs specified for
* use in the DNS-SD TXT record for that service.</p>
* \endhtmlonly
*
* \param addressType
*
* The type of the listening address of the local service, as a member
* of Socket_Address_Type.
*
* \param address
*
* The listening address of the local service, as indicated by the
* address_type.
*
* \param accessControl
*
* The access control the local service applies to the local socket,
* specified so the connection manager can behave appropriately when
* it connects.
*
* \param accessControlParam
*
* A parameter for the access control type, to be interpreted as
* specified in the documentation for the Socket_Access_Control enum.
* \param timeout The timeout in milliseconds.
*
* \return
*
* The ID of the new tube.
*/
inline QDBusPendingReply<uint> OfferStreamTube(const QString& service, const QVariantMap& parameters, uint addressType, const QDBusVariant& address, uint accessControl, const QDBusVariant& accessControlParam, int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<uint>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("OfferStreamTube"));
callMessage << QVariant::fromValue(service) << QVariant::fromValue(parameters) << QVariant::fromValue(addressType) << QVariant::fromValue(address) << QVariant::fromValue(accessControl) << QVariant::fromValue(accessControlParam);
return this->connection().asyncCall(callMessage, timeout);
}
/**
* Begins a call to the D-Bus method \c AcceptDBusTube on the remote object.
*
* Accept a D-Bus tube that's in the "local pending" state.
* The connection manager will attempt to open the tube. The tube remains
* in the "local pending" state until the TubeStateChanged
* signal is 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 ID
*
* The ID of the tube to accept.
* \param timeout The timeout in milliseconds.
*
* \return
*
* The string describing the address of the private bus. The client
* should not attempt to connect to the address until the tube is open.
*/
inline QDBusPendingReply<QString> AcceptDBusTube(uint ID, int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<QString>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("AcceptDBusTube"));
callMessage << QVariant::fromValue(ID);
return this->connection().asyncCall(callMessage, timeout);
}
/**
* Begins a call to the D-Bus method \c AcceptStreamTube on the remote object.
*
* Accept a stream tube that's in the "local pending"
* state. The connection manager will attempt to open the tube. The tube
* remains in the "local pending" state until the
* TubeStateChanged signal is 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 ID
*
* The ID of the tube to accept.
*
* \param addressType
*
* The type of address the connection manager should listen on.
*
* \param accessControl
*
* The type of access control the connection manager should apply to
* the socket.
*
* \param accessControlParam
*
* A parameter for the access control type, to be interpreted as
* specified in the documentation for the Socket_Access_Control enum.
* \param timeout The timeout in milliseconds.
*
* \return
*
* The address on which the connection manager will listen for
* connections to this tube. The client should not attempt to connect
* to the address until the tube is open.
*/
inline QDBusPendingReply<QDBusVariant> AcceptStreamTube(uint ID, uint addressType, uint accessControl, const QDBusVariant& accessControlParam, int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<QDBusVariant>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("AcceptStreamTube"));
callMessage << QVariant::fromValue(ID) << QVariant::fromValue(addressType) << QVariant::fromValue(accessControl) << QVariant::fromValue(accessControlParam);
return this->connection().asyncCall(callMessage, timeout);
}
/**
* Begins a call to the D-Bus method \c CloseTube on the remote object.
*
* Close a tube.
*
* 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 ID of the tube to close.
* \param timeout The timeout in milliseconds.
*/
inline QDBusPendingReply<> CloseTube(uint ID, int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("CloseTube"));
callMessage << QVariant::fromValue(ID);
return this->connection().asyncCall(callMessage, timeout);
}
/**
* Begins a call to the D-Bus method \c GetDBusTubeAddress on the remote object.
*
* For a D-Bus tube, return a string describing the address of the private
* bus.
*
* 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 ID of the tube to get an address for.
* \param timeout The timeout in milliseconds.
*
* \return
*
* The bus address.
*/
inline QDBusPendingReply<QString> GetDBusTubeAddress(uint ID, int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<QString>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("GetDBusTubeAddress"));
callMessage << QVariant::fromValue(ID);
return this->connection().asyncCall(callMessage, timeout);
}
/**
* Begins a call to the D-Bus method \c GetDBusNames on the remote object.
*
* For a multi-user (i.e. Handle_Type_Room) D-Bus tube, obtain a mapping
* between contact handles and their unique bus names on this tube.
*
* 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 ID of the tube to get names for.
* \param timeout The timeout in milliseconds.
*
* \return
*
* An array of structures, each containing a contact handle and a
* D-Bus bus name.
*/
inline QDBusPendingReply<Tp::DBusTubeMemberList> GetDBusNames(uint ID, int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<Tp::DBusTubeMemberList>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("GetDBusNames"));
callMessage << QVariant::fromValue(ID);
return this->connection().asyncCall(callMessage, timeout);
}
/**
* Begins a call to the D-Bus method \c GetStreamTubeSocketAddress on the remote object.
*
* For a stream tube, obtain the address of the socket used to communicate
* over this tube.
*
* 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 ID of the stream tube to get the socket for.
* \param timeout The timeout in milliseconds.
*
* \return
*
* The type of the listening address of the socket, as a member of
* Socket_Address_Type.
*
* \return
*
* The listening address of the socket, as indicated by the
* address_type.
*/
inline QDBusPendingReply<uint, QDBusVariant> GetStreamTubeSocketAddress(uint ID, int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<uint, QDBusVariant>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("GetStreamTubeSocketAddress"));
callMessage << QVariant::fromValue(ID);
return this->connection().asyncCall(callMessage, timeout);
}
Q_SIGNALS:
/**
* Represents the signal \c NewTube on the remote object.
*
* Emitted when a tube is created.
*
* \param ID
*
* The ID of the new tube.
*
* \param initiator
*
* The handle of the contact who initiated the tube.
*
* \param type
*
* The tube type, as defined by the Tube_Type enum.
*
* \param service
*
* A string representing the service that will be used over the tube.
*
* \param parameters
*
* The new tube's properties.
*
* \param state
*
* The new tube's state.
*/
void NewTube(uint ID, uint initiator, uint type, const QString& service, const QVariantMap& parameters, uint state);
/**
* Represents the signal \c TubeStateChanged on the remote object.
*
* Emitted when the state of a tube changes.
*
* \param ID
*
* The ID of the tube that changed state.
*
* \param state
*
* The new state of the tube; see the Tube_State enumeration.
*/
void TubeStateChanged(uint ID, uint state);
/**
* Represents the signal \c TubeClosed on the remote object.
*
* Emitted when a tube has been closed. The ID of a closed tube is no
* longer valid. The ID may later be reused for a new tube.
*
* \param ID
*
* The ID of the tube that was closed.
*/
void TubeClosed(uint ID);
/**
* Represents the signal \c DBusNamesChanged on the remote object.
*
* Emitted on a multi-user (i.e. Handle_Type_Room) D-Bus tube when a
* participant opens or closes the tube.
*
* \param ID
*
* The ID of the tube whose names have changed.
*
* \param added
*
* Array of handles and D-Bus names of new participants.
*
* \param removed
*
* Array of handles of former participants.
*/
void DBusNamesChanged(uint ID, const Tp::DBusTubeMemberList& added, const Tp::UIntList& removed);
/**
* Represents the signal \c StreamTubeNewConnection on the remote object.
*
* Emitted on a stream tube when a participant opens a new connection to
* its socket.
*
* \param ID
*
* The ID of the tube
*
* \param handle
*
* The handle of the participant who opened the new connection
*/
void StreamTubeNewConnection(uint ID, uint handle);
protected:
virtual void invalidate(Tp::DBusProxy *, const QString &, const QString &);
};
}
}
Q_DECLARE_METATYPE(Tp::Client::ChannelInterface*)
Q_DECLARE_METATYPE(Tp::Client::ChannelInterfaceAnonymityInterface*)
Q_DECLARE_METATYPE(Tp::Client::ChannelInterfaceCallStateInterface*)
Q_DECLARE_METATYPE(Tp::Client::ChannelInterfaceCaptchaAuthenticationInterface*)
Q_DECLARE_METATYPE(Tp::Client::ChannelInterfaceChatStateInterface*)
Q_DECLARE_METATYPE(Tp::Client::ChannelInterfaceConferenceInterface*)
Q_DECLARE_METATYPE(Tp::Client::ChannelInterfaceDTMFInterface*)
Q_DECLARE_METATYPE(Tp::Client::ChannelInterfaceDestroyableInterface*)
Q_DECLARE_METATYPE(Tp::Client::ChannelInterfaceFileTransferMetadataInterface*)
Q_DECLARE_METATYPE(Tp::Client::ChannelInterfaceGroupInterface*)
Q_DECLARE_METATYPE(Tp::Client::ChannelInterfaceHoldInterface*)
Q_DECLARE_METATYPE(Tp::Client::ChannelInterfaceMediaSignallingInterface*)
Q_DECLARE_METATYPE(Tp::Client::ChannelInterfaceMessagesInterface*)
Q_DECLARE_METATYPE(Tp::Client::ChannelInterfacePasswordInterface*)
Q_DECLARE_METATYPE(Tp::Client::ChannelInterfaceRoomConfigInterface*)
Q_DECLARE_METATYPE(Tp::Client::ChannelInterfaceRoomInterface*)
Q_DECLARE_METATYPE(Tp::Client::ChannelInterfaceSASLAuthenticationInterface*)
Q_DECLARE_METATYPE(Tp::Client::ChannelInterfaceSMSInterface*)
Q_DECLARE_METATYPE(Tp::Client::ChannelInterfaceSecurableInterface*)
Q_DECLARE_METATYPE(Tp::Client::ChannelInterfaceServicePointInterface*)
Q_DECLARE_METATYPE(Tp::Client::ChannelInterfaceSubjectInterface*)
Q_DECLARE_METATYPE(Tp::Client::ChannelInterfaceTubeInterface*)
Q_DECLARE_METATYPE(Tp::Client::ChannelTypeCallInterface*)
Q_DECLARE_METATYPE(Tp::Client::ChannelTypeContactListInterface*)
Q_DECLARE_METATYPE(Tp::Client::ChannelTypeContactSearchInterface*)
Q_DECLARE_METATYPE(Tp::Client::ChannelTypeDBusTubeInterface*)
Q_DECLARE_METATYPE(Tp::Client::ChannelTypeFileTransferInterface*)
Q_DECLARE_METATYPE(Tp::Client::ChannelTypeRoomListInterface*)
Q_DECLARE_METATYPE(Tp::Client::ChannelTypeServerAuthenticationInterface*)
Q_DECLARE_METATYPE(Tp::Client::ChannelTypeServerTLSConnectionInterface*)
Q_DECLARE_METATYPE(Tp::Client::ChannelTypeStreamTubeInterface*)
Q_DECLARE_METATYPE(Tp::Client::ChannelTypeStreamedMediaInterface*)
Q_DECLARE_METATYPE(Tp::Client::ChannelTypeTextInterface*)
Q_DECLARE_METATYPE(Tp::Client::ChannelTypeTubesInterface*)
|