slack_throttle v0.1.0 SlackThrottle.API
This library provides wrapper functions for the Slack Web API and automatically throttles all requests to it according to API rate limits.
Usage
Look up the API method you want to use in the Slack documentation. Function names are method names with dots replaced by underscores:
# method: channels.info
iex> SlackThrottle.API.channels_info("some token", %{channel: "C123456"})
%{"ok" => true, "channel" => %{"id" => "C123456", ...}}If you don’t care about the response, e.g. when broadcasting a message,
use :cast as the third argument:
# method: chat.postMessage
iex> SlackThrottle.API.chat_postMessage("some token", params, :cast)
:okBroadcasts are executed asynchronously and return :ok immediately.
Rate Limits
The Slack Web API is subject to rate limiting. Requests are only allowed at a rate of one per second on a per-access-token basis.
To comply with these restrictions, the library queues all function calls
(grouped by access token) and executes them at the given rate. These queues
are priority queues: Regular blocking function calls have higher priority than
asynchronous broadcasts (the :cast ones).
Configuration
The API throttle rate :api_throttle can be configured as well as the
timeout for blocking function calls :enqueue_sync_timeout:
config :slack_throttle,
api_throttle: 1000, # in milliseconds
enqueue_sync_timeout: 20000 # in millisecondsSummary
Functions
auth_revoke(token, params \\ %{}, type \\ :call)
auth_revoke(binary, %{optional(atom) => any}, :call | :cast) ::
%{optional(binary) => any} |
:ok
auth_test(token, params \\ %{}, type \\ :call)
auth_test(binary, %{optional(atom) => any}, :call | :cast) ::
%{optional(binary) => any} |
:ok
bots_info(token, params \\ %{}, type \\ :call)
bots_info(binary, %{optional(atom) => any}, :call | :cast) ::
%{optional(binary) => any} |
:ok
channels_archive(token, params \\ %{}, type \\ :call)
channels_archive(binary, %{optional(atom) => any}, :call | :cast) ::
%{optional(binary) => any} |
:ok
channels_close(token, params \\ %{}, type \\ :call)
channels_close(binary, %{optional(atom) => any}, :call | :cast) ::
%{optional(binary) => any} |
:ok
channels_create(token, params \\ %{}, type \\ :call)
channels_create(binary, %{optional(atom) => any}, :call | :cast) ::
%{optional(binary) => any} |
:ok
channels_createChild(token, params \\ %{}, type \\ :call)
channels_createChild(binary, %{optional(atom) => any}, :call | :cast) ::
%{optional(binary) => any} |
:ok
channels_history(token, params \\ %{}, type \\ :call)
channels_history(binary, %{optional(atom) => any}, :call | :cast) ::
%{optional(binary) => any} |
:ok
channels_info(token, params \\ %{}, type \\ :call)
channels_info(binary, %{optional(atom) => any}, :call | :cast) ::
%{optional(binary) => any} |
:ok
channels_invite(token, params \\ %{}, type \\ :call)
channels_invite(binary, %{optional(atom) => any}, :call | :cast) ::
%{optional(binary) => any} |
:ok
channels_kick(token, params \\ %{}, type \\ :call)
channels_kick(binary, %{optional(atom) => any}, :call | :cast) ::
%{optional(binary) => any} |
:ok
channels_leave(token, params \\ %{}, type \\ :call)
channels_leave(binary, %{optional(atom) => any}, :call | :cast) ::
%{optional(binary) => any} |
:ok
channels_list(token, params \\ %{}, type \\ :call)
channels_list(binary, %{optional(atom) => any}, :call | :cast) ::
%{optional(binary) => any} |
:ok
channels_mark(token, params \\ %{}, type \\ :call)
channels_mark(binary, %{optional(atom) => any}, :call | :cast) ::
%{optional(binary) => any} |
:ok
channels_open(token, params \\ %{}, type \\ :call)
channels_open(binary, %{optional(atom) => any}, :call | :cast) ::
%{optional(binary) => any} |
:ok
channels_rename(token, params \\ %{}, type \\ :call)
channels_rename(binary, %{optional(atom) => any}, :call | :cast) ::
%{optional(binary) => any} |
:ok
channels_replies(token, params \\ %{}, type \\ :call)
channels_replies(binary, %{optional(atom) => any}, :call | :cast) ::
%{optional(binary) => any} |
:ok
channels_setPurpose(token, params \\ %{}, type \\ :call)
channels_setPurpose(binary, %{optional(atom) => any}, :call | :cast) ::
%{optional(binary) => any} |
:ok
channels_setTopic(token, params \\ %{}, type \\ :call)
channels_setTopic(binary, %{optional(atom) => any}, :call | :cast) ::
%{optional(binary) => any} |
:ok
channels_unarchive(token, params \\ %{}, type \\ :call)
channels_unarchive(binary, %{optional(atom) => any}, :call | :cast) ::
%{optional(binary) => any} |
:ok
chat_delete(token, params \\ %{}, type \\ :call)
chat_delete(binary, %{optional(atom) => any}, :call | :cast) ::
%{optional(binary) => any} |
:ok
chat_meMessage(token, params \\ %{}, type \\ :call)
chat_meMessage(binary, %{optional(atom) => any}, :call | :cast) ::
%{optional(binary) => any} |
:ok
chat_postMessage(token, params \\ %{}, type \\ :call)
chat_postMessage(binary, %{optional(atom) => any}, :call | :cast) ::
%{optional(binary) => any} |
:ok
chat_update(token, params \\ %{}, type \\ :call)
chat_update(binary, %{optional(atom) => any}, :call | :cast) ::
%{optional(binary) => any} |
:ok
dnd_info(token, params \\ %{}, type \\ :call)
dnd_info(binary, %{optional(atom) => any}, :call | :cast) ::
%{optional(binary) => any} |
:ok
dnd_teamInfo(token, params \\ %{}, type \\ :call)
dnd_teamInfo(binary, %{optional(atom) => any}, :call | :cast) ::
%{optional(binary) => any} |
:ok
emoji_list(token, params \\ %{}, type \\ :call)
emoji_list(binary, %{optional(atom) => any}, :call | :cast) ::
%{optional(binary) => any} |
:ok
files_comments_add(token, params \\ %{}, type \\ :call)
files_comments_add(binary, %{optional(atom) => any}, :call | :cast) ::
%{optional(binary) => any} |
:ok
files_comments_delete(token, params \\ %{}, type \\ :call)
files_comments_delete(binary, %{optional(atom) => any}, :call | :cast) ::
%{optional(binary) => any} |
:ok
files_comments_edit(token, params \\ %{}, type \\ :call)
files_comments_edit(binary, %{optional(atom) => any}, :call | :cast) ::
%{optional(binary) => any} |
:ok
files_delete(token, params \\ %{}, type \\ :call)
files_delete(binary, %{optional(atom) => any}, :call | :cast) ::
%{optional(binary) => any} |
:ok
files_info(token, params \\ %{}, type \\ :call)
files_info(binary, %{optional(atom) => any}, :call | :cast) ::
%{optional(binary) => any} |
:ok
files_list(token, params \\ %{}, type \\ :call)
files_list(binary, %{optional(atom) => any}, :call | :cast) ::
%{optional(binary) => any} |
:ok
files_revokePublicURL(token, params \\ %{}, type \\ :call)
files_revokePublicURL(binary, %{optional(atom) => any}, :call | :cast) ::
%{optional(binary) => any} |
:ok
files_upload(token, params \\ %{}, type \\ :call)
files_upload(binary, %{optional(atom) => any}, :call | :cast) ::
%{optional(binary) => any} |
:ok
groups_archive(token, params \\ %{}, type \\ :call)
groups_archive(binary, %{optional(atom) => any}, :call | :cast) ::
%{optional(binary) => any} |
:ok
groups_close(token, params \\ %{}, type \\ :call)
groups_close(binary, %{optional(atom) => any}, :call | :cast) ::
%{optional(binary) => any} |
:ok
groups_create(token, params \\ %{}, type \\ :call)
groups_create(binary, %{optional(atom) => any}, :call | :cast) ::
%{optional(binary) => any} |
:ok
groups_createChild(token, params \\ %{}, type \\ :call)
groups_createChild(binary, %{optional(atom) => any}, :call | :cast) ::
%{optional(binary) => any} |
:ok
groups_history(token, params \\ %{}, type \\ :call)
groups_history(binary, %{optional(atom) => any}, :call | :cast) ::
%{optional(binary) => any} |
:ok
groups_info(token, params \\ %{}, type \\ :call)
groups_info(binary, %{optional(atom) => any}, :call | :cast) ::
%{optional(binary) => any} |
:ok
groups_invite(token, params \\ %{}, type \\ :call)
groups_invite(binary, %{optional(atom) => any}, :call | :cast) ::
%{optional(binary) => any} |
:ok
groups_kick(token, params \\ %{}, type \\ :call)
groups_kick(binary, %{optional(atom) => any}, :call | :cast) ::
%{optional(binary) => any} |
:ok
groups_leave(token, params \\ %{}, type \\ :call)
groups_leave(binary, %{optional(atom) => any}, :call | :cast) ::
%{optional(binary) => any} |
:ok
groups_list(token, params \\ %{}, type \\ :call)
groups_list(binary, %{optional(atom) => any}, :call | :cast) ::
%{optional(binary) => any} |
:ok
groups_mark(token, params \\ %{}, type \\ :call)
groups_mark(binary, %{optional(atom) => any}, :call | :cast) ::
%{optional(binary) => any} |
:ok
groups_open(token, params \\ %{}, type \\ :call)
groups_open(binary, %{optional(atom) => any}, :call | :cast) ::
%{optional(binary) => any} |
:ok
groups_rename(token, params \\ %{}, type \\ :call)
groups_rename(binary, %{optional(atom) => any}, :call | :cast) ::
%{optional(binary) => any} |
:ok
groups_replies(token, params \\ %{}, type \\ :call)
groups_replies(binary, %{optional(atom) => any}, :call | :cast) ::
%{optional(binary) => any} |
:ok
groups_setPurpose(token, params \\ %{}, type \\ :call)
groups_setPurpose(binary, %{optional(atom) => any}, :call | :cast) ::
%{optional(binary) => any} |
:ok
groups_setTopic(token, params \\ %{}, type \\ :call)
groups_setTopic(binary, %{optional(atom) => any}, :call | :cast) ::
%{optional(binary) => any} |
:ok
groups_unarchive(token, params \\ %{}, type \\ :call)
groups_unarchive(binary, %{optional(atom) => any}, :call | :cast) ::
%{optional(binary) => any} |
:ok
im_close(token, params \\ %{}, type \\ :call)
im_close(binary, %{optional(atom) => any}, :call | :cast) ::
%{optional(binary) => any} |
:ok
im_history(token, params \\ %{}, type \\ :call)
im_history(binary, %{optional(atom) => any}, :call | :cast) ::
%{optional(binary) => any} |
:ok
im_list(token, params \\ %{}, type \\ :call)
im_list(binary, %{optional(atom) => any}, :call | :cast) ::
%{optional(binary) => any} |
:ok
im_mark(token, params \\ %{}, type \\ :call)
im_mark(binary, %{optional(atom) => any}, :call | :cast) ::
%{optional(binary) => any} |
:ok
im_open(token, params \\ %{}, type \\ :call)
im_open(binary, %{optional(atom) => any}, :call | :cast) ::
%{optional(binary) => any} |
:ok
im_replies(token, params \\ %{}, type \\ :call)
im_replies(binary, %{optional(atom) => any}, :call | :cast) ::
%{optional(binary) => any} |
:ok
mpim_close(token, params \\ %{}, type \\ :call)
mpim_close(binary, %{optional(atom) => any}, :call | :cast) ::
%{optional(binary) => any} |
:ok
mpim_history(token, params \\ %{}, type \\ :call)
mpim_history(binary, %{optional(atom) => any}, :call | :cast) ::
%{optional(binary) => any} |
:ok
mpim_list(token, params \\ %{}, type \\ :call)
mpim_list(binary, %{optional(atom) => any}, :call | :cast) ::
%{optional(binary) => any} |
:ok
mpim_mark(token, params \\ %{}, type \\ :call)
mpim_mark(binary, %{optional(atom) => any}, :call | :cast) ::
%{optional(binary) => any} |
:ok
mpim_open(token, params \\ %{}, type \\ :call)
mpim_open(binary, %{optional(atom) => any}, :call | :cast) ::
%{optional(binary) => any} |
:ok
mpim_replies(token, params \\ %{}, type \\ :call)
mpim_replies(binary, %{optional(atom) => any}, :call | :cast) ::
%{optional(binary) => any} |
:ok
pins_add(token, params \\ %{}, type \\ :call)
pins_add(binary, %{optional(atom) => any}, :call | :cast) ::
%{optional(binary) => any} |
:ok
pins_list(token, params \\ %{}, type \\ :call)
pins_list(binary, %{optional(atom) => any}, :call | :cast) ::
%{optional(binary) => any} |
:ok
pins_remove(token, params \\ %{}, type \\ :call)
pins_remove(binary, %{optional(atom) => any}, :call | :cast) ::
%{optional(binary) => any} |
:ok
reactions_add(token, params \\ %{}, type \\ :call)
reactions_add(binary, %{optional(atom) => any}, :call | :cast) ::
%{optional(binary) => any} |
:ok
reactions_get(token, params \\ %{}, type \\ :call)
reactions_get(binary, %{optional(atom) => any}, :call | :cast) ::
%{optional(binary) => any} |
:ok
reactions_list(token, params \\ %{}, type \\ :call)
reactions_list(binary, %{optional(atom) => any}, :call | :cast) ::
%{optional(binary) => any} |
:ok
reactions_remove(token, params \\ %{}, type \\ :call)
reactions_remove(binary, %{optional(atom) => any}, :call | :cast) ::
%{optional(binary) => any} |
:ok
reminders_add(token, params \\ %{}, type \\ :call)
reminders_add(binary, %{optional(atom) => any}, :call | :cast) ::
%{optional(binary) => any} |
:ok
reminders_complete(token, params \\ %{}, type \\ :call)
reminders_complete(binary, %{optional(atom) => any}, :call | :cast) ::
%{optional(binary) => any} |
:ok
reminders_delete(token, params \\ %{}, type \\ :call)
reminders_delete(binary, %{optional(atom) => any}, :call | :cast) ::
%{optional(binary) => any} |
:ok
reminders_info(token, params \\ %{}, type \\ :call)
reminders_info(binary, %{optional(atom) => any}, :call | :cast) ::
%{optional(binary) => any} |
:ok
reminders_list(token, params \\ %{}, type \\ :call)
reminders_list(binary, %{optional(atom) => any}, :call | :cast) ::
%{optional(binary) => any} |
:ok
rtm_start(token, params \\ %{}, type \\ :call)
rtm_start(binary, %{optional(atom) => any}, :call | :cast) ::
%{optional(binary) => any} |
:ok
search_all(token, params \\ %{}, type \\ :call)
search_all(binary, %{optional(atom) => any}, :call | :cast) ::
%{optional(binary) => any} |
:ok
search_files(token, params \\ %{}, type \\ :call)
search_files(binary, %{optional(atom) => any}, :call | :cast) ::
%{optional(binary) => any} |
:ok
search_messages(token, params \\ %{}, type \\ :call)
search_messages(binary, %{optional(atom) => any}, :call | :cast) ::
%{optional(binary) => any} |
:ok
stars_add(token, params \\ %{}, type \\ :call)
stars_add(binary, %{optional(atom) => any}, :call | :cast) ::
%{optional(binary) => any} |
:ok
stars_list(token, params \\ %{}, type \\ :call)
stars_list(binary, %{optional(atom) => any}, :call | :cast) ::
%{optional(binary) => any} |
:ok
stars_remove(token, params \\ %{}, type \\ :call)
stars_remove(binary, %{optional(atom) => any}, :call | :cast) ::
%{optional(binary) => any} |
:ok
team_accessLogs(token, params \\ %{}, type \\ :call)
team_accessLogs(binary, %{optional(atom) => any}, :call | :cast) ::
%{optional(binary) => any} |
:ok
team_billableInfo(token, params \\ %{}, type \\ :call)
team_billableInfo(binary, %{optional(atom) => any}, :call | :cast) ::
%{optional(binary) => any} |
:ok
team_info(token, params \\ %{}, type \\ :call)
team_info(binary, %{optional(atom) => any}, :call | :cast) ::
%{optional(binary) => any} |
:ok
team_integrationLogs(token, params \\ %{}, type \\ :call)
team_integrationLogs(binary, %{optional(atom) => any}, :call | :cast) ::
%{optional(binary) => any} |
:ok
team_profile_get(token, params \\ %{}, type \\ :call)
team_profile_get(binary, %{optional(atom) => any}, :call | :cast) ::
%{optional(binary) => any} |
:ok
usergroups_create(token, params \\ %{}, type \\ :call)
usergroups_create(binary, %{optional(atom) => any}, :call | :cast) ::
%{optional(binary) => any} |
:ok
usergroups_disable(token, params \\ %{}, type \\ :call)
usergroups_disable(binary, %{optional(atom) => any}, :call | :cast) ::
%{optional(binary) => any} |
:ok
usergroups_enable(token, params \\ %{}, type \\ :call)
usergroups_enable(binary, %{optional(atom) => any}, :call | :cast) ::
%{optional(binary) => any} |
:ok
usergroups_list(token, params \\ %{}, type \\ :call)
usergroups_list(binary, %{optional(atom) => any}, :call | :cast) ::
%{optional(binary) => any} |
:ok
usergroups_update(token, params \\ %{}, type \\ :call)
usergroups_update(binary, %{optional(atom) => any}, :call | :cast) ::
%{optional(binary) => any} |
:ok
usergroups_users_list(token, params \\ %{}, type \\ :call)
usergroups_users_list(binary, %{optional(atom) => any}, :call | :cast) ::
%{optional(binary) => any} |
:ok
usergroups_users_update(token, params \\ %{}, type \\ :call)
usergroups_users_update(binary, %{optional(atom) => any}, :call | :cast) ::
%{optional(binary) => any} |
:ok
users_deletePhoto(token, params \\ %{}, type \\ :call)
users_deletePhoto(binary, %{optional(atom) => any}, :call | :cast) ::
%{optional(binary) => any} |
:ok
users_getPresence(token, params \\ %{}, type \\ :call)
users_getPresence(binary, %{optional(atom) => any}, :call | :cast) ::
%{optional(binary) => any} |
:ok
users_identity(token, params \\ %{}, type \\ :call)
users_identity(binary, %{optional(atom) => any}, :call | :cast) ::
%{optional(binary) => any} |
:ok
users_info(token, params \\ %{}, type \\ :call)
users_info(binary, %{optional(atom) => any}, :call | :cast) ::
%{optional(binary) => any} |
:ok
users_list(token, params \\ %{}, type \\ :call)
users_list(binary, %{optional(atom) => any}, :call | :cast) ::
%{optional(binary) => any} |
:ok
users_profile_get(token, params \\ %{}, type \\ :call)
users_profile_get(binary, %{optional(atom) => any}, :call | :cast) ::
%{optional(binary) => any} |
:ok
users_profile_set(token, params \\ %{}, type \\ :call)
users_profile_set(binary, %{optional(atom) => any}, :call | :cast) ::
%{optional(binary) => any} |
:ok
users_setActive(token, params \\ %{}, type \\ :call)
users_setActive(binary, %{optional(atom) => any}, :call | :cast) ::
%{optional(binary) => any} |
:ok
users_setPhoto(token, params \\ %{}, type \\ :call)
users_setPhoto(binary, %{optional(atom) => any}, :call | :cast) ::
%{optional(binary) => any} |
:ok