Module: RubyCord::Internal::Messageable
- Included in:
- DMChannel, Guild::TextChannel, Guild::ThreadChannel, Guild::VoiceChannel, User
- Defined in:
- lib/rubycord/internal/messageable.rb
Overview
Module for sending and reading messages.
Instance Method Summary collapse
-
#delete_message(message_id, reason: nil) ⇒ Async::Task<void>
(also: #destroy_message)
Delete a message.
-
#edit_message(message_id, content = RubyCord::Unset, embed: RubyCord::Unset, embeds: RubyCord::Unset, allowed_mentions: RubyCord::Unset, attachments: RubyCord::Unset, components: RubyCord::Unset, supress: RubyCord::Unset) ⇒ Async::Task<void>
Edit a message.
-
#fetch_message(id) ⇒ Async::Task<RubyCord::Message>
Fetch a message from ID.
-
#fetch_messages(limit = 50, before: nil, after: nil, around: nil) ⇒ Async::Task<Array<RubyCord::Message>>
Fetch a message history.
-
#fetch_pins ⇒ Async::Task<Array<RubyCord::Message>>
Fetch the pinned messages in the channel.
-
#pin_message(message, reason: nil) ⇒ Async::Task<void>
Pin a message in the channel.
-
#post(content = nil, tts: false, embed: nil, embeds: nil, allowed_mentions: nil, reference: nil, components: nil, attachment: nil, attachments: nil) ⇒ Async::Task<RubyCord::Message>
(also: #send_message)
Post a message to the channel.
-
#typing ⇒ Object
Trigger the typing indicator in the channel.
-
#unpin_message(message, reason: nil) ⇒ Async::Task<void>
Unpin a message in the channel.
Instance Method Details
#delete_message(message_id, reason: nil) ⇒ Async::Task<void> Also known as: destroy_message
Delete a message.
151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 |
# File 'lib/rubycord/internal/messageable.rb', line 151 def (, reason: nil) Async do @client .http .request( RubyCord::Internal::Route.new( "/channels/#{channel_id.wait}/messages/#{}", "//channels/:channel_id/messages/:message_id", :delete ), {}, audit_log_reason: reason ) .wait end end |
#edit_message(message_id, content = RubyCord::Unset, embed: RubyCord::Unset, embeds: RubyCord::Unset, allowed_mentions: RubyCord::Unset, attachments: RubyCord::Unset, components: RubyCord::Unset, supress: RubyCord::Unset) ⇒ Async::Task<void>
The arguments of this method are defaultly set to RubyCord::Unset
.
Specify value to set the value, if not don't specify or specify RubyCord::Unset
.
Edit a message.
94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 |
# File 'lib/rubycord/internal/messageable.rb', line 94 def ( , content = RubyCord::Unset, embed: RubyCord::Unset, embeds: RubyCord::Unset, allowed_mentions: RubyCord::Unset, attachments: RubyCord::Unset, components: RubyCord::Unset, supress: RubyCord::Unset ) Async do payload = {} payload[:content] = content if content != RubyCord::Unset = if != RubyCord::Unset [] elsif != RubyCord::Unset end payload[:embeds] = .map(&:to_hash) if payload[:allowed_mentions] = if allowed_mentions == RubyCord::Unset @client.allowed_mentions.to_hash else allowed_mentions.to_hash(@client.allowed_mentions) end payload[:components] = Component.to_payload(components) if components != RubyCord::Unset payload[:flags] = (supress ? 1 << 2 : 0) if supress != RubyCord::Unset if != RubyCord::Unset payload[:attachments] = .map.with_index do |a, i| { id: i, filename: a.filename, description: a.description } end end @client .http .multipart_request( RubyCord::Internal::Route.new( "/channels/#{channel_id.wait}/messages/#{}", "//channels/:channel_id/messages/:message_id", :patch ), payload, == RubyCord::Unset ? [] : ) .wait end end |
#fetch_message(id) ⇒ Async::Task<RubyCord::Message>
Fetch a message from ID.
179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 |
# File 'lib/rubycord/internal/messageable.rb', line 179 def (id) Async do _resp, data = @client .http .request( RubyCord::Internal::Route.new( "/channels/#{channel_id.wait}/messages/#{id}", "//channels/:channel_id/messages/:message_id", :get ) ) .wait RubyCord::Message.new(@client, data.merge({ guild_id: @guild_id.to_s })) end end |
#fetch_messages(limit = 50, before: nil, after: nil, around: nil) ⇒ Async::Task<Array<RubyCord::Message>>
Fetch a message history.
207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 |
# File 'lib/rubycord/internal/messageable.rb', line 207 def (limit = 50, before: nil, after: nil, around: nil) Async do params = { limit:, before: RubyCord::Utils.try(after, :id), after: RubyCord::Utils.try(around, :id), around: RubyCord::Utils.try(before, :id) }.filter { |_k, v| !v.nil? }.to_h _resp, = @client .http .request( RubyCord::Internal::Route.new( "/channels/#{channel_id.wait}/messages?#{URI.encode_www_form(params)}", "//channels/:channel_id/messages", :get ) ) .wait .map do |m| RubyCord::Message.new(@client, m.merge({ guild_id: @guild_id.to_s })) end end end |
#fetch_pins ⇒ Async::Task<Array<RubyCord::Message>>
Fetch the pinned messages in the channel.
239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 |
# File 'lib/rubycord/internal/messageable.rb', line 239 def fetch_pins Async do _resp, data = @client .http .request( RubyCord::Internal::Route.new( "/channels/#{channel_id.wait}/pins", "//channels/:channel_id/pins", :get ) ) .wait data.map { |pin| Message.new(@client, pin) } end end |
#pin_message(message, reason: nil) ⇒ Async::Task<void>
Pin a message in the channel.
265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 |
# File 'lib/rubycord/internal/messageable.rb', line 265 def (, reason: nil) Async do @client .http .request( RubyCord::Internal::Route.new( "/channels/#{channel_id.wait}/pins/#{.id}", "//channels/:channel_id/pins/:message_id", :put ), {}, audit_log_reason: reason ) .wait end end |
#post(content = nil, tts: false, embed: nil, embeds: nil, allowed_mentions: nil, reference: nil, components: nil, attachment: nil, attachments: nil) ⇒ Async::Task<RubyCord::Message> Also known as: send_message
Post a message to the channel.
20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 |
# File 'lib/rubycord/internal/messageable.rb', line 20 def post( content = nil, tts: false, embed: nil, embeds: nil, allowed_mentions: nil, reference: nil, components: nil, attachment: nil, attachments: nil ) Async do payload = {} payload[:content] = content if content payload[:tts] = tts = if [] elsif end payload[:embeds] = .map(&:to_hash) if payload[:allowed_mentions] = ( if allowed_mentions allowed_mentions.to_hash(@client.allowed_mentions) else @client.allowed_mentions.to_hash end ) payload[ :message_reference ] = reference.to_reference.to_hash if reference payload[:components] = Component.to_payload(components) if components ||= ? [] : [] payload[:attachments] = .map.with_index do |a, i| { id: i, filename: a.filename, description: a.description } end _resp, data = @client .http .multipart_request( RubyCord::Internal::Route.new( "/channels/#{channel_id.wait}/messages", "//channels/:channel_id/messages", :post ), payload, ) .wait RubyCord::Message.new(@client, data.merge({ guild_id: @guild_id.to_s })) end end |
#typing ⇒ Object
Trigger the typing indicator in the channel. If block is given, trigger typing indicator during executing block.
320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 |
# File 'lib/rubycord/internal/messageable.rb', line 320 def typing if block_given? begin post_task = Async do loop do @client.http.request( RubyCord::Internal::Route.new( "/channels/#{@id}/typing", "//channels/:channel_id/typing", :post ), {} ) sleep(5) end end ret = yield ensure post_task.stop end ret else Async do |_task| @client.http.request( RubyCord::Internal::Route.new( "/channels/#{@id}/typing", "//channels/:channel_id/typing", :post ), {} ) end end end |
#unpin_message(message, reason: nil) ⇒ Async::Task<void>
Unpin a message in the channel.
291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 |
# File 'lib/rubycord/internal/messageable.rb', line 291 def (, reason: nil) Async do @client .http .request( RubyCord::Internal::Route.new( "/channels/#{channel_id.wait}/pins/#{.id}", "//channels/:channel_id/pins/:message_id", :delete ), {}, audit_log_reason: reason ) .wait end end |