slack_web_api v1.2.1 SlackWebAPI.Api.Reminders
API calls for all endpoints tagged Reminders
.
Link to this section Summary
Functions
Creates a reminder.
Marks a reminder as complete.
Deletes a reminder.
Gets information about a reminder.
Lists all reminders created by or for a given user.
Link to this section Functions
reminders_add(connection, opts \\ [])
reminders_add(Tesla.Env.client(), keyword()) :: {:ok, map()} | {:error, Tesla.Env.t()}
Creates a reminder.
Parameters
- connection (SlackWebAPI.Connection): Connection to server
opts (KeywordList): [optional] Optional parameters
- :token (String.t): Authentication token. Requires scope:
reminders:write
- :text (String.t): The content of the reminder
- :user (String.t): The user who will receive the reminder. If no user is specified, the reminder will go to user who created it.
- :time (String.t): When this reminder should happen: the Unix timestamp (up to five years from now), the number of seconds until the reminder (if within 24 hours), or a natural language description (Ex. \"in 15 minutes,\" or \"every Thursday\")
- :token (String.t): Authentication token. Requires scope:
Returns
{:ok, %{}} on success {:error, info} on failure
reminders_complete(connection, opts \\ [])
reminders_complete(Tesla.Env.client(), keyword()) :: {:ok, map()} | {:error, Tesla.Env.t()}
Marks a reminder as complete.
Parameters
- connection (SlackWebAPI.Connection): Connection to server
opts (KeywordList): [optional] Optional parameters
- :token (String.t): Authentication token. Requires scope:
reminders:write
- :reminder (String.t): The ID of the reminder to be marked as complete
- :token (String.t): Authentication token. Requires scope:
Returns
{:ok, %{}} on success {:error, info} on failure
reminders_delete(connection, opts \\ [])
reminders_delete(Tesla.Env.client(), keyword()) :: {:ok, map()} | {:error, Tesla.Env.t()}
Deletes a reminder.
Parameters
- connection (SlackWebAPI.Connection): Connection to server
opts (KeywordList): [optional] Optional parameters
- :token (String.t): Authentication token. Requires scope:
reminders:write
- :reminder (String.t): The ID of the reminder
- :token (String.t): Authentication token. Requires scope:
Returns
{:ok, %{}} on success {:error, info} on failure
reminders_info(connection, opts \\ [])
reminders_info(Tesla.Env.client(), keyword()) :: {:ok, map()} | {:error, Tesla.Env.t()}
Gets information about a reminder.
Parameters
- connection (SlackWebAPI.Connection): Connection to server
opts (KeywordList): [optional] Optional parameters
- :token (String.t): Authentication token. Requires scope:
reminders:read
- :reminder (String.t): The ID of the reminder
- :token (String.t): Authentication token. Requires scope:
Returns
{:ok, %{}} on success {:error, info} on failure
reminders_list(connection, opts \\ [])
reminders_list(Tesla.Env.client(), keyword()) :: {:ok, map()} | {:error, Tesla.Env.t()}
Lists all reminders created by or for a given user.
Parameters
- connection (SlackWebAPI.Connection): Connection to server
opts (KeywordList): [optional] Optional parameters
- :token (String.t): Authentication token. Requires scope:
reminders:read
- :token (String.t): Authentication token. Requires scope:
Returns
{:ok, %{}} on success {:error, info} on failure