slack_web_api v1.2.1 SlackWebAPI.Api.Reminders

API calls for all endpoints tagged Reminders.

Link to this section Summary

Functions

Marks a reminder as complete.

Gets information about a reminder.

Lists all reminders created by or for a given user.

Link to this section Functions

Link to this function

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\")

Returns

{:ok, %{}} on success {:error, info} on failure

Link to this function

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

Returns

{:ok, %{}} on success {:error, info} on failure

Link to this function

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

Returns

{:ok, %{}} on success {:error, info} on failure

Link to this function

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

Returns

{:ok, %{}} on success {:error, info} on failure

Link to this function

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

Returns

{:ok, %{}} on success {:error, info} on failure