PcoPeopleFieldDatum class

This class represents a PCO People FieldDatum Object

Instantiation

  • Create a new instance using the PcoPeopleFieldDatum() constructor
  • Instantiate from existing JSON data using the PcoPeopleFieldDatum.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

UPDATING

Given a person ID and a field definition ID with a data type of 'checkboxes', in order to 'check' the box for that profile, you want to do a POST request to /people/v2/people/<person_id>/field_data. The payload must contain the field_definition_id and the string value.

   {
     "data": {
        "attributes": {
          "field_definition_id": <field_definition_id>,
          "value": "Financial/Bills"
        }
     }
   }

Note that if you POST with a value that does not already correspond to an existing field_option value for that field_definition, then the API will create a new one with that value.

You can GET all the existing checkbox values at /people/v2/field_definitions/<field_definition_id>/field_options.

To 'uncheck' the value of the checkbox, you can issue a DELETE to /people/v2/people/<person_id>/field_data/<field_datum_id>.

Description

A field datum is an individual piece of data for a custom field.

Attributes (and permissions)

  • id (ro) -> PCO: id
  • value (rw) -> PCO: value
  • file (ro) -> PCO: file
  • fileSize (ro) -> PCO: file_size
  • fileContentType (ro) -> PCO: file_content_type
  • fileName (ro) -> PCO: file_name
  • fieldDefinitionId (wo) -> PCO: field_definition_id

Edges and Actions

Outbound Edges:

Inbound Edges:

Actions: NONE

Raw Data Object Example

{
  "type": "FieldDatum",
  "id": "1",
  "attributes": {
    "value": "string",
    "file": "string",
    "file_size": 1,
    "file_content_type": "string",
    "file_name": "string"
  },
  "relationships": {
    "field_definition": {
      "data": {
        "type": "FieldDefinition",
        "id": "1"
      }
    },
    "customizable": {
      "data": {
        "type": "Customizable",
        "id": "1"
      }
    }
  }
}
Inheritance

Constructors

PcoPeopleFieldDatum({required String personId, String? id, String? value, String? file, int? fileSize, String? fileContentType, String? fileName, String? fieldDefinitionId, Map<String, List<PcoResource>>? withRelationships, List<PcoResource>? withIncluded})
Create a new PcoPeopleFieldDatum object using this endpoint: https://api.planningcenteronline.com/people/v2/people/$personId/field_data
factory
PcoPeopleFieldDatum.empty()
Create an empty instance of this class. This is only useful when an endpoint requires related or included data.
PcoPeopleFieldDatum.fromJson(Map<String, dynamic> data, {List<Map<String, dynamic>>? withIncluded})

Properties

