Agora C++ API Reference for All Platforms
|
8 #pragma once // NOLINT(build/header_guard)
9 #include "AgoraRefPtr.h"
10 #include "AgoraBase.h"
12 #include <api/aosl_ref.h>
62 virtual void onCollectionEvent(
const char* previousJson,
const char* curJson,
const char* collection,
const char* docName,
65 virtual void onDataException(
const char* databaseName,
const char* collectionName) = 0;
91 virtual int32_t
login(
const char* token,
const char* channelName,
user_id_t userId,
syncClientCallback callback,
void* userData, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
92 virtual int32_t
queryDoc(
const char* database,
const char* coll,
const char* range_start,
const char* range_end, int64_t limits,
bool doc_only,
bool count_only,
queryDocCallback callback,
void* userData, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
93 virtual int32_t
logout(aosl_ref_t ares = AOSL_REF_INVALID) = 0;
94 virtual int32_t
renewToken(
const char* token, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
101 const char** readable,
int readSize,
107 virtual int32_t
subscribe(
const char* database,
const char* collection,
109 virtual int32_t
unsubscribe(
const char* database,
const char* collection, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
110 virtual int32_t
putDoc(
const char* database,
const char* collection,
111 const char* docName, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
112 virtual int32_t
deleteDoc(
const char* database,
const char* collection,
113 const char* docName, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
114 virtual int32_t
getDocs(
const char* database,
const char* collection,
118 virtual int32_t
putDocValue(
const char* database,
const char* collection,
119 const char* docName,
const char* jsonValue, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
121 const char* docName,
const char* path,
122 const char* jsonValue, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
124 const char* docName,
const char* path, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
125 virtual int32_t
deleteDocValues(
const char* database,
const char* collection,
const char* docName,
126 const char** path, uint32_t pathSize,
127 aosl_ref_t ares = AOSL_REF_INVALID) = 0;
128 virtual int32_t
getDocValue(
const char* database,
const char* collection,
130 virtual int32_t
hasPath(
const char* database,
const char* collection,
131 const char* docName,
const char* path,
bool& result) = 0;
132 virtual int32_t
keepAliveDoc(
const char* database,
const char* collection,
133 const char* docName, uint32_t ttl, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
136 virtual int32_t
shakehand(aosl_ref_t ares = AOSL_REF_INVALID) = 0;
virtual int32_t getDocValue(const char *database, const char *collection, const char *docName, util::AString &jsonValue)=0
virtual int32_t putDocValue(const char *database, const char *collection, const char *docName, const char *jsonValue, aosl_ref_t ares=AOSL_REF_INVALID)=0
virtual int32_t logout(aosl_ref_t ares=AOSL_REF_INVALID)=0
void(* syncClientCallback)(SyncClientError, void *)
Definition: NGIAgoraSyncClient.h:33
@ kQueryDocFailed
Definition: NGIAgoraSyncClient.h:29
@ kCollectionNotCreated
Definition: NGIAgoraSyncClient.h:25
void(* queryDocCallback)(SyncClientError error, const char *resultJson, size_t count, bool more, void *userData)
Definition: NGIAgoraSyncClient.h:36
@ kDocSyncEnd
Definition: NGIAgoraSyncClient.h:49
SyncEventType
Definition: NGIAgoraSyncClient.h:38
@ kDisconnectDatabaseFailed
Definition: NGIAgoraSyncClient.h:22
virtual int32_t unsubscribe(const char *database, const char *collection, aosl_ref_t ares=AOSL_REF_INVALID)=0
virtual int32_t deleteDocValues(const char *database, const char *collection, const char *docName, const char **path, uint32_t pathSize, aosl_ref_t ares=AOSL_REF_INVALID)=0
@ kConnectSyncFailed
Definition: NGIAgoraSyncClient.h:20
void(* dataBaseOpCallback)(SyncClientError, const char *, void *)
Definition: NGIAgoraSyncClient.h:34
const char * user_id_t
Definition: AgoraBase.h:806
virtual int32_t getDocs(const char *database, const char *collection, util::AString *docNames, uint32_t docSize)=0
virtual ~ISyncClient()
Definition: NGIAgoraSyncClient.h:85
@ kTransactionBegin
Definition: NGIAgoraSyncClient.h:47
virtual int32_t putDoc(const char *database, const char *collection, const char *docName, aosl_ref_t ares=AOSL_REF_INVALID)=0
virtual ~ISyncClientObserver()
Definition: NGIAgoraSyncClient.h:66
uint32_t shakehand_interval
Definition: NGIAgoraSyncClient.h:75
@ kInvalidParams
Definition: NGIAgoraSyncClient.h:27
Definition: AgoraAtomicOps.h:21
@ kDatabaseNotConnected
Definition: NGIAgoraSyncClient.h:23
virtual void onCollectionEvent(const char *previousJson, const char *curJson, const char *collection, const char *docName, const CollectionEvent *events, int eventSize)=0
uint32_t compact_interval
Definition: NGIAgoraSyncClient.h:79
virtual int32_t queryDoc(const char *database, const char *coll, const char *range_start, const char *range_end, int64_t limits, bool doc_only, bool count_only, queryDocCallback callback, void *userData, aosl_ref_t ares=AOSL_REF_INVALID)=0
Definition: NGIAgoraSyncClient.h:55
const char * appId
Definition: NGIAgoraSyncClient.h:73
virtual int32_t deleteDoc(const char *database, const char *collection, const char *docName, aosl_ref_t ares=AOSL_REF_INVALID)=0
@ kToBePut
Definition: NGIAgoraSyncClient.h:44
@ kCollectionExisted
Definition: NGIAgoraSyncClient.h:26
@ kTransactionEnd
Definition: NGIAgoraSyncClient.h:48
Definition: NGIAgoraSyncClient.h:72
virtual int32_t hasPath(const char *database, const char *collection, const char *docName, const char *path, bool &result)=0
@ kToBeDeleted
Definition: NGIAgoraSyncClient.h:45
@ kOk
Definition: NGIAgoraSyncClient.h:18
virtual int32_t registerSyncClientObserver(ISyncClientObserver *observer, void(*safeDeleter)(ISyncClientObserver *)=OPTIONAL_NULLPTR, aosl_ref_t ares=AOSL_REF_INVALID)=0
void(* collectionOpCallback)(SyncClientError, const char *, const char *, void *)
Definition: NGIAgoraSyncClient.h:35
SyncClientError
Definition: NGIAgoraSyncClient.h:17
const char * path
Definition: NGIAgoraSyncClient.h:59
virtual int32_t shakehand(aosl_ref_t ares=AOSL_REF_INVALID)=0
@ kCreateCollectionFailed
Definition: NGIAgoraSyncClient.h:24
@ kConnectDatabaseFailed
Definition: NGIAgoraSyncClient.h:21
Definition: NGIAgoraSyncClient.h:57
virtual int32_t disconnectDatabase(const char *database, dataBaseOpCallback callback, void *userData, aosl_ref_t ares=AOSL_REF_INVALID)=0
SyncEventType type
Definition: NGIAgoraSyncClient.h:58
@ kFail
Definition: NGIAgoraSyncClient.h:19
@ kPut
Definition: NGIAgoraSyncClient.h:40
virtual void onDatabaseEvent(const char *databaseName, SyncClientError error)=0
virtual int32_t deleteCollection(const char *database, const char *collection, collectionOpCallback callback, void *userData, aosl_ref_t ares=AOSL_REF_INVALID)=0
virtual int32_t subscribe(const char *database, const char *collection, util::AString &snapshotJson)=0
uint32_t connection_timeout
Definition: NGIAgoraSyncClient.h:77
virtual int32_t keepAliveDoc(const char *database, const char *collection, const char *docName, uint32_t ttl, aosl_ref_t ares=AOSL_REF_INVALID)=0
@ kToBeInserted
Definition: NGIAgoraSyncClient.h:43
SyncConfig()
Definition: NGIAgoraSyncClient.h:80
const char * value
Definition: NGIAgoraSyncClient.h:60
Definition: AgoraRefPtr.h:31
virtual int32_t unregisterSyncClientObserver(ISyncClientObserver *observer)=0
@ kDeleted
Definition: NGIAgoraSyncClient.h:41
virtual void onDataException(const char *databaseName, const char *collectionName)=0
virtual int32_t login(const char *token, const char *channelName, user_id_t userId, syncClientCallback callback, void *userData, aosl_ref_t ares=AOSL_REF_INVALID)=0
@ kNotLoggedIn
Definition: NGIAgoraSyncClient.h:28
Definition: AgoraBase.h:156
virtual int32_t createCollection(const char *database, const char *collection, const char **readable, int readSize, collectionOpCallback callback, void *userData, aosl_ref_t ares=AOSL_REF_INVALID)=0
@ kDocNotCreated
Definition: NGIAgoraSyncClient.h:30
Definition: NGIAgoraSyncClient.h:83
virtual int32_t connectDatabase(const char *database, dataBaseOpCallback callback, void *userData, aosl_ref_t ares=AOSL_REF_INVALID)=0
virtual int32_t renewToken(const char *token, aosl_ref_t ares=AOSL_REF_INVALID)=0
virtual int32_t updateDocValue(const char *database, const char *collection, const char *docName, const char *path, const char *jsonValue, aosl_ref_t ares=AOSL_REF_INVALID)=0
virtual int32_t deleteDocValue(const char *database, const char *collection, const char *docName, const char *path, aosl_ref_t ares=AOSL_REF_INVALID)=0
@ kInserted
Definition: NGIAgoraSyncClient.h:39