PcoPeopleMessage class

This class represents a PCO People Message Object

Application: people
Id: message
Type: Message
ApiVersion: 2022-07-14
Is Deprecated: false
Is Collection Only: false
Default Endpoint: https://api.planningcenteronline.com/people/v2/messages
Create Endpoint: NONE

Instantiation

This object cannot be created through the API.
Instantiate from existing JSON data using the PcoPeopleMessage.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 message is an individual email or sms text sent to a member. Every message has a parent message group.

Attributes (and permissions)

id (ro) -> PCO: id
kind (ro) -> PCO: kind
toAddresses (ro) -> PCO: to_addresses
subject (ro) -> PCO: subject
file (ro) -> PCO: file
deliveryStatus (ro) -> PCO: delivery_status
rejectReason (ro) -> PCO: reject_reason
createdAt (ro) -> PCO: created_at
sentAt (ro) -> PCO: sent_at
bouncedAt (ro) -> PCO: bounced_at
rejectionNotificationSentAt (ro) -> PCO: rejection_notification_sent_at
fromName (ro) -> PCO: from_name
fromAddress (ro) -> PCO: from_address
readAt (ro) -> PCO: read_at
appName (ro) -> PCO: app_name
messageType (ro) -> PCO: message_type

Edges and Actions

Outbound Edges:

messagegroup-message-message_group: https://api.planningcenteronline.com/people/v2/messages/1/message_group
person-message-to: https://api.planningcenteronline.com/people/v2/messages/1/to

Inbound Edges:

message-messagegroup-messages: https://api.planningcenteronline.com/people/v2/message_groups/1/messages
message-organization-messages: https://api.planningcenteronline.com/people/v2/messages
message-person-messages: https://api.planningcenteronline.com/people/v2/people/1/messages

Actions: NONE

Raw Data Object Example

{
  "type": "Message",
  "id": "1",
  "attributes": {
    "kind": "value",
    "to_addresses": "string",
    "subject": "string",
    "file": "string",
    "delivery_status": "string",
    "reject_reason": "string",
    "created_at": "2000-01-01T12:00:00Z",
    "sent_at": "2000-01-01T12:00:00Z",
    "bounced_at": "2000-01-01T12:00:00Z",
    "rejection_notification_sent_at": "2000-01-01T12:00:00Z",
    "from_name": "string",
    "from_address": "string",
    "read_at": "2000-01-01T12:00:00Z",
    "app_name": "string",
    "message_type": "string"
  },
  "relationships": {
    "from": {
      "data": {
        "type": "Person",
        "id": "1"
      }
    },
    "to": {
      "data": {
        "type": "Person",
        "id": "1"
      }
    },
    "message_group": {
      "data": {
        "type": "MessageGroup",
        "id": "1"
      }
    }
  }
}

Inheritance

Object
PcoResource
PcoPeopleMessage

Constructors

