PcoPeopleSchoolOption class Null safety

This class represents a PCO People SchoolOption Object

Instantiation

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

Description

A school option represents a school name, school type, grades, etc. and can be selected for a person.

Attributes (and permissions)

  • id (ro) -> PCO: id
  • value (rw) -> PCO: value
  • sequence (rw) -> PCO: sequence
  • beginningGrade (rw) -> PCO: beginning_grade
  • endingGrade (rw) -> PCO: ending_grade
  • schoolTypes (rw) -> PCO: school_types

Edges and Actions

Outbound Edges:

Inbound Edges:

Actions: NONE

Raw Data Object Example

{
  "type": "SchoolOption",
  "id": "1",
  "attributes": {
    "value": "string",
    "sequence": 1,
    "beginning_grade": "string",
    "ending_grade": "string",
    "school_types": []
  },
  "relationships": {}
}
Inheritance

Constructors

PcoPeopleSchoolOption({String? id, String? value, int? sequence, String? beginningGrade, String? endingGrade, List? schoolTypes, Map<String, List<PcoResource>>? withRelationships, List<PcoResource>? withIncluded})
Create a new PcoPeopleSchoolOption object using this endpoint: https://api.planningcenteronline.com/people/v2/school_options
factory
PcoPeopleSchoolOption.empty()
Create an empty instance of this class. This is only useful when an endpoint requires related or included data.
PcoPeopleSchoolOption.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
beginningGrade String
pass null to remove key from attributes
read / write
canCreate bool
read-onlyoverride
canDestroy bool
read-onlyoverride
canUpdate bool
read-onlyoverride
createAllowed List<String>
read-onlyoverride
createdAt DateTime
read-onlyinherited
createPathTemplate String
read-onlyoverride
defaultPathTemplate String
read-onlyoverride
endingGrade String
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
contains the links data returned by the api if present
read-onlyinherited
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
schoolTypes List
pass null to remove key from attributes
read / write
sequence int
pass null to remove key from attributes
read / write
slug String
read-onlyinherited
updateAllowed List<String>
read-onlyoverride
updatedAt DateTime
read-onlyinherited
value String
pass null to remove key from attributes
read / write

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
getPromotesToSchool({PcoPeopleSchoolOptionQuery? query}) Future<PcoCollection<PcoPeopleSchoolOption>>
Will get a collection of PcoPeopleSchoolOption objects (expecting many) using a path like this: https://api.planningcenteronline.com/people/v2/school_options/1/promotes_to_school
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, PcoPeopleSchoolOptionQuery? query, bool getAll = false}) Future<PcoCollection<PcoPeopleSchoolOption>>
Will get a PcoCollection of PcoPeopleSchoolOption objects (expecting many) using a path like this: /people/v2/school_options
getAll({String? id, PcoPeopleSchoolOptionQuery? query}) Future<PcoCollection<PcoPeopleSchoolOption>>
Will get a PcoCollection containing ALL PcoPeopleSchoolOption objects (expecting many) using a path like this: /people/v2/school_options
getAllPromotesToSchoolFromSchoolOption(String schoolOptionId, {String? id, PcoPeopleSchoolOptionQuery? query}) Future<PcoCollection<PcoPeopleSchoolOption>>
Will get a PcoCollection containing ALL PcoPeopleSchoolOption objects (expecting many) using a path like this: /people/v2/school_options/$schoolOptionId/promotes_to_school
getAllSchoolFromPerson(String personId, {String? id, PcoPeopleSchoolOptionQuery? query}) Future<PcoCollection<PcoPeopleSchoolOption>>
Will get a PcoCollection containing ALL PcoPeopleSchoolOption objects (expecting many) using a path like this: /people/v2/people/$personId/school
getPromotesToSchoolFromSchoolOption(String schoolOptionId, {String? id, PcoPeopleSchoolOptionQuery? query, bool getAll = false}) Future<PcoCollection<PcoPeopleSchoolOption>>
Will get a PcoCollection of PcoPeopleSchoolOption objects (expecting many) using a path like this: /people/v2/school_options/$schoolOptionId/promotes_to_school
getSchoolFromPerson(String personId, {String? id, PcoPeopleSchoolOptionQuery? query, bool getAll = false}) Future<PcoCollection<PcoPeopleSchoolOption>>
Will get a PcoCollection of PcoPeopleSchoolOption objects (expecting many) using a path like this: /people/v2/people/$personId/school
getSingle(String id, {PcoPeopleSchoolOptionQuery? query}) Future<PcoPeopleSchoolOption?>
Will get a single PcoPeopleSchoolOption object using a path like this: /people/v2/school_options/[id]
getSinglePromotesToSchoolFromSchoolOption(String schoolOptionId, String id, {PcoPeopleSchoolOptionQuery? query}) Future<PcoPeopleSchoolOption?>
Will get a single PcoPeopleSchoolOption object using a path like this: /people/v2/school_options/$schoolOptionId/promotes_to_school/[id]
getSingleSchoolFromPerson(String personId, String id, {PcoPeopleSchoolOptionQuery? query}) Future<PcoPeopleSchoolOption?>
Will get a single PcoPeopleSchoolOption object using a path like this: /people/v2/people/$personId/school/[id]

Constants

kApiVersion → const String
'2022-07-14'
kBeginningGrade → const String
'beginning_grade'
kCreatePathTemplate → const String
'https://api.planningcenteronline.com/people/v2/school_options'
kDefaultPathTemplate → const String
'https://api.planningcenteronline.com/people/v2/school_options'
kEndingGrade → const String
'ending_grade'
kId → const String
'id'
kPcoApplication → const String
'people'
kSchoolTypes → const String
'school_types'
kSequence → const String
'sequence'
kTypeId → const String
'school_option'
kTypeString → const String
'SchoolOption'
kValue → const String
'value'