PcoCalendarEventInstance class
This class represents a PCO Calendar EventInstance Object
- Application: calendar
- Id: event_instance
- Type: EventInstance
- ApiVersion: 2021-07-20
- Is Deprecated: false
- Is Collection Only: false
- Default Endpoint: https://api.planningcenteronline.com/calendar/v2/event_instances
- Create Endpoint: NONE
Instantiation
- This object cannot be created through the API.
- Instantiate from existing
JSON
data using thePcoCalendarEventInstance.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-onlyattributes
map. - Additional data is available through the read-only
links
andrelationships
maps. - Available relationships / includes are exposed through typed getters.
Description
A specific occurrence of an event.
If the event is recurring, recurrence
will be set and
recurrence_description
will provide an overview of the recurrence pattern.
Attributes (and permissions)
id
(ro) -> PCO:id
isAllDayEvent
(ro) -> PCO:all_day_event
createdAt
(ro) -> PCO:created_at
endsAt
(ro) -> PCO:ends_at
location
(ro) -> PCO:location
recurrence
(ro) -> PCO:recurrence
recurrenceDescription
(ro) -> PCO:recurrence_description
startsAt
(ro) -> PCO:starts_at
updatedAt
(ro) -> PCO:updated_at
churchCenterUrl
(ro) -> PCO:church_center_url
Edges and Actions
Outbound Edges:
event-eventinstance-event
: https://api.planningcenteronline.com/calendar/v2/event_instances/1/eventeventtime-eventinstance-event_times
: https://api.planningcenteronline.com/calendar/v2/event_instances/1/event_timesresourcebooking-eventinstance-resource_bookings
: https://api.planningcenteronline.com/calendar/v2/event_instances/1/resource_bookingstag-eventinstance-tags
: https://api.planningcenteronline.com/calendar/v2/event_instances/1/tags
Inbound Edges:
eventinstance-event-event_instances
: https://api.planningcenteronline.com/calendar/v2/events/1/event_instanceseventinstance-organization-event_instances
: https://api.planningcenteronline.com/calendar/v2/event_instanceseventinstance-resourcebooking-event_instance
: https://api.planningcenteronline.com/calendar/v2/resource_bookings/1/event_instanceeventinstance-tag-event_instances
: https://api.planningcenteronline.com/calendar/v2/tags/1/event_instances
Actions: NONE
Raw Data Object Example
{
"type": "EventInstance",
"id": "1",
"attributes": {
"all_day_event": true,
"created_at": "2000-01-01T12:00:00Z",
"ends_at": "2000-01-01T12:00:00Z",
"location": "string",
"recurrence": "string",
"recurrence_description": "string",
"starts_at": "2000-01-01T12:00:00Z",
"updated_at": "2000-01-01T12:00:00Z",
"church_center_url": "string"
},
"relationships": {
"event": {
"data": {
"type": "Event",
"id": "1"
}
}
}
}
- Inheritance
-
- Object
- PcoResource
- PcoCalendarEventInstance
Constructors
-
PcoCalendarEventInstance({String? id, bool? isAllDayEvent, DateTime? createdAt, DateTime? endsAt, String? location, String? recurrence, String? recurrenceDescription, DateTime? startsAt, DateTime? updatedAt, String? churchCenterUrl, Map<
String, List< ? withRelationships, List<PcoResource> >PcoResource> ? withIncluded}) -
Create a new PcoCalendarEventInstance object. This object cannot be created with the API
factory
- PcoCalendarEventInstance.empty()
- Create an empty instance of this class. This is only useful when an endpoint requires related or included data.
-
PcoCalendarEventInstance.fromJson(Map<
String, dynamic> data, {List<Map< ? withIncluded})String, dynamic> >
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
- churchCenterUrl → String
-
no setter
-
createAllowed
→ List<
String> -
no setteroverride
- createdAt → DateTime
-
no setterinherited
- createPathTemplate → String
-
no setteroverride
- defaultPathTemplate → String
-
no setteroverride
- endsAt → DateTime
-
no setter
- fetched ↔ bool
-
indicate whether an item is full or partial
getter/setter pairinherited
- 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 → PcoCalendarEvent?
-
no setter
-
includedEventTimes
→ List<
PcoCalendarEventTime> -
no setter
-
includedResourceBookings
→ List<
PcoCalendarResourceBooking> -
no setter
-
includedTags
→ List<
PcoCalendarTag> -
no setter
- isAllDayEvent → bool
-
no setter
-
links
→ ReadOnlyMapView<
String, dynamic> -
contains the links data returned by the api if present
no setterinherited
- location → String
-
no setter
- needsSave → bool
-
no setterinherited
- pcoApplication ↔ String
-
latefinalinherited
- recurrence → String
-
no setter
- recurrenceDescription → 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
- startsAt → DateTime
-
no setter
-
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< ? withIncluded}) → dynamicString, dynamic> > -
Takes a full JSON:API Response Object (the contents of a "data" field)
will clear and update id, apiPath, attributes and
_relationships
inherited -
getEvent(
{PcoCalendarEventQuery? query}) → Future< PcoCollection< PcoCalendarEvent> > -
Will get a collection of PcoCalendarEvent objects (expecting one)
using a path like this:
https://api.planningcenteronline.com/calendar/v2/event_instances/1/event
-
getEventTimes(
{PcoCalendarEventTimeQuery? query}) → Future< PcoCollection< PcoCalendarEventTime> > -
Will get a collection of PcoCalendarEventTime objects (expecting many)
using a path like this:
https://api.planningcenteronline.com/calendar/v2/event_instances/1/event_times
-
getResourceBookings(
{PcoCalendarResourceBookingQuery? query}) → Future< PcoCollection< PcoCalendarResourceBooking> > -
Will get a collection of PcoCalendarResourceBooking objects (expecting many)
using a path like this:
https://api.planningcenteronline.com/calendar/v2/event_instances/1/resource_bookings
-
getTags(
{PcoCalendarTagQuery? query}) → Future< PcoCollection< PcoCalendarTag> > -
Will get a collection of PcoCalendarTag objects (expecting many)
using a path like this:
https://api.planningcenteronline.com/calendar/v2/event_instances/1/tags
-
handleIncludes(
List< Map< included) → voidString, dynamic> > -
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< included = const []]) → Map<String, dynamic> >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) operationsinherited -
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 ?where
key
=value or ?wheregt|lt
=valueno setter
Static Methods
-
get(
{String? id, PcoCalendarEventInstanceQuery? query, bool getAll = false, bool includeAllRelated = false, bool includeEvent = false, bool includeEventTimes = false, bool includeResourceBookings = false, bool includeTags = false}) → Future< PcoCollection< PcoCalendarEventInstance> > -
Will get a
PcoCollection
of PcoCalendarEventInstance objects (expecting many) using a path like this:/calendar/v2/event_instances
-
getAll(
{String? id, PcoCalendarEventInstanceQuery? query, bool includeAllRelated = false, bool includeEvent = false, bool includeEventTimes = false, bool includeResourceBookings = false, bool includeTags = false}) → Future< PcoCollection< PcoCalendarEventInstance> > -
Will get a
PcoCollection
containing ALL PcoCalendarEventInstance objects (expecting many) using a path like this:/calendar/v2/event_instances
-
getAllFromEvent(
String eventId, {String? id, PcoCalendarEventInstanceQuery? query, bool includeAllRelated = false, bool includeEvent = false, bool includeEventTimes = false, bool includeResourceBookings = false, bool includeTags = false}) → Future< PcoCollection< PcoCalendarEventInstance> > -
Will get a
PcoCollection
containing ALL PcoCalendarEventInstance objects (expecting many) using a path like this:/calendar/v2/events/$eventId/event_instances
-
getAllFromTag(
String tagId, {String? id, PcoCalendarEventInstanceQuery? query, bool includeAllRelated = false, bool includeEvent = false, bool includeEventTimes = false, bool includeResourceBookings = false, bool includeTags = false}) → Future< PcoCollection< PcoCalendarEventInstance> > -
Will get a
PcoCollection
containing ALL PcoCalendarEventInstance objects (expecting many) using a path like this:/calendar/v2/tags/$tagId/event_instances
-
getFromEvent(
String eventId, {String? id, PcoCalendarEventInstanceQuery? query, bool getAll = false, bool includeAllRelated = false, bool includeEvent = false, bool includeEventTimes = false, bool includeResourceBookings = false, bool includeTags = false}) → Future< PcoCollection< PcoCalendarEventInstance> > -
Will get a
PcoCollection
of PcoCalendarEventInstance objects (expecting many) using a path like this:/calendar/v2/events/$eventId/event_instances
-
getFromResourceBooking(
String resourceBookingId, {PcoCalendarEventInstanceQuery? query, bool getAll = false, bool includeAllRelated = false, bool includeEvent = false, bool includeEventTimes = false, bool includeResourceBookings = false, bool includeTags = false}) → Future< PcoCollection< PcoCalendarEventInstance> > -
Will get a
PcoCollection
of PcoCalendarEventInstance objects (expecting one) using a path like this:/calendar/v2/resource_bookings/$resourceBookingId/event_instance
-
getFromTag(
String tagId, {String? id, PcoCalendarEventInstanceQuery? query, bool getAll = false, bool includeAllRelated = false, bool includeEvent = false, bool includeEventTimes = false, bool includeResourceBookings = false, bool includeTags = false}) → Future< PcoCollection< PcoCalendarEventInstance> > -
Will get a
PcoCollection
of PcoCalendarEventInstance objects (expecting many) using a path like this:/calendar/v2/tags/$tagId/event_instances
-
getSingle(
String id, {PcoCalendarEventInstanceQuery? query, bool includeAllRelated = false, bool includeEvent = false, bool includeEventTimes = false, bool includeResourceBookings = false, bool includeTags = false}) → Future< PcoCalendarEventInstance?> -
Will get a single
PcoCalendarEventInstance
object using a path like this:/calendar/v2/event_instances/[id]
-
getSingleFromEvent(
String eventId, String id, {PcoCalendarEventInstanceQuery? query, bool includeAllRelated = false, bool includeEvent = false, bool includeEventTimes = false, bool includeResourceBookings = false, bool includeTags = false}) → Future< PcoCalendarEventInstance?> -
Will get a single
PcoCalendarEventInstance
object using a path like this:/calendar/v2/events/$eventId/event_instances/[id]
-
getSingleFromTag(
String tagId, String id, {PcoCalendarEventInstanceQuery? query, bool includeAllRelated = false, bool includeEvent = false, bool includeEventTimes = false, bool includeResourceBookings = false, bool includeTags = false}) → Future< PcoCalendarEventInstance?> -
Will get a single
PcoCalendarEventInstance
object using a path like this:/calendar/v2/tags/$tagId/event_instances/[id]
Constants
- kAllDayEvent → const String
- kApiVersion → const String
- kChurchCenterUrl → const String
- kCreatedAt → const String
- kCreatePathTemplate → const String
- kDefaultPathTemplate → const String
- kEndsAt → const String
- kId → const String
- kLocation → const String
- kPcoApplication → const String
- kRecurrence → const String
- kRecurrenceDescription → const String
- kStartsAt → const String
- kTypeId → const String
- kTypeString → const String
- kUpdatedAt → const String