PcoCalendarEvent class

This class represents a PCO Calendar Event Object

Instantiation

  • This object cannot be created through the API.
  • Instantiate from existing JSON data using the PcoCalendarEvent.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

An event.

May contain information such as who owns the event, visibility on Church Center and a public-facing summary.

Attributes (and permissions)

  • id (ro) -> PCO: id
  • approvalStatus (ro) -> PCO: approval_status
  • createdAt (ro) -> PCO: created_at
  • description (ro) -> PCO: description
  • imageUrl (ro) -> PCO: image_url
  • name (ro) -> PCO: name
  • percentApproved (ro) -> PCO: percent_approved
  • percentRejected (ro) -> PCO: percent_rejected
  • registrationUrl (ro) -> PCO: registration_url
  • summary (ro) -> PCO: summary
  • updatedAt (ro) -> PCO: updated_at
  • isVisibleInChurchCenter (ro) -> PCO: visible_in_church_center

Edges and Actions

Outbound Edges:

Inbound Edges:

Actions: NONE

Raw Data Object Example

{
  "type": "Event",
  "id": "1",
  "attributes": {
    "approval_status": "string",
    "created_at": "2000-01-01T12:00:00Z",
    "description": "string",
    "image_url": "string",
    "name": "string",
    "percent_approved": 1,
    "percent_rejected": 1,
    "registration_url": "string",
    "summary": "string",
    "updated_at": "2000-01-01T12:00:00Z",
    "visible_in_church_center": true
  },
  "relationships": {
    "owner": {
      "data": {
        "type": "Person",
        "id": "1"
      }
    }
  }
}
Inheritance

Constructors

PcoCalendarEvent({String? id, String? approvalStatus, DateTime? createdAt, String? description, String? imageUrl, String? name, int? percentApproved, int? percentRejected, String? registrationUrl, String? summary, DateTime? updatedAt, bool? isVisibleInChurchCenter, Map<String, List<PcoResource>>? withRelationships, List<PcoResource>? withIncluded})
Create a new PcoCalendarEvent object. This object cannot be created with the API
factory
PcoCalendarEvent.empty()
Create an empty instance of this class. This is only useful when an endpoint requires related or included data.
PcoCalendarEvent.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
approvalStatus → String
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
description → String
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
imageUrl → String
no setter
included → List<PcoResource>
contains included items parsed into objects
no setterinherited
includedAttachments → List<PcoCalendarAttachment>
no setter
includedTags → List<PcoCalendarTag>
no setter
isVisibleInChurchCenter → bool
no setter
contains the links data returned by the api if present
no setterinherited
name → String
no setter
needsSave → bool
no setterinherited
pcoApplication ↔ String
latefinalinherited
percentApproved → int
no setter
percentRejected → int
no setter
registrationUrl → 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
summary → String
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<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
getAttachments({PcoCalendarAttachmentQuery? query}) → Future<PcoCollection<PcoCalendarAttachment>>
Will get a collection of PcoCalendarAttachment objects (expecting many) using a path like this: https://api.planningcenteronline.com/calendar/v2/events/1/attachments
getConflicts({PcoCalendarConflictQuery? query}) → Future<PcoCollection<PcoCalendarConflict>>
Will get a collection of PcoCalendarConflict objects (expecting many) using a path like this: https://api.planningcenteronline.com/calendar/v2/events/1/conflicts
getEventInstances({PcoCalendarEventInstanceQuery? query}) → Future<PcoCollection<PcoCalendarEventInstance>>
Will get a collection of PcoCalendarEventInstance objects (expecting many) using a path like this: https://api.planningcenteronline.com/calendar/v2/events/1/event_instances
getEventResourceRequests({PcoCalendarEventResourceRequestQuery? query}) → Future<PcoCollection<PcoCalendarEventResourceRequest>>
Will get a collection of PcoCalendarEventResourceRequest objects (expecting many) using a path like this: https://api.planningcenteronline.com/calendar/v2/events/1/event_resource_requests
getFeed({PcoCalendarFeedQuery? query}) → Future<PcoCollection<PcoCalendarFeed>>
Will get a collection of PcoCalendarFeed objects (expecting many) using a path like this: https://api.planningcenteronline.com/calendar/v2/events/1/feed
getOwner({PcoCalendarPersonQuery? query}) → Future<PcoCollection<PcoCalendarPerson>>
Will get a collection of PcoCalendarPerson objects (expecting one) using a path like this: https://api.planningcenteronline.com/calendar/v2/events/1/owner
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/events/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/events/1/tags
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
includedOwner<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

