Class HelpQueueV2

Class that manages the queue for a specific category

Hierarchy

HelpQueueV2

Constructors

`Protected` constructor

new HelpQueueV2(queueChannel: QueueChannel, queueExtensions: IQueueExtension[], display: QueueDisplayV2, user: User, backupData?: QueueBackup & {
hoursUntilAutoClear: AutoClearTimeout;
seriousModeEnabled: boolean;
}): HelpQueueV2
Parameters
- queueChannel: QueueChannel
  
  the channel to manage
- queueExtensions: IQueueExtension[]
  
  individual queue extensions to inject
- display: QueueDisplayV2
- user: User
  
  YABOB's user object for QueueDisplay
- Optional backupData: QueueBackup & {
  hoursUntilAutoClear: AutoClearTimeout;
  seriousModeEnabled: boolean;
  }
  
  If defined, use this data to restore the students array
Returns HelpQueueV2
- Defined in src/help-queue/help-queue.ts:55

Properties

`Private` _activeHelperIds

_activeHelperIds: Set<string> = ...

`Private` _seriousModeEnabled

_seriousModeEnabled: boolean = false

`Private` _students

_students: Helpee[] = []

The actual queue of students

`Private` _timeUntilAutoClear

_timeUntilAutoClear: AutoClearTimeout = 'AUTO_CLEAR_DISABLED'

When to automatically remove everyone

`Private` `Readonly` display

display: QueueDisplayV2

`Private` notifGroup

notifGroup: Collection<string, GuildMember> = ...

The set of students to notify when queue opens, key is Guildmember.id

`Private` queueChannel

queueChannel: QueueChannel

`Private` queueExtensions

queueExtensions: IQueueExtension[]

timers

timers: Collection<QueueTimerType, Timer | Timeout> = ...

Keeps track of all the setTimout / setIntervals we started

Accessors

activeHelperIds

get activeHelperIds(): ReadonlySet<string>
set of helper IDs. Enforce readonly

Returns ReadonlySet<string>
- Defined in src/help-queue/help-queue.ts:117

channelObj

get channelObj(): Readonly<TextChannel>
#queue text channel object

Returns Readonly<TextChannel>
- Defined in src/help-queue/help-queue.ts:101

first

get first(): Optional<Helpee>
First student; undefined if no one is here

Returns Optional<Helpee>
- Defined in src/help-queue/help-queue.ts:109

isOpen

get isOpen(): boolean
is the queue open

Returns boolean
- Defined in src/help-queue/help-queue.ts:93

length

get length(): number
number of students

Returns number
- Defined in src/help-queue/help-queue.ts:89

parentCategoryId

get parentCategoryId(): string
ChannelId of the parent category

Returns string
- Defined in src/help-queue/help-queue.ts:105

queueName

get queueName(): string
name of corresponding queue

Returns string
- Defined in src/help-queue/help-queue.ts:97

seriousModeEnabled

get seriousModeEnabled(): boolean
The seriousness of the queue

Returns boolean
- Defined in src/help-queue/help-queue.ts:126

students

get students(): readonly Helpee[]
All students

Returns readonly Helpee[]
- Defined in src/help-queue/help-queue.ts:113

timeUntilAutoClear

get timeUntilAutoClear(): AutoClearTimeout
Time until auto clear happens

Returns AutoClearTimeout
- Defined in src/help-queue/help-queue.ts:121

Methods

addToNotifGroup

addToNotifGroup(targetStudent: GuildMember): Promise<void>
Adds a student to the notification group. Used for JoinNotif button
Parameters
- targetStudent: GuildMember
Returns Promise<void>
- Defined in src/help-queue/help-queue.ts:423

clearAllQueueTimers

clearAllQueueTimers(): void
Returns void
- Defined in src/help-queue/help-queue.ts:130

closeQueue

closeQueue(helperMember: GuildMember): Promise<void>
Close a queue with a helper

Throws
QueueError: do nothing if queue is closed
Parameters
- helperMember: GuildMember
  
  member with Staff/Admin that used /stop
Returns Promise<void>
- Defined in src/help-queue/help-queue.ts:257

dequeueWithHelper

dequeueWithHelper(helperMember: GuildMember, targetStudentMember?: GuildMember): Promise<Readonly<Helpee>>
Dequeue this particular queue with a helper

Throws
QueueError when
- Queue is not open
- No student is here
- helperMember is not one of the helpers
- targetStudentMember specified but not in queue
Parameters
- helperMember: GuildMember
  
  the member that triggered dequeue
- Optional targetStudentMember: GuildMember
  
  the student to look for if specified
Returns Promise<Readonly<Helpee>>
- Defined in src/help-queue/help-queue.ts:328

enqueue

enqueue(studentMember: GuildMember): Promise<void>
Enqueue a student

Throws
QueueError
Parameters
- studentMember: GuildMember
  
  the complete Helpee object
Returns Promise<void>
- Defined in src/help-queue/help-queue.ts:280

gracefulDelete

gracefulDelete(): Promise<void>
Queue delete procedure, let the extension process first before getting deleted

Returns Promise<void>
- Defined in src/help-queue/help-queue.ts:444

openQueue

openQueue(helperMember: GuildMember, notify: boolean): Promise<void>
Open a queue with a helper

