strawpoll-client.core

Liking cljdoc? Tell your friends :D

Clojure only.

->client
->poll-id
create-poll!
delete-poll!
get-poll-results!

Basic functions to interact with Strawpoll

Basic functions to interact with [Strawpoll](https://strawpoll.com/en/api-docs/)

raw docstring

->client^cljdeprecated

(->client {:keys [clj-http-opts] :as opts})

Create a client, which is the required first argument to create-poll!, get-poll-results!, and delete-poll!. This function expects an option map, with the following key sets:

:api-key - The Strawpoll API key for your project. If this key is missing, the library will attempt to load the Environment variable STRAWPOLL_API_KEY and the JVM Property StrawPollApiKey in this order. If all three values are nil, an exception will be thrown. More information is available on Strawpoll All remaining keys will be passed to the underlying clj-http request function

Create a client, which is the required first argument to `create-poll!`, `get-poll-results!`, and `delete-poll!`.
This function expects an option map, with the following key sets:
  - :api-key - The Strawpoll API key for your project.
               If this key is missing, the library will attempt to load the Environment variable `STRAWPOLL_API_KEY` and the JVM Property `StrawPollApiKey` in this order.
               If all three values are nil, an exception will be thrown.
               More information is available [on Strawpoll](https://strawpoll.com/en/api-docs/authentication/)
All remaining keys will be passed to the underlying [clj-http request function](https://github.com/dakrone/clj-http)

source raw docstring

->poll-id^cljdeprecated

(->poll-id create-poll!-response)

A convenience function to extract the identifier of a poll from the return value of strawpoll-client.core/create-poll!

A convenience function to extract the identifier of a poll from the return value of `strawpoll-client.core/create-poll!`

source raw docstring

create-poll!^cljdeprecated

(create-poll! client title answers)

(create-poll! {:keys [api-key clj-http-opts]}
              title
              answers
              {:keys [public? disallow-comments? multiple-answers?
                      multiple-votes-per-ip? name-required? deadline
                      only-registered-users? allow-vpn-users? no-captcha?]})

Create a poll using the provided client titled title with answers. client is expected to be the return value of strawpoll-client.core/->client title is a string representing the title of the poll you wish to create. answers is a sequence of strings representing the poll options user will be able to pick from. Implements all features described in the API Documentation

This behavior may be tuned with an additional argument as an option map with the following keys:

:public? - A boolean to determine wether or not the poll will be publicly listed. Defaults to falsey
:disallow-comments? - A boolean to disable commenting on polls. Defaults to falsey
:multiple-answers? - A boolean to indicate wether each voter is allowed to vote on multiple options. Defaults to falsey
:multiple-votes-per-ip? - A boolean to indicate if multiple votes may be recorded from a single IP address. Defaults to falsey
:name-required? - A boolean to indicate if users must enter a name while voting. Defaults to falsey
:deadline - An ISO-8601 Datetime in Zulu Timezone past when the poll will close. Defaults to nil, ergo no closing date will be set
:only-registered-users? - A boolean to indicate if users will be required to have an account with strawpoll.com in order to vote. Defaults to falsey
:allow-vpn-users? - A boolean to indicate if users behind a VPN will be allowed to vote. Defaults to falsey
:no-captcha? - A boolean indicating if voting in the poll will not require solving a captcha. Defaults to falsey, meaning users will have to complete this step

Create a poll using the provided `client` titled `title` with `answers`.
`client` is expected to be the return value of `strawpoll-client.core/->client`
`title` is a string representing the title of the poll you wish to create.
`answers` is a sequence of strings representing the poll options user will be able to pick from.
Implements all features described in the [API Documentation](https://strawpoll.com/en/api-docs/create-poll/)

This behavior may be tuned with an additional argument as an option map with the following keys:
- `:public?` - A boolean to determine wether or not the poll will be publicly listed. Defaults to falsey
- `:disallow-comments?` - A boolean to disable commenting on polls. Defaults to falsey
- `:multiple-answers?` - A boolean to indicate wether each voter is allowed to vote on multiple options. Defaults to falsey
- `:multiple-votes-per-ip?` - A boolean to indicate if multiple votes may be recorded from a single IP address. Defaults to falsey
- `:name-required?` - A boolean to indicate if users must enter a name while voting. Defaults to falsey
- `:deadline` - An ISO-8601 Datetime in Zulu Timezone past when the poll will close. Defaults to nil, ergo no closing date will be set
- `:only-registered-users?` - A boolean to indicate if users will be required to have an account with strawpoll.com in order to vote. Defaults to falsey
- `:allow-vpn-users?` - A boolean to indicate if users behind a VPN will be allowed to vote. Defaults to falsey
- `:no-captcha?` - A boolean indicating if voting in the poll will not require solving a captcha. Defaults to falsey, meaning users will have to complete this step

source raw docstring

delete-poll!^cljdeprecated

(delete-poll! {:keys [api-key clj-http-opts]} poll-id)

Permanently delete poll-id using the provided client. The poll-id is encoded in the response of strawpoll-client.core/create-poll! as content_id, which may be retreived by strawpoll-client.core/->poll-id

Permanently delete `poll-id` using the provided client.
The poll-id is encoded in the response of `strawpoll-client.core/create-poll!` as `content_id`, which may be retreived by `strawpoll-client.core/->poll-id`

source raw docstring

get-poll-results!^cljdeprecated

(get-poll-results! {:keys [api-key clj-http-opts]} poll-id)

Get the current results of poll-id using the provided client. The poll-id is encoded in the response of strawpoll-client.core/create-poll! as content_id, which may be retreived by strawpoll-client.core/->poll-id

Get the current results of `poll-id` using the provided client.
The poll-id is encoded in the response of `strawpoll-client.core/create-poll!` as `content_id`, which may be retreived by `strawpoll-client.core/->poll-id`

source raw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

Keyboard shortcuts Report a problem cljdoc on GitHub

× close