api → PlanningCenter
planning center resources must be tied to an api
no setterinherited
apiEndpoint → String
no setterinherited
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
no setteroverride
apiVersion → String
child classes can override these getters which will allow methods in this class to see static variables from child classes
no setteroverride
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
no setterinherited
canCreate → bool
no setteroverride
canDestroy → bool
no setteroverride
canUpdate → bool
no setteroverride
createAllowed → List<String>
no setteroverride
createdAt → DateTime
no setterinherited
createPathTemplate → String
no setteroverride
defaultPathTemplate → String
no setteroverride
fetched ↔ bool
indicate whether an item is full or partial
getter/setter pairinherited
fieldDefinitionId ↔ String
pass null to remove key from attributes
getter/setter pair
file → String
no setter
fileContentType → String
no setter
fileName → String
no setter
fileSize → int
no setter
hashCode → int
The hash code for this object.
no setterinherited
id → String?
no setterinherited
included → List<PcoResource>
contains included items parsed into objects
no setterinherited
includedFieldDefinition → PcoPeopleFieldDefinition?
no setter
includedFieldOption → PcoPeopleFieldOption?
no setter
includedTab → PcoPeopleTab?
no setter
contains the links data returned by the api if present
no setterinherited
needsSave → bool
no setterinherited
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
no setterinherited
resourceType ↔ String
all planning center resources must have a type
latefinalinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
slug → String
no setterinherited
updateAllowed → List<String>
no setteroverride
updatedAt → DateTime
no setterinherited
value ↔ String
pass null to remove key from attributes
getter/setter pair

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
getFieldDefinition({PcoPeopleFieldDefinitionQuery? query}) → Future<PcoCollection<PcoPeopleFieldDefinition>>
Will get a collection of PcoPeopleFieldDefinition objects (expecting one) using a path like this: https://api.planningcenteronline.com/people/v2/field_data/1/field_definition
getFieldOption({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_data/1/field_option
getPerson({PcoPeoplePersonQuery? query}) → Future<PcoCollection<PcoPeoplePerson>>
Will get a collection of PcoPeoplePerson objects (expecting many) using a path like this: https://api.planningcenteronline.com/people/v2/field_data/1/person
getTab({PcoPeopleTabQuery? query}) → Future<PcoCollection<PcoPeopleTab>>
Will get a collection of PcoPeopleTab objects (expecting many) using a path like this: https://api.planningcenteronline.com/people/v2/field_data/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 nonexistent 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
no setter
canOrderBy → List<String>
possible orderings with parameter ?order=
no setter
canQuery → List<String>
possible queries using parameters like ?wherekey=value or ?wheregt|lt=value
no setter

Static Methods

get({String? id, PcoPeopleFieldDatumQuery? query, bool getAll = false, bool includeAllRelated = false, bool includeFieldDefinition = false, bool includeFieldOption = false, bool includeTab = false}) → Future<PcoCollection<PcoPeopleFieldDatum>>
Will get a PcoCollection of PcoPeopleFieldDatum objects (expecting many) using a path like this: /people/v2/field_data
getAll({String? id, PcoPeopleFieldDatumQuery? query, bool includeAllRelated = false, bool includeFieldDefinition = false, bool includeFieldOption = false, bool includeTab = false}) → Future<PcoCollection<PcoPeopleFieldDatum>>
Will get a PcoCollection containing ALL PcoPeopleFieldDatum objects (expecting many) using a path like this: /people/v2/field_data
getAllFromPerson(String personId, {String? id, PcoPeopleFieldDatumQuery? query, bool includeAllRelated = false, bool includeFieldDefinition = false, bool includeFieldOption = false, bool includeTab = false}) → Future<PcoCollection<PcoPeopleFieldDatum>>
Will get a PcoCollection containing ALL PcoPeopleFieldDatum objects (expecting many) using a path like this: /people/v2/people/$personId/field_data
getFromPerson(String personId, {String? id, PcoPeopleFieldDatumQuery? query, bool getAll = false, bool includeAllRelated = false, bool includeFieldDefinition = false, bool includeFieldOption = false, bool includeTab = false}) → Future<PcoCollection<PcoPeopleFieldDatum>>
Will get a PcoCollection of PcoPeopleFieldDatum objects (expecting many) using a path like this: /people/v2/people/$personId/field_data
getSingle(String id, {PcoPeopleFieldDatumQuery? query, bool includeAllRelated = false, bool includeFieldDefinition = false, bool includeFieldOption = false, bool includeTab = false}) → Future<PcoPeopleFieldDatum?>
Will get a single PcoPeopleFieldDatum object using a path like this: /people/v2/field_data/[id]
getSingleFromPerson(String personId, String id, {PcoPeopleFieldDatumQuery? query, bool includeAllRelated = false, bool includeFieldDefinition = false, bool includeFieldOption = false, bool includeTab = false}) → Future<PcoPeopleFieldDatum?>
Will get a single PcoPeopleFieldDatum object using a path like this: /people/v2/people/$personId/field_data/[id]

Constants

kApiVersion → const String
kCreatePathTemplate → const String
kDefaultPathTemplate → const String
kFieldDefinitionId → const String
kFile → const String
kFileContentType → const String
kFileName → const String
kFileSize → const String
kId → const String
kPcoApplication → const String
kTypeId → const String
kTypeString → const String
kValue → const String