A CustomSlide is used for adding text intended for display on a screen.
| Property | Value |
|---|---|
| Product | Services (pco.services, API version 2018-11-01) |
| Resource type | CustomSlide |
| TypeScript | Services.CustomSlide, attributes Services.CustomSlideAttributes, schema Services.CustomSlideSchema |
| Planning Center path | /services/v2/songs/{song_id}/last_scheduled_item/{last_scheduled_item_id}/custom_slides |
| Planning Center docs | CustomSlide |
How to reach it
| Client path | Returns | Filters | Create |
|---|---|---|---|
pco.services.songs.id(songId).last_scheduled_item.id(itemId).custom_slides |
Collection | Yes |
From a collection, .id(customSlideId) addresses one CustomSlide: pco.services.songs.id(songId).last_scheduled_item.id(itemId).custom_slides.id(customSlideId). Collections support where, include, order, and pagination; single resources have get().
Attributes
On Services.CustomSlideAttributes. Every resource also has id and type ('CustomSlide') next to its attributes.
| Name | Type | Description |
|---|---|---|
body |
string | null |
|
enabled |
boolean | null |
|
label |
string | null |
|
order |
number | null |
Relationships and includes
Planning Center documents no includes for this resource.
| Relationship | Type | To | Includable |
|---|---|---|---|
attachment |
To one | Attachment | No |
item |
To one | Item | No |
Querying
No documented where fields.
No documented order fields.
Edges
This resource has no documented edges.
Writing
| Property | Value |
|---|---|
| Create | Yes, create() on custom_slides on Item |
| Update | Yes, update() on a reference |
| Delete | Yes, delete() on a reference |
Create attributes
Typed as Services.CustomSlideSchema['create'].
| Attribute | Type |
|---|---|
attachment_id |
string |
body |
string | null |
enabled |
boolean | null |
item_id |
string |
label |
string | null |
order |
number | null |
Update attributes
Typed as Services.CustomSlideSchema['update'].
| Attribute | Type |
|---|---|
attachment_id |
string |
body |
string | null |
enabled |
boolean | null |
item_id |
string |
label |
string | null |
order |
number | null |
See Writing data.
Example
import type { Services } from '@mackenly/planningcenterkit';
const songId = '1'; // Song id
const itemId = '1'; // Item id
const page = await pco.services.songs.id(songId).last_scheduled_item.id(itemId).custom_slides.perPage(25).list();
const items: Services.CustomSlide[] = page.data;