Skip to content

User Guide

Jump to bottom
harishoke edited this page Jun 1, 2025 · 1 revision

PollMasters User Guide

This guide will walk you through using the PollMasters application, from connecting to WhatsApp to sending polls and viewing results.

1. Initial Setup & Connection

Before you start: Ensure both the Backend Server and the Frontend GUI are running as described in the Setup and Installation guide.

  1. Open the GUI: The PollMasters application window will appear.
  2. Connection Tab: The application usually opens to the "Connection" tab.
  3. QR Code Scan:
    • If this is your first time running the application or if you've logged out, the backend will generate a QR code. This QR code will be displayed in the "QR Code Area" on the "Connection" tab of the GUI. It might also be printed in the Node.js backend terminal.
    • Open WhatsApp on your mobile phone.
    • Go to Settings > Linked Devices > Link a device.
    • Scan the QR code displayed in the PollMasters GUI.
  4. Connection Status:
    • Once the QR code is scanned successfully, the backend will establish a connection with WhatsApp.
    • The status label at the bottom of the GUI will update, eventually showing: "Status: WhatsApp Client is READY!" in green. The QR code display area will also indicate readiness.

2. Sending a Poll

Once the WhatsApp client is ready:

  1. Navigate to Poll Sender Tab: Click on the "Poll Sender" tab in the GUI.
  2. Refresh Chats (Important):
    • Click the "Refresh Chats" button (found on the "Connection" tab or potentially added to the Sender tab). This fetches your latest chat and group list from WhatsApp.
    • The "Select Chats/Groups for Poll" listbox will populate.
  3. Select Recipients:
    • From the listbox, select one or more chats/groups to send the poll to. You can use Ctrl+Click (or Cmd+Click on Mac) for multiple selections.
  4. Compose Poll Question:
    • In the "Poll Question" field, type your poll question.
  5. Add Poll Options:
    • Type an option in the "Poll Options" entry field and click "Add". Repeat for each option. WhatsApp supports 1 to 12 options.
    • You can "Edit", "Delete", or "Clear All" options using the respective buttons.
  6. Allow Multiple Answers (Optional):
    • Check the "Allow multiple answers" box if you want participants to be able to select more than one option. If unchecked, it's a single-choice poll.
  7. Adjust Anti-Ban Delay (Optional):
    • Modify the "Min (s)" and "Max (s)" delay values if sending to many chats. This sets a random delay between sending messages to different chats. Default is 2.0-4.0 seconds.
  8. Send the Poll:
    • Click the "Send Poll to Selected Chats" button.
    • A confirmation dialog will appear. Click "Yes" to proceed.
    • The status label will show the sending progress.

3. Viewing Poll Results

  1. Navigate to Poll Results Tab: Click on the "Poll Results" tab.
  2. Poll List:
    • This tab lists polls that have been sent or received updates during the current server session. They are typically listed with the newest first.
    • Click the "Refresh Poll List & Results" button to fetch the latest poll data from the server (especially useful if the GUI was restarted or if you want to ensure you have the latest).
  3. View Details:
    • Select a poll from the list.
    • The area below ("Selected Poll Details & Results") will display:
      • Poll Question
      • Message ID
      • Timestamp when it was sent
      • Whether multiple answers are allowed
      • A breakdown of each option with its current vote count and percentage.
      • Total unique voters who participated.
    • Results should update automatically as new votes come in, as long as the GUI is connected to the backend.

4. Using Poll Templates

Poll templates allow you to save and quickly reuse poll questions and options.

  1. Creating/Saving a Template:
    • In the "Poll Sender" tab, set up your desired poll question and options.
    • Click the "Save Current" button in the "Poll Templates" section.
    • Enter a name for your template when prompted and click "OK".
    • The template is saved to poll_templates.json in the project's root directory.
  2. Loading a Template:
    • Select a saved template from the dropdown menu in the "Poll Templates" section.
    • The poll question and options fields will automatically populate with the template's content.
  3. Deleting a Template:
    • Select the template you wish to delete from the dropdown menu.
    • Click the "Delete Selected" button.
    • Confirm the deletion.

5. Logging Out

  1. Navigate to Connection Tab: Go to the "Connection" tab.
  2. Logout: Click the "Logout & Clear Session" button.
  3. Confirm: A dialog will ask for confirmation.
    • This action logs the current WhatsApp account out from the backend server and attempts to delete the baileys_auth_info session folder on the server.
    • The GUI will update to show a disconnected status. You might need to restart the Node.js server to be able to scan a new QR code for a new account.

Clone this wiki locally