PcoServicesOrganization class

This class represents a PCO Services Organization Object

Instantiation

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

The root level of an organization where account-level settings are applied.

Attributes (and permissions)

  • id (ro) -> PCO: id
  • ccli (ro) -> PCO: ccli
  • createdAt (ro) -> PCO: created_at
  • dateFormat (ro) -> PCO: date_format
  • isMusicStandEnabled (ro) -> PCO: music_stand_enabled
  • name (ro) -> PCO: name
  • isProjectorEnabled (ro) -> PCO: projector_enabled
  • timeZone (ro) -> PCO: time_zone
  • isTwentyFourHourTime (ro) -> PCO: twenty_four_hour_time
  • updatedAt (ro) -> PCO: updated_at
  • ownerName (ro) -> PCO: owner_name
  • requiredToSetDownloadPermission (ro) -> PCO: required_to_set_download_permission
  • secret (ro) -> PCO: secret
  • isAllowMp3Download (ro) -> PCO: allow_mp3_download
  • isCalendarStartsOnSunday (ro) -> PCO: calendar_starts_on_sunday
  • isCcliConnected (ro) -> PCO: ccli_connected
  • isCcliReportingEnabled (ro) -> PCO: ccli_reporting_enabled
  • isExtraFileStorageAllowed (ro) -> PCO: extra_file_storage_allowed
  • isFileStorageExceeded (ro) -> PCO: file_storage_exceeded
  • isFileStorageSize (ro) -> PCO: file_storage_size
  • isFileStorageSizeUsed (ro) -> PCO: file_storage_size_used
  • isFileStorageExtraEnabled (ro) -> PCO: file_storage_extra_enabled
  • isRehearsalMixEnabled (ro) -> PCO: rehearsal_mix_enabled
  • legacyId (ro) -> PCO: legacy_id
  • fileStorageExtraCharges (ro) -> PCO: file_storage_extra_charges
  • peopleAllowed (ro) -> PCO: people_allowed
  • peopleRemaining (ro) -> PCO: people_remaining
  • isBeta (ro) -> PCO: beta

Edges and Actions

Outbound Edges:

Inbound Edges:

Actions: NONE

Raw Data Object Example

{
  "type": "Organization",
  "id": "1",
  "attributes": {
    "ccli": "string",
    "created_at": "2000-01-01T12:00:00Z",
    "date_format": 1,
    "music_stand_enabled": true,
    "name": "string",
    "projector_enabled": true,
    "time_zone": "string",
    "twenty_four_hour_time": true,
    "updated_at": "2000-01-01T12:00:00Z",
    "owner_name": "string",
    "required_to_set_download_permission": "string",
    "secret": "string",
    "allow_mp3_download": true,
    "calendar_starts_on_sunday": true,
    "ccli_connected": true,
    "ccli_reporting_enabled": true,
    "extra_file_storage_allowed": true,
    "file_storage_exceeded": true,
    "file_storage_size": true,
    "file_storage_size_used": true,
    "file_storage_extra_enabled": true,
    "rehearsal_mix_enabled": true,
    "legacy_id": "primary_key",
    "file_storage_extra_charges": 1,
    "people_allowed": 1,
    "people_remaining": 1,
    "beta": true
  },
  "relationships": {}
}
Inheritance

Constructors

