Module: Slack::Endpoint::Im

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

Instance Method Summary collapse

Instance Method Details

#im_close(options = {}) ⇒ Object

Close a direct message channel.

Parameters:

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

    a customizable set of options

Options Hash (options):

  • :channel (im) —

    Direct message channel to close.

See Also:



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

def im_close(options={})
  throw ArgumentError.new("Required arguments :channel missing") if options[:channel].nil?
  post("im.close", options)
end

#im_history(options = {}) ⇒ Object

Fetches history of messages and events from direct message channel.

Parameters:

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

    a customizable set of options

Options Hash (options):

  • :channel (im) —

    Direct message channel to fetch history for.

  • :latest (timestamp) —

    Latest message timestamp to include in results.

  • :oldest (timestamp) —

    Oldest message timestamp to include in results.

  • :count (Object) —

    Number of messages to return, between 1 and 1000.

See Also:



33
34
35
36
 
# File 'lib/slack/endpoint/im.rb', line 33

def im_history(options={})
  throw ArgumentError.new("Required arguments :channel missing") if options[:channel].nil?
  post("im.history", options)
end

#im_list(options = {}) ⇒ Object

Lists direct message channels for the calling user.

See Also:



44
45
46
 
# File 'lib/slack/endpoint/im.rb', line 44

def im_list(options={})
  post("im.list", options)
end

#im_mark(options = {}) ⇒ Object

Sets the read cursor in a direct message channel.

Parameters:

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

    a customizable set of options

Options Hash (options):

  • :channel (im) —

    Direct message channel to set reading cursor in.

  • :ts (timestamp) —

    Timestamp of the most recently seen message.

See Also:



58
59
60
61
62
 
# File 'lib/slack/endpoint/im.rb', line 58

def im_mark(options={})
  throw ArgumentError.new("Required arguments :channel missing") if options[:channel].nil?
  throw ArgumentError.new("Required arguments :ts missing") if options[:ts].nil?
  post("im.mark", options)
end

#im_open(options = {}) ⇒ Object

Opens a direct message channel.

Parameters:

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

    a customizable set of options

Options Hash (options):

  • :user (user) —

    User to open a direct message channel with.

See Also:



72
73
74
75
 
# File 'lib/slack/endpoint/im.rb', line 72

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