API リファレンス
環境設定
アプリの設定です。すべての設定を読むには開発者モードが必要です。キーを指定した読み書きには、以下の登録済みキーポリシーが適用されます。
登録済みの設定キー (63)
アクセス権は各キーの登録ポリシーに従います。保存された生の値をすべて読み取るには開発者モードが必要です。
| キー | 用途 | アクセス権 |
|---|---|---|
| dlna | Enable the DLNA service. | ローカル・リモートで読み書き可能 |
| device_name | Device display name. | ローカル・リモートで読み書き可能 |
| feed_auto_refresh | Enable automatic feed refresh. | ローカル・リモートで読み書き可能 |
| feed_auto_refresh_interval | Automatic feed refresh interval in seconds. | ローカル・リモートで読み書き可能 |
| feed_auto_refresh_only_wifi | Restrict automatic feed refresh to Wi-Fi. | ローカル・リモートで読み書き可能 |
| ai_image_search_enabled | Enable semantic image search. | ローカル・リモートで読み書き可能 |
| ai_image_search_model | Selected image-search model. | ローカル・リモートで読み書き可能 |
| dlna_allowed_senders | Allowed DLNA sender identities. | ローカル・リモートで読み書き可能 |
| dlna_denied_senders | Denied DLNA sender identities. | ローカル・リモートで読み書き可能 |
| dark_theme | Theme selection: USE_DEVICE_THEME, ON or OFF. | ローカル・リモートで読み書き可能 |
| amoled_dark_theme | Use the AMOLED dark-theme option. | ローカル・リモートで読み書き可能 |
| pdf_follow_dark_theme | Apply the current dark theme to PDF viewing. | ローカル・リモートで読み書き可能 |
| locale | Interface language. | ローカル・リモートで読み書き可能 |
| show_hidden_files | Show hidden files in file browsing. | ローカル・リモートで読み書き可能 |
| feed_font_scale | Feed-reader font scale. | ローカル・リモートで読み書き可能 |
| editor_wrap_content | Wrap long editor lines. | ローカル・リモートで読み書き可能 |
| editor_font_size | Editor font size. | ローカル・リモートで読み書き可能 |
| editor_status_bar | Show the editor status bar. | ローカル・リモートで読み書き可能 |
| desktop_home_features | Features displayed on the desktop home page. | ローカル・リモートで読み書き可能 |
| desktop_rail_features | デスクトップのナビゲーションバーに表示する機能。 | ローカル・リモートで読み書き可能 |
| media_excluded_dirs | Directories hidden from media pages; file indexing and file search remain available. | ローカル・リモートで読み書き可能 |
| desktop_upload_dirs | デスクトップのメディアカテゴリごとに保存されたアップロード先ディレクトリのパス。 | ローカル・リモートで読み書き可能 |
| audio_sort_by | Audio-library sort order. | ローカル・リモートで読み書き可能 |
| video_sort_by | Video-library sort order. | ローカル・リモートで読み書き可能 |
| image_sort_by | Image-library sort order. | ローカル・リモートで読み書き可能 |
| doc_sort_by | Document-library sort order. | ローカル・リモートで読み書き可能 |
| file_sort_by | File-browser sort order. | ローカル・リモートで読み書き可能 |
| pkg_sort_by | Installed-package sort order. | ローカル・リモートで読み書き可能 |
| audio_play_mode | Audio playback repeat or shuffle mode. | ローカル・リモートで読み書き可能 |
| audio_playback_speed | Audio playback speed multiplier. | ローカル・リモートで読み書き可能 |
| pomodoro_settings | Pomodoro work, break and round configuration. | ローカル・リモートで読み書き可能 |
| screen_mirror_quality | Screen-mirror quality preset. | ローカル・リモートで読み書き可能 |
| clipboard_directions | Clipboard synchronization direction for each peer. | ローカルのみ読み書き可能 |
| http_port | HTTP listener port. | ローカルのみ読み書き可能 |
| https_port | HTTPS listener port. | ローカルのみ読み書き可能 |
| background_service_enabled | Enable the background service. | ローカルのみ読み書き可能 |
| remote_access | Enable remote access. | ローカルのみ読み書き可能 |
| developer_mode | Enable developer tools and full preference or database access. | ローカルのみ読み書き可能 |
| allow_any_host | Allow requests with arbitrary HTTP host names. | ローカルのみ読み書き可能 |
| nearby_discoverable | Allow nearby devices to discover this device. | ローカルのみ読み書き可能 |
| notification_filter | Notification synchronization filter configuration. | ローカルのみ読み書き可能 |
| launcher_shortcuts | Configured launcher shortcuts. | ローカルのみ読み書き可能 |
| image_grid_cells_per_row | Image-grid column count. | ローカルのみ読み書き可能 |
| video_grid_cells_per_row | Video-grid column count. | ローカルのみ読み書き可能 |
| https | Enable HTTPS. | ローカルのみ読み書き可能 |
| web_address_bar_expanded | Expand the remote-access address bar. | ローカルのみ読み書き可能 |
| password | Local password configuration. | ローカルのみ読み書き可能 |
| password_type | Selected password mode. | ローカルのみ読み書き可能 |
| login_require_approval | Require local approval for remote login. | ローカルのみ読み書き可能 |
| api_permissions | Features authorized for remote API clients. | ローカルのみ読み書き可能 |
| dev_token | Development access token configuration. | ローカルのみ読み書き可能 |
| log_level | Application logging level. | ローカルのみ読み書き可能 |
| auto_check_update | Automatically check for application updates. | ローカルのみ読み書き可能 |
| skip_version | Application update version to skip. | ローカルのみ読み書き可能 |
| mdns_hostname | mDNS hostname used for local discovery. | ローカルまたは HTTP_SERVER 対応の認証済みリモート |
| recent_selected_dirs | この端末で確定したフォルダーの絶対パスを新しい順に最大8件保存します。Windowsでは / を使用し、ドライブのルートは D: ではなく D:/ と書きます。 ["D:/Projects/Photos", "E:/Backup/Photos"] | ローカル、またはログイン済みでファイル権限のあるリモート接続 |
| app_home_features | Features displayed by the native Tools page and its remote projection. | ローカルで読み書き、リモートは読み取りのみ |
| opaque_server_setup | Internal OPAQUE password-authentication server setup. | Rust 内部専用 |
| opaque_password_record | Internal OPAQUE password registration record. | Rust 内部専用 |
| client_id | Internal persistent device identity. | Rust 内部専用 |
| adb_token | Internal authorization token for local command access. | Rust 内部専用 |
| master_secret | Internal master secret. | Rust 内部専用 |
| signature_key_pair | Internal device signing key pair. | Rust 内部専用 |
型定義
graphql
type Subscription {
prefsChanged: Boolean!
}
type Mutation {
removePref(key: String!): Boolean!
setPref(key: String!, value: JSON!): Boolean!
}
type Query {
prefs(keys: [String!]): JSON!
}
scalar JSON操作
subscription
prefsChanged
設定変更時に変更シグナルを受信します。使用する設定フィールドを再取得してください。
graphql
subscription prefsChanged {
prefsChanged
}mutation
removePref
書き込み可能な設定の上書き値を削除します。auto_check_update と skip_version はデフォルトに戻ります。キーの許可リストを参照してください。
graphql
mutation removePref($key: String!) {
removePref(key: $key)
}mutation
setPref
登録済みの書き込み可能な設定を設定し、値を検証して副作用を適用します。権限はキーの許可リストを参照してください。
graphql
mutation setPref($key: String!, $value: JSON!) {
setPref(key: $key, value: $value)
}query
prefs
keys を省略するか null を渡すと、内部キーも含め保存されたすべての生の設定を読み取ります。開発者モードが必要です。名前を指定したキーはキー許可リストに従い、空のリストは空のオブジェクトを返します。
graphql
query prefs($keys: [String!]) {
prefs(keys: $keys)
}