Class CalendarInteractionExtension

Server Level Extension

Hierarchy

BaseInteractionExtension
- CalendarInteractionExtension

Implements

IInteractionExtension

Constructors

`Protected` constructor

new CalendarInteractionExtension(): CalendarInteractionExtension
Returns CalendarInteractionExtension
Overrides BaseInteractionExtension.constructor
- Defined in src/extensions/session-calendar/calendar-command-extension.ts:58

Properties

`Private` buttonMethodMap

buttonMethodMap: {
[buttonName: string]: ButtonCallback;
} = ...

Type declaration

[buttonName: string]: ButtonCallback

`Private` commandMethodMap

commandMethodMap: {
[commandName: string]: CommandCallback;
} = ...

Type declaration

[commandName: string]: CommandCallback

`Private` modalMethodMap

modalMethodMap: {
[modalName: string]: ModalSubmitCallback;
} = ...

Type declaration

[modalName: string]: ModalSubmitCallback

`Static` `Private` helpEmbedsSent

helpEmbedsSent: boolean = false

Accessors

slashCommandData

get slashCommandData(): RESTPostAPIApplicationCommandsJSONBody[]
The command data json to post to the discord server

Returns RESTPostAPIApplicationCommandsJSONBody[]
Implementation of IInteractionExtension.slashCommandData

Overrides BaseInteractionExtension.slashCommandData
- Defined in src/extensions/session-calendar/calendar-command-extension.ts:117

Methods

canHandleButton

canHandleButton(interaction: ButtonInteraction<CacheType>): boolean
Whether the extension can handle buttons
Parameters
- interaction: ButtonInteraction<CacheType>
  
  the button to test
Returns boolean
Implementation of IInteractionExtension.canHandleButton

Overrides BaseInteractionExtension.canHandleButton
- Defined in src/extensions/session-calendar/calendar-command-extension.ts:121

canHandleCommand

canHandleCommand(interaction: ChatInputCommandInteraction<CacheType>): boolean
Whether the extension can handle slash commands.
Parameters
- interaction: ChatInputCommandInteraction<CacheType>
  
  the slash command to test
Returns boolean
Implementation of IInteractionExtension.canHandleCommand

Overrides BaseInteractionExtension.canHandleCommand
- Defined in src/extensions/session-calendar/calendar-command-extension.ts:126

canHandleModalSubmit

canHandleModalSubmit(interaction: ModalSubmitInteraction<CacheType>): boolean
Whether the extension can handle modal submit
Parameters
- interaction: ModalSubmitInteraction<CacheType>
  
  the modal to test
Returns boolean
Implementation of IInteractionExtension.canHandleModalSubmit

Overrides BaseInteractionExtension.canHandleModalSubmit
- Defined in src/extensions/session-calendar/calendar-command-extension.ts:130

`Private` listUpComingHours

listUpComingHours(interaction: ChatInputCommandInteraction<CacheType>): Promise<undefined>
The /when_next command

Builds the embed for /when_next
Parameters
- interaction: ChatInputCommandInteraction<CacheType>
Returns Promise<undefined>
- Defined in src/extensions/session-calendar/calendar-command-extension.ts:254

`Private` makeParsableCalendarTitle

makeParsableCalendarTitle(interaction: ChatInputCommandInteraction<CacheType>, generateAll: boolean): Promise<string>
The /make_calendar_string and /make_calendar_string_all commands

Makes calendar titles for all approved queues
Parameters
- interaction: ChatInputCommandInteraction<CacheType>
- generateAll: boolean
  
  whether to generate string for all the queue roles
Returns Promise<string>
- Defined in src/extensions/session-calendar/calendar-command-extension.ts:278

processButton

processButton(interaction: ButtonInteraction<CacheType>): Promise<void>
Interface to the button processor. If the extension can handle this button, it should reply inside this method
Parameters
- interaction: ButtonInteraction<CacheType>
  
  the button that's guaranteed to be handled by this extension
Returns Promise<void>
Implementation of IInteractionExtension.processButton

Overrides BaseInteractionExtension.processButton
- Defined in src/extensions/session-calendar/calendar-command-extension.ts:166

processCommand

processCommand(interaction: ChatInputCommandInteraction<CacheType>): Promise<void>
Interface to the command processor. If the extension can handle this slash command, it should reply inside this method
Parameters
- interaction: ChatInputCommandInteraction<CacheType>
  
  the slash command that's guaranteed to be handled by this extension
Returns Promise<void>
Implementation of IInteractionExtension.processCommand

Overrides BaseInteractionExtension.processCommand
- Defined in src/extensions/session-calendar/calendar-command-extension.ts:134

processModalSubmit

processModalSubmit(interaction: ModalSubmitInteraction<CacheType>): Promise<void>
Interface to the modal submit processor. If the extension can handle this button, it should reply inside this method
Parameters
- interaction: ModalSubmitInteraction<CacheType>
  
  the modal that's guaranteed to be handled by this extension
