Skip to main content
SDK API
Full KeyOS API
Module messages Copy item path Source AppFilter Filter applied by ListAppsNone axis matches either value; the axes are
independent, so a Flux app may be built-in or sideloaded. AppFilterResolver The resolver for an archived AppFilter AppQrMatchRules AppQrMatchRulesResolver The resolver for an archived AppQrMatchRules ArchivedAppFilter An archived AppFilter ArchivedAppQrMatchRules An archived AppQrMatchRules ArchivedGetAppIcon An archived GetAppIcon ArchivedGetPermissionRequestInfo An archived GetPermissionRequestInfo ArchivedGetQrMatchRules An archived GetQrMatchRules ArchivedGetThirdPartyCertificates An archived GetThirdPartyCertificates ArchivedImportThirdPartyCertificate An archived ImportThirdPartyCertificate ArchivedInstallAppArchive An archived InstallAppArchive ArchivedInstallAppArchiveResult An archived InstallAppArchiveResult ArchivedInstalledAppInfo An archived InstalledAppInfo ArchivedInstalledAppPermissionGroup An archived InstalledAppPermissionGroup ArchivedInstalledAppPermissionSubgroup An archived InstalledAppPermissionSubgroup ArchivedListApps An archived ListApps ArchivedPermissionRequestInfo An archived PermissionRequestInfo ArchivedPreviewThirdPartyCertificate An archived PreviewThirdPartyCertificate ArchivedRemoveThirdPartyCertificate An archived RemoveThirdPartyCertificate ArchivedSetAppPermissionGrant An archived SetAppPermissionGrant ArchivedSubscribeAppEvents An archived SubscribeAppEvents ArchivedThirdPartyCertificateInfo An archived ThirdPartyCertificateInfo GetAppIcon Fetch the raw bytes of a single app’s bundled icon, keyed by its hex app id
(as returned in InstalledAppInfo::app_idNone when the app
is unknown, has no bundled icon, or the icon cannot be read. A dark-variant
request falls back to the light icon for apps that ship no dark icon. GetAppIconResolver The resolver for an archived GetAppIcon GetPermissionRequestInfo GetPermissionRequestInfoResolver The resolver for an archived GetPermissionRequestInfo GetQrMatchRules limits the response to the listed apps; an empty list returns all apps. GetQrMatchRulesResolver The resolver for an archived GetQrMatchRules GetThirdPartyCertificates GetThirdPartyCertificatesResolver The resolver for an archived GetThirdPartyCertificates ImportThirdPartyCertificate ImportThirdPartyCertificateResolver The resolver for an archived ImportThirdPartyCertificate InstallAppArchive Install an app from an archive the user picked on local storage. InstallAppArchiveResolver The resolver for an archived InstallAppArchive InstallAppArchiveResult InstallAppArchiveResultResolver The resolver for an archived InstallAppArchiveResult InstalledAppInfo InstalledAppInfoResolver The resolver for an archived InstalledAppInfo InstalledAppPermissionGroup A top-level permission group (the part of a subgroup key before the first .), under
which the permission UI collapses its subgroups. InstalledAppPermissionGroupResolver The resolver for an archived InstalledAppPermissionGroup InstalledAppPermissionSubgroup One permission subgroup of an app, the unit the user sees, approves, and denies. The
individual messages behind it stay internal to the OS. InstalledAppPermissionSubgroupResolver The resolver for an archived InstalledAppPermissionSubgroup LaunchApp LaunchAppBlocking ListApps ListAppsResolver The resolver for an archived ListApps PermissionRequestInfo PermissionRequestInfoResolver The resolver for an archived PermissionRequestInfo PreviewThirdPartyCertificate PreviewThirdPartyCertificateResolver The resolver for an archived PreviewThirdPartyCertificate RefreshInstalledApp Rescan the app set after a completed in-place replacement. The supplied app is reported as
installed even when its manifest is unchanged, so subscribers also refresh resources such as
icons that are not part of the manifest. RefreshInstalledApps RemoveApp RemoveThirdPartyCertificate RemoveThirdPartyCertificateResolver The resolver for an archived RemoveThirdPartyCertificate SetAppPermissionGrant SetAppPermissionGrantResolver The resolver for an archived SetAppPermissionGrant SubscribeAppEvents SubscribeAppEventsResolver The resolver for an archived SubscribeAppEvents ThirdPartyCertificateInfo ThirdPartyCertificateInfoResolver The resolver for an archived ThirdPartyCertificateInfo AppEvent AppEventResolver The resolver for an archived AppEvent ArchiveLocation Storage an app archive may be installed from: the places a user can put a file, and no
system location. It bounds what InstallAppArchive ArchiveLocationResolver The resolver for an archived ArchiveLocation ArchivedAppEvent An archived AppEvent ArchivedArchiveLocation An archived ArchiveLocation ArchivedGetAppName An archived GetAppName ArchivedIconVariant An archived IconVariant ArchivedInstallError An archived InstallError ArchivedPermissionGrantDecision An archived PermissionGrantDecision ArchivedPermissionRequestInfoResult An archived PermissionRequestInfoResult ArchivedRemoveInstalledAppResult An archived RemoveInstalledAppResult ArchivedRemoveThirdPartyCertificateResult An archived RemoveThirdPartyCertificateResult ArchivedSetAppPermissionGrantResult An archived SetAppPermissionGrantResult ArchivedThirdPartyCertificateError An archived ThirdPartyCertificateError GetAppName GetAppNameResolver The resolver for an archived GetAppName IconVariant Which themed variant of an app’s bundled icon to read. IconVariantResolver The resolver for an archived IconVariant InstallError Why an install did not happen. Every variant is a state the archive or the device is in, so
the caller can say something specific without the server sending it a string. InstallErrorResolver The resolver for an archived InstallError PermissionGrantDecision How the user answered a permission prompt (or moved a Settings toggle) for one
permission subgroup of an app. PermissionGrantDecisionResolver The resolver for an archived PermissionGrantDecision PermissionRequestInfoResult PermissionRequestInfoResultResolver The resolver for an archived PermissionRequestInfoResult RemoveInstalledAppResult RemoveInstalledAppResultResolver The resolver for an archived RemoveInstalledAppResult RemoveThirdPartyCertificateResult RemoveThirdPartyCertificateResultResolver The resolver for an archived RemoveThirdPartyCertificateResult SetAppPermissionGrantResult SetAppPermissionGrantResultResolver The resolver for an archived SetAppPermissionGrantResult ThirdPartyCertificateError Why a publisher certificate cannot be used. The window variants carry the bound the device clock
falls outside of, so a caller holding no certificate can still name the date. ThirdPartyCertificateErrorResolver The resolver for an archived ThirdPartyCertificateError now_unix_seconds The device clock, in seconds since the Unix epoch. 