PcoGivingDesignation class
This class represents a PCO Giving Designation Object
- Application: giving
- Id: designation
- Type: Designation
- ApiVersion: 2019-10-18
- Is Deprecated: false
- Is Collection Only: false
- Default Endpoint: https://api.planningcenteronline.com/giving/v2/donations/1/designations
- Create Endpoint: NONE
Instantiation
- This object cannot be created through the API.
- Instantiate from existing
JSON
data using thePcoGivingDesignation.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 Designation
conveys how much of a Donation
goes to a particular Fund
.
Designation
details are required when creating a Donation
. If all of a Donation
is going to a single Fund
, it will only have one Designation
. Similarly, to split a Donation
between multiple Fund
s, you can use multiple Designation
s.
Attributes (and permissions)
id
(ro) -> PCO:id
amountCents
(ro) -> PCO:amount_cents
amountCurrency
(ro) -> PCO:amount_currency
Edges and Actions
Outbound Edges:
fund-designation-fund
: https://api.planningcenteronline.com/giving/v2/donations/1/designations/1/fund
Inbound Edges:
designation-designationrefund-designation
: https://api.planningcenteronline.com/giving/v2/donations/1/refund/designation_refunds/1/designationdesignation-donation-designations
: https://api.planningcenteronline.com/giving/v2/donations/1/designations
Actions: NONE
Raw Data Object Example
{
"type": "Designation",
"id": "1",
"attributes": {
"amount_cents": 1,
"amount_currency": "string"
},
"relationships": {
"fund": {
"data": {
"type": "Fund",
"id": "1"
}
}
}
}
- Inheritance
-
- Object
- PcoResource
- PcoGivingDesignation
Constructors
-
PcoGivingDesignation({String? id, int? amountCents, String? amountCurrency, Map<
String, List< ? withRelationships, List<PcoResource> >PcoResource> ? withIncluded}) -
Create a new PcoGivingDesignation object. This object cannot be created with the API
factory
- PcoGivingDesignation.empty()
- Create an empty instance of this class. This is only useful when an endpoint requires related or included data.
-
PcoGivingDesignation.fromJson(Map<
String, dynamic> data, {List<Map< ? withIncluded})String, dynamic> >
Properties
- amountCents → int
-
no setter
- amountCurrency → String
-
no setter
- 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
-
links
→ ReadOnlyMapView<
String, dynamic> -
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
- slug → String
-
no setterinherited
-
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 -
getFund(
{PcoGivingFundQuery? query}) → Future< PcoCollection< PcoGivingFund> > -
Will get a collection of PcoGivingFund objects (expecting one)
using a path like this:
https://api.planningcenteronline.com/giving/v2/donations/1/designations/1/fund
-
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
-
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
-
getAllFromDonation(
String donationId, {String? id, PcoGivingDesignationQuery? query}) → Future< PcoCollection< PcoGivingDesignation> > -
Will get a
PcoCollection
containing ALL PcoGivingDesignation objects (expecting many) using a path like this:/giving/v2/donations/$donationId/designations
-
getFromDonation(
String donationId, {String? id, PcoGivingDesignationQuery? query, bool getAll = false}) → Future< PcoCollection< PcoGivingDesignation> > -
Will get a
PcoCollection
of PcoGivingDesignation objects (expecting many) using a path like this:/giving/v2/donations/$donationId/designations
-
getFromDonationAndRefundAndDesignationRefund(
String donationId, String designationRefundId, {PcoGivingDesignationQuery? query, bool getAll = false}) → Future< PcoCollection< PcoGivingDesignation> > -
Will get a
PcoCollection
of PcoGivingDesignation objects (expecting one) using a path like this:/giving/v2/donations/$donationId/refund/designation_refunds/$designationRefundId/designation
-
getSingleFromDonation(
String donationId, String id, {PcoGivingDesignationQuery? query}) → Future< PcoGivingDesignation?> -
Will get a single
PcoGivingDesignation
object using a path like this:/giving/v2/donations/$donationId/designations/[id]
Constants
- kAmountCents → const String
- kAmountCurrency → const String
- kApiVersion → const String
- kCreatePathTemplate → const String
- kDefaultPathTemplate → const String
- kId → const String
- kPcoApplication → const String
- kTypeId → const String
- kTypeString → const String