module Slack::Endpoint::Reminders

Public Instance Methods

reminders_add(options={}) click to toggle source

Creates a reminder.

@option options [Object] :text

The content of the reminder

@option options [Object] :time

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

@option options [Object] :user

The user who will receive the reminder. If no user is specified, the reminder will go to user who created it.

@see api.slack.com/methods/reminders.add @see github.com/aki017/slack-api-docs/blob/master/methods/reminders.add.md @see github.com/aki017/slack-api-docs/blob/master/methods/reminders.add.json

# File lib/slack/endpoint/reminders.rb, line 18
def reminders_add(options={})
  throw ArgumentError.new("Required arguments :text missing") if options[:text].nil?
  throw ArgumentError.new("Required arguments :time missing") if options[:time].nil?
  post("reminders.add", options)
end
reminders_complete(options={}) click to toggle source

Marks a reminder as complete.

@option options [Object] :reminder

The ID of the reminder to be marked as complete

@see api.slack.com/methods/reminders.complete @see github.com/aki017/slack-api-docs/blob/master/methods/reminders.complete.md @see github.com/aki017/slack-api-docs/blob/master/methods/reminders.complete.json

# File lib/slack/endpoint/reminders.rb, line 32
def reminders_complete(options={})
  throw ArgumentError.new("Required arguments :reminder missing") if options[:reminder].nil?
  post("reminders.complete", options)
end
reminders_delete(options={}) click to toggle source

Deletes a reminder.

@option options [Object] :reminder

The ID of the reminder

@see api.slack.com/methods/reminders.delete @see github.com/aki017/slack-api-docs/blob/master/methods/reminders.delete.md @see github.com/aki017/slack-api-docs/blob/master/methods/reminders.delete.json

# File lib/slack/endpoint/reminders.rb, line 45
def reminders_delete(options={})
  throw ArgumentError.new("Required arguments :reminder missing") if options[:reminder].nil?
  post("reminders.delete", options)
end
reminders_info(options={}) click to toggle source

Gets information about a reminder.

@option options [Object] :reminder

The ID of the reminder

@see api.slack.com/methods/reminders.info @see github.com/aki017/slack-api-docs/blob/master/methods/reminders.info.md @see github.com/aki017/slack-api-docs/blob/master/methods/reminders.info.json

# File lib/slack/endpoint/reminders.rb, line 58
def reminders_info(options={})
  throw ArgumentError.new("Required arguments :reminder missing") if options[:reminder].nil?
  post("reminders.info", options)
end
reminders_list(options={}) click to toggle source

Lists all reminders created by or for a given user.

@see api.slack.com/methods/reminders.list @see github.com/aki017/slack-api-docs/blob/master/methods/reminders.list.md @see github.com/aki017/slack-api-docs/blob/master/methods/reminders.list.json

# File lib/slack/endpoint/reminders.rb, line 69
def reminders_list(options={})
  post("reminders.list", options)
end