PcoServicesBlockout class Null safety

This class represents a PCO Services Blockout Object

Instantiation

  • Create a new instance using the PcoServicesBlockout() constructor
  • Instantiate from existing JSON data using the PcoServicesBlockout.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 object representing a blockout date, and an optional recurrence pattern

Attributes (and permissions)

  • id (ro) -> PCO: id
  • description (ro) -> PCO: description
  • groupIdentifier (ro) -> PCO: group_identifier
  • organizationName (ro) -> PCO: organization_name
  • reason (rw) -> PCO: reason
  • repeatFrequency (rw) -> PCO: repeat_frequency
  • repeatInterval (rw) -> PCO: repeat_interval
  • repeatPeriod (rw) -> PCO: repeat_period
  • settings (ro) -> PCO: settings
  • timeZone (ro) -> PCO: time_zone
  • createdAt (ro) -> PCO: created_at
  • updatedAt (ro) -> PCO: updated_at
  • repeatUntil (rw) -> PCO: repeat_until
  • startsAt (rw) -> PCO: starts_at
  • endsAt (rw) -> PCO: ends_at
  • isShare (rw) -> PCO: share

Edges and Actions

Outbound Edges:

Inbound Edges:

Actions: NONE

Raw Data Object Example

{
  "type": "Blockout",
  "id": "1",
  "attributes": {
    "description": "string",
    "group_identifier": "string",
    "organization_name": "string",
    "reason": "string",
    "repeat_frequency": "string",
    "repeat_interval": "string",
    "repeat_period": "string",
    "settings": "string",
    "time_zone": "string",
    "created_at": "2000-01-01T12:00:00Z",
    "updated_at": "2000-01-01T12:00:00Z",
    "repeat_until": "2000-01-01",
    "starts_at": "2000-01-01T12:00:00Z",
    "ends_at": "2000-01-01T12:00:00Z",
    "share": true
  },
  "relationships": {
    "person": {
      "data": {
        "type": "Person",
        "id": "1"
      }
    },
    "organization": {
      "data": {
        "type": "Organization",
        "id": "1"
      }
    }
  }
}
Inheritance

Constructors

PcoServicesBlockout({required String personId, String? id, String? description, String? groupIdentifier, String? organizationName, String? reason, String? repeatFrequency, String? repeatInterval, String? repeatPeriod, String? settings, String? timeZone, DateTime? createdAt, DateTime? updatedAt, String? repeatUntil, DateTime? startsAt, DateTime? endsAt, bool? isShare, Map<String, List<PcoResource>>? withRelationships, List<PcoResource>? withIncluded})
Create a new PcoServicesBlockout object using this endpoint: https://api.planningcenteronline.com/services/v2/people/$personId/blockouts
factory
PcoServicesBlockout.empty()
Create an empty instance of this class. This is only useful when an endpoint requires related or included data.
PcoServicesBlockout.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
createAllowed → List<String>
read-onlyoverride
createdAt → DateTime
read-onlyinherited
createPathTemplate → String
read-onlyoverride
defaultPathTemplate → String
read-onlyoverride
description → String
read-only
endsAt ↔ DateTime
pass null to remove key from attributes
read / write
fetched ↔ bool
indicate whether an item is full or partial
read / writeinherited
groupIdentifier → String
read-only
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
isShare ↔ bool
pass null to remove key from attributes
read / write
contains the links data returned by the api if present
read-onlyinherited
needsSave → bool
read-onlyinherited
organizationName → String
read-only
pcoApplication ↔ String
latefinalinherited
reason ↔ String
pass null to remove key from attributes
read / write
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
repeatFrequency ↔ String
Possible values:
read / write
repeatInterval ↔ String
Possible values:
read / write
repeatPeriod ↔ String
Possible values:
read / write
repeatUntil ↔ String
pass null to remove key from attributes
read / write
resourceType ↔ String
all planning center resources must have a type
latefinalinherited
runtimeType → Type
A representation of the runtime type of the object.
read-onlyinherited
settings → String
read-only
slug → String
read-onlyinherited
startsAt ↔ DateTime
pass null to remove key from attributes
read / write
timeZone → 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
getBlockoutDates({PcoServicesBlockoutDateQuery? query}) → Future<PcoCollection<PcoServicesBlockoutDate>>
Will get a collection of PcoServicesBlockoutDate objects (expecting many) using a path like this: https://api.planningcenteronline.com/services/v2/people/1/blockouts/1/blockout_dates
getBlockoutExceptions({PcoServicesBlockoutExceptionQuery? query}) → Future<PcoCollection<PcoServicesBlockoutException>>
Will get a collection of PcoServicesBlockoutException objects (expecting many) using a path like this: https://api.planningcenteronline.com/services/v2/people/1/blockouts/1/blockout_exceptions
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

getAllFromPerson(String personId, {String? id, PcoServicesBlockoutQuery? query}) → Future<PcoCollection<PcoServicesBlockout>>
Will get a PcoCollection containing ALL PcoServicesBlockout objects (expecting many) using a path like this: /services/v2/people/$personId/blockouts
getFromPerson(String personId, {String? id, PcoServicesBlockoutQuery? query, bool getAll = false}) → Future<PcoCollection<PcoServicesBlockout>>
Will get a PcoCollection of PcoServicesBlockout objects (expecting many) using a path like this: /services/v2/people/$personId/blockouts
getSingleFromPerson(String personId, String id, {PcoServicesBlockoutQuery? query}) → Future<PcoServicesBlockout?>
Will get a single PcoServicesBlockout object using a path like this: /services/v2/people/$personId/blockouts/[id]

Constants

kApiVersion → const String
'2018-11-01'
kCreatedAt → const String
'created_at'
kCreatePathTemplate → const String
'https://api.planningcenteronline.com/services/v2/people/1/blockouts'
kDefaultPathTemplate → const String
'https://api.planningcenteronline.com/services/v2/people/1/blockouts'
kDescription → const String
'description'
kEndsAt → const String
'ends_at'
kGroupIdentifier → const String
'group_identifier'
kId → const String
'id'
kOrganizationName → const String
'organization_name'
kPcoApplication → const String
'services'
kReason → const String
'reason'
kRepeatFrequency → const String
'repeat_frequency'
kRepeatInterval → const String
'repeat_interval'
kRepeatPeriod → const String
'repeat_period'
kRepeatUntil → const String
'repeat_until'
kSettings → const String
'settings'
kShare → const String
'share'
kStartsAt → const String
'starts_at'
kTimeZone → const String
'time_zone'
kTypeId → const String
'blockout'
kTypeString → const String
'Blockout'
kUpdatedAt → const String
'updated_at'