PcoServicesZoom class

This class represents a PCO Services Zoom Object

Instantiation

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

Describes a zoom level for an attachment

Attributes (and permissions)

  • id (ro) -> PCO: id
  • aspectRatio (rw) -> PCO: aspect_ratio
  • zoomLevel (rw) -> PCO: zoom_level
  • xOffset (rw) -> PCO: x_offset
  • yOffset (rw) -> PCO: y_offset

Edges and Actions

Outbound Edges: NONE

Inbound Edges:

Actions: NONE

Raw Data Object Example

{
  "type": "Zoom",
  "id": "1",
  "attributes": {
    "aspect_ratio": 1.42,
    "zoom_level": 1.42,
    "x_offset": 1.42,
    "y_offset": 1.42
  },
  "relationships": {
    "person": {
      "data": {
        "type": "Person",
        "id": "1"
      }
    },
    "attachable": {
      "data": {
        "type": "Attachment",
        "id": "1"
      }
    },
    "attachment": {
      "data": {
        "type": "Attachment",
        "id": "1"
      }
    }
  }
}
Inheritance

Constructors

PcoServicesZoom({required String attachmentId, String? id, double? aspectRatio, double? zoomLevel, double? xOffset, double? yOffset, Map<String, List<PcoResource>>? withRelationships, List<PcoResource>? withIncluded})
Create a new PcoServicesZoom object using this endpoint: https://api.planningcenteronline.com/services/v2/attachments/$attachmentId/zooms
factory
PcoServicesZoom.empty()
Create an empty instance of this class. This is only useful when an endpoint requires related or included data.
PcoServicesZoom.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
aspectRatio double
The aspect ratio of the device this zoom is for. It is rounded to the nearest 3 decimal places.
getter/setter pair
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
createAllowed List<String>
no setteroverride
createdAt DateTime
no setterinherited
createPathTemplate String
no setteroverride
defaultPathTemplate String
no setteroverride
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
contains the links data returned by the api if present
no setterinherited
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
updateAllowed List<String>
no setteroverride
updatedAt DateTime
no setterinherited
xOffset double
The percentage of the document's width the zoomed document should be offset by horizontally.
getter/setter pair
yOffset double
The percentage of the document's height the zoomed document should be offset by vertically.
getter/setter pair
zoomLevel double
The percentage of the zoom. Must be a value between 1.0 and 5.0
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
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

getAllFromAttachment(String attachmentId, {String? id, PcoServicesZoomQuery? query}) Future<PcoCollection<PcoServicesZoom>>
Will get a PcoCollection containing ALL PcoServicesZoom objects (expecting many) using a path like this: /services/v2/attachments/$attachmentId/zooms
getFromAttachment(String attachmentId, {String? id, PcoServicesZoomQuery? query, bool getAll = false}) Future<PcoCollection<PcoServicesZoom>>
Will get a PcoCollection of PcoServicesZoom objects (expecting many) using a path like this: /services/v2/attachments/$attachmentId/zooms
getSingleFromAttachment(String attachmentId, String id, {PcoServicesZoomQuery? query}) Future<PcoServicesZoom?>
Will get a single PcoServicesZoom object using a path like this: /services/v2/attachments/$attachmentId/zooms/[id]

Constants

kApiVersion → const String
kAspectRatio → const String
kCreatePathTemplate → const String
kDefaultPathTemplate → const String
kId → const String
kPcoApplication → const String
kTypeId → const String
kTypeString → const String
kXOffset → const String
kYOffset → const String
kZoomLevel → const String