PcoPeopleMessage({String? id, String? kind, String? toAddresses, String? subject, String? file, String? deliveryStatus, String? rejectReason, DateTime? createdAt, DateTime? sentAt, DateTime? bouncedAt, DateTime? rejectionNotificationSentAt, String? fromName, String? fromAddress, DateTime? readAt, String? appName, String? messageType, Map<String, List<PcoResource>>? withRelationships, List<PcoResource>? withIncluded}): Create a new PcoPeopleMessage object. This object cannot be created with the API
factory
PcoPeopleMessage.empty(): Create an empty instance of this class. This is only useful when an endpoint requires related or included data.
PcoPeopleMessage.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
appName → String: no setter
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
bouncedAt → DateTime: no setter
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
deliveryStatus → String: no setter
fetched ↔ bool: indicate whether an item is full or partial
getter/setter pairinherited
file → String: no setter
fromAddress → String: no setter
fromName → String: no setter
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
includedMessageGroup → PcoPeopleMessageGroup?: no setter
kind → String: no setter
links → ReadOnlyMapView<String, dynamic>: contains the links data returned by the api if present
no setterinherited
messageType → String: no setter
needsSave → bool: no setterinherited
pcoApplication ↔ String: latefinalinherited
readAt → DateTime: no setter
rejectionNotificationSentAt → DateTime: no setter
rejectReason → String: no setter
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
sentAt → DateTime: no setter
slug → String: no setterinherited
subject → String: no setter
toAddresses → String: no setter
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<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
getMessageGroup({PcoPeopleMessageGroupQuery? query}) → Future<PcoCollection<PcoPeopleMessageGroup>>: Will get a collection of PcoPeopleMessageGroup objects (expecting one) using a path like this: https://api.planningcenteronline.com/people/v2/messages/1/message_group
getTo({PcoPeoplePersonQuery? query}) → Future<PcoCollection<PcoPeoplePerson>>: Will get a collection of PcoPeoplePerson objects (expecting one) using a path like this: https://api.planningcenteronline.com/people/v2/messages/1/to
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
includedTo<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, PcoPeopleMessageQuery? query, bool getAll = false, bool includeAllRelated = false, bool includeMessageGroup = false, bool includeTo = false}) → Future<PcoCollection<PcoPeopleMessage>>: Will get a PcoCollection of PcoPeopleMessage objects (expecting many) using a path like this: /people/v2/messages
getAll({String? id, PcoPeopleMessageQuery? query, bool includeAllRelated = false, bool includeMessageGroup = false, bool includeTo = false}) → Future<PcoCollection<PcoPeopleMessage>>: Will get a PcoCollection containing ALL PcoPeopleMessage objects (expecting many) using a path like this: /people/v2/messages
getAllFromMessageGroup(String messageGroupId, {String? id, PcoPeopleMessageQuery? query, bool includeAllRelated = false, bool includeMessageGroup = false, bool includeTo = false}) → Future<PcoCollection<PcoPeopleMessage>>: Will get a PcoCollection containing ALL PcoPeopleMessage objects (expecting many) using a path like this: /people/v2/message_groups/$messageGroupId/messages
getAllFromPerson(String personId, {String? id, PcoPeopleMessageQuery? query, bool includeAllRelated = false, bool includeMessageGroup = false, bool includeTo = false}) → Future<PcoCollection<PcoPeopleMessage>>: Will get a PcoCollection containing ALL PcoPeopleMessage objects (expecting many) using a path like this: /people/v2/people/$personId/messages
getFromMessageGroup(String messageGroupId, {String? id, PcoPeopleMessageQuery? query, bool getAll = false, bool includeAllRelated = false, bool includeMessageGroup = false, bool includeTo = false}) → Future<PcoCollection<PcoPeopleMessage>>: Will get a PcoCollection of PcoPeopleMessage objects (expecting many) using a path like this: /people/v2/message_groups/$messageGroupId/messages
getFromPerson(String personId, {String? id, PcoPeopleMessageQuery? query, bool getAll = false, bool includeAllRelated = false, bool includeMessageGroup = false, bool includeTo = false}) → Future<PcoCollection<PcoPeopleMessage>>: Will get a PcoCollection of PcoPeopleMessage objects (expecting many) using a path like this: /people/v2/people/$personId/messages
getSingle(String id, {PcoPeopleMessageQuery? query, bool includeAllRelated = false, bool includeMessageGroup = false, bool includeTo = false}) → Future<PcoPeopleMessage?>: Will get a single PcoPeopleMessage object using a path like this: /people/v2/messages/[id]
getSingleFromMessageGroup(String messageGroupId, String id, {PcoPeopleMessageQuery? query, bool includeAllRelated = false, bool includeMessageGroup = false, bool includeTo = false}) → Future<PcoPeopleMessage?>: Will get a single PcoPeopleMessage object using a path like this: /people/v2/message_groups/$messageGroupId/messages/[id]
getSingleFromPerson(String personId, String id, {PcoPeopleMessageQuery? query, bool includeAllRelated = false, bool includeMessageGroup = false, bool includeTo = false}) → Future<PcoPeopleMessage?>: Will get a single PcoPeopleMessage object using a path like this: /people/v2/people/$personId/messages/[id]

Constants

kApiVersion → const String
kAppName → const String
kBouncedAt → const String
kCreatedAt → const String
kCreatePathTemplate → const String
kDefaultPathTemplate → const String
kDeliveryStatus → const String
kFile → const String
kFromAddress → const String
kFromName → const String
kId → const String
kKind → const String
kMessageType → const String
kPcoApplication → const String
kReadAt → const String
kRejectionNotificationSentAt → const String
kRejectReason → const String
kSentAt → const String
kSubject → const String
kToAddresses → const String
kTypeId → const String
kTypeString → const String