PcoGivingPledgeCampaign class Null safety

This class represents a PCO Giving PledgeCampaign Object

Application: giving
Id: pledge_campaign
Type: PledgeCampaign
ApiVersion: 2019-10-18
Is Deprecated: false
Is Collection Only: false
Default Endpoint: https://api.planningcenteronline.com/giving/v2/pledge_campaigns
Create Endpoint: NONE

Instantiation

Create a new instance using the PcoGivingPledgeCampaign() constructor
Instantiate from existing JSON data using the PcoGivingPledgeCampaign.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 PledgeCampaign is a way to request and track long-terms commitments to a particular goal or project.

Attributes (and permissions)

id (ro) -> PCO: id
createdAt (ro) -> PCO: created_at
updatedAt (ro) -> PCO: updated_at
name (rw) -> PCO: name
description (rw) -> PCO: description
startsAt (rw) -> PCO: starts_at
endsAt (rw) -> PCO: ends_at
goalCents (rw) -> PCO: goal_cents
goalCurrency (ro) -> PCO: goal_currency
isShowGoalInChurchCenter (rw) -> PCO: show_goal_in_church_center
receivedTotalFromPledgesCents (ro) -> PCO: received_total_from_pledges_cents
receivedTotalOutsideOfPledgesCents (ro) -> PCO: received_total_outside_of_pledges_cents
fundId (wo) -> PCO: fund_id

Edges and Actions

Outbound Edges:

fund-pledgecampaign-fund: https://api.planningcenteronline.com/giving/v2/pledge_campaigns/1/fund
pledge-pledgecampaign-pledges: https://api.planningcenteronline.com/giving/v2/pledge_campaigns/1/pledges

Inbound Edges:

pledgecampaign-pledge-pledge_campaign: https://api.planningcenteronline.com/giving/v2/pledges/1/pledge_campaign

Actions: NONE

Raw Data Object Example

{
  "type": "PledgeCampaign",
  "id": "1",
  "attributes": {
    "created_at": "2000-01-01T12:00:00Z",
    "updated_at": "2000-01-01T12:00:00Z",
    "name": "string",
    "description": "string",
    "starts_at": "2000-01-01T12:00:00Z",
    "ends_at": "2000-01-01T12:00:00Z",
    "goal_cents": 1,
    "goal_currency": "USD",
    "show_goal_in_church_center": true,
    "received_total_from_pledges_cents": 1,
    "received_total_outside_of_pledges_cents": 1
  },
  "relationships": {
    "fund": {
      "data": {
        "type": "Fund",
        "id": "1"
      }
    }
  }
}

Inheritance

Object
PcoResource
PcoGivingPledgeCampaign

Constructors

PcoGivingPledgeCampaign({String? id, DateTime? createdAt, DateTime? updatedAt, String? name, String? description, DateTime? startsAt, DateTime? endsAt, int? goalCents, String? goalCurrency, bool? isShowGoalInChurchCenter, int? receivedTotalFromPledgesCents, int? receivedTotalOutsideOfPledgesCents, String? fundId, Map<String, List<PcoResource>>? withRelationships, List<PcoResource>? withIncluded}): Create a new PcoGivingPledgeCampaign object. This object cannot be created with the API
factory
PcoGivingPledgeCampaign.empty(): Create an empty instance of this class. This is only useful when an endpoint requires related or included data.
PcoGivingPledgeCampaign.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: pass null to remove key from attributes
read / write
endsAt ↔ DateTime: pass null to remove key from attributes
read / write
fetched ↔ bool: indicate whether an item is full or partial
read / writeinherited
fundId ↔ String: pass null to remove key from attributes
read / write
goalCents ↔ int: Optional. During the donation period of this campaign, the running total of donations will be tracked against this number
read / write
goalCurrency → 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
includedFund → PcoGivingFund?: read-only
isShowGoalInChurchCenter ↔ bool: In addition to seeing their personal pledge progress within their donor profile, this option allows donors to see the the collective progress towards the campaign’s overall goal (if set).
read / write
links → ReadOnlyMapView<String, dynamic>: contains the links data returned by the api if present
read-onlyinherited
name ↔ String: pass null to remove key from attributes
read / write
needsSave → bool: read-onlyinherited
pcoApplication ↔ String: latefinalinherited
receivedTotalFromPledgesCents → int: read-only
receivedTotalOutsideOfPledgesCents → int: read-only
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
startsAt ↔ DateTime: pass null to remove key from attributes
read / write
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
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/pledge_campaigns/1/fund
getPledges({PcoGivingPledgeQuery? query}) → Future<PcoCollection<PcoGivingPledge>>: Will get a collection of PcoGivingPledge objects (expecting many) using a path like this: https://api.planningcenteronline.com/giving/v2/pledge_campaigns/1/pledges
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

getFromPledge(String pledgeId, {PcoGivingPledgeCampaignQuery? query, bool getAll = false, bool includeFund = false}) → Future<PcoCollection<PcoGivingPledgeCampaign>>: Will get a PcoCollection of PcoGivingPledgeCampaign objects (expecting one) using a path like this: /giving/v2/pledges/$pledgeId/pledge_campaign

Constants

kApiVersion → const String: '2019-10-18'
kCreatedAt → const String: 'created_at'
kCreatePathTemplate → const String: 'null'
kDefaultPathTemplate → const String: 'https://api.planningcenteronline.com/giving/v2/pledge_campaigns'
kDescription → const String: 'description'
kEndsAt → const String: 'ends_at'
kFundId → const String: 'fund_id'
kGoalCents → const String: 'goal_cents'
kGoalCurrency → const String: 'goal_currency'
kId → const String: 'id'
kName → const String: 'name'
kPcoApplication → const String: 'giving'
kReceivedTotalFromPledgesCents → const String: 'received_total_from_pledges_cents'
kReceivedTotalOutsideOfPledgesCents → const String: 'received_total_outside_of_pledges_cents'
kShowGoalInChurchCenter → const String: 'show_goal_in_church_center'
kStartsAt → const String: 'starts_at'
kTypeId → const String: 'pledge_campaign'
kTypeString → const String: 'PledgeCampaign'
kUpdatedAt → const String: 'updated_at'