PcoServicesItemNote class Null safety

This class represents a PCO Services ItemNote Object

Application: services
Id: item_note
Type: ItemNote
ApiVersion: 2018-11-01
Is Deprecated: false
Is Collection Only: false
Default Endpoint: https://api.planningcenteronline.com/services/v2/songs/1/last_scheduled_item/1/item_notes
Create Endpoint: https://api.planningcenteronline.com/services/v2/service_types/1/plans/1/items/1/item_notes

Instantiation

Create a new instance using the PcoServicesItemNote() constructor
Instantiate from existing JSON data using the PcoServicesItemNote.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

A plan item note that belongs to a category.

Note: You can only assign the category on create. If you want to change category; delete the current note, and create a new one passing in the item_note_category_id then.

Attributes (and permissions)

id (ro) -> PCO: id
createdAt (ro) -> PCO: created_at
updatedAt (ro) -> PCO: updated_at
content (rw) -> PCO: content
categoryName (ro) -> PCO: category_name

Edges and Actions

Outbound Edges:

itemnotecategory-itemnote-item_note_category: https://api.planningcenteronline.com/services/v2/songs/1/last_scheduled_item/1/item_notes/1/item_note_category

Inbound Edges:

itemnote-item-item_notes: https://api.planningcenteronline.com/services/v2/service_types/1/plans/1/items/1/item_notes

Actions: NONE

Raw Data Object Example

{
  "type": "ItemNote",
  "id": "1",
  "attributes": {
    "created_at": "2000-01-01T12:00:00Z",
    "updated_at": "2000-01-01T12:00:00Z",
    "content": "string",
    "category_name": "string"
  },
  "relationships": {
    "item_note_category": {
      "data": {
        "type": "ItemNoteCategory",
        "id": "1"
      }
    },
    "item": {
      "data": {
        "type": "Item",
        "id": "1"
      }
    }
  }
}

Inheritance

Object
PcoResource
PcoServicesItemNote

Constructors

PcoServicesItemNote({required String serviceTypeId, required String planId, required String itemId, String? id, DateTime? createdAt, DateTime? updatedAt, String? content, String? categoryName, Map<String, List<PcoResource>>? withRelationships, List<PcoResource>? withIncluded}): Create a new PcoServicesItemNote object using this endpoint: https://api.planningcenteronline.com/services/v2/service_types/$serviceTypeId/plans/$planId/items/$itemId/item_notes
factory
PcoServicesItemNote.empty(): Create an empty instance of this class. This is only useful when an endpoint requires related or included data.
PcoServicesItemNote.fromJson(Map<String, dynamic> data, {List<Map<String, dynamic>>? withIncluded})

Properties

api → PlanningCenter: planning center resources must be tied to an api
read-onlyinherited
apiEndpoint → String: read-onlyinherited
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
read-onlyoverride
apiVersion → String: child classes can override these getters which will allow methods in this class to see static variables from child classes
read-onlyoverride
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
read-onlyinherited
canCreate → bool: read-onlyoverride
canDestroy → bool: read-onlyoverride
canUpdate → bool: read-onlyoverride
categoryName → String: read-only
content ↔ String: pass null to remove key from attributes
read / write
createAllowed → List<String>: read-onlyoverride
createdAt → DateTime: read-onlyinherited
createPathTemplate → String: read-onlyoverride
defaultPathTemplate → String: read-onlyoverride
fetched ↔ bool: indicate whether an item is full or partial
read / writeinherited
hashCode → int: The hash code for this object.
read-onlyinherited
id → String?: read-onlyinherited
included → List<PcoResource>: contains included items parsed into objects
read-onlyinherited
includedItemNoteCategory → PcoServicesItemNoteCategory?: read-only
links → ReadOnlyMapView<String, dynamic>: contains the links data returned by the api if present
read-onlyinherited
needsSave → bool: read-onlyinherited
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
read-onlyinherited
resourceType ↔ String: all planning center resources must have a type
latefinalinherited
runtimeType → Type: A representation of the runtime type of the object.
read-onlyinherited
slug → String: read-onlyinherited
updateAllowed → List<String>: read-onlyoverride
updatedAt → DateTime: read-onlyinherited

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
getItemNoteCategory({PcoServicesItemNoteCategoryQuery? query}) → Future<PcoCollection<PcoServicesItemNoteCategory>>: Will get a collection of PcoServicesItemNoteCategory objects (expecting one) using a path like this: https://api.planningcenteronline.com/services/v2/songs/1/last_scheduled_item/1/item_notes/1/item_note_category
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
noSuchMethod(Invocation invocation) → dynamic: Invoked when a non-existent 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
read-only
canOrderBy → List<String>: possible orderings with parameter ?order=
read-only
canQuery → List<String>: possible queries using parameters like ?wherekey=value or ?wheregt|lt=value
read-only

Static Methods

getAllFromServiceTypeAndPlanAndItem(String serviceTypeId, String planId, String itemId, {String? id, PcoServicesItemNoteQuery? query, bool includeItemNoteCategory = false}) → Future<PcoCollection<PcoServicesItemNote>>: Will get a PcoCollection containing ALL PcoServicesItemNote objects (expecting many) using a path like this: /services/v2/service_types/$serviceTypeId/plans/$planId/items/$itemId/item_notes
getFromServiceTypeAndPlanAndItem(String serviceTypeId, String planId, String itemId, {String? id, PcoServicesItemNoteQuery? query, bool getAll = false, bool includeItemNoteCategory = false}) → Future<PcoCollection<PcoServicesItemNote>>: Will get a PcoCollection of PcoServicesItemNote objects (expecting many) using a path like this: /services/v2/service_types/$serviceTypeId/plans/$planId/items/$itemId/item_notes
getSingleFromServiceTypeAndPlanAndItem(String serviceTypeId, String planId, String itemId, String id, {PcoServicesItemNoteQuery? query, bool includeItemNoteCategory = false}) → Future<PcoServicesItemNote?>: Will get a single PcoServicesItemNote object using a path like this: /services/v2/service_types/$serviceTypeId/plans/$planId/items/$itemId/item_notes/[id]

Constants

kApiVersion → const String: '2018-11-01'
kCategoryName → const String: 'category_name'
kContent → const String: 'content'
kCreatedAt → const String: 'created_at'
kCreatePathTemplate → const String: 'https://api.planningcenteronline.com/services/v2/service_types/1/plans/1/items/1/item_notes'
kDefaultPathTemplate → const String: 'https://api.planningcenteronline.com/services/v2/songs/1/last_scheduled_item/1/item_notes'
kId → const String: 'id'
kPcoApplication → const String: 'services'
kTypeId → const String: 'item_note'
kTypeString → const String: 'ItemNote'
kUpdatedAt → const String: 'updated_at'