PcoCalendarOrganization class
This class represents a PCO Calendar Organization Object
- Application: calendar
- Id: organization
- Type: Organization
- ApiVersion: 2021-07-20
- Is Deprecated: false
- Is Collection Only: false
- Default Endpoint: https://api.planningcenteronline.com/calendar/v2
- Create Endpoint: NONE
Instantiation
- This object cannot be created through the API.
- Instantiate from existing
JSON
data using thePcoCalendarOrganization.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
An administrative structure, usually representing a single church. Contains date/time formatting and time zone preferences.
Attributes (and permissions)
id
(ro) -> PCO:id
name
(ro) -> PCO:name
timeZone
(ro) -> PCO:time_zone
isTwentyFourHourTime
(ro) -> PCO:twenty_four_hour_time
dateFormat
(ro) -> PCO:date_format
isOnboarding
(ro) -> PCO:onboarding
Edges and Actions
Outbound Edges:
attachment-organization-attachments
: https://api.planningcenteronline.com/calendar/v2/attachmentsconflict-organization-conflicts
: https://api.planningcenteronline.com/calendar/v2/conflictseventinstance-organization-event_instances
: https://api.planningcenteronline.com/calendar/v2/event_instanceseventresourcerequest-organization-event_resource_requests
: https://api.planningcenteronline.com/calendar/v2/event_resource_requestsevent-organization-events
: https://api.planningcenteronline.com/calendar/v2/eventsfeed-organization-feeds
: https://api.planningcenteronline.com/calendar/v2/feedsperson-organization-people
: https://api.planningcenteronline.com/calendar/v2/peoplereporttemplate-organization-report_templates
: https://api.planningcenteronline.com/calendar/v2/report_templatesresourceapprovalgroup-organization-resource_approval_groups
: https://api.planningcenteronline.com/calendar/v2/resource_approval_groupsresourcebooking-organization-resource_bookings
: https://api.planningcenteronline.com/calendar/v2/resource_bookingsresourcefolder-organization-resource_folders
: https://api.planningcenteronline.com/calendar/v2/resource_foldersresourcequestion-organization-resource_questions
: https://api.planningcenteronline.com/calendar/v2/resource_questionsresource-organization-resources
: https://api.planningcenteronline.com/calendar/v2/resourcesroomsetup-organization-room_setups
: https://api.planningcenteronline.com/calendar/v2/room_setupstaggroup-organization-tag_groups
: https://api.planningcenteronline.com/calendar/v2/tag_groupstag-organization-tags
: https://api.planningcenteronline.com/calendar/v2/tags
Inbound Edges:
organization-person-organization
: https://api.planningcenteronline.com/calendar/v2/people/1/organization
Actions: NONE
Raw Data Object Example
{
"type": "Organization",
"id": "1",
"attributes": {
"name": "string",
"time_zone": "string",
"twenty_four_hour_time": true,
"date_format": "string"
},
"relationships": {}
}
- Inheritance
-
- Object
- PcoResource
- PcoCalendarOrganization
Constructors
-
PcoCalendarOrganization({String? id, String? name, String? timeZone, bool? isTwentyFourHourTime, String? dateFormat, bool? isOnboarding, Map<
String, List< ? withRelationships, List<PcoResource> >PcoResource> ? withIncluded}) -
Create a new PcoCalendarOrganization object. This object cannot be created with the API
factory
- PcoCalendarOrganization.empty()
- Create an empty instance of this class. This is only useful when an endpoint requires related or included data.
-
PcoCalendarOrganization.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
-
createAllowed
→ List<
String> -
no setteroverride
- createdAt → DateTime
-
no setterinherited
- createPathTemplate → String
-
no setteroverride
- dateFormat → String
-
no setter
- defaultPathTemplate → String
-
no setteroverride
- 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
- isOnboarding → bool
-
no setter
- isTwentyFourHourTime → 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
- timeZone → 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< ? 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 -
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/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/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/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/event_resource_requests
-
getEvents(
{PcoCalendarEventQuery? query}) → Future< PcoCollection< PcoCalendarEvent> > -
Will get a collection of PcoCalendarEvent objects (expecting many)
using a path like this:
https://api.planningcenteronline.com/calendar/v2/events
-
getFeeds(
{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/feeds
-
getPeople(
{PcoCalendarPersonQuery? query}) → Future< PcoCollection< PcoCalendarPerson> > -
Will get a collection of PcoCalendarPerson objects (expecting many)
using a path like this:
https://api.planningcenteronline.com/calendar/v2/people
-
getReportTemplates(
{PcoCalendarReportTemplateQuery? query}) → Future< PcoCollection< PcoCalendarReportTemplate> > -
Will get a collection of PcoCalendarReportTemplate objects (expecting many)
using a path like this:
https://api.planningcenteronline.com/calendar/v2/report_templates
-
getResourceApprovalGroups(
{PcoCalendarResourceApprovalGroupQuery? query}) → Future< PcoCollection< PcoCalendarResourceApprovalGroup> > -
Will get a collection of PcoCalendarResourceApprovalGroup objects (expecting many)
using a path like this:
https://api.planningcenteronline.com/calendar/v2/resource_approval_groups
-
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/resource_bookings
-
getResourceFolders(
{PcoCalendarResourceFolderQuery? query}) → Future< PcoCollection< PcoCalendarResourceFolder> > -
Will get a collection of PcoCalendarResourceFolder objects (expecting many)
using a path like this:
https://api.planningcenteronline.com/calendar/v2/resource_folders
-
getResourceQuestions(
{PcoCalendarResourceQuestionQuery? query}) → Future< PcoCollection< PcoCalendarResourceQuestion> > -
Will get a collection of PcoCalendarResourceQuestion objects (expecting many)
using a path like this:
https://api.planningcenteronline.com/calendar/v2/resource_questions
-
getResources(
{PcoCalendarResourceQuery? query}) → Future< PcoCollection< PcoCalendarResource> > -
Will get a collection of PcoCalendarResource objects (expecting many)
using a path like this:
https://api.planningcenteronline.com/calendar/v2/resources
-
getRoomSetups(
{PcoCalendarRoomSetupQuery? query}) → Future< PcoCollection< PcoCalendarRoomSetup> > -
Will get a collection of PcoCalendarRoomSetup objects (expecting many)
using a path like this:
https://api.planningcenteronline.com/calendar/v2/room_setups
-
getTagGroups(
{PcoCalendarTagGroupQuery? query}) → Future< PcoCollection< PcoCalendarTagGroup> > -
Will get a collection of PcoCalendarTagGroup objects (expecting many)
using a path like this:
https://api.planningcenteronline.com/calendar/v2/tag_groups
-
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/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
-
getAllFromPerson(
String personId, {String? id, PcoCalendarOrganizationQuery? query}) → Future< PcoCollection< PcoCalendarOrganization> > -
Will get a
PcoCollection
containing ALL PcoCalendarOrganization objects (expecting many) using a path like this:/calendar/v2/people/$personId/organization
-
getFromPerson(
String personId, {String? id, PcoCalendarOrganizationQuery? query, bool getAll = false}) → Future< PcoCollection< PcoCalendarOrganization> > -
Will get a
PcoCollection
of PcoCalendarOrganization objects (expecting many) using a path like this:/calendar/v2/people/$personId/organization
-
getSingleFromPerson(
String personId, String id, {PcoCalendarOrganizationQuery? query}) → Future< PcoCalendarOrganization?> -
Will get a single
PcoCalendarOrganization
object using a path like this:/calendar/v2/people/$personId/organization/[id]
Constants
- kApiVersion → const String
- kCreatePathTemplate → const String
- kDateFormat → const String
- kDefaultPathTemplate → const String
- kId → const String
- kName → const String
- kOnboarding → const String
- kPcoApplication → const String
- kTimeZone → const String
- kTwentyFourHourTime → const String
- kTypeId → const String
- kTypeString → const String