PcoServicesSeries class Null safety

This class represents a PCO Services Series Object

Application: services
Id: series
Type: Series
ApiVersion: 2018-11-01
Is Deprecated: false
Is Collection Only: false
Default Endpoint: https://api.planningcenteronline.com/services/v2/series
Create Endpoint: NONE

Instantiation

This object cannot be created through the API.
Instantiate from existing JSON data using the PcoServicesSeries.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 Series can be specified for each plan to tie plans with similar messages together, even across Service Types.

Note: A series is not created until artwork is added from the plan. You can use series_title included in Plan attributes to get titles for series without artwork.

Attributes (and permissions)

id (ro) -> PCO: id
createdAt (ro) -> PCO: created_at
updatedAt (ro) -> PCO: updated_at
artworkFileName (ro) -> PCO: artwork_file_name
artworkContentType (ro) -> PCO: artwork_content_type
artworkFileSize (ro) -> PCO: artwork_file_size
title (ro) -> PCO: title
artworkForDashboard (ro) -> PCO: artwork_for_dashboard
artworkForMobile (ro) -> PCO: artwork_for_mobile
artworkForPlan (ro) -> PCO: artwork_for_plan
artworkOriginal (ro) -> PCO: artwork_original
isHasArtwork (ro) -> PCO: has_artwork

Edges and Actions

Outbound Edges:

plan-series-plans: https://api.planningcenteronline.com/services/v2/series/1/plans

Inbound Edges:

series-organization-series: https://api.planningcenteronline.com/services/v2/series
series-plan-series: https://api.planningcenteronline.com/services/v2/service_types/1/plans/1/series

Actions: NONE

Raw Data Object Example

{
  "type": "Series",
  "id": "1",
  "attributes": {
    "created_at": "2000-01-01T12:00:00Z",
    "updated_at": "2000-01-01T12:00:00Z",
    "artwork_file_name": "string",
    "artwork_content_type": "string",
    "artwork_file_size": 1,
    "title": "string",
    "artwork_for_dashboard": "string",
    "artwork_for_mobile": "string",
    "artwork_for_plan": "string",
    "artwork_original": "string",
    "has_artwork": true
  },
  "relationships": {}
}

Inheritance

Object
PcoResource
PcoServicesSeries

Constructors

PcoServicesSeries({String? id, DateTime? createdAt, DateTime? updatedAt, String? artworkFileName, String? artworkContentType, int? artworkFileSize, String? title, String? artworkForDashboard, String? artworkForMobile, String? artworkForPlan, String? artworkOriginal, bool? isHasArtwork, Map<String, List<PcoResource>>? withRelationships, List<PcoResource>? withIncluded}): Create a new PcoServicesSeries object. This object cannot be created with the API
factory
PcoServicesSeries.empty(): Create an empty instance of this class. This is only useful when an endpoint requires related or included data.
PcoServicesSeries.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
artworkContentType → String: read-only
artworkFileName → String: read-only
artworkFileSize → int: read-only
artworkForDashboard → String: read-only
artworkForMobile → String: read-only
artworkForPlan → String: read-only
artworkOriginal → String: read-only
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
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
isHasArtwork → bool: 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
title → String: read-only
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
getPlans({PcoServicesPlanQuery? query}) → Future<PcoCollection<PcoServicesPlan>>: Will get a collection of PcoServicesPlan objects (expecting many) using a path like this: https://api.planningcenteronline.com/services/v2/series/1/plans
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

get({String? id, PcoServicesSeriesQuery? query, bool getAll = false}) → Future<PcoCollection<PcoServicesSeries>>: Will get a PcoCollection of PcoServicesSeries objects (expecting many) using a path like this: /services/v2/series
getAll({String? id, PcoServicesSeriesQuery? query}) → Future<PcoCollection<PcoServicesSeries>>: Will get a PcoCollection containing ALL PcoServicesSeries objects (expecting many) using a path like this: /services/v2/series
getAllFromServiceTypeAndPlan(String serviceTypeId, String planId, {String? id, PcoServicesSeriesQuery? query}) → Future<PcoCollection<PcoServicesSeries>>: Will get a PcoCollection containing ALL PcoServicesSeries objects (expecting many) using a path like this: /services/v2/service_types/$serviceTypeId/plans/$planId/series
getFromServiceTypeAndPlan(String serviceTypeId, String planId, {String? id, PcoServicesSeriesQuery? query, bool getAll = false}) → Future<PcoCollection<PcoServicesSeries>>: Will get a PcoCollection of PcoServicesSeries objects (expecting many) using a path like this: /services/v2/service_types/$serviceTypeId/plans/$planId/series
getSingle(String id, {PcoServicesSeriesQuery? query}) → Future<PcoServicesSeries?>: Will get a single PcoServicesSeries object using a path like this: /services/v2/series/[id]
getSingleFromServiceTypeAndPlan(String serviceTypeId, String planId, String id, {PcoServicesSeriesQuery? query}) → Future<PcoServicesSeries?>: Will get a single PcoServicesSeries object using a path like this: /services/v2/service_types/$serviceTypeId/plans/$planId/series/[id]

Constants

kApiVersion → const String: '2018-11-01'
kArtworkContentType → const String: 'artwork_content_type'
kArtworkFileName → const String: 'artwork_file_name'
kArtworkFileSize → const String: 'artwork_file_size'
kArtworkForDashboard → const String: 'artwork_for_dashboard'
kArtworkForMobile → const String: 'artwork_for_mobile'
kArtworkForPlan → const String: 'artwork_for_plan'
kArtworkOriginal → const String: 'artwork_original'
kCreatedAt → const String: 'created_at'
kCreatePathTemplate → const String: 'null'
kDefaultPathTemplate → const String: 'https://api.planningcenteronline.com/services/v2/series'
kHasArtwork → const String: 'has_artwork'
kId → const String: 'id'
kPcoApplication → const String: 'services'
kTitle → const String: 'title'
kTypeId → const String: 'series'
kTypeString → const String: 'Series'
kUpdatedAt → const String: 'updated_at'