API-Referenz

Key Value

Gerätebezogene JSON-Anwendungsdaten, getrennt von Einstellungen und ohne Entwicklermodus verfügbar. Erlaubte Schlüssel: last_file_path, quick_note_draft, recent_searches, recent_save_dirs, chat_input_text:peer:ID und chat_input_text:channel:ID mit nichtleerer ID. Clients desselben Geräts teilen diese Werte.

Aktuell über Key Value gespeicherte Daten

Dies sind die von keyValue und setKeyValue akzeptierten Anwendungsdatenschlüssel. Die Tabelle beschreibt aktuelle Client-Wertstrukturen, keine serverseitig erzwungenen JSON-Strukturen. ID darf nicht leer sein. Werte sind persistent und werden von Clients desselben Geräts geteilt; es sind keine Einstellungen. Fehlende Werte liefern null. value ist nicht-null-JSON; null kann keinen Schlüssel löschen. Beispiele zeigen Datenstrukturen, keine gespeicherten Benutzerinhalte.

KeyJSON-WertstrukturZweck
last_file_path{ rootPath: string, fullPath: string, selectedPath: string }Letzter Dateibrowserort: Stammverzeichnis, vollständiger Pfad und ausgewählter Pfad.
quick_note_draftstringNoch nicht gesendeter Schnellnotiztext.
recent_searchesstring[]Letzte Suchbegriffe, neueste zuerst. Die Liste wird vom Client gekürzt.
recent_save_dirsstring[]Zuletzt gewählte Speicher- oder Uploadverzeichnisse, neueste zuerst. Die Liste wird vom Client gekürzt.
chat_input_text:peer:IDstringNoch nicht gesendeter Chattext für das durch ID identifizierte Gerät.
chat_input_text:channel:IDstringNoch nicht gesendeter Chattext für den durch ID identifizierten Kanal.

Typdefinitionen

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

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

scalar JSON

Operationen

mutation

setKeyValue

Speichert JSON-Anwendungsdaten unter einem erlaubten Key-Value-Schlüssel. Der kodierte Wert darf 65536 Byte nicht überschreiten. Liefert true bei Änderung und false bei gleichem Wert; ändert keine Einstellungen.

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

Liest JSON-Anwendungsdaten für einen erlaubten Key-Value-Schlüssel. Fehlende Schlüssel liefern null. Liest keine Einstellungen.

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