ResponseShape enum

How a route returns its item schema (see RouteEntry.returns).

Inheritance

• Object
• Enum
• ResponseShape

Available extensions

• EnumName

Values

item → const ResponseShape

{"data": item} (a JsonResource).

raw → const ResponseShape

The item itself, without a data wrapper.

collection → const ResponseShape

{"data": [item, ...]} (JsonResource.collection of a list).

paginated → const ResponseShape

{"data": [...], "links": {...}, "meta": {...}} from paginate().

simplePaginated → const ResponseShape

The same envelope from simplePaginate().

cursorPaginated → const ResponseShape

The same envelope from cursorPaginate().

Properties

hashCode → int

The hash code for this object.

no setter, inherited

index → int

A numeric identifier for the enumerated value.

no setter, inherited

name → String

Available on Enum, provided by the EnumName extension

The name of the enum value.

no setter

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Constants

values → const List<ResponseShape>

A constant List of the values in this enum, in order of their declaration.