Tham chiếu API

Khóa và giá trị

Dữ liệu ứng dụng JSON theo thiết bị, tách khỏi tùy chọn và dùng được không cần Chế độ nhà phát triển. Khóa cho phép: last_file_path, quick_note_draft, recent_searches, recent_save_dirs, chat_input_text:peer:ID và chat_input_text:channel:ID (ID không rỗng). Các máy khách cùng thiết bị chia sẻ giá trị.

Dữ liệu hiện lưu qua Key Value

Đây là các khóa dữ liệu ứng dụng hiện được keyValue và setKeyValue chấp nhận. Bảng mô tả cấu trúc giá trị máy khách hiện tại, không phải cấu trúc JSON do máy chủ bắt buộc. ID không được rỗng. Giá trị lưu bền vững và được các máy khách cùng thiết bị chia sẻ; chúng không phải tùy chọn. Giá trị thiếu trả về null. Tham số value là JSON khác null; không thể dùng null để xóa khóa. Ví dụ mô tả cấu trúc dữ liệu, không phải nội dung người dùng thực đã lưu.

KeyCấu trúc giá trị JSONMục đích
last_file_path{ rootPath: string, fullPath: string, selectedPath: string }Vị trí trình duyệt tệp cuối: gốc, đường dẫn đầy đủ và đường dẫn đã chọn.
quick_note_draftstringVăn bản ghi chú nhanh chưa gửi.
recent_searchesstring[]Từ khóa tìm gần đây, mới nhất trước; máy khách cắt gọn danh sách.
recent_save_dirsstring[]Thư mục lưu hoặc tải lên mới chọn gần đây, mới nhất trước; máy khách cắt gọn danh sách.
chat_input_text:peer:IDstringVăn bản trò chuyện chưa gửi cho thiết bị ngang hàng theo ID.
chat_input_text:channel:IDstringVăn bản trò chuyện chưa gửi cho kênh theo ID.

Định nghĩa kiểu

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

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

scalar JSON

Thao tác

mutation

setKeyValue

Lưu bền vững dữ liệu ứng dụng JSON cho khóa Key Value cho phép. Giá trị mã hóa không vượt quá 65536 byte. Trả về true khi đổi, false khi giống hệt; API này không thay tùy chọn.

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

Đọc dữ liệu ứng dụng JSON cho khóa Key Value cho phép. Khóa thiếu trả về null. API này không đọc tùy chọn.

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