module Slack::Web::Api::Endpoints::Users

Public Instance Methods

users_getPresence(options = {}) click to toggle source

This method lets you find out information about a user's presence. Consult the presence documentation for more details.

@option options [user] :user

User to get presence info on. Defaults to the authed user.

@see api.slack.com/methods/users.getPresence @see github.com/dblock/slack-api-ref/blob/master/methods/users.getPresence.json

# File lib/slack/web/api/endpoints/users.rb, line 16
def users_getPresence(options = {})
  throw ArgumentError.new('Required arguments :user missing') if options[:user].nil?
  options = options.merge(user: users_id(options)['user']['id']) if options[:user]
  post('users.getPresence', options)
end
users_info(options = {}) click to toggle source

This method returns information about a team member.

@option options [user] :user

User to get info on.

@see api.slack.com/methods/users.info @see github.com/dblock/slack-api-ref/blob/master/methods/users.info.json

# File lib/slack/web/api/endpoints/users.rb, line 29
def users_info(options = {})
  throw ArgumentError.new('Required arguments :user missing') if options[:user].nil?
  options = options.merge(user: users_id(options)['user']['id']) if options[:user]
  post('users.info', options)
end
users_list(options = {}) click to toggle source

This method returns a list of all users in the team. This includes deleted/deactivated users.

@option options [Object] :presence

Whether to include presence data in the output.

@see api.slack.com/methods/users.list @see github.com/dblock/slack-api-ref/blob/master/methods/users.list.json

# File lib/slack/web/api/endpoints/users.rb, line 42
def users_list(options = {})
  post('users.list', options)
end
users_setActive(options = {}) click to toggle source

This method lets the slack messaging server know that the authenticated user is currently active. Consult the presence documentation for more details.

@see api.slack.com/methods/users.setActive @see github.com/dblock/slack-api-ref/blob/master/methods/users.setActive.json

# File lib/slack/web/api/endpoints/users.rb, line 53
def users_setActive(options = {})
  post('users.setActive', options)
end
users_setPresence(options = {}) click to toggle source

This method lets you set the calling user's manual presence. Consult the presence documentation for more details.

@option options [Object] :presence

Either auto or away.

@see api.slack.com/methods/users.setPresence @see github.com/dblock/slack-api-ref/blob/master/methods/users.setPresence.json

# File lib/slack/web/api/endpoints/users.rb, line 65
def users_setPresence(options = {})
  throw ArgumentError.new('Required arguments :presence missing') if options[:presence].nil?
  post('users.setPresence', options)
end