PcoCheckInsEvent class

This class represents a PCO CheckIns Event Object

Application: check-ins
Id: event
Type: Event
ApiVersion: 2019-07-17
Is Deprecated: false
Is Collection Only: false
Default Endpoint: https://api.planningcenteronline.com/check-ins/v2/events
Create Endpoint: NONE

Instantiation

This object cannot be created through the API.
Instantiate from existing JSON data using the PcoCheckInsEvent.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 recurring event which people may attend.

Each recurrence is an event period (which often corresponds to a week).

Event periods have event times where people may actually check in.

Attributes (and permissions)

id (ro) -> PCO: id
name (ro) -> PCO: name
frequency (ro) -> PCO: frequency
isEnableServicesIntegration (ro) -> PCO: enable_services_integration
createdAt (ro) -> PCO: created_at
updatedAt (ro) -> PCO: updated_at
archivedAt (ro) -> PCO: archived_at
integrationKey (ro) -> PCO: integration_key
isLocationTimesEnabled (ro) -> PCO: location_times_enabled
isPreSelectEnabled (ro) -> PCO: pre_select_enabled
appSource (ro) -> PCO: app_source

Edges and Actions

Outbound Edges:

attendancetype-event-attendance_types: https://api.planningcenteronline.com/check-ins/v2/events/1/attendance_types
checkin-event-check_ins: https://api.planningcenteronline.com/check-ins/v2/events/1/check_ins
eventtime-event-current_event_times: https://api.planningcenteronline.com/check-ins/v2/events/1/current_event_times
eventlabel-event-event_labels: https://api.planningcenteronline.com/check-ins/v2/events/1/event_labels
eventperiod-event-event_periods: https://api.planningcenteronline.com/check-ins/v2/events/1/event_periods
location-event-locations: https://api.planningcenteronline.com/check-ins/v2/events/1/locations
personevent-event-person_events: https://api.planningcenteronline.com/check-ins/v2/events/1/person_events

Inbound Edges:

event-attendancetype-event: https://api.planningcenteronline.com/check-ins/v2/attendance_types/1/event
event-checkin-event: https://api.planningcenteronline.com/check-ins/v2/check_ins/1/event
event-eventlabel-event: https://api.planningcenteronline.com/check-ins/v2/events/1/event_labels/1/event
event-eventperiod-event: https://api.planningcenteronline.com/check-ins/v2/check_ins/1/event_period/1/event
event-eventtime-event: https://api.planningcenteronline.com/check-ins/v2/event_times/1/event
event-location-event: https://api.planningcenteronline.com/check-ins/v2/check_ins/1/locations/1/event
event-organization-events: https://api.planningcenteronline.com/check-ins/v2/events
event-personevent-event: https://api.planningcenteronline.com/check-ins/v2/events/1/person_events/1/event
event-station-event: https://api.planningcenteronline.com/check-ins/v2/stations/1/event

Actions: NONE

Raw Data Object Example

{
  "type": "Event",
  "id": "1",
  "attributes": {
    "name": "string",
    "frequency": "string",
    "enable_services_integration": true,
    "created_at": "2000-01-01T12:00:00Z",
    "updated_at": "2000-01-01T12:00:00Z",
    "archived_at": "2000-01-01T12:00:00Z",
    "integration_key": "string",
    "location_times_enabled": true,
    "pre_select_enabled": true
  },
  "relationships": {}
}

Inheritance

Object
PcoResource
PcoCheckInsEvent

Constructors

