PlainApp
API-referentie

Key Value

JSON-toepassingsgegevens per apparaat, los van voorkeuren en beschikbaar zonder ontwikkelaarsmodus. Toegestane sleutels: last_file_path, quick_note_draft, recent_searches, recent_save_dirs, chat_input_text:peer:ID en chat_input_text:channel:ID (niet-lege ID). Waarden worden gedeeld door clients van hetzelfde apparaat.

Gegevens die momenteel via Key Value worden opgeslagen

Dit zijn de toepassingsgegevenssleutels die keyValue en setKeyValue momenteel accepteren. De tabel beschrijft de huidige waardestructuren van clients, geen door de server afgedwongen JSON-structuren. ID mag niet leeg zijn. Waarden worden blijvend opgeslagen en gedeeld door clients van hetzelfde apparaat; het zijn geen voorkeuren. Ontbrekende waarden geven null terug. Het argument value is niet-null JSON; null kan niet worden gebruikt om een sleutel te verwijderen. Voorbeelden beschrijven gegevensstructuren, geen werkelijk opgeslagen gebruikersinhoud.

KeyStructuur van JSON-waardeDoel
last_file_path{ rootPath: string, fullPath: string, selectedPath: string }Laatste locatie van de bestandsbrowser: hoofdmap, volledig pad en geselecteerd pad.
quick_note_draftstringNiet-verstuurde tekst van een snelle notitie.
recent_searchesstring[]Recente zoektermen, nieuwste eerst; de client kort de lijst in.
recent_save_dirsstring[]Recent geselecteerde opslag- of uploadmappen, nieuwste eerst; de client kort de lijst in.
chat_input_text:peer:IDstringNiet-verstuurde chattekst voor de peer met de opgegeven ID.
chat_input_text:channel:IDstringNiet-verstuurde chattekst voor het kanaal met de opgegeven ID.

Typedefinities

graphql
type Mutation {
  setKeyValue(key: String!, value: JSON!): Boolean!
}

type Query {
  keyValue(key: String!): JSON
}

scalar JSON

Bewerkingen

mutation

setKeyValue

JSON-toepassingsgegevens blijvend opslaan voor een toegestane Key Value-sleutel. Gecodeerde waarden mogen niet groter zijn dan 65536 bytes. Geeft true terug bij wijziging, false bij identieke waarden; deze API wijzigt geen voorkeuren.

graphql
# Save JSON application data up to 65,536 encoded bytes; returns whether the stored value changed.
mutation setKeyValue($key: String!, $value: JSON!) {
  setKeyValue(key: $key, value: $value)
}
query

keyValue

JSON-toepassingsgegevens voor een toegestane Key Value-sleutel lezen. Ontbrekende sleutels geven null terug. Deze API leest geen voorkeuren.

graphql
# Read JSON application data by key; returns null when absent and does not read preferences.
query keyValue($key: String!) {
  keyValue(key: $key)
}