Module: Slack::Endpoint::Users

Included in:

Slack::Endpoint

Defined in:

lib/slack/endpoint/users.rb

Instance Method Summary

• #users_getPresence(options = {}) ⇒ Object

  This method lets you find out information about a user’s presence.

• #users_info(options = {}) ⇒ Object

  This method returns information about a team member.

• #users_list(options = {}) ⇒ Object

  This method returns a list of all users in the team.

• #users_setActive(options = {}) ⇒ Object

  This method lets the slack messaging server know that the authenticated user is currently active.

• #users_setPresence(options = {}) ⇒ Object

  This method lets you set the calling user’s manual presence.

Instance Method Details

#users_getPresence(options = {}) ⇒ Object

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

Parameters:

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

  a customizable set of options

Options Hash (options):

• :user (Object) —

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

See Also:

• https://api.slack.com/methods/users.getPresence
• https://github.com/aki017/slack-api-docs/blob/master/methods/users.getPresence.md
• https://github.com/aki017/slack-api-docs/blob/master/methods/users.getPresence.json

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

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

#users_info(options = {}) ⇒ Object

This method returns information about a team member.

Parameters:

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

  a customizable set of options

Options Hash (options):

• :user (Object) —

  User to get info on

See Also:

• https://api.slack.com/methods/users.info
• https://github.com/aki017/slack-api-docs/blob/master/methods/users.info.md
• https://github.com/aki017/slack-api-docs/blob/master/methods/users.info.json

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

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

#users_list(options = {}) ⇒ Object

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

Parameters:

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

  a customizable set of options

Options Hash (options):

• :presence (Object) —

  Whether to include presence data in the output

See Also:

• https://api.slack.com/methods/users.list
• https://github.com/aki017/slack-api-docs/blob/master/methods/users.list.md
• https://github.com/aki017/slack-api-docs/blob/master/methods/users.list.json

# File 'lib/slack/endpoint/users.rb', line 43

def users_list(options={})
  options[:attachments] = options[:attachments].to_json if Hash === options[:attachments]
  post("users.list", options)
end

#users_setActive(options = {}) ⇒ Object

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

See Also:

• https://api.slack.com/methods/users.setActive
• https://github.com/aki017/slack-api-docs/blob/master/methods/users.setActive.md
• https://github.com/aki017/slack-api-docs/blob/master/methods/users.setActive.json

# File 'lib/slack/endpoint/users.rb', line 56

def users_setActive(options={})
  options[:attachments] = options[:attachments].to_json if Hash === options[:attachments]
  post("users.setActive", options)
end

#users_setPresence(options = {}) ⇒ Object

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

Parameters:

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

  a customizable set of options

Options Hash (options):

• :presence (Object) —

  Either auto or away

See Also:

• https://api.slack.com/methods/users.setPresence
• https://github.com/aki017/slack-api-docs/blob/master/methods/users.setPresence.md
• https://github.com/aki017/slack-api-docs/blob/master/methods/users.setPresence.json

# File 'lib/slack/endpoint/users.rb', line 70

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