CalendarSocket

@codebolt/plugin-sdk

---

Class: CalendarSocket

Defined in: CodeBolt/packages/pluginSdk/src/sockets/calendar.socket.ts:10

Calendar WebSocket - Manage calendar events with RSVP support. Type-based protocol: send { type, data, requestId }, receive { type:response, data, requestId, success }.

Extends

• TypedEventEmitter<CalendarSocketEvents>

Constructors

Constructor

new CalendarSocket(connectionManager: SocketConnectionManager, socketName: string): CalendarSocket;

Defined in: CodeBolt/packages/pluginSdk/src/sockets/calendar.socket.ts:13

Parameters

Parameter	Type	Default value
connectionManager	SocketConnectionManager	undefined
socketName	string	'calendar'

Returns

CalendarSocket

Overrides

TypedEventEmitter.constructor

Properties

Property	Modifier	Type	Inherited from	Defined in
listeners	protected	Map<string | symbol, Set<(...args: any[]) => void>>	TypedEventEmitter.listeners	CodeBolt/packages/pluginSdk/src/core/event-emitter.ts:24

Methods

createEvent()

createEvent(event: CreateCalendarEventRequest, requestId?: string): void;

Defined in: CodeBolt/packages/pluginSdk/src/sockets/calendar.socket.ts:105

Parameters

Parameter	Type
event	CreateCalendarEventRequest
requestId?	string

Returns

void

---

deleteEvent()

deleteEvent(eventId: string, requestId?: string): void;

Defined in: CodeBolt/packages/pluginSdk/src/sockets/calendar.socket.ts:111

Parameters

Parameter	Type
eventId	string
requestId?	string

Returns

void

---

emit()

emit<K>(event: K, ...args: Parameters<CalendarSocketEvents[K]>): boolean;

Defined in: CodeBolt/packages/pluginSdk/src/core/event-emitter.ts:54

Type Parameters

Type Parameter
K extends string

Parameters

Parameter	Type
event	K
...args	Parameters<CalendarSocketEvents[K]>

Returns

boolean

Inherited from

TypedEventEmitter.emit

---

getEvent()

getEvent(eventId: string, requestId?: string): void;

Defined in: CodeBolt/packages/pluginSdk/src/sockets/calendar.socket.ts:114

Parameters

Parameter	Type
eventId	string
requestId?	string

Returns

void

---

getStatus()

getStatus(requestId?: string): void;

Defined in: CodeBolt/packages/pluginSdk/src/sockets/calendar.socket.ts:126

Parameters

Parameter	Type
requestId?	string

Returns

void

---

getUpcoming()

getUpcoming(filter?: CalendarFilterOptions, requestId?: string): void;

Defined in: CodeBolt/packages/pluginSdk/src/sockets/calendar.socket.ts:120

Parameters

Parameter	Type
filter?	CalendarFilterOptions
requestId?	string

Returns

void

---

listenerCount()

listenerCount(event: string): number;

Defined in: CodeBolt/packages/pluginSdk/src/core/event-emitter.ts:75

Parameters

Parameter	Type
event	string

Returns

number

Inherited from

TypedEventEmitter.listenerCount

---

listEvents()

listEvents(filter?: CalendarFilterOptions, requestId?: string): void;

Defined in: CodeBolt/packages/pluginSdk/src/sockets/calendar.socket.ts:117

Parameters

Parameter	Type
filter?	CalendarFilterOptions
requestId?	string

Returns

void

---

off()

off<K>(event: K, listener: CalendarSocketEvents[K]): this;

Defined in: CodeBolt/packages/pluginSdk/src/core/event-emitter.ts:35

Type Parameters

Type Parameter
K extends string

Parameters

Parameter	Type
event	K
listener	CalendarSocketEvents[K]

Returns

this

Inherited from

TypedEventEmitter.off

---

on()

on<K>(event: K, listener: CalendarSocketEvents[K]): this;

Defined in: CodeBolt/packages/pluginSdk/src/core/event-emitter.ts:27

Type Parameters

Type Parameter
K extends string

Parameters

Parameter	Type
event	K
listener	CalendarSocketEvents[K]

Returns

this

Inherited from

TypedEventEmitter.on

---

once()

once<K>(event: K, listener: CalendarSocketEvents[K]): this;

Defined in: CodeBolt/packages/pluginSdk/src/core/event-emitter.ts:46

Type Parameters

Type Parameter
K extends string

Parameters

Parameter	Type
event	K
listener	CalendarSocketEvents[K]

Returns

this

Inherited from

TypedEventEmitter.once

---

removeAllListeners()

removeAllListeners(event?: string): this;

Defined in: CodeBolt/packages/pluginSdk/src/core/event-emitter.ts:66

Parameters

Parameter	Type
event?	string

Returns

this

Inherited from

TypedEventEmitter.removeAllListeners

---

rsvp()

rsvp(rsvpData: CalendarRSVPRequest & {
  eventId: string;
}, requestId?: string): void;

Defined in: CodeBolt/packages/pluginSdk/src/sockets/calendar.socket.ts:123

Parameters

Parameter	Type
rsvpData	CalendarRSVPRequest & { eventId: string; }
requestId?	string

Returns

void

---

updateEvent()

updateEvent(event: UpdateCalendarEventRequest & {
  eventId: string;
}, requestId?: string): void;

Defined in: CodeBolt/packages/pluginSdk/src/sockets/calendar.socket.ts:108

Parameters

Parameter	Type
event	UpdateCalendarEventRequest & { eventId: string; }
requestId?	string

Returns

void