QEverCloud  6.1.0
Unofficial Evernote Cloud API for Qt
Services.h
Go to the documentation of this file.
1 
12 #ifndef QEVERCLOUD_GENERATED_SERVICES_H
13 #define QEVERCLOUD_GENERATED_SERVICES_H
14 
15 #include "../Export.h"
16 
17 #include "../AsyncResult.h"
18 #include "../DurableService.h"
19 #include "../Optional.h"
20 #include "../RequestContext.h"
21 #include "Constants.h"
22 #include "Types.h"
23 #include <QObject>
24 
25 namespace qevercloud {
26 
28 
55 class QEVERCLOUD_EXPORT INoteStore: public QObject
56 {
57  Q_OBJECT
58  Q_DISABLE_COPY(INoteStore)
59 protected:
60  INoteStore(QObject * parent) :
61  QObject(parent)
62  {}
63 
64 public:
65  virtual QString noteStoreUrl() const = 0;
66  virtual void setNoteStoreUrl(QString url) = 0;
67 
72  virtual SyncState getSyncState(
73  IRequestContextPtr ctx = {}) = 0;
74 
76  virtual AsyncResult * getSyncStateAsync(
77  IRequestContextPtr ctx = {}) = 0;
78 
112  virtual SyncChunk getFilteredSyncChunk(
113  qint32 afterUSN,
114  qint32 maxEntries,
115  const SyncChunkFilter & filter,
116  IRequestContextPtr ctx = {}) = 0;
117 
119  virtual AsyncResult * getFilteredSyncChunkAsync(
120  qint32 afterUSN,
121  qint32 maxEntries,
122  const SyncChunkFilter & filter,
123  IRequestContextPtr ctx = {}) = 0;
124 
166  virtual SyncState getLinkedNotebookSyncState(
167  const LinkedNotebook & linkedNotebook,
168  IRequestContextPtr ctx = {}) = 0;
169 
171  virtual AsyncResult * getLinkedNotebookSyncStateAsync(
172  const LinkedNotebook & linkedNotebook,
173  IRequestContextPtr ctx = {}) = 0;
174 
239  virtual SyncChunk getLinkedNotebookSyncChunk(
240  const LinkedNotebook & linkedNotebook,
241  qint32 afterUSN,
242  qint32 maxEntries,
243  bool fullSyncOnly,
244  IRequestContextPtr ctx = {}) = 0;
245 
247  virtual AsyncResult * getLinkedNotebookSyncChunkAsync(
248  const LinkedNotebook & linkedNotebook,
249  qint32 afterUSN,
250  qint32 maxEntries,
251  bool fullSyncOnly,
252  IRequestContextPtr ctx = {}) = 0;
253 
257  virtual QList<Notebook> listNotebooks(
258  IRequestContextPtr ctx = {}) = 0;
259 
261  virtual AsyncResult * listNotebooksAsync(
262  IRequestContextPtr ctx = {}) = 0;
263 
277  virtual QList<Notebook> listAccessibleBusinessNotebooks(
278  IRequestContextPtr ctx = {}) = 0;
279 
281  virtual AsyncResult * listAccessibleBusinessNotebooksAsync(
282  IRequestContextPtr ctx = {}) = 0;
283 
303  virtual Notebook getNotebook(
304  Guid guid,
305  IRequestContextPtr ctx = {}) = 0;
306 
308  virtual AsyncResult * getNotebookAsync(
309  Guid guid,
310  IRequestContextPtr ctx = {}) = 0;
311 
316  virtual Notebook getDefaultNotebook(
317  IRequestContextPtr ctx = {}) = 0;
318 
320  virtual AsyncResult * getDefaultNotebookAsync(
321  IRequestContextPtr ctx = {}) = 0;
322 
357  virtual Notebook createNotebook(
358  const Notebook & notebook,
359  IRequestContextPtr ctx = {}) = 0;
360 
362  virtual AsyncResult * createNotebookAsync(
363  const Notebook & notebook,
364  IRequestContextPtr ctx = {}) = 0;
365 
405  virtual qint32 updateNotebook(
406  const Notebook & notebook,
407  IRequestContextPtr ctx = {}) = 0;
408 
410  virtual AsyncResult * updateNotebookAsync(
411  const Notebook & notebook,
412  IRequestContextPtr ctx = {}) = 0;
413 
439  virtual qint32 expungeNotebook(
440  Guid guid,
441  IRequestContextPtr ctx = {}) = 0;
442 
444  virtual AsyncResult * expungeNotebookAsync(
445  Guid guid,
446  IRequestContextPtr ctx = {}) = 0;
447 
452  virtual QList<Tag> listTags(
453  IRequestContextPtr ctx = {}) = 0;
454 
456  virtual AsyncResult * listTagsAsync(
457  IRequestContextPtr ctx = {}) = 0;
458 
472  virtual QList<Tag> listTagsByNotebook(
473  Guid notebookGuid,
474  IRequestContextPtr ctx = {}) = 0;
475 
477  virtual AsyncResult * listTagsByNotebookAsync(
478  Guid notebookGuid,
479  IRequestContextPtr ctx = {}) = 0;
480 
499  virtual Tag getTag(
500  Guid guid,
501  IRequestContextPtr ctx = {}) = 0;
502 
504  virtual AsyncResult * getTagAsync(
505  Guid guid,
506  IRequestContextPtr ctx = {}) = 0;
507 
536  virtual Tag createTag(
537  const Tag & tag,
538  IRequestContextPtr ctx = {}) = 0;
539 
541  virtual AsyncResult * createTagAsync(
542  const Tag & tag,
543  IRequestContextPtr ctx = {}) = 0;
544 
576  virtual qint32 updateTag(
577  const Tag & tag,
578  IRequestContextPtr ctx = {}) = 0;
579 
581  virtual AsyncResult * updateTagAsync(
582  const Tag & tag,
583  IRequestContextPtr ctx = {}) = 0;
584 
611  virtual void untagAll(
612  Guid guid,
613  IRequestContextPtr ctx = {}) = 0;
614 
616  virtual AsyncResult * untagAllAsync(
617  Guid guid,
618  IRequestContextPtr ctx = {}) = 0;
619 
645  virtual qint32 expungeTag(
646  Guid guid,
647  IRequestContextPtr ctx = {}) = 0;
648 
650  virtual AsyncResult * expungeTagAsync(
651  Guid guid,
652  IRequestContextPtr ctx = {}) = 0;
653 
658  virtual QList<SavedSearch> listSearches(
659  IRequestContextPtr ctx = {}) = 0;
660 
662  virtual AsyncResult * listSearchesAsync(
663  IRequestContextPtr ctx = {}) = 0;
664 
682  virtual SavedSearch getSearch(
683  Guid guid,
684  IRequestContextPtr ctx = {}) = 0;
685 
687  virtual AsyncResult * getSearchAsync(
688  Guid guid,
689  IRequestContextPtr ctx = {}) = 0;
690 
715  virtual SavedSearch createSearch(
716  const SavedSearch & search,
717  IRequestContextPtr ctx = {}) = 0;
718 
720  virtual AsyncResult * createSearchAsync(
721  const SavedSearch & search,
722  IRequestContextPtr ctx = {}) = 0;
723 
751  virtual qint32 updateSearch(
752  const SavedSearch & search,
753  IRequestContextPtr ctx = {}) = 0;
754 
756  virtual AsyncResult * updateSearchAsync(
757  const SavedSearch & search,
758  IRequestContextPtr ctx = {}) = 0;
759 
785  virtual qint32 expungeSearch(
786  Guid guid,
787  IRequestContextPtr ctx = {}) = 0;
788 
790  virtual AsyncResult * expungeSearchAsync(
791  Guid guid,
792  IRequestContextPtr ctx = {}) = 0;
793 
835  virtual qint32 findNoteOffset(
836  const NoteFilter & filter,
837  Guid guid,
838  IRequestContextPtr ctx = {}) = 0;
839 
841  virtual AsyncResult * findNoteOffsetAsync(
842  const NoteFilter & filter,
843  Guid guid,
844  IRequestContextPtr ctx = {}) = 0;
845 
903  virtual NotesMetadataList findNotesMetadata(
904  const NoteFilter & filter,
905  qint32 offset,
906  qint32 maxNotes,
907  const NotesMetadataResultSpec & resultSpec,
908  IRequestContextPtr ctx = {}) = 0;
909 
911  virtual AsyncResult * findNotesMetadataAsync(
912  const NoteFilter & filter,
913  qint32 offset,
914  qint32 maxNotes,
915  const NotesMetadataResultSpec & resultSpec,
916  IRequestContextPtr ctx = {}) = 0;
917 
949  virtual NoteCollectionCounts findNoteCounts(
950  const NoteFilter & filter,
951  bool withTrash,
952  IRequestContextPtr ctx = {}) = 0;
953 
955  virtual AsyncResult * findNoteCountsAsync(
956  const NoteFilter & filter,
957  bool withTrash,
958  IRequestContextPtr ctx = {}) = 0;
959 
991  virtual Note getNoteWithResultSpec(
992  Guid guid,
993  const NoteResultSpec & resultSpec,
994  IRequestContextPtr ctx = {}) = 0;
995 
997  virtual AsyncResult * getNoteWithResultSpecAsync(
998  Guid guid,
999  const NoteResultSpec & resultSpec,
1000  IRequestContextPtr ctx = {}) = 0;
1001 
1009  virtual Note getNote(
1010  Guid guid,
1011  bool withContent,
1012  bool withResourcesData,
1013  bool withResourcesRecognition,
1014  bool withResourcesAlternateData,
1015  IRequestContextPtr ctx = {}) = 0;
1016 
1018  virtual AsyncResult * getNoteAsync(
1019  Guid guid,
1020  bool withContent,
1021  bool withResourcesData,
1022  bool withResourcesRecognition,
1023  bool withResourcesAlternateData,
1024  IRequestContextPtr ctx = {}) = 0;
1025 
1034  virtual LazyMap getNoteApplicationData(
1035  Guid guid,
1036  IRequestContextPtr ctx = {}) = 0;
1037 
1039  virtual AsyncResult * getNoteApplicationDataAsync(
1040  Guid guid,
1041  IRequestContextPtr ctx = {}) = 0;
1042 
1052  virtual QString getNoteApplicationDataEntry(
1053  Guid guid,
1054  QString key,
1055  IRequestContextPtr ctx = {}) = 0;
1056 
1058  virtual AsyncResult * getNoteApplicationDataEntryAsync(
1059  Guid guid,
1060  QString key,
1061  IRequestContextPtr ctx = {}) = 0;
1062 
1067  virtual qint32 setNoteApplicationDataEntry(
1068  Guid guid,
1069  QString key,
1070  QString value,
1071  IRequestContextPtr ctx = {}) = 0;
1072 
1074  virtual AsyncResult * setNoteApplicationDataEntryAsync(
1075  Guid guid,
1076  QString key,
1077  QString value,
1078  IRequestContextPtr ctx = {}) = 0;
1079 
1085  virtual qint32 unsetNoteApplicationDataEntry(
1086  Guid guid,
1087  QString key,
1088  IRequestContextPtr ctx = {}) = 0;
1089 
1091  virtual AsyncResult * unsetNoteApplicationDataEntryAsync(
1092  Guid guid,
1093  QString key,
1094  IRequestContextPtr ctx = {}) = 0;
1095 
1116  virtual QString getNoteContent(
1117  Guid guid,
1118  IRequestContextPtr ctx = {}) = 0;
1119 
1121  virtual AsyncResult * getNoteContentAsync(
1122  Guid guid,
1123  IRequestContextPtr ctx = {}) = 0;
1124 
1159  virtual QString getNoteSearchText(
1160  Guid guid,
1161  bool noteOnly,
1162  bool tokenizeForIndexing,
1163  IRequestContextPtr ctx = {}) = 0;
1164 
1166  virtual AsyncResult * getNoteSearchTextAsync(
1167  Guid guid,
1168  bool noteOnly,
1169  bool tokenizeForIndexing,
1170  IRequestContextPtr ctx = {}) = 0;
1171 
1196  virtual QString getResourceSearchText(
1197  Guid guid,
1198  IRequestContextPtr ctx = {}) = 0;
1199 
1201  virtual AsyncResult * getResourceSearchTextAsync(
1202  Guid guid,
1203  IRequestContextPtr ctx = {}) = 0;
1204 
1223  virtual QStringList getNoteTagNames(
1224  Guid guid,
1225  IRequestContextPtr ctx = {}) = 0;
1226 
1228  virtual AsyncResult * getNoteTagNamesAsync(
1229  Guid guid,
1230  IRequestContextPtr ctx = {}) = 0;
1231 
1295  virtual Note createNote(
1296  const Note & note,
1297  IRequestContextPtr ctx = {}) = 0;
1298 
1300  virtual AsyncResult * createNoteAsync(
1301  const Note & note,
1302  IRequestContextPtr ctx = {}) = 0;
1303 
1375  virtual Note updateNote(
1376  const Note & note,
1377  IRequestContextPtr ctx = {}) = 0;
1378 
1380  virtual AsyncResult * updateNoteAsync(
1381  const Note & note,
1382  IRequestContextPtr ctx = {}) = 0;
1383 
1410  virtual qint32 deleteNote(
1411  Guid guid,
1412  IRequestContextPtr ctx = {}) = 0;
1413 
1415  virtual AsyncResult * deleteNoteAsync(
1416  Guid guid,
1417  IRequestContextPtr ctx = {}) = 0;
1418 
1443  virtual qint32 expungeNote(
1444  Guid guid,
1445  IRequestContextPtr ctx = {}) = 0;
1446 
1448  virtual AsyncResult * expungeNoteAsync(
1449  Guid guid,
1450  IRequestContextPtr ctx = {}) = 0;
1451 
1494  virtual Note copyNote(
1495  Guid noteGuid,
1496  Guid toNotebookGuid,
1497  IRequestContextPtr ctx = {}) = 0;
1498 
1500  virtual AsyncResult * copyNoteAsync(
1501  Guid noteGuid,
1502  Guid toNotebookGuid,
1503  IRequestContextPtr ctx = {}) = 0;
1504 
1527  virtual QList<NoteVersionId> listNoteVersions(
1528  Guid noteGuid,
1529  IRequestContextPtr ctx = {}) = 0;
1530 
1532  virtual AsyncResult * listNoteVersionsAsync(
1533  Guid noteGuid,
1534  IRequestContextPtr ctx = {}) = 0;
1535 
1579  virtual Note getNoteVersion(
1580  Guid noteGuid,
1581  qint32 updateSequenceNum,
1582  bool withResourcesData,
1583  bool withResourcesRecognition,
1584  bool withResourcesAlternateData,
1585  IRequestContextPtr ctx = {}) = 0;
1586 
1588  virtual AsyncResult * getNoteVersionAsync(
1589  Guid noteGuid,
1590  qint32 updateSequenceNum,
1591  bool withResourcesData,
1592  bool withResourcesRecognition,
1593  bool withResourcesAlternateData,
1594  IRequestContextPtr ctx = {}) = 0;
1595 
1633  virtual Resource getResource(
1634  Guid guid,
1635  bool withData,
1636  bool withRecognition,
1637  bool withAttributes,
1638  bool withAlternateData,
1639  IRequestContextPtr ctx = {}) = 0;
1640 
1642  virtual AsyncResult * getResourceAsync(
1643  Guid guid,
1644  bool withData,
1645  bool withRecognition,
1646  bool withAttributes,
1647  bool withAlternateData,
1648  IRequestContextPtr ctx = {}) = 0;
1649 
1658  virtual LazyMap getResourceApplicationData(
1659  Guid guid,
1660  IRequestContextPtr ctx = {}) = 0;
1661 
1663  virtual AsyncResult * getResourceApplicationDataAsync(
1664  Guid guid,
1665  IRequestContextPtr ctx = {}) = 0;
1666 
1676  virtual QString getResourceApplicationDataEntry(
1677  Guid guid,
1678  QString key,
1679  IRequestContextPtr ctx = {}) = 0;
1680 
1682  virtual AsyncResult * getResourceApplicationDataEntryAsync(
1683  Guid guid,
1684  QString key,
1685  IRequestContextPtr ctx = {}) = 0;
1686 
1691  virtual qint32 setResourceApplicationDataEntry(
1692  Guid guid,
1693  QString key,
1694  QString value,
1695  IRequestContextPtr ctx = {}) = 0;
1696 
1698  virtual AsyncResult * setResourceApplicationDataEntryAsync(
1699  Guid guid,
1700  QString key,
1701  QString value,
1702  IRequestContextPtr ctx = {}) = 0;
1703 
1708  virtual qint32 unsetResourceApplicationDataEntry(
1709  Guid guid,
1710  QString key,
1711  IRequestContextPtr ctx = {}) = 0;
1712 
1714  virtual AsyncResult * unsetResourceApplicationDataEntryAsync(
1715  Guid guid,
1716  QString key,
1717  IRequestContextPtr ctx = {}) = 0;
1718 
1768  virtual qint32 updateResource(
1769  const Resource & resource,
1770  IRequestContextPtr ctx = {}) = 0;
1771 
1773  virtual AsyncResult * updateResourceAsync(
1774  const Resource & resource,
1775  IRequestContextPtr ctx = {}) = 0;
1776 
1799  virtual QByteArray getResourceData(
1800  Guid guid,
1801  IRequestContextPtr ctx = {}) = 0;
1802 
1804  virtual AsyncResult * getResourceDataAsync(
1805  Guid guid,
1806  IRequestContextPtr ctx = {}) = 0;
1807 
1849  virtual Resource getResourceByHash(
1850  Guid noteGuid,
1851  QByteArray contentHash,
1852  bool withData,
1853  bool withRecognition,
1854  bool withAlternateData,
1855  IRequestContextPtr ctx = {}) = 0;
1856 
1858  virtual AsyncResult * getResourceByHashAsync(
1859  Guid noteGuid,
1860  QByteArray contentHash,
1861  bool withData,
1862  bool withRecognition,
1863  bool withAlternateData,
1864  IRequestContextPtr ctx = {}) = 0;
1865 
1890  virtual QByteArray getResourceRecognition(
1891  Guid guid,
1892  IRequestContextPtr ctx = {}) = 0;
1893 
1895  virtual AsyncResult * getResourceRecognitionAsync(
1896  Guid guid,
1897  IRequestContextPtr ctx = {}) = 0;
1898 
1923  virtual QByteArray getResourceAlternateData(
1924  Guid guid,
1925  IRequestContextPtr ctx = {}) = 0;
1926 
1928  virtual AsyncResult * getResourceAlternateDataAsync(
1929  Guid guid,
1930  IRequestContextPtr ctx = {}) = 0;
1931 
1952  virtual ResourceAttributes getResourceAttributes(
1953  Guid guid,
1954  IRequestContextPtr ctx = {}) = 0;
1955 
1957  virtual AsyncResult * getResourceAttributesAsync(
1958  Guid guid,
1959  IRequestContextPtr ctx = {}) = 0;
1960 
1995  virtual Notebook getPublicNotebook(
1996  UserID userId,
1997  QString publicUri,
1998  IRequestContextPtr ctx = {}) = 0;
1999 
2001  virtual AsyncResult * getPublicNotebookAsync(
2002  UserID userId,
2003  QString publicUri,
2004  IRequestContextPtr ctx = {}) = 0;
2005 
2083  virtual SharedNotebook shareNotebook(
2084  const SharedNotebook & sharedNotebook,
2085  QString message,
2086  IRequestContextPtr ctx = {}) = 0;
2087 
2089  virtual AsyncResult * shareNotebookAsync(
2090  const SharedNotebook & sharedNotebook,
2091  QString message,
2092  IRequestContextPtr ctx = {}) = 0;
2093 
2148  virtual CreateOrUpdateNotebookSharesResult createOrUpdateNotebookShares(
2149  const NotebookShareTemplate & shareTemplate,
2150  IRequestContextPtr ctx = {}) = 0;
2151 
2153  virtual AsyncResult * createOrUpdateNotebookSharesAsync(
2154  const NotebookShareTemplate & shareTemplate,
2155  IRequestContextPtr ctx = {}) = 0;
2156 
2160  virtual qint32 updateSharedNotebook(
2161  const SharedNotebook & sharedNotebook,
2162  IRequestContextPtr ctx = {}) = 0;
2163 
2165  virtual AsyncResult * updateSharedNotebookAsync(
2166  const SharedNotebook & sharedNotebook,
2167  IRequestContextPtr ctx = {}) = 0;
2168 
2205  virtual Notebook setNotebookRecipientSettings(
2206  QString notebookGuid,
2207  const NotebookRecipientSettings & recipientSettings,
2208  IRequestContextPtr ctx = {}) = 0;
2209 
2211  virtual AsyncResult * setNotebookRecipientSettingsAsync(
2212  QString notebookGuid,
2213  const NotebookRecipientSettings & recipientSettings,
2214  IRequestContextPtr ctx = {}) = 0;
2215 
2223  virtual QList<SharedNotebook> listSharedNotebooks(
2224  IRequestContextPtr ctx = {}) = 0;
2225 
2227  virtual AsyncResult * listSharedNotebooksAsync(
2228  IRequestContextPtr ctx = {}) = 0;
2229 
2267  virtual LinkedNotebook createLinkedNotebook(
2268  const LinkedNotebook & linkedNotebook,
2269  IRequestContextPtr ctx = {}) = 0;
2270 
2272  virtual AsyncResult * createLinkedNotebookAsync(
2273  const LinkedNotebook & linkedNotebook,
2274  IRequestContextPtr ctx = {}) = 0;
2275 
2292  virtual qint32 updateLinkedNotebook(
2293  const LinkedNotebook & linkedNotebook,
2294  IRequestContextPtr ctx = {}) = 0;
2295 
2297  virtual AsyncResult * updateLinkedNotebookAsync(
2298  const LinkedNotebook & linkedNotebook,
2299  IRequestContextPtr ctx = {}) = 0;
2300 
2304  virtual QList<LinkedNotebook> listLinkedNotebooks(
2305  IRequestContextPtr ctx = {}) = 0;
2306 
2308  virtual AsyncResult * listLinkedNotebooksAsync(
2309  IRequestContextPtr ctx = {}) = 0;
2310 
2322  virtual qint32 expungeLinkedNotebook(
2323  Guid guid,
2324  IRequestContextPtr ctx = {}) = 0;
2325 
2327  virtual AsyncResult * expungeLinkedNotebookAsync(
2328  Guid guid,
2329  IRequestContextPtr ctx = {}) = 0;
2330 
2381  virtual AuthenticationResult authenticateToSharedNotebook(
2382  QString shareKeyOrGlobalId,
2383  IRequestContextPtr ctx = {}) = 0;
2384 
2386  virtual AsyncResult * authenticateToSharedNotebookAsync(
2387  QString shareKeyOrGlobalId,
2388  IRequestContextPtr ctx = {}) = 0;
2389 
2415  virtual SharedNotebook getSharedNotebookByAuth(
2416  IRequestContextPtr ctx = {}) = 0;
2417 
2419  virtual AsyncResult * getSharedNotebookByAuthAsync(
2420  IRequestContextPtr ctx = {}) = 0;
2421 
2471  virtual void emailNote(
2472  const NoteEmailParameters & parameters,
2473  IRequestContextPtr ctx = {}) = 0;
2474 
2476  virtual AsyncResult * emailNoteAsync(
2477  const NoteEmailParameters & parameters,
2478  IRequestContextPtr ctx = {}) = 0;
2479 
2503  virtual QString shareNote(
2504  Guid guid,
2505  IRequestContextPtr ctx = {}) = 0;
2506 
2508  virtual AsyncResult * shareNoteAsync(
2509  Guid guid,
2510  IRequestContextPtr ctx = {}) = 0;
2511 
2534  virtual void stopSharingNote(
2535  Guid guid,
2536  IRequestContextPtr ctx = {}) = 0;
2537 
2539  virtual AsyncResult * stopSharingNoteAsync(
2540  Guid guid,
2541  IRequestContextPtr ctx = {}) = 0;
2542 
2585  virtual AuthenticationResult authenticateToSharedNote(
2586  QString guid,
2587  QString noteKey,
2588  IRequestContextPtr ctx = {}) = 0;
2589 
2591  virtual AsyncResult * authenticateToSharedNoteAsync(
2592  QString guid,
2593  QString noteKey,
2594  IRequestContextPtr ctx = {}) = 0;
2595 
2645  virtual RelatedResult findRelated(
2646  const RelatedQuery & query,
2647  const RelatedResultSpec & resultSpec,
2648  IRequestContextPtr ctx = {}) = 0;
2649 
2651  virtual AsyncResult * findRelatedAsync(
2652  const RelatedQuery & query,
2653  const RelatedResultSpec & resultSpec,
2654  IRequestContextPtr ctx = {}) = 0;
2655 
2683  virtual UpdateNoteIfUsnMatchesResult updateNoteIfUsnMatches(
2684  const Note & note,
2685  IRequestContextPtr ctx = {}) = 0;
2686 
2688  virtual AsyncResult * updateNoteIfUsnMatchesAsync(
2689  const Note & note,
2690  IRequestContextPtr ctx = {}) = 0;
2691 
2708  virtual ManageNotebookSharesResult manageNotebookShares(
2709  const ManageNotebookSharesParameters & parameters,
2710  IRequestContextPtr ctx = {}) = 0;
2711 
2713  virtual AsyncResult * manageNotebookSharesAsync(
2714  const ManageNotebookSharesParameters & parameters,
2715  IRequestContextPtr ctx = {}) = 0;
2716 
2725  virtual ShareRelationships getNotebookShares(
2726  QString notebookGuid,
2727  IRequestContextPtr ctx = {}) = 0;
2728 
2730  virtual AsyncResult * getNotebookSharesAsync(
2731  QString notebookGuid,
2732  IRequestContextPtr ctx = {}) = 0;
2733 
2734 };
2735 
2736 using INoteStorePtr = std::shared_ptr<INoteStore>;
2737 
2739 
2759 class QEVERCLOUD_EXPORT IUserStore: public QObject
2760 {
2761  Q_OBJECT
2762  Q_DISABLE_COPY(IUserStore)
2763 protected:
2764  IUserStore(QObject * parent) :
2765  QObject(parent)
2766  {}
2767 
2768 public:
2769  virtual QString userStoreUrl() const = 0;
2770  virtual void setUserStoreUrl(QString url) = 0;
2771 
2798  virtual bool checkVersion(
2799  QString clientName,
2800  qint16 edamVersionMajor = EDAM_VERSION_MAJOR,
2801  qint16 edamVersionMinor = EDAM_VERSION_MINOR,
2802  IRequestContextPtr ctx = {}) = 0;
2803 
2805  virtual AsyncResult * checkVersionAsync(
2806  QString clientName,
2807  qint16 edamVersionMajor = EDAM_VERSION_MAJOR,
2808  qint16 edamVersionMinor = EDAM_VERSION_MINOR,
2809  IRequestContextPtr ctx = {}) = 0;
2810 
2823  virtual BootstrapInfo getBootstrapInfo(
2824  QString locale,
2825  IRequestContextPtr ctx = {}) = 0;
2826 
2828  virtual AsyncResult * getBootstrapInfoAsync(
2829  QString locale,
2830  IRequestContextPtr ctx = {}) = 0;
2831 
2918  virtual AuthenticationResult authenticateLongSession(
2919  QString username,
2920  QString password,
2921  QString consumerKey,
2922  QString consumerSecret,
2923  QString deviceIdentifier,
2924  QString deviceDescription,
2925  bool supportsTwoFactor,
2926  IRequestContextPtr ctx = {}) = 0;
2927 
2929  virtual AsyncResult * authenticateLongSessionAsync(
2930  QString username,
2931  QString password,
2932  QString consumerKey,
2933  QString consumerSecret,
2934  QString deviceIdentifier,
2935  QString deviceDescription,
2936  bool supportsTwoFactor,
2937  IRequestContextPtr ctx = {}) = 0;
2938 
2977  virtual AuthenticationResult completeTwoFactorAuthentication(
2978  QString oneTimeCode,
2979  QString deviceIdentifier,
2980  QString deviceDescription,
2981  IRequestContextPtr ctx = {}) = 0;
2982 
2984  virtual AsyncResult * completeTwoFactorAuthenticationAsync(
2985  QString oneTimeCode,
2986  QString deviceIdentifier,
2987  QString deviceDescription,
2988  IRequestContextPtr ctx = {}) = 0;
2989 
3008  virtual void revokeLongSession(
3009  IRequestContextPtr ctx = {}) = 0;
3010 
3012  virtual AsyncResult * revokeLongSessionAsync(
3013  IRequestContextPtr ctx = {}) = 0;
3014 
3048  virtual AuthenticationResult authenticateToBusiness(
3049  IRequestContextPtr ctx = {}) = 0;
3050 
3052  virtual AsyncResult * authenticateToBusinessAsync(
3053  IRequestContextPtr ctx = {}) = 0;
3054 
3062  virtual User getUser(
3063  IRequestContextPtr ctx = {}) = 0;
3064 
3066  virtual AsyncResult * getUserAsync(
3067  IRequestContextPtr ctx = {}) = 0;
3068 
3077  virtual PublicUserInfo getPublicUserInfo(
3078  QString username,
3079  IRequestContextPtr ctx = {}) = 0;
3080 
3082  virtual AsyncResult * getPublicUserInfoAsync(
3083  QString username,
3084  IRequestContextPtr ctx = {}) = 0;
3085 
3095  virtual UserUrls getUserUrls(
3096  IRequestContextPtr ctx = {}) = 0;
3097 
3099  virtual AsyncResult * getUserUrlsAsync(
3100  IRequestContextPtr ctx = {}) = 0;
3101 
3145  virtual void inviteToBusiness(
3146  QString emailAddress,
3147  IRequestContextPtr ctx = {}) = 0;
3148 
3150  virtual AsyncResult * inviteToBusinessAsync(
3151  QString emailAddress,
3152  IRequestContextPtr ctx = {}) = 0;
3153 
3178  virtual void removeFromBusiness(
3179  QString emailAddress,
3180  IRequestContextPtr ctx = {}) = 0;
3181 
3183  virtual AsyncResult * removeFromBusinessAsync(
3184  QString emailAddress,
3185  IRequestContextPtr ctx = {}) = 0;
3186 
3229  virtual void updateBusinessUserIdentifier(
3230  QString oldEmailAddress,
3231  QString newEmailAddress,
3232  IRequestContextPtr ctx = {}) = 0;
3233 
3235  virtual AsyncResult * updateBusinessUserIdentifierAsync(
3236  QString oldEmailAddress,
3237  QString newEmailAddress,
3238  IRequestContextPtr ctx = {}) = 0;
3239 
3258  virtual QList<UserProfile> listBusinessUsers(
3259  IRequestContextPtr ctx = {}) = 0;
3260 
3262  virtual AsyncResult * listBusinessUsersAsync(
3263  IRequestContextPtr ctx = {}) = 0;
3264 
3279  virtual QList<BusinessInvitation> listBusinessInvitations(
3280  bool includeRequestedInvitations,
3281  IRequestContextPtr ctx = {}) = 0;
3282 
3284  virtual AsyncResult * listBusinessInvitationsAsync(
3285  bool includeRequestedInvitations,
3286  IRequestContextPtr ctx = {}) = 0;
3287 
3298  virtual AccountLimits getAccountLimits(
3299  ServiceLevel serviceLevel,
3300  IRequestContextPtr ctx = {}) = 0;
3301 
3303  virtual AsyncResult * getAccountLimitsAsync(
3304  ServiceLevel serviceLevel,
3305  IRequestContextPtr ctx = {}) = 0;
3306 
3307 };
3308 
3309 using IUserStorePtr = std::shared_ptr<IUserStore>;
3310 
3312 
3314  QString noteStoreUrl = {},
3315  IRequestContextPtr ctx = {},
3316  QObject * parent = nullptr,
3317  IRetryPolicyPtr retryPolicy = {});
3318 
3319 QEVERCLOUD_EXPORT IUserStore * newUserStore(
3320  QString userStoreUrl = {},
3321  IRequestContextPtr ctx = {},
3322  QObject * parent = nullptr,
3323  IRetryPolicyPtr retryPolicy = {});
3324 
3325 } // namespace qevercloud
3326 
3327 Q_DECLARE_METATYPE(QList<qevercloud::Notebook>)
3328 Q_DECLARE_METATYPE(QList<qevercloud::Tag>)
3329 Q_DECLARE_METATYPE(QList<qevercloud::SavedSearch>)
3330 Q_DECLARE_METATYPE(QList<qevercloud::NoteVersionId>)
3331 Q_DECLARE_METATYPE(QList<qevercloud::SharedNotebook>)
3332 Q_DECLARE_METATYPE(QList<qevercloud::LinkedNotebook>)
3333 Q_DECLARE_METATYPE(QList<qevercloud::BusinessInvitation>)
3334 Q_DECLARE_METATYPE(QList<qevercloud::UserProfile>)
3335 
3336 #endif // QEVERCLOUD_GENERATED_SERVICES_H
INoteStore(QObject *parent)
Definition: Services.h:60
std::shared_ptr< IRetryPolicy > IRetryPolicyPtr
Definition: DurableService.h:32
Definition: Types.h:165
QEVERCLOUD_EXPORT const qint16 EDAM_VERSION_MAJOR
QString Guid
Definition: Types.h:62
Definition: Services.h:55
std::shared_ptr< IUserStore > IUserStorePtr
Definition: Services.h:3309
qint32 UserID
Definition: Types.h:50
QEVERCLOUD_EXPORT const qint16 EDAM_VERSION_MINOR
QEVERCLOUD_EXPORT INoteStore * newNoteStore(QString noteStoreUrl={}, IRequestContextPtr ctx={}, QObject *parent=nullptr, IRetryPolicyPtr retryPolicy={})
IUserStore(QObject *parent)
Definition: Services.h:2764
#define QEVERCLOUD_EXPORT
Definition: Export.h:19
Definition: AsyncResult.h:21
std::shared_ptr< INoteStore > INoteStorePtr
Definition: Services.h:2736
QEVERCLOUD_EXPORT IUserStore * newUserStore(QString userStoreUrl={}, IRequestContextPtr ctx={}, QObject *parent=nullptr, IRetryPolicyPtr retryPolicy={})
Definition: Services.h:2759
ServiceLevel
Definition: EDAMErrorCode.h:325
std::shared_ptr< IRequestContext > IRequestContextPtr
Definition: RequestContext.h:81