dartvel_ui library

Classes

AlgoliaSearchProvider<TModel, TFacets>: Algolia query endpoint.
Analytics: Analytics manager supporting multiple providers
AnalyticsEvent
AnalyticsProvider
AnthropicDVAIAdapter: Talks to the Anthropic Messages API (POST /v1/messages).
ApnsPushProvider: Apple Push Notification service.
AuthProvider: Authentication provider
AuthUser: User model
BillingPlan
CustomTransitionPage<T>: Page with custom transition functionality.
DartvelLayout
DartvelPage
DartvelRouteState
DartvelSeo
DartvelTabsLayout: A _layout.dart that makes its folder tabs: a stack per tab, each keeping its pages and their state while another tab is shown.
DV
DV3DSceneDocument: A scene, as a document.
DVAabb: An axis-aligned box.
DVAccelerator: A parsed accelerator.
DVAccessibility
DVAccessibilityCheck
DVAccessibilityKeys: The keys accessibility needs, which a kiosk's hardware-key block must let through. Kiosk blocks escape, never access.
DVAccessibilityReport
DVAccessibilitySwitchControl: The one DVSwitchControlState, reached as DV.Accessibility.switchControl.
DVAccessibilityToggle: The toggle an attract route can carry: switch control on or off.
DVAccount: The signed-in person's account, as the server describes it.
DVAccountPageEntry: A navigation entry for an account page the generated router serves.
DVAccountPages: The gate the generated router puts in front of an account page, and the entries a person can follow.
DVAI
DVAIAdapter
DVAIAgentRequest
DVAIAgentResult
DVAIToolDefinition: A registered AI tool: the handler plus the description and JSON Schema a provider needs in order to decide when to call it.
DVAIToolEntry
DVAIToolRegistry
DVAITranscript
DVAllFilter: Every one of a list of filters.
DVAnchor: What a node is pinned to.
DVAndroidBindings: The Android bindings, unavailable here.
DVAndroidBondWatch: Follows a bond through, one getBondState() reading at a time.
DVAndroidCapture: The capture bridge, unavailable here, and present so the name resolves.
DVAndroidKeystoreAppKeyStore: No Android Keystore without dart:ffi and JNI -- in a browser, say.
DVAnyFilter: At least one of a list of filters.
DVAppKey: The application key: generated once per install and per user, used to encrypt what Dartvel stores at rest on a device.
DVAppKeyCipher: AES-256-GCM over the application key.
DVAppKeySharedStoreCipher: AES-256-GCM under the application key.
DVAppKeyStore: Where the application key is kept.
DVAppLaunch
DVAppLaunchResult: What DVAppLaunch.start decided.
DVAppleStorePolicy: The App Store's conservative default policy.
DVApplicationMenu
DVAppTrackingTransparency: The App Tracking Transparency prompt, through the platform binding.
DVAskForCodePage: The same question as a page. See DV.Auth.AskForCodePage.
DVAssetRef: One bundled file. The generated DVAsset enum implements this.
DVAudioFocus: Arbitrates audio focus between this application's players, and with the platform.
DVAudioFocusBackend: The platform half of audio focus.
DVAuth
DVAuthAuthorization
DVAuthProvider
DVAuthUser
DVAwsCredentials
DVAwsSigV4: Signs requests with AWS Signature Version 4.
DVBackgroundVideo: The video behind a box: DVBox(...).modifier(DVModifier().backgroundVideo( DVAsset.marketingVideo)).
DVBillable: Whether a good is digital or physical, declared rather than guessed.
DVBilling
DVBillingCheckoutSession
DVBillingCustomer: A domain object that says which billing customer it is.
DVBillingProvider
DVBillingWebhookReceiver: A provider that accepts signed webhooks.
DVBillingWebhookResult: What a webhook did.
DVBiometrics
DVBluetooth
DVBluetoothAdapter: A Bluetooth adapter on this machine.
DVBluetoothDevice: A Bluetooth device this machine knows about: paired, connected, or seen.
DVBool: A bool living in a DVPlatformMemory.
DVBox<T>
DVBrowserExtension
DVBrowserMenu: The web's two right-click menus, and which one the next click gets.
DVBrowserWindowResult: The result of asking the browser for a window.
DVCache: The cache behind DV.Cache, on the store dartvel.cache names.
DVCacheAdapter: Storage behind DV.Cache. Expiry is the adapter's responsibility: a read of an expired key must behave exactly like a read of a missing key.
DVCacheAdmin: The cache and tag explorer: which tags exist, what they cover, and a way to revalidate one.
DVCacheTag: Every key tagged name: DV.Cache.delete(const DVCacheTag('products')).
DVCacheTarget: What DVCacheView.delete drops besides a String key: a DVCacheTag, or DVCache.all.
DVCacheView: The four calls, on one store: DV.Cache, or the store DVCache.withAdapter switched to.
DVCamera
DVCancellation: A request to stop, which a caller or an owner's lifecycle can make.
DVCaptureBackend: A capture device.
DVCaptureBackendEvent: Something the device reports.
DVCaptureCapabilities: What this target's capture backend can record. Reported, never assumed.
DVCaptureDeviceLost: The device went away: unplugged, taken by another application.
DVCaptureFailed
DVCaptureFiles: Where recordings are written.
DVCapturePermissionRevoked: The operating system withdrew the permission while recording.
DVCapturePermissions: The runtime permission flow, as capture uses it.
DVCaptureRequest: What was asked for.
DVCaptureSession: One recording.
DVCaptureStarted: The device is open and recording.
DVCaptureStopped: The device is closed and the file finalised.
DVClassWidget: A Dartvel page widget represented as a class.
DVClipboard
DVCodeEntry: The field, the button and the message, shared by the modal and the page.
DVComfort: Comfort is policy, not advice.
DVComfortOptions: The comfort options an immersive space offers.
DVComfortResolution: What the policy made of what was declared.
DVConsentBanner: Asks for consent over child until somebody answers under the current policy version.
DVConsentSettingsPage: Every declared category with a switch, and a save.
DVConsentSpatialConsent: DVSpatialConsent answered by DVConsent.
DVConservativeStorePolicy: The conservative default: every digital good sold in a store build goes to that store, whatever the jurisdiction; everything else goes to the gateway.
DVContacts
DVContentAction: The policy actions the workflow checks, registered like update and delete through DV.Auth.authorization.register<User, Document>(...).
DVContentApproval: Which version was approved, by whom and when. Travels with a bundle, so a rollback restores the fact that the restored version was the reviewed one.
DVContentReport: Something the workflow reported rather than threw, or threw and also recorded, because the caller was a job with nobody to throw to.
DVContentScheduledJob: The payload of a scheduled publish or withdrawal on DVQueues.
DVContentServed<T>: What to serve for a document, and how it may be served.
DVContentTransition: One state change, from Record History.
DVContentVersion<T>: One version of one document, as read.
DVContentWorkflow<T>: The workflow for one kind of stored document.
DVContext: The context handed to a DV.transaction body and to backend functions.
DVContextLifecycle: Lifecycle signals scoped to a single context.
DVContrastCheck
DVCrashes: DV.Crashes.
DVCrashInstallation: One installation of the crash reporter into this process.
DVCronEntry
DVDatabase: The database facade behind DV.Database.
DVDatabaseAdapter
DVDatabaseCacheAdapter: Cache backed by a DVDatabaseAdapter, so cache entries survive process restarts and can share the application's database.
DVDatabasePurchaseLedger
DVDatabaseQueueAdapter: Queue storage backed by a DVDatabaseAdapter, so dispatched jobs survive a process restart. With SQLite this is the durable local queue the spec calls for, sharing one database file with the application and cache.
DvDataLoader
DvDataScope
DVDeepLinks
DvDefaultError
DvDefaultLoading
DVDerivedSignal<T>: A signal produced by operating on other signals.
DVDesktopPermissions
DVDeviceControls
DVDeviceDiagnosticsBundle
DVDeviceHealth
DVDeviceKiosk
DVDeviceProbes: What a platform reads for the manifest and health.
DVDeviceProvisioningResult
DVDeviceRuntime
DVDialogs
DVDigitalBillable: See DVBillable.digital.
DVDisplay: A display the application can address.
DVDisplayControls
DVDisplayHint: Which display a window is asking for.
DVDisplayResolution: What a hint resolved to, and whether it was what was asked for.
DVDisplays: Reads display lists and resolves hints against them.
DVDisplayState
DVDistributedCacheAdapter: Spreads keys across several cache nodes.
DVDouble: A double living in a DVPlatformMemory.
DVDragDrop
DVDrmAdapter: A licence-acquiring integration for one or more DVDrmSchemes.
DVDrmProtection: That a source is protected, and by what.
DVDropEvent: One drop onto the window.
DVEntitlementSnapshot: An entitlement as a device holds it: what, and until when.
DVEntitlementSnapshots: The entitlement snapshots a device holds, checked against its clock.
DVEnvironment: The image-based lighting a scene is lit by.
DVExportOptions<TModel>
DVExportResult
DVFakeAudioFocusBackend: Audio focus the test grants, refuses and takes away.
DVFakeCaptureBackend: A capture device the test drives.
DVFakeCapturePermissions: Permissions granted by name.
DVFakeDrmAdapter: A DRM adapter that licenses anything in its scheme.
DVFakeMediaPlayerBackend: A player backend that records what it was asked and emits what it is told.
DVFakeMediaTimers: Timers that fire when the test says time has passed.
DVFakeStoreAdapter
DVFieldCipher: AES-256-GCM over a server-held keyring, for model fields stored in a database.
DVFieldEncryption: How generated models reach the field cipher.
DVFieldFilter: A field compared with a value.
DVFieldKey: One key an operator has put on the field keyring.
DVFieldKeyring: The keys available to a process for model-field encryption.
DVFile: A file on this device, with what is known about it.
DVFileAssociations: Registering this application as the handler for its own file types.
DVFileBindings: Registers the file bindings against register.
DVFileFilter: A file-type filter the chooser offers: Text (*.txt).
DVFiles
DVFileSessionTokenSink: A sealed session token in a file.
DVFileStorageAdapter
DVFileType: One file type this application opens.
DVFilter: Which records an operation applies to: a tree of comparisons, rather than a WHERE string only a SQL engine could run.
DVFleetProvisioningRequest
DVFold: A fold or hinge through the screen, as the platform reports it.
DVForm<T>
DVFormControls
DVForwardingMediaSignal<T>: A signal that reads whichever signal it currently points at.
DVFullscreenOptions
DVFunctionStore: Stores workflow documents, the way DVPageStore stores pages: saving publishes, because a workflow is data. Where the functions built in Studio are kept.
DVGlobalShortcut
DVGltf: The glTF inspector.
DVGltfSummary: What a model contains.
DVGoRoutes: An existing application's go_router routes, mounted as they are.
DVHaptics
DVHardwareCapability
DVHardwareCapabilityManifest
DVHardwareKeys: Maps a remote's or keypad's hardware keys onto focus and activation, with nothing switched on: the D-pad moves focus in that direction (the first press lands on the first control), and select, Enter, or a gamepad's A activate what is focused.
DVHomeWidgets: The application's side of a home widget's data.
DVHomeWidgetSpec
DVHostedPage: Dartvel's routes, run by a router of their own inside a host's route.
DVHttpAIAdapter
DVHttpMailProvider: Shared behaviour for mail providers that speak HTTP.
DVHttpRequest
DVHttpResponse
DVHttpSearchProvider<TModel, TFacets>: Shared behaviour for hosted search services reached over HTTP.
DVI18n
DvI18n
DvI18nScope
DVImage: An image held by a model field.
DVImageRender
DVImageVariants: The widths images are resized to, and what can be resized.
DVImportChunk
DVImportResult<TModel>
DVImportRowError
DVInMemoryQueueAdapter
DVInMemorySearchProvider<TModel, TFacets>: A concrete local search provider for development, tests, and small apps.
DVInstall: DV.Platform.install.
DVInstallPrompt: Holds the deferred browser event, and tells anyone who cares.
DVInt: An integer living in a DVPlatformMemory.
DVInvoice: One invoice from a billing provider.
DVIosBindings: The iOS bindings, unavailable here.
DVJob: Annotation for a durable background job.
DVJobEnvelope<TPayload>
DVJobPayload: Type-erased queue storage marker. User job payloads remain strongly typed at dispatch and handler registration boundaries.
DVJobPayloadCodec<TPayload>: Converts a job payload to and from JSON so a durable queue can store it.
DVJobPayloadCodecs: Codecs that let DVDatabaseQueueAdapter persist job payloads.
DVJsonBool
DVJsonCodec: Converts between Dartvel's typed DVJsonValue tree and the plain Object? tree that dart:convert produces and consumes.
DVJsonList
DVJsonMap
DVJsonNull
DVJsonNumber
DVJsonString
DVJsonValue
DVKeyboardScroll: Scrolls the page beneath it when the keys a reader expects are pressed.
DVKiosk
DVKioskDiagnosticsScreen: What an operator sees when the device cannot stay up: the finding, and a way to clear it once the cause is fixed.
DVKioskEnforced: What enforcement actually did.
DVKioskEnforcement: What a device will actually do with a declared policy.
DVKioskEscapeKeys
DVKioskExitRequest: A request to leave kiosk mode.
DVKioskExitResult: What came of an exit attempt.
DVKioskHost
DVKioskOptions
DVKioskPolicy: One kiosk's declared policy.
DVKioskReset: What a reset cleared, and where it left the kiosk.
DVKioskRuntime: The kiosk state machine.
DVKioskSignal<T>: A minimal read-only signal, so this package needs no Flutter.
DVLifecycleRegistry: The lifecycle signals reachable from DV.lifecycle.
DVLifecycleSignal<T>: A read-only reactive value.
DVLight: A light.
DVLinkOpener
DVLinuxBindings: The Linux desktop bindings, unavailable here.
DVLocalAuthProvider: Development and test auth adapter.
DVLocalBillingProvider
DVLocation
DVMacosAssociations: The macOS file associations, unavailable here.
DVMacosBindings: The macOS bindings, unavailable here.
DVMacosDialog: A macOS dialog, unavailable here.
DVMacosDialogs: The macOS dialogs, unavailable here.
DVMacosDialogSeen: What a macOS dialog showed, unavailable here.
DVMacosDragDrop: The macOS dragging destination, unavailable here.
DVMacosKiosk: The macOS kiosk enforcement, unavailable here.
DVMacosMenus: The macOS application menu, unavailable here.
DVMacosPrinting: Printing, unavailable here.
DVMacosShortcuts: The macOS global shortcuts, unavailable here.
DVMacosTray: The macOS tray icon, unavailable here.
DVMailAddress
DVMailMessage
DVMailProvider
DVMailTemplate: A mail message as translation keys, rendered per recipient locale.
DVMat4: A 4x4 matrix, column-major: element (row r, column c) is storage[c * 4 + r].
DVMedia
DVMediaBackendCapabilities: What a backend on this target can do. Reported, never assumed.
DVMediaBackendEvent: Something a backend reports.
DVMediaBackends: Where native bindings register the players and capture devices they implement.
DVMediaBuffered
DVMediaBuffering: Waiting on data, by the backend's own account.
DVMediaCapture: The capture runtime behind DV.Platform.Media.
DVMediaCompleted
DVMediaController: A handle on a player.
DVMediaEnvironment: What a player is wired to. Defaults are the process's own.
DVMediaFailed
DVMediaPaused
DVMediaPlayerBackend: A platform player.
DVMediaPlaying: Frames or samples are actually being rendered.
DVMediaPosition: Where playback is, as of the last seek the backend has completed.
DVMediaReady: Loaded and able to play; paused.
DVMediaSeekCompleted
DVMediaSignal<T>: A read-only reactive value driven by the media runtime.
DVMediaSource: What is played. The box owns size and gestures; this owns content.
DVMediaTimer: One scheduled callback.
DVMediaTimers: Where the media runtime gets its timers.
DVMediaTransportKeys: Remote-control keys, mapped to the controller by default.
DVMemcachedCacheAdapter: DV.Cache on Memcached.
DVMemory: A factory, not a singleton arena: every allocate is an independent DVPlatformMemory with its own budget, segments, cursor and lifecycle.
DVMemoryAppKeyStore: Holds the key for the lifetime of the process only.
DVMemoryBacking: Reserves segments for an arena.
DVMemoryCacheAdapter: Process-local cache. The default, and what DV.Cache used exclusively before adapters existed.
DVMemoryConfig: The parsed dartvel.memory section, with any device-profile overrides.
DVMemoryDiagnostic: A diagnostic an arena recorded about itself, e.g. DV-MEMORY-001.
DVMemoryFileStorageAdapter: Process-local storage. The default, and what DV.FileStorage used exclusively before adapters existed.
DVMemoryHeapBacking: Segments allocated as typed data on the Dart heap.
DVMemoryHeapSegment: A segment on the Dart heap: an ArrayBuffer on web.
DVMemoryMailProvider
DVMemoryNotificationProvider
DVMemoryPurchaseLedger: A ledger in memory, for tests and development. A restart loses it.
DVMemoryRecordEngine: An in-memory database that runs the record operations and no SQL.
DVMemorySegmentStore: One reserved segment.
DVMemorySessionTokenStore: A token held for the life of the process only.
DVMemorySettings: What configuration says for one target.
DVMemorySharedStoreBackend: The default backend: in memory, with no cross-engine notification.
DVMemorySpatialAnchorStore
DVMemoryUsage: Aggregate usage across every live arena DV.Memory created.
DVMenuItem
DVMenus
DVMesh: A procedural shape.
DVMfa: When a route or a backend function needs a second factor.
DVMiddleware: Annotation for backend function/page middleware.
DVMiddlewareKey
DVMiddlewares
DVModel3D: An imported model.
DVModel3DFieldPolicy: The upload limits of one 3D model field, as the generator writes them into Model.model3dFields.
DVModel3DProblem: One reason an upload was refused.
DVModel3DValidation: The outcome of checking an upload against a field's policy.
DVModel3DViewer: An orbit viewer for one 3D asset: DVBox.scene with the model, a camera the user can turn, a key light and the studio environment.
DVModelAdmin<T>: Generated CRUD admin for one model.
DVModelChange<T>: One model change, as delivered to watchers.
DVModelWatch: A running Model.watch(...). Cancel it when the watcher goes away.
DVModifier
DVModule: A mounted Dartvel module.
DVModuleRegistry: The registry behind DV.Modules.
DVMoney: An amount in a currency's minor units.
DVMutableLifecycleSignal<T>: The framework-facing half of a lifecycle signal.
DVMutableMediaSignal<T>: The runtime-facing half of a DVMediaSignal.
DVNativeBridge
DVNavigation: Context-free navigation over the generated route targets.
DVNavLink: A navigable link to a route.
DVNetwork: DV.Platform.network.
DVNfc
DVNode: A group: a transform its children share.
DVNotificationAttempt: One channel's result, including the ones that went nowhere.
DVNotificationDelivery: Everything one send did, per channel.
DVNotificationMail
DVNotificationMessage
DVNotificationPreferences: What a recipient has asked to receive.
DVNotificationProvider
DVNotificationRoutes: Where one recipient can be reached, per channel.
DVNotifications
DVNotificationsService
DVNotificationTemplate: A notification as translation keys, rendered per recipient locale.
DVNullFilter: A field that is, or is not, null.
DVNullSharedStoreCipher: The default when no application key has been provided.
DVOAuth2Authorization: A started authorization. Hold this until the provider redirects back: the state proves the callback belongs to this attempt and the codeVerifier proves the exchange comes from whoever started it.
DVOAuth2Client: Drives the authorization-code flow with PKCE.
DVOAuth2Config: Endpoints and client identity for one identity provider.
DVOAuth2Tokens
DVObservabilityAndLogging
DVOneTimeCode: One-time codes, as digits.
DVOutboxAdmin: The mail and notification outbox.
DVOwnedCloseSample
DVPaddleBillingProvider: Paddle Billing (the v2 API) for subscriptions, with entitlements kept from webhooks.
DVPageBundle: A set of page documents shipped together — the unit an OTA patch carries.
DVPageBundleInstaller: Applies page bundles delivered with a release or OTA patch.
DVPageChrome: Whether the page inside this subtree should draw its own scaffold.
DVPageDocument: A builder-editable page: a route, a title, and a widget tree.
DVPageDocumentDiff: The node-level difference between two versions of one page.
DVPageDocumentEditor: The operations a drag-and-drop surface calls. UI gestures reduce to these four; everything else in the builder is chrome around them.
DVPageDocumentRenderer: Renders a document as the real widgets it describes.
DVPageLifecycleHost: Wraps a page and moves its lifecycle.
DVPageLifecycleScope: The page lifecycle signal a subtree can reach.
DVPageMfa: Answers whether this device's session may open a page, for the generated router.
DVPageMiddleware: Runs a page's declared middleware, for the generated router.
DVPageNode: One widget in a page document.
DVPageNodeChange: One node that was added, removed, moved or changed.
DVPagePolicy: Answers whether this caller may open a route, for the generated router.
DVPagePropertyChange: One property that differs, with both values.
DVPageScaffoldSpec
DVPageShell
DVPageSitemap: A page's entry in sitemap.xml.
DVPageStore: Stores documents through DV.Database, WordPress-style: page content is data, so saving is publishing.
DVPageUpdateResult
DVPasswordHasher: PBKDF2-HMAC-SHA256 password hashing.
DVPermissions
DVPhysicalBillable: See DVBillable.physical.
DVPlatform
DVPlatformMemory: An arena over a preallocated memory budget.
DVPlatformXRPermissions: Camera permission through DV.Platform.permissions.
DVPlayStorePolicy: Google Play's conservative default policy.
DVPluralForms: The plural forms a message has, in one language.
DVPolicies
DVPolicy: Annotation for model/resource authorization policies.
DVPolicyAction
DVPolicyAdmin: The policy and permission explorer, and the model sync channel inspector.
DVPresence: Channel membership.
DVPresenceEvent
DVPresenceMember: One participant on a channel.
DVPressedLinkTarget: Opening a destination beside the current one.
DVPrinting
DVPrintResult
DVPrivateCaptureFiles
DVProcessAudioFocusBackend: A backend for a target with no platform focus to negotiate: always granted, never lost. Arbitration between this application's own players still happens in DVAudioFocus.
DVProgress: How far through a task is.
DVPurchaseChange: Entitlements a customer gained or lost, after the change committed.
DVPurchaseGrant: One purchase's standing in the ledger: who holds it and until when.
DVPurchaseLedger: Where grants are kept.
DVPurchaseProduct: Something the application sells, and what owning it unlocks.
DVPurchaseResult: What a verification or notification did.
DVPurchases: DV.Purchases: store purchases, verified on the server, written to the ledger entitlements are read from.
DVQrCode: A QR code symbol: a square of modules, true for dark.
DVQrImage: A QR code drawn with a four-module quiet zone, dark on white whatever the theme: a scanner needs contrast, and a light-on-dark code is one many cameras will not read.
DVQuat: A rotation, as a unit quaternion.
DVQueueAdapter
DVQueueAdmin: The queue and job dashboard: what is waiting, what has died, and the two things an operator can do about a dead letter.
DVQueues
DVQuietHours: A daily window during which interruptive channels stay quiet.
DVRange: A span of media time, e.g. one buffered range.
DVRaster
DVRay: A half-line: every point origin + direction * t for t >= 0.
DVReadableSignal<T>: A reactive value that can be read, whether it stores its own state or is derived from signals that do.
DVRecordAdapter: The operations every database engine implements.
DVRecordShape: A collection: its name, the field that identifies a record, and the fields a record has.
DVRedisCacheAdapter: DV.Cache on Redis (or Valkey).
DVReportResult
DVRoute: A path and the screen it shows. GoRoute, typed.
DVRouteAdmin: The route and page explorer.
DVRouteDegradations: Opens and degradations at one call site.
DVRouteInfo: One generated route, as the route explorer sees it.
DVRouteNode: One entry in lib/routes.dart.
DVRoutePending: What a route shows while its first location is resolving.
DVRoutePrefetch: The two steps of a document prefetch, replaceable for tests and for a host that serves its pages some other way.
DVRoutePreloaders: Route loaders, so a link can fetch what it points at.
DVRoutePreviews: Route builders, so a link can show what it points at.
DVRouter
DVRouteState: What a config route's builder and redirect are told about the match.
DVRouteTarget
DVRust
DVRustInt
DVScene: The 3D content of a DVBox.scene.
DVScene3D: The application's 3D configuration.
DVSceneAsset: A reference to a 3D asset, with what is needed to trust it.
DVSceneAssetChange: One asset's state changing.
DVSceneAssetLoader: Loads scene assets under a policy.
DVSceneAssetPolicy: What an application allows its scenes to load.
DVSceneAssetRefusal: Why an asset reference was refused before it was fetched.
DVSceneAssetState: The state of one asset.
DVSceneBoxFactory: DVBox.scene(...).
DVSceneCamera: The camera a viewport draws from.
DVSceneCameraData: A camera's projection, and optionally the orbit it is controlled by.
DVSceneCanvasRenderer: A renderer that draws onto a Flutter canvas: the shape a Flutter GPU adapter takes, rendering to a texture and drawing it here.
DVSceneController: Reads what a viewport is doing: whether it renders, and if not, why.
DVSceneDraw: One thing to draw.
DVSceneFake: The headless backend DV.Test.fake3D() installs.
DVSceneFrame: Everything a renderer needs to draw one frame.
DVSceneGraph: A scene graph built from a DV3DSceneDocument.
DVSceneLight: A light's parameters.
DVSceneLightDraw: One light in a frame.
DVSceneNode: A node in a DVScene.
DVSceneNodeData: One node in a scene document.
DVScenePick: A node a ray hit.
DVScenePrimitive: A procedural shape, in the node's local space, centred on its origin.
DVSceneRecordingRenderer: A headless renderer that records what it was asked to do.
DVSceneRenderer: A 3D renderer.
DVSceneResolved: What a DVScene resolves to on one build.
DVSceneResource: A renderer-side resource made from one asset.
DVSceneRuntime: A scene document, loaded and bound to a renderer.
DVSceneView: A perspective camera, with the orbit it is controlled by.
DVSceneViewport: The widget inside DVBox.scene.
DVScheduledReport
DVScreen
DVScreenInfo
DVSealedSessionTokenStore: A session token sealed with AES-256-GCM under the application key before it reaches sink.
DVSearchProvider<TModel, TFacets>
DVSearchResultPage<TModel>
DVSecondFactorStatus: What second factors the signed-in person has.
DVSecrets: Reads secrets from the process environment, then .env.
DVSensors
DVSentNotification
DVSerial: The serial ports, under DV.Platform.device.serial.
DVSerialConnection: An open serial port.
DVSerialPort: A serial port this machine has.
DVSession: A signed-in device.
DVSessionAuthProvider: DV.Auth's provider over DVSessionClient: e-mail and password against the generated backend.
DVSessionClient: The generated backend's sessions, from the device.
DVSessionSignal: DV.Session: this device's session, as a read-only signal.
DVSessionTokenSink: Where a sealed token's bytes go: a dumb sink, because the sealing happens before anything reaches it.
DVSessionTokenStore: Where a native client keeps its session token.
DVShare
DVSharedStoreAnchorStore: World anchor tokens under xr.anchors.* in the shared window store.
DVSharedStoreBackend: Where a shared value is actually kept, and how a change reaches another window.
DVSharedStoreCipher: Encrypts values before they reach the backend.
DVShell
DVShellBranch: One tab of a DVStatefulShellRoute.
DVShellCommand
DVShellNavigation: The tabs a DVStatefulShellRoute's builder places, and switches between.
DVShellResult
DVShellRoute: A frame around child routes, which render in a nested navigator. ShellRoute, typed.
DVShorebirdNative: The Shorebird updater's C API, as Dart sees it.
DVShorebirdUpdates
DVShortcuts
DVShowingPages: Work that belongs to a running application: started with its first page on screen and stopped with its last.
DVSignal<T>
DVSignedStoreNotification: A notification body with the headers that sign it.
DVSize: A byte count. Units are binary: DVSize.mb(1) is 1,048,576 bytes.
DVSmtpClient
DVSmtpConnection: One SMTP connection. The transport is abstracted so tests drive a scripted conversation instead of opening a socket.
DVSort: An order to return records in.
DVSpatialAnchorStore: Where world anchor tokens are kept between launches, by anchor id.
DVSpatialCapability: DV.Window.capability.spatial: null on every target that is not a headset or glasses.
DVSpatialConsent: Whether a use of environment data is agreed to.
DVSpatialConvention: The coordinate convention a device reports poses in.
DVSpatialFrameMonitor: Watches frame intervals against a device profile's target rate.
DVSpatialInputEvent: One input.
DVSpatialLightProbe: Lighting estimated from the real environment. Environment data: it never prints its values.
DVSpatialPersistence: Whether the OS keeps pinned panels across reboot: all of them, a bounded number, or none. Dartvel remembers no placements of its own.
DVSpatialPose: A rigid pose in world space: right-handed, Y up, metres -- the space DVSceneGraph computes world matrices in.
DVSpatialPresentation: The answer to a request to present in space.
DVSpatialSession: A presentation in space: one volume or immersive space, owned by the window that opened it.
DVSpatialSpaceRequest: What a window asked to present in space.
DVSqliteSearchProvider<TModel, TFacets>: Full-text search backed by SQLite's FTS5 extension.
DVSqlRecordAdapter: The record operations compiled to SQL, for SQLite, PostgreSQL, MySQL and the in-memory development database.
DVStartupFinding: A phase, or the whole startup, that went over its budget.
DVStartupPhase: One phase of startup: what it was, when it ended, and how long it took.
DVStartupProfile
DVStatefulShellRoute: Tabs: each branch keeps its own navigation stack. StatefulShellRoute.indexedStack, typed.
DVStorage
DVStoreAdapter: One store's server-side verification.
DVStoredImage
DVStoreMoney: Store amounts in integer minor units, exactly.
DVStoreNotification: A store server notification, after its signature was verified.
DVStorePolicy: Decides where a purchase goes.
DVStorePrices: The price a purchase button shows.
DVStorePriceSource: Reads prices from a store, on the device.
DVStoreTransaction: A purchase as the store's server describes it.
DVStripeBillingProvider: Stripe Checkout for subscriptions, with entitlements kept from webhooks.
DVStudioApp: The whole of Studio, as a web-server binary serves it.
DVStudioCanvas: The editing canvas.
DVStudioClient: Studio's calls to the backend it is served by.
DVStudioColor: A Studio colour with a light and a dark value, still const.
DVStudioContent: The content workflow for Studio page documents, wired to the page store and to DV.Cache.
DVStudioEdit: One editor mutation as data.
DVStudioEditorController: Editing state for one page document: what is selected, what changed, and how to undo it.
DVStudioField: One field of a model, as the backend describes it.
DVStudioIconButton: A square icon control with a hover state: toolbar actions, rail items, panel header actions.
DVStudioIcons: Icons Studio names in more than one place, so a page is the same glyph in the rail, the page list and the dashboard.
DVStudioInApp: Studio inside the application it manages, on whatever it runs on.
DVStudioInspector: Edits the selected node's properties.
DVStudioLayers: The document as a tree: every node, nested the way the page nests it.
DVStudioLayoutProperty: A property that is an argument to the box rather than a modifier on it.
DVStudioLeafType: A leaf node type the page builder can place.
DVStudioListRow: A row in a Studio list: a page, a layer, a workflow, a revision.
DVStudioLivePage: A compiled page drawn on the artboard, as the application draws it, at a device's width. A preview: it is looked at, not clicked through.
DVStudioMarkPainter: Paints the Dartvel mark in its brand gradient, or flat in color.
DVStudioModel: A model, as the backend describes it.
DVStudioModelsSection: Every model the backend declares, a model's records, and a record's form.
DVStudioModule: One module, as the graph records it.
DVStudioModulesSection: Studio's Modules section.
DVStudioPageRoute: Serves the Studio document for route when one exists, and fallback otherwise.
DVStudioPalette: The elements a page can be built from, grouped, searchable, and each one draggable onto the canvas or insertable with a tap.
DVStudioPaletteItem: What the palette drags and the canvas accepts.
DVStudioProperty
DVStudioRecordData: One stored record, at the version it was read.
DVStudioRemoteFunctionStore: The functions built in Studio, kept on the server that served it.
DVStudioRemotePageStore: A page store kept on the server Studio is served by.
DVStudioReply: What the backend answered: a status and the decoded JSON body.
DVStudioScreen: The Studio admin surface: a navigation rail, and the section it opens.
DVStudioSection: A section in Studio's switcher.
DVStudioSegment<T>: One option in a DVStudioSegmented.
DVStudioSegmented<T>: A set of mutually exclusive options drawn as one control: device width, text alignment, a layout's direction.
DVStudioSitePage: One route of the site.
DVStudioSiteSource: Where Studio's Pages section learns the site.
DVStudioStyle: Studio's design system: the colours, spacing, type and controls every Studio screen — and every section attached to one — is built from.
DVStudioSurface: A surface that material widgets inside it can paint on.
DVStudioTextInput: A single-line text input in Studio's style.
DVSwitchControl: Makes child drivable by one or two switches while switch control is on.
DVSwitchControlSettings: Which keys are the switches.
DVSwitchControlState: Whether switch control is on. One per application, so the generated toggle on an attract route and every DVSwitchControl on every page agree.
DVSystemMediaTimers: dart:async timers.
DVTab: A tab is a route.
DVTable<T>: A table over rows.
DVTableColumn<T>: One column: its heading, how to read a cell out of a row, and optionally how to sort by it.
DVTableFocusPosition: Which cell the keyboard is on.
DVTableHeaderCell: A header cell, as its own type so a test can find one.
DVTableState<T>
DVTabWorkspace
DVTabWorkspaceController: The state behind a tab strip: order, selection, tear-out and adoption.
DVTappableTargetCheck
DVTelemetryAdmin: Entitlements and recorded events.
DVTenants: Resolves a tenant from a request, and holds the tenant the current work is running for.
DVTerminalSize: Columns and rows of a terminal.
DVTerminalSurface: The terminal an application is drawing into.
DVTestHarness
DVText
DVTheme
DVTopProgress: The loads an application is waiting on, for the bar at the top of the page. Reached as DV.progress.
DVTopProgressBar: The bar itself: three points high, the theme's primary colour unless DVTopProgress.color says otherwise, and still when the platform asks for reduced motion.
DVTransactionRunner: Runs reversible units of work.
DVTransform: A node's local transform: translation, rotation and scale.
DVTranslationCatalog
DVTranslationKey: A translation key, typed rather than a bare string.
DVTray
DVTrayMenuItem
DVUnconfiguredSearchProvider<TModel, TFacets>: Fails loudly when a searchable model has no configured provider.
DVUpdateInfo
DVUpdateRollout: Staged rollouts: which devices a release has reached yet.
DVUpdates
DVUsageMeter: Something an application counts and a provider bills for.
DVUsb: The USB bus, under DV.Platform.device.usb.
DVUsbDevice: A device on the bus.
DVUseMiddleware: Typed annotation for page, layout, model, storage, and backend middleware.
DVVec3: A point or a direction in three dimensions.
DVVideoSurface: A backend that draws frames. A player backend implements this when it renders video into Flutter; one that does not plays audio under a poster.
DVVolumeOptions: The size a volume asks for, in metres. A hint: the OS decides.
DVWebBindings: The browser bindings, unavailable here.
DVWebCryptoAppKeyStore: WebCrypto is the browser's; there is none here.
DVWebPushKeyPair: An application server key pair — the sender's identity to the push service, and the ephemeral half of the key agreement.
DVWebPushSubscription: The subscription a browser hands back from PushManager.subscribe().
DVWindow: A window, real or virtual.
DVWindowingCapability: What a target can actually do with windows.
DVWindowingDeclaration: What a project declared under dartvel.windowing.
DVWindowKiosk: A kiosk window's policy, as DVWindowOptions.kiosk. Names a declared policy -- DVKioskPolicies.<name> -- so a kiosk window opened at runtime obeys one the declaration knows.
DVWindowKioskHandle: What a kiosk window can be asked: its state, what this platform honours for one display, a session reset, and the one way out.
DVWindowManager: The window manager.
DVWindowOpenSample
DVWindowOptions
DVWindowPerformance: What the windowing layer measures, and what it finds in the measurements.
DVWindowPerformanceFinding
DVWindowsAssociations: The Windows file associations, unavailable here.
DVWindowsBindings: The Windows bindings, unavailable here.
DVWindowsDialog: A Windows dialog, unavailable here.
DVWindowsDialogs: The Windows dialogs, unavailable here.
DVWindowsDialogSeen: What a Windows dialog showed, unavailable here.
DVWindowsDragDrop: The Windows drop target, unavailable here.
DVWindowSharedStore
DVWindowsKiosk: The Windows kiosk enforcement, unavailable here.
DVWindowsMenus: The Windows application menu, unavailable here.
DVWindowsPrinting: Printing, unavailable here.
DVWindowsShortcuts: The Windows global shortcuts, unavailable here.
DVWindowState: A window size worth restoring.
DVWindowsTray: The Windows tray icon, unavailable here.
DVWindowTearOutSample
DVWorkerBuffer
DVWorkerCapability: What a target's workers are, reported rather than hidden.
DVWorkerLease
DVWorkerLendable: Something a caller lends a worker for the length of one run -- native memory, today. It comes back with the worker's answer, or, when the run was cancelled or timed out, only once the worker's thread has ended.
DVWorkerProfile: How many workers a device gets, from what the device is.
DVWorkerReporter: What a task is given to report through.
DVWorkerResult<O>: The answer to one DV.Workers.run.
DVWorkers: The pool.
DVWorkerTasks: Tasks a web worker can be asked to run, by name.
DVWorkflowCanvas: The workflow canvas: steps as cards in execution order on a dot-grid workspace, joined by connectors, with a condition's two branches side by side under it as their own drop targets.
DVWorkflowDocument
DVWorkflowDocumentEditor: Structural edits to a workflow's step tree.
DVWorkflowEditorController: Editing state for one workflow: selection and undo/redo, the same bargain the page editor makes.
DVWorkflowInspector: Edits the selected step: its action, arguments and result variable.
DVWorkflowPalette: The draggable step palette, as insert tiles.
DVWorkflowPaletteItem: A step type the palette can drop.
DVWorkflowParameter: An input a workflow takes: a name, a type and whether it may be left out.
DVWorkflows: The registry of actions a workflow may call, and the runner that executes one.
DVWorkflowStep: One step in a workflow.
DVWorkflowStore
DVWorkflowValue: A value a step consumes: either a literal or a reference to a variable.
DVWorkspaceRestoreSample
DVXR: Where DV.Window gets its XR runtime.
DVXRAnchorChanged: An anchor moved, in the device's convention; no pose means it was lost.
DVXRBindingDevice: The XR device reached through generated native bindings.
DVXRDevice: An XR device.
DVXRDeviceEvent: Something the device reports.
DVXRFakeDevice: A headless device, and what DV.Test.fakeXR installs.
DVXRFrameTimed: One displayed frame.
DVXRHeadPoseChanged: Where the head is, in the device's convention. Body data.
DVXRInput
DVXRPassthroughChanged: The camera feed behind a space turned on or off.
DVXRPermissionRevoked: A permission was withdrawn while the session ran -- from system settings, or by the OS.
DVXRRuntime: The XR runtime for one application.
DVXRSpaceEnded: The system closed the space: the user left it with the home gesture, or another application took the immersive space.
DVXRTrackingChanged
Entitlement
FirebasePushProvider: Firebase Cloud Messaging, HTTP v1.
GeminiDVAIAdapter: Talks to the Gemini generative-language REST API.
GoRoute Get started Configuration Redirection Transition animations Named routes: A route that is displayed visually above the matching parent route using the Navigator.
GoRouteData Type-safe routes: A class to represent a GoRoute in Type-safe routing.
GoRouteInformationParser: Converts between incoming URLs and a RouteMatchList using RouteMatcher. Also performs redirection using RouteRedirector.
GoRouteInformationProvider: The RouteInformationProvider created by go_router.
GoRouter Get started Upgrading Configuration Navigation Redirection Web Deep linking Named routes Error handling: The route configuration for the app.
GoRouterDelegate: GoRouter implementation of RouterDelegate.
GoRouterState: The route state during routing.
ImperativeRouteMatch: The route match that represent route pushed through GoRouter.push.
InheritedGoRouter: GoRouter implementation of InheritedWidget.
LocalAnalyticsProvider: In-memory analytics provider for local development and tests.
LocalAuthProvider: In-memory auth provider for local development and tests.
LocalDVAIAdapter: Deterministic in-process adapter for development and tests. It never reaches the network, so tests cannot accidentally pass because a provider was unreachable.
LocaleTag
LocalPushNotificationProvider: In-memory push provider for local development and tests.
MailgunMailProvider: Mailgun messages API. Unlike the others this is form-encoded, and it authenticates with HTTP Basic using the literal user name api.
MeilisearchProvider<TModel, TFacets>: Meilisearch search endpoint. Paging is 1-based, matching Dartvel.
MemoryDVDatabaseAdapter: The development database: an in-memory table store that runs the subset of SQL Dartvel itself issues.
MemorySlice<T extends Object>: A list of primitives living in a DVPlatformMemory.
NoTransitionPage<T>: Custom transition page with no transition.
OllamaDVAIAdapter: Talks to a local Ollama runtime. The API key is optional and only sent when the runtime is fronted by an authenticating proxy.
OpenAIDVAIAdapter: Talks to the OpenAI REST API. OpenRouterDVAIAdapter reuses this wire format against a different host.
OpenRouterDVAIAdapter: OpenRouter exposes the OpenAI chat-completions wire format under its own host. It does not serve embeddings or transcription.
OpenSearchProvider<TModel, TFacets>: OpenSearch and Elasticsearch, which share this query API.
PageTransitionSpec
PostmarkMailProvider: Postmark single-message send.
PushNotification: Push notification message
PushNotificationProvider: Push notification provider
PushNotifications: Push notifications manager
ResendMailProvider: Resend (https://resend.com) transactional mail.
RouteBase: The base class for GoRoute and ShellRoute.
RouteBuilder: Builds the top-level Navigator for GoRouter.
RouteConfiguration: The route configuration for GoRouter configured by the app.
RouteData: Baseclass for supporting Type-safe routing.
RouteInformationState<T>: The data class to be stored in RouteInformation.state to be used by GoRouteInformationParser.
RouteMatch: An matched result by matching a GoRoute against a location.
RouteMatchBase: The base class for various route matches.
RouteMatchList: The list of RouteMatchBase objects.
RoutingConfig Configuration: A set of parameters that defines routing in GoRouter.
S3FileStorageAdapter: S3 and S3-compatible object stores (AWS S3, Cloudflare R2, MinIO), authenticated with AWS Signature Version 4.
SendGridMailProvider: SendGrid v3 mail send.
SeoProps
SesMailProvider: Amazon SES v2, signed with AWS Signature Version 4.
ShellRoute Configuration: A route that displays a UI shell around the matching child route.
ShellRouteBase: Base class for classes that act as shells for sub-routes, such as ShellRoute and StatefulShellRoute.
ShellRouteContext: Context object used when building the shell and Navigator for a shell route.
ShellRouteData: A class to represent a ShellRoute in Type-safe routing.
ShellRouteMatch: An matched result by matching a ShellRoute against a location.
SmtpMailProvider: Sends through an SMTP server.
SqliteDVDatabaseAdapter
StatefulNavigationShell: Widget for managing the state of a StatefulShellRoute.
StatefulNavigationShellState: State for StatefulNavigationShell.
StatefulShellBranch: Representation of a separate branch in a stateful navigation tree, used to configure StatefulShellRoute.
StatefulShellBranchData: Base class for supporting StatefulShellRoute
StatefulShellRoute Configuration: A route that displays a UI shell with separate Navigators for its sub-routes.
StatefulShellRouteData: Base class for supporting StatefulShellRoute
TwilioSmsProvider: Twilio SMS.
TypedGoRoute<T extends GoRouteData>: A superclass for each typed go route descendant
TypedRoute<T extends RouteData>: A superclass for each typed route descendant
TypedShellRoute<T extends ShellRouteData>: A superclass for each typed shell route descendant
TypedStatefulShellBranch<T extends StatefulShellBranchData>: A superclass for each typed shell route descendant
TypedStatefulShellRoute<T extends StatefulShellRouteData>: A superclass for each typed shell route descendant
WebPushProvider: Web Push, per RFC 8291 (encryption) and RFC 8292 (VAPID).

Enums

ApnsEnvironment: Which APNS environment a device token belongs to.
ApnsPushType: What kind of notification is being delivered.
AuthFailure: Why an authentication attempt failed.
AuthState: Auth state
DV3DDegradation: Why a viewport shows its poster rather than the scene.
DVAccountPage: One of the prebuilt account pages.
DVAlign: How a row or list distributes its children along its own axis.
DVAnchorType: The kinds of anchor, as a closed set.
DVAndroidBondOutcome: What a bond attempt has come to, so far.
DVAppLifecycle: Application-level lifecycle states.
DVAssetKind: What a bundled file is, taken from its extension when it is generated.
DVAudioFormat: Audio container/codec pairs a recording can be asked for.
DVBackgroundPlayback: Whether a player may keep playing with the application in the background.
DVBreakpoint: The width bands Dartvel lays out against.
DVBrowserWindowOutcome: What the browser did with a window request.
DVBuildLifecycle: Build pipeline lifecycle states, observed through DV.lifecycle.build.
DVCaptureInterruption: Why a recording stopped before the application stopped it.
DVCaptureKind
DVCaptureState: Where a capture session is.
DVCompare: A comparison a DVFilter can make.
DVContentReportKind
DVContentScheduledAction: What a scheduled job does at its slot.
DVContentScheduleOutcome: How a scheduled job ended.
DVContentState: Where a version is in the workflow.
DVCrashHook: Where an error arrived. One error can arrive at more than one, and is recorded once; the same place seeing it again is a second occurrence.
DVCronTarget
DVCrossAlign: How a row or list places its children across its other axis.
DVDeployPlatform: Every platform dartvel build makes, under the DVDeployTarget its apps serve Studio's pages as.
DVDeployStatus: Where a platform stands today, in docs/build-targets.md's terms.
DVDeployTarget: A place Studio deploys a page to, named as a site owner would name it.
DVDialogKind
DVDrmScheme: The content protection systems DVDrmAdapters answer for.
DVDropType: What a window will take a drop of.
DVFieldType: How a field is stored, for engines that declare types.
DVFoldState: What the current surface looks like, as a value.
DVHand
DVImageSource: Where a DVImage's bytes come from.
DVImmersion: How an immersive space shows the world around the user.
DVInstallOutcome: What the reader chose.
DVInvoiceStatus: Where an invoice got to.
DVJobState
DVKioskClearable: What a session reset clears.
DVKioskCursor: Whether a kiosk shows a pointer.
DVKioskExternal: What a kiosk does with an address that is not this application.
DVKioskResetReason: Why a session was reset.
DVKioskScope: Whether the whole device is the kiosk, or one display of it.
DVKioskState: Where a kiosk is.
DVKioskTarget: The targets the specification gives a kiosk row.
DVLaunchOutcome: What a dual-mode application should do at startup.
DVLinkPreload
DVLinkPreview: Whether a link shows what it points at.
DVLocomotion: How an immersive scene lets the user move.
DVMailPriority
DVMediaControls: Which built-in controls a media box draws.
DVMediaKind: Whether a box plays video or audio.
DVMediaSourceKind: Where a DVMediaSource comes from.
DVMediaStreaming: Whether a source is an adaptive stream.
DVMemoryProfile: The class of device a target belongs to, which decides the default segment size and whether committing pages at startup is allowed.
DVMemoryTarget: A target an arena can run on.
DVModel3DProblemKind: Why an upload was refused.
DVModelChangeKind: What happened to a model.
DVModelPageDataMode: How a generated Model.Page(...) resolves the data it renders.
DVModelPageRole: The part a field plays in a generated model page, set by the field-scoped @DVModel.featuredImage(), .pageTitle(), .mainContent() and .hideFromPage() constructors.
DVModifierKey: A modifier, in platform-neutral terms.
DVModuleLifecycle: Module lifecycle states, observed through DV.Modules.<id>.lifecycle.
DVNetworkStatus: What the device can reach.
DVNotificationChannel
DVNotificationOutcome: What happened on one channel.
DVNotificationProviderKind
DVPageChangeKind: How a node differs between the two versions.
DVPageLifecycle: Page-level lifecycle states, observed through context.lifecycle.page.
DVPageUpdateOutcome: What a page bundle fetch resulted in.
DVPlane: Which detected planes a plane anchor accepts.
DVPlaybackState: Where a player is.
DVPluralCategory: The CLDR plural categories.
DVPosture: How a foldable is being held, from its first fold.
DVPresenceEventKind: What happened on a channel.
DVPurchaseChannel: Where the running build sells from.
DVPurchaseKind: What a store product is, which decides whether it has an end.
DVPurchaseRoute: Where a purchase goes.
DVRenderSurface: Where an application's frames are landing.
DVRequestLifecycle: Backend request lifecycle states, observed through context.lifecycle.request.
DVSceneAnchorPlacement: Where an anchored node is, as far as the graph knows.
DVSceneAssetFailure: How a load failed.
DVSceneAssetKind: What an asset is.
DVSceneAssetSource: Where an asset's bytes come from.
DVSceneAssetStatus: Where a load is.
DVSceneHandedness: The handedness of a document's coordinate system.
DVSceneLightType: The light types.
DVSceneNodeKind: What a scene node is.
DVScenePrimitiveShape: The procedural shapes a mesh node can be without an asset.
DVSceneUnits: The length unit a document's numbers are in.
DVSceneUpAxis: Which axis a document treats as up.
DVScreenShape: The shape of the surface being drawn on.
DVSitemapChangeFrequency: How often a page changes, in the words sitemaps.org defines.
DVSpatialAnchorStatus: Where an anchored node's anchor is.
DVSpatialDataUse: A use of environment data that needs somebody's agreement.
DVSpatialInput: The inputs a target delivers. Which exist is reported, never assumed.
DVSpatialInputAction: What an input does. A select is .onTap(); grab and release are .onGrab() and .onRelease().
DVSpatialInputSource: Where an input came from.
DVSpatialLighting: What a scene in space is lit by.
DVSpatialPersistenceKind
DVSpatialRefusal: Why a request was not presented in space.
DVSpatialSessionState
DVSpatialSpaceKind: The two ways of presenting a scene in space that are new kinds. A panel is an ordinary window and needs nothing here.
DVStore: A store that sells digital goods inside an application.
DVStudioPageKind: What kind of page a route is.
DVStudioPropertyKind: How a document property is edited and applied.
DVTabExit: Why a tab left a workspace, so the caller can tell a tear-out from a close.
DVTabPresentation: A tab strip and its content, composed from DVBox and DVText.
DVTenantIsolation: How tenant data is separated.
DVTenantSource: Where a request's tenant is read from.
DVTerminalGraphics: How faithfully a terminal can draw.
DVThreePaneFold: Across one fold, which of DVBox.threePane's panes share a side.
DVTrackingAuthorization: What the system prompt answered.
DVTransactionLifecycle: Transaction lifecycle states, observed through context.lifecycle.transaction.
DvTransition
DVTransportAction: What a remote-control or keyboard key does to a player.
DVUpdateChannel: Which track a device follows.
DVUpdateHold: Why an update this device knows about is not being offered to it.
DVWindowDegradation: Why a request was presented as something other than a window.
DVWindowExitPolicy: When closing a window ends the process.
DVWindowHandover: How content crosses from one window to another.
DVWindowKind: What kind of surface was asked for.
DVWindowLifecycle: The lifecycle of a window, as a read-only signal the runtime owns.
DVWindowModality: What a window blocks while it is open.
DVWindowPerformanceIssue: The four diagnostics the specification's performance contract names.
DVWindowPresentation: How the request was actually presented.
DVWorkerFailureKind: Why a run did not produce a value.
DVWorkerMechanism: What carried the work.
DVWorkerOutcome: How a run ended.
DVWorkflowSide: A builder-editable backend function. Where a workflow runs, and so what it exports as.
DVWorkflowType: A type a workflow input or result can have, named for a site owner.
NavigatingType: The type of the navigation.

Mixins

DVSceneNodeModifiers<Self extends DVSceneNode>: The modifiers every scene node takes.

Extensions

DartvelNavigationX on BuildContext
DartvelRouteX on BuildContext
DVAnalyticsConsentPages on DVAnalyticsRuntime: DV.Analytics.ConsentBanner(child: ...) and DV.Analytics.ConsentSettingsPage(), the way DV.Auth provides its sign-in pages.
DVAssetImage on DVAssetRef: What can be shown as an image: an image a model holds, or a bundled one.
DVAssetMedia on DVAssetRef: What can be played: media a model holds, or a bundled file.
DVBooleanSignalX on DVReadableSignal<bool>: Logic over boolean signals.
DVFlagContextX on BuildContext: Reading a flag as a signal.
DVFlutterTestHarness on DVTestHarness
DVFormAliasX on T
DVLifecycleContextX on BuildContext: context.lifecycle in a page.
DVMailTemplating on DVNotificationMail: Rendering a DVMailTemplate through DV.I18n.
DVMediaSignalWatch on DVMediaSignal<T>: Reading a player's signals in a build.
DVModelSignalX on T
DVModuleGlobals on DVModule: A module's own DV.global registry.
DVModuleShelling on DVModule: A module's own chrome, and how it is read back.
DVModuleTheming on DVModule: A module's own look, and how it is read back.
DVNotificationTemplating on DVNotificationsService: Rendering a DVNotificationTemplate through DV.I18n.
DVNumericSignalX on DVReadableSignal<num>: Arithmetic and comparison over numeric signals.
DVScreenContextX on BuildContext: context.screen -- the reactive screen surface.
DVShellResultFuture on Future<DVShellResult>
DVSignalContextX on BuildContext
DVStringSignalX on DVReadableSignal<String>: Concatenation over string signals.
DVWindowDegradationX on DVWindowDegradation
DVWindowKindX on DVWindowKind
DVXRTestHarness on DVTestHarness: DV.Test.fakeXR(...).
GoRouterHelper on BuildContext: Dart extension to add navigation function to a BuildContext object, e.g. context.go('/');

Constants

dvAndroidBiometricSuccess → const int: BiometricManager.BIOMETRIC_SUCCESS.
dvAndroidBluetoothAdapterPath → const String: The path reported for the one Bluetooth adapter Android exposes.
dvAndroidBondBonded → const int: BluetoothDevice.BOND_BONDED.
dvAndroidBondBonding → const int: BluetoothDevice.BOND_BONDING — a pairing dialog nobody has answered yet.
dvAndroidBondNone → const int: BluetoothDevice.BOND_NONE.
dvAndroidFullscreenBlocker → const String: Why display.enterFullscreen and display.exitFullscreen are unbound on Android, in one place so it is not retold three different ways.
dvAndroidKeystoreNonceBytes → const int: The GCM nonce the Keystore generates for an encryption, in bytes.
dvAndroidKeystoreProvider → const String: The provider whose keys never leave secure storage.
dvAndroidKeystoreTagBits → const int: The GCM tag, in bits and bytes.
dvAndroidKeystoreTransformation → const String: How the application key is sealed under the Keystore key.
dvAndroidNotificationChannelId → const String: The channel every Dartvel local notification is posted on.
dvAndroidNotificationChannelName → const String: What the channel is called in the system settings, where the user sees it.
dvAndroidRedactedBluetoothAddress → const String: The MAC address Android hands ordinary applications instead of the real one.
dvAndroidSealedKeyBytes → const int: A sealed application key: 32 bytes of key and the tag on them.
dvAndroidShareIntentFlags → const int: Intent.FLAG_ACTIVITY_NEW_TASK.
dvAndroidShareMimeType → const String: The MIME type the shared payload is declared as.
dvAndroidShareUsesChooser → const bool: Whether the share goes through Intent.createChooser.
dvBackSwipeEdgeWidth → const double: How far from the leading edge an iOS back swipe starts: the width Cupertino's page route listens on.
dvBrowserFollowsAnchors → const bool: False off the web: there are no anchors, so nothing follows one and DVNavLink is the only thing that can open a link.
dvGraphicsQueryId → const int: The default identifier for a graphics query.
dvLinkPreviewDelay → const Duration: How long a pointer rests before the preview appears.
dvLinkVisibleDelay → const Duration: When a link fetches the route it points at. How long a link has to stay on screen before DVLinkPreload.visible fetches what it points at.
dvStudioAlignNames → const List<String>: The names DVAlign answers to in a page document.
dvStudioButtonDefaults → const Map<String, Object?>: How a button looks when nothing says otherwise: filled, padded, rounded.
dvStudioCrossAlignNames → const List<String>: The names DVCrossAlign answers to.
dvStudioImageFits → const List<String>: How an image fills its box, by the names Flutter uses.
dvStudioLayouts → const List<String>: Every layout a page document can name.
dvStudioPagesShape → const DVRecordShape: A page as a record, keyed by its route: one shape for DVPageStore, the Studio API and the published-pages reader, so the three cannot disagree about the fields.
dvStudioPhoneWidth → const double: Below this width Studio is laid out for a phone: sections along the bottom, and the editor one pane at a time.
dvStudioPlacementEdges → const List<String>: The edges a child of a stack can name.
dvTerminalFallbackPrompt → const String: What the application says when it has no display but can use a terminal.
dvWebImplementedBindings → const Set<String>: What a browser can genuinely do, given a browser that has the API.
dvWebUnavailableBindings → const Map<String, String>: Every declared binding the web cannot serve, and the obstacle.
dvWebUnconditionalBindings → const Set<String>: The bindings registered with no feature probe at all.

Properties

dvAudioFocus → DVAudioFocus: The process's audio focus, used by players that were not given one.
final
dvKioskBlocksClipboard → bool: Whether a running kiosk policy has locked the clipboard.
no setter
dvKioskBlocksTextSelection → bool: Whether a running kiosk policy has locked text selection.
no setter
dvKioskLocksWindows → bool: Whether a running kiosk policy locks the surface to one window.
no setter
dvMaintenanceRoute ↔ String: Where a visitor is sent while the application is down.
getter/setter pair
dvModelDeserializers → Map<Type, Object? Function(Map<String, Object?>)>: final
dvModelFactories → Map<Type, Object? Function()>: final
dvModelReadCarriers → Map<Type, void Function(Object? read, Object? edited)>: final
dvModelSerializers → Map<Type, Map<String, Object?> Function(Object?)>: final
dvMountPoint → String: Where the routes were last mounted, / when at the root.
no setter
dvSecondFactorRoute ↔ String: Where a page that needs a second factor sends a session without one. The generated router serves DV.Auth.SecondFactorPage here when any page declares mfa:.
getter/setter pair
dvSignInRoute ↔ String: Where a visitor who is not signed in is sent.
getter/setter pair
dvStudioLayoutProperties → List<DVStudioLayoutProperty>: How a box lays its children out, as the inspector offers it.
final
dvStudioLeafTypes → List<DVStudioLeafType>: final
dvStudioProperties → List<DVStudioProperty>: Every styling control the page builder offers.
final
dvUnauthorizedRoute ↔ String: Where a refused request goes.
getter/setter pair
formControlsFactories → Map<Type, DVFormControlsFactory>: final

Functions

carryDVModelRead<T>(T read, T edited) → void: Makes edited carry the version read was loaded at, when T registered a carrier; otherwise does nothing.
dvAndroidBiometricAvailable(int status) → bool: Whether status from BiometricManager.canAuthenticate means yes.
dvAndroidBluetoothAdapterMap({required String address, required String? name, required bool powered, required bool discovering}) → Map<String, Object?>: The adapter, in the shape DVBluetoothAdapter.fromMap reads.
dvAndroidBluetoothDeviceMap({required String address, required String? name, required int bondState, required Set<String> connectedAddresses}) → Map<String, Object?>: A known device, in the shape DVBluetoothDevice.fromMap reads.
dvAndroidFilesRoot(String? filesDir) → String?: The one directory files.readBytes, files.writeBytes and files.delete may touch, given the application's own files directory. Null when there is none.
dvAndroidGeometry({required int widthPixels, required int heightPixels, required double density}) → Map<String, Object?>?: The default display, or null when Android has not said yet.
dvAndroidKeystoreAlias(String app) → String: The Keystore alias of app's wrapping key. One per application, so two Dartvel applications in one process never share a key.
dvAndroidLaunchRoute(String? uri) → String?: The route an application was launched at, from the URI it was given.
dvAndroidNfcAvailable({required bool hasAdapter, required bool enabled}) → bool: Whether NFC can read something now.
dvAndroidNotificationId(int counter) → int: A notification id from a running counter.
dvAndroidNotificationNeedsChannel(int sdkInt) → bool: Whether this API level needs a notification channel.
dvAndroidOpenKeyBlob(String blob) → ({Uint8List nonce, Uint8List sealed})?: The nonce and sealed key in blob, or null when it is not one.
dvAndroidSealedKeyPath(String? noBackupDir, String app) → String?: Where app's sealed key is kept, given the application's no-backup directory; null when there is none.
dvAndroidSealKeyBlob(Uint8List nonce, Uint8List sealed) → String: The text kept on disk for a key sealed as sealed under nonce.
dvAndroidSensorSample(List<double> values) → Map<String, double>?: One sample from a motion sensor, or null when the event does not carry three axes.
dvAndroidStateDirectory(String? filesDir) → String?: Where the device runtime keeps its id, provisioning record and restarts, given the application's own files directory. Null when there is none.
dvAppKeyStoreFor(String app, {String? platform, String? home}) → Future<DVAppKeyStore>: The key store for app on this machine: what the platform has custody for -- the Android Keystore, the Keychain on iOS and macOS, DPAPI, the Secret Service -- else, on a desktop with no keyring answering, a file only the user can read. On Android and iOS there is no file: the keyring answers or the key is refused.
dvAppLifecycleFor(AppLifecycleState state) → DVAppLifecycle?: What state means for DV.lifecycle.app, or null when it means nothing.
dvApplyKioskContainment(DVKioskPolicy? policy) → void: Installs policy's containment for the process.
dvAskForCode(BuildContext context, {int length = 6, String title = 'Enter your code', String? message, DVCodeCheck? verify}) → Future<String?>: Shows the modal. See DV.Auth.askForCode.
dvBreakpointFor(double width) → DVBreakpoint: The breakpoint a logical width falls in.
dvClearKioskSession(Set<DVKioskClearable> what, {DVKioskScope scope = DVKioskScope.device, String? namespace}) → Future<void>: Clears what from the framework's own state.
dvCloseBrowserWindow(String? id) → bool: Nothing to close.
dvConfigRoutes(List<DVRouteNode> nodes, {SeoProps seo = SeoProps.empty, PageTransitionSpec transition = const PageTransitionSpec(), GoRouterRedirect? inheritedRedirect}) → List<RouteBase>: nodes as go_router routes, for the generated router.
dvCrashDirectoryFor({required String appId, required String os, required Map<String, String> environment, String? androidStateDirectory}) → String?: The directory crash records for appId go in on os, or null when the platform gives no directory that survives a restart.
dvDeviceTypeFor({required String platform, required String breakpoint, bool isTV = false, bool isWatch = false, bool isWeb = false, bool isFoldable = false}) → String: What kind of device this is.
dvDisplayAvailable() → bool: Whether this process can open a window. See dvDisplayAvailableIn.
dvDisplayAvailableIn(Map<String, String> environment, {required String os}) → bool: dvDisplayAvailable, for a given environment and OS name.
dvEnsureSemantics() → void
dvFunctionStudioSections({List<DVWorkflowPaletteItem> palette = const <DVWorkflowPaletteItem>[], DVFunctionStore? store, DVCodeFunctions? written}) → List<DVStudioSection>: The Frontend and Backend sections, for registering with DVStudioScreen: a function built in each, with the same builder.
dvGlobalName(Type type) → String: The name a global is declared by: the lowerCamel form of its type.
dvHomeWidgetDataKey(String id) → String: Where a home widget's data is left for the surface that draws it.
dvHostedLocation(String location, List<RouteBase> routes, {String at = '/'}) → String?: The Dartvel path a host location names under at, or null when it is not one of routes: the host's own route, which the host handles.
dvHostedPath(String path, {String at = '/'}) → String: The host path for a Dartvel path mounted at at: what a host passes to Navigator.pushNamed for DVRoutes.about.path.
dvImageOf(Object source, {String? alt}) → DVImage: The image source names: a DVImage as it is, or a bundled image, with alt when the caller has better words for it than the value carries.
dvImageServedPath(DVImage image) → String?: The address the site serves image at, which is what its variants are keyed on: an asset under assets/, a network image at its own URL. Null for a file or a stored image, which the site does not serve.
dvImageVariantProvider(DVImage image, double devicePixels, DVImageVariants variants) → ImageProvider<Object>?: The provider for image drawn devicePixels wide, or null when there is no variant for it and the image itself is fetched.
dvInstallIdFrom({required String? read(), required void write(String id), String generate()?}) → String: This install's id: the stored one, or a new random one stored for next time.
dvInterceptLinkNavigation(void route(String path)) → void: No-op off the web. There is no document, no anchors and no browser navigation to intercept: a link on a native platform reaches DVNavLink's own handler and nothing else.
dvIosHapticSoundId(String name) → int: The system sound identifier that produces a given haptic.
dvKioskAllowsExternalUrl(String url) → bool: Whether a running kiosk policy permits opening url outside the application, per routes.external.
dvKioskHidesCursor(DVKioskCursor mode, {required bool mouseConnected}) → bool: Whether the pointer is hidden, given the mode and the hardware.
dvKioskRouteRedirect(String path) → String?: Where a running kiosk sends path, or null to let it through.
dvKittyGraphicsQuery([int id = dvGraphicsQueryId]) → String: The escape sequence that asks a terminal whether it speaks the Kitty graphics protocol, followed by a primary Device Attributes request.
dvLanguageOf(String locale) → String: The language subtag of locale, lower-cased.
dvLogMediaDiagnostic(String code, String message) → void: Logs code at the level the diagnostic registry assigns it.
dvLogXRDiagnostic(String code, String message, Map<String, Object?> context) → void: Logs code at the level the diagnostic registry assigns it.
dvMailPriorityHeaders(DVMailPriority priority) → Map<String, String>: The headers that carry priority to a mail client.
dvMailWireHeaders(DVMailMessage message) → Map<String, String>: Every header message should reach the wire with.
dvMediaOf(Object source) → DVMediaSource: The media source names: a DVMediaSource as it is, or a bundled file.
dvModuleShell(BuildContext context, String moduleId, Widget child) → Widget: Wraps child in whatever chrome the module mounted as moduleId should render in.
dvModuleTheme(BuildContext context, String moduleId, Widget child) → Widget: Wraps child in whatever theme the module mounted as moduleId should render in.
dvMountedLocation(String path) → String: The location to hand the router for Dartvel path: under the mount point when Dartvel serves the path, unchanged when it does not.
dvMountRoutes(List<RouteBase> routes, {String at = '/'}) → List<RouteBase>: routes mounted at at, for a host GoRouter's routes:.
dvNegotiateTerminalGraphics({required bool hasTerminal, required void write(String), required Stream<String> replies, int id = dvGraphicsQueryId, Duration timeout = const Duration(milliseconds: 300)}) → Future<DVTerminalGraphics>: Asks the terminal which graphics protocol it speaks.
dvNextSequence() → int: A number larger than any this process has handed out, and than the clock in microseconds, so a restarted process carries on above the last one.
dvNotFoundRedirect(GoRouterState state, String to) → String?: Where dartvel.notFoundRedirect sends a path no route serves, or null to leave the location alone.
dvOnGenerateRoute(RouteSettings settings, List<RouteBase> routes, {String at = '/'}) → Route<Object?>?: For Navigator 1.0: a route for settings when it names a Dartvel page under at, else null for the host's own onGenerateRoute to answer.
dvOpenBrowserWindow(String url, {String? title, double? width, double? height}) → DVBrowserWindowResult: Nothing to open: this target opens windows through window.open.
dvOpenUrl(String path, {bool newTab = false}) → void: No-op off the web, where there is no browser to hand a URL to.
dvOrderGoRoutes(List<RouteBase> routes) → List<RouteBase>: routes ordered so that no route hides another: a static segment is matched before a parameter, a parameter before a catch-all, whatever order they were declared in. A shell and a route with children move as one. Throws DVRouteOrderException (DV-ROUTE-004) when no order works.
dvPageFor(Uri uri, List<RouteBase> routes, {String at = '/'}) → Page<Object?>?: For Navigator 2.0: the page for uri when it names a Dartvel page under at, else null. The host puts it in its navigator's pages.
dvPluralCategoriesFor(String locale) → Set<DVPluralCategory>: Which categories locale uses.
dvPluralCategory({required String locale, required num count}) → DVPluralCategory: The category count takes in locale.
dvPrefetchHref(String path) → String: The prerendered page path is served as, relative to the base the site is served from -- so a site under /app/ prefetches /app/docs, not /docs.
dvPrefetchImages(String? manifest, String path, {DVImageVariants? variants, double devicePixelRatio = 1}) → List<String>: The images the build recorded path painting on load, or none.
dvPublishedPagesFromServer() → Future<List<DVPageDocument>>: The page documents published on the server that served this page, from its /_dartvel/pages. Empty when it answers anything else.
dvReadGraphicsReply(String reply, {int id = dvGraphicsQueryId}) → DVTerminalGraphics?: What a terminal's answer to dvKittyGraphicsQuery means, or null while the answer is still arriving.
dvRecordConsentChoice(DVConsent consent, Map<DVConsentCategory, bool> answers, {required DVConsentPrompt prompt}) → Future<bool>: Records answers as a choice made through prompt, and returns whether everything that was answered was written.
dvRefuseIfClipboardBlocked(String operation) → void: Throws when the clipboard is locked, naming why.
dvRegisterDeferredPageReset(void reset()) → void Function(): Registers reset, returning a function that unregisters it.
dvResetAmbientSignals() → void: Drops the ambient container, so a test starts from nothing.
dvResetDeferredPages() → void: Drops every generated page's cached library future.
dvResetKioskContainment() → void: Forgets any installed containment.
dvResetModuleShells() → void: Test-only: forgets every declared module shell.
dvResetModuleThemes() → void: Test-only: forgets every declared module theme.
dvResetMount() → void: Forgets the mount. For tests, and a host that unmounts.
dvResetPageMiddleware() → void: Forgets everything an application or a test configured.
dvRoutePaths(List<RouteBase> routes) → List<String>: Every path pattern routes serve, nested routes joined to their parents.
dvSendAIHttpRequest(DVAIHttpRequest request) → Future<DVAIHttpResponse>
dvSendHttpRequest(DVHttpRequest request) → Future<DVHttpResponse>: Sends request, walking its protocol chain until one succeeds.
dvSessionDeviceLabel() → String: What a session from this install is recorded as: the platform and the kind of client, such as Android app or Web browser.
dvSessionTokenStoreFor(String app) → DVSessionTokenStore?: The session token store a generated runtime uses for app: sealed under the application key dartvel key manages, in a file in the device's state directory, else under the user's home.
dvShellNavigation(StatefulNavigationShell shell) → DVShellNavigation: A DVShellNavigation over go_router's shell, for the generated router.
dvSignalContainerOf(BuildContext context) → ProviderContainer: The Riverpod container backing signals reached through context.
dvStartAppLifecycleBridge() → void: Starts reporting the platform's application lifecycle on DV.lifecycle.app.
dvStopAppLifecycleBridge() → void: Stops reporting. For tests, and for a host that owns the binding itself.
dvStudioAlignOf(Object? name) → DVAlign: DVAlign by name, defaulting to start.
dvStudioBrowserTransport() → DVStudioTransport: The browser's transport: same-origin, with the session cookie, and the CSRF header every write needs.
dvStudioCrossAlignOf(Object? name) → DVCrossAlign: DVCrossAlign by name, defaulting to stretch.
dvStudioDataSection(DVStudioClient client) → DVStudioSection: Data: every data model, compiled or designed in Studio, its records, and the designer that makes and changes one.
dvStudioDocumentFromStructure(String route, Object? tree, {String? title}) → DVPageDocument: The page document a captured structure describes.
dvStudioEffectiveProperties(DVPageNode node, [Map<String, Object?>? properties]) → Map<String, Object?>: The properties node is drawn and exported with.
dvStudioImageFitOf(Object? value) → BoxFit
dvStudioImageOf(Map<String, Object?> properties) → DVImage: The image a node describes.
dvStudioInProcessTransport(DVStudioApi api) → DVStudioTransport: A transport that answers from a core.DVStudioApi in this process: the Studio an application carries inside itself, on a phone, a desktop, a TV or the web, reading and writing its own database through the same API a server answers Studio with.
dvStudioInsertTarget(DVStudioEditorController controller) → String: Where an element inserted without a drop target goes; see _dvStudioInsertTarget. The command palette inserts the same way the palette's tap does.
dvStudioInspectorGroupsFor(DVPageNode node) → List<(String, List<String>)>: Which properties the inspector offers for node, grouped and ordered the way it draws them.
dvStudioIsPlaced(Map<String, Object?> properties) → bool: Whether properties say where a child sits.
dvStudioLayoutBox(DVPageNode node, List<Widget> children) → Widget: The box node describes, holding children.
dvStudioLayoutLabel(String layout) → String: What the palette calls layout.
dvStudioLeafTypeFor(DVPageNode node) → DVStudioLeafType?: The leaf type node declares, or null when it is a layout box.
dvStudioNodeTitle(DVPageNode node, DVPageDocument document) → String: What a node is called in Layers and in the command palette: the page, a leaf's palette label, or a box's layout label, with its text when it has some, so two Text elements can be told apart.
dvStudioPageKindLabel(DVStudioSitePage page) → String: What a page's kind reads as in a badge.
dvStudioPageKindTone(DVStudioSitePage page) → Color: The tone of a page's kind badge.
dvStudioPagePath(String route) → String: The file an exported page belongs in, by the pages router's own rule.
dvStudioPlace(Map<String, Object?> properties, Widget child) → Widget: child at the place properties name, or child itself when they name none.
dvStudioPlaceSource(Map<String, Object?> properties, String source) → String: The exported form of dvStudioPlace: source wrapped where the child says it sits.
dvStudioRouteInfoJson(DVRouteInfo route) → Map<String, Object?>: route as the project graph describes a route.
dvStudioServerSections(DVStudioClient client) → List<DVStudioSection>: The sections Studio has on a server, named for someone who has never written code: the app's data, its site map, its backend logic, background tasks and their queue, the modules it mounts, the cache, and the team who may open Studio.
dvStudioSiteMapSection(DVStudioClient client) → DVStudioSection: Site map: every route the site answers, compiled and stored -- the list Pages opens them from.
dvStudioSitePages({required Iterable<Map<String, Object?>> compiled, required Map<String, String?> stored, bool hasStructure(String path)?}) → List<DVStudioSitePage>: Every route of the site: each compiled one, marked as overridden when stored has a document at its path, then the stored routes no compiled page answers. Sorted by path.
dvStudioSpacingOf(Map<String, Object?> properties) → double: The gap a box leaves between its children.
dvStudioStructureOf(BuildContext context) → List<Map<String, Object?>>: The structure of the page rendered under context, in the shape the build's semantics capture writes: the words, headings, links, images and buttons, and the rows and columns they sit in.
dvStudioStyled(DVPageNode node, Widget built, {bool withAction = true}) → Widget: Folds node's properties onto built as a DVModifier.
dvTabPresentationFor({required bool isTV, required bool isWatch}) → DVTabPresentation: The presentation for a device.
dvTerminalRunnerPathFor(String executable) → String: The terminal runner beside the GUI binary: the same name with -cli, keeping a Windows .exe. What dartvel build <desktop>-cli produces.
dvTransitionPage<T>({LocalKey? key, required Widget child, required PageTransitionSpec spec}) → CustomTransitionPage<T>
dvUsePathUrlStrategy() → void
dvWindowStateKey(String name) → String: The storage key for a named window.
dvWorkflowStudioSection({List<DVWorkflowPaletteItem> palette = const <DVWorkflowPaletteItem>[], DVWorkflowSide side = DVWorkflowSide.backend, DVFunctionStore? store, DVCodeFunctions? written}) → DVStudioSection: One side's section: Frontend or Backend.
dvWrapAlignmentOf(DVAlign align) → WrapAlignment: DVAlign as a Wrap reads it.
dvWrapCrossAlignmentOf(DVCrossAlign align) → WrapCrossAlignment: DVCrossAlign as a Wrap reads it.
parseDocumentColor(Object? value) → Color?: Reads a colour from a document property.
registerDVModelDeserializer<T>(DVModelDeserializer<T> deserializer) → void: Registers how a T is rebuilt from a JSON map.
registerDVModelFactory<T>(DVModelFactory<T> factory) → void
registerDVModelReadCarrier<T>(DVModelReadCarrier<T> carry) → void: Registers how an edit of a T inherits the read of the T it edits.
registerDVModelSerializer<T>(DVModelSerializer<T> serializer) → void
registerFormControlsFactory<T>(DVFormControlsFactory factory) → void
resolveLaunchSurface({required Set<DVRenderSurface> linked, required List<String> arguments, required bool displayAvailable, bool interactive = true}) → DVLaunchOutcome: Decides where a launch should start.
signal<T>(BuildContext context, T value) → DVSignal<T>

Typedefs

DVAccessTokenSupplier = Future<String> Function(): Supplies a short-lived OAuth2 access token for a push service.
DVAIHttpRequest = DVHttpRequest: Retained names for the shared HTTP seam, which now lives in src/http/transport.dart so mail and other provider adapters share it.
DVAIHttpResponse = DVHttpResponse
DVAIHttpSend = DVHttpSend
DVAIToolHandler = FutureOr<DVJsonValue> Function(DVJsonObject input)
DVAppKeyStoreSource = Future<DVAppKeyStore?> Function(): Where a store finds the application key store, or null when this platform has none.
DVAppLaunchAcquire = DVInstanceLock Function(String path): How a lock is taken; the real one, or a test's.
DVBillingFetch = Future<(int, String)> Function(String method, Uri url, Map<String, String> headers, String? body): (status, body) for an HTTP method request to url with headers.
DVBrowserWindowOpener = DVBrowserWindowResult Function(String url, {double? height, String? title, double? width}): Opens url as a browser window.
DVCodeCheck = Future<String?> Function(String code): Checks a code. Returns null when it is right, or what to tell the person when it is not.
DVCrashTextReceiver = void Function(String error, String stack, DVCrashHook hook): Receives an error that arrived only as its description and stack text.
DVFormControlsFactory = DVFormControls Function(Object? model, {void onReset()?, void onSubmit()?})
DVHttpSend = Future<DVHttpResponse> Function(DVHttpRequest request)
DVImageView = DVImageRender: Renders a DVImage model field.
DVJobHandler<TPayload> = FutureOr<void> Function(TPayload payload)
DVJsonObject = Map<String, DVJsonValue>
DVLinkPreviewCallback = void Function(String? path): Called with the destination when the pointer enters a link, and null when it leaves.
DVMacosDialogAutomation = void Function(DVMacosDialog dialog)
DVMediaDiagnosticSink = void Function(String code, String message): Receives a DV-MEDIA-* code and what happened.
DVMediaPlayerFactory = DVMediaPlayerBackend Function(DVMediaSource source, DVMediaKind kind): Makes a platform player for source.
DVModuleShellBuilder = Widget Function(BuildContext context, Widget child): Builds a module's chrome around child.
DVNotificationPreferenceResolver = Future<DVNotificationPreferences> Function(String recipient): Resolves a recipient id to what they have asked to receive.
DVNotificationRouteResolver = Future<DVNotificationRoutes> Function(String recipient): Resolves a recipient id to the addresses its channels need.
DVPolicyCheck<TUser, TResource> = FutureOr<bool> Function(TUser user, TResource resource)
DVPublicPathsResolver = Future<List<String>> Function(): Supplies the concrete parameter values a parameterized route needs during static generation.
DVRouteBuilder = Widget Function(BuildContext context, DVRouteState state): Builds a config route's screen.
DVRouteRedirect = FutureOr<DVRouteTarget?> Function(BuildContext context, DVRouteState state): Where to send a visitor instead, or null to let the route activate.
DVSceneAssetDecode = Future<DVGltfSummary> Function(Uint8List bytes): Reads a model's bytes into a summary.
DVSceneAssetFetch = Future<List<int>?> Function(DVSceneAsset asset): Fetches an asset's bytes, or null when nothing is there.
DVSearchDocument<TModel> = String Function(TModel model)
DVSearchFacetFilter<TFacets> = List<String> Function(TFacets? facets): Builds provider filter expressions from typed facets. Meilisearch and Algolia both express facets as filter strings, so this is where an application maps its own facet type onto that syntax.
DVSearchFacetMatcher<TModel, TFacets> = bool Function(TModel model, TFacets? facets)
DVSeo = SeoProps
DVShellBuilder = Widget Function(BuildContext context, DVRouteState state, Widget child): Builds the frame a DVShellRoute's child routes render inside.
DVSmtpConnect = Future<DVSmtpConnection> Function(String host, int port, {required bool secure})
DVStatefulShellBuilder = Widget Function(BuildContext context, DVRouteState state, DVShellNavigation shell): Builds the frame of a DVStatefulShellRoute, given the tabs.
DVStudioEditorHook = VoidCallback Function(DVStudioEditorController controller): Attaches to an editor when the Studio screen opens one; the returned callback is called when that editor goes away.
DVStudioTransport = Future<DVStudioReply> Function(String method, String path, {Object? body}): Sends one request to the backend Studio is served by. path is relative to the mount, with no leading slash.
DVStyleModifier = DVModifier
DVWidgetBuilder<T> = Widget Function(T item)
DVWindowsDialogAutomation = void Function(DVWindowsDialog dialog)
DVWorkerTask<I, O> = FutureOr<O> Function(I input, DVWorkerReporter reporter): A task: a top-level or static function from a typed input to a typed output. That is what can cross an isolate boundary and what a web worker can be handed; a closure over the calling scope is neither.
DVXRDiagnosticSink = void Function(String code, String message, Map<String, Object?> context): Receives an XR diagnostic. Context never carries environment or body data.
ExitCallback = FutureOr<bool> Function(BuildContext context, GoRouterState state): Signature for function used in RouteBase.onExit.
GoExceptionHandler = void Function(BuildContext context, GoRouterState state, GoRouter router): The function signature of GoRouter.onException.
GoRouterBuilderWithNav = Widget Function(BuildContext context, Widget child): Signature of a go router builder function with navigator.
GoRouterPageBuilder = Page Function(BuildContext context, GoRouterState state): The page builder for GoRoute.
GoRouterRedirect = FutureOr<String?> Function(BuildContext context, GoRouterState state): The signature of the redirect callback.
GoRouterWidgetBuilder = Widget Function(BuildContext context, GoRouterState state): The widget builder for GoRoute.
NavigatorBuilder = Widget Function(GlobalKey<NavigatorState> navigatorKey, ShellRouteMatch match, RouteMatchList matchList, List<NavigatorObserver>? observers, String? restorationScopeId): Signature for functions used to build Navigators
ParserExceptionHandler = RouteMatchList Function(BuildContext context, RouteMatchList routeMatchList): The function signature of GoRouteInformationParser.onParserException.
PopPageWithRouteMatchCallback = bool Function(Route route, dynamic result, RouteMatchBase match): Signature for a function that takes in a route to be popped with the result and returns a boolean decision on whether the pop is successful.
RouteMatchVisitor = bool Function(RouteMatchBase): The function signature for RouteMatchList.visitRouteMatches
ShellNavigationContainerBuilder = Widget Function(BuildContext context, StatefulNavigationShell navigationShell, List<Widget> children): Builder for a custom container for the branch Navigators of a StatefulShellRoute.
ShellRouteBuilder = Widget Function(BuildContext context, GoRouterState state, Widget child): The widget builder for ShellRoute.
ShellRoutePageBuilder = Page Function(BuildContext context, GoRouterState state, Widget child): The page builder for ShellRoute.
StatefulShellRouteBuilder = Widget Function(BuildContext context, GoRouterState state, StatefulNavigationShell navigationShell): The widget builder for StatefulShellRoute.
StatefulShellRoutePageBuilder = Page Function(BuildContext context, GoRouterState state, StatefulNavigationShell navigationShell): The page builder for StatefulShellRoute.

Exceptions / Errors

AuthException
DV3DSceneFormatException: Thrown when a scene document is malformed. path names the value, e.g. nodes[0].children[2].transform.t.
DVAccountDeleted: A sign-in refused because the account was deleted: its deletion's grace period ended, so signing in no longer cancels it.
DVAIProviderException: Thrown when a provider rejects a request or returns a payload Dartvel cannot interpret. Provider failures are never swallowed into empty results.
DVAppKeyStoreUnavailable: The platform key store could not hold or give up the application key.
DVAudioFocusRefused: Thrown by play() when the platform refused audio focus.
DVBillingError: A billing operation that could not proceed, with a message safe to show.
DVBotRefusal: A request refused for not passing the challenge.
DVBreachedPasswordRefusal: A password refused because it appears in a breach corpus (DV-EDGE-004).
DVCaptureBusy: Another recording already holds the device.
DVCaptureFailure: The device failed.
DVCaptureInterrupted: Recording stopped before the application stopped it. partial is what was recorded up to then, still private, when there is any.
DVCapturePermissionRefused: The person refused a capture permission.
DVCaptureUnsupported: The target cannot record what was asked for.
DVCompensationException: Thrown when a compensation handler itself fails during rollback.
DVContentChangedAfterApproval: The version changed after it was approved, so publishing it would ship text nobody approved (DV-CONTENT-002).
DVContentError: A refusal from the workflow. code is the diagnostic, when the specification assigns one.
DVContentFrozen: A version under review cannot be edited: a reviewer approving a moving document approves nothing.
DVContentInvalidTransition: The version is not in a state the operation applies to.
DVContentOpenDraft: The document already has a version open for editing, review or scheduling. One at a time, so there is one answer to "what is next".
DVContentRefused: The actor lacks the policy action. DV-CONTENT-003 for DVContentAction.publish and DVContentAction.schedule; the specification assigns no code to the others.
DVFieldDecryptionFailure: Thrown when a stored field cannot be opened.
DVFieldEncryptionUnavailable: Thrown when an encrypted field is read or written and the process has no usable keyring.
DVFileStorageException: Thrown when an object store rejects a request.
DVGltfFormatException: Thrown when bytes are not a glTF 2.0 model this inspector can read.
DVMailProviderException: Thrown when a mail provider rejects a message. Delivery failures are never swallowed - a caller always learns the message did not go out.
DVMediaDrmUnavailable: Protected content, and no adapter on this target for its scheme.
DVMediaStreamingUnsupported: An adaptive stream, a backend that cannot play one, and no progressive rendition to fall back to.
DVMemoryException: An allocation the arena refused, carrying its diagnostic code.
DVMfaRequired: A call that needs a second factor this session has not presented (DV-SESSION-001).
DVModel3DRejected: Thrown by DVModel3DFieldPolicy.accept for an upload that is not valid.
DVOAuth2Exception
DVPurchaseRefused: Dartvel refused to grant anything for a purchase, and why.
DVPushProviderException: Thrown when a push service rejects a notification.
DVRouteOrderException: Routes that cannot be put in any order where each is reachable.
DVSearchProviderException: Thrown when a hosted search service rejects a query or answers with a shape Dartvel cannot read. A failed search never degrades to an empty page.
DVSecondFactorRefused: A second-factor code the server refused.
DVSecretNotFoundException: Thrown when a secret is asked for and no source provides it.
DVSessionRequestFailed: A request to the generated auth endpoints that the server did not answer as asked. Carries the status and the path, never the body.
DVSharedStoreKeyError: Cross-window view state: which tab is active, tab order, layout, scroll offsets, drafts.
DVSharedStoreSealUnavailable: A value under a sealed namespace that was not written, because no application key could be had to encrypt it under.
DVSmtpException: Thrown when the server answers with an unexpected status.
DVSpatialAnchorNotStored: A token a store declined to keep, and why, in words that name the anchor and never the token.
DVStoreRefusal: The store looked at a receipt or notification and said no.
DVStoreUnavailable: The store could not be asked. Nothing was decided and nothing written.
DVStudioRemoteError: A request the backend refused, with what it said.
DVUncaughtError: An error that reached a hook only as text.
DVUnknownModuleException: Thrown when a module is requested that was never registered.
DVVelocityRefusal: A velocity limit that tripped (DV-EDGE-005).
DVWebPermissionDenied: The browser had the API and the answer was no.
DVWorkerFailure: A run that produced no value, described.
DVWorkflowException: Thrown when a workflow cannot run: an unknown action, a missing variable, a malformed step.
DVXRBindingException: A binding that is present and failed, or absent where a capability said it would be there. Reported as DV-XR-006, an error: an integration defect, not a capability limit.
GoError: Thrown when GoRouter is used incorrectly.
GoException: Thrown when GoRouter can not handle a user request.

dartvel_ui library

Classes

Enums

Mixins

Extensions

Constants

Properties

Functions

Typedefs

Exceptions / Errors

dartvel_dev package

dartvel_ui library