planning-center-monorepo v1.0.0
planning-center-monorepo / planning-center-check-ins-ts/src / PcoCheckInsClient
Class: PcoCheckInsClient
Defined in: packages/planning-center-check-ins-ts/src/client.ts:30
Implements
EventEmitter
Constructors
Constructor
new PcoCheckInsClient(
config):PcoCheckInsClient
Defined in: packages/planning-center-check-ins-ts/src/client.ts:54
Parameters
config
Returns
PcoCheckInsClient
Properties
events
events:
EventsModule
Defined in: packages/planning-center-check-ins-ts/src/client.ts:31
checkIns
checkIns:
CheckInsModule
Defined in: packages/planning-center-check-ins-ts/src/client.ts:32
locations
locations:
LocationsModule
Defined in: packages/planning-center-check-ins-ts/src/client.ts:33
eventTimes
eventTimes:
EventTimesModule
Defined in: packages/planning-center-check-ins-ts/src/client.ts:34
stations
stations:
StationsModule
Defined in: packages/planning-center-check-ins-ts/src/client.ts:35
labels
labels:
LabelsModule
Defined in: packages/planning-center-check-ins-ts/src/client.ts:36
options
options:
OptionsModule
Defined in: packages/planning-center-check-ins-ts/src/client.ts:37
checkInGroups
checkInGroups:
CheckInGroupsModule
Defined in: packages/planning-center-check-ins-ts/src/client.ts:38
preChecks
preChecks:
PreChecksModule
Defined in: packages/planning-center-check-ins-ts/src/client.ts:39
passes
passes:
PassesModule
Defined in: packages/planning-center-check-ins-ts/src/client.ts:40
headcounts
headcounts:
HeadcountsModule
Defined in: packages/planning-center-check-ins-ts/src/client.ts:41
attendanceTypes
attendanceTypes:
AttendanceTypesModule
Defined in: packages/planning-center-check-ins-ts/src/client.ts:42
rosterListPersons
rosterListPersons:
RosterListPersonsModule
Defined in: packages/planning-center-check-ins-ts/src/client.ts:43
organization
organization:
OrganizationModule
Defined in: packages/planning-center-check-ins-ts/src/client.ts:44
integrationLinks
integrationLinks:
IntegrationLinksModule
Defined in: packages/planning-center-check-ins-ts/src/client.ts:45
themes
themes:
ThemesModule
Defined in: packages/planning-center-check-ins-ts/src/client.ts:46
batch
batch:
BatchExecutor
Defined in: packages/planning-center-check-ins-ts/src/client.ts:47
Methods
on()
on<
T>(eventType,handler):void
Defined in: packages/planning-center-check-ins-ts/src/client.ts:91
Type Parameters
T
T extends PcoEvent
Parameters
eventType
T["type"]
handler
EventHandler<T>
Returns
void
Implementation of
EventEmitter.on
off()
off<
T>(eventType,handler):void
Defined in: packages/planning-center-check-ins-ts/src/client.ts:95
Type Parameters
T
T extends PcoEvent
Parameters
eventType
T["type"]
handler
EventHandler<T>
Returns
void
Implementation of
EventEmitter.off
emit()
emit<
T>(event):void
Defined in: packages/planning-center-check-ins-ts/src/client.ts:99
Type Parameters
T
T extends PcoEvent
Parameters
event
T
Returns
void
Implementation of
EventEmitter.emit
getConfig()
getConfig():
PcoCheckInsClientConfig
Defined in: packages/planning-center-check-ins-ts/src/client.ts:106
Get the current configuration
Returns
updateConfig()
updateConfig(
updates):void
Defined in: packages/planning-center-check-ins-ts/src/client.ts:113
Update the configuration
Parameters
updates
Partial<PcoCheckInsClientConfig>
Returns
void
getPerformanceMetrics()
getPerformanceMetrics():
Record<string, {count:number;averageTime:number;minTime:number;maxTime:number;errorRate:number; }>
Defined in: packages/planning-center-check-ins-ts/src/client.ts:133
Get performance metrics
Returns
Record<string, { count: number; averageTime: number; minTime: number; maxTime: number; errorRate: number; }>
getRateLimitInfo()
getRateLimitInfo():
Record<string, {limit:number;remaining:number;resetTime:number; }>
Defined in: packages/planning-center-check-ins-ts/src/client.ts:140
Get rate limit information
Returns
Record<string, { limit: number; remaining: number; resetTime: number; }>
removeAllListeners()
removeAllListeners(
eventType?):void
Defined in: packages/planning-center-check-ins-ts/src/client.ts:147
Clear all event listeners
Parameters
eventType?
Returns
void
listenerCount()
listenerCount(
eventType):number
Defined in: packages/planning-center-check-ins-ts/src/client.ts:154
Get the number of listeners for an event type
Parameters
eventType
Returns
number
eventTypes()
eventTypes():
EventType[]
Defined in: packages/planning-center-check-ins-ts/src/client.ts:161
Get all registered event types