Class: Discorb::Guild::Widget
- Inherits:
-
DiscordModel
- Object
- DiscordModel
- Discorb::Guild::Widget
- Defined in:
- lib/discorb/guild.rb
Overview
Represents a guild widget.
Instance Attribute Summary collapse
- #channel -> nil, Discorb::Channel readonly
-
#channel_id -> Discorb::Snowflake
readonly
The channel ID.
-
#enabled -> Boolean
(also: #enabled?, #enable?)
readonly
Whether the widget is enabled.
- #guild -> nil, Discorb::Guild readonly
-
#guild_id -> Discorb::Snowflake
readonly
The guild ID.
-
#json_url -> String
readonly
The JSON URL.
Instance Method Summary collapse
-
#edit(enabled: nil, channel: nil, reason: nil) -> Async::Task<void>
(also: #modify)
Edit the widget.
-
#iframe(theme: "dark", width: 350, height: 500) -> String
Return iframe HTML of the widget.
Methods inherited from DiscordModel
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.
|
# File 'lib/discorb/guild.rb', line 1057
|
#channel_id -> Discorb::Snowflake (readonly)
Returns The channel ID.
1051 1052 1053 |
# File 'lib/discorb/guild.rb', line 1051 def channel_id @channel_id end |
#enabled -> Boolean (readonly) Also known as: enabled?, enable?
Returns Whether the widget is enabled.
1053 1054 1055 |
# File 'lib/discorb/guild.rb', line 1053 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.
|
# File 'lib/discorb/guild.rb', line 1057
|
#guild_id -> Discorb::Snowflake (readonly)
Returns The guild ID.
1049 1050 1051 |
# File 'lib/discorb/guild.rb', line 1049 def guild_id @guild_id end |
#json_url -> String (readonly)
Returns The JSON URL.
|
# File 'lib/discorb/guild.rb', line 1057
|
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.
1096 1097 1098 1099 1100 1101 1102 1103 |
# File 'lib/discorb/guild.rb', line 1096 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.
1120 1121 1122 1123 1124 1125 |
# File 'lib/discorb/guild.rb', line 1120 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 |