Throws
QueueError: do nothing if helperMemeber is already helping
Parameters
- helperMember: GuildMember
  
  member with Staff/Admin that used /start
- notify: boolean
  
  whether to notify everyone in the notif group
Returns Promise<void>
- Defined in src/help-queue/help-queue.ts:232

removeAllStudents

removeAllStudents(): Promise<void>
Remove all students from the queue. Used for /clear_all

Returns Promise<void>
- Defined in src/help-queue/help-queue.ts:406

removeFromNotifGroup

removeFromNotifGroup(targetStudent: GuildMember): Promise<void>
Adds a student to the notification group.
- Used for RemoveNotif button
Parameters
- targetStudent: GuildMember
Returns Promise<void>
- Defined in src/help-queue/help-queue.ts:434

removeStudent

removeStudent(targetStudentMember: GuildMember): Promise<Helpee>
Remove a student from the queue. Used for /leave

Throws
QueueError: the student is not in the queue
Parameters
- targetStudentMember: GuildMember
  
  the student to remove
Returns Promise<Helpee>
- Defined in src/help-queue/help-queue.ts:380

setAutoClear

setAutoClear(hours: number, minutes: number, enable: boolean): void
Sets up auto clear parameters
- The timer won't start until autoClearQueue is called
Parameters
- hours: number
  
  clear queue after this many hours
- minutes: number
- enable: boolean
  
  whether to enable auto clear, overrides 'hours'
Returns void
- Defined in src/help-queue/help-queue.ts:141

setSeriousMode

setSeriousMode(seriousMode: boolean): Promise<void>
Parameters
- seriousMode: boolean
Returns Promise<void>
- Defined in src/help-queue/help-queue.ts:478

`Private` startAutoClearTimer

startAutoClearTimer(): void
Starts the timer that will clear all the students after a certain number of hours

Returns void
- Defined in src/help-queue/help-queue.ts:486

triggerRender

triggerRender(): Promise<void>
Re-renders the queue message. Composes the queue view model, then sends it to QueueDisplay

Returns Promise<void>
- Defined in src/help-queue/help-queue.ts:459

updateSeriousMode

updateSeriousMode(seriousModeEnabled: boolean): Promise<void>
Parameters
- seriousModeEnabled: boolean
Returns Promise<void>
- Defined in src/help-queue/help-queue.ts:450

`Static` create

create(queueChannel: QueueChannel, user: User, everyoneRole: Role, backupData?: QueueBackup & {
hoursUntilAutoClear: AutoClearTimeout;
seriousModeEnabled: boolean;
}): Promise<HelpQueueV2>
Asynchronously creates a clean queue
Parameters
- queueChannel: QueueChannel
  
  the corresponding text channel and its name
- user: User
  
  YABOB's client object. Used for queue rendering
- everyoneRole: Role
  
  used for locking the queue
- Optional backupData: QueueBackup & {
  hoursUntilAutoClear: AutoClearTimeout;
  seriousModeEnabled: boolean;
  }
  
  backup queue data directly passed to the constructor
Returns Promise<HelpQueueV2>
- Defined in src/help-queue/help-queue.ts:162

Class HelpQueueV2

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

Protected constructor

Parameters

queueChannel: QueueChannel

queueExtensions: IQueueExtension[]

display: QueueDisplayV2

user: User

Optional backupData: QueueBackup & { hoursUntilAutoClear: AutoClearTimeout; seriousModeEnabled: boolean; }

Returns HelpQueueV2

Properties

Private _activeHelperIds

Private _seriousModeEnabled

Private _students

Private _timeUntilAutoClear

Private Readonly display

Private notifGroup

Private queueChannel

Private queueExtensions

timers

Accessors

activeHelperIds

Returns ReadonlySet<string>

channelObj

Returns Readonly<TextChannel>

first

Returns Optional<Helpee>

isOpen

Returns boolean

length

Returns number

parentCategoryId

Returns string

queueName

Returns string

seriousModeEnabled

Returns boolean

students

Returns readonly Helpee[]

timeUntilAutoClear

Returns AutoClearTimeout

Methods

addToNotifGroup

Parameters

targetStudent: GuildMember

Returns Promise<void>

clearAllQueueTimers

Returns void

closeQueue

Throws

Parameters

helperMember: GuildMember

Returns Promise<void>

dequeueWithHelper

Throws

Parameters

helperMember: GuildMember

Optional targetStudentMember: GuildMember

Returns Promise<Readonly<Helpee>>

enqueue

Throws

Parameters

studentMember: GuildMember

Returns Promise<void>

gracefulDelete

Returns Promise<void>

openQueue

Throws

Parameters

helperMember: GuildMember

notify: boolean

Returns Promise<void>

removeAllStudents

Returns Promise<void>

`Protected` constructor

`Optional` backupData: QueueBackup & {
hoursUntilAutoClear: AutoClearTimeout;
seriousModeEnabled: boolean;
}

`Private` _activeHelperIds

`Private` _seriousModeEnabled

`Private` _students

`Private` _timeUntilAutoClear

`Private` `Readonly` display

`Private` notifGroup

`Private` queueChannel

`Private` queueExtensions

`Optional` targetStudentMember: GuildMember

`Private` startAutoClearTimer

`Static` create

`Optional` backupData: QueueBackup & {
hoursUntilAutoClear: AutoClearTimeout;
seriousModeEnabled: boolean;
}