Справочник API

Ключ и значение

Данные приложения JSON для устройства, отдельно от настроек и без требования режима разработчика. Допустимые ключи: last_file_path, quick_note_draft, recent_searches, recent_save_dirs, chat_input_text:peer:ID и chat_input_text:channel:ID (непустой ID). Значения общие для клиентов одного устройства.

Данные, сейчас хранящиеся через Key Value

Это ключи данных приложения, сейчас принимаемые keyValue и setKeyValue. Таблица описывает текущие структуры значений клиентов, а не проверяемые сервером структуры JSON. ID не должен быть пустым. Значения сохраняются постоянно и доступны всем клиентам одного устройства; это не настройки. Отсутствующие значения возвращают null. Аргумент value — JSON, отличный от null; null нельзя использовать для удаления ключа. Примеры описывают структуры данных, а не фактически сохранённое содержимое пользователя.

KeyСтруктура значения JSONНазначение
last_file_path{ rootPath: string, fullPath: string, selectedPath: string }Последнее расположение файлового браузера: корень, полный путь и выбранный путь.
quick_note_draftstringНеотправленный текст быстрой заметки.
recent_searchesstring[]Недавние поисковые запросы от новых к старым; клиент обрезает список.
recent_save_dirsstring[]Недавно выбранные каталоги сохранения или загрузки от новых к старым; клиент обрезает список.
chat_input_text:peer:IDstringНеотправленный текст чата для узла с указанным ID.
chat_input_text:channel:IDstringНеотправленный текст чата для канала с указанным ID.

Определения типов

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

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

scalar JSON

Операции

mutation

setKeyValue

Сохраняет данные приложения JSON для допустимого ключа Key Value. Закодированное значение не должно превышать 65536 байт. Возвращает true при изменении, false при совпадении; этот API не меняет настройки.

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 для допустимого ключа Key Value. Отсутствующие ключи возвращают null. Этот API не читает настройки.

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