module Slack::Web::Api::Endpoints::Dnd

Public Instance Methods

dnd_endDnd(options = {}) click to toggle source

Ends the current user's Do Not Disturb session immediately.

@see api.slack.com/methods/dnd.endDnd @see github.com/slack-ruby/slack-api-ref/blob/master/methods/dnd/dnd.endDnd.json

# File lib/slack/web/api/endpoints/dnd.rb, line 13
def dnd_endDnd(options = {})
  post('dnd.endDnd', options)
end
dnd_endSnooze(options = {}) click to toggle source

Ends the current user's snooze mode immediately.

@see api.slack.com/methods/dnd.endSnooze @see github.com/slack-ruby/slack-api-ref/blob/master/methods/dnd/dnd.endSnooze.json

# File lib/slack/web/api/endpoints/dnd.rb, line 22
def dnd_endSnooze(options = {})
  post('dnd.endSnooze', options)
end
dnd_info(options = {}) click to toggle source

Retrieves a user's current Do Not Disturb status.

@option options [user] :user

User to fetch status for (defaults to current user).

@see api.slack.com/methods/dnd.info @see github.com/slack-ruby/slack-api-ref/blob/master/methods/dnd/dnd.info.json

# File lib/slack/web/api/endpoints/dnd.rb, line 33
def dnd_info(options = {})
  options = options.merge(user: users_id(options)['user']['id']) if options[:user]
  post('dnd.info', options)
end
dnd_setSnooze(options = {}) click to toggle source

Turns on Do Not Disturb mode for the current user, or changes its duration.

@option options [Object] :num_minutes

Number of minutes, from now, to snooze until.

@see api.slack.com/methods/dnd.setSnooze @see github.com/slack-ruby/slack-api-ref/blob/master/methods/dnd/dnd.setSnooze.json

# File lib/slack/web/api/endpoints/dnd.rb, line 45
def dnd_setSnooze(options = {})
  throw ArgumentError.new('Required arguments :num_minutes missing') if options[:num_minutes].nil?
  post('dnd.setSnooze', options)
end
dnd_teamInfo(options = {}) click to toggle source

Retrieves the Do Not Disturb status for users on a team.

@option options [Object] :users

Comma-separated list of users to fetch Do Not Disturb status for.

@see api.slack.com/methods/dnd.teamInfo @see github.com/slack-ruby/slack-api-ref/blob/master/methods/dnd/dnd.teamInfo.json

# File lib/slack/web/api/endpoints/dnd.rb, line 57
def dnd_teamInfo(options = {})
  post('dnd.teamInfo', options)
end