Stackship-plattformenAnvändareMaskinöversatt

Användarinställningar

De personliga inställningar som plattformen sparar, deras standardvärden och rutterna som läser och ändrar dem.

Plattformen sparar några inställningar för varje inloggad person. De tillhör personen, inte en boundary eller ett team, och ingen annan kan läsa eller ändra dem.

Inställningar och standardvärden

Inställningarna skapas, med de här standardvärdena, första gången någon av rutterna nedan anropas för dig:

Inställning	Fält	Standard
Aviseringar på	`notifications.enabled`	`true`
Aviseringar via e-post	`notifications.email`	`false`
Aviseringar i portalen	`notifications.portal`	`true`
Tema	`portalSettings.theme` — `dark`, `light` eller `system`	`dark`
Språk	`portalSettings.language`	`en-US`
Senast sedda "Nytt i versionen"	`portalSettings.whatsNewSeenRelease` — ett releasenamn som `platform-0.8.0`	ingen
Vald boundary	`selectedBoundary` — `id`, `name`, `region`	ingen

Aviseringsinställningarna sparas, men inget på plattformen använder dem ännu.

Hur portalen använder dem

Portalens sida Inställningar sparar temat och språket som du väljer. När portalen laddas läser den bara tillbaka språket, och tillämpar det när det är en eller sv. Temat som portalen visar sparas i stället i webbläsaren.

När plattformen har uppgraderats visar portalen den nya releasens Nytt i versionen en gång. När du stänger den sparar portalen releasen i whatsNewSeenRelease, så att den inte visas igen förrän vid nästa uppgradering.

Rutter

Alla rutter gäller anroparens egna inställningar och kräver en inloggad anropare, men ingen behörighet.

Metod och sökväg	Läser eller ersätter
`GET /user/settings`	Alla inställningar
`PUT /user/settings`	Alla inställningar: `notifications`, `portalSettings`, `selectedBoundary`
`GET` / `PUT /user/settings/notifications`	`enabled`, `email`, `portal`
`GET` / `PUT /user/settings/portal`	`theme`, `language`
`GET` / `PUT /user/settings/boundary`	`id`, `name`, `region`
`PUT /user/settings/whats-new`	`release`: releasen vars "Nytt i versionen" du har sett

I PUT /user/settings behåller notifications eller portalSettings sina nuvarande värden om de utelämnas, men selectedBoundary rensas om den utelämnas. PUT-rutterna ändrar aldrig whatsNewSeenRelease; det gör bara PUT /user/settings/whats-new, som avvisar allt som inte är ett releasenamn med 400. Ett okänt tema, eller ett tomt språk, avvisas med 400; alla andra språkvärden sparas som de är.

bash

stsh api GET /user/settings
stsh api PUT /user/settings/portal -d '{"theme":"light","language":"sv"}'