PcoServicesPlanTemplate class
This class represents a PCO Services PlanTemplate Object
- Application: services
- Id: plan_template
- Type: PlanTemplate
- ApiVersion: 2018-11-01
- Is Deprecated: false
- Is Collection Only: false
- Default Endpoint: https://api.planningcenteronline.com/services/v2/service_types/1/plan_templates
- Create Endpoint: NONE
Instantiation
- This object cannot be created through the API.
- Instantiate from existing
JSON
data using thePcoServicesPlanTemplate.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 PlanTemplate Resource
Attributes (and permissions)
id
(ro) -> PCO:id
name
(ro) -> PCO:name
createdAt
(ro) -> PCO:created_at
updatedAt
(ro) -> PCO:updated_at
itemCount
(ro) -> PCO:item_count
teamCount
(ro) -> PCO:team_count
noteCount
(ro) -> PCO:note_count
isCanViewOrder
(ro) -> PCO:can_view_order
isMultiDay
(ro) -> PCO:multi_day
isPrefersOrderView
(ro) -> PCO:prefers_order_view
isRehearsable
(ro) -> PCO:rehearsable
Edges and Actions
Outbound Edges:
item-plantemplate-items
: https://api.planningcenteronline.com/services/v2/service_types/1/plan_templates/1/itemsplannote-plantemplate-notes
: https://api.planningcenteronline.com/services/v2/service_types/1/plan_templates/1/notes
Inbound Edges:
plantemplate-servicetype-plan_templates
: https://api.planningcenteronline.com/services/v2/service_types/1/plan_templates
Actions:
item_reorder
: https://api.planningcenteronline.com/services/v2/service_types/1/plan_templates/1/item_reorder
Raw Data Object Example
{
"type": "PlanTemplate",
"id": "1",
"attributes": {
"name": "string",
"created_at": "2000-01-01T12:00:00Z",
"updated_at": "2000-01-01T12:00:00Z",
"item_count": 1,
"team_count": 1,
"note_count": 1,
"can_view_order": true,
"multi_day": true,
"prefers_order_view": true,
"rehearsable": true
},
"relationships": {
"service_type": {
"data": {
"type": "ServiceType",
"id": "1"
}
},
"created_by": {
"data": {
"type": "Person",
"id": "1"
}
},
"updated_by": {
"data": {
"type": "Person",
"id": "1"
}
}
}
}
- Inheritance
-
- Object
- PcoResource
- PcoServicesPlanTemplate
Constructors
-
PcoServicesPlanTemplate({String? id, String? name, DateTime? createdAt, DateTime? updatedAt, int? itemCount, int? teamCount, int? noteCount, bool? isCanViewOrder, bool? isMultiDay, bool? isPrefersOrderView, bool? isRehearsable, Map<
String, List< ? withRelationships, List<PcoResource> >PcoResource> ? withIncluded}) -
Create a new PcoServicesPlanTemplate object. This object cannot be created with the API
factory
- PcoServicesPlanTemplate.empty()
- Create an empty instance of this class. This is only useful when an endpoint requires related or included data.
-
PcoServicesPlanTemplate.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
- 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
- isCanViewOrder → bool
-
no setter
- isMultiDay → bool
-
no setter
- isPrefersOrderView → bool
-
no setter
- isRehearsable → bool
-
no setter
- itemCount → int
-
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
- noteCount → int
-
no setter
- 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
- teamCount → int
-
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 -
getItems(
{PcoServicesItemQuery? query}) → Future< PcoCollection< PcoServicesItem> > -
Will get a collection of PcoServicesItem objects (expecting many)
using a path like this:
https://api.planningcenteronline.com/services/v2/service_types/1/plan_templates/1/items
-
getNotes(
{PcoServicesPlanNoteQuery? query}) → Future< PcoCollection< PcoServicesPlanNote> > -
Will get a collection of PcoServicesPlanNote objects (expecting many)
using a path like this:
https://api.planningcenteronline.com/services/v2/service_types/1/plan_templates/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
-
itemReorder(
Object data) → Future< PlanningCenterApiResponse< PlanningCenterApiData> > -
ACTION:
item_reorder
-
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
-
getAllFromServiceType(
String serviceTypeId, {String? id, PcoServicesPlanTemplateQuery? query}) → Future< PcoCollection< PcoServicesPlanTemplate> > -
Will get a
PcoCollection
containing ALL PcoServicesPlanTemplate objects (expecting many) using a path like this:/services/v2/service_types/$serviceTypeId/plan_templates
-
getFromServiceType(
String serviceTypeId, {String? id, PcoServicesPlanTemplateQuery? query, bool getAll = false}) → Future< PcoCollection< PcoServicesPlanTemplate> > -
Will get a
PcoCollection
of PcoServicesPlanTemplate objects (expecting many) using a path like this:/services/v2/service_types/$serviceTypeId/plan_templates
-
getSingleFromServiceType(
String serviceTypeId, String id, {PcoServicesPlanTemplateQuery? query}) → Future< PcoServicesPlanTemplate?> -
Will get a single
PcoServicesPlanTemplate
object using a path like this:/services/v2/service_types/$serviceTypeId/plan_templates/[id]
Constants
- kApiVersion → const String
- kCanViewOrder → const String
- kCreatedAt → const String
- kCreatePathTemplate → const String
- kDefaultPathTemplate → const String
- kId → const String
- kItemCount → const String
- kMultiDay → const String
- kName → const String
- kNoteCount → const String
- kPcoApplication → const String
- kPrefersOrderView → const String
- kRehearsable → const String
- kTeamCount → const String
- kTypeId → const String
- kTypeString → const String
- kUpdatedAt → const String