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?, #hash

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 949

#channel_id -> Discorb::Snowflake (readonly)

Returns The channel ID.

Returns:



943
944
945
 
# File 'lib/discorb/guild.rb', line 943

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.



945
946
947
 
# File 'lib/discorb/guild.rb', line 945

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 949

#guild_id -> Discorb::Snowflake (readonly)

Returns The guild ID.

Returns:



941
942
943
 
# File 'lib/discorb/guild.rb', line 941

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 949

Instance Method Details

#edit(enabled: nil, channel: nil, reason: nil) -> 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.

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.

Raises:



980
981
982
983
984
985
986
987
 
# File 'lib/discorb/guild.rb', line 980

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.internet.patch("/guilds/#{@guild_id}/widget", 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.



1004
1005
1006
1007
1008
1009
 
# File 'lib/discorb/guild.rb', line 1004

def iframe(theme: "dark", width: 350, height: 500)
  [
    %(<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
end