wocas-client v0.0.2
WocasClient
Met deze library wordt de communicatie tussen een Angular applicatie en een WocasEngine server eenvoudig gemaakt.
Quick start
- Installeren met
npm i wocas-client
- Importeren met
import { WocasClient } from 'wocas-client';
- Injecteren in gewenst Angular component door toe te voegen aan constructor parameters:
constructor(
private wocasClient: WocasClient
) { }
Functionaliteit
De WocasClient library biedt de volgende functionaliteit:
request(endpoint: string, params?: Object, headers?: HttpHeaders); // retourneert een Observable
getData(endpoint: string, params?: Object); // retourneert een Observable
setData(endpoint: string, params?: Object); // retourneert een Observable
setVersion(version: string); // void
getVersion(); // retourneert een string
setRequestId(requestId: number); // void
resetMessageSequence(): // void
startKeepAlive(interval: number, url: string); // void
stopKeepAlive(): // void
Veranderingen
Verwijderde methode process
De methode process is niet meegenomen naar de nieuwe situatie. Deze werd gebruikt om de responsedata van getData en setData om te zetten naar JSON. Dit wordt nu binnen de desbetreffende merhodes zelf gedaan
XML methodes zijn verwijderd
Binnen het bestand communication.service.ts bestonden de methodes createXMLRequestString en createXMLNode. Deze zijn niet meegenomen naar de nieuwe situatie omdat deze niet thuishoren in de WocasClient. Deze dienen handmatig buiten de library om verplaatst te worden.
Spinner event verwijderd
Uit de methodes getData en setData zijn de aanroepen richting de spinner en de eventqueue verwijderd, omdat deze niet binnen de WocaClient thuis horen. Deze dienen handmatig buiten de library om verplaatst te worden.
Parameters uit setData verwijderd
De argumentenlijst van setData is gewijzigd.
oude situatie
setData(page: any, requestType: any, callback: any, requestParameters: any, params?: any);
nieuwe situatie
setData(endpoint: string, params?: Object); // retourneert een Observable
Voorheen werd er binnen setData een xmlRequestString samengesteld. Deze dient nu als parameter meegegeven te worden aan het params object. Een voorbeeld:
const endpoint: string = "https://localhost:1600/dataurl.pwc";
const xmlRequestString: string = this.createXMLRequestString(page, requestType, callback, requestParameters);
// De benaming 'waarde' is verplicht!
const params: Object = {
'waarde': xmlRequestString
}
setData(endpoint,params);