Class AttendingServerV2

V2 of AttendingServer. Represents 1 server that this YABOB is a member of

Public functions can be accessed by the command handler
Variables with an underscore has a public getter, but only mutable inside the class

Hierarchy

AttendingServerV2

Constructors

`Protected` constructor

new AttendingServerV2(user: User, guild: Guild, serverExtensions: IServerExtension[]): AttendingServerV2
Parameters
- user: User
- guild: Guild
- serverExtensions: IServerExtension[]
Returns AttendingServerV2
- Defined in src/attending-server/base-attending-server.ts:75

Properties

`Private` _activeHelpers

_activeHelpers: Collection<string, Helper> = ...

unique active helpers, key is member.id

`Private` _afterSessionMessage

_afterSessionMessage: string = ''

message sent to students after they leave

`Private` `Optional` _loggingChannel

_loggingChannel?: TextChannel

optional, channel where yabob will log message. if undefined, don't log on the server

`Private` _queues

_queues: Collection<string, HelpQueueV2> = ...

Key is CategoryChannel.id of the parent catgory of #queue

`Readonly` guild

guild: Guild

`Private` queueChannelsCache

queueChannelsCache: QueueChannel[] = []

cached result of getQueueChannels

`Private` `Readonly` serverExtensions

serverExtensions: IServerExtension[]

timers

timers: Collection<"SERVER_PERIODIC_UPDATE", Timer | Timeout> = ...

Keeps track of all the setTimout/setIntervals we started

`Readonly` user

user: User

Accessors

activeHelpers

get activeHelpers(): ReadonlyMap<string, Helper>
Returns ReadonlyMap<string, Helper>
- Defined in src/attending-server/base-attending-server.ts:87

afterSessionMessage

get afterSessionMessage(): string
Returns string
- Defined in src/attending-server/base-attending-server.ts:93

loggingChannel

get loggingChannel(): Optional<TextChannel>
Returns Optional<TextChannel>
- Defined in src/attending-server/base-attending-server.ts:96

queueAutoClearTimeout

get queueAutoClearTimeout(): Optional<AutoClearTimeout>
Returns Optional<AutoClearTimeout>
- Defined in src/attending-server/base-attending-server.ts:90

queues

get queues(): readonly HelpQueueV2[]
Returns readonly HelpQueueV2[]
- Defined in src/attending-server/base-attending-server.ts:81

studentsInAllQueues

get studentsInAllQueues(): readonly Helpee[]
Returns readonly Helpee[]
- Defined in src/attending-server/base-attending-server.ts:84

Methods

addStudentToNotifGroup

addStudentToNotifGroup(studentMember: GuildMember, targetQueue: QueueChannel): Promise<void>
Adds a student to the notification group
Parameters
- studentMember: GuildMember
  
  student to add
- targetQueue: QueueChannel
  
  which notif group to add to
Returns Promise<void>
- Defined in src/attending-server/base-attending-server.ts:699

announceToStudentsInQueue

announceToStudentsInQueue(helperMember: GuildMember, announcement: string, targetQueue?: QueueChannel): Promise<void>
Send an announcement to all the students in the helper's approved queues
Parameters
- helperMember: GuildMember
  
  helper that used /announce
- announcement: string
  
  announcement body
- Optional targetQueue: QueueChannel
  
  optional, specifies which queue to announce to
Returns Promise<void>
- Defined in src/attending-server/base-attending-server.ts:728

cleanUpQueue

cleanUpQueue(targetQueue: QueueChannel): Promise<void>
Cleans up the given queue and resend all embeds
Parameters
- targetQueue: QueueChannel
  
  the queue to clean
Returns Promise<void>
- Defined in src/attending-server/base-attending-server.ts:783

clearAllQueues

clearAllQueues(): Promise<void>
Clear all queues of this server

Remark
separated from clear queue to avoid excessive backup calls

Returns Promise<void>
- Defined in src/attending-server/base-attending-server.ts:687

clearAllServerTimers

