.. _buttonpoll:

==========
ButtonPoll
==========

This is the cog guide for the buttonpoll cog. You will
find detailed docs about usage and commands.

``[p]`` is considered as your prefix.

.. note::

    To use this cog, you will need to install and load it.

    See the :ref:`getting_started` page.

.. _buttonpoll-usage:

-----
Usage
-----

Create polls with buttons, and get a pie chart afterwards!


.. _buttonpoll-commands:

--------
Commands
--------

.. _buttonpoll-command-buttonpoll:

^^^^^^^^^^
buttonpoll
^^^^^^^^^^

.. note:: |mod-lock|

**Syntax**

.. code-block:: none

    [p]buttonpoll [chan]

.. tip:: Aliases: ``poll``, ``bpoll``

**Description**

Start a button-based poll

This is an interactive setup. By default the current channel will be used,
but if you want to start a poll remotely you can send the channel name
along with the buttonpoll command.

**Examples:**
- ``[p]buttonpoll`` - start a poll in the current channel
- ``[p]buttonpoll #polls`` start a poll somewhere else

.. _buttonpoll-command-endpoll:

^^^^^^^
endpoll
^^^^^^^

.. note:: |mod-lock|

**Syntax**

.. code-block:: none

    [p]endpoll <message_id>

.. tip:: Alias: ``endp``

**Description**

End a currently running poll

**Arguments**
- ``message_id``: (integer) The ID of the poll message

.. _buttonpoll-command-getvoters:

^^^^^^^^^
getvoters
^^^^^^^^^

.. note:: |mod-lock|

**Syntax**

.. code-block:: none

    [p]getvoters <message_id>

.. tip:: Alias: ``voters``

**Description**

Fetch the current voters for a running poll

**Arguments**
- ``message_id``: (integer) The ID of the poll message

.. _buttonpoll-command-listpolls:

^^^^^^^^^
listpolls
^^^^^^^^^

.. note:: |mod-lock|

**Syntax**

.. code-block:: none

    [p]listpolls 

**Description**

List all currently running polls