Class: Discorb::Webhook Abstract

Inherits:
Object
  • Object
show all
Defined in:
lib/discorb/webhook.rb

Overview

This class is abstract.

Represents a webhook.

Defined Under Namespace

Classes: ApplicationWebhook, FollowerWebhook, IncomingWebhook, Message, URLWebhook

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#application_id -> Discorb::Snowflake? (readonly)

Returns:

  • (Discorb::Snowflake) —

    The application ID of the webhook.

  • (nil) —

    If the webhook is not an application webhook.



21
22
23
 
# File 'lib/discorb/webhook.rb', line 21

def application_id
  @application_id
end

#avatar -> Discorb::Asset (readonly)

Returns The avatar of the webhook.

Returns:



18
19
20
 
# File 'lib/discorb/webhook.rb', line 18

def avatar
  @avatar
end

#channel_id -> Discorb::Snowflake (readonly)

Returns The ID of the channel this webhook belongs to.

Returns:



14
15
16
 
# File 'lib/discorb/webhook.rb', line 14

def channel_id
  @channel_id
end

#guild_id -> Discorb::Snowflake (readonly)

Returns The ID of the guild this webhook belongs to.

Returns:



12
13
14
 
# File 'lib/discorb/webhook.rb', line 12

def guild_id
  @guild_id
end

#name -> String (readonly)

Returns The name of the webhook.

Returns:

  • (String) —

    The name of the webhook.



10
11
12
 
# File 'lib/discorb/webhook.rb', line 10

def name
  @name
end

#token -> String (readonly)

Returns The URL of the webhook.

Returns:

  • (String) —

    The URL of the webhook.



23
24
25
 
# File 'lib/discorb/webhook.rb', line 23

def token
  @token
end

#user -> Discorb::User (readonly)

Returns The user that created this webhook.

Returns:



16
17
18
 
# File 'lib/discorb/webhook.rb', line 16

def user
  @user
end

Class Method Details

.from_url(url) -> Object 



424
425
426
 
# File 'lib/discorb/webhook.rb', line 424

def from_url(url)
  URLWebhook.new(url)
end

.new(url) -> Discorb::Webhook::URLWebhook

Creates URLWebhook.

Parameters:

  • url (String) —

    The URL of the webhook.

Returns:



404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
 
# File 'lib/discorb/webhook.rb', line 404

def new(url)
  if self != Webhook
    return super(*url) if url.is_a?(Array)

    return super
  end
  if url.is_a?(String)
    URLWebhook.new(url)
  else
    case url[1][:type]
    when 1
      IncomingWebhook
    when 2
      FollowerWebhook
    when 3
      ApplicationWebhook
    end.new(url)
  end
end

Instance Method Details

#delete! -> Object Also known as: destroy!

Note:

This is an asynchronous method, it will return a Async::Task object. Use Async::Task#wait to get the result.

Note:

This method calls HTTP request.

Deletes the webhook.

Raises:



121
122
123
124
125
126
 
# File 'lib/discorb/webhook.rb', line 121

def delete!
  Async do
    @http.delete(url).wait
    self
  end
end

#delete_message!(message) -> Object

Deletes the webhook's message.

Parameters:



178
179
180
181
182
183
 
# File 'lib/discorb/webhook.rb', line 178

def delete_message!(message)
  Async do
    @http.delete("#{url}/messages/#{Utils.try(message, :id)}").wait
    message
  end
end

#edit(name: :unset, avatar: :unset, channel: :unset) -> Object Also known as: modify

Note:

This is an asynchronous method, it will return a Async::Task object. Use Async::Task#wait to get the result.

Note:

This method calls HTTP request.

Note:

The arguments of this method are defaultly set to :unset. Specify value to set the value, if not don't specify or specify :unset.

Edits the webhook.

Parameters:

  • name (String) (defaults to: :unset) —

    The new name of the webhook.

  • avatar (Discorb::Image) (defaults to: :unset) —

    The new avatar of the webhook.

  • channel (Discorb::GuildChannel) (defaults to: :unset) —

    The new channel of the webhook.

Raises:



104
105
106
107
108
109
110
111
112
 
# File 'lib/discorb/webhook.rb', line 104

def edit(name: :unset, avatar: :unset, channel: :unset)
  Async do
    payload = {}
    payload[:name] = name if name != :unset
    payload[:avatar] = avatar if avatar != :unset
    payload[:channel_id] = Utils.try(channel, :id) if channel != :unset
    @http.patch(url.to_s, payload).wait
  end
end

