PcoPeopleFieldDefinition class Null safety

This class represents a PCO People FieldDefinition Object

Instantiation

  • Create a new instance using the PcoPeopleFieldDefinition() constructor
  • Instantiate from existing JSON data using the PcoPeopleFieldDefinition.fromJson() constructor.
  • Load an instance from the API using one of the static methods defined on this class.

Usage

  • Fields exposed by the API are readable through getter methods.
  • Fields writable by the API are exposed through setter methods.
  • Original json data is exposed through the read-only attributes map.
  • Additional data is available through the read-only links and relationships maps.
  • Available relationships / includes are exposed through typed getters.

Extra Instructions

DELETING

Deleting a field definition internally sets its deleted_at attribute to the current time.

Description

A field definition represents a custom field -- its name, data type, etc.

Attributes (and permissions)

  • id (ro) -> PCO: id
  • dataType (rw) -> PCO: data_type
  • name (rw) -> PCO: name
  • sequence (rw) -> PCO: sequence
  • slug (rw) -> PCO: slug
  • config (rw) -> PCO: config
  • deletedAt (rw) -> PCO: deleted_at
  • tabId (ro) -> PCO: tab_id

Edges and Actions

Outbound Edges:

Inbound Edges:

Actions: NONE

Raw Data Object Example

{
  "type": "FieldDefinition",
  "id": "1",
  "attributes": {
    "data_type": "string",
    "name": "string",
    "sequence": 1,
    "slug": "string",
    "config": "string",
    "deleted_at": "2000-01-01T12:00:00Z",
    "tab_id": "primary_key"
  },
  "relationships": {
    "tab": {
      "data": {
        "type": "Tab",
        "id": "1"
      }
    }
  }
}
Inheritance

Constructors

PcoPeopleFieldDefinition({required String tabId, String? id, String? dataType, String? name, int? sequence, String? slug, String? config, DateTime? deletedAt, Map<String, List<PcoResource>>? withRelationships, List<PcoResource>? withIncluded})
Create a new PcoPeopleFieldDefinition object using this endpoint: https://api.planningcenteronline.com/people/v2/tabs/$tabId/field_definitions
factory
PcoPeopleFieldDefinition.empty()
Create an empty instance of this class. This is only useful when an endpoint requires related or included data.
PcoPeopleFieldDefinition.fromJson(Map<String, dynamic> data, {List<Map<String, dynamic>>? withIncluded})

Properties

api → PlanningCenter
planning center resources must be tied to an api
read-onlyinherited
apiEndpoint → String
read-onlyinherited
apiPath → String
PcoResources include their own path as a link object but this might be null if we haven't created/fetched the object yet Child classes should redefine this getter to allow for manual path overrides
read-onlyoverride
apiVersion → String
child classes can override these getters which will allow methods in this class to see static variables from child classes
read-onlyoverride
attributes → ReadOnlyMapView<String, dynamic>
contains the underlying attributes returned by the api and allows a user to access arbitrary data in the attributes by actual api name
read-onlyinherited
canCreate → bool
read-onlyoverride
canDestroy → bool
read-onlyoverride
canUpdate → bool
read-onlyoverride
config ↔ String
pass null to remove key from attributes
read / write
createAllowed → List<String>
read-onlyoverride
createdAt → DateTime
read-onlyinherited
createPathTemplate → String
read-onlyoverride
dataType ↔ String
pass null to remove key from attributes
read / write
defaultPathTemplate → String
read-onlyoverride
deletedAt ↔ DateTime
pass null to remove key from attributes
read / write
fetched ↔ bool
indicate whether an item is full or partial
read / writeinherited
hashCode → int
The hash code for this object.
read-onlyinherited
id → String?
read-onlyinherited
included → List<PcoResource>
contains included items parsed into objects
read-onlyinherited
includedFieldOptions → List<PcoPeopleFieldOption>
read-only
includedTab → PcoPeopleTab?
read-only
contains the links data returned by the api if present
read-onlyinherited
name ↔ String
pass null to remove key from attributes
read / write
needsSave → bool
read-onlyinherited
pcoApplication ↔ String
latefinalinherited
relationships → ReadOnlyMapView<String, List<PcoResource>>
contains relationships parsed into objects even though the api sends relationship objects as Maps or Lists we always put them into lists for consistency
read-onlyinherited
resourceType ↔ String
all planning center resources must have a type
latefinalinherited
runtimeType → Type
A representation of the runtime type of the object.
read-onlyinherited
sequence ↔ int
pass null to remove key from attributes
read / write
slug ↔ String
pass null to remove key from attributes
read / writeoverride-getter
tabId → String
read-only
updateAllowed → List<String>
read-onlyoverride
updatedAt → DateTime
read-onlyinherited

Methods

