Skip to content

Commit ad2338b

Browse files
committed
Add documentation for polls
Closes #1885
1 parent c237f98 commit ad2338b

File tree

1 file changed

+83
-0
lines changed

1 file changed

+83
-0
lines changed

man/signal-cli.1.adoc

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -385,6 +385,89 @@ Clear session state and send end session message.
385385
*--edit-timestamp*::
386386
Specify the timestamp of a previous message with the recipient or group to send an edited message.
387387

388+
=== sendPollCreate
389+
390+
Send a poll create message to another user or group.
391+
392+
RECIPIENT::
393+
Specify the recipients.
394+
395+
*--note-to-self*::
396+
Send the message to self.
397+
398+
*--notify-self*::
399+
If self is part of recipients/groups send a normal message, not a sync message.
400+
401+
*-g* GROUP, *--group-id* GROUP::
402+
Specify the recipient group ID in base64 encoding.
403+
404+
*-u* USERNAME, *--username* USERNAME::
405+
Specify the recipient username or username link.
406+
407+
*-q* QUESTION, *--question* QUESTION::
408+
Specify the poll question.
409+
410+
*--no-multi*::
411+
Allow only one option to be selected by each recipient.
412+
By default, recipients can select multiple options.
413+
414+
*-o* OPTION [OPTION ...], *--option* OPTION [OPTION ...]*::
415+
The options for the poll.
416+
417+
=== sendPollVote
418+
419+
Send a poll vote message to another user or group, to vote on a previously created vote.
420+
421+
RECIPIENT::
422+
Specify the recipients.
423+
424+
*--note-to-self*::
425+
Send the message to self.
426+
427+
*--notify-self*::
428+
If self is part of recipients/groups send a normal message, not a sync message.
429+
430+
*-g* GROUP, *--group-id* GROUP::
431+
Specify the recipient group ID in base64 encoding.
432+
433+
*-u* USERNAME, *--username* USERNAME::
434+
Specify the recipient username or username link.
435+
436+
*--poll-author* POLL_AUTHOR::
437+
Specify the number or uuid of the author of the poll message.
438+
439+
*--poll-timestamp* POLL_TIMESTAMP::
440+
Specify the timestamp of the original poll create message.
441+
442+
*-o* [OPTION [OPTION ...]], *--option* [OPTION [OPTION ...]]::
443+
The option indexes of the poll to vote for.
444+
For none multi polls, only one option may be specified.
445+
446+
*--vote-count: VOTE_COUNT::
447+
Specify the number of this vote (increase by one for every time you vote).
448+
449+
=== sendPollTerminate
450+
451+
Send a poll terminate message to another user or group, to close on a previously created vote.
452+
453+
RECIPIENT::
454+
Specify the recipients.
455+
456+
*--note-to-self*::
457+
Send the message to self.
458+
459+
*--notify-self*::
460+
If self is part of recipients/groups send a normal message, not a sync message.
461+
462+
*-g* GROUP, *--group-id* GROUP::
463+
Specify the recipient group ID in base64 encoding.
464+
465+
*-u* USERNAME, *--username* USERNAME::
466+
Specify the recipient username or username link.
467+
468+
*--poll-timestamp* POLL_TIMESTAMP::
469+
Specify the timestamp of the original poll create message.
470+
388471
=== sendMessageRequestResponse
389472

390473
Send response to a message request to linked devices.

0 commit comments

Comments
 (0)