Key Value
Dados JSON da aplicação por dispositivo, separados das preferências e disponíveis sem Modo de Programador. Chaves permitidas: last_file_path, quick_note_draft, recent_searches, recent_save_dirs, chat_input_text:peer:ID e chat_input_text:channel:ID (ID não vazio). Os valores são partilhados pelos clientes do mesmo dispositivo.
Dados atualmente guardados através de Key Value
Estas são as chaves de dados da aplicação atualmente aceites por keyValue e setKeyValue. A tabela descreve as estruturas atuais dos valores do cliente, não estruturas JSON impostas pelo servidor. ID não pode estar vazio. Os valores são persistentes e partilhados pelos clientes do mesmo dispositivo; não são preferências. Os valores inexistentes devolvem null. O argumento value é JSON não nulo; null não pode ser usado para eliminar uma chave. Os exemplos descrevem estruturas de dados, não conteúdo real guardado por utilizadores.
| Key | Estrutura do valor JSON | Finalidade |
|---|---|---|
| last_file_path | { rootPath: string, fullPath: string, selectedPath: string } | Última localização do explorador de ficheiros: raiz, caminho completo e caminho selecionado. |
| quick_note_draft | string | Texto de nota rápida não enviado. |
| recent_searches | string[] | Termos de pesquisa recentes, dos mais recentes para os mais antigos; o cliente limita a lista. |
| recent_save_dirs | string[] | Diretórios de gravação ou carregamento selecionados recentemente, dos mais recentes para os mais antigos; o cliente limita a lista. |
| chat_input_text:peer:ID | string | Texto de conversa não enviado para o par identificado por ID. |
| chat_input_text:channel:ID | string | Texto de conversa não enviado para o canal identificado por ID. |
Definições de Tipo
type Mutation {
setKeyValue(key: String!, value: JSON!): Boolean!
}
type Query {
keyValue(key: String!): JSON
}
scalar JSONOperações
setKeyValue
Persistir dados JSON da aplicação para uma chave Key Value permitida. Os valores codificados não devem exceder 65536 bytes. Devolve true quando alterados, false quando idênticos; esta API não altera preferências.
# 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)
}keyValue
Consultar dados JSON da aplicação para uma chave Key Value permitida. As chaves inexistentes devolvem null. Esta API não lê preferências.
# Read JSON application data by key; returns null when absent and does not read preferences.
query keyValue($key: String!) {
keyValue(key: $key)
}