PcoGroupsEvent class
This class represents a PCO Groups Event Object
- Application: groups
- Id: event
- Type: Event
- ApiVersion: 2018-08-01
- Is Deprecated: false
- Is Collection Only: false
- Default Endpoint: https://api.planningcenteronline.com/groups/v2/events
- Create Endpoint: NONE
Instantiation
- This object cannot be created through the API.
- Instantiate from existing
JSON
data using thePcoGroupsEvent.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
Attributes (and permissions)
id
(ro) -> PCO:id
isAttendanceRequestsEnabled
(ro) -> PCO:attendance_requests_enabled
isAutomatedReminderEnabled
(ro) -> PCO:automated_reminder_enabled
isCanceled
(ro) -> PCO:canceled
canceledAt
(ro) -> PCO:canceled_at
description
(ro) -> PCO:description
endsAt
(ro) -> PCO:ends_at
locationTypePreference
(ro) -> PCO:location_type_preference
isMultiDay
(ro) -> PCO:multi_day
name
(ro) -> PCO:name
isRemindersSent
(ro) -> PCO:reminders_sent
remindersSentAt
(ro) -> PCO:reminders_sent_at
isRepeating
(ro) -> PCO:repeating
startsAt
(ro) -> PCO:starts_at
virtualLocationUrl
(ro) -> PCO:virtual_location_url
visitorsCount
(ro) -> PCO:visitors_count
Edges and Actions
Outbound Edges:
attendance-event-attendances
: https://api.planningcenteronline.com/groups/v2/events/1/attendancesgroup-event-group
: https://api.planningcenteronline.com/groups/v2/events/1/grouplocation-event-location
: https://api.planningcenteronline.com/groups/v2/events/1/locationeventnote-event-notes
: https://api.planningcenteronline.com/groups/v2/events/1/notes
Inbound Edges:
event-group-events
: https://api.planningcenteronline.com/groups/v2/groups/1/eventsevent-grouptype-events
: https://api.planningcenteronline.com/groups/v2/group_types/1/eventsevent-organization-events
: https://api.planningcenteronline.com/groups/v2/eventsevent-person-events
: https://api.planningcenteronline.com/groups/v2/people/1/events
Actions: NONE
Raw Data Object Example
{
"type": "Event",
"id": "1",
"attributes": {
"attendance_requests_enabled": true,
"automated_reminder_enabled": true,
"canceled": true,
"canceled_at": "2000-01-01T12:00:00Z",
"description": "string",
"ends_at": "2000-01-01T12:00:00Z",
"location_type_preference": "string",
"multi_day": true,
"name": "string",
"reminders_sent": true,
"reminders_sent_at": "2000-01-01T12:00:00Z",
"repeating": true,
"starts_at": "2000-01-01T12:00:00Z",
"virtual_location_url": "string",
"visitors_count": 1
},
"relationships": {
"attendance_submitter": {
"data": {
"type": "Person",
"id": "1"
}
},
"group": {
"data": {
"type": "Group",
"id": "1"
}
},
"location": {
"data": {
"type": "Location",
"id": "1"
}
},
"repeating_event": {
"data": {
"type": "RepeatingEvent",
"id": "1"
}
}
}
}
- Inheritance
-
- Object
- PcoResource
- PcoGroupsEvent
Constructors
-
PcoGroupsEvent({String? id, bool? isAttendanceRequestsEnabled, bool? isAutomatedReminderEnabled, bool? isCanceled, DateTime? canceledAt, String? description, DateTime? endsAt, String? locationTypePreference, bool? isMultiDay, String? name, bool? isRemindersSent, DateTime? remindersSentAt, bool? isRepeating, DateTime? startsAt, String? virtualLocationUrl, int? visitorsCount, Map<
String, List< ? withRelationships, List<PcoResource> >PcoResource> ? withIncluded}) -
Create a new PcoGroupsEvent object. This object cannot be created with the API
factory
- PcoGroupsEvent.empty()
- Create an empty instance of this class. This is only useful when an endpoint requires related or included data.
-
PcoGroupsEvent.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
- canceledAt → DateTime
-
no setter
- 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
- description → String
-
no setter
- 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
- includedGroup → PcoGroupsGroup?
-
no setter
- includedLocation → PcoGroupsLocation?
-
no setter
- isAttendanceRequestsEnabled → bool
-
no setter
- isAutomatedReminderEnabled → bool
-
no setter
- isCanceled → bool
-
no setter
- isMultiDay → bool
-
no setter
- isRemindersSent → bool
-
no setter
- isRepeating → bool
-
no setter
-
links
→ ReadOnlyMapView<
String, dynamic> -
contains the links data returned by the api if present
no setterinherited
- locationTypePreference → String
-
no setter
- 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
- remindersSentAt → DateTime
-
no setter
- 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
- virtualLocationUrl → String
-
no setter
- visitorsCount → 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< ? 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 -
getAttendances(
{PcoGroupsAttendanceQuery? query}) → Future< PcoCollection< PcoGroupsAttendance> > -
Will get a collection of PcoGroupsAttendance objects (expecting many)
using a path like this:
https://api.planningcenteronline.com/groups/v2/events/1/attendances
-
getGroup(
{PcoGroupsGroupQuery? query}) → Future< PcoCollection< PcoGroupsGroup> > -
Will get a collection of PcoGroupsGroup objects (expecting one)
using a path like this:
https://api.planningcenteronline.com/groups/v2/events/1/group
-
getLocation(
{PcoGroupsLocationQuery? query}) → Future< PcoCollection< PcoGroupsLocation> > -
Will get a collection of PcoGroupsLocation objects (expecting one)
using a path like this:
https://api.planningcenteronline.com/groups/v2/events/1/location
-
getNotes(
{PcoGroupsEventNoteQuery? query}) → Future< PcoCollection< PcoGroupsEventNote> > -
Will get a collection of PcoGroupsEventNote objects (expecting many)
using a path like this:
https://api.planningcenteronline.com/groups/v2/events/1/notes
-
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, PcoGroupsEventQuery? query, bool getAll = false, bool includeAllRelated = false, bool includeGroup = false, bool includeLocation = false}) → Future< PcoCollection< PcoGroupsEvent> > -
Will get a
PcoCollection
of PcoGroupsEvent objects (expecting many) using a path like this:/groups/v2/events
-
getAll(
{String? id, PcoGroupsEventQuery? query, bool includeAllRelated = false, bool includeGroup = false, bool includeLocation = false}) → Future< PcoCollection< PcoGroupsEvent> > -
Will get a
PcoCollection
containing ALL PcoGroupsEvent objects (expecting many) using a path like this:/groups/v2/events
-
getAllFromGroup(
String groupId, {String? id, PcoGroupsEventQuery? query, bool includeAllRelated = false, bool includeGroup = false, bool includeLocation = false}) → Future< PcoCollection< PcoGroupsEvent> > -
Will get a
PcoCollection
containing ALL PcoGroupsEvent objects (expecting many) using a path like this:/groups/v2/groups/$groupId/events
-
getAllFromGroupType(
String groupTypeId, {String? id, PcoGroupsEventQuery? query, bool includeAllRelated = false, bool includeGroup = false, bool includeLocation = false}) → Future< PcoCollection< PcoGroupsEvent> > -
Will get a
PcoCollection
containing ALL PcoGroupsEvent objects (expecting many) using a path like this:/groups/v2/group_types/$groupTypeId/events
-
getAllFromPerson(
String personId, {String? id, PcoGroupsEventQuery? query, bool includeAllRelated = false, bool includeGroup = false, bool includeLocation = false}) → Future< PcoCollection< PcoGroupsEvent> > -
Will get a
PcoCollection
containing ALL PcoGroupsEvent objects (expecting many) using a path like this:/groups/v2/people/$personId/events
-
getFromGroup(
String groupId, {String? id, PcoGroupsEventQuery? query, bool getAll = false, bool includeAllRelated = false, bool includeGroup = false, bool includeLocation = false}) → Future< PcoCollection< PcoGroupsEvent> > -
Will get a
PcoCollection
of PcoGroupsEvent objects (expecting many) using a path like this:/groups/v2/groups/$groupId/events
-
getFromGroupType(
String groupTypeId, {String? id, PcoGroupsEventQuery? query, bool getAll = false, bool includeAllRelated = false, bool includeGroup = false, bool includeLocation = false}) → Future< PcoCollection< PcoGroupsEvent> > -
Will get a
PcoCollection
of PcoGroupsEvent objects (expecting many) using a path like this:/groups/v2/group_types/$groupTypeId/events
-
getFromPerson(
String personId, {String? id, PcoGroupsEventQuery? query, bool getAll = false, bool includeAllRelated = false, bool includeGroup = false, bool includeLocation = false}) → Future< PcoCollection< PcoGroupsEvent> > -
Will get a
PcoCollection
of PcoGroupsEvent objects (expecting many) using a path like this:/groups/v2/people/$personId/events
-
getSingle(
String id, {PcoGroupsEventQuery? query, bool includeAllRelated = false, bool includeGroup = false, bool includeLocation = false}) → Future< PcoGroupsEvent?> -
Will get a single
PcoGroupsEvent
object using a path like this:/groups/v2/events/[id]
-
getSingleFromGroup(
String groupId, String id, {PcoGroupsEventQuery? query, bool includeAllRelated = false, bool includeGroup = false, bool includeLocation = false}) → Future< PcoGroupsEvent?> -
Will get a single
PcoGroupsEvent
object using a path like this:/groups/v2/groups/$groupId/events/[id]
-
getSingleFromGroupType(
String groupTypeId, String id, {PcoGroupsEventQuery? query, bool includeAllRelated = false, bool includeGroup = false, bool includeLocation = false}) → Future< PcoGroupsEvent?> -
Will get a single
PcoGroupsEvent
object using a path like this:/groups/v2/group_types/$groupTypeId/events/[id]
-
getSingleFromPerson(
String personId, String id, {PcoGroupsEventQuery? query, bool includeAllRelated = false, bool includeGroup = false, bool includeLocation = false}) → Future< PcoGroupsEvent?> -
Will get a single
PcoGroupsEvent
object using a path like this:/groups/v2/people/$personId/events/[id]
Constants
- kApiVersion → const String
- kAttendanceRequestsEnabled → const String
- kAutomatedReminderEnabled → const String
- kCanceled → const String
- kCanceledAt → const String
- kCreatePathTemplate → const String
- kDefaultPathTemplate → const String
- kDescription → const String
- kEndsAt → const String
- kId → const String
- kLocationTypePreference → const String
- kMultiDay → const String
- kName → const String
- kPcoApplication → const String
- kRemindersSent → const String
- kRemindersSentAt → const String
- kRepeating → const String
- kStartsAt → const String
- kTypeId → const String
- kTypeString → const String
- kVirtualLocationUrl → const String
- kVisitorsCount → const String