Returns Promise<void>
Implementation of IInteractionExtension.processModalSubmit

Inherited from BaseInteractionExtension.processModalSubmit
- Defined in src/extensions/extension-interface.ts:262

`Private` requestCalendarRefresh

requestCalendarRefresh(queueName: string, interaction: ButtonInteraction<CacheType>): Promise<string>
Refreshes the calendar emebed for the specified queue

Returns
Parameters
- queueName: string
- interaction: ButtonInteraction<CacheType>
Returns Promise<string>
- Defined in src/extensions/session-calendar/calendar-command-extension.ts:387

`Private` setPublicEmbedUrl

setPublicEmbedUrl(interaction: ChatInputCommandInteraction<CacheType>): Promise<string>
The /set_public_embd_url command

Sets the public embed url for the server's calendar
Parameters
- interaction: ChatInputCommandInteraction<CacheType>
Returns Promise<string>
- Defined in src/extensions/session-calendar/calendar-command-extension.ts:359

`Private` splitButtonQueueName

splitButtonQueueName(interaction: ButtonInteraction<CacheType>): [string, string]
Seperates the button name and queue name from the button interaction custom id

Returns
[buttonName, queueName]
Parameters
- interaction: ButtonInteraction<CacheType>
Returns [string, string]
- Defined in src/extensions/session-calendar/calendar-command-extension.ts:197

`Private` unsetCalendarId

unsetCalendarId(interaction: ChatInputCommandInteraction<CacheType>): Promise<string>
The /unset_calendar command

Resets the calendar id to default
Parameters
- interaction: ChatInputCommandInteraction<CacheType>
Returns Promise<string>
- Defined in src/extensions/session-calendar/calendar-command-extension.ts:235

`Private` updateCalendarId

updateCalendarId(interaction: ChatInputCommandInteraction<CacheType>): Promise<string>
The /set_calendar [calendar_id] command

Updates the calendar id in the shared calendar extension states
- Triggers the queue level extensions to update
Parameters
- interaction: ChatInputCommandInteraction<CacheType>
Returns Promise<string>
- Defined in src/extensions/session-calendar/calendar-command-extension.ts:210

`Static` load

load(guild: Guild): Promise<CalendarInteractionExtension>
- Initializes the calendar extension using firebase backup if available
- Adds calendar extension slash commands to the server
- Adds calendar extension help messages to respective lists
Returns
CalendarInteractionExtension
Parameters
- guild: Guild
Returns Promise<CalendarInteractionExtension>
- Defined in src/extensions/session-calendar/calendar-command-extension.ts:71

Class CalendarInteractionExtension

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

Protected constructor

Returns CalendarInteractionExtension

Properties

Private buttonMethodMap

Type declaration

[buttonName: string]: ButtonCallback

Private commandMethodMap

Type declaration

[commandName: string]: CommandCallback

Private modalMethodMap

Type declaration

[modalName: string]: ModalSubmitCallback

Static Private helpEmbedsSent

Accessors

slashCommandData

Returns RESTPostAPIApplicationCommandsJSONBody[]

Methods

canHandleButton

Parameters

interaction: ButtonInteraction<CacheType>

Returns boolean

canHandleCommand

Parameters

interaction: ChatInputCommandInteraction<CacheType>

Returns boolean

canHandleModalSubmit

Parameters

interaction: ModalSubmitInteraction<CacheType>

Returns boolean

Private listUpComingHours

Parameters

interaction: ChatInputCommandInteraction<CacheType>

Returns Promise<undefined>

Private makeParsableCalendarTitle

Parameters

interaction: ChatInputCommandInteraction<CacheType>

generateAll: boolean

Returns Promise<string>

processButton

Parameters

interaction: ButtonInteraction<CacheType>

Returns Promise<void>

processCommand

Parameters

interaction: ChatInputCommandInteraction<CacheType>

Returns Promise<void>

processModalSubmit

Parameters

interaction: ModalSubmitInteraction<CacheType>

Returns Promise<void>

Private requestCalendarRefresh

Returns

Parameters

queueName: string

interaction: ButtonInteraction<CacheType>

Returns Promise<string>

Private setPublicEmbedUrl

Parameters

interaction: ChatInputCommandInteraction<CacheType>

Returns Promise<string>

Private splitButtonQueueName

Returns

Parameters

interaction: ButtonInteraction<CacheType>

Returns [string, string]

Private unsetCalendarId

Parameters

interaction: ChatInputCommandInteraction<CacheType>

Returns Promise<string>

Private updateCalendarId

Parameters

`Protected` constructor

`Private` buttonMethodMap

`Private` commandMethodMap

`Private` modalMethodMap

`Static` `Private` helpEmbedsSent

`Private` listUpComingHours

`Private` makeParsableCalendarTitle

`Private` requestCalendarRefresh

`Private` setPublicEmbedUrl

`Private` splitButtonQueueName

`Private` unsetCalendarId

`Private` updateCalendarId

`Static` load