#edit_message(message, content = :unset, embed: :unset, embeds: :unset, file: :unset, files: :unset, attachments: :unset, allowed_mentions: :unset) -> Object

Note:

This is an asynchronous method, it will return a Async::Task object. Use Async::Task#wait to get the result.

Note:

This method calls HTTP request.

Note:

The arguments of this method are defaultly set to :unset. Specify value to set the value, if not don't specify or specify :unset.

Edits the webhook's message.

Parameters:

  • message (Discorb::Webhook::Message) —

    The message to edit.

  • content (String) (defaults to: :unset) —

    The new content of the message.

  • embed (Discorb::Embed) (defaults to: :unset) —

    The new embed of the message.

  • embeds (Array<Discorb::Embed>) (defaults to: :unset) —

    The new embeds of the message.

  • attachments (Array<Discorb::Attachment>) (defaults to: :unset) —

    The attachments to remain.

  • file (Discorb::File) (defaults to: :unset) —

    The file to send.

  • files (Array<Discorb::File>) (defaults to: :unset) —

    The files to send.

  • allowed_mentions (Discorb::AllowedMentions) (defaults to: :unset) —

    The allowed mentions to send.

Raises:



145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'lib/discorb/webhook.rb', line 145

def edit_message(
  message, content = :unset,
  embed: :unset, embeds: :unset,
  file: :unset, files: :unset,
  attachments: :unset,
  allowed_mentions: :unset
)
  Async do
    payload = {}
    payload[:content] = content if content != :unset
    payload[:embeds] = embed ? [embed.to_hash] : [] if embed != :unset
    payload[:embeds] = embeds.map(&:to_hash) if embeds != :unset
    payload[:attachments] = attachments.map(&:to_hash) if attachments != :unset
    payload[:allowed_mentions] = allowed_mentions if allowed_mentions != :unset
    files = [file] if file != :unset
    if files == :unset
      headers = {
        "Content-Type" => "application/json",
      }
    else
      headers, payload = HTTP.multipart(payload, files)
    end
    _resp, data = @http.patch("#{url}/messages/#{Utils.try(message, :id)}", payload, headers: headers).wait
    message.send(:_set_data, data)
    message
  end
end

#inspect -> Object 



40
41
42
 
# File 'lib/discorb/webhook.rb', line 40

def inspect
  "#<#{self.class} #{@name.inspect} id=#{@id}>"
end

#post(content = nil, tts: false, embed: nil, embeds: nil, allowed_mentions: nil, file: nil, files: nil, username: nil, avatar_url: :unset, wait: true) -> Discorb::Webhook::Message, Async::Task<nil> Also known as: execute

Note:

This is an asynchronous method, it will return a Async::Task object. Use Async::Task#wait to get the result.

Note:

This method calls HTTP request.

Posts a message to the webhook.

Parameters:

  • content (String) (defaults to: nil) —

    The content of the message.

  • tts (Boolean) (defaults to: false) —

    Whether the message should be sent as text-to-speech.

  • embed (Discorb::Embed) (defaults to: nil) —

    The embed to send.

  • embeds (Array<Discorb::Embed>) (defaults to: nil) —

    The embeds to send.

  • allowed_mentions (Discorb::AllowedMentions) (defaults to: nil) —

    The allowed mentions to send.

  • file (Discorb::File) (defaults to: nil) —

    The file to send.

  • files (Array<Discorb::File>) (defaults to: nil) —

    The files to send.

  • username (String) (defaults to: nil) —

    The username of the message.

  • avatar_url (String) (defaults to: :unset) —

    The avatar URL of the message.

  • wait (Boolean) (defaults to: true) —

    Whether to wait for the message to be sent.

Returns:

Raises:



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/discorb/webhook.rb', line 63

def post(content = nil, tts: false, embed: nil, embeds: nil, allowed_mentions: nil,
                        file: nil, files: nil, username: nil, avatar_url: :unset, wait: true)
  Async do
    payload = {}
    payload[:content] = content if content
    payload[:tts] = tts
    tmp_embed = if embed
        [embed]
      elsif embeds
        embeds
      end
    payload[:embeds] = tmp_embed.map(&:to_hash) if tmp_embed
    payload[:allowed_mentions] = allowed_mentions&.to_hash
    payload[:username] = username if username
    payload[:avatar_url] = avatar_url if avatar_url != :unset
    files = [file] if file
    if files
      headers, payload = HTTP.multipart(payload, files)
    else
      headers = {
        "Content-Type" => "application/json",
      }
    end
    _resp, data = @http.post("#{url}?wait=#{wait}", payload, headers: headers).wait

    data && Webhook::Message.new(self, data)
  end
end