PcoServicesItem class

This class represents a PCO Services Item Object

Instantiation

  • Create a new instance using the PcoServicesItem() constructor
  • Instantiate from existing JSON data using the PcoServicesItem.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 item in a plan.

Attributes (and permissions)

  • id (ro) -> PCO: id
  • title (rw) -> PCO: title
  • sequence (rw) -> PCO: sequence
  • createdAt (ro) -> PCO: created_at
  • updatedAt (ro) -> PCO: updated_at
  • length (rw) -> PCO: length
  • itemType (rw) -> PCO: item_type
  • htmlDetails (rw) -> PCO: html_details
  • servicePosition (rw) -> PCO: service_position
  • description (rw) -> PCO: description
  • keyName (ro) -> PCO: key_name
  • customArrangementSequence (rw) -> PCO: custom_arrangement_sequence
  • customArrangementSequenceShort (ro) -> PCO: custom_arrangement_sequence_short
  • customArrangementSequenceFull (ro) -> PCO: custom_arrangement_sequence_full
  • arrangementId (wo) -> PCO: arrangement_id
  • keyId (wo) -> PCO: key_id
  • selectedLayoutId (wo) -> PCO: selected_layout_id
  • songId (wo) -> PCO: song_id

Edges and Actions

Outbound Edges:

Inbound Edges:

Actions: NONE

Raw Data Object Example

{
  "type": "Item",
  "id": "1",
  "attributes": {
    "title": "string",
    "sequence": 1,
    "created_at": "2000-01-01T12:00:00Z",
    "updated_at": "2000-01-01T12:00:00Z",
    "length": 1,
    "item_type": "string",
    "html_details": "string",
    "service_position": "string",
    "description": "string",
    "key_name": "string",
    "custom_arrangement_sequence": [],
    "custom_arrangement_sequence_short": [],
    "custom_arrangement_sequence_full": []
  },
  "relationships": {
    "plan": {
      "data": {
        "type": "Plan",
        "id": "1"
      }
    },
    "song": {
      "data": {
        "type": "Song",
        "id": "1"
      }
    },
    "arrangement": {
      "data": {
        "type": "Arrangement",
        "id": "1"
      }
    },
    "key": {
      "data": {
        "type": "Key",
        "id": "1"
      }
    },
    "selected_layout": {
      "data": {
        "type": "Layout",
        "id": "1"
      }
    },
    "selected_background": {
      "data": {
        "type": "Attachment",
        "id": "1"
      }
    }
  }
}
Inheritance

Constructors

