Module: Slack::Endpoint::Users

Included in:
Slack::Endpoint
Defined in:
lib/slack/endpoint/users.rb

Instance Method Summary collapse

Instance Method Details

#users_getPresence(options = {}) ⇒ Object

Gets user presence information.

Parameters:

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

    a customizable set of options

Options Hash (options):

  • :user (user) —

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

See Also:



14
15
16
17
 
# File 'lib/slack/endpoint/users.rb', line 14

def users_getPresence(options={})
  throw ArgumentError.new("Required arguments :user missing") if options[:user].nil?
  post("users.getPresence", options)
end

#users_info(options = {}) ⇒ Object

Gets information about a user.

Parameters:

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

    a customizable set of options

Options Hash (options):

  • :user (user) —

    User to get info on

See Also:



27
28
29
30
 
# File 'lib/slack/endpoint/users.rb', line 27

def users_info(options={})
  throw ArgumentError.new("Required arguments :user missing") if options[:user].nil?
  post("users.info", options)
end

#users_list(options = {}) ⇒ Object

Lists all users in a Slack team.

See Also:



38
39
40
 
# File 'lib/slack/endpoint/users.rb', line 38

def users_list(options={})
  post("users.list", options)
end

#users_setActive(options = {}) ⇒ Object

Marks a user as active.

See Also:



48
49
50
 
# File 'lib/slack/endpoint/users.rb', line 48

def users_setActive(options={})
  post("users.setActive", options)
end

#users_setPresence(options = {}) ⇒ Object

Manually sets user presence.

Parameters:

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

    a customizable set of options

Options Hash (options):

  • :presence (Object) —

    Either ‘auto` or `away`

See Also:



60
61
62
63
 
# File 'lib/slack/endpoint/users.rb', line 60

def users_setPresence(options={})
  throw ArgumentError.new("Required arguments :presence missing") if options[:presence].nil?
  post("users.setPresence", options)
end