Module: Slack::Web::Users

Included in:
Slack::Web
Defined in:
lib/slack/web/users.rb

Overview

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

Constant Summary collapse

SCOPE =

Endpoint scope

'users'

Instance Method Summary collapse

Instance Method Details

#users_get_presence(params = {}) ⇒ Object

Gets user presence information.

Parameters:

  • params (Hash) (defaults to: {}) —

    API call arguments

Options Hash (params):

  • 'user' (user) —

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

See Also:



20
21
22
23
24
 
# 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 = {}) ⇒ Object

Gets information about a user.

Parameters:

  • params (Hash) (defaults to: {}) —

    API call arguments

Options Hash (params):

  • 'user' (user) —

    User to get info on

See Also:



34
35
36
37
38
 
# 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 = {}) ⇒ Object

Lists all users in a Slack team.

Parameters:

  • params (Hash) (defaults to: {}) —

    API call arguments

See Also:



46
47
48
49
 
# 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 = {}) ⇒ Object

Marks a user as active.

Parameters:

  • params (Hash) (defaults to: {}) —

    API call arguments

See Also:



57
58
59
60
 
# 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 = {}) ⇒ Object

Manually sets user presence.

Parameters:

  • params (Hash) (defaults to: {}) —

    API call arguments

Options Hash (params):

  • 'presence' (Object) —

    Either auto or away

See Also:



70
71
72
73
74
 
# 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