PcoServicesItem({required String serviceTypeId, required String planId, String? id, String? title, int? sequence, DateTime? createdAt, DateTime? updatedAt, int? length, String? itemType, String? htmlDetails, String? servicePosition, String? description, String? keyName, List? customArrangementSequence, List? customArrangementSequenceShort, List? customArrangementSequenceFull, String? arrangementId, String? keyId, String? selectedLayoutId, String? songId, Map<String, List<PcoResource>>? withRelationships, List<PcoResource>? withIncluded})
Create a new PcoServicesItem object using this endpoint: https://api.planningcenteronline.com/services/v2/service_types/$serviceTypeId/plans/$planId/items
factory
PcoServicesItem.empty()
Create an empty instance of this class. This is only useful when an endpoint requires related or included data.
PcoServicesItem.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
arrangementId ↔ String
pass null to remove key from attributes
getter/setter pair
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
customArrangementSequence ↔ List
An array of strings containing a label and a number describing the section:
getter/setter pair
customArrangementSequenceFull → List
no setter
customArrangementSequenceShort → List
no setter
defaultPathTemplate → String
no setteroverride
description ↔ String
pass null to remove key from attributes
getter/setter pair
fetched ↔ bool
indicate whether an item is full or partial
getter/setter pairinherited
hashCode → int
The hash code for this object.
no setterinherited
htmlDetails ↔ String
pass null to remove key from attributes
getter/setter pair
id → String?
no setterinherited
included → List<PcoResource>
contains included items parsed into objects
no setterinherited
includedArrangement → PcoServicesArrangement?
no setter
includedItemNotes → List<PcoServicesItemNote>
no setter
includedItemTimes → List<PcoServicesItemTime>
no setter
includedKey → PcoServicesKey?
no setter
includedMedia → PcoServicesMedia?
no setter
includedSong → PcoServicesSong?
no setter
itemType ↔ String
There are 4 possible values:
getter/setter pair
keyId ↔ String
pass null to remove key from attributes
getter/setter pair
keyName → String
no setter
length ↔ int
pass null to remove key from attributes
getter/setter pair
contains the links data returned by the api if present
no setterinherited
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
selectedLayoutId ↔ String
pass null to remove key from attributes
getter/setter pair
sequence ↔ int
pass null to remove key from attributes
getter/setter pair
servicePosition ↔ String
There are 3 possible values:
getter/setter pair
slug → String
no setterinherited
songId ↔ String
pass null to remove key from attributes
getter/setter pair
title ↔ String
pass null to remove key from attributes
getter/setter pair
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
getArrangement({PcoServicesArrangementQuery? query}) → Future<PcoCollection<PcoServicesArrangement>>
Will get a collection of PcoServicesArrangement objects (expecting one) using a path like this: https://api.planningcenteronline.com/services/v2/service_types/1/plans/1/items/1/arrangement
getAttachments({PcoServicesAttachmentQuery? query}) → Future<PcoCollection<PcoServicesAttachment>>
Will get a collection of PcoServicesAttachment objects (expecting many) using a path like this: https://api.planningcenteronline.com/services/v2/service_types/1/plans/1/items/1/attachments
getCustomSlides({PcoServicesCustomSlideQuery? query}) → Future<PcoCollection<PcoServicesCustomSlide>>
Will get a collection of PcoServicesCustomSlide objects (expecting many) using a path like this: https://api.planningcenteronline.com/services/v2/service_types/1/plans/1/items/1/custom_slides
getItemNotes({PcoServicesItemNoteQuery? query}) → Future<PcoCollection<PcoServicesItemNote>>
Will get a collection of PcoServicesItemNote objects (expecting many) using a path like this: https://api.planningcenteronline.com/services/v2/service_types/1/plans/1/items/1/item_notes
getItemTimes({PcoServicesItemTimeQuery? query}) → Future<PcoCollection<PcoServicesItemTime>>
Will get a collection of PcoServicesItemTime objects (expecting many) using a path like this: https://api.planningcenteronline.com/services/v2/service_types/1/plans/1/items/1/item_times
getKey({PcoServicesKeyQuery? query}) → Future<PcoCollection<PcoServicesKey>>
Will get a collection of PcoServicesKey objects (expecting one) using a path like this: https://api.planningcenteronline.com/services/v2/service_types/1/plans/1/items/1/key
getMedia({PcoServicesMediaQuery? query}) → Future<PcoCollection<PcoServicesMedia>>
Will get a collection of PcoServicesMedia objects (expecting many) using a path like this: https://api.planningcenteronline.com/services/v2/service_types/1/plans/1/items/1/media
getSelectedAttachment({PcoServicesAttachmentQuery? query}) → Future<PcoCollection<PcoServicesAttachment>>
Will get a collection of PcoServicesAttachment objects (expecting many) using a path like this: https://api.planningcenteronline.com/services/v2/service_types/1/plans/1/items/1/selected_attachment
getSelectedBackground({PcoServicesAttachmentQuery? query}) → Future<PcoCollection<PcoServicesAttachment>>
Will get a collection of PcoServicesAttachment objects (expecting one) using a path like this: https://api.planningcenteronline.com/services/v2/service_types/1/plans/1/items/1/selected_background
getSong({PcoServicesSongQuery? query}) → Future<PcoCollection<PcoServicesSong>>
Will get a collection of PcoServicesSong objects (expecting one) using a path like this: https://api.planningcenteronline.com/services/v2/service_types/1/plans/1/items/1/song
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
includedSelectedAttachment<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

