module Slack::Web::Users

Module for the users methods. Get info on members of your Slack team.

Constants

SCOPE

Endpoint scope

Public Instance Methods

users_get_presence(params = {}) click to toggle source

Gets user presence information.

@param [Hash] params

API call arguments

@option params [user] 'user'

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

@see api.slack.com/methods/users.messages

# File lib/slack/web/users.rb, line 20
def users_get_presence(params = {})
  fail ArgumentError, "Required arguments 'user' missing" if params['user'].nil?
  response = @session.do_post "#{SCOPE}.getPresence", params
  Slack.parse_response(response)
end
users_info(params = {}) click to toggle source

Gets information about a user.

@param [Hash] params

API call arguments

@option params [user] 'user'

User to get info on

@see api.slack.com/methods/users.info

# File lib/slack/web/users.rb, line 34
def users_info(params = {})
  fail ArgumentError, "Required arguments 'user' missing" if params['user'].nil?
  response = @session.do_post "#{SCOPE}.info", params
  Slack.parse_response(response)
end
users_list(params = {}) click to toggle source

Lists all users in a Slack team.

@param [Hash] params

API call arguments

@see api.slack.com/methods/users.list

# File lib/slack/web/users.rb, line 46
def users_list(params = {})
  response = @session.do_post "#{SCOPE}.list", params
  Slack.parse_response(response)
end
users_set_active(params = {}) click to toggle source

Marks a user as active.

@param [Hash] params

API call arguments

@see api.slack.com/methods/users.setActive

# File lib/slack/web/users.rb, line 57
def users_set_active(params = {})
  response = @session.do_post "#{SCOPE}.setActive", params
  Slack.parse_response(response)
end
users_set_presence(params = {}) click to toggle source

Manually sets user presence.

@param [Hash] params

API call arguments

@option params [Object] 'presence'

Either `auto` or `away`

@see api.slack.com/methods/users.setPresence

# File lib/slack/web/users.rb, line 70
def users_set_presence(params = {})
  fail ArgumentError, "Required arguments 'presence' missing" if params['presence'].nil?
  response = @session.do_post "#{SCOPE}.setPresence", params
  Slack.parse_response(response)
end