API リファレンス

Key Value

設定とは別の、デバイスごとの永続的な 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 引数は非 null の JSON で、null ではキーを削除できません。例はデータ構造を示し、実際に保存されたユーザーの内容ではありません。

KeyJSON 値の構造用途
last_file_path{ rootPath: string, fullPath: string, selectedPath: string }最後のファイルブラウザー位置:ルート、完全パス、選択パス。
quick_note_draftstring未送信のクイックメモのテキスト。
recent_searchesstring[]最近の検索語を新しい順に保存します。リストの件数調整はクライアントが行います。
recent_save_dirsstring[]最近選択した保存先またはアップロード先ディレクトリを新しい順に保存します。リストの件数調整はクライアントが行います。
chat_input_text:peer:IDstringID で識別されるピア向けの未送信チャットテキスト。
chat_input_text:channel:IDstringID で識別されるチャネル向けの未送信チャットテキスト。

型定義

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

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

scalar JSON

操作

mutation

setKeyValue

許可された Key Value キーの JSON アプリデータを永続化します。エンコード後の値は 65,536 バイト以下でなければなりません。変更した場合 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

許可された Key Value キーの JSON アプリデータを読み取ります。キーが存在しない場合は 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)
}