Class FirebaseServerBackupExtension

Server Level Extension

Hierarchy

BaseServerExtension
- FirebaseServerBackupExtension

Implements

IServerExtension

Index

Constructors

`Private` constructor

new FirebaseServerBackupExtension(firebase_db: Firestore, serverId: string, serverName: string): FirebaseServerBackupExtension
Parameters
- firebase_db: Firestore
- serverId: string
- serverName: string
Returns FirebaseServerBackupExtension
Overrides BaseServerExtension.constructor
- Defined in src/extensions/firebase-backup/firebase-extension.ts:17

Properties

`Private` `Readonly` firebase_db

firebase_db: Firestore

`Private` `Readonly` serverId

serverId: string

`Private` `Readonly` serverName

serverName: string

Methods

`Private` backupServerToFirebase

backupServerToFirebase(server: Readonly<AttendingServerV2>): Promise<void>
Builds the backup data and sends it to firebase

Noexcept
error is logged to the console
Parameters
- server: Readonly<AttendingServerV2>
  
  the server to backup
Returns Promise<void>
- Defined in src/extensions/firebase-backup/firebase-extension.ts:83

loadExternalServerData

loadExternalServerData(serverId: string): Promise<Optional<ServerBackup>>
Gets the backup from firebase If there's no backup for this serverId, return undefined
Parameters
- serverId: string
  
  the server to retrieve backup for. This is the id from Guild.id
Returns Promise<Optional<ServerBackup>>
Implementation of IServerExtension.loadExternalServerData

Overrides BaseServerExtension.loadExternalServerData
- Defined in src/extensions/firebase-backup/firebase-extension.ts:57

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

Inherited from BaseServerExtension.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

Inherited from BaseServerExtension.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

Inherited from BaseServerExtension.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

Inherited from BaseServerExtension.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

Inherited from BaseServerExtension.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

Inherited from BaseServerExtension.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

Inherited from BaseServerExtension.onServerPeriodicUpdate
- Defined in src/extensions/extension-interface.ts:301

onServerRequestBackup

onServerRequestBackup(server: Readonly<AttendingServerV2>): Promise<void>
Saves a backup of the current server state to firebase
Parameters
- server: Readonly<AttendingServerV2>
Returns Promise<void>
Implementation of IServerExtension.onServerRequestBackup

Overrides BaseServerExtension.onServerRequestBackup
- Defined in src/extensions/firebase-backup/firebase-extension.ts:72

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

Inherited from BaseServerExtension.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

Inherited from BaseServerExtension.onStudentLeaveVC
- Defined in src/extensions/extension-interface.ts:314

`Static` load

load(serverName: string, serverId: string): Promise<FirebaseServerBackupExtension>
Returns a new FirebaseServerBackupExtension for the server with the given id and name
- Connects to the firsebase database
Parameters
- serverName: string
- serverId: string
Returns Promise<FirebaseServerBackupExtension>
- Defined in src/extensions/firebase-backup/firebase-extension.ts:32

Class FirebaseServerBackupExtension

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

Private constructor

Parameters

firebase_db: Firestore

serverId: string

serverName: string

Returns FirebaseServerBackupExtension

Properties

Private Readonly firebase_db

Private Readonly serverId

Private Readonly serverName

Methods

Private backupServerToFirebase

Noexcept

Parameters

server: Readonly<AttendingServerV2>

Returns Promise<void>

loadExternalServerData

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>

Static load

Parameters

serverName: string

`Private` constructor

`Private` `Readonly` firebase_db

`Private` `Readonly` serverId

`Private` `Readonly` serverName

`Private` backupServerToFirebase

`Static` load