Skip to content

Polls docs grammar pass #2964

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Jul 21, 2024
Merged

Polls docs grammar pass #2964

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions docs/guides/polls/polls.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,26 +21,26 @@ A poll is part of a message; to send one you need to pass a [PollProperties] obj
[!code-csharp[Creating polls](samples/create-poll.cs)]

> [!WARNING]
> Due to limitations of the Discord API it's not possible to send attachments in a messages with a poll.
> Due to limitations set by the Discord API, it's not possible to send both an attachment and a poll in the same message.

> [!NOTE]
> It is not possible to modify polls after them being created.
> It is not possible to modify polls after they are created.


## Managing polls

### Ending polls
You can expire polls early by calling `EndPollAsync` on an [IUserMessage] with a poll.
You can end a poll early by calling `EndPollAsync` on an [IUserMessage] that has a poll.

[!code-csharp[Ending polls](samples/end-poll.cs)]

### Getting poll answer voters
### Getting a poll answer's voters
To get voters for a specific answer call `GetPollAnswerVotersAsync(answerId)` on an [IUserMessage] with a poll.

[!code-csharp[Getting poll answer voters](samples/get-poll-voters.cs)]

### Retrieving poll results
You can get results of a poll by simply getting an [IUserMessage] and checking the `IUserMessage.Poll.Results` property. Alteratively you can check the results on a `MessageUpdated` gateway event.
You can get results of a poll by simply getting an [IUserMessage] and checking the `IUserMessage.Poll.Results` property. Alternatively, you can check the results on a `MessageUpdated` gateway event.


## Gateway events
Expand All @@ -51,11 +51,11 @@ You can receive information about poll votes live using following events:
- `PollVoteRemoved`

> [!NOTE]
> These events are only sent if the client has `GatewayIntents.GuildMessagePolls` or `GatewayIntents.DirectMessagePolls` intents enabled. It will receive events for polls in guild or dm channels respectively.
> These events are only sent if the client has the `GatewayIntents.GuildMessagePolls` or `GatewayIntents.DirectMessagePolls` intents enabled. It will receive events for polls in guild or DM channels respectively.

### Poll expiry
On poll expiry the `MessageUpdated` event is fired.


[PollProperties]: xref:Discord.PollProperties
[IUserMessage]: xref:Discord.IUserMessage
[IUserMessage]: xref:Discord.IUserMessage