/usr/include/telepathy-qt4/TelepathyQt/_gen/cli-account.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 | /*
* 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 AccountInterface
* \headerfile TelepathyQt/account.h <TelepathyQt/AccountManager>
* \ingroup clientaccount
*
* Proxy class providing a 1:1 mapping of the D-Bus interface "org.freedesktop.Telepathy.Account".
*/
class TP_QT_EXPORT AccountInterface : public Tp::AbstractInterface
{
Q_OBJECT
public:
/**
* Returns the name of the interface "org.freedesktop.Telepathy.Account", which this class
* represents.
*
* \return The D-Bus interface name.
*/
static inline QLatin1String staticInterfaceName()
{
return QLatin1String("org.freedesktop.Telepathy.Account");
}
/**
* Creates a AccountInterface 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.
*/
AccountInterface(
const QString& busName,
const QString& objectPath,
QObject* parent = 0
);
/**
* Creates a AccountInterface 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.
*/
AccountInterface(
const QDBusConnection& connection,
const QString& busName,
const QString& objectPath,
QObject* parent = 0
);
/**
* Creates a AccountInterface 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.
*/
AccountInterface(Tp::DBusProxy *proxy);
/**
* Asynchronous getter for the remote object property \c Interfaces of type \c QStringList.
*
*
* A list of the extra interfaces provided by this account.
*
* \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 DisplayName of type \c QString.
*
*
* The user-visible name of this account. This SHOULD be chosen by the
* user at account creation time. The account creation user interface is
* responsible for setting a reasonable default value in the user's
* locale; something like "Jabber (bob@example.com)" would be
* sensible.
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyDisplayName() const
{
return internalRequestProperty(QLatin1String("DisplayName"));
}
/**
* Asynchronous setter for the remote object property \c DisplayName of type \c QString.
*
*
* The user-visible name of this account. This SHOULD be chosen by the
* user at account creation time. The account creation user interface is
* responsible for setting a reasonable default value in the user's
* locale; something like "Jabber (bob@example.com)" would be
* sensible.
*
* \return A pending operation which will emit finished when the property has been
* set.
*/
inline Tp::PendingOperation *setPropertyDisplayName(QString newValue)
{
return internalSetProperty(QLatin1String("DisplayName"), QVariant::fromValue(newValue));
}
/**
* Asynchronous getter for the remote object property \c Icon of type \c QString.
*
*
* The name of an icon in the system's icon theme, such as
* "im-msn", or the empty string to not specify an icon. If the
* icon is set to an empty string, the account manager or any client MAY
* derive a default icon, for instance from the protocol.
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyIcon() const
{
return internalRequestProperty(QLatin1String("Icon"));
}
/**
* Asynchronous setter for the remote object property \c Icon of type \c QString.
*
*
* The name of an icon in the system's icon theme, such as
* "im-msn", or the empty string to not specify an icon. If the
* icon is set to an empty string, the account manager or any client MAY
* derive a default icon, for instance from the protocol.
*
* \return A pending operation which will emit finished when the property has been
* set.
*/
inline Tp::PendingOperation *setPropertyIcon(QString newValue)
{
return internalSetProperty(QLatin1String("Icon"), QVariant::fromValue(newValue));
}
/**
* Asynchronous getter for the remote object property \c Valid of type \c bool.
*
*
* If true, this account is considered by the account manager to be
* complete and usable. If false, user action is required to make it
* usable, and it will never attempt to connect (for instance, this might
* be caused by the absence of a required parameter). For connection
* managers with a plugin architecture, like telepathy-haze, we have
* little or no control over the parameters offered; for platforms with
* package management, we have little or no control over the CMs offered.
* NMC 4.x would just pretend the account didn't exist in these
* circumstances, but silent data loss is bad, and UIs with CM-specific
* knowledge (or a user filling in newly-required parameters) might be
* able to rescue a broken account.
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyValid() const
{
return internalRequestProperty(QLatin1String("Valid"));
}
/**
* Asynchronous getter for the remote object property \c Enabled of type \c bool.
*
*
* \htmlonly
* <p>This property gives the users the possibility to prevent an account
* from being used. This flag does not change the validity of the
* account.</p>
*
* <p>A disabled account can never be put online.</p>
*
* <div class="rationale">
* <p>Use cases:</p>
*
* <ul>
* <li>user has two or more accounts capable of calling contact X, but
* he doesn't want the UI to prompt him everytime about which one he
* wants to use for the call. He can then disable all the equivalent
* accounts but one.</li>
*
* <li>There is some temporary server error and the user doesn't want
* to be be bother by error messages, or change the account
* configuration: temporarily disabling the account is quicker.</li>
* </ul>
* </div>
*
* <p>The AccountManager SHOULD allow this property to be set on invalid
* accounts, but MUST NOT attempt to put invalid accounts online
* even if they become Enabled.</p>
*
* <div class="rationale">
* <p>There doesn't seem to be any good reason not to allow this.</p>
* </div>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyEnabled() const
{
return internalRequestProperty(QLatin1String("Enabled"));
}
/**
* Asynchronous setter for the remote object property \c Enabled of type \c bool.
*
*
* \htmlonly
* <p>This property gives the users the possibility to prevent an account
* from being used. This flag does not change the validity of the
* account.</p>
*
* <p>A disabled account can never be put online.</p>
*
* <div class="rationale">
* <p>Use cases:</p>
*
* <ul>
* <li>user has two or more accounts capable of calling contact X, but
* he doesn't want the UI to prompt him everytime about which one he
* wants to use for the call. He can then disable all the equivalent
* accounts but one.</li>
*
* <li>There is some temporary server error and the user doesn't want
* to be be bother by error messages, or change the account
* configuration: temporarily disabling the account is quicker.</li>
* </ul>
* </div>
*
* <p>The AccountManager SHOULD allow this property to be set on invalid
* accounts, but MUST NOT attempt to put invalid accounts online
* even if they become Enabled.</p>
*
* <div class="rationale">
* <p>There doesn't seem to be any good reason not to allow this.</p>
* </div>
* \endhtmlonly
*
* \return A pending operation which will emit finished when the property has been
* set.
*/
inline Tp::PendingOperation *setPropertyEnabled(bool newValue)
{
return internalSetProperty(QLatin1String("Enabled"), QVariant::fromValue(newValue));
}
/**
* Asynchronous getter for the remote object property \c Nickname of type \c QString.
*
*
* The nickname to set on this account for display to other contacts, as
* set by the user. When the account becomes connected, the account
* manager SHOULD set this as the user's alias using SetAliases if
* appropriate. In a later specification revision, we plan to separate the
* concepts of a contact's nickname as set by themselves, and the
* local name for them in our contact list (a "handle" or
* "pet name" as described in XEP-0165 and its references). The
* terminology change from alias to nickname here is a step in that
* direction.
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyNickname() const
{
return internalRequestProperty(QLatin1String("Nickname"));
}
/**
* Asynchronous setter for the remote object property \c Nickname of type \c QString.
*
*
* The nickname to set on this account for display to other contacts, as
* set by the user. When the account becomes connected, the account
* manager SHOULD set this as the user's alias using SetAliases if
* appropriate. In a later specification revision, we plan to separate the
* concepts of a contact's nickname as set by themselves, and the
* local name for them in our contact list (a "handle" or
* "pet name" as described in XEP-0165 and its references). The
* terminology change from alias to nickname here is a step in that
* direction.
*
* \return A pending operation which will emit finished when the property has been
* set.
*/
inline Tp::PendingOperation *setPropertyNickname(QString newValue)
{
return internalSetProperty(QLatin1String("Nickname"), QVariant::fromValue(newValue));
}
/**
* Asynchronous getter for the remote object property \c Service of type \c QString.
*
*
* \htmlonly
* <p>Some protocols, like XMPP and SIP, are used by various different
* user-recognised brands, such as <i>Google Talk</i> and <i>Ovi by
* Nokia</i>. On accounts for such services, this property SHOULD be
* set to a string describing the service, which MUST consist only of
* ASCII letters, numbers and hyphen/minus signs, and start with a
* letter (matching the requirements for <tp:type>Protocol</tp:type>).
* For the <tt>jabber</tt> protocol, one of the following service names
* should be used if possible:</p>
*
* <ul>
* <li><tt>google-talk</tt> (for <a href="http://www.google.com/talk/">Google's IM service</a>)</li>
* <li><tt>ovi-chat</tt> (for <a href="http://www.ovi.com/">Ovi</a>'s IM
* service)</li>
* <li><tt>facebook</tt> (for <a href="http://www.facebook.com/sitetour/chat.php">Facebook's IM
* service</a>)</li>
* <li><tt>lj-talk</tt> (for <a href="http://www.livejournal.com/chat/">LiveJournal's IM
* service</a>)</li>
* <li><tt>windows-live</tt> (for <a href="http://live.com">Windows Live Messenger IM service</a>)</li>
*
* </ul>
*
* <p>For the <tt>IRC</tt> protocol, the network name (<tt>freenode</tt>,
* <tt>gimpnet</tt>, etc.) can be used if relevant.</p>
*
* <p>The \endhtmlonly \link requestPropertyIcon() Icon \endlink \htmlonly property SHOULD be set to a
* corresponding brand-specific icon name, if possible. In the future,
* this property may be used as an index into additional
* service-specific customizations. If this property is the empty string
* (or missing), the service is determined by the protocol name (either
* because this is a single-service protocol like <tt>msn</tt>, or
* because this is just a generic <tt>jabber</tt> or <tt>sip</tt>
* account without specific branding).</p>
*
* <p>This property MAY be set, if appropriate, when calling
* \endhtmlonly AccountManagerInterface::CreateAccount() \htmlonly . Updating this property will fail on
* externally-stored accounts whose \endhtmlonly \link AccountInterfaceStorageInterface::requestPropertyStorageRestrictions() AccountInterfaceStorageInterface::StorageRestrictions \endlink \htmlonly include
* <code>Cannot_Set_Service</code>.</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 setter for the remote object property \c Service of type \c QString.
*
*
* \htmlonly
* <p>Some protocols, like XMPP and SIP, are used by various different
* user-recognised brands, such as <i>Google Talk</i> and <i>Ovi by
* Nokia</i>. On accounts for such services, this property SHOULD be
* set to a string describing the service, which MUST consist only of
* ASCII letters, numbers and hyphen/minus signs, and start with a
* letter (matching the requirements for <tp:type>Protocol</tp:type>).
* For the <tt>jabber</tt> protocol, one of the following service names
* should be used if possible:</p>
*
* <ul>
* <li><tt>google-talk</tt> (for <a href="http://www.google.com/talk/">Google's IM service</a>)</li>
* <li><tt>ovi-chat</tt> (for <a href="http://www.ovi.com/">Ovi</a>'s IM
* service)</li>
* <li><tt>facebook</tt> (for <a href="http://www.facebook.com/sitetour/chat.php">Facebook's IM
* service</a>)</li>
* <li><tt>lj-talk</tt> (for <a href="http://www.livejournal.com/chat/">LiveJournal's IM
* service</a>)</li>
* <li><tt>windows-live</tt> (for <a href="http://live.com">Windows Live Messenger IM service</a>)</li>
*
* </ul>
*
* <p>For the <tt>IRC</tt> protocol, the network name (<tt>freenode</tt>,
* <tt>gimpnet</tt>, etc.) can be used if relevant.</p>
*
* <p>The \endhtmlonly \link requestPropertyIcon() Icon \endlink \htmlonly property SHOULD be set to a
* corresponding brand-specific icon name, if possible. In the future,
* this property may be used as an index into additional
* service-specific customizations. If this property is the empty string
* (or missing), the service is determined by the protocol name (either
* because this is a single-service protocol like <tt>msn</tt>, or
* because this is just a generic <tt>jabber</tt> or <tt>sip</tt>
* account without specific branding).</p>
*
* <p>This property MAY be set, if appropriate, when calling
* \endhtmlonly AccountManagerInterface::CreateAccount() \htmlonly . Updating this property will fail on
* externally-stored accounts whose \endhtmlonly \link AccountInterfaceStorageInterface::requestPropertyStorageRestrictions() AccountInterfaceStorageInterface::StorageRestrictions \endlink \htmlonly include
* <code>Cannot_Set_Service</code>.</p>
* \endhtmlonly
*
* \return A pending operation which will emit finished when the property has been
* set.
*/
inline Tp::PendingOperation *setPropertyService(QString newValue)
{
return internalSetProperty(QLatin1String("Service"), QVariant::fromValue(newValue));
}
/**
* Asynchronous getter for the remote object property \c Parameters of type \c QVariantMap.
*
*
* \htmlonly
* <p>A map from connection manager parameter names (as in the
* \endhtmlonly ConnectionManagerInterface \htmlonly
* interface) to their values. This property includes
* only those parameters that are stored for this account, and SHOULD
* only include those parameters that the user has explicitly set.
* </p>
* <p>This property cannot be altered using
* <code>org.freedesktop.DBus.Properties.Set()</code>; use
* \endhtmlonly UpdateParameters() \htmlonly instead.</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 AutomaticPresence of type \c Tp::SimplePresence.
*
*
* \htmlonly
* <p>The presence status that this account should have if it is brought
* online.</p>
*
* <div class="rationale">
* In ITOS2007 and ITOS2008 this is a global preference, not visible
* on D-Bus (the "default presence"). "Automatic presence" better
* describes when it is used.
* </div>
*
* <p>Setting this property MUST NOT actually change the account's
* status until the next time it is (re)connected for some reason.</p>
*
* <p>The value of this property MUST be one that would be acceptable
* for \endhtmlonly \link requestPropertyRequestedPresence() RequestedPresence \endlink \htmlonly ,
* with the additional restriction that the
* <tp:type>Connection_Presence_Type</tp:type> MUST NOT be Offline.</p>
*
* <div class="rationale">
* <p>Otherwise, it would not be possible to use this presence to bring
* the account online for a channel request.</p>
* </div>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyAutomaticPresence() const
{
return internalRequestProperty(QLatin1String("AutomaticPresence"));
}
/**
* Asynchronous setter for the remote object property \c AutomaticPresence of type \c Tp::SimplePresence.
*
*
* \htmlonly
* <p>The presence status that this account should have if it is brought
* online.</p>
*
* <div class="rationale">
* In ITOS2007 and ITOS2008 this is a global preference, not visible
* on D-Bus (the "default presence"). "Automatic presence" better
* describes when it is used.
* </div>
*
* <p>Setting this property MUST NOT actually change the account's
* status until the next time it is (re)connected for some reason.</p>
*
* <p>The value of this property MUST be one that would be acceptable
* for \endhtmlonly \link requestPropertyRequestedPresence() RequestedPresence \endlink \htmlonly ,
* with the additional restriction that the
* <tp:type>Connection_Presence_Type</tp:type> MUST NOT be Offline.</p>
*
* <div class="rationale">
* <p>Otherwise, it would not be possible to use this presence to bring
* the account online for a channel request.</p>
* </div>
* \endhtmlonly
*
* \return A pending operation which will emit finished when the property has been
* set.
*/
inline Tp::PendingOperation *setPropertyAutomaticPresence(Tp::SimplePresence newValue)
{
return internalSetProperty(QLatin1String("AutomaticPresence"), QVariant::fromValue(newValue));
}
/**
* Asynchronous getter for the remote object property \c ConnectAutomatically of type \c bool.
*
*
* If true, the account manager SHOULD attempt to put this account online
* with the AutomaticPresence whenever possible (in the base Account
* interface this is deliberately left vague). If false, it MUST NOT put
* the account online automatically in response to, for instance,
* connectivity changes, but SHOULD still put the account online with the
* AutomaticPresence if requested by the user (for instance, if the user
* tries to start a conversation using this account).
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyConnectAutomatically() const
{
return internalRequestProperty(QLatin1String("ConnectAutomatically"));
}
/**
* Asynchronous setter for the remote object property \c ConnectAutomatically of type \c bool.
*
*
* If true, the account manager SHOULD attempt to put this account online
* with the AutomaticPresence whenever possible (in the base Account
* interface this is deliberately left vague). If false, it MUST NOT put
* the account online automatically in response to, for instance,
* connectivity changes, but SHOULD still put the account online with the
* AutomaticPresence if requested by the user (for instance, if the user
* tries to start a conversation using this account).
*
* \return A pending operation which will emit finished when the property has been
* set.
*/
inline Tp::PendingOperation *setPropertyConnectAutomatically(bool newValue)
{
return internalSetProperty(QLatin1String("ConnectAutomatically"), QVariant::fromValue(newValue));
}
/**
* Asynchronous getter for the remote object property \c Connection of type \c QDBusObjectPath.
*
*
* \htmlonly
* <p>Either the object path of the \endhtmlonly ConnectionInterface \htmlonly to
* this account, or the special value <code>'/'</code> if there is no
* connection.</p>
*
* <p>If this object path is not '/', the Connection's well-known bus
* name can be derived from this object path by removing the first '/'
* and replacing subsequent '/' characters with '.'.</p>
*
* <div class="rationale">
* Object paths aren't nullable, so we can't use an empty string.
* </div>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyConnection() const
{
return internalRequestProperty(QLatin1String("Connection"));
}
/**
* Asynchronous getter for the remote object property \c ConnectionStatus of type \c uint.
*
*
* If the Connection property is non-empty, the status of that connection.
* If the Connection property is the empty string, this property may
* either be Disconnected (indicating that the account manager is not
* attempting to bring it online), or Connecting (indicating that the
* account manager is attempting to connect). The account manager is
* expected to set this by observing signals from the Connection. If the
* AM is doing some sort of backoff/delay on reconnection attempts, the
* account's status is conceptually "Connecting" even
* though there is no Connection.
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyConnectionStatus() const
{
return internalRequestProperty(QLatin1String("ConnectionStatus"));
}
/**
* Asynchronous getter for the remote object property \c ConnectionStatusReason of type \c uint.
*
*
* The reason for the last change to ConnectionStatus. The account manager
* is expected to set this by observing signals from the Connection. If
* you weren't watching the Connection at the time it failed, you
* can't tell why - unless the AM can tell you.
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyConnectionStatusReason() const
{
return internalRequestProperty(QLatin1String("ConnectionStatusReason"));
}
/**
* Asynchronous getter for the remote object property \c ConnectionError of type \c QString.
*
*
* \htmlonly
* <p>If the last connection to this account failed with an error,
* the D-Bus error name of that error; otherwise, the empty string.
* The account manager is expected to set this by observing the
* \endhtmlonly ConnectionInterface::ConnectionError() \htmlonly and
* \endhtmlonly ConnectionInterface::StatusChanged() \htmlonly
* signals.</p>
*
* <p>If ConnectionError is received before the connection disconnects,
* its first argument should be used to set this property;
* otherwise, the Reason argument of StatusChanged should be converted
* to a suitable D-Bus error name.</p>
*
* <p>Whenever the Connection connects successfully, this property should
* be reset to the empty string.</p>
*
* <div class="rationale">
* <p>This combines the state-recoverability of
* \endhtmlonly \link requestPropertyConnectionStatusReason() ConnectionStatusReason \endlink \htmlonly with the
* extensibility of Connection.ConnectionError.</p>
* </div>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyConnectionError() const
{
return internalRequestProperty(QLatin1String("ConnectionError"));
}
/**
* Asynchronous getter for the remote object property \c ConnectionErrorDetails of type \c QVariantMap.
*
*
* \htmlonly
* <p>If the last connection to this account failed with an error,
* a mapping representing 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>Whenever the Connection connects successfully, this property should
* be reset to the empty map.</p>
*
* <div class="rationale">
* <p>This combines the state-recoverability of
* \endhtmlonly \link requestPropertyConnectionStatusReason() ConnectionStatusReason \endlink \htmlonly with the
* extensibility of Connection.ConnectionError.</p>
* </div>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyConnectionErrorDetails() const
{
return internalRequestProperty(QLatin1String("ConnectionErrorDetails"));
}
/**
* Asynchronous getter for the remote object property \c CurrentPresence of type \c Tp::SimplePresence.
*
*
* The actual presence. If the connection is not online, the
* Connection_Presence_Type SHOULD be Connection_Presence_Type_Offline. If
* the connection is online but does not support the SimplePresence
* interface, the type SHOULD be Connection_Presence_Type_Unset. The
* account manager is expected to set this by observing signals from the
* Connection.
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyCurrentPresence() const
{
return internalRequestProperty(QLatin1String("CurrentPresence"));
}
/**
* Asynchronous getter for the remote object property \c RequestedPresence of type \c Tp::SimplePresence.
*
*
* \htmlonly
* <p>The requested presence for this account. When this is changed, the
* account manager should attempt to manipulate the connection manager to
* make \endhtmlonly \link requestPropertyCurrentPresence() CurrentPresence \endlink \htmlonly match
* \endhtmlonly \link requestPropertyRequestedPresence() RequestedPresence \endlink \htmlonly as closely as
* possible. It should not be saved to any sort of persistent
* storage.</p>
*
* <p>When the account manager automatically connects an account,
* it must signal this by setting the RequestedPresence to the same
* thing as the \endhtmlonly \link requestPropertyAutomaticPresence() AutomaticPresence \endlink \htmlonly .</p>
*
* <p>The <tp:type>Connection_Presence_Type</tp:type> in this property
* MUST NOT be Unset, Unknown or Error.</p>
*
* <div class="rationale">
* <p>Requesting those presence types doesn't make sense.</p>
* </div>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyRequestedPresence() const
{
return internalRequestProperty(QLatin1String("RequestedPresence"));
}
/**
* Asynchronous setter for the remote object property \c RequestedPresence of type \c Tp::SimplePresence.
*
*
* \htmlonly
* <p>The requested presence for this account. When this is changed, the
* account manager should attempt to manipulate the connection manager to
* make \endhtmlonly \link requestPropertyCurrentPresence() CurrentPresence \endlink \htmlonly match
* \endhtmlonly \link requestPropertyRequestedPresence() RequestedPresence \endlink \htmlonly as closely as
* possible. It should not be saved to any sort of persistent
* storage.</p>
*
* <p>When the account manager automatically connects an account,
* it must signal this by setting the RequestedPresence to the same
* thing as the \endhtmlonly \link requestPropertyAutomaticPresence() AutomaticPresence \endlink \htmlonly .</p>
*
* <p>The <tp:type>Connection_Presence_Type</tp:type> in this property
* MUST NOT be Unset, Unknown or Error.</p>
*
* <div class="rationale">
* <p>Requesting those presence types doesn't make sense.</p>
* </div>
* \endhtmlonly
*
* \return A pending operation which will emit finished when the property has been
* set.
*/
inline Tp::PendingOperation *setPropertyRequestedPresence(Tp::SimplePresence newValue)
{
return internalSetProperty(QLatin1String("RequestedPresence"), QVariant::fromValue(newValue));
}
/**
* Asynchronous getter for the remote object property \c ChangingPresence of type \c bool.
*
*
* \htmlonly
* <p>If true, a change to the presence of this account is
* in progress.</p>
*
* <p>Whenever \endhtmlonly \link requestPropertyRequestedPresence() RequestedPresence \endlink \htmlonly is set on
* an account that could go online, or whenever an account with a
* non-offline \endhtmlonly \link requestPropertyRequestedPresence() RequestedPresence \endlink \htmlonly becomes
* able to go online (for instance because
* \endhtmlonly \link requestPropertyEnabled() Enabled \endlink \htmlonly or
* \endhtmlonly \link requestPropertyValid() Valid \endlink \htmlonly changes to True),
* ChangingPresence MUST change to True, and the two property changes MUST
* be emitted in the same
* \endhtmlonly AccountPropertyChanged() \htmlonly signal, before the
* Set method returns.</p>
*
* <p>When the account manager succeeds or fails in changing the presence,
* or the connection disconnects due to an error, ChangingPresence MUST
* change to False as part of the same
* \endhtmlonly AccountPropertyChanged() \htmlonly signal.</p>
*
* <div class="rationale">
* <p>This allows UIs to indicate that a presence change is in progress
* or has finished, even if the change was initiated by a different
* UI.</p>
*
* <p>For instance, Maemo 5 and Empathy indicate a presence change by
* having the presence indicator alternate between the
* \endhtmlonly \link requestPropertyRequestedPresence() RequestedPresence \endlink \htmlonly
* and the \endhtmlonly \link requestPropertyCurrentPresence() CurrentPresence \endlink \htmlonly ; they should
* start blinking when ChangingPresence becomes true, and stop when it
* becomes false.</p>
* </div>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyChangingPresence() const
{
return internalRequestProperty(QLatin1String("ChangingPresence"));
}
/**
* Asynchronous getter for the remote object property \c NormalizedName of type \c QString.
*
*
* \htmlonly
* <p>The normalized user ID of the local user on this account (i.e. the
* string returned when the \endhtmlonly ConnectionInterface::InspectHandles() \htmlonly
* method is called on the
* result of \endhtmlonly ConnectionInterface::GetSelfHandle() \htmlonly
* for an active connection).</p>
*
* <p>It is unspecified whether this user ID is globally unique.</p>
*
* <div class="rationale">
* <p>As currently implemented, IRC user IDs are only unique within
* the same IRCnet. On some saner protocols, the user ID includes a
* DNS name which provides global uniqueness.</p>
* </div>
*
* <p>If this value is not known yet (which will always be the case for
* accounts that have never been online), it will be an empty
* string.</p>
*
* <p>It is possible that this value will change if the connection
* manager's normalization algorithm changes, although this SHOULD
* be avoided.</p>
*
* <div class="rationale">
* <p>It's not always completely clear what normalization algorithm
* should be used; for instance, in Gabble, we currently use JIDs,
* but it would also have been reasonable to use xmpp URIs.</p>
* </div>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyNormalizedName() const
{
return internalRequestProperty(QLatin1String("NormalizedName"));
}
/**
* Asynchronous getter for the remote object property \c HasBeenOnline of type \c bool.
*
*
* If true, this account has successfully been put online at some point in
* the past. UIs could apply a policy that the 'account'
* parameter can only be edited in accounts that have never been online,
* or that ConnectAutomatically cannot be set on such accounts. The
* account manager should not enforce such policies, but it can expose
* enough information to UIs that the UI can decide what to do.
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyHasBeenOnline() const
{
return internalRequestProperty(QLatin1String("HasBeenOnline"));
}
/**
* Asynchronous getter for the remote object property \c Supersedes of type \c Tp::ObjectPathList.
*
*
* \htmlonly
* <p>A list of the object paths of formerly-used accounts which are
* superseded by this one.</p>
*
* <div class="rationale">
* <p>For instance, if an account is migrated from one connection
* manager implementation to another, or even from one protocol
* to another (for instance formerly-proprietary services which
* can now be accessed via XMPP), log storage services could
* look for logs under all of the superseded object paths as well
* as the new object path.</p>
*
* <p>This is a list because a single user-visible account could be
* migrated more than once.</p>
* </div>
*
* <p>If the Account Manager implementation performs an account migration
* automatically, it SHOULD set this property. If a client performs
* an account migration, it SHOULD set this property via
* via the Properties argument of \endhtmlonly AccountManagerInterface::CreateAccount() \htmlonly
* when creating the migrated account. In either case, the value
* SHOULD include the old account's path, and every path from
* the old account's Supersedes property.</p>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertySupersedes() const
{
return internalRequestProperty(QLatin1String("Supersedes"));
}
/**
* Asynchronous setter for the remote object property \c Supersedes of type \c Tp::ObjectPathList.
*
*
* \htmlonly
* <p>A list of the object paths of formerly-used accounts which are
* superseded by this one.</p>
*
* <div class="rationale">
* <p>For instance, if an account is migrated from one connection
* manager implementation to another, or even from one protocol
* to another (for instance formerly-proprietary services which
* can now be accessed via XMPP), log storage services could
* look for logs under all of the superseded object paths as well
* as the new object path.</p>
*
* <p>This is a list because a single user-visible account could be
* migrated more than once.</p>
* </div>
*
* <p>If the Account Manager implementation performs an account migration
* automatically, it SHOULD set this property. If a client performs
* an account migration, it SHOULD set this property via
* via the Properties argument of \endhtmlonly AccountManagerInterface::CreateAccount() \htmlonly
* when creating the migrated account. In either case, the value
* SHOULD include the old account's path, and every path from
* the old account's Supersedes property.</p>
* \endhtmlonly
*
* \return A pending operation which will emit finished when the property has been
* set.
*/
inline Tp::PendingOperation *setPropertySupersedes(Tp::ObjectPathList newValue)
{
return internalSetProperty(QLatin1String("Supersedes"), 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();
}
public Q_SLOTS:
/**
* Begins a call to the D-Bus method \c Remove on the remote object.
*
* Delete the account.
*
* 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<> Remove(int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("Remove"));
return this->connection().asyncCall(callMessage, timeout);
}
/**
* Begins a call to the D-Bus method \c UpdateParameters on the remote object.
*
* \htmlonly
* <p>Change the value of the \endhtmlonly \link requestPropertyParameters() Parameters \endlink \htmlonly
* property.</p>
*
* <p>If any of the <var>Set</var> parameters’
* <tp:type>Conn_Mgr_Param_Flags</tp:type> include
* <code>DBus_Property</code>, the change will be applied immediately to
* the corresponding D-Bus Property on the active
* \endhtmlonly \link requestPropertyConnection() Connection \endlink \htmlonly , if there is one. If any of
* the <var>Unset</var> parameters’
* <tp:type>Conn_Mgr_Param_Flags</tp:type> include both
* <code>DBus_Property</code> and <code>Has_Default</code>, the
* corresponding D-Bus Property on the connection will be set to the
* default value. Changes to other parameters will not take effect
* until the next time the account is disconnected and reconnected. (If
* parameters are explicitly set to their default value, or are unset
* when previously set to their default value, the account manager MAY
* decide that no reconnection is necessary to make the change take
* effect.)</p>
*
* <div class="rationale">
* <p>In general, reconnecting is a destructive operation that shouldn't
* happen as a side-effect. In particular, migration tools that
* twiddle the settings of all accounts shouldn't cause an automatic
* disconnect and reconnect.</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 set
*
* A mapping from parameter names to their values. These parameters
* should be stored for future use.
*
* \param unset
*
* A list of the names of parameters to be removed from the set of
* stored values, allowing the default values to be used. If the given
* parameters were not, in fact, stored, or even if they do not exist
* at all, the account manager MUST accept this without error.
* \param timeout The timeout in milliseconds.
*
* \return
*
* \htmlonly
* <p>If all of the updates could be applied to the active
* \endhtmlonly \link requestPropertyConnection() Connection \endlink \htmlonly (if any),
* the empty list, signifying that no reconnection is required for the
* new parameters to take effect. For example, if the only parameter
* updated is <tt>...Cellular. \endhtmlonly \link ConnectionInterfaceCellularInterface::requestPropertyMessageValidityPeriod() ConnectionInterfaceCellularInterface::MessageValidityPeriod \endlink \htmlonly </tt>,
* the new value can be applied immediately to the connection.</p>
*
* <p>Otherwise, a list of the names of parameters with changes that
* will not take effect until the account is reconnected. User
* interfaces that require "instant apply" semantics MAY call
* \endhtmlonly Reconnect() \htmlonly in response to receiving a
* non-empty list. For example, if the caller updates both
* <tt>...Anonymity. \endhtmlonly \link ConnectionInterfaceAnonymityInterface::requestPropertyAnonymityMandatory() ConnectionInterfaceAnonymityInterface::AnonymityMandatory \endlink \htmlonly </tt>
* and <tt>require-encryption</tt>, the former can be applied to the
* current connection, but the latter needs a reconnect to take
* effect, so this method should return
* <code>["require-encryption"]</code>.</p>
* \endhtmlonly
*/
inline QDBusPendingReply<QStringList> UpdateParameters(const QVariantMap& set, const QStringList& unset, int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<QStringList>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("UpdateParameters"));
callMessage << QVariant::fromValue(set) << QVariant::fromValue(unset);
return this->connection().asyncCall(callMessage, timeout);
}
/**
* Begins a call to the D-Bus method \c Reconnect on the remote object.
*
* \htmlonly
* <p>Re-connect this account. If the account is currently disconnected
* and the requested presence is offline, or if the account
* is not \endhtmlonly \link requestPropertyEnabled() Enabled \endlink \htmlonly or not
* \endhtmlonly \link requestPropertyValid() Valid \endlink \htmlonly , this does nothing.</p>
*
* <p>If the account is disconnected and the requested presence is not
* offline, this forces an attempt to connect with the requested
* presence immediately.</p>
*
* <p>If the account is connecting or connected, this is equivalent to
* remembering the current value of
* \endhtmlonly \link requestPropertyRequestedPresence() RequestedPresence \endlink \htmlonly , setting its value
* to (OFFLINE, "offline", ""), waiting for the change to take effect,
* then setting its value to the value that was previously
* remembered.</p>
*
* <div class="rationale">
* <p>Clients desiring "instant apply" semantics for CM parameters MAY
* call this method to achieve that.</p>
* </div>
*
* <p>In particular, if the account's
* \endhtmlonly \link requestPropertyConnection() Connection \endlink \htmlonly is in the Connecting
* state, calling this method causes the attempt to connect to be
* aborted and re-tried.</p>
*
* <div class="rationale">
* <p>This is necessary to ensure that the new parameters are
* picked up.</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<> Reconnect(int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("Reconnect"));
return this->connection().asyncCall(callMessage, timeout);
}
Q_SIGNALS:
/**
* Represents the signal \c Removed on the remote object.
*
* This account has been removed. This is redundant with AccountRemoved,
* but it's still worth having, to avoid having to bind to
* AccountManager.AccountRemoved to tell you whether your Account is valid
* — ideally, an account-editing UI should only care about a single
* Account.
*/
void Removed();
/**
* Represents the signal \c AccountPropertyChanged on the remote object.
*
* The values of one or more properties on this interface (that do not
* specify that this signal does not apply to them) may have changed. This
* does not cover properties of other interfaces, which must provide their
* own change notification if appropriate.
*
* \param properties
*
* A map from property names in this namespace (e.g. Nickname) to
* values. Properties whose values have not changed SHOULD be omitted,
* but this need not be done.
*/
void AccountPropertyChanged(const QVariantMap& properties);
protected:
virtual void invalidate(Tp::DBusProxy *, const QString &, const QString &);
};
/**
* \class AccountInterfaceAddressingInterface
* \headerfile TelepathyQt/account.h <TelepathyQt/AccountManager>
* \ingroup clientaccount
*
* Proxy class providing a 1:1 mapping of the D-Bus interface "org.freedesktop.Telepathy.Account.Interface.Addressing".
*/
class TP_QT_EXPORT AccountInterfaceAddressingInterface : public Tp::AbstractInterface
{
Q_OBJECT
public:
/**
* Returns the name of the interface "org.freedesktop.Telepathy.Account.Interface.Addressing", which this class
* represents.
*
* \return The D-Bus interface name.
*/
static inline QLatin1String staticInterfaceName()
{
return QLatin1String("org.freedesktop.Telepathy.Account.Interface.Addressing");
}
/**
* Creates a AccountInterfaceAddressingInterface 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.
*/
AccountInterfaceAddressingInterface(
const QString& busName,
const QString& objectPath,
QObject* parent = 0
);
/**
* Creates a AccountInterfaceAddressingInterface 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.
*/
AccountInterfaceAddressingInterface(
const QDBusConnection& connection,
const QString& busName,
const QString& objectPath,
QObject* parent = 0
);
/**
* Creates a AccountInterfaceAddressingInterface 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.
*/
AccountInterfaceAddressingInterface(Tp::DBusProxy *proxy);
/**
* Creates a AccountInterfaceAddressingInterface 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 AccountInterfaceAddressingInterface(const Tp::Client::AccountInterface& mainInterface);
/**
* Creates a AccountInterfaceAddressingInterface 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.
*/
AccountInterfaceAddressingInterface(const Tp::Client::AccountInterface& mainInterface, QObject* parent);
/**
* Asynchronous getter for the remote object property \c URISchemes of type \c QStringList.
*
*
* \htmlonly
* <p>A list of fields indicating the type of URI addressing scheme
* the the account should be used for (eg 'tel') indicating the
* account is intended for use by applications offering a telephony
* UI, or 'sip' or 'xmpp' for those protocols</p>
* <p>Note that these fields signify intent, not ability: It is
* entirely possible that an account which can be used for a
* given URI scheme is not wanted for it by the user, and
* therefore not flagged as such in this field.</p>
* <p>Change notification for this property is provided by the
* standard D-Bus <code>PropertiesChanged</code> signal.</p>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyURISchemes() const
{
return internalRequestProperty(QLatin1String("URISchemes"));
}
/**
* 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 SetURISchemeAssociation on the remote object.
*
* Associate (or disassociate) an account with a particular URI addressing
* scheme, (such as 'tel' for telephony)
*
* 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 URIScheme
*
* URI scheme to associate/disassociate the account with/from
*
* \param association
*
* True to associate this account with a given addressing scheme False
* if the account should not be associated with said scheme
* \param timeout The timeout in milliseconds.
*/
inline QDBusPendingReply<> SetURISchemeAssociation(const QString& URIScheme, bool association, int timeout = -1)
{
if (!invalidationReason().isEmpty()) {
return QDBusPendingReply<>(QDBusMessage::createError(
invalidationReason(),
invalidationMessage()
));
}
QDBusMessage callMessage = QDBusMessage::createMethodCall(this->service(), this->path(),
this->staticInterfaceName(), QLatin1String("SetURISchemeAssociation"));
callMessage << QVariant::fromValue(URIScheme) << QVariant::fromValue(association);
return this->connection().asyncCall(callMessage, timeout);
}
protected:
virtual void invalidate(Tp::DBusProxy *, const QString &, const QString &);
};
/**
* \class AccountInterfaceAvatarInterface
* \headerfile TelepathyQt/account.h <TelepathyQt/AccountManager>
* \ingroup clientaccount
*
* Proxy class providing a 1:1 mapping of the D-Bus interface "org.freedesktop.Telepathy.Account.Interface.Avatar".
*/
class TP_QT_EXPORT AccountInterfaceAvatarInterface : public Tp::AbstractInterface
{
Q_OBJECT
public:
/**
* Returns the name of the interface "org.freedesktop.Telepathy.Account.Interface.Avatar", which this class
* represents.
*
* \return The D-Bus interface name.
*/
static inline QLatin1String staticInterfaceName()
{
return QLatin1String("org.freedesktop.Telepathy.Account.Interface.Avatar");
}
/**
* Creates a AccountInterfaceAvatarInterface 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.
*/
AccountInterfaceAvatarInterface(
const QString& busName,
const QString& objectPath,
QObject* parent = 0
);
/**
* Creates a AccountInterfaceAvatarInterface 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.
*/
AccountInterfaceAvatarInterface(
const QDBusConnection& connection,
const QString& busName,
const QString& objectPath,
QObject* parent = 0
);
/**
* Creates a AccountInterfaceAvatarInterface 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.
*/
AccountInterfaceAvatarInterface(Tp::DBusProxy *proxy);
/**
* Creates a AccountInterfaceAvatarInterface 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 AccountInterfaceAvatarInterface(const Tp::Client::AccountInterface& mainInterface);
/**
* Creates a AccountInterfaceAvatarInterface 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.
*/
AccountInterfaceAvatarInterface(const Tp::Client::AccountInterface& mainInterface, QObject* parent);
/**
* Asynchronous getter for the remote object property \c Avatar of type \c Tp::Avatar.
*
*
* The avatar to set on this account for display to other contacts,
* represented as a structure containing the bytes of the avatar, and the
* MIME type as a string; may be set to an empty byte-array and an empty
* string to indicate no avatar. When the account becomes connected, the
* account manager SHOULD set this avatar using SetAvatar if appropriate.
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyAvatar() const
{
return internalRequestProperty(QLatin1String("Avatar"));
}
/**
* Asynchronous setter for the remote object property \c Avatar of type \c Tp::Avatar.
*
*
* The avatar to set on this account for display to other contacts,
* represented as a structure containing the bytes of the avatar, and the
* MIME type as a string; may be set to an empty byte-array and an empty
* string to indicate no avatar. When the account becomes connected, the
* account manager SHOULD set this avatar using SetAvatar if appropriate.
*
* \return A pending operation which will emit finished when the property has been
* set.
*/
inline Tp::PendingOperation *setPropertyAvatar(Tp::Avatar newValue)
{
return internalSetProperty(QLatin1String("Avatar"), QVariant::fromValue(newValue));
}
/**
* Request all of the DBus properties on the interface.
*
* \return A pending variant map which will emit finished when the properties have
* been retrieved.
*/
Tp::PendingVariantMap *requestAllProperties() const
{
return internalRequestAllProperties();
}
Q_SIGNALS:
/**
* Represents the signal \c AvatarChanged on the remote object.
*
* Emitted when the Avatar property changes. The avatar itself is
* deliberately not included in this signal, to reduce bus traffic in the
* (likely common) case where no running application cares about the
* user's own avatar.
*/
void AvatarChanged();
protected:
virtual void invalidate(Tp::DBusProxy *, const QString &, const QString &);
};
/**
* \class AccountInterfaceStorageInterface
* \headerfile TelepathyQt/account.h <TelepathyQt/AccountManager>
* \ingroup clientaccount
*
* Proxy class providing a 1:1 mapping of the D-Bus interface "org.freedesktop.Telepathy.Account.Interface.Storage".
*/
class TP_QT_EXPORT AccountInterfaceStorageInterface : public Tp::AbstractInterface
{
Q_OBJECT
public:
/**
* Returns the name of the interface "org.freedesktop.Telepathy.Account.Interface.Storage", which this class
* represents.
*
* \return The D-Bus interface name.
*/
static inline QLatin1String staticInterfaceName()
{
return QLatin1String("org.freedesktop.Telepathy.Account.Interface.Storage");
}
/**
* Creates a AccountInterfaceStorageInterface 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.
*/
AccountInterfaceStorageInterface(
const QString& busName,
const QString& objectPath,
QObject* parent = 0
);
/**
* Creates a AccountInterfaceStorageInterface 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.
*/
AccountInterfaceStorageInterface(
const QDBusConnection& connection,
const QString& busName,
const QString& objectPath,
QObject* parent = 0
);
/**
* Creates a AccountInterfaceStorageInterface 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.
*/
AccountInterfaceStorageInterface(Tp::DBusProxy *proxy);
/**
* Creates a AccountInterfaceStorageInterface 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 AccountInterfaceStorageInterface(const Tp::Client::AccountInterface& mainInterface);
/**
* Creates a AccountInterfaceStorageInterface 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.
*/
AccountInterfaceStorageInterface(const Tp::Client::AccountInterface& mainInterface, QObject* parent);
/**
* Asynchronous getter for the remote object property \c StorageProvider of type \c QString.
*
*
* \htmlonly
* <p>
* The name of the account storage implementation, which SHOULD start
* with a reversed domain name in the same way as D-Bus interface names.
* When this is the empty string the account is internally stored.
* </p>
* <p>
* This property cannot change once an Account has been created.
* </p>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyStorageProvider() const
{
return internalRequestProperty(QLatin1String("StorageProvider"));
}
/**
* Asynchronous getter for the remote object property \c StorageIdentifier of type \c QDBusVariant.
*
*
* \htmlonly
* <p>
* Unique identification of the account within the storage backend.
* The contents of the variant are defined by the
* \endhtmlonly \link requestPropertyStorageProvider() StorageProvider \endlink \htmlonly .
* </p>
* <p>
* This property cannot change once an Account has been created.
* </p>
* <div class="rationale">
* <p>
* Different storage systems will have their own way of uniquely
* identifying an account, typically an integer or a string.
* Given that all users of this property should have direct knowledge
* of the backend they should know what types to expect and how to
* handle it.
* </p>
* </div>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyStorageIdentifier() const
{
return internalRequestProperty(QLatin1String("StorageIdentifier"));
}
/**
* Asynchronous getter for the remote object property \c StorageSpecificInformation of type \c QVariantMap.
*
*
* \htmlonly
* <p>
* Map containing information specific to the storage backend. The keys
* and the types of their values are defined by the
* \endhtmlonly \link requestPropertyStorageProvider() StorageProvider \endlink \htmlonly , and are not
* interpreted by the AccountManager implementation.
* </p>
* <p>
* As the values in this map may change at any time (due to an external
* application manipulating the storage provider directly), this
* property should not be cached; it should instead be retrieved each
* time it is needed.
* </p>
*
* <div class="rationale">
* <p>
* This can be used to provide additional hints to user interfaces
* aware of a specific storage provider, without requiring those user
* interfaces to use the
* \endhtmlonly \link requestPropertyStorageIdentifier() StorageIdentifier \endlink \htmlonly to query the
* storage provider directly.
* </p>
* </div>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyStorageSpecificInformation() const
{
return internalRequestProperty(QLatin1String("StorageSpecificInformation"));
}
/**
* Asynchronous getter for the remote object property \c StorageRestrictions of type \c uint.
*
*
* \htmlonly
* <p>
* Bitfield which defines what restrictions this Storage method has.
* </p>
* <p>
* This property cannot change once an Account has been created.
* </p>
* \endhtmlonly
*
* \return A pending variant which will emit finished when the property has been
* retrieved.
*/
inline Tp::PendingVariant *requestPropertyStorageRestrictions() const
{
return internalRequestProperty(QLatin1String("StorageRestrictions"));
}
/**
* 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 &);
};
}
}
Q_DECLARE_METATYPE(Tp::Client::AccountInterface*)
Q_DECLARE_METATYPE(Tp::Client::AccountInterfaceAddressingInterface*)
Q_DECLARE_METATYPE(Tp::Client::AccountInterfaceAvatarInterface*)
Q_DECLARE_METATYPE(Tp::Client::AccountInterfaceStorageInterface*)
|