Module: Slack::Web::Api::Endpoints::Im
- Included in:
- Slack::Web::Api::Endpoints
- Defined in:
- lib/slack/web/api/endpoints/im.rb
Instance Method Summary collapse
-
#im_close(options = {}) ⇒ Object
This method closes a direct message channel.
-
#im_history(options = {}) ⇒ Object
This method returns a portion of messages/events from the specified direct message channel.
-
#im_list(options = {}) ⇒ Object
Don’t use this method.
-
#im_mark(options = {}) ⇒ Object
This method moves the read cursor in a direct message channel.
-
#im_open(options = {}) ⇒ Object
This method opens a direct message channel with another member of your Slack team.
-
#im_replies(options = {}) ⇒ Object
This method returns an entire thread (a message plus all the messages in reply to it).
Instance Method Details
#im_close(options = {}) ⇒ Object
This method closes a direct message channel.
15 16 17 18 19 |
# File 'lib/slack/web/api/endpoints/im.rb', line 15 def im_close( = {}) throw ArgumentError.new('Required arguments :channel missing') if [:channel].nil? = .merge(channel: channels_id()['channel']['id']) if [:channel] post('im.close', ) end |
#im_history(options = {}) ⇒ Object
This method returns a portion of messages/events from the specified direct message channel. To read the entire history for a direct message channel, call the method with no latest or oldest arguments, and then continue paging using the instructions below.
38 39 40 41 42 |
# File 'lib/slack/web/api/endpoints/im.rb', line 38 def im_history( = {}) throw ArgumentError.new('Required arguments :channel missing') if [:channel].nil? = .merge(channel: channels_id()['channel']['id']) if [:channel] post('im.history', ) end |
#im_list(options = {}) ⇒ Object
Don’t use this method. Use conversations.list instead.
53 54 55 56 57 58 59 60 61 |
# File 'lib/slack/web/api/endpoints/im.rb', line 53 def im_list( = {}) if block_given? Pagination::Cursor.new(self, :im_list, ).each do |page| yield page end else post('im.list', ) end end |
#im_mark(options = {}) ⇒ Object
This method moves the read cursor in a direct message channel.
72 73 74 75 76 77 |
# File 'lib/slack/web/api/endpoints/im.rb', line 72 def im_mark( = {}) throw ArgumentError.new('Required arguments :channel missing') if [:channel].nil? throw ArgumentError.new('Required arguments :ts missing') if [:ts].nil? = .merge(channel: channels_id()['channel']['id']) if [:channel] post('im.mark', ) end |
#im_open(options = {}) ⇒ Object
This method opens a direct message channel with another member of your Slack team.
90 91 92 93 94 |
# File 'lib/slack/web/api/endpoints/im.rb', line 90 def im_open( = {}) throw ArgumentError.new('Required arguments :user missing') if [:user].nil? = .merge(user: users_id()['user']['id']) if [:user] post('im.open', ) end |
#im_replies(options = {}) ⇒ Object
This method returns an entire thread (a message plus all the messages in reply to it).
105 106 107 108 109 110 |
# File 'lib/slack/web/api/endpoints/im.rb', line 105 def im_replies( = {}) throw ArgumentError.new('Required arguments :channel missing') if [:channel].nil? throw ArgumentError.new('Required arguments :thread_ts missing') if [:thread_ts].nil? = .merge(channel: channels_id()['channel']['id']) if [:channel] post('im.replies', ) end |