PcoCheckInsEvent({String? id, String? name, String? frequency, bool? isEnableServicesIntegration, DateTime? createdAt, DateTime? updatedAt, DateTime? archivedAt, String? integrationKey, bool? isLocationTimesEnabled, bool? isPreSelectEnabled, String? appSource, Map<String, List<PcoResource>>? withRelationships, List<PcoResource>? withIncluded}): Create a new PcoCheckInsEvent object. This object cannot be created with the API
factory
PcoCheckInsEvent.empty(): Create an empty instance of this class. This is only useful when an endpoint requires related or included data.
PcoCheckInsEvent.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
appSource → String: no setter
archivedAt → DateTime: 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
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
frequency → String: 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
includedAttendanceTypes → List<PcoCheckInsAttendanceType>: no setter
includedEventPeriods → List<PcoCheckInsEventPeriod>: no setter
integrationKey → String: no setter
isEnableServicesIntegration → bool: no setter
isLocationTimesEnabled → bool: no setter
isPreSelectEnabled → bool: no setter
links → ReadOnlyMapView<String, dynamic>: contains the links data returned by the api if present
no setterinherited
name → String: no setter
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

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
getAttendanceTypes({PcoCheckInsAttendanceTypeQuery? query}) → Future<PcoCollection<PcoCheckInsAttendanceType>>: Will get a collection of PcoCheckInsAttendanceType objects (expecting many) using a path like this: https://api.planningcenteronline.com/check-ins/v2/events/1/attendance_types
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/events/1/check_ins
getCurrentEventTimes({PcoCheckInsEventTimeQuery? query}) → Future<PcoCollection<PcoCheckInsEventTime>>: Will get a collection of PcoCheckInsEventTime objects (expecting many) using a path like this: https://api.planningcenteronline.com/check-ins/v2/events/1/current_event_times
getEventLabels({PcoCheckInsEventLabelQuery? query}) → Future<PcoCollection<PcoCheckInsEventLabel>>: Will get a collection of PcoCheckInsEventLabel objects (expecting many) using a path like this: https://api.planningcenteronline.com/check-ins/v2/events/1/event_labels
getEventPeriods({PcoCheckInsEventPeriodQuery? query}) → Future<PcoCollection<PcoCheckInsEventPeriod>>: Will get a collection of PcoCheckInsEventPeriod objects (expecting many) using a path like this: https://api.planningcenteronline.com/check-ins/v2/events/1/event_periods
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/events/1/locations
getPersonEvents({PcoCheckInsPersonEventQuery? query}) → Future<PcoCollection<PcoCheckInsPersonEvent>>: Will get a collection of PcoCheckInsPersonEvent objects (expecting many) using a path like this: https://api.planningcenteronline.com/check-ins/v2/events/1/person_events
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, PcoCheckInsEventQuery? query, bool getAll = false, bool includeAllRelated = false, bool includeAttendanceTypes = false, bool includeEventPeriods = false}) → Future<PcoCollection<PcoCheckInsEvent>>: Will get a PcoCollection of PcoCheckInsEvent objects (expecting many) using a path like this: /check-ins/v2/events
getAll({String? id, PcoCheckInsEventQuery? query, bool includeAllRelated = false, bool includeAttendanceTypes = false, bool includeEventPeriods = false}) → Future<PcoCollection<PcoCheckInsEvent>>: Will get a PcoCollection containing ALL PcoCheckInsEvent objects (expecting many) using a path like this: /check-ins/v2/events
getAllFromAttendanceType(String attendanceTypeId, {String? id, PcoCheckInsEventQuery? query, bool includeAllRelated = false, bool includeAttendanceTypes = false, bool includeEventPeriods = false}) → Future<PcoCollection<PcoCheckInsEvent>>: Will get a PcoCollection containing ALL PcoCheckInsEvent objects (expecting many) using a path like this: /check-ins/v2/attendance_types/$attendanceTypeId/event
getAllFromCheckIn(String checkInId, {String? id, PcoCheckInsEventQuery? query, bool includeAllRelated = false, bool includeAttendanceTypes = false, bool includeEventPeriods = false}) → Future<PcoCollection<PcoCheckInsEvent>>: Will get a PcoCollection containing ALL PcoCheckInsEvent objects (expecting many) using a path like this: /check-ins/v2/check_ins/$checkInId/event
getAllFromCheckInAndEventPeriod(String checkInId, String eventPeriodId, {String? id, PcoCheckInsEventQuery? query, bool includeAllRelated = false, bool includeAttendanceTypes = false, bool includeEventPeriods = false}) → Future<PcoCollection<PcoCheckInsEvent>>: Will get a PcoCollection containing ALL PcoCheckInsEvent objects (expecting many) using a path like this: /check-ins/v2/check_ins/$checkInId/event_period/$eventPeriodId/event
getAllFromCheckInAndLocation(String checkInId, String locationId, {String? id, PcoCheckInsEventQuery? query, bool includeAllRelated = false, bool includeAttendanceTypes = false, bool includeEventPeriods = false}) → Future<PcoCollection<PcoCheckInsEvent>>: Will get a PcoCollection containing ALL PcoCheckInsEvent objects (expecting many) using a path like this: /check-ins/v2/check_ins/$checkInId/locations/$locationId/event
getAllFromEventAndEventLabel(String eventId, String eventLabelId, {String? id, PcoCheckInsEventQuery? query, bool includeAllRelated = false, bool includeAttendanceTypes = false, bool includeEventPeriods = false}) → Future<PcoCollection<PcoCheckInsEvent>>: Will get a PcoCollection containing ALL PcoCheckInsEvent objects (expecting many) using a path like this: /check-ins/v2/events/$eventId/event_labels/$eventLabelId/event
getAllFromEventAndPersonEvent(String eventId, String personEventId, {String? id, PcoCheckInsEventQuery? query, bool includeAllRelated = false, bool includeAttendanceTypes = false, bool includeEventPeriods = false}) → Future<PcoCollection<PcoCheckInsEvent>>: Will get a PcoCollection containing ALL PcoCheckInsEvent objects (expecting many) using a path like this: /check-ins/v2/events/$eventId/person_events/$personEventId/event
getAllFromEventTime(String eventTimeId, {String? id, PcoCheckInsEventQuery? query, bool includeAllRelated = false, bool includeAttendanceTypes = false, bool includeEventPeriods = false}) → Future<PcoCollection<PcoCheckInsEvent>>: Will get a PcoCollection containing ALL PcoCheckInsEvent objects (expecting many) using a path like this: /check-ins/v2/event_times/$eventTimeId/event
getAllFromStation(String stationId, {String? id, PcoCheckInsEventQuery? query, bool includeAllRelated = false, bool includeAttendanceTypes = false, bool includeEventPeriods = false}) → Future<PcoCollection<PcoCheckInsEvent>>: Will get a PcoCollection containing ALL PcoCheckInsEvent objects (expecting many) using a path like this: /check-ins/v2/stations/$stationId/event
getFromAttendanceType(String attendanceTypeId, {String? id, PcoCheckInsEventQuery? query, bool getAll = false, bool includeAllRelated = false, bool includeAttendanceTypes = false, bool includeEventPeriods = false}) → Future<PcoCollection<PcoCheckInsEvent>>: Will get a PcoCollection of PcoCheckInsEvent objects (expecting many) using a path like this: /check-ins/v2/attendance_types/$attendanceTypeId/event
getFromCheckIn(String checkInId, {String? id, PcoCheckInsEventQuery? query, bool getAll = false, bool includeAllRelated = false, bool includeAttendanceTypes = false, bool includeEventPeriods = false}) → Future<PcoCollection<PcoCheckInsEvent>>: Will get a PcoCollection of PcoCheckInsEvent objects (expecting many) using a path like this: /check-ins/v2/check_ins/$checkInId/event
getFromCheckInAndEventPeriod(String checkInId, String eventPeriodId, {String? id, PcoCheckInsEventQuery? query, bool getAll = false, bool includeAllRelated = false, bool includeAttendanceTypes = false, bool includeEventPeriods = false}) → Future<PcoCollection<PcoCheckInsEvent>>: Will get a PcoCollection of PcoCheckInsEvent objects (expecting many) using a path like this: /check-ins/v2/check_ins/$checkInId/event_period/$eventPeriodId/event
getFromCheckInAndLocation(String checkInId, String locationId, {String? id, PcoCheckInsEventQuery? query, bool getAll = false, bool includeAllRelated = false, bool includeAttendanceTypes = false, bool includeEventPeriods = false}) → Future<PcoCollection<PcoCheckInsEvent>>: Will get a PcoCollection of PcoCheckInsEvent objects (expecting many) using a path like this: /check-ins/v2/check_ins/$checkInId/locations/$locationId/event
getFromEventAndEventLabel(String eventId, String eventLabelId, {String? id, PcoCheckInsEventQuery? query, bool getAll = false, bool includeAllRelated = false, bool includeAttendanceTypes = false, bool includeEventPeriods = false}) → Future<PcoCollection<PcoCheckInsEvent>>: Will get a PcoCollection of PcoCheckInsEvent objects (expecting many) using a path like this: /check-ins/v2/events/$eventId/event_labels/$eventLabelId/event
getFromEventAndPersonEvent(String eventId, String personEventId, {String? id, PcoCheckInsEventQuery? query, bool getAll = false, bool includeAllRelated = false, bool includeAttendanceTypes = false, bool includeEventPeriods = false}) → Future<PcoCollection<PcoCheckInsEvent>>: Will get a PcoCollection of PcoCheckInsEvent objects (expecting many) using a path like this: /check-ins/v2/events/$eventId/person_events/$personEventId/event
getFromEventTime(String eventTimeId, {String? id, PcoCheckInsEventQuery? query, bool getAll = false, bool includeAllRelated = false, bool includeAttendanceTypes = false, bool includeEventPeriods = false}) → Future<PcoCollection<PcoCheckInsEvent>>: Will get a PcoCollection of PcoCheckInsEvent objects (expecting many) using a path like this: /check-ins/v2/event_times/$eventTimeId/event
getFromStation(String stationId, {String? id, PcoCheckInsEventQuery? query, bool getAll = false, bool includeAllRelated = false, bool includeAttendanceTypes = false, bool includeEventPeriods = false}) → Future<PcoCollection<PcoCheckInsEvent>>: Will get a PcoCollection of PcoCheckInsEvent objects (expecting many) using a path like this: /check-ins/v2/stations/$stationId/event
getSingle(String id, {PcoCheckInsEventQuery? query, bool includeAllRelated = false, bool includeAttendanceTypes = false, bool includeEventPeriods = false}) → Future<PcoCheckInsEvent?>: Will get a single PcoCheckInsEvent object using a path like this: /check-ins/v2/events/[id]
getSingleFromAttendanceType(String attendanceTypeId, String id, {PcoCheckInsEventQuery? query, bool includeAllRelated = false, bool includeAttendanceTypes = false, bool includeEventPeriods = false}) → Future<PcoCheckInsEvent?>: Will get a single PcoCheckInsEvent object using a path like this: /check-ins/v2/attendance_types/$attendanceTypeId/event/[id]
getSingleFromCheckIn(String checkInId, String id, {PcoCheckInsEventQuery? query, bool includeAllRelated = false, bool includeAttendanceTypes = false, bool includeEventPeriods = false}) → Future<PcoCheckInsEvent?>: Will get a single PcoCheckInsEvent object using a path like this: /check-ins/v2/check_ins/$checkInId/event/[id]
getSingleFromCheckInAndEventPeriod(String checkInId, String eventPeriodId, String id, {PcoCheckInsEventQuery? query, bool includeAllRelated = false, bool includeAttendanceTypes = false, bool includeEventPeriods = false}) → Future<PcoCheckInsEvent?>: Will get a single PcoCheckInsEvent object using a path like this: /check-ins/v2/check_ins/$checkInId/event_period/$eventPeriodId/event/[id]
getSingleFromCheckInAndLocation(String checkInId, String locationId, String id, {PcoCheckInsEventQuery? query, bool includeAllRelated = false, bool includeAttendanceTypes = false, bool includeEventPeriods = false}) → Future<PcoCheckInsEvent?>: Will get a single PcoCheckInsEvent object using a path like this: /check-ins/v2/check_ins/$checkInId/locations/$locationId/event/[id]
getSingleFromEventAndEventLabel(String eventId, String eventLabelId, String id, {PcoCheckInsEventQuery? query, bool includeAllRelated = false, bool includeAttendanceTypes = false, bool includeEventPeriods = false}) → Future<PcoCheckInsEvent?>: Will get a single PcoCheckInsEvent object using a path like this: /check-ins/v2/events/$eventId/event_labels/$eventLabelId/event/[id]
getSingleFromEventAndPersonEvent(String eventId, String personEventId, String id, {PcoCheckInsEventQuery? query, bool includeAllRelated = false, bool includeAttendanceTypes = false, bool includeEventPeriods = false}) → Future<PcoCheckInsEvent?>: Will get a single PcoCheckInsEvent object using a path like this: /check-ins/v2/events/$eventId/person_events/$personEventId/event/[id]
getSingleFromEventTime(String eventTimeId, String id, {PcoCheckInsEventQuery? query, bool includeAllRelated = false, bool includeAttendanceTypes = false, bool includeEventPeriods = false}) → Future<PcoCheckInsEvent?>: Will get a single PcoCheckInsEvent object using a path like this: /check-ins/v2/event_times/$eventTimeId/event/[id]
getSingleFromStation(String stationId, String id, {PcoCheckInsEventQuery? query, bool includeAllRelated = false, bool includeAttendanceTypes = false, bool includeEventPeriods = false}) → Future<PcoCheckInsEvent?>: Will get a single PcoCheckInsEvent object using a path like this: /check-ins/v2/stations/$stationId/event/[id]

Constants

kApiVersion → const String
kAppSource → const String
kArchivedAt → const String
kCreatedAt → const String
kCreatePathTemplate → const String
kDefaultPathTemplate → const String
kEnableServicesIntegration → const String
kFrequency → const String
kId → const String
kIntegrationKey → const String
kLocationTimesEnabled → const String
kName → const String
kPcoApplication → const String
kPreSelectEnabled → const String
kTypeId → const String
kTypeString → const String
kUpdatedAt → const String