module Slack::Web::Api::Endpoints::Reminders
Public Instance Methods
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 [user] :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/slack-ruby/slack-api-ref/blob/master/methods/reminders/reminders.add.json
# File lib/slack/web/api/endpoints/reminders.rb, line 19 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? options = options.merge(user: users_id(options)['user']['id']) if options[:user] post('reminders.add', options) end
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/slack-ruby/slack-api-ref/blob/master/methods/reminders/reminders.complete.json
# File lib/slack/web/api/endpoints/reminders.rb, line 33 def reminders_complete(options = {}) throw ArgumentError.new('Required arguments :reminder missing') if options[:reminder].nil? post('reminders.complete', options) end
Deletes a reminder.
@option options [Object] :reminder
The ID of the reminder.
@see api.slack.com/methods/reminders.delete @see github.com/slack-ruby/slack-api-ref/blob/master/methods/reminders/reminders.delete.json
# File lib/slack/web/api/endpoints/reminders.rb, line 45 def reminders_delete(options = {}) throw ArgumentError.new('Required arguments :reminder missing') if options[:reminder].nil? post('reminders.delete', options) end
Gets information about a reminder.
@option options [Object] :reminder
The ID of the reminder.
@see api.slack.com/methods/reminders.info @see github.com/slack-ruby/slack-api-ref/blob/master/methods/reminders/reminders.info.json
# File lib/slack/web/api/endpoints/reminders.rb, line 57 def reminders_info(options = {}) throw ArgumentError.new('Required arguments :reminder missing') if options[:reminder].nil? post('reminders.info', options) end
Lists all reminders created by or for a given user.
@see api.slack.com/methods/reminders.list @see github.com/slack-ruby/slack-api-ref/blob/master/methods/reminders/reminders.list.json
# File lib/slack/web/api/endpoints/reminders.rb, line 67 def reminders_list(options = {}) post('reminders.list', options) end