PcoServicesOrganization({String? id, String? ccli, DateTime? createdAt, int? dateFormat, bool? isMusicStandEnabled, String? name, bool? isProjectorEnabled, String? timeZone, bool? isTwentyFourHourTime, DateTime? updatedAt, String? ownerName, String? requiredToSetDownloadPermission, String? secret, bool? isAllowMp3Download, bool? isCalendarStartsOnSunday, bool? isCcliConnected, bool? isCcliReportingEnabled, bool? isExtraFileStorageAllowed, bool? isFileStorageExceeded, bool? isFileStorageSize, bool? isFileStorageSizeUsed, bool? isFileStorageExtraEnabled, bool? isRehearsalMixEnabled, String? legacyId, int? fileStorageExtraCharges, int? peopleAllowed, int? peopleRemaining, bool? isBeta, Map<String, List<PcoResource>>? withRelationships, List<PcoResource>? withIncluded})
Create a new PcoServicesOrganization object. This object cannot be created with the API
factory
PcoServicesOrganization.empty()
Create an empty instance of this class. This is only useful when an endpoint requires related or included data.
PcoServicesOrganization.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
canCreate → bool
no setteroverride
canDestroy → bool
no setteroverride
canUpdate → bool
no setteroverride
ccli → String
no setter
createAllowed → List<String>
no setteroverride
createdAt → DateTime
no setterinherited
createPathTemplate → String
no setteroverride
dateFormat → int
no setter
defaultPathTemplate → String
no setteroverride
fetched ↔ bool
indicate whether an item is full or partial
getter/setter pairinherited
fileStorageExtraCharges → int
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
isAllowMp3Download → bool
no setter
isBeta → bool
no setter
isCalendarStartsOnSunday → bool
no setter
isCcliConnected → bool
no setter
isCcliReportingEnabled → bool
no setter
isExtraFileStorageAllowed → bool
no setter
isFileStorageExceeded → bool
no setter
isFileStorageExtraEnabled → bool
no setter
isFileStorageSize → bool
no setter
isFileStorageSizeUsed → bool
no setter
isMusicStandEnabled → bool
no setter
isProjectorEnabled → bool
no setter
isRehearsalMixEnabled → bool
no setter
isTwentyFourHourTime → bool
no setter
legacyId → String
no setter
contains the links data returned by the api if present
no setterinherited
name → String
no setter
needsSave → bool
no setterinherited
ownerName → String
no setter
pcoApplication ↔ String
latefinalinherited
peopleAllowed → int
no setter
peopleRemaining → int
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
requiredToSetDownloadPermission → String
no setter
resourceType ↔ String
all planning center resources must have a type
latefinalinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
secret → String
no setter
slug → String
no setterinherited
timeZone → 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
getAttachmentTypes({PcoServicesAttachmentTypeQuery? query}) → Future<PcoCollection<PcoServicesAttachmentType>>
Will get a collection of PcoServicesAttachmentType objects (expecting many) using a path like this: https://api.planningcenteronline.com/services/v2/attachment_types
getEmailTemplates({PcoServicesEmailTemplateQuery? query}) → Future<PcoCollection<PcoServicesEmailTemplate>>
Will get a collection of PcoServicesEmailTemplate objects (expecting many) using a path like this: https://api.planningcenteronline.com/services/v2/email_templates
getFolders({PcoServicesFolderQuery? query}) → Future<PcoCollection<PcoServicesFolder>>
Will get a collection of PcoServicesFolder objects (expecting many) using a path like this: https://api.planningcenteronline.com/services/v2/folders
getMedia({PcoServicesMediaQuery? query}) → Future<PcoCollection<PcoServicesMedia>>
Will get a collection of PcoServicesMedia objects (expecting many) using a path like this: https://api.planningcenteronline.com/services/v2/media
getPeople({PcoServicesPersonQuery? query}) → Future<PcoCollection<PcoServicesPerson>>
Will get a collection of PcoServicesPerson objects (expecting many) using a path like this: https://api.planningcenteronline.com/services/v2/people
getPlans({PcoServicesOrganizationQuery? query}) → Future<PcoCollection<PcoServicesOrganization>>
Will get a collection of PcoServicesOrganization objects (expecting many) using a path like this: https://api.planningcenteronline.com/services/v2/plans
getReportTemplates({PcoServicesReportTemplateQuery? query}) → Future<PcoCollection<PcoServicesReportTemplate>>
Will get a collection of PcoServicesReportTemplate objects (expecting many) using a path like this: https://api.planningcenteronline.com/services/v2/report_templates
getSeries({PcoServicesSeriesQuery? query}) → Future<PcoCollection<PcoServicesSeries>>
Will get a collection of PcoServicesSeries objects (expecting many) using a path like this: https://api.planningcenteronline.com/services/v2/series
getServiceTypes({PcoServicesServiceTypeQuery? query}) → Future<PcoCollection<PcoServicesServiceType>>
Will get a collection of PcoServicesServiceType objects (expecting many) using a path like this: https://api.planningcenteronline.com/services/v2/service_types
getSongs({PcoServicesSongQuery? query}) → Future<PcoCollection<PcoServicesSong>>
Will get a collection of PcoServicesSong objects (expecting many) using a path like this: https://api.planningcenteronline.com/services/v2/songs
getTagGroups({PcoServicesTagGroupQuery? query}) → Future<PcoCollection<PcoServicesTagGroup>>
Will get a collection of PcoServicesTagGroup objects (expecting many) using a path like this: https://api.planningcenteronline.com/services/v2/tag_groups
getTeams({PcoServicesTeamQuery? query}) → Future<PcoCollection<PcoServicesTeam>>
Will get a collection of PcoServicesTeam objects (expecting many) using a path like this: https://api.planningcenteronline.com/services/v2/teams
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 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, PcoServicesOrganizationQuery? query, bool getAll = false}) → Future<PcoCollection<PcoServicesOrganization>>
Will get a PcoCollection of PcoServicesOrganization objects (expecting many) using a path like this: /services/v2
getAll({String? id, PcoServicesOrganizationQuery? query}) → Future<PcoCollection<PcoServicesOrganization>>
Will get a PcoCollection containing ALL PcoServicesOrganization objects (expecting many) using a path like this: /services/v2
getSingle(String id, {PcoServicesOrganizationQuery? query}) → Future<PcoServicesOrganization?>
Will get a single PcoServicesOrganization object using a path like this: /services/v2/[id]