Class BaseServerExtension

Any SERVER extension must inherit from here
Override the events that you want to trigger

Hierarchy

BaseServerExtension

Implements

IServerExtension

Index

Constructors

constructor

Methods

loadExternalServerData onAllQueuesInit onDequeueFirst onHelperStartHelping onHelperStopHelping onServerDelete onServerInitSuccess onServerPeriodicUpdate onServerRequestBackup onStudentJoinVC onStudentLeaveVC

Constructors

constructor

new BaseServerExtension(): BaseServerExtension
Returns BaseServerExtension

Methods

loadExternalServerData

loadExternalServerData(serverId: string): Promise<Optional<ServerBackup>>
When the server asks for external backup data. Called inside AttendingServerV2.create

Returns
Optional backup. If no extension provides backups, start fresh
Parameters
- serverId: string
  
  the guild id
Returns Promise<Optional<ServerBackup>>
Implementation of IServerExtension.loadExternalServerData
- Defined in src/extensions/extension-interface.ts:323

onAllQueuesInit

onAllQueuesInit(server: Readonly<AttendingServerV2>, allQueues: readonly HelpQueueV2[]): Promise<void>
When all the queues are successfully created. Happens before onServerInitSuccess
Parameters
- server: Readonly<AttendingServerV2>
- allQueues: readonly HelpQueueV2[]
Returns Promise<void>
Implementation of IServerExtension.onAllQueuesInit
- Defined in src/extensions/extension-interface.ts:277

onDequeueFirst

onDequeueFirst(server: Readonly<AttendingServerV2>, dequeuedStudent: Readonly<Helpee>): Promise<void>
When a student is dequeued
Parameters
- server: Readonly<AttendingServerV2>
  
  which server is this student from
- dequeuedStudent: Readonly<Helpee>
  
  the newly dequeued student
Returns Promise<void>
Implementation of IServerExtension.onDequeueFirst
- Defined in src/extensions/extension-interface.ts:283

onHelperStartHelping

onHelperStartHelping(server: Readonly<AttendingServerV2>, helper: Readonly<Omit<Helper, "helpEnd">>): Promise<void>
When a helper starts helping. Called after /start
Parameters
- server: Readonly<AttendingServerV2>
  
  which server is this helper from
- helper: Readonly<Omit<Helper, "helpEnd">>
  
  the helper that used start
Returns Promise<void>
Implementation of IServerExtension.onHelperStartHelping
- Defined in src/extensions/extension-interface.ts:289

onHelperStopHelping

onHelperStopHelping(server: Readonly<AttendingServerV2>, helper: Readonly<Required<Helper>>): Promise<void>
When a helper stops helping. Called after /stop
Parameters
- server: Readonly<AttendingServerV2>
  
  which server is this helper from
- helper: Readonly<Required<Helper>>
  
  the helper that used stop
Returns Promise<void>
Implementation of IServerExtension.onHelperStopHelping
- Defined in src/extensions/extension-interface.ts:295

onServerDelete

onServerDelete(server: Readonly<AttendingServerV2>): Promise<void>
When YABOB is kicked from a server. Extensions should override this method to do any necessary cleanup
Parameters
- server: Readonly<AttendingServerV2>
  
  the server that just got deleted
Returns Promise<void>
Implementation of IServerExtension.onServerDelete
- Defined in src/extensions/extension-interface.ts:320

onServerInitSuccess

onServerInitSuccess(server: Readonly<AttendingServerV2>): Promise<void>
When a server instance is successfully created
Parameters
- server: Readonly<AttendingServerV2>
  
  the newly created server
Returns Promise<void>
Implementation of IServerExtension.onServerInitSuccess
- Defined in src/extensions/extension-interface.ts:274

onServerPeriodicUpdate

onServerPeriodicUpdate(server: Readonly<AttendingServerV2>, isFirstCall: boolean): Promise<void>
Called every 15 minutes

Deprecated
will likely be removed in the future
Parameters
- server: Readonly<AttendingServerV2>
  
  the object
- isFirstCall: boolean
  
  whether this is called inside server init
Returns Promise<void>
Implementation of IServerExtension.onServerPeriodicUpdate
- Defined in src/extensions/extension-interface.ts:301

onServerRequestBackup

onServerRequestBackup(server: Readonly<AttendingServerV2>): Promise<void>
When the server requests backups. Currently, only queue related changes will trigger this call
Parameters
- server: Readonly<AttendingServerV2>
  
  the server to backup
Returns Promise<void>
Implementation of IServerExtension.onServerRequestBackup
- Defined in src/extensions/extension-interface.ts:326

onStudentJoinVC

onStudentJoinVC(server: Readonly<AttendingServerV2>, studentMember: GuildMember, voiceChannel: VoiceChannel): Promise<void>
When a student that just dequeued joins the voice channel
Parameters
- server: Readonly<AttendingServerV2>
  
  which server is this student from
- studentMember: GuildMember
  
  the student guild member object
- voiceChannel: VoiceChannel
  
  non-null voice channel
Returns Promise<void>
Implementation of IServerExtension.onStudentJoinVC
- Defined in src/extensions/extension-interface.ts:307

onStudentLeaveVC

onStudentLeaveVC(server: Readonly<AttendingServerV2>, studentMember: GuildMember): Promise<void>
When a student finishes receiving help and leaves the voice channel
Parameters
- server: Readonly<AttendingServerV2>
  
  which server is this student from
- studentMember: GuildMember
  
  the student guild member object
Returns Promise<void>
Implementation of IServerExtension.onStudentLeaveVC
- Defined in src/extensions/extension-interface.ts:314

Class BaseServerExtension

Boilerplate base class of server related extensions.

Hierarchy

Implements

Index

Constructors

Methods

Constructors

constructor

Returns BaseServerExtension

Methods

loadExternalServerData

Returns

Parameters

serverId: string

Returns Promise<Optional<ServerBackup>>

onAllQueuesInit

Parameters

server: Readonly<AttendingServerV2>

allQueues: readonly HelpQueueV2[]

Returns Promise<void>

onDequeueFirst

Parameters

server: Readonly<AttendingServerV2>

dequeuedStudent: Readonly<Helpee>

Returns Promise<void>

onHelperStartHelping

Parameters

server: Readonly<AttendingServerV2>

helper: Readonly<Omit<Helper, "helpEnd">>

Returns Promise<void>

onHelperStopHelping

Parameters

server: Readonly<AttendingServerV2>

helper: Readonly<Required<Helper>>

Returns Promise<void>

onServerDelete

Parameters

server: Readonly<AttendingServerV2>

Returns Promise<void>

onServerInitSuccess

Parameters

server: Readonly<AttendingServerV2>

Returns Promise<void>

onServerPeriodicUpdate

Deprecated

Parameters

server: Readonly<AttendingServerV2>

isFirstCall: boolean

Returns Promise<void>

onServerRequestBackup

Parameters

server: Readonly<AttendingServerV2>

Returns Promise<void>

onStudentJoinVC

Parameters

server: Readonly<AttendingServerV2>

studentMember: GuildMember

voiceChannel: VoiceChannel

Returns Promise<void>

onStudentLeaveVC

Parameters

server: Readonly<AttendingServerV2>

studentMember: GuildMember

Returns Promise<void>

Settings

Member Visibility

Theme