PanelSchema class

The whole panel document. Contains only the resources the authenticated user may view — the server filters, the client never decides.

Constructors

PanelSchema({required int version, required String id, required String title, String locale = '', List<String> locales = const [], PanelDirection direction = PanelDirection.ltr, PollConfig? poll, RealtimeConfig? realtime, List<NavigationGroup> navigation = const [], List<ResourceSchema> resources = const []})
const
PanelSchema.fromJson(Map<String, dynamic> json)
factory

Properties

direction → PanelDirection
The panel's layout direction. Absent or unrecognised reads as PanelDirection.ltr — see PanelDirection.fromJson.
final
hashCode → int
The hash code for this object.
no setterinherited
id → String
final
locale → String
app()->getLocale() at request time, published for a client that wants it for its own formatting. Not used by this package to decide direction — that is read from its own key, independently.
final
locales → List<String>
The panel's declared locales, flat and in display order — absent (or unanswerable server-side) reads as [], never guessed at from a dotted field name. The client uses it only to ORDER a translatable group's chips; the chips themselves come from the form's own fields, which stay the source of truth for which locales actually exist.
final
final
poll → PollConfig?
final
props → List<Object?>
Identity only: id and version are exactly the two things that do not change when a panel's contents do, so two documents whose resources differ entirely still compare equal. Never write if (fresh == cached) return; after refetching /schema — that discards every real update.
no setter
realtime → RealtimeConfig?
final
resources → List<ResourceSchema>
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
stringify → bool?
If set to true, the toString method will be overridden to output this instance's props.
no setterinherited
title → String
final
version → int
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
resource(String key) → ResourceSchema?
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Constants

supportedVersion → const int
The contract version this build understands.