lib/slack/endpoint/dnd.rb in slack-api-1.6.0 vs lib/slack/endpoint/dnd.rb in slack-api-1.6.1
- old
+ new
@@ -2,11 +2,11 @@
module Slack
module Endpoint
module Dnd
#
- # Ends the user's currently scheduled Do Not Disturb session immediately.
+ # Ends the current user's Do Not Disturb session immediately.
#
# @see https://api.slack.com/methods/dnd.endDnd
# @see https://github.com/aki017/slack-api-docs/blob/master/methods/dnd.endDnd.md
# @see https://github.com/aki017/slack-api-docs/blob/master/methods/dnd.endDnd.json
def dnd_endDnd(options={})
@@ -22,11 +22,11 @@
def dnd_endSnooze(options={})
post("dnd.endSnooze", options)
end
#
- # Provides information about a user's current Do Not Disturb settings.
+ # Retrieves a user's current Do Not Disturb status.
#
# @option options [Object] :user
# User to fetch status for (defaults to current user)
# @see https://api.slack.com/methods/dnd.info
# @see https://github.com/aki017/slack-api-docs/blob/master/methods/dnd.info.md
@@ -34,11 +34,11 @@
def dnd_info(options={})
post("dnd.info", options)
end
#
- # Adjusts the snooze duration for a user's Do Not Disturb settings. If a snooze session is not already active for the user, invoking this method will begin one for the specified duration.
+ # 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 https://api.slack.com/methods/dnd.setSnooze
# @see https://github.com/aki017/slack-api-docs/blob/master/methods/dnd.setSnooze.md
@@ -47,10 +47,10 @@
throw ArgumentError.new("Required arguments :num_minutes missing") if options[:num_minutes].nil?
post("dnd.setSnooze", options)
end
#
- # Provides information about the current Do Not Disturb settings for users of a Slack team.
+ # 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 https://api.slack.com/methods/dnd.teamInfo
# @see https://github.com/aki017/slack-api-docs/blob/master/methods/dnd.teamInfo.md