API Reference

Preferences

Application configuration. Full preference reads require Developer Mode; scoped reads and writes follow the registered key policies below.

Registered preference keys (63)

Access follows the registered key policy. Full raw reads require Developer Mode.

KeyPurposeAccess
dlnaEnable the DLNA service. Local and remote read/write
device_nameDevice display name. Local and remote read/write
feed_auto_refreshEnable automatic feed refresh. Local and remote read/write
feed_auto_refresh_intervalAutomatic feed refresh interval in seconds. Local and remote read/write
feed_auto_refresh_only_wifiRestrict automatic feed refresh to Wi-Fi. Local and remote read/write
ai_image_search_enabledEnable semantic image search. Local and remote read/write
ai_image_search_modelSelected image-search model. Local and remote read/write
dlna_allowed_sendersAllowed DLNA sender identities. Local and remote read/write
dlna_denied_sendersDenied DLNA sender identities. Local and remote read/write
dark_themeTheme selection: USE_DEVICE_THEME, ON or OFF. Local and remote read/write
amoled_dark_themeUse the AMOLED dark-theme option. Local and remote read/write
pdf_follow_dark_themeApply the current dark theme to PDF viewing. Local and remote read/write
localeInterface language. Local and remote read/write
show_hidden_filesShow hidden files in file browsing. Local and remote read/write
feed_font_scaleFeed-reader font scale. Local and remote read/write
editor_wrap_contentWrap long editor lines. Local and remote read/write
editor_font_sizeEditor font size. Local and remote read/write
editor_status_barShow the editor status bar. Local and remote read/write
desktop_home_featuresFeatures displayed on the desktop home page. Local and remote read/write
desktop_rail_featuresFeatures displayed in the desktop navigation rail. Local and remote read/write
media_excluded_dirsDirectories hidden from media pages; file indexing and file search remain available. Local and remote read/write
desktop_upload_dirsUpload directory paths saved for each desktop media category. Local and remote read/write
audio_sort_byAudio-library sort order. Local and remote read/write
video_sort_byVideo-library sort order. Local and remote read/write
image_sort_byImage-library sort order. Local and remote read/write
doc_sort_byDocument-library sort order. Local and remote read/write
file_sort_byFile-browser sort order. Local and remote read/write
pkg_sort_byInstalled-package sort order. Local and remote read/write
audio_play_modeAudio playback repeat or shuffle mode. Local and remote read/write
audio_playback_speedAudio playback speed multiplier. Local and remote read/write
pomodoro_settingsPomodoro work, break and round configuration. Local and remote read/write
screen_mirror_qualityScreen-mirror quality preset. Local and remote read/write
clipboard_directionsClipboard synchronization direction for each peer. Local read/write only
http_portHTTP listener port. Local read/write only
https_portHTTPS listener port. Local read/write only
background_service_enabledEnable the background service. Local read/write only
remote_accessEnable remote access. Local read/write only
developer_modeEnable developer tools and full preference or database access. Local read/write only
allow_any_hostAllow requests with arbitrary HTTP host names. Local read/write only
nearby_discoverableAllow nearby devices to discover this device. Local read/write only
notification_filterNotification synchronization filter configuration. Local read/write only
launcher_shortcutsConfigured launcher shortcuts. Local read/write only
image_grid_cells_per_rowImage-grid column count. Local read/write only
video_grid_cells_per_rowVideo-grid column count. Local read/write only
httpsEnable HTTPS. Local read/write only
web_address_bar_expandedExpand the remote-access address bar. Local read/write only
passwordLocal password configuration. Local read/write only
password_typeSelected password mode. Local read/write only
login_require_approvalRequire local approval for remote login. Local read/write only
api_permissionsFeatures authorized for remote API clients. Local read/write only
dev_tokenDevelopment access token configuration. Local read/write only
log_levelApplication logging level. Local read/write only
auto_check_updateAutomatically check for application updates. Local read/write only
skip_versionApplication update version to skip. Local read/write only
mdns_hostnamemDNS hostname used for local discovery. Local callers may read and write it; authenticated remote callers may do so only when the server declares HTTP_SERVER support. Local or authenticated remote with HTTP_SERVER
recent_selected_dirsUp to eight confirmed absolute directory paths on this device, newest first. Windows paths use forward slashes; a drive root is D:/, not D:. ["D:/Projects/Photos", "E:/Backup/Photos"]Local or signed-in remote with Files access
app_home_featuresFeatures displayed by the native Tools page and its remote projection. Local read/write; remote read only
opaque_server_setupInternal OPAQUE password-authentication server setup. Rust internal only
opaque_password_recordInternal OPAQUE password registration record. Rust internal only
client_idInternal persistent device identity. Rust internal only
adb_tokenInternal authorization token for local command access. Rust internal only
master_secretInternal master secret. Rust internal only
signature_key_pairInternal device signing key pair. Rust internal only

Type Definitions

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

Operations

subscription

prefsChanged

Receive a change signal when preferences change; refetch the configuration fields you use.

graphql
subscription prefsChanged {
  prefsChanged
}
mutation

removePref

Remove a writable preference override; auto_check_update and skip_version reset to their defaults. See the key whitelist.

graphql
mutation removePref($key: String!) {
  removePref(key: $key)
}
mutation

setPref

Set a registered writable preference, validate its value and apply its side effects. See the key whitelist for permissions.

graphql
mutation setPref($key: String!, $value: JSON!) {
  setPref(key: $key, value: $value)
}
query

prefs

Omit keys or pass null to read every raw stored preference, including internal keys; Developer Mode is required. Named keys use the key whitelist; an empty list returns an empty object.

graphql
query prefs($keys: [String!]) {
  prefs(keys: $keys)
}