PcoPeopleWorkflow class

This class represents a PCO People Workflow Object

Instantiation

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

Attributes (and permissions)

  • id (ro) -> PCO: id
  • name (rw) -> PCO: name
  • myReadyCardCount (ro) -> PCO: my_ready_card_count
  • totalReadyCardCount (ro) -> PCO: total_ready_card_count
  • completedCardCount (ro) -> PCO: completed_card_count
  • totalCardsCount (ro) -> PCO: total_cards_count
  • totalReadyAndSnoozedCardCount (ro) -> PCO: total_ready_and_snoozed_card_count
  • createdAt (ro) -> PCO: created_at
  • updatedAt (ro) -> PCO: updated_at
  • deletedAt (ro) -> PCO: deleted_at
  • campusId (rw) -> PCO: campus_id
  • workflowCategoryId (rw) -> PCO: workflow_category_id
  • myOverdueCardCount (ro) -> PCO: my_overdue_card_count
  • myDueSoonCardCount (ro) -> PCO: my_due_soon_card_count
  • isRecentlyViewed (ro) -> PCO: recently_viewed

Edges and Actions

Outbound Edges:

Inbound Edges:

Actions: NONE

Raw Data Object Example

{
  "type": "Workflow",
  "id": "1",
  "attributes": {
    "name": "string",
    "my_ready_card_count": 1,
    "total_ready_card_count": 1,
    "completed_card_count": 1,
    "total_cards_count": 1,
    "total_ready_and_snoozed_card_count": 1,
    "created_at": "2000-01-01T12:00:00Z",
    "updated_at": "2000-01-01T12:00:00Z",
    "deleted_at": "2000-01-01T12:00:00Z",
    "campus_id": "primary_key",
    "workflow_category_id": "primary_key",
    "recently_viewed": true
  },
  "relationships": {
    "workflow_category": {
      "data": {
        "type": "WorkflowCategory",
        "id": "1"
      }
    },
    "campus": {
      "data": {
        "type": "Campus",
        "id": "1"
      }
    }
  }
}
Inheritance

Constructors

PcoPeopleWorkflow({String? id, String? name, int? myReadyCardCount, int? totalReadyCardCount, int? completedCardCount, int? totalCardsCount, int? totalReadyAndSnoozedCardCount, DateTime? createdAt, DateTime? updatedAt, DateTime? deletedAt, String? campusId, String? workflowCategoryId, int? myOverdueCardCount, int? myDueSoonCardCount, bool? isRecentlyViewed, Map<String, List<PcoResource>>? withRelationships, List<PcoResource>? withIncluded})
Create a new PcoPeopleWorkflow object using this endpoint: https://api.planningcenteronline.com/people/v2/workflows
factory
PcoPeopleWorkflow.empty()
Create an empty instance of this class. This is only useful when an endpoint requires related or included data.
PcoPeopleWorkflow.fromJson(Map<String, dynamic> data, {List<Map<String, dynamic>>? withIncluded})

Properties

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
campusId ↔ String
pass null to remove key from attributes
getter/setter pair
canCreate → bool
no setteroverride
canDestroy → bool
no setteroverride
canUpdate → bool
no setteroverride
completedCardCount → int
no setter
createAllowed → List<String>
no setteroverride
createdAt → DateTime
no setterinherited
createPathTemplate → String
no setteroverride
defaultPathTemplate → String
no setteroverride
deletedAt → DateTime
no setter
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
isRecentlyViewed → bool
no setter
contains the links data returned by the api if present
no setterinherited
myDueSoonCardCount → int
no setter
myOverdueCardCount → int
no setter
myReadyCardCount → int
no setter
name ↔ String
pass null to remove key from attributes
getter/setter pair
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
totalCardsCount → int
no setter
totalReadyAndSnoozedCardCount → int
no setter
totalReadyCardCount → int
no setter
updateAllowed → List<String>
no setteroverride
updatedAt → DateTime
no setterinherited
workflowCategoryId ↔ String
pass null to remove key from attributes
getter/setter pair

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
getCards({PcoPeopleWorkflowCardQuery? query}) → Future<PcoCollection<PcoPeopleWorkflowCard>>
Will get a collection of PcoPeopleWorkflowCard objects (expecting many) using a path like this: https://api.planningcenteronline.com/people/v2/workflows/1/cards
getCategory({PcoPeopleWorkflowCategoryQuery? query}) → Future<PcoCollection<PcoPeopleWorkflowCategory>>
Will get a collection of PcoPeopleWorkflowCategory objects (expecting many) using a path like this: https://api.planningcenteronline.com/people/v2/workflows/1/category
getSharedPeople({PcoPeoplePersonQuery? query}) → Future<PcoCollection<PcoPeoplePerson>>
Will get a collection of PcoPeoplePerson objects (expecting many) using a path like this: https://api.planningcenteronline.com/people/v2/workflows/1/shared_people
getShares({PcoPeopleWorkflowShareQuery? query}) → Future<PcoCollection<PcoPeopleWorkflowShare>>
Will get a collection of PcoPeopleWorkflowShare objects (expecting many) using a path like this: https://api.planningcenteronline.com/people/v2/workflows/1/shares
getSteps({PcoPeopleWorkflowStepQuery? query}) → Future<PcoCollection<PcoPeopleWorkflowStep>>
Will get a collection of PcoPeopleWorkflowStep objects (expecting many) using a path like this: https://api.planningcenteronline.com/people/v2/workflows/1/steps
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
includedCategory<T extends PcoResource>() → List<T>
The code generator could not automatically determine the resource type of this relationship. For type safe code, you should specify it in the type argument when calling.
includedShares<T extends PcoResource>() → List<T>
The code generator could not automatically determine the resource type of this relationship. For type safe code, you should specify it in the type argument when calling.
includedSteps<T extends PcoResource>() → List<T>
The code generator could not automatically determine the resource type of this relationship. For type safe code, you should specify it in the type argument when calling.
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) 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
no setter
canOrderBy → List<String>
possible orderings with parameter ?order=
no setter
canQuery → List<String>
possible queries using parameters like ?wherekey=value or ?wheregt|lt=value
no setter

Static Methods

get({String? id, PcoPeopleWorkflowQuery? query, bool getAll = false, bool includeAllRelated = false, bool includeCategory = false, bool includeShares = false, bool includeSteps = false}) → Future<PcoCollection<PcoPeopleWorkflow>>
Will get a PcoCollection of PcoPeopleWorkflow objects (expecting many) using a path like this: /people/v2/workflows
getAll({String? id, PcoPeopleWorkflowQuery? query, bool includeAllRelated = false, bool includeCategory = false, bool includeShares = false, bool includeSteps = false}) → Future<PcoCollection<PcoPeopleWorkflow>>
Will get a PcoCollection containing ALL PcoPeopleWorkflow objects (expecting many) using a path like this: /people/v2/workflows
getFromPersonAndWorkflowCard(String personId, String workflowCardId, {PcoPeopleWorkflowQuery? query, bool getAll = false, bool includeAllRelated = false, bool includeCategory = false, bool includeShares = false, bool includeSteps = false}) → Future<PcoCollection<PcoPeopleWorkflow>>
Will get a PcoCollection of PcoPeopleWorkflow objects (expecting one) using a path like this: /people/v2/people/$personId/workflow_cards/$workflowCardId/workflow
getSingle(String id, {PcoPeopleWorkflowQuery? query, bool includeAllRelated = false, bool includeCategory = false, bool includeShares = false, bool includeSteps = false}) → Future<PcoPeopleWorkflow?>
Will get a single PcoPeopleWorkflow object using a path like this: /people/v2/workflows/[id]