PcoServicesSongbookStatus class Null safety

This class represents a PCO Services SongbookStatus Object

• Application: services
• Id: songbook_status
• Type: SongbookStatus
• ApiVersion: 2018-11-01
• Is Deprecated: false
• Is Collection Only: false
• Default Endpoint: https://api.planningcenteronline.com/services/v2
• Create Endpoint: NONE

Instantiation

• This object cannot be created through the API.
• Instantiate from existing JSON data using the PcoServicesSongbookStatus.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

Used to get the status of an in progress songbook action. When FINISHED, will contain the url of the songbook.

Attributes (and permissions)

• id (ro) -> PCO: id
• status (ro) -> PCO: status
• statusCode (ro) -> PCO: status_code
• statusToken (ro) -> PCO: status_token
• url (ro) -> PCO: url

Edges and Actions

Outbound Edges: NONE

Inbound Edges: NONE

Actions: NONE

Raw Data Object Example

{
  "type": "SongbookStatus",
  "id": "1",
  "attributes": {
    "status": "string",
    "status_code": "string",
    "status_token": "string",
    "url": "string"
  },
  "relationships": {}
}

Inheritance

• Object
• PcoResource
• PcoServicesSongbookStatus

Constructors

PcoServicesSongbookStatus({String? id, String? status, String? statusCode, String? statusToken, String? url, Map<String, List<PcoResource>>? withRelationships, List<PcoResource>? withIncluded})

Create a new PcoServicesSongbookStatus object. This object cannot be created with the API

factory

PcoServicesSongbookStatus.empty()

Create an empty instance of this class. This is only useful when an endpoint requires related or included data.

PcoServicesSongbookStatus.fromJson(Map<String, dynamic> data, {List<Map<String, dynamic>>? withIncluded})

Properties

api → PlanningCenter

planning center resources must be tied to an api

read-only, inherited

apiEndpoint → String

read-only, inherited

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-only, override

apiVersion → String

child classes can override these getters which will allow methods in this class to see static variables from child classes

read-only, override

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-only, inherited

canCreate → bool

read-only, override

canDestroy → bool

read-only, override

canUpdate → bool

read-only, override

createAllowed → List<String>

read-only, override

createdAt → DateTime

read-only, inherited

createPathTemplate → String

read-only, override

defaultPathTemplate → String

read-only, override

fetched ↔ bool

indicate whether an item is full or partial

read / write, inherited

hashCode → int

The hash code for this object.

read-only, inherited

id → String?

read-only, inherited

included → List<PcoResource>

contains included items parsed into objects

read-only, inherited

links → ReadOnlyMapView<String, dynamic>

contains the links data returned by the api if present

read-only, inherited

needsSave → bool

read-only, inherited

pcoApplication ↔ String

late, final, inherited

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-only, inherited

resourceType ↔ String

all planning center resources must have a type

late, final, inherited

runtimeType → Type

A representation of the runtime type of the object.

read-only, inherited

slug → String

read-only, inherited

status → String

read-only

statusCode → String

read-only

statusToken → String

read-only

updateAllowed → List<String>

read-only, override

updatedAt → DateTime

read-only, inherited

url → String

read-only

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

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

Constants

kApiVersion → const String

'2018-11-01'

kCreatePathTemplate → const String

'null'

kDefaultPathTemplate → const String

'https://api.planningcenteronline.com/services/v2'

kId → const String

'id'

kPcoApplication → const String

'services'

kStatus → const String

'status'

kStatusCode → const String

'status_code'

kStatusToken → const String

'status_token'

kTypeId → const String

'songbook_status'

kTypeString → const String

'SongbookStatus'

kUrl → const String

'url'