ApptiveGridLayout enum

Defines the Layout of an Entity that is returned by ApptiveGrid

When using this manually for example when calling ApptiveGridClient.performApptiveLink add this to queryParamters as

'layout': ApptiveGridLayout.field.queryParameter,
Inheritance

Constructors

ApptiveGridLayout({required String queryParameter})
Creates a new ApptiveGrid Layout enum Entry
const

Values

field → const ApptiveGridLayout

This is the layout that returns a JSON where the JSON keys are the field ids

const ApptiveGridLayout(queryParameter: 'field')
indexed → const ApptiveGridLayout

This is the layout that returns a JSON array containing all fields

const ApptiveGridLayout(queryParameter: 'indexed')
property → const ApptiveGridLayout

This is the layout the returns a JSON where the JSON keys are the name of the fields

const ApptiveGridLayout(queryParameter: 'property')
key → const ApptiveGridLayout

This is the layout that returns a JSON where the JSON keys are the key of a field.

const ApptiveGridLayout(queryParameter: 'key')
keyAndField → const ApptiveGridLayout

This is the layout that returns a JSON where the JSON keys are either field id or field key. When a field has a key this is used if not the field id which is always present

const ApptiveGridLayout(queryParameter: 'keyAndField')

Properties

hashCode int
The hash code for this object.
no setterinherited
index int
A numeric identifier for the enumerated value.
no setterinherited
queryParameter String
The query Parameter that should be used when adding this to a request to ApptiveGrid
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

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<ApptiveGridLayout>
A constant List of the values in this enum, in order of their declaration.