diff options
author | Christian Mollekopf <chrigi_1@fastmail.fm> | 2015-12-28 13:52:46 +0100 |
---|---|---|
committer | Christian Mollekopf <chrigi_1@fastmail.fm> | 2015-12-28 13:52:46 +0100 |
commit | 296a5ac347dbccfff44d2b2a0a378e98b0480cac (patch) | |
tree | 2b27aa44b37752dd568a17ce43389ef10845d42b /docs/clientapi.md | |
parent | d2654f78a4f7e87b44e296477e4d90646c967670 (diff) | |
download | sink-296a5ac347dbccfff44d2b2a0a378e98b0480cac.tar.gz sink-296a5ac347dbccfff44d2b2a0a378e98b0480cac.zip |
Docs
Diffstat (limited to 'docs/clientapi.md')
-rw-r--r-- | docs/clientapi.md | 3 |
1 files changed, 3 insertions, 0 deletions
diff --git a/docs/clientapi.md b/docs/clientapi.md index e0c66fb..219f972 100644 --- a/docs/clientapi.md +++ b/docs/clientapi.md | |||
@@ -17,6 +17,7 @@ The client API consists of: | |||
17 | A set of standardized domain types is defined. This is necessary to decouple applications from resources (so a calendar can access events from all resources), and to have a "language" for queries. | 17 | A set of standardized domain types is defined. This is necessary to decouple applications from resources (so a calendar can access events from all resources), and to have a "language" for queries. |
18 | 18 | ||
19 | The definition of the domain model directly affects: | 19 | The definition of the domain model directly affects: |
20 | |||
20 | * granularity for data retrieval (email property, or individual subject, date, ...) | 21 | * granularity for data retrieval (email property, or individual subject, date, ...) |
21 | * queriable properties for filtering and sorting (sender, id, ...) | 22 | * queriable properties for filtering and sorting (sender, id, ...) |
22 | 23 | ||
@@ -24,6 +25,7 @@ The purpose of these domain types is strictly to be the interface and the types | |||
24 | 25 | ||
25 | ## Store Facade | 26 | ## Store Facade |
26 | The store is always accessed through a store specific facade, which hides: | 27 | The store is always accessed through a store specific facade, which hides: |
28 | |||
27 | * store access (one store could use a database, and another one plain files) | 29 | * store access (one store could use a database, and another one plain files) |
28 | * message type (flatbuffers, ...) | 30 | * message type (flatbuffers, ...) |
29 | * indexes | 31 | * indexes |
@@ -69,6 +71,7 @@ Queries can be kept open (live) to receive updates as the store changes. | |||
69 | 71 | ||
70 | ### Query | 72 | ### Query |
71 | The query consists of: | 73 | The query consists of: |
74 | |||
72 | * a set of filters to match the wanted entities | 75 | * a set of filters to match the wanted entities |
73 | * the set of properties to retrieve for each entity | 76 | * the set of properties to retrieve for each entity |
74 | 77 | ||