g2.4

help/Example.html

@@ -34,6 +34,7 @@ test<br>test<br>test<br>test<br>test<br>test<br>test<br>test<br>test<br>test<br>
 
 <script src="../auth.js"></script>
 <script src="../lib/basic.js"></script>
+<script src="../help/data_xample.js"></script>
 <script>
 
 showOverlay("overlay1");
@@ -42,16 +43,18 @@ showOverlay("overlay1");
 
 async function main() {
 	const couchDB = new CouchDB();
-	await couchDB.set("login", {
-		"username": "bla",
-		"password": "bla"
+	await couchDB.set("xample", {
+		"my_data": 1,
+		"more_data": "bla"
 	});
 
 	const data = await couchDB.get("login");
 	console.log(JSON.stringify(data));
 	//Gibt { "username": "bla", "password": "bla" } wieder
 }
+
 main();
+createTemp();
 
 </script>
 

help/data_xample.js

@@ -0,0 +1,82 @@
+async function createTemp() {
+	const couchDB = new CouchDB();
+	await couchDB.set("users", {
+		"turtle": {
+			"password": "1234",
+			"level": 1,
+			"avatar": null,
+			"abilities": [],
+			"role": "student",
+			"courses": [
+				"weiche_ware",
+				"bucket"
+			]
+		},
+		"dumble-door": {
+			"password": "bla",
+			"level": 10,
+			"avatar": "https://static.turtle-coding-gbr.de/profile-pic.png",
+			"abilities": [],
+			"role": "professor",
+			"courses": [
+				"weiche_ware"
+			]
+		},
+		"narrator": {
+			"password": "stanley",
+			"level": 100,
+			"avatar": "https://static.turtle-coding-gbr.de/st",
+			"abilities": [],
+			"role": "professor",
+			"courses": [
+				"bucket"
+			]
+		}
+	});
+	await couchDB.set("course:bucket", {
+		"title": "Bucket",
+		"description": "The end is never the end is never the end is never",
+		"owner": "narrator",
+		"questions": [
+			{
+				"title": "What is comedic timing?",
+				"type": "text"
+			},
+			{
+				"title": "How does it work?",
+				"type": "text"
+			},
+			{
+				"title": "How long should it last?",
+				"type": "scala"
+			},
+			{
+				"title": "How can it be used to effectively silence your political enemies?",
+				"type": "emoji"
+			}
+		],
+		"result": [
+			["YES", "YES", 5, 2],
+			["YES", "YES", 1, 3]
+		]
+	});
+	await couchDB.set("course:weiche_ware", {
+		"title": "Weiche Ware",
+		"description": "blabering",
+		"owner": "dumble-door",
+		"questions": [
+			{
+				"title": "Wie fanden Sie die Vorlesung?",
+				"type": "text"
+			},
+			{
+				"title": "Finden Sie, dass man Zauberei an lebendigen Schülern praktizieren sollte?",
+				"type": "scala"
+			}
+		],
+		"result": [
+			["Gut, aber ...", 5],
+			["Schlecht", 1]
+		]
+	});
+}

help/documentation.md

@@ -7,11 +7,15 @@
 ##Overlays
 
 ```
-//Erstelle ein element mit <overlay></overla> in html und vergebe eine id. Um das overlay anzuzeigen, rufe showOverlay mit der id auf
-function showOverlay(string id);
+//Erstelle ein element mit <overlay></overlay> in html und vergebe eine id. Um das overlay anzuzeigen, rufe showOverlay mit der id auf
+function showOverlay(string id) -> void;
 
 //Schließe das overlay mit der id
-function hideOverlay(string id);
+function hideOverlay(string id) -> void;
+
+//Rufe das overlay auf
+function getOverlay(string id) -> div;
+
 ```
 
 ##CouchDB
@@ -21,15 +25,17 @@ function hideOverlay(string id);
 //Erstelle eine neue CouchDB-Klasse mit new CouchDB();
 class CouchDB {
 	//Überprüfe, ob CouchDB online ist. (Wird sowieso automatisch gemacht, wenn get, set oder createDB verwendet wird)
-	async checkOnlineStatus();
+	async checkOnlineStatus() -> bool;
 	
 	//Erstellt die Datenbank. (Wird auch automatisch gemacht, wenn man get oder set verwendet)
-	async createDB();
+	async createDB() -> void;
 	
-	//Bekomme das Objekt, was in der Datenbank unter der id gespeichert wurde
-	async get(string id);
+	//Bekomme das Objekt, was in der Datenbank unter der id gespeichert wurde (Gibt null zurück, wenn nicht vorhanden)
+	async get(string id) -> Map|null;
 	//Setze ein Objekt, was in der Datenbank gespeichert wird (Bedenke: Du musst ein Objekt angeben, alles andere (string, array) wird nicht genommen)
-	async set(string id, object content, boolean replace = true);
+	async set(string id, object content, boolean replace = true) -> Map;
+	//Lösche ein Objekt, was in der Datenbank gespeichert ist
+	async delete(string id) -> Map;
 }
 ```
 
@@ -54,3 +60,13 @@ async function main() {
 }
 main();
 ```
+
+##User
+
+```
+//Gebe dir den Nutzer wieder
+async function getUserData(couchDB) -> Map?;
+
+//Setze den Nutzer, welcher unter der Variable userData verfügbar sein wird
+async function setUserData(couchDB) -> bool;
+```