Client Server interactie RVD scherm

Ik heb eerst WL aangepast, dus zie opmerkingen aldaar. acties beginnen met kleine letter. parameters worden meegegeven als post-variabele parameter namen underscored, kleine letters, engels (mijn voorkeur)

login (string username, string password)

returns int Id, string Username, string Avatar, String Role or exception
Beschrijving
functie om user in te laten loggen
Uitleg
Exception wordt gebruikt als:
foutief wachtwoord, onbekende username,etc
Wordt vanuit de database de Role of RoleId teruggegeven? Beide zou kunnen.
username en avatar worden tevens opgeslagen in session.

checkLogged ()

returns string Username, string Avatar, String Role or exception
Beschrijving
wordt gebruikt als gebruiker refresh knop gebruikt om te checken of hij al was ingelogd
Uitleg
eigenlijk een login, maar dan zonder iets in te vullen en alles uit de session halen.
Potentieel probleem: nu kan je het wachtwoord dus niet checken, wat een potentieel beveiligingsissue is (iemand kan immers proberen zelf een session aan te maken, toch?). wachtwoord in session zetten lijkt me niet echt een optie. Misschien een hash van het wachtwoord in de session opslaan en deze checken?

logout ()

return none or exception
Beschrijving
Username wordt uit session gehaald en vervolgens wordt session verwijderd.

addMessage (string text, boolean ticket)

returns MessageId or exception
Beschrijving
Functie om bij RVDlog een regel text in te voeren in het systeem en eventueel een ticket aan te maken
Uitleg
Id wordt gebruikt om bij de client bij te houden welke berichten hij al heeft.

getMessages (integer message_id, datetime $date_and_time)

returns array chat(int MessageID, string Text, string Username, string Avatar, array time(hours, minutes)) or exception
Beschrijving
Haalt alle berichten uit de database waarbij MessageId de laatst ontvangen message is. Timestamp geeft aan vanaf welke datum en tijd de database de berichten moeten zijn.
Uitleg
In de vorige versie kon je ook de string 'all' meegeven en dan kreeg je gewoon alle berichten. weer doen of anders implementeren?

searchMessages (string $keyword)

returns array chat(int MessageID, string Text, string Username, string Avatar, array time(hours, minutes))or exception
Beschrijving
Haalt alle berichten uit de database waarbij de username of Text dit keyword bevat.
Uitleg
Vergelijkbaar met GetMessages

getUsers ()

returns array users(integer id, string role, string username, integer totaal) or exception
Beschrijving
Functie om lijst met user te krijgen
Uitleg
In de vorige versie werd dit ook gebruikt voor synchronisatie. Uitgelogde users (timestamp ouder dan 30s) werden verwijderd en de timestamp van de huidige user werd ververst. Weer doen of aparte functie hiervoor opzetten?

getHandles ()

returns array(int group_id, string group_name, array(integer id, integer handle_number, string handle_name) handles) groups or exception
Beschrijving
Functie om lijst met roepnamen/voertuigennamen te krijgen

getTicketList ()

returns array(integer id, string text, string status, string user_wl, array time(hours, minutes)) tickets or exception
Beschrijving
Functie om lijst met tickets en hun status te krijgen
Uitleg
Ticket lijst van tickets die nieuw zijn en toegewezen zijn. Text zou de titel van de ticket moeten zijn. Alleen 'parents' worden getoond, niet de subopmerkingen/meldingen.

getFeedback ()

returns array(integer id, string title, string handle_name, string message, string user_wl, array time (hours, minutes)) feedback or exception
Beschrijving
Functie om benodigde terugmeldingen te zien die zijn ingediend door WL
Uitleg
Geeft een lijst met meldingen die wl graag gedaan wil hebben

closeFeedback (integer id)

returns null or exception
Beschrijving
Nadat melding over netwerk is gedaan, kan het feedback item gesloten worden.
Uitleg
Sluit feedback item af