Feltbeskrivelser
NokkelInput (Kafka key)
Se NokkelInput
BeskjedInput (Kafka value)
Beskrivelse av feltene til eventet Beskjed
.
Husk å validere alle eventene med builderene
våre. Les mer om dette her.
tidspunkt - deprecated
Feltet vises ikke til bruker, og feltet vil derfor etter hvert forsvinne. Tidspunktet som vises til bruker er tidspunktet da eventet ble behandlet første gang.
tekst
Dette er teksten som faktisk vises i eventet. Det er ikke noen støtte for å formatere teksten som settes i dette feltet. Feltet har en begrensning på 300 tegn og kan ikke være null.
link
Dette er lenken som blir aktivert i det en bruker trykker på selve eventet.
En lenke må være en komplett URL, inkludert https
protokoll. Feltet har en begrensning på 200 tegn.
Produsenten kan sende inn en tom String. Da vil ikke link
være synlig for sluttbruker.
sikkerhetsnivaa (valgfri)
Angir sikkerhetsnivået for informasjonen som eventet innholder. Kan inneholde verdien 3
eller 4
, default verdi er 4
.
DittNAV støtter at en bruker er innlogget på nivå 3, hvis denne brukeren har eventer med nivå 4 så vil disse eventene bli "grået ut".
Brukeren ser bare hvilken type event dette er, men ikke noe av innholdet.
For å se innholdet må brukeren steppe opp til et høyere innloggingsnivå.
synligFremTil (valgfri)
Et tidspunkt på når eventet ikke skal være synlig mer, f.eks beskjeden skal kun være synlig 7 dager. Når synligFramTil-tidspunktet har passert vil DittNAV sende et Done-event, og deaktivere eventet. synligFramTil = null -> synlig for alltid, med mindre brukeren selv arkiverer beskjeden på forsiden av DittNAV. Bruk UTC som tidssone.
eksternVarsling (valgfri)
Default-verdien til dette feltet er false
, men hvis det blir satt til true
vil beskjed-eventet bli varslet på SMS eller e-post.
Les mer om eksternvarsling her.
prefererteKanaler (valgfri)
Angir ønskede varslingskanaler for ekstern varsling.
Gyldige verdier finnes her.
Feltet kan inneholde flere prefererte kanaler, men er valgfritt. Dersom det ikke settes velges EPOST som default preferert kanal.
Det er ikke tillatt å sette feltet dersom eksternVarsling
er false
.
smsVarslingstekst (valgfri)
Tekst som skal overstyre SMS (standard tekst) for ekstern varsling.
Teksten kan ikke være lengre enn 160 tegn. Det er ikke tillatt å sette feltet dersom eksternVarsling
er false
.
epostVarslingstekst (valgfri)
Tekst som skal overstyre epost (standard tekst) for ekstern varsling.
Kun innhold av <body>
(e-post mal) skal overstyres.
Teksten kan innholde HTML tagger som er gyldig i <body>
tag og den kan ikke være lengre enn 4,000 tegn.
Det er ikke tillatt å sette feltet dersom eksternVarsling
er false
.
epostVarslingstittel (valgfri)
Tekst som skal overstyre epostens standardtittel ("Beskjed fra NAV") for ekstern varsling. Teksten kan ikke være lengre enn 40 tegn.
Det er ikke tillatt å sette feltet dersom eksternVarsling
er false
.
Schemas
BeskjedInput-schemas på Github.