Class: Discorb::Guild::Widget

Inherits:
DiscordModel show all
Defined in:
lib/discorb/guild.rb

Overview

Represents a guild widget.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from DiscordModel

#==, #eql?, #inspect

Instance Attribute Details

#channel -> nil, Discorb::Channel (readonly)

Note:

This method returns an object from client cache. it will return nil if the object is not in cache.

Returns:




# File 'lib/discorb/guild.rb', line 1272

#channel_id -> Discorb::Snowflake (readonly)

Returns The channel ID.

Returns:



1266
1267
1268
 
# File 'lib/discorb/guild.rb', line 1266

def channel_id
  @channel_id
end

#enabled -> Boolean (readonly) Also known as: enabled?, enable?

Returns Whether the widget is enabled.

Returns:

  • (Boolean) —

    Whether the widget is enabled.



1268
1269
1270
 
# File 'lib/discorb/guild.rb', line 1268

def enabled
  @enabled
end

#guild -> nil, Discorb::Guild (readonly)

Note:

This method returns an object from client cache. it will return nil if the object is not in cache.

Returns:




# File 'lib/discorb/guild.rb', line 1272

#guild_id -> Discorb::Snowflake (readonly)

Returns The guild ID.

Returns:



1264
1265
1266
 
# File 'lib/discorb/guild.rb', line 1264

def guild_id
  @guild_id
end

#json_url -> String (readonly)

Returns The JSON URL.

Returns:

  • (String) —

    The JSON URL.




# File 'lib/discorb/guild.rb', line 1272

Instance Method Details

#edit(enabled: nil, channel: nil, reason: nil) -> Async::Task<void> Also known as: modify

Note:

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

Edit the widget.

Parameters:

  • enabled (Boolean) (defaults to: nil) —

    Whether the widget is enabled.

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

    The channel.

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

    The reason for editing the widget.

Returns:

  • (Async::Task<void>) —

    The task.



1311
1312
1313
1314
1315
1316
1317
1318
1319
 
# File 'lib/discorb/guild.rb', line 1311

def edit(enabled: nil, channel: nil, reason: nil)
  Async do
    payload = {}
    payload[:enabled] = enabled unless enabled.nil?
    payload[:channel_id] = channel.id if channel_id
    @client.http.request(Route.new("/guilds/#{@guild_id}/widget", "//guilds/:guild_id/widget", :patch), payload,
                         audit_log_reason: reason).wait
  end
end

#iframe(theme: "dark", width: 350, height: 500) -> String

Return iframe HTML of the widget.

Parameters:

  • theme ("dark", "light") (defaults to: "dark") —

    The theme of the widget.

  • width (Integer) (defaults to: 350) —

    The width of the widget.

  • height (Integer) (defaults to: 500) —

    The height of the widget.

Returns:

  • (String) —

    The iframe HTML.



1336
1337
1338
1339
1340
1341
1342
1343
 
# File 'lib/discorb/guild.rb', line 1336

def iframe(theme: "dark", width: 350, height: 500)
  # rubocop:disable Layout/LineLength
  [
    %(<iframe src="https://canary.discord.com/widget?id=#{@guild_id}&theme=#{theme}" width="#{width}" height="#{height}"),
    %(allowtransparency="true" frameborder="0" sandbox="allow-popups allow-popups-to-escape-sandbox allow-same-origin allow-scripts"></iframe>),
  ].join
  # rubocop:enable Layout/LineLength
end