API Referansı

Anahtar ve değer

Tercihlerden ayrı, Geliştirici Modu gerektirmeyen cihaz başına JSON uygulama verisi. İzin verilen anahtarlar: last_file_path, quick_note_draft, recent_searches, recent_save_dirs, chat_input_text:peer:ID ve chat_input_text:channel:ID (ID boş olamaz). Değerler aynı cihazın istemcileri arasında paylaşılır.

Şu anda Key Value üzerinden saklanan veriler

Bunlar keyValue ve setKeyValue tarafından şu an kabul edilen uygulama veri anahtarlarıdır. Tablo sunucunun zorunlu kıldığı JSON yapılarını değil, mevcut istemci değer yapılarını açıklar. ID boş olamaz. Değerler kalıcıdır ve aynı cihazın istemcileri arasında paylaşılır; tercih değildir. Eksik değerler null döndürür. value bağımsız değişkeni null olmayan JSON'dur; null anahtar silmek için kullanılamaz. Örnekler gerçek kayıtlı kullanıcı içeriğini değil veri yapılarını açıklar.

KeyJSON değer yapısıAmaç
last_file_path{ rootPath: string, fullPath: string, selectedPath: string }Son dosya tarayıcısı konumu: kök, tam yol ve seçili yol.
quick_note_draftstringGönderilmemiş hızlı not metni.
recent_searchesstring[]Son arama terimleri, en yeni önce; listeyi istemci kırpar.
recent_save_dirsstring[]Son seçilen kaydetme veya yükleme dizinleri, en yeni önce; listeyi istemci kırpar.
chat_input_text:peer:IDstringID ile belirtilen eş için gönderilmemiş sohbet metni.
chat_input_text:channel:IDstringID ile belirtilen kanal için gönderilmemiş sohbet metni.

Tip Tanımları

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

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

scalar JSON

İşlemler

mutation

setKeyValue

İzin verilen Key Value anahtarı için JSON uygulama verisini kalıcı kaydeder. Kodlanmış değerler 65536 baytı aşmamalıdır. Değişince true, aynıysa false döndürür; bu API tercihleri değiştirmez.

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

İzin verilen Key Value anahtarı için JSON uygulama verisini okur. Eksik anahtarlar null döndürür. Bu API tercihleri okumaz.

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