clearAllServerTimers(): void
Cleans up all the timers from setInterval

Returns void
- Defined in src/attending-server/base-attending-server.ts:120

clearQueue

clearQueue(targetQueue: QueueChannel): Promise<void>
Clears the given queue
Parameters
- targetQueue: QueueChannel
  
  queue to clear
Returns Promise<void>
- Defined in src/attending-server/base-attending-server.ts:676

closeAllClosableQueues

closeAllClosableQueues(helperMember: GuildMember): Promise<Required<Helper>>
Closes all the queue that the helper has permission to & logs the help time to console

Throws
ServerError: If the helper is not hosting
Parameters
- helperMember: GuildMember
  
  helper that used /stop
Returns Promise<Required<Helper>>
- Defined in src/attending-server/base-attending-server.ts:623

`Private` createClassRoles

createClassRoles(): Promise<void>
Creates roles for all the available queues if not already created

Returns Promise<void>
- Defined in src/attending-server/base-attending-server.ts:998

`Private` createHierarchyRoles

createHierarchyRoles(): Promise<void>
Creates all the command access hierarchy roles

Returns Promise<void>
- Defined in src/attending-server/base-attending-server.ts:958

createQueue

createQueue(newQueueName: string): Promise<void>
Creates a new OH queue

Throws
ServerError: if a queue with the same name already exists
Parameters
- newQueueName: string
  
  name for this class/queue
Returns Promise<void>
- Defined in src/attending-server/base-attending-server.ts:348

deleteQueueById

deleteQueueById(queueCategoryID: string): Promise<void>
Deletes a queue by categoryID

Throws
ServerError: If a discord API failure happened
- #queue existence is checked by CentralCommandHandler
Parameters
- queueCategoryID: string
  
  CategoryChannel.id of the target queue
Returns Promise<void>
- Defined in src/attending-server/base-attending-server.ts:381

dequeueGlobalFirst

dequeueGlobalFirst(helperMember: GuildMember): Promise<Readonly<Helpee>>
Dequeue the student that has been waiting for the longest

Throws
- ServerError: if specificQueue is given but helper doesn't have the role
- QueueError: if the queue to dequeue from rejects
Parameters
- helperMember: GuildMember
  the helper that used /next
  - ignored if specified queue is undefined
Returns Promise<Readonly<Helpee>>
- Defined in src/attending-server/base-attending-server.ts:432

dequeueWithArgs

dequeueWithArgs(helperMember: GuildMember, targetStudentMember?: GuildMember, specificQueue?: QueueChannel): Promise<Readonly<Helpee>>
Handle /next with arguments
Parameters
- helperMember: GuildMember
- Optional targetStudentMember: GuildMember
  
  if specified, remove this student and override queue order
- Optional specificQueue: QueueChannel
  
  if specified, dequeue from this queue
Returns Promise<Readonly<Helpee>>
- Defined in src/attending-server/base-attending-server.ts:497

enqueueStudent

enqueueStudent(studentMember: GuildMember, queue: QueueChannel): Promise<void>
Attempt to enqueue a student

Throws
QueueError: if
Parameters
- studentMember: GuildMember
  
  student member to enqueue
- queue: QueueChannel
  
  target queue
Returns Promise<void>
- Defined in src/attending-server/base-attending-server.ts:417

getQueueChannels

getQueueChannels(useCache?: boolean): Promise<QueueChannel[]>
Gets all the queue channels on the server. SLOW if nothing is found, returns empty array
Parameters
- useCache: boolean = true
  whether to read from existing cache, defaults to true
  - unless queues change often, prefer cache for fast response
Returns Promise<QueueChannel[]>
- Defined in src/attending-server/base-attending-server.ts:303

gracefulDelete

gracefulDelete(): Promise<void>
Called when leaving a server
- let all the extensions clean up their own memory
Returns Promise<void>
- Defined in src/attending-server/base-attending-server.ts:883

`Private` initAllQueues

