PcoCheckInsLocation class

This class represents a PCO CheckIns Location Object

Instantiation

  • This object cannot be created through the API.
  • Instantiate from existing JSON data using the PcoCheckInsLocation.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 place where people may check in to for a given event. Some locations have kind="Folder", which means that people can't check-in here, but this location contains other locations. You can get its contents from the locations attribute. You can get a location's parent folder from the parent attribute. (If it's not in a folder, parent will be empty.)

Attributes (and permissions)

  • id (ro) -> PCO: id
  • name (ro) -> PCO: name
  • kind (ro) -> PCO: kind
  • isOpened (ro) -> PCO: opened
  • questions (ro) -> PCO: questions
  • ageMinInMonths (ro) -> PCO: age_min_in_months
  • ageMaxInMonths (ro) -> PCO: age_max_in_months
  • ageRangeBy (ro) -> PCO: age_range_by
  • ageOn (ro) -> PCO: age_on
  • childOrAdult (ro) -> PCO: child_or_adult
  • effectiveDate (ro) -> PCO: effective_date
  • gender (ro) -> PCO: gender
  • gradeMin (ro) -> PCO: grade_min
  • gradeMax (ro) -> PCO: grade_max
  • maxOccupancy (ro) -> PCO: max_occupancy
  • minVolunteers (ro) -> PCO: min_volunteers
  • attendeesPerVolunteer (ro) -> PCO: attendees_per_volunteer
  • position (ro) -> PCO: position
  • updatedAt (ro) -> PCO: updated_at
  • createdAt (ro) -> PCO: created_at

Edges and Actions

Outbound Edges:

Inbound Edges:

Actions: NONE

Raw Data Object Example

{
  "type": "Location",
  "id": "1",
  "attributes": {
    "name": "string",
    "kind": "string",
    "opened": true,
    "questions": "string",
    "age_min_in_months": 1,
    "age_max_in_months": 1,
    "age_range_by": "string",
    "age_on": "2000-01-01",
    "child_or_adult": "string",
    "effective_date": "2000-01-01",
    "gender": "string",
    "grade_min": 1,
    "grade_max": 1,
    "max_occupancy": 1,
    "min_volunteers": 1,
    "attendees_per_volunteer": 1,
    "position": 1,
    "updated_at": "2000-01-01T12:00:00Z",
    "created_at": "2000-01-01T12:00:00Z"
  },
  "relationships": {
    "parent": {
      "data": {
        "type": "Parent",
        "id": "1"
      }
    }
  }
}
Inheritance

Constructors

PcoCheckInsLocation({String? id, String? name, String? kind, bool? isOpened, String? questions, int? ageMinInMonths, int? ageMaxInMonths, String? ageRangeBy, String? ageOn, String? childOrAdult, String? effectiveDate, String? gender, int? gradeMin, int? gradeMax, int? maxOccupancy, int? minVolunteers, int? attendeesPerVolunteer, int? position, DateTime? updatedAt, DateTime? createdAt, Map<String, List<PcoResource>>? withRelationships, List<PcoResource>? withIncluded})
Create a new PcoCheckInsLocation object. This object cannot be created with the API
factory
PcoCheckInsLocation.empty()
Create an empty instance of this class. This is only useful when an endpoint requires related or included data.
PcoCheckInsLocation.fromJson(Map<String, dynamic> data, {List<Map<String, dynamic>>? withIncluded})

Properties

ageMaxInMonths → int
no setter
ageMinInMonths → int
no setter
ageOn → String
no setter
ageRangeBy → String
no setter
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
attendeesPerVolunteer → int
no setter
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
childOrAdult → String
no setter
createAllowed → List<String>
no setteroverride
createdAt → DateTime
no setterinherited
createPathTemplate → String
no setteroverride
defaultPathTemplate → String
no setteroverride
effectiveDate → String
no setter
fetched ↔ bool
indicate whether an item is full or partial
getter/setter pairinherited
gender → String
no setter
gradeMax → int
no setter
gradeMin → 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
includedEvent → PcoCheckInsEvent?
no setter
includedLocations → List<PcoCheckInsLocation>
no setter
includedOptions → List<PcoCheckInsOption>
no setter
isOpened → bool
no setter
kind → String
no setter
contains the links data returned by the api if present
no setterinherited
maxOccupancy → int
no setter
minVolunteers → int
no setter
name → String
no setter
needsSave → bool
no setterinherited
pcoApplication ↔ String
latefinalinherited
position → int
no setter
questions → String
no setter
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

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
getCheckIns({PcoCheckInsCheckInQuery? query}) → Future<PcoCollection<PcoCheckInsCheckIn>>
Will get a collection of PcoCheckInsCheckIn objects (expecting many) using a path like this: https://api.planningcenteronline.com/check-ins/v2/check_ins/1/locations/1/check_ins
getEvent({PcoCheckInsEventQuery? query}) → Future<PcoCollection<PcoCheckInsEvent>>
Will get a collection of PcoCheckInsEvent objects (expecting many) using a path like this: https://api.planningcenteronline.com/check-ins/v2/check_ins/1/locations/1/event
getLocationEventPeriods({PcoCheckInsLocationEventPeriodQuery? query}) → Future<PcoCollection<PcoCheckInsLocationEventPeriod>>
Will get a collection of PcoCheckInsLocationEventPeriod objects (expecting many) using a path like this: https://api.planningcenteronline.com/check-ins/v2/check_ins/1/locations/1/location_event_periods
getLocationEventTimes({PcoCheckInsLocationEventTimeQuery? query}) → Future<PcoCollection<PcoCheckInsLocationEventTime>>
Will get a collection of PcoCheckInsLocationEventTime objects (expecting many) using a path like this: https://api.planningcenteronline.com/check-ins/v2/check_ins/1/locations/1/location_event_times
getLocationLabels({PcoCheckInsLocationLabelQuery? query}) → Future<PcoCollection<PcoCheckInsLocationLabel>>
Will get a collection of PcoCheckInsLocationLabel objects (expecting many) using a path like this: https://api.planningcenteronline.com/check-ins/v2/check_ins/1/locations/1/location_labels
getLocations({PcoCheckInsLocationQuery? query}) → Future<PcoCollection<PcoCheckInsLocation>>
Will get a collection of PcoCheckInsLocation objects (expecting many) using a path like this: https://api.planningcenteronline.com/check-ins/v2/check_ins/1/locations/1/locations
getOptions({PcoCheckInsOptionQuery? query}) → Future<PcoCollection<PcoCheckInsOption>>
Will get a collection of PcoCheckInsOption objects (expecting many) using a path like this: https://api.planningcenteronline.com/check-ins/v2/check_ins/1/locations/1/options
getParent({PcoCheckInsLocationQuery? query}) → Future<PcoCollection<PcoCheckInsLocation>>
Will get a collection of PcoCheckInsLocation objects (expecting one) using a path like this: https://api.planningcenteronline.com/check-ins/v2/check_ins/1/locations/1/parent
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
includedParent<T extends PcoResource>() → List<T>
The code generator could not automatically determine the resource type of this relationship. For type safe code, you should specify it in the type argument when calling.
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

getAllFromCheckIn(String checkInId, {String? id, PcoCheckInsLocationQuery? query, bool includeAllRelated = false, bool includeEvent = false, bool includeLocations = false, bool includeOptions = false, bool includeParent = false}) → Future<PcoCollection<PcoCheckInsLocation>>
Will get a PcoCollection containing ALL PcoCheckInsLocation objects (expecting many) using a path like this: /check-ins/v2/check_ins/$checkInId/locations
getAllFromCheckInAndLocation(String checkInId, String locationId, {String? id, PcoCheckInsLocationQuery? query, bool includeAllRelated = false, bool includeEvent = false, bool includeLocations = false, bool includeOptions = false, bool includeParent = false}) → Future<PcoCollection<PcoCheckInsLocation>>
Will get a PcoCollection containing ALL PcoCheckInsLocation objects (expecting many) using a path like this: /check-ins/v2/check_ins/$checkInId/locations/$locationId/locations
getAllFromEvent(String eventId, {String? id, PcoCheckInsLocationQuery? query, bool includeAllRelated = false, bool includeEvent = false, bool includeLocations = false, bool includeOptions = false, bool includeParent = false}) → Future<PcoCollection<PcoCheckInsLocation>>
Will get a PcoCollection containing ALL PcoCheckInsLocation objects (expecting many) using a path like this: /check-ins/v2/events/$eventId/locations
getAvailableLocationsFromEventTime(String eventTimeId, {PcoCheckInsLocationQuery? query, bool getAll = false, bool includeAllRelated = false, bool includeEvent = false, bool includeLocations = false, bool includeOptions = false, bool includeParent = false}) → Future<PcoCollection<PcoCheckInsLocation>>
Will get a PcoCollection of PcoCheckInsLocation objects (expecting one) using a path like this: /check-ins/v2/event_times/$eventTimeId/available_locations
getFromCheckIn(String checkInId, {String? id, PcoCheckInsLocationQuery? query, bool getAll = false, bool includeAllRelated = false, bool includeEvent = false, bool includeLocations = false, bool includeOptions = false, bool includeParent = false}) → Future<PcoCollection<PcoCheckInsLocation>>
Will get a PcoCollection of PcoCheckInsLocation objects (expecting many) using a path like this: /check-ins/v2/check_ins/$checkInId/locations
getFromCheckInAndEventPeriodAndLocationEventPeriod(String checkInId, String eventPeriodId, String locationEventPeriodId, {PcoCheckInsLocationQuery? query, bool getAll = false, bool includeAllRelated = false, bool includeEvent = false, bool includeLocations = false, bool includeOptions = false, bool includeParent = false}) → Future<PcoCollection<PcoCheckInsLocation>>
Will get a PcoCollection of PcoCheckInsLocation objects (expecting one) using a path like this: /check-ins/v2/check_ins/$checkInId/event_period/$eventPeriodId/location_event_periods/$locationEventPeriodId/location
getFromCheckInAndLocation(String checkInId, String locationId, {String? id, PcoCheckInsLocationQuery? query, bool getAll = false, bool includeAllRelated = false, bool includeEvent = false, bool includeLocations = false, bool includeOptions = false, bool includeParent = false}) → Future<PcoCollection<PcoCheckInsLocation>>
Will get a PcoCollection of PcoCheckInsLocation objects (expecting many) using a path like this: /check-ins/v2/check_ins/$checkInId/locations/$locationId/locations
getFromEvent(String eventId, {String? id, PcoCheckInsLocationQuery? query, bool getAll = false, bool includeAllRelated = false, bool includeEvent = false, bool includeLocations = false, bool includeOptions = false, bool includeParent = false}) → Future<PcoCollection<PcoCheckInsLocation>>
Will get a PcoCollection of PcoCheckInsLocation objects (expecting many) using a path like this: /check-ins/v2/events/$eventId/locations
getFromEventTimeAndLocationEventTime(String eventTimeId, String locationEventTimeId, {PcoCheckInsLocationQuery? query, bool getAll = false, bool includeAllRelated = false, bool includeEvent = false, bool includeLocations = false, bool includeOptions = false, bool includeParent = false}) → Future<PcoCollection<PcoCheckInsLocation>>
Will get a PcoCollection of PcoCheckInsLocation objects (expecting one) using a path like this: /check-ins/v2/event_times/$eventTimeId/location_event_times/$locationEventTimeId/location
getFromLabelAndLocationLabel(String labelId, String locationLabelId, {PcoCheckInsLocationQuery? query, bool getAll = false, bool includeAllRelated = false, bool includeEvent = false, bool includeLocations = false, bool includeOptions = false, bool includeParent = false}) → Future<PcoCollection<PcoCheckInsLocation>>
Will get a PcoCollection of PcoCheckInsLocation objects (expecting one) using a path like this: /check-ins/v2/labels/$labelId/location_labels/$locationLabelId/location
getFromStation(String stationId, {PcoCheckInsLocationQuery? query, bool getAll = false, bool includeAllRelated = false, bool includeEvent = false, bool includeLocations = false, bool includeOptions = false, bool includeParent = false}) → Future<PcoCollection<PcoCheckInsLocation>>
Will get a PcoCollection of PcoCheckInsLocation objects (expecting one) using a path like this: /check-ins/v2/stations/$stationId/location
getParentFromCheckInAndLocation(String checkInId, String locationId, {PcoCheckInsLocationQuery? query, bool getAll = false, bool includeAllRelated = false, bool includeEvent = false, bool includeLocations = false, bool includeOptions = false, bool includeParent = false}) → Future<PcoCollection<PcoCheckInsLocation>>
Will get a PcoCollection of PcoCheckInsLocation objects (expecting one) using a path like this: /check-ins/v2/check_ins/$checkInId/locations/$locationId/parent
getSingleFromCheckIn(String checkInId, String id, {PcoCheckInsLocationQuery? query, bool includeAllRelated = false, bool includeEvent = false, bool includeLocations = false, bool includeOptions = false, bool includeParent = false}) → Future<PcoCheckInsLocation?>
Will get a single PcoCheckInsLocation object using a path like this: /check-ins/v2/check_ins/$checkInId/locations/[id]
getSingleFromCheckInAndLocation(String checkInId, String locationId, String id, {PcoCheckInsLocationQuery? query, bool includeAllRelated = false, bool includeEvent = false, bool includeLocations = false, bool includeOptions = false, bool includeParent = false}) → Future<PcoCheckInsLocation?>
Will get a single PcoCheckInsLocation object using a path like this: /check-ins/v2/check_ins/$checkInId/locations/$locationId/locations/[id]
getSingleFromEvent(String eventId, String id, {PcoCheckInsLocationQuery? query, bool includeAllRelated = false, bool includeEvent = false, bool includeLocations = false, bool includeOptions = false, bool includeParent = false}) → Future<PcoCheckInsLocation?>
Will get a single PcoCheckInsLocation object using a path like this: /check-ins/v2/events/$eventId/locations/[id]

Constants

kAgeMaxInMonths → const String
kAgeMinInMonths → const String
kAgeOn → const String
kAgeRangeBy → const String
kApiVersion → const String
kAttendeesPerVolunteer → const String
kChildOrAdult → const String
kCreatedAt → const String
kCreatePathTemplate → const String
kDefaultPathTemplate → const String
kEffectiveDate → const String
kGender → const String
kGradeMax → const String
kGradeMin → const String
kId → const String
kKind → const String
kMaxOccupancy → const String
kMinVolunteers → const String
kName → const String
kOpened → const String
kPcoApplication → const String
kPosition → const String
kQuestions → const String
kTypeId → const String
kTypeString → const String
kUpdatedAt → const String