Class: CalendarEndpoint

Defined in: endpoints/calendar.ts:17

The single calendar belonging to each server, and the current user's reminders.

Constructors

Constructor

new CalendarEndpoint(client): CalendarEndpoint;

Defined in: endpoints/calendar.ts:18

Parameters

Parameter	Type
client	RESTClient

Returns

CalendarEndpoint

Methods

create()

create(serverId, input): Promise<ICalendarEventResponse>;

Defined in: endpoints/calendar.ts:29

Parameters

Parameter	Type
serverId	number
input	ICreateCalendarEvent

Returns

Promise<ICalendarEventResponse>

---

dismissReminder()

dismissReminder(reminderId): Promise<IApiResponse>;

Defined in: endpoints/calendar.ts:58

Parameters

Parameter	Type
reminderId	number

Returns

Promise<IApiResponse>

---

get()

get(serverId, eventId): Promise<ICalendarEventResponse>;

Defined in: endpoints/calendar.ts:25

Parameters

Parameter	Type
serverId	number
eventId	number

Returns

Promise<ICalendarEventResponse>

---

invitations()

invitations(): Promise<ICalendarInvitationsResponse>;

Defined in: endpoints/calendar.ts:62

Returns

Promise<ICalendarInvitationsResponse>

---

list()

list(serverId, range): Promise<ICalendarEventsResponse>;

Defined in: endpoints/calendar.ts:20

Parameters

Parameter	Type
serverId	number
range	ICalendarRange

Returns

Promise<ICalendarEventsResponse>

---

markInvitationRead()

markInvitationRead(invitationId): Promise<IApiResponse>;

Defined in: endpoints/calendar.ts:73

Parameters

Parameter	Type
invitationId	number

Returns

Promise<IApiResponse>

---

markInvitationsRead()

markInvitationsRead(): Promise<IApiResponse>;

Defined in: endpoints/calendar.ts:77

Returns

Promise<IApiResponse>

---

markSeen()

markSeen(serverId, eventId): Promise<ICalendarUnreadResponse>;

Defined in: endpoints/calendar.ts:45

Parameters

Parameter	Type
serverId	number
eventId	number

Returns

Promise<ICalendarUnreadResponse>

---

pendingReminders()

pendingReminders(): Promise<ICalendarRemindersResponse>;

Defined in: endpoints/calendar.ts:49

Returns

Promise<ICalendarRemindersResponse>

---

remove()

remove(serverId, eventId): Promise<IApiResponse>;

Defined in: endpoints/calendar.ts:37

Parameters

Parameter	Type
serverId	number
eventId	number

Returns

Promise<IApiResponse>

---

respondToInvitation()

respondToInvitation(invitationId, status): Promise<ICalendarInvitationResponse>;

Defined in: endpoints/calendar.ts:66

Parameters

Parameter	Type
invitationId	number
status	"accepted" | "declined" | "tentative"

Returns

Promise<ICalendarInvitationResponse>

---

snoozeReminder()

snoozeReminder(reminderId): Promise<IApiResponse>;

Defined in: endpoints/calendar.ts:54

Remind this attendee again five minutes before the event starts.

Parameters

Parameter	Type
reminderId	number

Returns

Promise<IApiResponse>

---

unread()

unread(serverId): Promise<ICalendarUnreadResponse>;

Defined in: endpoints/calendar.ts:41

Parameters

Parameter	Type
serverId	number

Returns

Promise<ICalendarUnreadResponse>

---

update()

update(
   serverId, 
   eventId, 
   input
): Promise<ICalendarEventResponse>;

Defined in: endpoints/calendar.ts:33

Parameters

Parameter	Type
serverId	number
eventId	number
input	IUpdateCalendarEvent

Returns

Promise<ICalendarEventResponse>