diff options
author | Christian Mollekopf <chrigi_1@fastmail.fm> | 2016-01-20 19:07:38 +0100 |
---|---|---|
committer | Christian Mollekopf <chrigi_1@fastmail.fm> | 2016-01-20 19:07:38 +0100 |
commit | 944d1f728cb1612daa51aa2c550c0bcb67166852 (patch) | |
tree | f0a52d10dfbb855da0b1db17f820b4a73bfa8e40 /docs/applicationdomaintypes.md | |
parent | bdb01c2c068df326f5a8328ed1492ab1bea388c5 (diff) | |
download | sink-944d1f728cb1612daa51aa2c550c0bcb67166852.tar.gz sink-944d1f728cb1612daa51aa2c550c0bcb67166852.zip |
Use Sink in docs.
Diffstat (limited to 'docs/applicationdomaintypes.md')
-rw-r--r-- | docs/applicationdomaintypes.md | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/docs/applicationdomaintypes.md b/docs/applicationdomaintypes.md index 4baf317..798fa13 100644 --- a/docs/applicationdomaintypes.md +++ b/docs/applicationdomaintypes.md | |||
@@ -22,7 +22,7 @@ This is a proposed set of types that we will need to evolve into what we actuall | |||
22 | 22 | ||
23 | * Contact | 23 | * Contact |
24 | * Collection | 24 | * Collection |
25 | * Akonadi Resource | 25 | * Sink Resource |
26 | * Mail Folder | 26 | * Mail Folder |
27 | * Calendar | 27 | * Calendar |
28 | * Todolist | 28 | * Todolist |
@@ -32,19 +32,19 @@ This is a proposed set of types that we will need to evolve into what we actuall | |||
32 | * Tag | 32 | * Tag |
33 | * Contact Group | 33 | * Contact Group |
34 | * Thread | 34 | * Thread |
35 | * Akonadi Resource | 35 | * Sink Resource |
36 | * Maildir Resource | 36 | * Maildir Resource |
37 | 37 | ||
38 | #### Properties | 38 | #### Properties |
39 | ```no-highlight | 39 | ```no-highlight |
40 | Entity: The smallest unit in the akonadi universe | 40 | Entity: The smallest unit in the sink universe |
41 | id: unique identifier in the akonadi storage. Not persistant over db recreations and can therefore only be referenced from within the akonadi database. | 41 | id: unique identifier in the sink storage. Not persistant over db recreations and can therefore only be referenced from within the sink database. |
42 | ``` | 42 | ``` |
43 | ```no-highlight | 43 | ```no-highlight |
44 | Domain Object: | 44 | Domain Object: |
45 | uid: unique identifier of the domain object. | 45 | uid: unique identifier of the domain object. |
46 | revision: revision of the entity | 46 | revision: revision of the entity |
47 | resource: reference to AkonadiResource:id of the parent resource. | 47 | resource: reference to SinkResource:id of the parent resource. |
48 | ``` | 48 | ``` |
49 | ```no-highlight | 49 | ```no-highlight |
50 | Event: | 50 | Event: |
@@ -61,7 +61,7 @@ Mail: | |||
61 | mimeMessage: A string containing the path to the mime message | 61 | mimeMessage: A string containing the path to the mime message |
62 | ``` | 62 | ``` |
63 | ```no-highlight | 63 | ```no-highlight |
64 | Akonadi Resource: | 64 | Sink Resource: |
65 | type: The type of the resource. | 65 | type: The type of the resource. |
66 | name: The name of the resource. | 66 | name: The name of the resource. |
67 | ``` | 67 | ``` |
@@ -75,7 +75,7 @@ Some domain objects reference others, and that is often used to build hierarchie | |||
75 | Examples are folder hierachies, tags, todo hierarchies, mail threads, contact groups, etc. | 75 | Examples are folder hierachies, tags, todo hierarchies, mail threads, contact groups, etc. |
76 | 76 | ||
77 | These references can be built on two levels: | 77 | These references can be built on two levels: |
78 | * On the akonadi entity level: The referenced object *must* be available in local storage, and we're only linking to that specific instance. If the referenced entity is removed, the reference breaks. The reference always only references a single akonadi entity. | 78 | * On the sink entity level: The referenced object *must* be available in local storage, and we're only linking to that specific instance. If the referenced entity is removed, the reference breaks. The reference always only references a single sink entity. |
79 | * On the domain object level: The reference can remain also if no object currently matches the reference. The reference automatically applies to new entities containing an object with the referenced uid. More than one entity can be matched if they contain the same domain object. | 79 | * On the domain object level: The reference can remain also if no object currently matches the reference. The reference automatically applies to new entities containing an object with the referenced uid. More than one entity can be matched if they contain the same domain object. |
80 | 80 | ||
81 | #### Examples | 81 | #### Examples |
@@ -84,7 +84,7 @@ The following hierachies exist among others: | |||
84 | * Parent Collection | 84 | * Parent Collection |
85 | * Given by the source (path of the folder in IMAP) | 85 | * Given by the source (path of the folder in IMAP) |
86 | * Parent folder "owns" the sub entity | 86 | * Parent folder "owns" the sub entity |
87 | * Link exists on the akonadi entity level: We specify where the entity lives, this MUST always be a single parent entity. | 87 | * Link exists on the sink entity level: We specify where the entity lives, this MUST always be a single parent entity. |
88 | * Subtodos | 88 | * Subtodos |
89 | * Given by the todo itself | 89 | * Given by the todo itself |
90 | * Not necessarly owning (though often implemented as such, similar to threading) | 90 | * Not necessarly owning (though often implemented as such, similar to threading) |