getAllFromSeriesAndPlanAndLive(String seriesId, String planId, String liveId, {String? id, PcoServicesItemQuery? query, bool includeAllRelated = false, bool includeArrangement = false, bool includeItemNotes = false, bool includeItemTimes = false, bool includeKey = false, bool includeMedia = false, bool includeSelectedAttachment = false, bool includeSong = false}) → Future<PcoCollection<PcoServicesItem>>
Will get a PcoCollection containing ALL PcoServicesItem objects (expecting many) using a path like this: /services/v2/series/$seriesId/plans/$planId/live/$liveId/items
getAllFromServiceTypeAndPlan(String serviceTypeId, String planId, {String? id, PcoServicesItemQuery? query, bool includeAllRelated = false, bool includeArrangement = false, bool includeItemNotes = false, bool includeItemTimes = false, bool includeKey = false, bool includeMedia = false, bool includeSelectedAttachment = false, bool includeSong = false}) → Future<PcoCollection<PcoServicesItem>>
Will get a PcoCollection containing ALL PcoServicesItem objects (expecting many) using a path like this: /services/v2/service_types/$serviceTypeId/plans/$planId/items
getAllFromServiceTypeAndPlanTemplate(String serviceTypeId, String planTemplateId, {String? id, PcoServicesItemQuery? query, bool includeAllRelated = false, bool includeArrangement = false, bool includeItemNotes = false, bool includeItemTimes = false, bool includeKey = false, bool includeMedia = false, bool includeSelectedAttachment = false, bool includeSong = false}) → Future<PcoCollection<PcoServicesItem>>
Will get a PcoCollection containing ALL PcoServicesItem objects (expecting many) using a path like this: /services/v2/service_types/$serviceTypeId/plan_templates/$planTemplateId/items
getFromSeriesAndPlanAndLive(String seriesId, String planId, String liveId, {String? id, PcoServicesItemQuery? query, bool getAll = false, bool includeAllRelated = false, bool includeArrangement = false, bool includeItemNotes = false, bool includeItemTimes = false, bool includeKey = false, bool includeMedia = false, bool includeSelectedAttachment = false, bool includeSong = false}) → Future<PcoCollection<PcoServicesItem>>
Will get a PcoCollection of PcoServicesItem objects (expecting many) using a path like this: /services/v2/series/$seriesId/plans/$planId/live/$liveId/items
getFromServiceTypeAndPlan(String serviceTypeId, String planId, {String? id, PcoServicesItemQuery? query, bool getAll = false, bool includeAllRelated = false, bool includeArrangement = false, bool includeItemNotes = false, bool includeItemTimes = false, bool includeKey = false, bool includeMedia = false, bool includeSelectedAttachment = false, bool includeSong = false}) → Future<PcoCollection<PcoServicesItem>>
Will get a PcoCollection of PcoServicesItem objects (expecting many) using a path like this: /services/v2/service_types/$serviceTypeId/plans/$planId/items
getFromServiceTypeAndPlanTemplate(String serviceTypeId, String planTemplateId, {String? id, PcoServicesItemQuery? query, bool getAll = false, bool includeAllRelated = false, bool includeArrangement = false, bool includeItemNotes = false, bool includeItemTimes = false, bool includeKey = false, bool includeMedia = false, bool includeSelectedAttachment = false, bool includeSong = false}) → Future<PcoCollection<PcoServicesItem>>
Will get a PcoCollection of PcoServicesItem objects (expecting many) using a path like this: /services/v2/service_types/$serviceTypeId/plan_templates/$planTemplateId/items
getLastScheduledItemFromSong(String songId, {PcoServicesItemQuery? query, bool getAll = false, bool includeAllRelated = false, bool includeArrangement = false, bool includeItemNotes = false, bool includeItemTimes = false, bool includeKey = false, bool includeMedia = false, bool includeSelectedAttachment = false, bool includeSong = false}) → Future<PcoCollection<PcoServicesItem>>
Will get a PcoCollection of PcoServicesItem objects (expecting one) using a path like this: /services/v2/songs/$songId/last_scheduled_item
getSingleFromSeriesAndPlanAndLive(String seriesId, String planId, String liveId, String id, {PcoServicesItemQuery? query, bool includeAllRelated = false, bool includeArrangement = false, bool includeItemNotes = false, bool includeItemTimes = false, bool includeKey = false, bool includeMedia = false, bool includeSelectedAttachment = false, bool includeSong = false}) → Future<PcoServicesItem?>
Will get a single PcoServicesItem object using a path like this: /services/v2/series/$seriesId/plans/$planId/live/$liveId/items/[id]
getSingleFromServiceTypeAndPlan(String serviceTypeId, String planId, String id, {PcoServicesItemQuery? query, bool includeAllRelated = false, bool includeArrangement = false, bool includeItemNotes = false, bool includeItemTimes = false, bool includeKey = false, bool includeMedia = false, bool includeSelectedAttachment = false, bool includeSong = false}) → Future<PcoServicesItem?>
Will get a single PcoServicesItem object using a path like this: /services/v2/service_types/$serviceTypeId/plans/$planId/items/[id]
getSingleFromServiceTypeAndPlanTemplate(String serviceTypeId, String planTemplateId, String id, {PcoServicesItemQuery? query, bool includeAllRelated = false, bool includeArrangement = false, bool includeItemNotes = false, bool includeItemTimes = false, bool includeKey = false, bool includeMedia = false, bool includeSelectedAttachment = false, bool includeSong = false}) → Future<PcoServicesItem?>
Will get a single PcoServicesItem object using a path like this: /services/v2/service_types/$serviceTypeId/plan_templates/$planTemplateId/items/[id]