Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

På baggrund af følgende eksempler, er det muligt at komme hurtigt i gang med anvendelsen af SDK'erne. 

Sammenhæng med øvrige dokumenter

Dette dokument er en del af den samlede dokumentation for NAP SDK.

Dokumentet er udformet, så det i videst muligt omfang opfylder sit formål uafhængigt af de øvrige dokumenter.

Nap-typescript-sdk

Nap-typescript-sdk er det basale SDK. Det udstiller en række metoder og interfaces som vil blive beskrevet i følgende:

NAP interface

En wrapper af kontekstbroenNAP Bridge.

Code Block
languagejs
export interface NAP {
	fromHost$: Observable<NAPMessage>;
	toHost$: Subject<NAPMessage>;
	errors$: Observable<NAPError>;
	subscribe: (subscriber: NAPHostSubscriber) => void; 
	unsubscribe: (subscriber: NAPHostSubscriber) => void; 
	send: (message: NAPMessage) => void;
}

...

Denne wrapping foregår i creatNAP() funktion, som SDKet eksporterer.

NAPMessage

Den grundlæggende model for nap beskeder, der kører over (fromHost$, toHost$, subscrbe og send).

Består af følgende felter, hvor context propertien, er meget inspireret af FHIR / FHIRcast (https://fhircast.org/specification/Feb2020Ballot/),

...

Code Block
languagejs
export interface NAPMessage {
  date: string;
  id: string;
  event: NAPEvent;
}
export interface NAPEvent {
  type: NAPEventType;
  context?: FHIR.Context[];
}

...


Eventkataloget definerer de eventtyper, der kan sendes over NAP i en given version.Eventkatalog

Dette eventkatalog lægger sig op af FHIR / FHIRcast.

...

Code Block
languagejs
import { NAPEventCatalogue } from 'nap-typescript-sdk';
const sessionCloseEvent = NAPEventCatalogue.v1.SessionClose;

NAPError

Model for de SDK fejl. Disse beskeder sendes, hvis sker der fejl i createNAP() kaldet -  når NAP bridge skal wrappes.

Code Block
languagejs
export interface NAPError {
  id: number;
  message: string;
  isFatal: boolean;
}

Eksempel på brug af errors$

Fejl bliver således skrevet i web konsollen.

Code Block
languagejs
this.napAngular.errors$.subscribe(res => {
     console.error(res);
    });

Eksemplet er taget fra NapRefWeb Referenceimplementering (NAP) - Leverancebeskrivelse.

Hjælpefunktioner

Nap-typescript-sdk indeholder derudover en række hjælpefunktioner, som kan være brugbare til at hente værdier eller undgå stavefejl, når der skal laves NAPMessages.

...