PcoCheckInsEventTime class

This class represents a PCO CheckIns EventTime Object

Instantiation

  • This object cannot be created through the API.
  • Instantiate from existing JSON data using the PcoCheckInsEventTime.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 time that someone may check in. Times are copied from session to session.

Attributes (and permissions)

  • id (ro) -> PCO: id
  • totalCount (ro) -> PCO: total_count
  • startsAt (ro) -> PCO: starts_at
  • showsAt (ro) -> PCO: shows_at
  • hidesAt (ro) -> PCO: hides_at
  • regularCount (ro) -> PCO: regular_count
  • guestCount (ro) -> PCO: guest_count
  • volunteerCount (ro) -> PCO: volunteer_count
  • createdAt (ro) -> PCO: created_at
  • updatedAt (ro) -> PCO: updated_at
  • name (ro) -> PCO: name
  • hour (ro) -> PCO: hour
  • minute (ro) -> PCO: minute
  • dayOfWeek (ro) -> PCO: day_of_week

Edges and Actions

Outbound Edges:

Inbound Edges:

Actions: NONE

Raw Data Object Example

{
  "type": "EventTime",
  "id": "1",
  "attributes": {
    "total_count": 1,
    "starts_at": "2000-01-01T12:00:00Z",
    "shows_at": "2000-01-01T12:00:00Z",
    "hides_at": "2000-01-01T12:00:00Z",
    "regular_count": 1,
    "guest_count": 1,
    "volunteer_count": 1,
    "created_at": "2000-01-01T12:00:00Z",
    "updated_at": "2000-01-01T12:00:00Z",
    "name": "string",
    "hour": 1,
    "minute": 1,
    "day_of_week": 1
  },
  "relationships": {
    "event": {
      "data": {
        "type": "Event",
        "id": "1"
      }
    },
    "event_period": {
      "data": {
        "type": "EventPeriod",
        "id": "1"
      }
    }
  }
}
Inheritance

Constructors

