Riferimento API

Key Value

Dati JSON dell’applicazione per dispositivo, separati dalle preferenze e disponibili senza modalità sviluppatore. Chiavi consentite: last_file_path, quick_note_draft, recent_searches, recent_save_dirs, chat_input_text:peer:ID e chat_input_text:channel:ID (ID non vuoto). I valori sono condivisi dai client dello stesso dispositivo.

Dati attualmente memorizzati tramite Key Value

Queste sono le chiavi dei dati applicativi attualmente accettate da keyValue e setKeyValue. La tabella descrive le strutture dei valori attuali dei client, non strutture JSON imposte dal server. ID non deve essere vuoto. I valori sono persistenti e condivisi dai client dello stesso dispositivo; non sono preferenze. I valori mancanti restituiscono null. L’argomento value è JSON non nullo; null non può essere usato per eliminare una chiave. Gli esempi descrivono strutture dati, non contenuti reali salvati dagli utenti.

KeyStruttura del valore JSONUtilizzo
last_file_path{ rootPath: string, fullPath: string, selectedPath: string }Ultima posizione del file manager: radice, percorso completo e percorso selezionato.
quick_note_draftstringTesto della nota rapida non inviato.
recent_searchesstring[]Termini di ricerca recenti, dai più recenti; il client limita la lunghezza dell’elenco.
recent_save_dirsstring[]Directory di salvataggio o caricamento selezionate di recente, dalle più recenti; il client limita la lunghezza dell’elenco.
chat_input_text:peer:IDstringTesto di chat non inviato per il peer identificato da ID.
chat_input_text:channel:IDstringTesto di chat non inviato per il canale identificato da ID.

Definizioni di tipo

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

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

scalar JSON

Operazioni

mutation

setKeyValue

Salvare dati JSON dell’applicazione per una chiave Key Value consentita. I valori codificati non devono superare 65536 byte. Restituisce true se modificati, false se identici; questa API non modifica le preferenze.

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

Leggere dati JSON dell’applicazione per una chiave Key Value consentita. Le chiavi mancanti restituiscono null. Questa API non legge le preferenze.

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