Référence de l'API

Key Value

Données JSON de l’application propres à chaque appareil, distinctes des préférences et accessibles sans mode développeur. Clés autorisées : last_file_path, quick_note_draft, recent_searches, recent_save_dirs, chat_input_text:peer:ID et chat_input_text:channel:ID (ID non vide). Les clients d’un même appareil partagent les valeurs.

Données actuellement stockées via Key Value

Ce sont les clés de données d’application actuellement acceptées par keyValue et setKeyValue. Le tableau décrit les structures actuelles des valeurs clientes, pas des structures JSON imposées par le serveur. ID ne doit pas être vide. Les valeurs sont persistantes et partagées par les clients du même appareil ; ce ne sont pas des préférences. Les valeurs absentes renvoient null. L’argument value est du JSON non nul ; null ne permet pas de supprimer une clé. Les exemples décrivent des structures de données, pas du contenu réel enregistré par les utilisateurs.

KeyStructure de la valeur JSONUtilisation
last_file_path{ rootPath: string, fullPath: string, selectedPath: string }Dernier emplacement du navigateur de fichiers : racine, chemin complet et chemin sélectionné.
quick_note_draftstringTexte de note rapide non envoyé.
recent_searchesstring[]Termes de recherche récents, les plus récents en premier ; le client raccourcit la liste.
recent_save_dirsstring[]Répertoires d’enregistrement ou de téléversement récemment sélectionnés, les plus récents en premier ; le client raccourcit la liste.
chat_input_text:peer:IDstringTexte de discussion non envoyé pour le pair identifié par ID.
chat_input_text:channel:IDstringTexte de discussion non envoyé pour le canal identifié par ID.

Définitions de types

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

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

scalar JSON

Opérations

mutation

setKeyValue

Conserver les données JSON de l’application pour une clé Key Value autorisée. Les valeurs encodées ne doivent pas dépasser 65536 octets. Renvoie true en cas de changement, false si elles sont identiques ; cette API ne modifie pas les préférences.

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

Lire les données JSON de l’application pour une clé Key Value autorisée. Les clés absentes renvoient null. Cette API ne lit pas les préférences.

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