get({String? id, PcoCalendarEventQuery? query, bool getAll = false, bool includeAllRelated = false, bool includeAttachments = false, bool includeOwner = false, bool includeTags = false}) → Future<PcoCollection<PcoCalendarEvent>>
Will get a PcoCollection of PcoCalendarEvent objects (expecting many) using a path like this: /calendar/v2/events
getAll({String? id, PcoCalendarEventQuery? query, bool includeAllRelated = false, bool includeAttachments = false, bool includeOwner = false, bool includeTags = false}) → Future<PcoCollection<PcoCalendarEvent>>
Will get a PcoCollection containing ALL PcoCalendarEvent objects (expecting many) using a path like this: /calendar/v2/events
getAllFromTag(String tagId, {String? id, PcoCalendarEventQuery? query, bool includeAllRelated = false, bool includeAttachments = false, bool includeOwner = false, bool includeTags = false}) → Future<PcoCollection<PcoCalendarEvent>>
Will get a PcoCollection containing ALL PcoCalendarEvent objects (expecting many) using a path like this: /calendar/v2/tags/$tagId/events
getAllFromTagGroup(String tagGroupId, {String? id, PcoCalendarEventQuery? query, bool includeAllRelated = false, bool includeAttachments = false, bool includeOwner = false, bool includeTags = false}) → Future<PcoCollection<PcoCalendarEvent>>
Will get a PcoCollection containing ALL PcoCalendarEvent objects (expecting many) using a path like this: /calendar/v2/tag_groups/$tagGroupId/events
getFromAttachment(String attachmentId, {PcoCalendarEventQuery? query, bool getAll = false, bool includeAllRelated = false, bool includeAttachments = false, bool includeOwner = false, bool includeTags = false}) → Future<PcoCollection<PcoCalendarEvent>>
Will get a PcoCollection of PcoCalendarEvent objects (expecting one) using a path like this: /calendar/v2/attachments/$attachmentId/event
getFromEventInstance(String eventInstanceId, {PcoCalendarEventQuery? query, bool getAll = false, bool includeAllRelated = false, bool includeAttachments = false, bool includeOwner = false, bool includeTags = false}) → Future<PcoCollection<PcoCalendarEvent>>
Will get a PcoCollection of PcoCalendarEvent objects (expecting one) using a path like this: /calendar/v2/event_instances/$eventInstanceId/event
getFromEventInstanceAndEventTime(String eventInstanceId, String eventTimeId, {PcoCalendarEventQuery? query, bool getAll = false, bool includeAllRelated = false, bool includeAttachments = false, bool includeOwner = false, bool includeTags = false}) → Future<PcoCollection<PcoCalendarEvent>>
Will get a PcoCollection of PcoCalendarEvent objects (expecting one) using a path like this: /calendar/v2/event_instances/$eventInstanceId/event_times/$eventTimeId/event
getFromEventResourceRequest(String eventResourceRequestId, {PcoCalendarEventQuery? query, bool getAll = false, bool includeAllRelated = false, bool includeAttachments = false, bool includeOwner = false, bool includeTags = false}) → Future<PcoCollection<PcoCalendarEvent>>
Will get a PcoCollection of PcoCalendarEvent objects (expecting one) using a path like this: /calendar/v2/event_resource_requests/$eventResourceRequestId/event
getFromTag(String tagId, {String? id, PcoCalendarEventQuery? query, bool getAll = false, bool includeAllRelated = false, bool includeAttachments = false, bool includeOwner = false, bool includeTags = false}) → Future<PcoCollection<PcoCalendarEvent>>
Will get a PcoCollection of PcoCalendarEvent objects (expecting many) using a path like this: /calendar/v2/tags/$tagId/events
getFromTagGroup(String tagGroupId, {String? id, PcoCalendarEventQuery? query, bool getAll = false, bool includeAllRelated = false, bool includeAttachments = false, bool includeOwner = false, bool includeTags = false}) → Future<PcoCollection<PcoCalendarEvent>>
Will get a PcoCollection of PcoCalendarEvent objects (expecting many) using a path like this: /calendar/v2/tag_groups/$tagGroupId/events
getSingle(String id, {PcoCalendarEventQuery? query, bool includeAllRelated = false, bool includeAttachments = false, bool includeOwner = false, bool includeTags = false}) → Future<PcoCalendarEvent?>
Will get a single PcoCalendarEvent object using a path like this: /calendar/v2/events/[id]
getSingleFromTag(String tagId, String id, {PcoCalendarEventQuery? query, bool includeAllRelated = false, bool includeAttachments = false, bool includeOwner = false, bool includeTags = false}) → Future<PcoCalendarEvent?>
Will get a single PcoCalendarEvent object using a path like this: /calendar/v2/tags/$tagId/events/[id]
getSingleFromTagGroup(String tagGroupId, String id, {PcoCalendarEventQuery? query, bool includeAllRelated = false, bool includeAttachments = false, bool includeOwner = false, bool includeTags = false}) → Future<PcoCalendarEvent?>
Will get a single PcoCalendarEvent object using a path like this: /calendar/v2/tag_groups/$tagGroupId/events/[id]
getWinnerFromConflict(String conflictId, {PcoCalendarEventQuery? query, bool getAll = false, bool includeAllRelated = false, bool includeAttachments = false, bool includeOwner = false, bool includeTags = false}) → Future<PcoCollection<PcoCalendarEvent>>
Will get a PcoCollection of PcoCalendarEvent objects (expecting one) using a path like this: /calendar/v2/conflicts/$conflictId/winner

Constants

kApiVersion → const String
kApprovalStatus → const String
kCreatedAt → const String
kCreatePathTemplate → const String
kDefaultPathTemplate → const String
kDescription → const String
kId → const String
kImageUrl → const String
kName → const String
kPcoApplication → const String
kPercentApproved → const String
kPercentRejected → const String
kRegistrationUrl → const String
kSummary → const String
kTypeId → const String
kTypeString → const String
kUpdatedAt → const String
kVisibleInChurchCenter → const String