Web API

Das RapidClipse Framework bietet mehrere Methoden an, um Web-API Funktionen des Endgeräts zu benutzen z.B. einen Text in das Clipboard des Benutzers zu kopieren und einzufügen.

Zuerst muss die Maven dependency in der pom.xml hinzugefügt werden:

<dependency>
	<groupId>com.rapidclipse</groupId>
	<artifactId>rap-server-webapi</artifactId>
	<version>10.02.00-RAP-GA</version>
</dependency>

Die API ist in mehrere Teilen aufgebaut:

Clipboard - Kopieren und Einfügen von Texten in und von dem System-Clipboard.
Device - Allgemeine Funktionen wie vibrieren oder teilen von Links an andere installierte Apps.
Geolocation - Lesen der Geographischen Koordinaten des Gerätes.
Memory - Lesen der Menge des verfügbaren Speichers.
Network - Lesen von Informationen über die momentane Netzwerkverbindung.
Notification - Local Notifications, welche im Notification-Management des Gerätes angezeigt wird.
Online - Testen, wann das Gerät wieder über eine Online-Verbindung verfügt.
Payment - Dialog, mit welchen Informationen für Zahlung mit z.B. Kreditkarte gesammelt werden kann.
Permission - Testen ob der Benutzer bestimmte Web-API-Featuers erlaubt hat, oder nicht.
Screen - Allgemeine Funktionen zu Bildschirmorientierung und Fullscreen.
Touch - Lesen von Touch-Informationen.
Video - GUI-Element für abspielen von Multimedia als auch von den Kameras des Gerätes.

Viele der Methoden erwarten Callbacks als Parameter, da der Javascript-Code erst ausgeführt werden kann, wenn die Informationen an den Browser gesendet wurden und dieser dann die Rückgabewerte wieder an den Server zurück geschickt hat.

Wichtige Information:

Viele der Features funktionieren nur in einen Secure-Context (https-Verbindung zu dem Server). Diese können aber z.B. mit Google Chrome trozdem im lokalen Netzwerk wie folgt getestet werden:
- Um Features auf localhost zu testen kann bei Chrome unter chrome://flags unter Insecure origins treated as secure http://localhost:8080 eingetragen werden
- Um Features auszuprobieren, welche nur auf dem Handy funktionieren, kann im Handy auch unter Insecure origins treated as secure die lokale IP-Addresse des PCs eingetragen werden z.B. http://192.168.0.123:8080
Viele dieser Features müssen erst vom Benutzer erlaubt werden. Wenn eines dieser Features ausgeführt wird, bekommt der Benutzer ein kleines Dialog-Fenster, wo dieser dieses Feature erlauben oder blockieren kann.
Für ein paar Features wie z.B. Local Notifications muss die Anwendung als PWA gekennzeichnet werden! Dafür einfach über die Haupt-View @PWA schreiben
Nicht alle der Features werden zurzeit von allen Browsern unterstützt, um Browser-Compatibiltity Informationen zu erhalten können Webseiten wie MDN benutzt werden.