coerceDouble(dynamic a) → double
inherited
coerceInt(dynamic a) → int
inherited
delete() → Future<PlanningCenterApiResponse<PlanningCenterApiData>>
inherited
filteredAttributes(List<String> allowedKeys) → Map<String, dynamic>
inherited
fromJson(Map<String, dynamic> data, {List<Map<String, dynamic>>? withIncluded}) → dynamic
Takes a full JSON:API Response Object (the contents of a "data" field) will clear and update id, apiPath, attributes and _relationships
inherited
getFieldOptions({PcoPeopleFieldOptionQuery? query}) → Future<PcoCollection<PcoPeopleFieldOption>>
Will get a collection of PcoPeopleFieldOption objects (expecting many) using a path like this: https://api.planningcenteronline.com/people/v2/field_definitions/1/field_options
getTab({PcoPeopleTabQuery? query}) → Future<PcoCollection<PcoPeopleTab>>
Will get a collection of PcoPeopleTab objects (expecting one) using a path like this: https://api.planningcenteronline.com/people/v2/field_definitions/1/tab
handleIncludes(List<Map<String, dynamic>> included) → void
This function populates the relationships with typed resource objects based on the data in the included map of the json.
inherited
handleItem(Map<String, dynamic> data) → PcoResource?
inherited
handleRelationships(Map<String, dynamic> items, [List<Map<String, dynamic>> included = const []]) → Map<String, List<PcoResource>>
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed.
inherited
save({Map<String, PcoResource>? withRelated, List<PcoResource>? withIncluded}) → Future<PlanningCenterApiResponse<PlanningCenterApiData>>
Many Planning Center endpoints allow or require additional relationships and/or included items to be sent with a create/update operation. Since these cannot always be determined by the automatic code generation, they may be included as arguments to the save operation.
inherited
toCreateResource() → Map<String, dynamic>
create the attributes Map for this object without the id field using only the attributes allowed in create (post) operations
inherited
toDataMap({Map<String, PcoResource>? withRelated, List<PcoResource>? withIncluded}) → Map<String, dynamic>
create a json-api Map for this object automatically selecting create or update based on the existence of the id field. Will result in something like this:
inherited
toIdResource() → Map<String, dynamic>
returns the simplest representation of this resource with only the type and the id:
inherited
toJson({dynamic includeAttributes = true, dynamic includeRelationships = false}) → Map<String, dynamic>
Some api requests only want the type and id of an object. In those cases, set includeAttributes to false or call toIdResource instead.
inherited
toString() → String
A string representation of this object.
inherited
toUpdateResource() → Map<String, dynamic>
create the attributes Map for this object using only the attributes allowed in update (patch) operations
inherited

Operators

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

Static Properties

canInclude → List<String>
possible includes with parameter ?include=a,b
read-only
canOrderBy → List<String>
possible orderings with parameter ?order=
read-only
canQuery → List<String>
possible queries using parameters like ?wherekey=value or ?wheregt|lt=value
read-only

Static Methods

get({String? id, PcoPeopleFieldDefinitionQuery? query, bool getAll = false, bool includeAllRelated = false, bool includeFieldOptions = false, bool includeTab = false}) → Future<PcoCollection<PcoPeopleFieldDefinition>>
Will get a PcoCollection of PcoPeopleFieldDefinition objects (expecting many) using a path like this: /people/v2/field_definitions
getAll({String? id, PcoPeopleFieldDefinitionQuery? query, bool includeAllRelated = false, bool includeFieldOptions = false, bool includeTab = false}) → Future<PcoCollection<PcoPeopleFieldDefinition>>
Will get a PcoCollection containing ALL PcoPeopleFieldDefinition objects (expecting many) using a path like this: /people/v2/field_definitions
getAllFromTab(String tabId, {String? id, PcoPeopleFieldDefinitionQuery? query, bool includeAllRelated = false, bool includeFieldOptions = false, bool includeTab = false}) → Future<PcoCollection<PcoPeopleFieldDefinition>>
Will get a PcoCollection containing ALL PcoPeopleFieldDefinition objects (expecting many) using a path like this: /people/v2/tabs/$tabId/field_definitions
getFromFieldData(String fieldDataId, {PcoPeopleFieldDefinitionQuery? query, bool getAll = false, bool includeAllRelated = false, bool includeFieldOptions = false, bool includeTab = false}) → Future<PcoCollection<PcoPeopleFieldDefinition>>
Will get a PcoCollection of PcoPeopleFieldDefinition objects (expecting one) using a path like this: /people/v2/field_data/$fieldDataId/field_definition
getFromTab(String tabId, {String? id, PcoPeopleFieldDefinitionQuery? query, bool getAll = false, bool includeAllRelated = false, bool includeFieldOptions = false, bool includeTab = false}) → Future<PcoCollection<PcoPeopleFieldDefinition>>
Will get a PcoCollection of PcoPeopleFieldDefinition objects (expecting many) using a path like this: /people/v2/tabs/$tabId/field_definitions
getSingle(String id, {PcoPeopleFieldDefinitionQuery? query, bool includeAllRelated = false, bool includeFieldOptions = false, bool includeTab = false}) → Future<PcoPeopleFieldDefinition?>
Will get a single PcoPeopleFieldDefinition object using a path like this: /people/v2/field_definitions/[id]
getSingleFromTab(String tabId, String id, {PcoPeopleFieldDefinitionQuery? query, bool includeAllRelated = false, bool includeFieldOptions = false, bool includeTab = false}) → Future<PcoPeopleFieldDefinition?>
Will get a single PcoPeopleFieldDefinition object using a path like this: /people/v2/tabs/$tabId/field_definitions/[id]

Constants

kApiVersion → const String
'2022-07-14'
kConfig → const String
'config'
kCreatePathTemplate → const String
'https://api.planningcenteronline.com/people/v2/tabs/1/field_definitions'
kDataType → const String
'data_type'
kDefaultPathTemplate → const String
'https://api.planningcenteronline.com/people/v2/field_definitions'
kDeletedAt → const String
'deleted_at'
kId → const String
'id'
kName → const String
'name'
kPcoApplication → const String
'people'
kSequence → const String
'sequence'
kSlug → const String
'slug'
kTabId → const String
'tab_id'
kTypeId → const String
'field_definition'
kTypeString → const String
'FieldDefinition'