initAllQueues(queueBackups?: QueueBackup[], hoursUntilAutoClear?: AutoClearTimeout, seriousModeEnabled?: boolean): Promise<void>
Creates all the office hour queues
Parameters
- Optional queueBackups: QueueBackup[]
  
  if a backup extension is enabled, this is the queue data to load
- hoursUntilAutoClear: AutoClearTimeout = 'AUTO_CLEAR_DISABLED'
- seriousModeEnabled: boolean = false
Returns Promise<void>
- Defined in src/attending-server/base-attending-server.ts:912

onMemberJoinVC

onMemberJoinVC(member: GuildMember, newVoiceState: WithRequired<VoiceState, "channel">): Promise<void>
Called when a member joins a voice channel
- triggers onStudentJoinVC for all extensions if the member is a student and was just removed from the queue
Parameters
- member: GuildMember
- newVoiceState: WithRequired<VoiceState, "channel">
Returns Promise<void>
- Defined in src/attending-server/base-attending-server.ts:242

onMemberLeaveVC

onMemberLeaveVC(member: GuildMember, oldVoiceState: WithRequired<VoiceState, "channel">): Promise<void>
Called when a member leaves a voice channel
- triggers onStudentLeaveVC for all extensions if the member is a student and was in a session
Parameters
- member: GuildMember
- oldVoiceState: WithRequired<VoiceState, "channel">
Returns Promise<void>
- Defined in src/attending-server/base-attending-server.ts:273

openAllOpenableQueues

openAllOpenableQueues(helperMember: GuildMember, notify: boolean): Promise<void>
Opens all the queue that the helper has permission to

Throws
ServerError
- If the helper doesn't have any class roles
- If the helper is already hosting
Parameters
- helperMember: GuildMember
  
  helper that used /start
- notify: boolean
Returns Promise<void>
- Defined in src/attending-server/base-attending-server.ts:589

removeStudentFromNotifGroup

removeStudentFromNotifGroup(studentMember: GuildMember, targetQueue: QueueChannel): Promise<void>
Removes a student from the notification group
Parameters
- studentMember: GuildMember
  
  student to add
- targetQueue: QueueChannel
  
  which notif group to remove from
Returns Promise<void>
- Defined in src/attending-server/base-attending-server.ts:713

removeStudentFromQueue

removeStudentFromQueue(studentMember: GuildMember, targetQueue: QueueChannel): Promise<void>
Removes a student from a given queue

Throws
QueueError: if
Parameters
- studentMember: GuildMember
  
  student that used /leave or the cleave button
- targetQueue: QueueChannel
  
  the queue to leave from
Returns Promise<void>
- Defined in src/attending-server/base-attending-server.ts:660

`Private` sendCommandHelpChannelMessages

sendCommandHelpChannelMessages(helpCategories: CategoryChannel[], messageContents: {
    channelName: string;
    file: HelpMessage[];
    visibility: string[];
}[]): Promise<void>
Overwrites the existing command help channel and send new help messages
Parameters
- helpCategories: CategoryChannel[]
  
  the category named 'Bot Commands Help'
- messageContents: {
      channelName: string;
      file: HelpMessage[];
      visibility: string[];
  }[]
  
  array of embeds to send to each help channel
Returns Promise<void>
- Defined in src/attending-server/base-attending-server.ts:1018

sendLogMessage

sendLogMessage(message: string | BaseMessageOptions): Promise<void>
Parameters
- message: string | BaseMessageOptions
Returns Promise<void>
- Defined in src/attending-server/base-attending-server.ts:901

setAfterSessionMessage

setAfterSessionMessage(newMessage: string): Promise<void>
Sets the after sesseion message for this server
Parameters
- newMessage: string
  after session message to set
  - Side Effect: Triggers a firebase backup
Returns Promise<void>
- Defined in src/attending-server/base-attending-server.ts:792

setLoggingChannel

setLoggingChannel(loggingChannel?: TextChannel): Promise<void>
Sets the logging channel for this server
Parameters
- Optional loggingChannel: TextChannel
  the new logging channel.
  - If undefined, disables logging for this server