PcoCheckInsEventTime({String? id, int? totalCount, DateTime? startsAt, DateTime? showsAt, DateTime? hidesAt, int? regularCount, int? guestCount, int? volunteerCount, DateTime? createdAt, DateTime? updatedAt, String? name, int? hour, int? minute, int? dayOfWeek, Map<String, List<PcoResource>>? withRelationships, List<PcoResource>? withIncluded})
Create a new PcoCheckInsEventTime object. This object cannot be created with the API
factory
PcoCheckInsEventTime.empty()
Create an empty instance of this class. This is only useful when an endpoint requires related or included data.
PcoCheckInsEventTime.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
dayOfWeek → int
no setter
defaultPathTemplate → String
no setteroverride
fetched ↔ bool
indicate whether an item is full or partial
getter/setter pairinherited
guestCount → int
no setter
hashCode → int
The hash code for this object.
no setterinherited
hidesAt → DateTime
no setter
hour → int
no setter
id → String?
no setterinherited
included → List<PcoResource>
contains included items parsed into objects
no setterinherited
includedEvent → PcoCheckInsEvent?
no setter
includedEventPeriod → PcoCheckInsEventPeriod?
no setter
includedHeadcounts → List<PcoCheckInsHeadcount>
no setter
contains the links data returned by the api if present
no setterinherited
minute → int
no setter
name → String
no setter
needsSave → bool
no setterinherited
pcoApplication ↔ String
latefinalinherited
regularCount → int
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
showsAt → DateTime
no setter
slug → String
no setterinherited
startsAt → DateTime
no setter
totalCount → int
no setter
updateAllowed → List<String>
no setteroverride
updatedAt → DateTime
no setterinherited
volunteerCount → int
no setter

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
getAvailableLocations({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/event_times/1/available_locations
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/event_times/1/check_ins
getEvent({PcoCheckInsEventQuery? query}) → Future<PcoCollection<PcoCheckInsEvent>>
Will get a collection of PcoCheckInsEvent objects (expecting one) using a path like this: https://api.planningcenteronline.com/check-ins/v2/event_times/1/event
getEventPeriod({PcoCheckInsEventPeriodQuery? query}) → Future<PcoCollection<PcoCheckInsEventPeriod>>
Will get a collection of PcoCheckInsEventPeriod objects (expecting one) using a path like this: https://api.planningcenteronline.com/check-ins/v2/event_times/1/event_period
getHeadcounts({PcoCheckInsHeadcountQuery? query}) → Future<PcoCollection<PcoCheckInsHeadcount>>
Will get a collection of PcoCheckInsHeadcount objects (expecting many) using a path like this: https://api.planningcenteronline.com/check-ins/v2/event_times/1/headcounts
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/event_times/1/location_event_times
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, PcoCheckInsEventTimeQuery? query, bool getAll = false, bool includeAllRelated = false, bool includeEvent = false, bool includeEventPeriod = false, bool includeHeadcounts = false}) → Future<PcoCollection<PcoCheckInsEventTime>>
Will get a PcoCollection of PcoCheckInsEventTime objects (expecting many) using a path like this: /check-ins/v2/event_times
getAll({String? id, PcoCheckInsEventTimeQuery? query, bool includeAllRelated = false, bool includeEvent = false, bool includeEventPeriod = false, bool includeHeadcounts = false}) → Future<PcoCollection<PcoCheckInsEventTime>>
Will get a PcoCollection containing ALL PcoCheckInsEventTime objects (expecting many) using a path like this: /check-ins/v2/event_times
getAllFromCheckIn(String checkInId, {String? id, PcoCheckInsEventTimeQuery? query, bool includeAllRelated = false, bool includeEvent = false, bool includeEventPeriod = false, bool includeHeadcounts = false}) → Future<PcoCollection<PcoCheckInsEventTime>>
Will get a PcoCollection containing ALL PcoCheckInsEventTime objects (expecting many) using a path like this: /check-ins/v2/check_ins/$checkInId/event_times
getAllFromCheckInAndEventPeriod(String checkInId, String eventPeriodId, {String? id, PcoCheckInsEventTimeQuery? query, bool includeAllRelated = false, bool includeEvent = false, bool includeEventPeriod = false, bool includeHeadcounts = false}) → Future<PcoCollection<PcoCheckInsEventTime>>
Will get a PcoCollection containing ALL PcoCheckInsEventTime objects (expecting many) using a path like this: /check-ins/v2/check_ins/$checkInId/event_period/$eventPeriodId/event_times
getCurrentEventTimesFromEvent(String eventId, {PcoCheckInsEventTimeQuery? query, bool getAll = false, bool includeAllRelated = false, bool includeEvent = false, bool includeEventPeriod = false, bool includeHeadcounts = false}) → Future<PcoCollection<PcoCheckInsEventTime>>
Will get a PcoCollection of PcoCheckInsEventTime objects (expecting one) using a path like this: /check-ins/v2/events/$eventId/current_event_times
getFromCheckIn(String checkInId, {String? id, PcoCheckInsEventTimeQuery? query, bool getAll = false, bool includeAllRelated = false, bool includeEvent = false, bool includeEventPeriod = false, bool includeHeadcounts = false}) → Future<PcoCollection<PcoCheckInsEventTime>>
Will get a PcoCollection of PcoCheckInsEventTime objects (expecting many) using a path like this: /check-ins/v2/check_ins/$checkInId/event_times
getFromCheckInAndEventPeriod(String checkInId, String eventPeriodId, {String? id, PcoCheckInsEventTimeQuery? query, bool getAll = false, bool includeAllRelated = false, bool includeEvent = false, bool includeEventPeriod = false, bool includeHeadcounts = false}) → Future<PcoCollection<PcoCheckInsEventTime>>
Will get a PcoCollection of PcoCheckInsEventTime objects (expecting many) using a path like this: /check-ins/v2/check_ins/$checkInId/event_period/$eventPeriodId/event_times
getFromEventTimeAndLocationEventTime(String eventTimeId, String locationEventTimeId, {PcoCheckInsEventTimeQuery? query, bool getAll = false, bool includeAllRelated = false, bool includeEvent = false, bool includeEventPeriod = false, bool includeHeadcounts = false}) → Future<PcoCollection<PcoCheckInsEventTime>>
Will get a PcoCollection of PcoCheckInsEventTime objects (expecting one) using a path like this: /check-ins/v2/event_times/$eventTimeId/location_event_times/$locationEventTimeId/event_time
getFromHeadcount(String headcountId, {PcoCheckInsEventTimeQuery? query, bool getAll = false, bool includeAllRelated = false, bool includeEvent = false, bool includeEventPeriod = false, bool includeHeadcounts = false}) → Future<PcoCollection<PcoCheckInsEventTime>>
Will get a PcoCollection of PcoCheckInsEventTime objects (expecting one) using a path like this: /check-ins/v2/headcounts/$headcountId/event_time
getSingle(String id, {PcoCheckInsEventTimeQuery? query, bool includeAllRelated = false, bool includeEvent = false, bool includeEventPeriod = false, bool includeHeadcounts = false}) → Future<PcoCheckInsEventTime?>
Will get a single PcoCheckInsEventTime object using a path like this: /check-ins/v2/event_times/[id]
getSingleFromCheckIn(String checkInId, String id, {PcoCheckInsEventTimeQuery? query, bool includeAllRelated = false, bool includeEvent = false, bool includeEventPeriod = false, bool includeHeadcounts = false}) → Future<PcoCheckInsEventTime?>
Will get a single PcoCheckInsEventTime object using a path like this: /check-ins/v2/check_ins/$checkInId/event_times/[id]
getSingleFromCheckInAndEventPeriod(String checkInId, String eventPeriodId, String id, {PcoCheckInsEventTimeQuery? query, bool includeAllRelated = false, bool includeEvent = false, bool includeEventPeriod = false, bool includeHeadcounts = false}) → Future<PcoCheckInsEventTime?>
Will get a single PcoCheckInsEventTime object using a path like this: /check-ins/v2/check_ins/$checkInId/event_period/$eventPeriodId/event_times/[id]

Constants

kApiVersion → const String
kCreatedAt → const String
kCreatePathTemplate → const String
kDayOfWeek → const String
kDefaultPathTemplate → const String
kGuestCount → const String
kHidesAt → const String
kHour → const String
kId → const String
kMinute → const String
kName → const String
kPcoApplication → const String
kRegularCount → const String
kShowsAt → const String
kStartsAt → const String
kTotalCount → const String
kTypeId → const String
kTypeString → const String
kUpdatedAt → const String
kVolunteerCount → const String