Payload class

Enumerate the AclEntry 0.2 records a maintainer holds, with optional conjunctive filters and paging. A hierarchical filter (context, resource) MUST state its direction; there is no default direction. The outer document members are owned by the framework — SPEC §6.3.

Constructors

Payload({String? role, ContextPath? context, Capability? capability, ResourceQualifier? resource, PayloadDirection? direction, String? subjectPrefix, int? pageSize, String? cursor, Ext? ext})
const
Payload.fromJson(Map<String, dynamic> json)
Read this payload from a decoded JSON object.
factory

Properties

capability → ResourceQualifier?
Optional filter — only entries whose EFFECTIVE capability set includes this capability (the role's full ceiling for capabilities: {scope: ceiling}, nothing for none, and for listed the ceiling ∩ the non-additive grants plus the additive grants). Combined with resource, the capability must be held at a qualifier related to that resource by direction.
final
context → ResourceQualifier?
Optional filter on the entries' ACT scope, read in the stated direction. REQUIRES direction. Replaces 0.1's scope filter.
final
cursor → ResourceQualifier?
Opaque continuation token returned by the maintainer in a previous response. It binds the filters and direction it was minted under; a follow-up request MUST repeat them unchanged.
final
direction → PayloadDirection?
How to read a hierarchical filter (context, resource). REQUIRED when either is present and REFUSED when neither is: actingIn — entries whose scope or qualifier is an ancestor-or-self of the queried one, i.e. who may act IN it (unrestricted act scopes and unqualified capabilities match); subtree — entries holding a grant at or BENEATH the queried one (an unrestricted act scope or an unqualified capability does NOT match, and an entry naming contexts both inside and outside the subtree DOES); any — the union. Same three questions as 0.1's acting-in / subtree / any, re-cased to lowerCamelCase, with no default.
final
ext → Ext?
Ecosystem-defined extension members per SPEC.md §4.5.1.
final
hashCode → int
The hash code for this object.
no setterinherited
pageSize → int?
Maximum number of entries to return. Maintainer-defined default and ceiling.
final
resource → ResourceQualifier?
Optional filter on the resource qualifiers of the entries' effective capabilities (of capability when given, of any capability otherwise), read in the stated direction. REQUIRES direction.
final
role → ResourceQualifier?
Optional filter — only entries with this role are returned.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
subjectPrefix → ResourceQualifier?
Optional filter — only entries whose subject VID starts with this prefix are returned.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() → Map<String, dynamic>
Serialize to a JSON-encodable map, omitting absent members.
toString() → String
A string representation of this object.
inherited

Operators

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