Returns Promise<void>
- Defined in src/attending-server/base-attending-server.ts:894

setQueueAutoClear

setQueueAutoClear(hours: number, minutes: number, enable: boolean): Promise<void>
Sets up queue auto clear for this server
Parameters
- hours: number
  
  the number of hours to wait before clearing the queue
- minutes: number
  
  the number of minutes to wait before clearing the queue
- enable: boolean
  
  whether to disable auto clear, overrides 'hours'
Returns Promise<void>
- Defined in src/attending-server/base-attending-server.ts:806

setSeriousServer

setSeriousServer(enableSeriousMode: boolean): Promise<boolean>
Sets the serious server flag, and updates the queues if changing from serious to not serious, or vice versa

Returns
True if triggered renders for all queues
Parameters
- enableSeriousMode: boolean
  
  new value for seriousServer
Returns Promise<boolean>
- Defined in src/attending-server/base-attending-server.ts:105

updateCommandHelpChannels

updateCommandHelpChannels(): Promise<void>
Updates the help channel messages Removes all messages in the help channel and posts new ones

Returns Promise<void>
- Defined in src/attending-server/base-attending-server.ts:821

`Static` create

create(user: User, guild: Guild): Promise<AttendingServerV2>
Asynchronously creates a YABOB instance for 1 server

Returns
a created instance of YABOB

Throws
ServerError
Parameters
- user: User
  
  discord client user
- guild: Guild
  
  the server for YABOB to join
Returns Promise<AttendingServerV2>
- Defined in src/attending-server/base-attending-server.ts:133

Class AttendingServerV2

V2 of AttendingServer. Represents 1 server that this YABOB is a member of

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

Protected constructor

Parameters

user: User

guild: Guild

serverExtensions: IServerExtension[]

Returns AttendingServerV2

Properties

Private _activeHelpers

Private _afterSessionMessage

Private Optional _loggingChannel

Private _queues

Readonly guild

Private queueChannelsCache

Private Readonly serverExtensions

timers

Readonly user

Accessors

activeHelpers

Returns ReadonlyMap<string, Helper>

afterSessionMessage

Returns string

loggingChannel

Returns Optional<TextChannel>

queueAutoClearTimeout

Returns Optional<AutoClearTimeout>

queues

Returns readonly HelpQueueV2[]

studentsInAllQueues

Returns readonly Helpee[]

Methods

addStudentToNotifGroup

Parameters

studentMember: GuildMember

targetQueue: QueueChannel

Returns Promise<void>

announceToStudentsInQueue

Parameters

helperMember: GuildMember

announcement: string

Optional targetQueue: QueueChannel

Returns Promise<void>

cleanUpQueue

Parameters

targetQueue: QueueChannel

Returns Promise<void>

clearAllQueues

Remark

Returns Promise<void>

clearAllServerTimers

Returns void

clearQueue

Parameters

targetQueue: QueueChannel

Returns Promise<void>

closeAllClosableQueues

Throws

Parameters

helperMember: GuildMember

Returns Promise<Required<Helper>>

Private createClassRoles

Returns Promise<void>

Private createHierarchyRoles

Returns Promise<void>

createQueue

Throws

Parameters

newQueueName: string

Returns Promise<void>

deleteQueueById

Throws

Parameters

`Protected` constructor

`Private` _activeHelpers

`Private` _afterSessionMessage

`Private` `Optional` _loggingChannel

`Private` _queues

`Readonly` guild

`Private` queueChannelsCache

`Private` `Readonly` serverExtensions

`Readonly` user

`Optional` targetQueue: QueueChannel

`Private` createClassRoles

`Private` createHierarchyRoles

`Optional` targetStudentMember: GuildMember

`Optional` specificQueue: QueueChannel

`Private` initAllQueues

`Optional` queueBackups: QueueBackup[]

`Private` sendCommandHelpChannelMessages

messageContents: {
channelName: string;
file: HelpMessage[];
visibility: string[];
}[]