Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Effect Queues UI and API #2223

Merged
merged 11 commits into from
Sep 15, 2023
Merged

Conversation

dennisrijsdijk
Copy link
Collaborator

Description of the Change

Introduce some visual status indicators for Queue status and amount of items (queue length) and context buttons to toggle queue activity and clear queue. Intoduce API for fetching queues, changing queue status and clearing queue.

API

  • GET api/v1/queues

    • returns array of Effect Queues:
      • name (string)
      • mode ("custom" | "auto" | "interval")
      • sortTags (string[])
      • active (boolean)
      • id (string)
      • length (number)
  • GET api/v1/queues/:queueId

    • returns a Detailed Effect Queue if the id matches or 404 if the queue doesn't exist
      • name (string)
      • mode ("custom" | "auto" | "interval")
      • sortTags (string[])
      • active (boolean)
      • id (string)
      • queue (object[])
  • GET/POST api/v1/queues/:queueId/pause

  • GET/POST api/v1/queues/:queueId/resume

  • GET/POST api/v1/queues/:queueId/toggle

    • pauses, resumes or toggles the effect queue. returns a Detailed Effect Queue if the id matches or 404 if the queue doesn't exist
  • GET/POST api/v1/queues/:queueId/clear

    • clears an effect queue. returns a Detailed Effect Queue if the id matches or 404 if the queue doesn't exist

Applicable Issues

#2213
#2214

Testing

Both the UI and API have been manually tested for issues. Including converting old queues, creating new queues, changing settings, changing activity state and clearing queue through effect, API and UI, adding effects to a queue both when paused and active.

Screenshots

  • Effect Queues Table entries (old on top, new below)

firebot-queues-table-change

  • Context Menu (old)

firebot-queues-ctx-menu

  • Context Menu (new)

firebot-queues-ctx-menu-new

@itsjesski itsjesski merged commit e9cd08a into crowbartools:v5 Sep 15, 2023
1 check passed
@dennisrijsdijk dennisrijsdijk deleted the effect-queues branch July 31, 2024 10:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants