<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Discorb::Guild
— Documentation by YARD 0.9.26
</title>
<link rel="stylesheet" href="../css/style.css" type="text/css" />
<link rel="stylesheet" href="../css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "Discorb::Guild";
relpath = '../';
</script>
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../a_index.html">Index (G)</a> »
<span class='title'><span class='object_link'><a href="../Discorb.html" title="Discorb (module)">Discorb</a></span></span>
»
<span class="title">Guild</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Class: Discorb::Guild
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName"><span class='object_link'><a href="DiscordModel.html" title="Discorb::DiscordModel (class)">DiscordModel</a></span></span>
<ul class="fullTree">
<li>Object</li>
<li class="next"><span class='object_link'><a href="DiscordModel.html" title="Discorb::DiscordModel (class)">DiscordModel</a></span></li>
<li class="next">Discorb::Guild</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/discorb/guild.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Represents a guild in the Discord.</p>
</div>
</div>
<div class="tags">
</div><h2>Defined Under Namespace</h2>
<p class="children">
<strong class="classes">Classes:</strong> <span class='object_link'><a href="Guild/Ban.html" title="Discorb::Guild::Ban (class)">Ban</a></span>, <span class='object_link'><a href="Guild/VanityInvite.html" title="Discorb::Guild::VanityInvite (class)">VanityInvite</a></span>, <span class='object_link'><a href="Guild/Widget.html" title="Discorb::Guild::Widget (class)">Widget</a></span>
</p>
<h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#afk_timeout-instance_method" title="#afk_timeout (instance method)">#<strong>afk_timeout</strong> ⇒ Integer </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'><p>The AFK timeout of the guild.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#approximate_member_count-instance_method" title="#approximate_member_count (instance method)">#<strong>approximate_member_count</strong> ⇒ Integer </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'><p>The approxmate amount of members in the guild.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#approximate_presence_count-instance_method" title="#approximate_presence_count (instance method)">#<strong>approximate_presence_count</strong> ⇒ Integer </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'><p>The approxmate amount of non-offline members in the guild.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#available-instance_method" title="#available (instance method)">#<strong>available</strong> ⇒ Boolean </a>
(also: #available?)
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'><p>Whether the guild is available.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#banner-instance_method" title="#banner (instance method)">#<strong>banner</strong> ⇒ Discorb::Asset<sup>?</sup> </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#channels-instance_method" title="#channels (instance method)">#<strong>channels</strong> ⇒ Discorb::Dictionary{Discorb::Snowflake => Discorb::GuildChannel} </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'><p>A dictionary of channels in the guild.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#default_message_notifications-instance_method" title="#default_message_notifications (instance method)">#<strong>default_message_notifications</strong> ⇒ :all_messages, :only_mentions </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'><p>The default message notification level of the guild.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#description-instance_method" title="#description (instance method)">#<strong>description</strong> ⇒ String </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'><p>The description of the guild.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#discovery_splash-instance_method" title="#discovery_splash (instance method)">#<strong>discovery_splash</strong> ⇒ Discorb::Asset </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'><p>The discovery splash of the guild.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#emojis-instance_method" title="#emojis (instance method)">#<strong>emojis</strong> ⇒ Discorb::Dictionary{Discorb::Snowflake => Discorb::CustomEmoji} </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'><p>A dictionary of custom emojis in the guild.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#explicit_content_filter-instance_method" title="#explicit_content_filter (instance method)">#<strong>explicit_content_filter</strong> ⇒ :disabled_in_text, ... </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'><p>The explict content filter level of the guild.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#features-instance_method" title="#features (instance method)">#<strong>features</strong> ⇒ Array<Symbol> </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'><p>Features that are enabled in the guild.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#icon-instance_method" title="#icon (instance method)">#<strong>icon</strong> ⇒ Discorb::Asset </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'><p>The icon of the guild.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#id-instance_method" title="#id (instance method)">#<strong>id</strong> ⇒ Discorb::Snowflake </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'><p>ID of the guild.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#joined_at-instance_method" title="#joined_at (instance method)">#<strong>joined_at</strong> ⇒ Time </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'><p>Time that representing when bot has joined the guild.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#large-instance_method" title="#large (instance method)">#<strong>large</strong> ⇒ Boolean </a>
(also: #large?)
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'><p>Whether the guild is large.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#max_presences-instance_method" title="#max_presences (instance method)">#<strong>max_presences</strong> ⇒ Integer </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'><p>Number of online members in the guild.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#max_video_channel_users-instance_method" title="#max_video_channel_users (instance method)">#<strong>max_video_channel_users</strong> ⇒ Integer </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'><p>The maximum amount of users in a video channel.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#member_count-instance_method" title="#member_count (instance method)">#<strong>member_count</strong> ⇒ Integer </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'><p>The amount of members in the guild.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#members-instance_method" title="#members (instance method)">#<strong>members</strong> ⇒ Discorb::Dictionary{Discorb::Snowflake => Discorb::Member} </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'><p>A dictionary of members in the guild.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#mfa_level-instance_method" title="#mfa_level (instance method)">#<strong>mfa_level</strong> ⇒ :none, :elevated </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'><p>The MFA level of the guild.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#name-instance_method" title="#name (instance method)">#<strong>name</strong> ⇒ String </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'><p>The name of the guild.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#nsfw_level-instance_method" title="#nsfw_level (instance method)">#<strong>nsfw_level</strong> ⇒ :default, ... </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'><p>The nsfw level of the guild.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#owner-instance_method" title="#owner (instance method)">#<strong>owner</strong> ⇒ Boolean </a>
(also: #owner?)
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'><p>Whether the client is the owner of the guild.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#owner_id-instance_method" title="#owner_id (instance method)">#<strong>owner_id</strong> ⇒ Discorb::Snowflake </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'><p>ID of the guild owner.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#permissions-instance_method" title="#permissions (instance method)">#<strong>permissions</strong> ⇒ Discorb::Permission </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'><p>The bot's permission in the guild.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#preferred_locale-instance_method" title="#preferred_locale (instance method)">#<strong>preferred_locale</strong> ⇒ Symbol </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'><p>The preffered language of the guild.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#premium_subscription_count-instance_method" title="#premium_subscription_count (instance method)">#<strong>premium_subscription_count</strong> ⇒ Integer </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'><p>The amount of premium subscriptions (Server Boosts) the guild has.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#premium_tier-instance_method" title="#premium_tier (instance method)">#<strong>premium_tier</strong> ⇒ Integer </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'><p>The premium tier (Boost Level) of the guild.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#presences-instance_method" title="#presences (instance method)">#<strong>presences</strong> ⇒ Discorb::Dictionary{Discorb::User => Discorb::Presence} </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'><p>A dictionary of presence in the guild.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#roles-instance_method" title="#roles (instance method)">#<strong>roles</strong> ⇒ Discorb::Dictionary{Discorb::Snowflake => Discorb::Role} </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'><p>A dictionary of roles in the guild.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#splash-instance_method" title="#splash (instance method)">#<strong>splash</strong> ⇒ Discorb::Asset </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'><p>The splash of the guild.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#stage_instances-instance_method" title="#stage_instances (instance method)">#<strong>stage_instances</strong> ⇒ Discorb::Dictionary{Discorb::Snowflake => Discorb::StageInstance} </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'><p>A dictionary of stage instances in the guild.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#system_channel_flags-instance_method" title="#system_channel_flags (instance method)">#<strong>system_channel_flags</strong> ⇒ Discorb::Guild::SystemChannelFlag </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'><p>The flag for the system channel.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#threads-instance_method" title="#threads (instance method)">#<strong>threads</strong> ⇒ Discorb::Dictionary{Discorb::Snowflake => Discorb::ThreadChannel} </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'><p>A dictionary of threads in the guild.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#unavailable-instance_method" title="#unavailable (instance method)">#<strong>unavailable</strong> ⇒ Boolean </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'><p>Whether the guild is unavailable.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#vanity_url_code-instance_method" title="#vanity_url_code (instance method)">#<strong>vanity_url_code</strong> ⇒ String<sup>?</sup> </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#verification_level-instance_method" title="#verification_level (instance method)">#<strong>verification_level</strong> ⇒ :none, ... </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'><p>The verification level of the guild.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#voice_states-instance_method" title="#voice_states (instance method)">#<strong>voice_states</strong> ⇒ Discorb::Dictionary{Discorb::User => Discorb::VoiceState} </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'><p>A dictionary of voice states in the guild.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#welcome_screen-instance_method" title="#welcome_screen (instance method)">#<strong>welcome_screen</strong> ⇒ Discorb::WelcomeScreen </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'><p>The welcome screen of the guild.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#widget_enabled-instance_method" title="#widget_enabled (instance method)">#<strong>widget_enabled</strong> ⇒ Boolean </a>
(also: #widget_enabled?)
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'><p>Whether the guild enabled the widget.</p>
</div></span>
</li>
</ul>
<h2>
Class Method Summary
<small><a href="#" class="summary_toggle">collapse</a></small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#banner-class_method" title="banner (class method)">.<strong>banner</strong>(guild_id, style: "banner") ⇒ String </a>
</span>
<span class="summary_desc"><div class='inline'><p>Returns a banner url from the guild's ID.</p>
</div></span>
</li>
</ul>
<h2>
Instance Method Summary
<small><a href="#" class="summary_toggle">collapse</a></small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#afk_channel-instance_method" title="#afk_channel (instance method)">#<strong>afk_channel</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#ban_member-instance_method" title="#ban_member (instance method)">#<strong>ban_member</strong>(member, delete_message_days: 0, reason: nil) ⇒ Discorb::Guild::Ban </a>
</span>
<span class="summary_desc"><div class='inline'><p>Ban a member from the guild.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#banned%3F-instance_method" title="#banned? (instance method)">#<strong>banned?</strong>(user) ⇒ Boolean </a>
</span>
<span class="summary_desc"><div class='inline'><p>Checks the user was banned from the guild.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#create_category_channel-instance_method" title="#create_category_channel (instance method)">#<strong>create_category_channel</strong>(name, position: nil, permission_overwrites: nil, parent: nil, reason: nil) ⇒ Discorb::CategoryChannel </a>
(also: #create_category)
</span>
<span class="summary_desc"><div class='inline'><p>Create a new category channel.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#create_emoji-instance_method" title="#create_emoji (instance method)">#<strong>create_emoji</strong>(name, image, roles: []) ⇒ Discorb::CustomEmoji </a>
</span>
<span class="summary_desc"><div class='inline'><p>Create a custom emoji.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#create_news_channel-instance_method" title="#create_news_channel (instance method)">#<strong>create_news_channel</strong>(name, topic: nil, rate_limit_per_user: nil, slowmode: nil, position: nil, nsfw: nil, permission_overwrites: nil, parent: nil, reason: nil) ⇒ Discorb::NewsChannel </a>
</span>
<span class="summary_desc"><div class='inline'><p>Create a new news channel.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#create_role-instance_method" title="#create_role (instance method)">#<strong>create_role</strong>(name = nil, color: nil, hoist: nil, mentionable: nil, reason: nil) ⇒ Discorb::Role </a>
</span>
<span class="summary_desc"><div class='inline'><p>Create a role in the guild.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#create_stage_channel-instance_method" title="#create_stage_channel (instance method)">#<strong>create_stage_channel</strong>(name, bitrate: 64, position: nil, permission_overwrites: nil, parent: nil, reason: nil) ⇒ Discorb::StageChannel </a>
</span>
<span class="summary_desc"><div class='inline'><p>Create a new stage channel.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#create_template-instance_method" title="#create_template (instance method)">#<strong>create_template</strong>(name, description = nil, reason: nil) ⇒ Discorb::GuildTemplate </a>
</span>
<span class="summary_desc"><div class='inline'><p>Create a new template in the guild.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#create_text_channel-instance_method" title="#create_text_channel (instance method)">#<strong>create_text_channel</strong>(name, topic: nil, rate_limit_per_user: nil, slowmode: nil, position: nil, nsfw: nil, permission_overwrites: nil, parent: nil, reason: nil) ⇒ Discorb::TextChannel </a>
</span>
<span class="summary_desc"><div class='inline'><p>Create a new text channel.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#create_voice_channel-instance_method" title="#create_voice_channel (instance method)">#<strong>create_voice_channel</strong>(name, bitrate: 64, user_limit: nil, position: nil, permission_overwrites: nil, parent: nil, reason: nil) ⇒ Discorb::VoiceChannel </a>
</span>
<span class="summary_desc"><div class='inline'><p>Create a new voice channel.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#edit_nickname-instance_method" title="#edit_nickname (instance method)">#<strong>edit_nickname</strong>(nickname, reason: nil) ⇒ Object </a>
(also: #edit_nick, #modify_nickname)
</span>
<span class="summary_desc"><div class='inline'><p>Change nickname of client member.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#fetch_active_threads-instance_method" title="#fetch_active_threads (instance method)">#<strong>fetch_active_threads</strong> ⇒ Array<Discorb::ThreadChannel> </a>
</span>
<span class="summary_desc"><div class='inline'><p>Fetch a list of active threads in the guild.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#fetch_audit_log-instance_method" title="#fetch_audit_log (instance method)">#<strong>fetch_audit_log</strong> ⇒ Discorb::AuditLog </a>
</span>
<span class="summary_desc"><div class='inline'><p>Fetch audit log of the guild.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#fetch_ban-instance_method" title="#fetch_ban (instance method)">#<strong>fetch_ban</strong>(user) ⇒ Discorb::Guild::Ban<sup>?</sup> </a>
</span>
<span class="summary_desc"><div class='inline'><p>Fetch a ban in the guild.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#fetch_bans-instance_method" title="#fetch_bans (instance method)">#<strong>fetch_bans</strong> ⇒ Array<Discorb::Guild::Ban> </a>
</span>
<span class="summary_desc"><div class='inline'><p>Fetch a list of bans in the guild.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#fetch_channels-instance_method" title="#fetch_channels (instance method)">#<strong>fetch_channels</strong> ⇒ Array<Discorb::Channel> </a>
</span>
<span class="summary_desc"><div class='inline'><p>Fetch channels of the guild.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#fetch_emoji-instance_method" title="#fetch_emoji (instance method)">#<strong>fetch_emoji</strong>(id) ⇒ Discorb::CustomEmoji </a>
</span>
<span class="summary_desc"><div class='inline'><p>Fetch emoji id of the guild.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#fetch_emoji_list-instance_method" title="#fetch_emoji_list (instance method)">#<strong>fetch_emoji_list</strong> ⇒ Discorb::Dictionary{Discorb::Snowflake => Discorb::CustomEmoji} </a>
(also: #fetch_emojis)
</span>
<span class="summary_desc"><div class='inline'><p>Fetch emoji list of the guild.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#fetch_integrations-instance_method" title="#fetch_integrations (instance method)">#<strong>fetch_integrations</strong> ⇒ Array<Discorb::Integration> </a>
</span>
<span class="summary_desc"><div class='inline'><p>Fetch integrations in the guild.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#fetch_invites-instance_method" title="#fetch_invites (instance method)">#<strong>fetch_invites</strong> ⇒ Array<Invite> </a>
</span>
<span class="summary_desc"><div class='inline'><p>Fetch invites in the guild.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#fetch_member-instance_method" title="#fetch_member (instance method)">#<strong>fetch_member</strong>(id) ⇒ Discorb::Member<sup>?</sup> </a>
</span>
<span class="summary_desc"><div class='inline'><p>Fetch a member in the guild.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#fetch_member_named-instance_method" title="#fetch_member_named (instance method)">#<strong>fetch_member_named</strong> ⇒ Discorb::Member<sup>?</sup> </a>
</span>
<span class="summary_desc"><div class='inline'><p>Almost the same as <span class='object_link'><a href="#fetch_members_named-instance_method" title="Discorb::Guild#fetch_members_named (method)">#fetch_members_named</a></span>, but returns a single member.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#fetch_members_named-instance_method" title="#fetch_members_named (instance method)">#<strong>fetch_members_named</strong>(name, limit: 1) ⇒ Array<Discorb::Member> </a>
</span>
<span class="summary_desc"><div class='inline'><p>Search for members by name in the guild.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#fetch_prune-instance_method" title="#fetch_prune (instance method)">#<strong>fetch_prune</strong>(days = 7, roles: []) ⇒ Integer </a>
</span>
<span class="summary_desc"><div class='inline'><p>Fetch how many members will be pruned.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#fetch_roles-instance_method" title="#fetch_roles (instance method)">#<strong>fetch_roles</strong> ⇒ Array<Discorb::Role> </a>
</span>
<span class="summary_desc"><div class='inline'><p>Fetch a list of roles in the guild.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#fetch_sticker-instance_method" title="#fetch_sticker (instance method)">#<strong>fetch_sticker</strong>(id) ⇒ Discorb::Sticker::GuildSticker<sup>?</sup> </a>
</span>
<span class="summary_desc"><div class='inline'><p>Fetch the sticker by ID.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#fetch_stickers-instance_method" title="#fetch_stickers (instance method)">#<strong>fetch_stickers</strong> ⇒ Array<Discorb::Sticker::GuildSticker> </a>
</span>
<span class="summary_desc"><div class='inline'><p>Fetch stickers in the guild.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#fetch_template-instance_method" title="#fetch_template (instance method)">#<strong>fetch_template</strong> ⇒ Discorb::GuildTemplate<sup>?</sup> </a>
</span>
<span class="summary_desc"><div class='inline'><p>Almost the same as <span class='object_link'><a href="#fetch_templates-instance_method" title="Discorb::Guild#fetch_templates (method)">#fetch_templates</a></span>, but returns a single template.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#fetch_templates-instance_method" title="#fetch_templates (instance method)">#<strong>fetch_templates</strong> ⇒ Discorb::GuildTemplate </a>
</span>
<span class="summary_desc"><div class='inline'><p>Fetch templates in the guild.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#fetch_vanity_invite-instance_method" title="#fetch_vanity_invite (instance method)">#<strong>fetch_vanity_invite</strong> ⇒ Discorb::Guild::VanityInvite </a>
</span>
<span class="summary_desc"><div class='inline'><p>Fetch the vanity URL of the guild.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#fetch_voice_regions-instance_method" title="#fetch_voice_regions (instance method)">#<strong>fetch_voice_regions</strong> ⇒ Array<Discorb::VoiceRegion> </a>
</span>
<span class="summary_desc"><div class='inline'><p>Fetch voice regions that are available in the guild.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#fetch_webhooks-instance_method" title="#fetch_webhooks (instance method)">#<strong>fetch_webhooks</strong> ⇒ Array<Discorb::Webhook> </a>
</span>
<span class="summary_desc"><div class='inline'><p>Fetch webhooks of the guild.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#fetch_welcome_screen-instance_method" title="#fetch_welcome_screen (instance method)">#<strong>fetch_welcome_screen</strong> ⇒ Discorb::Guild::WelcomeScreen </a>
</span>
<span class="summary_desc"><div class='inline'><p>Fetch the welcome screen of the guild.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#fetch_widget-instance_method" title="#fetch_widget (instance method)">#<strong>fetch_widget</strong> ⇒ Discorb::Guild::Widget </a>
</span>
<span class="summary_desc"><div class='inline'><p>Fetch the widget of the guild.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#inspect-instance_method" title="#inspect (instance method)">#<strong>inspect</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#kick_member-instance_method" title="#kick_member (instance method)">#<strong>kick_member</strong>(member, reason: nil) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Kick a member from the guild.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#leave!-instance_method" title="#leave! (instance method)">#<strong>leave!</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Leave the guild.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#me-instance_method" title="#me (instance method)">#<strong>me</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#prune-instance_method" title="#prune (instance method)">#<strong>prune</strong>(days = 7, roles: [], reason: nil) ⇒ Integer </a>
</span>
<span class="summary_desc"><div class='inline'><p>Prune members from the guild.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#public_updates_channel-instance_method" title="#public_updates_channel (instance method)">#<strong>public_updates_channel</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#rules_channel-instance_method" title="#rules_channel (instance method)">#<strong>rules_channel</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#system_channel-instance_method" title="#system_channel (instance method)">#<strong>system_channel</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#unban_user-instance_method" title="#unban_user (instance method)">#<strong>unban_user</strong>(user, reason: nil) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Unban a user from the guild.</p>
</div></span>
</li>
</ul>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="DiscordModel.html" title="Discorb::DiscordModel (class)">DiscordModel</a></span></h3>
<p class="inherited"><span class='object_link'><a href="DiscordModel.html#==-instance_method" title="Discorb::DiscordModel#== (method)">#==</a></span>, <span class='object_link'><a href="DiscordModel.html#eql%3F-instance_method" title="Discorb::DiscordModel#eql? (method)">#eql?</a></span>, <span class='object_link'><a href="DiscordModel.html#hash-instance_method" title="Discorb::DiscordModel#hash (method)">#hash</a></span></p>
<div id="instance_attr_details" class="attr_details">
<h2>Instance Attribute Details</h2>
<span id=""></span>
<div class="method_details first">
<h3 class="signature first" id="afk_timeout-instance_method">
#<strong>afk_timeout</strong> ⇒ <tt>Integer</tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns The AFK timeout of the guild.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Integer</tt>)</span>
—
<div class='inline'><p>The AFK timeout of the guild.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
21
22
23</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/guild.rb', line 21</span>
<span class='kw'>def</span> <span class='id identifier rubyid_afk_timeout'>afk_timeout</span>
<span class='ivar'>@afk_timeout</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="approximate_member_count-instance_method">
#<strong>approximate_member_count</strong> ⇒ <tt>Integer</tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns The approxmate amount of members in the guild.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Integer</tt>)</span>
—
<div class='inline'><p>The approxmate amount of members in the guild.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
72
73
74</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/guild.rb', line 72</span>
<span class='kw'>def</span> <span class='id identifier rubyid_approximate_member_count'>approximate_member_count</span>
<span class='ivar'>@approximate_member_count</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="approximate_presence_count-instance_method">
#<strong>approximate_presence_count</strong> ⇒ <tt>Integer</tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns The approxmate amount of non-offline members in the guild.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Integer</tt>)</span>
—
<div class='inline'><p>The approxmate amount of non-offline members in the guild.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
74
75
76</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/guild.rb', line 74</span>
<span class='kw'>def</span> <span class='id identifier rubyid_approximate_presence_count'>approximate_presence_count</span>
<span class='ivar'>@approximate_presence_count</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="available-instance_method">
#<strong>available</strong> ⇒ <tt>Boolean</tt> <span class="extras">(readonly)</span>
<span class="aliases">Also known as:
<span class="names"><span id='available?-instance_method'>available?</span></span>
</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns Whether the guild is available.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Boolean</tt>)</span>
—
<div class='inline'><p>Whether the guild is available.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
97
98
99</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/guild.rb', line 97</span>
<span class='kw'>def</span> <span class='id identifier rubyid_available'>available</span>
<span class='ivar'>@available</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="banner-instance_method">
#<strong>banner</strong> ⇒ <tt><span class='object_link'><a href="Asset.html" title="Discorb::Asset (class)">Discorb::Asset</a></span></tt><sup>?</sup> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="Asset.html" title="Discorb::Asset (class)">Discorb::Asset</a></span></tt>)</span>
—
<div class='inline'><p>The banner of the guild.</p>
</div>
</li>
<li>
<span class='type'>(<tt>nil</tt>)</span>
—
<div class='inline'><p>If the guild does not have a banner.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
61
62
63</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/guild.rb', line 61</span>
<span class='kw'>def</span> <span class='id identifier rubyid_banner'>banner</span>
<span class='ivar'>@banner</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="channels-instance_method">
#<strong>channels</strong> ⇒ <tt><span class='object_link'><a href="Dictionary.html" title="Discorb::Dictionary (class)">Discorb::Dictionary</a></span>{<span class='object_link'><a href="Snowflake.html" title="Discorb::Snowflake (class)">Discorb::Snowflake</a></span> => <span class='object_link'><a href="GuildChannel.html" title="Discorb::GuildChannel (class)">Discorb::GuildChannel</a></span>}</tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns A dictionary of channels in the guild.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="Dictionary.html" title="Discorb::Dictionary (class)">Discorb::Dictionary</a></span>{<span class='object_link'><a href="Snowflake.html" title="Discorb::Snowflake (class)">Discorb::Snowflake</a></span> => <span class='object_link'><a href="GuildChannel.html" title="Discorb::GuildChannel (class)">Discorb::GuildChannel</a></span>}</tt>)</span>
—
<div class='inline'><p>A dictionary of channels in the guild.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
47
48
49</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/guild.rb', line 47</span>
<span class='kw'>def</span> <span class='id identifier rubyid_channels'>channels</span>
<span class='ivar'>@channels</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="default_message_notifications-instance_method">
#<strong>default_message_notifications</strong> ⇒ <tt>:all_messages</tt>, <tt>:only_mentions</tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns The default message notification level of the guild.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>:all_messages</tt>, <tt>:only_mentions</tt>)</span>
—
<div class='inline'><p>The default message notification level of the guild.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
84
85
86</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/guild.rb', line 84</span>
<span class='kw'>def</span> <span class='id identifier rubyid_default_message_notifications'>default_message_notifications</span>
<span class='ivar'>@default_message_notifications</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="description-instance_method">
#<strong>description</strong> ⇒ <tt>String</tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns The description of the guild.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>String</tt>)</span>
—
<div class='inline'><p>The description of the guild.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
58
59
60</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/guild.rb', line 58</span>
<span class='kw'>def</span> <span class='id identifier rubyid_description'>description</span>
<span class='ivar'>@description</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="discovery_splash-instance_method">
#<strong>discovery_splash</strong> ⇒ <tt><span class='object_link'><a href="Asset.html" title="Discorb::Asset (class)">Discorb::Asset</a></span></tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns The discovery splash of the guild.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="Asset.html" title="Discorb::Asset (class)">Discorb::Asset</a></span></tt>)</span>
—
<div class='inline'><p>The discovery splash of the guild.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
15
16
17</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/guild.rb', line 15</span>
<span class='kw'>def</span> <span class='id identifier rubyid_discovery_splash'>discovery_splash</span>
<span class='ivar'>@discovery_splash</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="emojis-instance_method">
#<strong>emojis</strong> ⇒ <tt><span class='object_link'><a href="Dictionary.html" title="Discorb::Dictionary (class)">Discorb::Dictionary</a></span>{<span class='object_link'><a href="Snowflake.html" title="Discorb::Snowflake (class)">Discorb::Snowflake</a></span> => <span class='object_link'><a href="CustomEmoji.html" title="Discorb::CustomEmoji (class)">Discorb::CustomEmoji</a></span>}</tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns A dictionary of custom emojis in the guild.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="Dictionary.html" title="Discorb::Dictionary (class)">Discorb::Dictionary</a></span>{<span class='object_link'><a href="Snowflake.html" title="Discorb::Snowflake (class)">Discorb::Snowflake</a></span> => <span class='object_link'><a href="CustomEmoji.html" title="Discorb::CustomEmoji (class)">Discorb::CustomEmoji</a></span>}</tt>)</span>
—
<div class='inline'><p>A dictionary of custom emojis in the guild.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
25
26
27</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/guild.rb', line 25</span>
<span class='kw'>def</span> <span class='id identifier rubyid_emojis'>emojis</span>
<span class='ivar'>@emojis</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="explicit_content_filter-instance_method">
#<strong>explicit_content_filter</strong> ⇒ <tt>:disabled_in_text</tt>, ... <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns The explict content filter level of the guild.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>:disabled_in_text</tt>, <tt>:members_without_roles</tt>, <tt>:all_members</tt>)</span>
—
<div class='inline'><p>The explict content filter level of the guild.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
86
87
88</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/guild.rb', line 86</span>
<span class='kw'>def</span> <span class='id identifier rubyid_explicit_content_filter'>explicit_content_filter</span>
<span class='ivar'>@explicit_content_filter</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="features-instance_method">
#<strong>features</strong> ⇒ <tt>Array<Symbol></tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns features that are enabled in the guild.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Array<Symbol></tt>)</span>
—
<div class='inline'><p>features that are enabled in the guild.</p>
</div>
</li>
</ul>
<p class="tag_title">See Also:</p>
<ul class="see">
<li><a href="https://discord.com/developers/docs/resources/guild#guild-object-guild-features" target="_parent" title="Official Discord API docs">Official Discord API docs</a></li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
28
29
30</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/guild.rb', line 28</span>
<span class='kw'>def</span> <span class='id identifier rubyid_features'>features</span>
<span class='ivar'>@features</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="icon-instance_method">
#<strong>icon</strong> ⇒ <tt><span class='object_link'><a href="Asset.html" title="Discorb::Asset (class)">Discorb::Asset</a></span></tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns The icon of the guild.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="Asset.html" title="Discorb::Asset (class)">Discorb::Asset</a></span></tt>)</span>
—
<div class='inline'><p>The icon of the guild.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
40
41
42</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/guild.rb', line 40</span>
<span class='kw'>def</span> <span class='id identifier rubyid_icon'>icon</span>
<span class='ivar'>@icon</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="id-instance_method">
#<strong>id</strong> ⇒ <tt><span class='object_link'><a href="Snowflake.html" title="Discorb::Snowflake (class)">Discorb::Snowflake</a></span></tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns ID of the guild.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="Snowflake.html" title="Discorb::Snowflake (class)">Discorb::Snowflake</a></span></tt>)</span>
—
<div class='inline'><p>ID of the guild.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
9
10
11</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/guild.rb', line 9</span>
<span class='kw'>def</span> <span class='id identifier rubyid_id'>id</span>
<span class='ivar'>@id</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="joined_at-instance_method">
#<strong>joined_at</strong> ⇒ <tt><span class='object_link'><a href="../Time.html" title="Time (class)">Time</a></span></tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns Time that representing when bot has joined the guild.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="../Time.html" title="Time (class)">Time</a></span></tt>)</span>
—
<div class='inline'><p>Time that representing when bot has joined the guild.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
34
35
36</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/guild.rb', line 34</span>
<span class='kw'>def</span> <span class='id identifier rubyid_joined_at'>joined_at</span>
<span class='ivar'>@joined_at</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="large-instance_method">
#<strong>large</strong> ⇒ <tt>Boolean</tt> <span class="extras">(readonly)</span>
<span class="aliases">Also known as:
<span class="names"><span id='large?-instance_method'>large?</span></span>
</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns Whether the guild is large.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Boolean</tt>)</span>
—
<div class='inline'><p>Whether the guild is large.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
91
92
93</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/guild.rb', line 91</span>
<span class='kw'>def</span> <span class='id identifier rubyid_large'>large</span>
<span class='ivar'>@large</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="max_presences-instance_method">
#<strong>max_presences</strong> ⇒ <tt>Integer</tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns Number of online members in the guild.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Integer</tt>)</span>
—
<div class='inline'><p>Number of online members in the guild.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
53
54
55</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/guild.rb', line 53</span>
<span class='kw'>def</span> <span class='id identifier rubyid_max_presences'>max_presences</span>
<span class='ivar'>@max_presences</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="max_video_channel_users-instance_method">
#<strong>max_video_channel_users</strong> ⇒ <tt>Integer</tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns The maximum amount of users in a video channel.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Integer</tt>)</span>
—
<div class='inline'><p>The maximum amount of users in a video channel.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
70
71
72</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/guild.rb', line 70</span>
<span class='kw'>def</span> <span class='id identifier rubyid_max_video_channel_users'>max_video_channel_users</span>
<span class='ivar'>@max_video_channel_users</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="member_count-instance_method">
#<strong>member_count</strong> ⇒ <tt>Integer</tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns The amount of members in the guild.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Integer</tt>)</span>
—
<div class='inline'><p>The amount of members in the guild.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
38
39
40</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/guild.rb', line 38</span>
<span class='kw'>def</span> <span class='id identifier rubyid_member_count'>member_count</span>
<span class='ivar'>@member_count</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="members-instance_method">
#<strong>members</strong> ⇒ <tt><span class='object_link'><a href="Dictionary.html" title="Discorb::Dictionary (class)">Discorb::Dictionary</a></span>{<span class='object_link'><a href="Snowflake.html" title="Discorb::Snowflake (class)">Discorb::Snowflake</a></span> => <span class='object_link'><a href="Member.html" title="Discorb::Member (class)">Discorb::Member</a></span>}</tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<div class="note notetag">
<strong>Note:</strong>
<div class='inline'><p>You must enable <code>GUILD_MEMBERS</code> intent to use this method.</p>
</div>
</div>
<p>Returns A dictionary of members in the guild.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="Dictionary.html" title="Discorb::Dictionary (class)">Discorb::Dictionary</a></span>{<span class='object_link'><a href="Snowflake.html" title="Discorb::Snowflake (class)">Discorb::Snowflake</a></span> => <span class='object_link'><a href="Member.html" title="Discorb::Member (class)">Discorb::Member</a></span>}</tt>)</span>
—
<div class='inline'><p>A dictionary of members in the guild.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
45
46
47</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/guild.rb', line 45</span>
<span class='kw'>def</span> <span class='id identifier rubyid_members'>members</span>
<span class='ivar'>@members</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="mfa_level-instance_method">
#<strong>mfa_level</strong> ⇒ <tt>:none</tt>, <tt>:elevated</tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns The MFA level of the guild.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>:none</tt>, <tt>:elevated</tt>)</span>
—
<div class='inline'><p>The MFA level of the guild.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
30
31
32</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/guild.rb', line 30</span>
<span class='kw'>def</span> <span class='id identifier rubyid_mfa_level'>mfa_level</span>
<span class='ivar'>@mfa_level</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="name-instance_method">
#<strong>name</strong> ⇒ <tt>String</tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns The name of the guild.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>String</tt>)</span>
—
<div class='inline'><p>The name of the guild.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
11
12
13</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/guild.rb', line 11</span>
<span class='kw'>def</span> <span class='id identifier rubyid_name'>name</span>
<span class='ivar'>@name</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="nsfw_level-instance_method">
#<strong>nsfw_level</strong> ⇒ <tt>:default</tt>, ... <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns The nsfw level of the guild.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>:default</tt>, <tt>:explicit</tt>, <tt>:safe</tt>, <tt>:age_restricted</tt>)</span>
—
<div class='inline'><p>The nsfw level of the guild.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
78
79
80</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/guild.rb', line 78</span>
<span class='kw'>def</span> <span class='id identifier rubyid_nsfw_level'>nsfw_level</span>
<span class='ivar'>@nsfw_level</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="owner-instance_method">
#<strong>owner</strong> ⇒ <tt>Boolean</tt> <span class="extras">(readonly)</span>
<span class="aliases">Also known as:
<span class="names"><span id='owner?-instance_method'>owner?</span></span>
</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns Whether the client is the owner of the guild.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Boolean</tt>)</span>
—
<div class='inline'><p>Whether the client is the owner of the guild.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
88
89
90</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/guild.rb', line 88</span>
<span class='kw'>def</span> <span class='id identifier rubyid_owner'>owner</span>
<span class='ivar'>@owner</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="owner_id-instance_method">
#<strong>owner_id</strong> ⇒ <tt><span class='object_link'><a href="Snowflake.html" title="Discorb::Snowflake (class)">Discorb::Snowflake</a></span></tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns ID of the guild owner.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="Snowflake.html" title="Discorb::Snowflake (class)">Discorb::Snowflake</a></span></tt>)</span>
—
<div class='inline'><p>ID of the guild owner.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
17
18
19</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/guild.rb', line 17</span>
<span class='kw'>def</span> <span class='id identifier rubyid_owner_id'>owner_id</span>
<span class='ivar'>@owner_id</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="permissions-instance_method">
#<strong>permissions</strong> ⇒ <tt><span class='object_link'><a href="Permission.html" title="Discorb::Permission (class)">Discorb::Permission</a></span></tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns The bot's permission in the guild.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="Permission.html" title="Discorb::Permission (class)">Discorb::Permission</a></span></tt>)</span>
—
<div class='inline'><p>The bot's permission in the guild.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
19
20
21</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/guild.rb', line 19</span>
<span class='kw'>def</span> <span class='id identifier rubyid_permissions'>permissions</span>
<span class='ivar'>@permissions</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="preferred_locale-instance_method">
#<strong>preferred_locale</strong> ⇒ <tt>Symbol</tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<div class="note notetag">
<strong>Note:</strong>
<div class='inline'><p>This modifies the language code, <code>-</code> will be replaced with <code>_</code>.</p>
</div>
</div>
<p>Returns The preffered language of the guild.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Symbol</tt>)</span>
—
<div class='inline'><p>The preffered language of the guild.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
68
69
70</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/guild.rb', line 68</span>
<span class='kw'>def</span> <span class='id identifier rubyid_preferred_locale'>preferred_locale</span>
<span class='ivar'>@preferred_locale</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="premium_subscription_count-instance_method">
#<strong>premium_subscription_count</strong> ⇒ <tt>Integer</tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns The amount of premium subscriptions (Server Boosts) the guild has.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Integer</tt>)</span>
—
<div class='inline'><p>The amount of premium subscriptions (Server Boosts) the guild has.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
65
66
67</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/guild.rb', line 65</span>
<span class='kw'>def</span> <span class='id identifier rubyid_premium_subscription_count'>premium_subscription_count</span>
<span class='ivar'>@premium_subscription_count</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="premium_tier-instance_method">
#<strong>premium_tier</strong> ⇒ <tt>Integer</tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns The premium tier (Boost Level) of the guild.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Integer</tt>)</span>
—
<div class='inline'><p>The premium tier (Boost Level) of the guild.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
63
64
65</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/guild.rb', line 63</span>
<span class='kw'>def</span> <span class='id identifier rubyid_premium_tier'>premium_tier</span>
<span class='ivar'>@premium_tier</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="presences-instance_method">
#<strong>presences</strong> ⇒ <tt><span class='object_link'><a href="Dictionary.html" title="Discorb::Dictionary (class)">Discorb::Dictionary</a></span>{<span class='object_link'><a href="User.html" title="Discorb::User (class)">Discorb::User</a></span> => <span class='object_link'><a href="Presence.html" title="Discorb::Presence (class)">Discorb::Presence</a></span>}</tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns A dictionary of presence in the guild.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="Dictionary.html" title="Discorb::Dictionary (class)">Discorb::Dictionary</a></span>{<span class='object_link'><a href="User.html" title="Discorb::User (class)">Discorb::User</a></span> => <span class='object_link'><a href="Presence.html" title="Discorb::Presence (class)">Discorb::Presence</a></span>}</tt>)</span>
—
<div class='inline'><p>A dictionary of presence in the guild.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
51
52
53</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/guild.rb', line 51</span>
<span class='kw'>def</span> <span class='id identifier rubyid_presences'>presences</span>
<span class='ivar'>@presences</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="roles-instance_method">
#<strong>roles</strong> ⇒ <tt><span class='object_link'><a href="Dictionary.html" title="Discorb::Dictionary (class)">Discorb::Dictionary</a></span>{<span class='object_link'><a href="Snowflake.html" title="Discorb::Snowflake (class)">Discorb::Snowflake</a></span> => <span class='object_link'><a href="Role.html" title="Discorb::Role (class)">Discorb::Role</a></span>}</tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns A dictionary of roles in the guild.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="Dictionary.html" title="Discorb::Dictionary (class)">Discorb::Dictionary</a></span>{<span class='object_link'><a href="Snowflake.html" title="Discorb::Snowflake (class)">Discorb::Snowflake</a></span> => <span class='object_link'><a href="Role.html" title="Discorb::Role (class)">Discorb::Role</a></span>}</tt>)</span>
—
<div class='inline'><p>A dictionary of roles in the guild.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
23
24
25</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/guild.rb', line 23</span>
<span class='kw'>def</span> <span class='id identifier rubyid_roles'>roles</span>
<span class='ivar'>@roles</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="splash-instance_method">
#<strong>splash</strong> ⇒ <tt><span class='object_link'><a href="Asset.html" title="Discorb::Asset (class)">Discorb::Asset</a></span></tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns The splash of the guild.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="Asset.html" title="Discorb::Asset (class)">Discorb::Asset</a></span></tt>)</span>
—
<div class='inline'><p>The splash of the guild.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
13
14
15</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/guild.rb', line 13</span>
<span class='kw'>def</span> <span class='id identifier rubyid_splash'>splash</span>
<span class='ivar'>@splash</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="stage_instances-instance_method">
#<strong>stage_instances</strong> ⇒ <tt><span class='object_link'><a href="Dictionary.html" title="Discorb::Dictionary (class)">Discorb::Dictionary</a></span>{<span class='object_link'><a href="Snowflake.html" title="Discorb::Snowflake (class)">Discorb::Snowflake</a></span> => <span class='object_link'><a href="StageInstance.html" title="Discorb::StageInstance (class)">Discorb::StageInstance</a></span>}</tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns A dictionary of stage instances in the guild.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="Dictionary.html" title="Discorb::Dictionary (class)">Discorb::Dictionary</a></span>{<span class='object_link'><a href="Snowflake.html" title="Discorb::Snowflake (class)">Discorb::Snowflake</a></span> => <span class='object_link'><a href="StageInstance.html" title="Discorb::StageInstance (class)">Discorb::StageInstance</a></span>}</tt>)</span>
—
<div class='inline'><p>A dictionary of stage instances in the guild.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
80
81
82</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/guild.rb', line 80</span>
<span class='kw'>def</span> <span class='id identifier rubyid_stage_instances'>stage_instances</span>
<span class='ivar'>@stage_instances</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="system_channel_flags-instance_method">
#<strong>system_channel_flags</strong> ⇒ <tt>Discorb::Guild::SystemChannelFlag</tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns The flag for the system channel.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Discorb::Guild::SystemChannelFlag</tt>)</span>
—
<div class='inline'><p>The flag for the system channel.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
32
33
34</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/guild.rb', line 32</span>
<span class='kw'>def</span> <span class='id identifier rubyid_system_channel_flags'>system_channel_flags</span>
<span class='ivar'>@system_channel_flags</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="threads-instance_method">
#<strong>threads</strong> ⇒ <tt><span class='object_link'><a href="Dictionary.html" title="Discorb::Dictionary (class)">Discorb::Dictionary</a></span>{<span class='object_link'><a href="Snowflake.html" title="Discorb::Snowflake (class)">Discorb::Snowflake</a></span> => <span class='object_link'><a href="ThreadChannel.html" title="Discorb::ThreadChannel (class)">Discorb::ThreadChannel</a></span>}</tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns A dictionary of threads in the guild.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="Dictionary.html" title="Discorb::Dictionary (class)">Discorb::Dictionary</a></span>{<span class='object_link'><a href="Snowflake.html" title="Discorb::Snowflake (class)">Discorb::Snowflake</a></span> => <span class='object_link'><a href="ThreadChannel.html" title="Discorb::ThreadChannel (class)">Discorb::ThreadChannel</a></span>}</tt>)</span>
—
<div class='inline'><p>A dictionary of threads in the guild.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
49
50
51</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/guild.rb', line 49</span>
<span class='kw'>def</span> <span class='id identifier rubyid_threads'>threads</span>
<span class='ivar'>@threads</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="unavailable-instance_method">
#<strong>unavailable</strong> ⇒ <tt>Boolean</tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns Whether the guild is unavailable.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Boolean</tt>)</span>
—
<div class='inline'><p>Whether the guild is unavailable.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
36
37
38</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/guild.rb', line 36</span>
<span class='kw'>def</span> <span class='id identifier rubyid_unavailable'>unavailable</span>
<span class='ivar'>@unavailable</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="vanity_url_code-instance_method">
#<strong>vanity_url_code</strong> ⇒ <tt>String</tt><sup>?</sup> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>String</tt>)</span>
—
<div class='inline'><p>The vanity invite URL for the guild.</p>
</div>
</li>
<li>
<span class='type'>(<tt>nil</tt>)</span>
—
<div class='inline'><p>If the guild does not have a vanity invite URL.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
56
57
58</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/guild.rb', line 56</span>
<span class='kw'>def</span> <span class='id identifier rubyid_vanity_url_code'>vanity_url_code</span>
<span class='ivar'>@vanity_url_code</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="verification_level-instance_method">
#<strong>verification_level</strong> ⇒ <tt>:none</tt>, ... <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns The verification level of the guild.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>:none</tt>, <tt>:low</tt>, <tt>:medium</tt>, <tt>:high</tt>, <tt>:very_high</tt>)</span>
—
<div class='inline'><p>The verification level of the guild.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
82
83
84</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/guild.rb', line 82</span>
<span class='kw'>def</span> <span class='id identifier rubyid_verification_level'>verification_level</span>
<span class='ivar'>@verification_level</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="voice_states-instance_method">
#<strong>voice_states</strong> ⇒ <tt><span class='object_link'><a href="Dictionary.html" title="Discorb::Dictionary (class)">Discorb::Dictionary</a></span>{<span class='object_link'><a href="User.html" title="Discorb::User (class)">Discorb::User</a></span> => <span class='object_link'><a href="VoiceState.html" title="Discorb::VoiceState (class)">Discorb::VoiceState</a></span>}</tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns A dictionary of voice states in the guild.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="Dictionary.html" title="Discorb::Dictionary (class)">Discorb::Dictionary</a></span>{<span class='object_link'><a href="User.html" title="Discorb::User (class)">Discorb::User</a></span> => <span class='object_link'><a href="VoiceState.html" title="Discorb::VoiceState (class)">Discorb::VoiceState</a></span>}</tt>)</span>
—
<div class='inline'><p>A dictionary of voice states in the guild.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
42
43
44</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/guild.rb', line 42</span>
<span class='kw'>def</span> <span class='id identifier rubyid_voice_states'>voice_states</span>
<span class='ivar'>@voice_states</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="welcome_screen-instance_method">
#<strong>welcome_screen</strong> ⇒ <tt><span class='object_link'><a href="WelcomeScreen.html" title="Discorb::WelcomeScreen (class)">Discorb::WelcomeScreen</a></span></tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns The welcome screen of the guild.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="WelcomeScreen.html" title="Discorb::WelcomeScreen (class)">Discorb::WelcomeScreen</a></span></tt>)</span>
—
<div class='inline'><p>The welcome screen of the guild.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
76
77
78</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/guild.rb', line 76</span>
<span class='kw'>def</span> <span class='id identifier rubyid_welcome_screen'>welcome_screen</span>
<span class='ivar'>@welcome_screen</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="widget_enabled-instance_method">
#<strong>widget_enabled</strong> ⇒ <tt>Boolean</tt> <span class="extras">(readonly)</span>
<span class="aliases">Also known as:
<span class="names"><span id='widget_enabled?-instance_method'>widget_enabled?</span></span>
</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns Whether the guild enabled the widget.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Boolean</tt>)</span>
—
<div class='inline'><p>Whether the guild enabled the widget.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
94
95
96</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/guild.rb', line 94</span>
<span class='kw'>def</span> <span class='id identifier rubyid_widget_enabled'>widget_enabled</span>
<span class='ivar'>@widget_enabled</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="class_method_details" class="method_details_list">
<h2>Class Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="banner-class_method">
.<strong>banner</strong>(guild_id, style: "banner") ⇒ <tt>String</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns a banner url from the guild's ID.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>guild_id</span>
<span class='type'>(<tt>#to_s</tt>)</span>
—
<div class='inline'><p>The ID of the guild.</p>
</div>
</li>
<li>
<span class='name'>style</span>
<span class='type'>(<tt>:shield</tt>, <tt>:banner1</tt>, <tt>:banner2</tt>, <tt>:banner3</tt>, <tt>:banner4</tt>)</span>
<em class="default">(defaults to: <tt>"banner"</tt>)</em>
—
<div class='inline'><p>The style of the banner.</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>String</tt>)</span>
—
<div class='inline'><p>The url of the banner.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
1042
1043
1044</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/guild.rb', line 1042</span>
<span class='kw'>def</span> <span class='id identifier rubyid_banner'>banner</span><span class='lparen'>(</span><span class='id identifier rubyid_guild_id'>guild_id</span><span class='comma'>,</span> <span class='label'>style:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>banner</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="../Discorb.html" title="Discorb (module)">Discorb</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Discorb.html#API_BASE_URL-constant" title="Discorb::API_BASE_URL (constant)">API_BASE_URL</a></span></span><span class='embexpr_end'>}</span><span class='tstring_content'>/guilds/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_guild_id'>guild_id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/widget.png&style=</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_style'>style</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="afk_channel-instance_method">
#<strong>afk_channel</strong> ⇒ <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
136
137
138</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/guild.rb', line 136</span>
<span class='kw'>def</span> <span class='id identifier rubyid_afk_channel'>afk_channel</span>
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_channels'>channels</span><span class='lbracket'>[</span><span class='ivar'>@afk_channel_id</span><span class='rbracket'>]</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="ban_member-instance_method">
#<strong>ban_member</strong>(member, delete_message_days: 0, reason: nil) ⇒ <tt><span class='object_link'><a href="Guild/Ban.html" title="Discorb::Guild::Ban (class)">Discorb::Guild::Ban</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<div class="note notetag">
<strong>Note:</strong>
<div class='inline'><p>This is an asynchronous method, it will return a <code>Async::Task</code> object. Use <code>Async::Task#wait</code> to get the result.</p>
</div>
</div>
<div class="note notetag">
<strong>Note:</strong>
<div class='inline'><p>This method calls HTTP request.</p>
</div>
</div>
<p>Ban a member from the guild.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>member</span>
<span class='type'>(<tt><span class='object_link'><a href="Member.html" title="Discorb::Member (class)">Discorb::Member</a></span></tt>)</span>
—
<div class='inline'><p>The member to ban.</p>
</div>
</li>
<li>
<span class='name'>delete_message_days</span>
<span class='type'>(<tt>Integer</tt>)</span>
<em class="default">(defaults to: <tt>0</tt>)</em>
—
<div class='inline'><p>The number of days to delete messages.</p>
</div>
</li>
<li>
<span class='name'>reason</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'><p>The reason for banning the member.</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="Guild/Ban.html" title="Discorb::Guild::Ban (class)">Discorb::Guild::Ban</a></span></tt>)</span>
—
<div class='inline'><p>The ban.</p>
</div>
</li>
</ul>
<p class="tag_title">Raises:</p>
<ul class="raise">
<li>
<span class='type'>(<tt><span class='object_link'><a href="HTTPError.html" title="Discorb::HTTPError (class)">Discorb::HTTPError</a></span></tt>)</span>
—
<div class='inline'><p>HTTP request failed.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
643
644
645
646
647
648
649
650</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/guild.rb', line 643</span>
<span class='kw'>def</span> <span class='id identifier rubyid_ban_member'>ban_member</span><span class='lparen'>(</span><span class='id identifier rubyid_member'>member</span><span class='comma'>,</span> <span class='label'>delete_message_days:</span> <span class='int'>0</span><span class='comma'>,</span> <span class='label'>reason:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
<span class='const'>Async</span> <span class='kw'>do</span>
<span class='id identifier rubyid__resp'>_resp</span><span class='comma'>,</span> <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_http'>http</span><span class='period'>.</span><span class='id identifier rubyid_post'>post</span><span class='lparen'>(</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/guilds/</span><span class='embexpr_beg'>#{</span><span class='ivar'>@id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/bans</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='lbrace'>{</span> <span class='label'>user:</span> <span class='id identifier rubyid_member'>member</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span><span class='comma'>,</span> <span class='label'>delete_message_days:</span> <span class='id identifier rubyid_delete_message_days'>delete_message_days</span> <span class='rbrace'>}</span><span class='comma'>,</span> <span class='label'>audit_log_reason:</span> <span class='id identifier rubyid_reason'>reason</span><span class='comma'>,</span>
<span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_wait'>wait</span>
<span class='const'><span class='object_link'><a href="Guild/Ban.html" title="Discorb::Guild::Ban (class)">Ban</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='ivar'>@client</span><span class='comma'>,</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="banned?-instance_method">
#<strong>banned?</strong>(user) ⇒ <tt>Boolean</tt>
</h3><div class="docstring">
<div class="discussion">
<div class="note notetag">
<strong>Note:</strong>
<div class='inline'><p>This is an asynchronous method, it will return a <code>Async::Task</code> object. Use <code>Async::Task#wait</code> to get the result.</p>
</div>
</div>
<div class="note notetag">
<strong>Note:</strong>
<div class='inline'><p>This method calls HTTP request.</p>
</div>
</div>
<p>Checks the user was banned from the guild.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>user</span>
<span class='type'>(<tt><span class='object_link'><a href="User.html" title="Discorb::User (class)">Discorb::User</a></span></tt>)</span>
—
<div class='inline'><p>The user to check.</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Boolean</tt>)</span>
—
<div class='inline'><p>Whether the user was banned.</p>
</div>
</li>
</ul>
<p class="tag_title">Raises:</p>
<ul class="raise">
<li>
<span class='type'>(<tt><span class='object_link'><a href="HTTPError.html" title="Discorb::HTTPError (class)">Discorb::HTTPError</a></span></tt>)</span>
—
<div class='inline'><p>HTTP request failed.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
626
627
628
629
630</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/guild.rb', line 626</span>
<span class='kw'>def</span> <span class='id identifier rubyid_banned?'>banned?</span><span class='lparen'>(</span><span class='id identifier rubyid_user'>user</span><span class='rparen'>)</span>
<span class='const'>Async</span> <span class='kw'>do</span>
<span class='op'>!</span><span class='id identifier rubyid_fetch_ban'>fetch_ban</span><span class='lparen'>(</span><span class='id identifier rubyid_user'>user</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_wait'>wait</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="create_category_channel-instance_method">
#<strong>create_category_channel</strong>(name, position: nil, permission_overwrites: nil, parent: nil, reason: nil) ⇒ <tt><span class='object_link'><a href="CategoryChannel.html" title="Discorb::CategoryChannel (class)">Discorb::CategoryChannel</a></span></tt>
<span class="aliases">Also known as:
<span class="names"><span id='create_category-instance_method'>create_category</span></span>
</span>
</h3><div class="docstring">
<div class="discussion">
<div class="note notetag">
<strong>Note:</strong>
<div class='inline'><p>This is an asynchronous method, it will return a <code>Async::Task</code> object. Use <code>Async::Task#wait</code> to get the result.</p>
</div>
</div>
<div class="note notetag">
<strong>Note:</strong>
<div class='inline'><p>This method calls HTTP request.</p>
</div>
</div>
<p>Create a new category channel.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>name</span>
<span class='type'>(<tt>String</tt>)</span>
—
<div class='inline'><p>The name of the channel.</p>
</div>
</li>
<li>
<span class='name'>position</span>
<span class='type'>(<tt>Integer</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'><p>The position of the channel.</p>
</div>
</li>
<li>
<span class='name'>permission_overwrites</span>
<span class='type'>(<tt>Hash{<span class='object_link'><a href="Role.html" title="Discorb::Role (class)">Discorb::Role</a></span>, <span class='object_link'><a href="Member.html" title="Discorb::Member (class)">Discorb::Member</a></span> => <span class='object_link'><a href="PermissionOverwrite.html" title="Discorb::PermissionOverwrite (class)">Discorb::PermissionOverwrite</a></span>}</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'><p>A list of permission overwrites.</p>
</div>
</li>
<li>
<span class='name'>parent</span>
<span class='type'>(<tt><span class='object_link'><a href="CategoryChannel.html" title="Discorb::CategoryChannel (class)">Discorb::CategoryChannel</a></span></tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'><p>The parent of the channel.</p>
</div>
</li>
<li>
<span class='name'>reason</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'><p>The reason for creating the channel.</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="CategoryChannel.html" title="Discorb::CategoryChannel (class)">Discorb::CategoryChannel</a></span></tt>)</span>
—
<div class='inline'><p>The created category channel.</p>
</div>
</li>
</ul>
<p class="tag_title">Raises:</p>
<ul class="raise">
<li>
<span class='type'>(<tt><span class='object_link'><a href="HTTPError.html" title="Discorb::HTTPError (class)">Discorb::HTTPError</a></span></tt>)</span>
—
<div class='inline'><p>HTTP request failed.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/guild.rb', line 378</span>
<span class='kw'>def</span> <span class='id identifier rubyid_create_category_channel'>create_category_channel</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='label'>position:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>permission_overwrites:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>parent:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>reason:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
<span class='const'>Async</span> <span class='kw'>do</span>
<span class='id identifier rubyid_payload'>payload</span> <span class='op'>=</span> <span class='lbrace'>{</span> <span class='label'>type:</span> <span class='const'><span class='object_link'><a href="CategoryChannel.html" title="Discorb::CategoryChannel (class)">CategoryChannel</a></span></span><span class='period'>.</span><span class='id identifier rubyid_channel_type'>channel_type</span> <span class='rbrace'>}</span>
<span class='id identifier rubyid_payload'>payload</span><span class='lbracket'>[</span><span class='symbol'>:name</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_name'>name</span>
<span class='id identifier rubyid_payload'>payload</span><span class='lbracket'>[</span><span class='symbol'>:position</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_position'>position</span> <span class='kw'>if</span> <span class='id identifier rubyid_position'>position</span>
<span class='kw'>if</span> <span class='id identifier rubyid_permission_overwrites'>permission_overwrites</span>
<span class='id identifier rubyid_payload'>payload</span><span class='lbracket'>[</span><span class='symbol'>:permission_overwrites</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_permission_overwrites'>permission_overwrites</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_target'>target</span><span class='comma'>,</span> <span class='id identifier rubyid_overwrite'>overwrite</span><span class='op'>|</span>
<span class='lbrace'>{</span>
<span class='label'>type:</span> <span class='id identifier rubyid_target'>target</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="Role.html" title="Discorb::Role (class)">Role</a></span></span><span class='rparen'>)</span> <span class='op'>?</span> <span class='int'>0</span> <span class='op'>:</span> <span class='int'>1</span><span class='comma'>,</span>
<span class='label'>id:</span> <span class='id identifier rubyid_target'>target</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
<span class='label'>allow:</span> <span class='id identifier rubyid_overwrite'>overwrite</span><span class='period'>.</span><span class='id identifier rubyid_allow_value'>allow_value</span><span class='comma'>,</span>
<span class='label'>deny:</span> <span class='id identifier rubyid_overwrite'>overwrite</span><span class='period'>.</span><span class='id identifier rubyid_deny_value'>deny_value</span><span class='comma'>,</span>
<span class='rbrace'>}</span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_payload'>payload</span><span class='lbracket'>[</span><span class='symbol'>:parent_id</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_parent'>parent</span><span class='op'>&.</span><span class='id identifier rubyid_id'>id</span>
<span class='id identifier rubyid__resp'>_resp</span><span class='comma'>,</span> <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_http'>http</span><span class='period'>.</span><span class='id identifier rubyid_post'>post</span><span class='lparen'>(</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/guilds/</span><span class='embexpr_beg'>#{</span><span class='ivar'>@id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/channels</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id identifier rubyid_payload'>payload</span><span class='comma'>,</span> <span class='label'>audit_log_reason:</span> <span class='id identifier rubyid_reason'>reason</span><span class='comma'>,</span>
<span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_wait'>wait</span>
<span class='const'><span class='object_link'><a href="Channel.html" title="Discorb::Channel (class)">Channel</a></span></span><span class='period'>.</span><span class='id identifier rubyid_make_channel'>make_channel</span><span class='lparen'>(</span><span class='ivar'>@client</span><span class='comma'>,</span> <span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="create_emoji-instance_method">
#<strong>create_emoji</strong>(name, image, roles: []) ⇒ <tt><span class='object_link'><a href="CustomEmoji.html" title="Discorb::CustomEmoji (class)">Discorb::CustomEmoji</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<div class="note notetag">
<strong>Note:</strong>
<div class='inline'><p>This is an asynchronous method, it will return a <code>Async::Task</code> object. Use <code>Async::Task#wait</code> to get the result.</p>
</div>
</div>
<div class="note notetag">
<strong>Note:</strong>
<div class='inline'><p>This method calls HTTP request.</p>
</div>
</div>
<p>Create a custom emoji.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>name</span>
<span class='type'>(<tt>#to_s</tt>)</span>
—
<div class='inline'><p>The name of the emoji.</p>
</div>
</li>
<li>
<span class='name'>image</span>
<span class='type'>(<tt><span class='object_link'><a href="Image.html" title="Discorb::Image (class)">Discorb::Image</a></span></tt>)</span>
—
<div class='inline'><p>The image of the emoji.</p>
</div>
</li>
<li>
<span class='name'>roles</span>
<span class='type'>(<tt>Array<<span class='object_link'><a href="Role.html" title="Discorb::Role (class)">Discorb::Role</a></span>></tt>)</span>
<em class="default">(defaults to: <tt>[]</tt>)</em>
—
<div class='inline'><p>A list of roles to give the emoji.</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="CustomEmoji.html" title="Discorb::CustomEmoji (class)">Discorb::CustomEmoji</a></span></tt>)</span>
—
<div class='inline'><p>The created emoji.</p>
</div>
</li>
</ul>
<p class="tag_title">Raises:</p>
<ul class="raise">
<li>
<span class='type'>(<tt><span class='object_link'><a href="HTTPError.html" title="Discorb::HTTPError (class)">Discorb::HTTPError</a></span></tt>)</span>
—
<div class='inline'><p>HTTP request failed.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
222
223
224
225
226
227
228
229
230
231
232</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/guild.rb', line 222</span>
<span class='kw'>def</span> <span class='id identifier rubyid_create_emoji'>create_emoji</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='id identifier rubyid_image'>image</span><span class='comma'>,</span> <span class='label'>roles:</span> <span class='lbracket'>[</span><span class='rbracket'>]</span><span class='rparen'>)</span>
<span class='id identifier rubyid__resp'>_resp</span><span class='comma'>,</span> <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_http'>http</span><span class='period'>.</span><span class='id identifier rubyid_post'>post</span><span class='lparen'>(</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/guilds/</span><span class='embexpr_beg'>#{</span><span class='ivar'>@id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/emojis</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
<span class='lbrace'>{</span>
<span class='label'>name:</span> <span class='id identifier rubyid_name'>name</span><span class='comma'>,</span>
<span class='label'>image:</span> <span class='id identifier rubyid_image'>image</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='comma'>,</span>
<span class='label'>roles:</span> <span class='id identifier rubyid_roles'>roles</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_r'>r</span><span class='op'>|</span> <span class='const'><span class='object_link'><a href="../Discorb.html" title="Discorb (module)">Discorb</a></span></span><span class='op'>::</span><span class='const'>Utils</span><span class='period'>.</span><span class='id identifier rubyid_try'>try</span><span class='lparen'>(</span><span class='id identifier rubyid_r'>r</span><span class='comma'>,</span> <span class='symbol'>:id</span><span class='rparen'>)</span> <span class='rbrace'>}</span><span class='comma'>,</span>
<span class='rbrace'>}</span>
<span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_wait'>wait</span>
<span class='ivar'>@emojis</span><span class='lbracket'>[</span><span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:id</span><span class='rbracket'>]</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="CustomEmoji.html" title="Discorb::CustomEmoji (class)">CustomEmoji</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='ivar'>@client</span><span class='comma'>,</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="create_news_channel-instance_method">
#<strong>create_news_channel</strong>(name, topic: nil, rate_limit_per_user: nil, slowmode: nil, position: nil, nsfw: nil, permission_overwrites: nil, parent: nil, reason: nil) ⇒ <tt><span class='object_link'><a href="NewsChannel.html" title="Discorb::NewsChannel (class)">Discorb::NewsChannel</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<div class="note notetag">
<strong>Note:</strong>
<div class='inline'><p>This is an asynchronous method, it will return a <code>Async::Task</code> object. Use <code>Async::Task#wait</code> to get the result.</p>
</div>
</div>
<div class="note notetag">
<strong>Note:</strong>
<div class='inline'><p>This method calls HTTP request.</p>
</div>
</div>
<p>Create a new news channel.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>name</span>
<span class='type'>(<tt>String</tt>)</span>
—
<div class='inline'><p>The name of the channel.</p>
</div>
</li>
<li>
<span class='name'>topic</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'><p>The topic of the channel.</p>
</div>
</li>
<li>
<span class='name'>rate_limit_per_user</span>
<span class='type'>(<tt>Integer</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'><p>The rate limit per user in the channel.</p>
</div>
</li>
<li>
<span class='name'>slowmode</span>
<span class='type'>(<tt>Integer</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'><p>Alias for <code>rate_limit_per_user</code>.</p>
</div>
</li>
<li>
<span class='name'>position</span>
<span class='type'>(<tt>Integer</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'><p>The position of the channel.</p>
</div>
</li>
<li>
<span class='name'>nsfw</span>
<span class='type'>(<tt>Boolean</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'><p>Whether the channel is nsfw.</p>
</div>
</li>
<li>
<span class='name'>permission_overwrites</span>
<span class='type'>(<tt>Hash{<span class='object_link'><a href="Role.html" title="Discorb::Role (class)">Discorb::Role</a></span>, <span class='object_link'><a href="Member.html" title="Discorb::Member (class)">Discorb::Member</a></span> => <span class='object_link'><a href="PermissionOverwrite.html" title="Discorb::PermissionOverwrite (class)">Discorb::PermissionOverwrite</a></span>}</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'><p>A list of permission overwrites.</p>
</div>
</li>
<li>
<span class='name'>parent</span>
<span class='type'>(<tt><span class='object_link'><a href="CategoryChannel.html" title="Discorb::CategoryChannel (class)">Discorb::CategoryChannel</a></span></tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'><p>The parent of the channel.</p>
</div>
</li>
<li>
<span class='name'>reason</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'><p>The reason for creating the channel.</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="NewsChannel.html" title="Discorb::NewsChannel (class)">Discorb::NewsChannel</a></span></tt>)</span>
—
<div class='inline'><p>The created news channel.</p>
</div>
</li>
</ul>
<p class="tag_title">Raises:</p>
<ul class="raise">
<li>
<span class='type'>(<tt><span class='object_link'><a href="HTTPError.html" title="Discorb::HTTPError (class)">Discorb::HTTPError</a></span></tt>)</span>
—
<div class='inline'><p>HTTP request failed.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/guild.rb', line 458</span>
<span class='kw'>def</span> <span class='id identifier rubyid_create_news_channel'>create_news_channel</span><span class='lparen'>(</span>
<span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='label'>topic:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>rate_limit_per_user:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>slowmode:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>position:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>nsfw:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>permission_overwrites:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>parent:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>reason:</span> <span class='kw'>nil</span>
<span class='rparen'>)</span>
<span class='const'>Async</span> <span class='kw'>do</span>
<span class='id identifier rubyid_payload'>payload</span> <span class='op'>=</span> <span class='lbrace'>{</span> <span class='label'>type:</span> <span class='const'><span class='object_link'><a href="NewsChannel.html" title="Discorb::NewsChannel (class)">NewsChannel</a></span></span><span class='period'>.</span><span class='id identifier rubyid_channel_type'>channel_type</span> <span class='rbrace'>}</span>
<span class='id identifier rubyid_payload'>payload</span><span class='lbracket'>[</span><span class='symbol'>:name</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_name'>name</span>
<span class='id identifier rubyid_payload'>payload</span><span class='lbracket'>[</span><span class='symbol'>:topic</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_topic'>topic</span> <span class='kw'>if</span> <span class='id identifier rubyid_topic'>topic</span>
<span class='id identifier rubyid_rate_limit_per_user'>rate_limit_per_user</span> <span class='op'>||=</span> <span class='id identifier rubyid_slowmode'>slowmode</span>
<span class='id identifier rubyid_payload'>payload</span><span class='lbracket'>[</span><span class='symbol'>:rate_limit_per_user</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_rate_limit_per_user'>rate_limit_per_user</span> <span class='kw'>if</span> <span class='id identifier rubyid_rate_limit_per_user'>rate_limit_per_user</span>
<span class='id identifier rubyid_payload'>payload</span><span class='lbracket'>[</span><span class='symbol'>:position</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_position'>position</span> <span class='kw'>if</span> <span class='id identifier rubyid_position'>position</span>
<span class='kw'>if</span> <span class='id identifier rubyid_permission_overwrites'>permission_overwrites</span>
<span class='id identifier rubyid_payload'>payload</span><span class='lbracket'>[</span><span class='symbol'>:permission_overwrites</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_permission_overwrites'>permission_overwrites</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_target'>target</span><span class='comma'>,</span> <span class='id identifier rubyid_overwrite'>overwrite</span><span class='op'>|</span>
<span class='lbrace'>{</span>
<span class='label'>type:</span> <span class='id identifier rubyid_target'>target</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="Role.html" title="Discorb::Role (class)">Role</a></span></span><span class='rparen'>)</span> <span class='op'>?</span> <span class='int'>0</span> <span class='op'>:</span> <span class='int'>1</span><span class='comma'>,</span>
<span class='label'>id:</span> <span class='id identifier rubyid_target'>target</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
<span class='label'>allow:</span> <span class='id identifier rubyid_overwrite'>overwrite</span><span class='period'>.</span><span class='id identifier rubyid_allow_value'>allow_value</span><span class='comma'>,</span>
<span class='label'>deny:</span> <span class='id identifier rubyid_overwrite'>overwrite</span><span class='period'>.</span><span class='id identifier rubyid_deny_value'>deny_value</span><span class='comma'>,</span>
<span class='rbrace'>}</span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_payload'>payload</span><span class='lbracket'>[</span><span class='symbol'>:nsfw</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_nsfw'>nsfw</span> <span class='kw'>unless</span> <span class='id identifier rubyid_nsfw'>nsfw</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
<span class='id identifier rubyid_payload'>payload</span><span class='lbracket'>[</span><span class='symbol'>:parent_id</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_parent'>parent</span><span class='op'>&.</span><span class='id identifier rubyid_id'>id</span>
<span class='id identifier rubyid__resp'>_resp</span><span class='comma'>,</span> <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_http'>http</span><span class='period'>.</span><span class='id identifier rubyid_post'>post</span><span class='lparen'>(</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/guilds/</span><span class='embexpr_beg'>#{</span><span class='ivar'>@id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/channels</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id identifier rubyid_payload'>payload</span><span class='comma'>,</span> <span class='label'>audit_log_reason:</span> <span class='id identifier rubyid_reason'>reason</span><span class='comma'>,</span>
<span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_wait'>wait</span>
<span class='const'><span class='object_link'><a href="Channel.html" title="Discorb::Channel (class)">Channel</a></span></span><span class='period'>.</span><span class='id identifier rubyid_make_channel'>make_channel</span><span class='lparen'>(</span><span class='ivar'>@client</span><span class='comma'>,</span> <span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="create_role-instance_method">
#<strong>create_role</strong>(name = nil, color: nil, hoist: nil, mentionable: nil, reason: nil) ⇒ <tt><span class='object_link'><a href="Role.html" title="Discorb::Role (class)">Discorb::Role</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<div class="note notetag">
<strong>Note:</strong>
<div class='inline'><p>This is an asynchronous method, it will return a <code>Async::Task</code> object. Use <code>Async::Task#wait</code> to get the result.</p>
</div>
</div>
<div class="note notetag">
<strong>Note:</strong>
<div class='inline'><p>This method calls HTTP request.</p>
</div>
</div>
<p>Create a role in the guild.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>name</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'><p>The name of the role.</p>
</div>
</li>
<li>
<span class='name'>color</span>
<span class='type'>(<tt><span class='object_link'><a href="Color.html" title="Discorb::Color (class)">Discorb::Color</a></span></tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'><p>The color of the role.</p>
</div>
</li>
<li>
<span class='name'>hoist</span>
<span class='type'>(<tt>Boolean</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'><p>Whether the role should be hoisted.</p>
</div>
</li>
<li>
<span class='name'>mentionable</span>
<span class='type'>(<tt>Boolean</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'><p>Whether the role should be mentionable.</p>
</div>
</li>
<li>
<span class='name'>reason</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'><p>The reason for creating the role.</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="Role.html" title="Discorb::Role (class)">Discorb::Role</a></span></tt>)</span>
—
<div class='inline'><p>The role.</p>
</div>
</li>
</ul>
<p class="tag_title">Raises:</p>
<ul class="raise">
<li>
<span class='type'>(<tt><span class='object_link'><a href="HTTPError.html" title="Discorb::HTTPError (class)">Discorb::HTTPError</a></span></tt>)</span>
—
<div class='inline'><p>HTTP request failed.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
693
694
695
696
697
698
699
700
701
702
703
704
705</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/guild.rb', line 693</span>
<span class='kw'>def</span> <span class='id identifier rubyid_create_role'>create_role</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>color:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>hoist:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>mentionable:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>reason:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
<span class='const'>Async</span> <span class='kw'>do</span>
<span class='id identifier rubyid_payload'>payload</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
<span class='id identifier rubyid_payload'>payload</span><span class='lbracket'>[</span><span class='symbol'>:name</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_name'>name</span> <span class='kw'>if</span> <span class='id identifier rubyid_name'>name</span>
<span class='id identifier rubyid_payload'>payload</span><span class='lbracket'>[</span><span class='symbol'>:color</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_color'>color</span><span class='period'>.</span><span class='id identifier rubyid_to_i'>to_i</span> <span class='kw'>if</span> <span class='id identifier rubyid_color'>color</span>
<span class='id identifier rubyid_payload'>payload</span><span class='lbracket'>[</span><span class='symbol'>:hoist</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_hoist'>hoist</span> <span class='kw'>if</span> <span class='id identifier rubyid_hoist'>hoist</span>
<span class='id identifier rubyid_payload'>payload</span><span class='lbracket'>[</span><span class='symbol'>:mentionable</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_mentionable'>mentionable</span> <span class='kw'>if</span> <span class='id identifier rubyid_mentionable'>mentionable</span>
<span class='id identifier rubyid__resp'>_resp</span><span class='comma'>,</span> <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_http'>http</span><span class='period'>.</span><span class='id identifier rubyid_post'>post</span><span class='lparen'>(</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/guilds/</span><span class='embexpr_beg'>#{</span><span class='ivar'>@id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/roles</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id identifier rubyid_payload'>payload</span><span class='comma'>,</span> <span class='label'>audit_log_reason:</span> <span class='id identifier rubyid_reason'>reason</span><span class='comma'>,</span>
<span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_wait'>wait</span>
<span class='const'><span class='object_link'><a href="Role.html" title="Discorb::Role (class)">Role</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='ivar'>@client</span><span class='comma'>,</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="create_stage_channel-instance_method">
#<strong>create_stage_channel</strong>(name, bitrate: 64, position: nil, permission_overwrites: nil, parent: nil, reason: nil) ⇒ <tt><span class='object_link'><a href="StageChannel.html" title="Discorb::StageChannel (class)">Discorb::StageChannel</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<div class="note notetag">
<strong>Note:</strong>
<div class='inline'><p>This is an asynchronous method, it will return a <code>Async::Task</code> object. Use <code>Async::Task#wait</code> to get the result.</p>
</div>
</div>
<div class="note notetag">
<strong>Note:</strong>
<div class='inline'><p>This method calls HTTP request.</p>
</div>
</div>
<p>Create a new stage channel.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>name</span>
<span class='type'>(<tt>String</tt>)</span>
—
<div class='inline'><p>The name of the channel.</p>
</div>
</li>
<li>
<span class='name'>bitrate</span>
<span class='type'>(<tt>Integer</tt>)</span>
<em class="default">(defaults to: <tt>64</tt>)</em>
—
<div class='inline'><p>The bitrate of the channel.</p>
</div>
</li>
<li>
<span class='name'>position</span>
<span class='type'>(<tt>Integer</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'><p>The position of the channel.</p>
</div>
</li>
<li>
<span class='name'>permission_overwrites</span>
<span class='type'>(<tt>Hash{<span class='object_link'><a href="Role.html" title="Discorb::Role (class)">Discorb::Role</a></span>, <span class='object_link'><a href="Member.html" title="Discorb::Member (class)">Discorb::Member</a></span> => <span class='object_link'><a href="PermissionOverwrite.html" title="Discorb::PermissionOverwrite (class)">Discorb::PermissionOverwrite</a></span>}</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'><p>A list of permission overwrites.</p>
</div>
</li>
<li>
<span class='name'>parent</span>
<span class='type'>(<tt><span class='object_link'><a href="CategoryChannel.html" title="Discorb::CategoryChannel (class)">Discorb::CategoryChannel</a></span></tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'><p>The parent of the channel.</p>
</div>
</li>
<li>
<span class='name'>reason</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'><p>The reason for creating the channel.</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="StageChannel.html" title="Discorb::StageChannel (class)">Discorb::StageChannel</a></span></tt>)</span>
—
<div class='inline'><p>The created stage channel.</p>
</div>
</li>
</ul>
<p class="tag_title">Raises:</p>
<ul class="raise">
<li>
<span class='type'>(<tt><span class='object_link'><a href="HTTPError.html" title="Discorb::HTTPError (class)">Discorb::HTTPError</a></span></tt>)</span>
—
<div class='inline'><p>HTTP request failed.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/guild.rb', line 417</span>
<span class='kw'>def</span> <span class='id identifier rubyid_create_stage_channel'>create_stage_channel</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='label'>bitrate:</span> <span class='int'>64</span><span class='comma'>,</span> <span class='label'>position:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>permission_overwrites:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>parent:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>reason:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
<span class='const'>Async</span> <span class='kw'>do</span>
<span class='id identifier rubyid_payload'>payload</span> <span class='op'>=</span> <span class='lbrace'>{</span> <span class='label'>type:</span> <span class='const'><span class='object_link'><a href="StageChannel.html" title="Discorb::StageChannel (class)">StageChannel</a></span></span><span class='period'>.</span><span class='id identifier rubyid_channel_type'>channel_type</span> <span class='rbrace'>}</span>
<span class='id identifier rubyid_payload'>payload</span><span class='lbracket'>[</span><span class='symbol'>:name</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_name'>name</span>
<span class='id identifier rubyid_payload'>payload</span><span class='lbracket'>[</span><span class='symbol'>:bitrate</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_bitrate'>bitrate</span> <span class='op'>*</span> <span class='int'>1000</span> <span class='kw'>if</span> <span class='id identifier rubyid_bitrate'>bitrate</span>
<span class='id identifier rubyid_payload'>payload</span><span class='lbracket'>[</span><span class='symbol'>:position</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_position'>position</span> <span class='kw'>if</span> <span class='id identifier rubyid_position'>position</span>
<span class='kw'>if</span> <span class='id identifier rubyid_permission_overwrites'>permission_overwrites</span>
<span class='id identifier rubyid_payload'>payload</span><span class='lbracket'>[</span><span class='symbol'>:permission_overwrites</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_permission_overwrites'>permission_overwrites</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_target'>target</span><span class='comma'>,</span> <span class='id identifier rubyid_overwrite'>overwrite</span><span class='op'>|</span>
<span class='lbrace'>{</span>
<span class='label'>type:</span> <span class='id identifier rubyid_target'>target</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="Role.html" title="Discorb::Role (class)">Role</a></span></span><span class='rparen'>)</span> <span class='op'>?</span> <span class='int'>0</span> <span class='op'>:</span> <span class='int'>1</span><span class='comma'>,</span>
<span class='label'>id:</span> <span class='id identifier rubyid_target'>target</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
<span class='label'>allow:</span> <span class='id identifier rubyid_overwrite'>overwrite</span><span class='period'>.</span><span class='id identifier rubyid_allow_value'>allow_value</span><span class='comma'>,</span>
<span class='label'>deny:</span> <span class='id identifier rubyid_overwrite'>overwrite</span><span class='period'>.</span><span class='id identifier rubyid_deny_value'>deny_value</span><span class='comma'>,</span>
<span class='rbrace'>}</span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_payload'>payload</span><span class='lbracket'>[</span><span class='symbol'>:parent_id</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_parent'>parent</span><span class='op'>&.</span><span class='id identifier rubyid_id'>id</span>
<span class='id identifier rubyid__resp'>_resp</span><span class='comma'>,</span> <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_http'>http</span><span class='period'>.</span><span class='id identifier rubyid_post'>post</span><span class='lparen'>(</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/guilds/</span><span class='embexpr_beg'>#{</span><span class='ivar'>@id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/channels</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id identifier rubyid_payload'>payload</span><span class='comma'>,</span> <span class='label'>audit_log_reason:</span> <span class='id identifier rubyid_reason'>reason</span><span class='comma'>,</span>
<span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_wait'>wait</span>
<span class='const'><span class='object_link'><a href="Channel.html" title="Discorb::Channel (class)">Channel</a></span></span><span class='period'>.</span><span class='id identifier rubyid_make_channel'>make_channel</span><span class='lparen'>(</span><span class='ivar'>@client</span><span class='comma'>,</span> <span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="create_template-instance_method">
#<strong>create_template</strong>(name, description = nil, reason: nil) ⇒ <tt><span class='object_link'><a href="GuildTemplate.html" title="Discorb::GuildTemplate (class)">Discorb::GuildTemplate</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Create a new template in the guild.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>name</span>
<span class='type'>(<tt>String</tt>)</span>
—
<div class='inline'><p>The name of the template.</p>
</div>
</li>
<li>
<span class='name'>description</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'><p>The description of the template.</p>
</div>
</li>
<li>
<span class='name'>reason</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'><p>The reason for creating the template.</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="GuildTemplate.html" title="Discorb::GuildTemplate (class)">Discorb::GuildTemplate</a></span></tt>)</span>
—
<div class='inline'><p>The template.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
902
903
904
905
906
907
908
909</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/guild.rb', line 902</span>
<span class='kw'>def</span> <span class='id identifier rubyid_create_template'>create_template</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='id identifier rubyid_description'>description</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>reason:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
<span class='const'>Async</span> <span class='kw'>do</span>
<span class='id identifier rubyid__resp'>_resp</span><span class='comma'>,</span> <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_http'>http</span><span class='period'>.</span><span class='id identifier rubyid_post'>post</span><span class='lparen'>(</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/guilds/</span><span class='embexpr_beg'>#{</span><span class='ivar'>@id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/templates</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='lbrace'>{</span> <span class='label'>name:</span> <span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='label'>description:</span> <span class='id identifier rubyid_description'>description</span> <span class='rbrace'>}</span><span class='comma'>,</span> <span class='label'>audit_log_reason:</span> <span class='id identifier rubyid_reason'>reason</span><span class='comma'>,</span>
<span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_wait'>wait</span>
<span class='const'><span class='object_link'><a href="GuildTemplate.html" title="Discorb::GuildTemplate (class)">GuildTemplate</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='ivar'>@client</span><span class='comma'>,</span> <span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="create_text_channel-instance_method">
#<strong>create_text_channel</strong>(name, topic: nil, rate_limit_per_user: nil, slowmode: nil, position: nil, nsfw: nil, permission_overwrites: nil, parent: nil, reason: nil) ⇒ <tt><span class='object_link'><a href="TextChannel.html" title="Discorb::TextChannel (class)">Discorb::TextChannel</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<div class="note notetag">
<strong>Note:</strong>
<div class='inline'><p>This is an asynchronous method, it will return a <code>Async::Task</code> object. Use <code>Async::Task#wait</code> to get the result.</p>
</div>
</div>
<div class="note notetag">
<strong>Note:</strong>
<div class='inline'><p>This method calls HTTP request.</p>
</div>
</div>
<p>Create a new text channel.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>name</span>
<span class='type'>(<tt>String</tt>)</span>
—
<div class='inline'><p>The name of the channel.</p>
</div>
</li>
<li>
<span class='name'>topic</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'><p>The topic of the channel.</p>
</div>
</li>
<li>
<span class='name'>rate_limit_per_user</span>
<span class='type'>(<tt>Integer</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'><p>The rate limit per user in the channel.</p>
</div>
</li>
<li>
<span class='name'>slowmode</span>
<span class='type'>(<tt>Integer</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'><p>Alias for <code>rate_limit_per_user</code>.</p>
</div>
</li>
<li>
<span class='name'>position</span>
<span class='type'>(<tt>Integer</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'><p>The position of the channel.</p>
</div>
</li>
<li>
<span class='name'>nsfw</span>
<span class='type'>(<tt>Boolean</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'><p>Whether the channel is nsfw.</p>
</div>
</li>
<li>
<span class='name'>permission_overwrites</span>
<span class='type'>(<tt>Hash{<span class='object_link'><a href="Role.html" title="Discorb::Role (class)">Discorb::Role</a></span>, <span class='object_link'><a href="Member.html" title="Discorb::Member (class)">Discorb::Member</a></span> => <span class='object_link'><a href="PermissionOverwrite.html" title="Discorb::PermissionOverwrite (class)">Discorb::PermissionOverwrite</a></span>}</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'><p>A list of permission overwrites.</p>
</div>
</li>
<li>
<span class='name'>parent</span>
<span class='type'>(<tt><span class='object_link'><a href="CategoryChannel.html" title="Discorb::CategoryChannel (class)">Discorb::CategoryChannel</a></span></tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'><p>The parent of the channel.</p>
</div>
</li>
<li>
<span class='name'>reason</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'><p>The reason for creating the channel.</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="TextChannel.html" title="Discorb::TextChannel (class)">Discorb::TextChannel</a></span></tt>)</span>
—
<div class='inline'><p>The created text channel.</p>
</div>
</li>
</ul>
<p class="tag_title">Raises:</p>
<ul class="raise">
<li>
<span class='type'>(<tt><span class='object_link'><a href="HTTPError.html" title="Discorb::HTTPError (class)">Discorb::HTTPError</a></span></tt>)</span>
—
<div class='inline'><p>HTTP request failed.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/guild.rb', line 293</span>
<span class='kw'>def</span> <span class='id identifier rubyid_create_text_channel'>create_text_channel</span><span class='lparen'>(</span>
<span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='label'>topic:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>rate_limit_per_user:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>slowmode:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>position:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>nsfw:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>permission_overwrites:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>parent:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>reason:</span> <span class='kw'>nil</span>
<span class='rparen'>)</span>
<span class='const'>Async</span> <span class='kw'>do</span>
<span class='id identifier rubyid_payload'>payload</span> <span class='op'>=</span> <span class='lbrace'>{</span> <span class='label'>type:</span> <span class='const'><span class='object_link'><a href="TextChannel.html" title="Discorb::TextChannel (class)">TextChannel</a></span></span><span class='period'>.</span><span class='id identifier rubyid_channel_type'>channel_type</span> <span class='rbrace'>}</span>
<span class='id identifier rubyid_payload'>payload</span><span class='lbracket'>[</span><span class='symbol'>:name</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_name'>name</span>
<span class='id identifier rubyid_payload'>payload</span><span class='lbracket'>[</span><span class='symbol'>:topic</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_topic'>topic</span> <span class='kw'>if</span> <span class='id identifier rubyid_topic'>topic</span>
<span class='id identifier rubyid_rate_limit_per_user'>rate_limit_per_user</span> <span class='op'>||=</span> <span class='id identifier rubyid_slowmode'>slowmode</span>
<span class='id identifier rubyid_payload'>payload</span><span class='lbracket'>[</span><span class='symbol'>:rate_limit_per_user</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_rate_limit_per_user'>rate_limit_per_user</span> <span class='kw'>if</span> <span class='id identifier rubyid_rate_limit_per_user'>rate_limit_per_user</span>
<span class='id identifier rubyid_payload'>payload</span><span class='lbracket'>[</span><span class='symbol'>:nsfw</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_nsfw'>nsfw</span> <span class='kw'>if</span> <span class='id identifier rubyid_nsfw'>nsfw</span>
<span class='id identifier rubyid_payload'>payload</span><span class='lbracket'>[</span><span class='symbol'>:position</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_position'>position</span> <span class='kw'>if</span> <span class='id identifier rubyid_position'>position</span>
<span class='kw'>if</span> <span class='id identifier rubyid_permission_overwrites'>permission_overwrites</span>
<span class='id identifier rubyid_payload'>payload</span><span class='lbracket'>[</span><span class='symbol'>:permission_overwrites</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_permission_overwrites'>permission_overwrites</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_target'>target</span><span class='comma'>,</span> <span class='id identifier rubyid_overwrite'>overwrite</span><span class='op'>|</span>
<span class='lbrace'>{</span>
<span class='label'>type:</span> <span class='id identifier rubyid_target'>target</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="Role.html" title="Discorb::Role (class)">Role</a></span></span><span class='rparen'>)</span> <span class='op'>?</span> <span class='int'>0</span> <span class='op'>:</span> <span class='int'>1</span><span class='comma'>,</span>
<span class='label'>id:</span> <span class='id identifier rubyid_target'>target</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
<span class='label'>allow:</span> <span class='id identifier rubyid_overwrite'>overwrite</span><span class='period'>.</span><span class='id identifier rubyid_allow_value'>allow_value</span><span class='comma'>,</span>
<span class='label'>deny:</span> <span class='id identifier rubyid_overwrite'>overwrite</span><span class='period'>.</span><span class='id identifier rubyid_deny_value'>deny_value</span><span class='comma'>,</span>
<span class='rbrace'>}</span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_payload'>payload</span><span class='lbracket'>[</span><span class='symbol'>:parent_id</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_parent'>parent</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span> <span class='kw'>if</span> <span class='id identifier rubyid_parent'>parent</span>
<span class='id identifier rubyid__resp'>_resp</span><span class='comma'>,</span> <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_http'>http</span><span class='period'>.</span><span class='id identifier rubyid_post'>post</span><span class='lparen'>(</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/guilds/</span><span class='embexpr_beg'>#{</span><span class='ivar'>@id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/channels</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id identifier rubyid_payload'>payload</span><span class='comma'>,</span> <span class='label'>audit_log_reason:</span> <span class='id identifier rubyid_reason'>reason</span><span class='comma'>,</span>
<span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_wait'>wait</span>
<span class='id identifier rubyid_payload'>payload</span><span class='lbracket'>[</span><span class='symbol'>:parent_id</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_parent'>parent</span><span class='op'>&.</span><span class='id identifier rubyid_id'>id</span>
<span class='const'><span class='object_link'><a href="Channel.html" title="Discorb::Channel (class)">Channel</a></span></span><span class='period'>.</span><span class='id identifier rubyid_make_channel'>make_channel</span><span class='lparen'>(</span><span class='ivar'>@client</span><span class='comma'>,</span> <span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="create_voice_channel-instance_method">
#<strong>create_voice_channel</strong>(name, bitrate: 64, user_limit: nil, position: nil, permission_overwrites: nil, parent: nil, reason: nil) ⇒ <tt><span class='object_link'><a href="VoiceChannel.html" title="Discorb::VoiceChannel (class)">Discorb::VoiceChannel</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<div class="note notetag">
<strong>Note:</strong>
<div class='inline'><p>This is an asynchronous method, it will return a <code>Async::Task</code> object. Use <code>Async::Task#wait</code> to get the result.</p>
</div>
</div>
<div class="note notetag">
<strong>Note:</strong>
<div class='inline'><p>This method calls HTTP request.</p>
</div>
</div>
<p>Create a new voice channel.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>name</span>
<span class='type'>(<tt>String</tt>)</span>
—
<div class='inline'><p>The name of the channel.</p>
</div>
</li>
<li>
<span class='name'>bitrate</span>
<span class='type'>(<tt>Integer</tt>)</span>
<em class="default">(defaults to: <tt>64</tt>)</em>
—
<div class='inline'><p>The bitrate of the channel.</p>
</div>
</li>
<li>
<span class='name'>user_limit</span>
<span class='type'>(<tt>Integer</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'><p>The user limit of the channel.</p>
</div>
</li>
<li>
<span class='name'>position</span>
<span class='type'>(<tt>Integer</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'><p>The position of the channel.</p>
</div>
</li>
<li>
<span class='name'>permission_overwrites</span>
<span class='type'>(<tt>Hash{<span class='object_link'><a href="Role.html" title="Discorb::Role (class)">Discorb::Role</a></span>, <span class='object_link'><a href="Member.html" title="Discorb::Member (class)">Discorb::Member</a></span> => <span class='object_link'><a href="PermissionOverwrite.html" title="Discorb::PermissionOverwrite (class)">Discorb::PermissionOverwrite</a></span>}</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'><p>A list of permission overwrites.</p>
</div>
</li>
<li>
<span class='name'>parent</span>
<span class='type'>(<tt><span class='object_link'><a href="CategoryChannel.html" title="Discorb::CategoryChannel (class)">Discorb::CategoryChannel</a></span></tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'><p>The parent of the channel.</p>
</div>
</li>
<li>
<span class='name'>reason</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'><p>The reason for creating the channel.</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="VoiceChannel.html" title="Discorb::VoiceChannel (class)">Discorb::VoiceChannel</a></span></tt>)</span>
—
<div class='inline'><p>The created voice channel.</p>
</div>
</li>
</ul>
<p class="tag_title">Raises:</p>
<ul class="raise">
<li>
<span class='type'>(<tt><span class='object_link'><a href="HTTPError.html" title="Discorb::HTTPError (class)">Discorb::HTTPError</a></span></tt>)</span>
—
<div class='inline'><p>HTTP request failed.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/guild.rb', line 338</span>
<span class='kw'>def</span> <span class='id identifier rubyid_create_voice_channel'>create_voice_channel</span><span class='lparen'>(</span>
<span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='label'>bitrate:</span> <span class='int'>64</span><span class='comma'>,</span> <span class='label'>user_limit:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>position:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>permission_overwrites:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>parent:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>reason:</span> <span class='kw'>nil</span>
<span class='rparen'>)</span>
<span class='const'>Async</span> <span class='kw'>do</span>
<span class='id identifier rubyid_payload'>payload</span> <span class='op'>=</span> <span class='lbrace'>{</span> <span class='label'>type:</span> <span class='const'><span class='object_link'><a href="VoiceChannel.html" title="Discorb::VoiceChannel (class)">VoiceChannel</a></span></span><span class='period'>.</span><span class='id identifier rubyid_channel_type'>channel_type</span> <span class='rbrace'>}</span>
<span class='id identifier rubyid_payload'>payload</span><span class='lbracket'>[</span><span class='symbol'>:name</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_name'>name</span>
<span class='id identifier rubyid_payload'>payload</span><span class='lbracket'>[</span><span class='symbol'>:bitrate</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_bitrate'>bitrate</span> <span class='op'>*</span> <span class='int'>1000</span> <span class='kw'>if</span> <span class='id identifier rubyid_bitrate'>bitrate</span>
<span class='id identifier rubyid_payload'>payload</span><span class='lbracket'>[</span><span class='symbol'>:user_limit</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_user_limit'>user_limit</span> <span class='kw'>if</span> <span class='id identifier rubyid_user_limit'>user_limit</span>
<span class='id identifier rubyid_payload'>payload</span><span class='lbracket'>[</span><span class='symbol'>:position</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_position'>position</span> <span class='kw'>if</span> <span class='id identifier rubyid_position'>position</span>
<span class='kw'>if</span> <span class='id identifier rubyid_permission_overwrites'>permission_overwrites</span>
<span class='id identifier rubyid_payload'>payload</span><span class='lbracket'>[</span><span class='symbol'>:permission_overwrites</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_permission_overwrites'>permission_overwrites</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_target'>target</span><span class='comma'>,</span> <span class='id identifier rubyid_overwrite'>overwrite</span><span class='op'>|</span>
<span class='lbrace'>{</span>
<span class='label'>type:</span> <span class='id identifier rubyid_target'>target</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="Role.html" title="Discorb::Role (class)">Role</a></span></span><span class='rparen'>)</span> <span class='op'>?</span> <span class='int'>0</span> <span class='op'>:</span> <span class='int'>1</span><span class='comma'>,</span>
<span class='label'>id:</span> <span class='id identifier rubyid_target'>target</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
<span class='label'>allow:</span> <span class='id identifier rubyid_overwrite'>overwrite</span><span class='period'>.</span><span class='id identifier rubyid_allow_value'>allow_value</span><span class='comma'>,</span>
<span class='label'>deny:</span> <span class='id identifier rubyid_overwrite'>overwrite</span><span class='period'>.</span><span class='id identifier rubyid_deny_value'>deny_value</span><span class='comma'>,</span>
<span class='rbrace'>}</span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_payload'>payload</span><span class='lbracket'>[</span><span class='symbol'>:parent_id</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_parent'>parent</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span> <span class='kw'>if</span> <span class='id identifier rubyid_parent'>parent</span>
<span class='id identifier rubyid__resp'>_resp</span><span class='comma'>,</span> <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_http'>http</span><span class='period'>.</span><span class='id identifier rubyid_post'>post</span><span class='lparen'>(</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/guilds/</span><span class='embexpr_beg'>#{</span><span class='ivar'>@id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/channels</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id identifier rubyid_payload'>payload</span><span class='comma'>,</span> <span class='label'>audit_log_reason:</span> <span class='id identifier rubyid_reason'>reason</span><span class='comma'>,</span>
<span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_wait'>wait</span>
<span class='id identifier rubyid_payload'>payload</span><span class='lbracket'>[</span><span class='symbol'>:parent_id</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_parent'>parent</span><span class='op'>&.</span><span class='id identifier rubyid_id'>id</span>
<span class='const'><span class='object_link'><a href="Channel.html" title="Discorb::Channel (class)">Channel</a></span></span><span class='period'>.</span><span class='id identifier rubyid_make_channel'>make_channel</span><span class='lparen'>(</span><span class='ivar'>@client</span><span class='comma'>,</span> <span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="edit_nickname-instance_method">
#<strong>edit_nickname</strong>(nickname, reason: nil) ⇒ <tt>Object</tt>
<span class="aliases">Also known as:
<span class="names"><span id='edit_nick-instance_method'>edit_nick</span>, <span id='modify_nickname-instance_method'>modify_nickname</span></span>
</span>
</h3><div class="docstring">
<div class="discussion">
<p>Change nickname of client member.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>nickname</span>
<span class='type'>(<tt>String</tt>)</span>
—
<div class='inline'><p>The nickname to set.</p>
</div>
</li>
<li>
<span class='name'>reason</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'><p>The reason for changing the nickname.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
559
560
561
562
563</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/guild.rb', line 559</span>
<span class='kw'>def</span> <span class='id identifier rubyid_edit_nickname'>edit_nickname</span><span class='lparen'>(</span><span class='id identifier rubyid_nickname'>nickname</span><span class='comma'>,</span> <span class='label'>reason:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
<span class='const'>Async</span> <span class='kw'>do</span>
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_http'>http</span><span class='period'>.</span><span class='id identifier rubyid_patch'>patch</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/guilds/</span><span class='embexpr_beg'>#{</span><span class='ivar'>@id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/members/@me/nick</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='lbrace'>{</span> <span class='label'>nick:</span> <span class='id identifier rubyid_nickname'>nickname</span> <span class='rbrace'>}</span><span class='comma'>,</span> <span class='label'>audit_log_reason:</span> <span class='id identifier rubyid_reason'>reason</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_wait'>wait</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="fetch_active_threads-instance_method">
#<strong>fetch_active_threads</strong> ⇒ <tt>Array<<span class='object_link'><a href="ThreadChannel.html" title="Discorb::ThreadChannel (class)">Discorb::ThreadChannel</a></span>></tt>
</h3><div class="docstring">
<div class="discussion">
<div class="note notetag">
<strong>Note:</strong>
<div class='inline'><p>This is an asynchronous method, it will return a <code>Async::Task</code> object. Use <code>Async::Task#wait</code> to get the result.</p>
</div>
</div>
<div class="note notetag">
<strong>Note:</strong>
<div class='inline'><p>This method calls HTTP request.</p>
</div>
</div>
<p>Fetch a list of active threads in the guild.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Array<<span class='object_link'><a href="ThreadChannel.html" title="Discorb::ThreadChannel (class)">Discorb::ThreadChannel</a></span>></tt>)</span>
—
<div class='inline'><p>The list of threads.</p>
</div>
</li>
</ul>
<p class="tag_title">Raises:</p>
<ul class="raise">
<li>
<span class='type'>(<tt><span class='object_link'><a href="HTTPError.html" title="Discorb::HTTPError (class)">Discorb::HTTPError</a></span></tt>)</span>
—
<div class='inline'><p>HTTP request failed.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
494
495
496
497
498
499</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/guild.rb', line 494</span>
<span class='kw'>def</span> <span class='id identifier rubyid_fetch_active_threads'>fetch_active_threads</span>
<span class='const'>Async</span> <span class='kw'>do</span>
<span class='id identifier rubyid__resp'>_resp</span><span class='comma'>,</span> <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_http'>http</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/guilds/</span><span class='embexpr_beg'>#{</span><span class='ivar'>@id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/threads/active</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_wait'>wait</span>
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:threads</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_t'>t</span><span class='op'>|</span> <span class='const'><span class='object_link'><a href="Channel.html" title="Discorb::Channel (class)">Channel</a></span></span><span class='period'>.</span><span class='id identifier rubyid_make_thread'>make_thread</span><span class='lparen'>(</span><span class='ivar'>@client</span><span class='comma'>,</span> <span class='id identifier rubyid_t'>t</span><span class='rparen'>)</span> <span class='rbrace'>}</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="fetch_audit_log-instance_method">
#<strong>fetch_audit_log</strong> ⇒ <tt><span class='object_link'><a href="AuditLog.html" title="Discorb::AuditLog (class)">Discorb::AuditLog</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<div class="note notetag">
<strong>Note:</strong>
<div class='inline'><p>This is an asynchronous method, it will return a <code>Async::Task</code> object. Use <code>Async::Task#wait</code> to get the result.</p>
</div>
</div>
<div class="note notetag">
<strong>Note:</strong>
<div class='inline'><p>This method calls HTTP request.</p>
</div>
</div>
<p>Fetch audit log of the guild.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="AuditLog.html" title="Discorb::AuditLog (class)">Discorb::AuditLog</a></span></tt>)</span>
—
<div class='inline'><p>The audit log of the guild.</p>
</div>
</li>
</ul>
<p class="tag_title">Raises:</p>
<ul class="raise">
<li>
<span class='type'>(<tt><span class='object_link'><a href="HTTPError.html" title="Discorb::HTTPError (class)">Discorb::HTTPError</a></span></tt>)</span>
—
<div class='inline'><p>HTTP request failed.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
255
256
257
258
259
260</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/guild.rb', line 255</span>
<span class='kw'>def</span> <span class='id identifier rubyid_fetch_audit_log'>fetch_audit_log</span>
<span class='const'>Async</span> <span class='kw'>do</span>
<span class='id identifier rubyid__resp'>_resp</span><span class='comma'>,</span> <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_http'>http</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/guilds/</span><span class='embexpr_beg'>#{</span><span class='ivar'>@id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/audit-logs</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_wait'>wait</span>
<span class='const'><span class='object_link'><a href="AuditLog.html" title="Discorb::AuditLog (class)">AuditLog</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='ivar'>@client</span><span class='comma'>,</span> <span class='id identifier rubyid_data'>data</span><span class='comma'>,</span> <span class='kw'>self</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="fetch_ban-instance_method">
#<strong>fetch_ban</strong>(user) ⇒ <tt><span class='object_link'><a href="Guild/Ban.html" title="Discorb::Guild::Ban (class)">Discorb::Guild::Ban</a></span></tt><sup>?</sup>
</h3><div class="docstring">
<div class="discussion">
<div class="note notetag">
<strong>Note:</strong>
<div class='inline'><p>This is an asynchronous method, it will return a <code>Async::Task</code> object. Use <code>Async::Task#wait</code> to get the result.</p>
</div>
</div>
<div class="note notetag">
<strong>Note:</strong>
<div class='inline'><p>This method calls HTTP request.</p>
</div>
</div>
<p>Fetch a ban in the guild.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>user</span>
<span class='type'>(<tt><span class='object_link'><a href="User.html" title="Discorb::User (class)">Discorb::User</a></span></tt>)</span>
—
<div class='inline'><p>The user to fetch.</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="Guild/Ban.html" title="Discorb::Guild::Ban (class)">Discorb::Guild::Ban</a></span></tt>)</span>
—
<div class='inline'><p>The ban.</p>
</div>
</li>
<li>
<span class='type'>(<tt>nil</tt>)</span>
—
<div class='inline'><p>If the ban is not found.</p>
</div>
</li>
</ul>
<p class="tag_title">Raises:</p>
<ul class="raise">
<li>
<span class='type'>(<tt><span class='object_link'><a href="HTTPError.html" title="Discorb::HTTPError (class)">Discorb::HTTPError</a></span></tt>)</span>
—
<div class='inline'><p>HTTP request failed.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
607
608
609
610
611
612
613
614
615</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/guild.rb', line 607</span>
<span class='kw'>def</span> <span class='id identifier rubyid_fetch_ban'>fetch_ban</span><span class='lparen'>(</span><span class='id identifier rubyid_user'>user</span><span class='rparen'>)</span>
<span class='const'>Async</span> <span class='kw'>do</span>
<span class='id identifier rubyid__resp'>_resp</span><span class='comma'>,</span> <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_http'>http</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/guilds/</span><span class='embexpr_beg'>#{</span><span class='ivar'>@id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/bans/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_user'>user</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_wait'>wait</span>
<span class='kw'>rescue</span> <span class='const'><span class='object_link'><a href="../Discorb.html" title="Discorb (module)">Discorb</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="NotFoundError.html" title="Discorb::NotFoundError (class)">NotFoundError</a></span></span>
<span class='kw'>nil</span>
<span class='kw'>else</span>
<span class='const'><span class='object_link'><a href="Guild/Ban.html" title="Discorb::Guild::Ban (class)">Ban</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='ivar'>@client</span><span class='comma'>,</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="fetch_bans-instance_method">
#<strong>fetch_bans</strong> ⇒ <tt>Array<<span class='object_link'><a href="Guild/Ban.html" title="Discorb::Guild::Ban (class)">Discorb::Guild::Ban</a></span>></tt>
</h3><div class="docstring">
<div class="discussion">
<div class="note notetag">
<strong>Note:</strong>
<div class='inline'><p>This is an asynchronous method, it will return a <code>Async::Task</code> object. Use <code>Async::Task#wait</code> to get the result.</p>
</div>
</div>
<div class="note notetag">
<strong>Note:</strong>
<div class='inline'><p>This method calls HTTP request.</p>
</div>
</div>
<p>Fetch a list of bans in the guild.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Array<<span class='object_link'><a href="Guild/Ban.html" title="Discorb::Guild::Ban (class)">Discorb::Guild::Ban</a></span>></tt>)</span>
—
<div class='inline'><p>The list of bans.</p>
</div>
</li>
</ul>
<p class="tag_title">Raises:</p>
<ul class="raise">
<li>
<span class='type'>(<tt><span class='object_link'><a href="HTTPError.html" title="Discorb::HTTPError (class)">Discorb::HTTPError</a></span></tt>)</span>
—
<div class='inline'><p>HTTP request failed.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
590
591
592
593
594
595</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/guild.rb', line 590</span>
<span class='kw'>def</span> <span class='id identifier rubyid_fetch_bans'>fetch_bans</span>
<span class='const'>Async</span> <span class='kw'>do</span>
<span class='id identifier rubyid__resp'>_resp</span><span class='comma'>,</span> <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_http'>http</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/guilds/</span><span class='embexpr_beg'>#{</span><span class='ivar'>@id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/bans</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_wait'>wait</span>
<span class='id identifier rubyid_data'>data</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_d'>d</span><span class='op'>|</span> <span class='const'><span class='object_link'><a href="Guild/Ban.html" title="Discorb::Guild::Ban (class)">Ban</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='ivar'>@client</span><span class='comma'>,</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='id identifier rubyid_d'>d</span><span class='rparen'>)</span> <span class='rbrace'>}</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="fetch_channels-instance_method">
#<strong>fetch_channels</strong> ⇒ <tt>Array<<span class='object_link'><a href="Channel.html" title="Discorb::Channel (class)">Discorb::Channel</a></span>></tt>
</h3><div class="docstring">
<div class="discussion">
<div class="note notetag">
<strong>Note:</strong>
<div class='inline'><p>This is an asynchronous method, it will return a <code>Async::Task</code> object. Use <code>Async::Task#wait</code> to get the result.</p>
</div>
</div>
<div class="note notetag">
<strong>Note:</strong>
<div class='inline'><p>This method calls HTTP request.</p>
</div>
</div>
<p>Fetch channels of the guild.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Array<<span class='object_link'><a href="Channel.html" title="Discorb::Channel (class)">Discorb::Channel</a></span>></tt>)</span>
—
<div class='inline'><p>A list of channels in the guild.</p>
</div>
</li>
</ul>
<p class="tag_title">Raises:</p>
<ul class="raise">
<li>
<span class='type'>(<tt><span class='object_link'><a href="HTTPError.html" title="Discorb::HTTPError (class)">Discorb::HTTPError</a></span></tt>)</span>
—
<div class='inline'><p>HTTP request failed.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
269
270
271
272
273
274</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/guild.rb', line 269</span>
<span class='kw'>def</span> <span class='id identifier rubyid_fetch_channels'>fetch_channels</span>
<span class='const'>Async</span> <span class='kw'>do</span>
<span class='id identifier rubyid__resp'>_resp</span><span class='comma'>,</span> <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_http'>http</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/guilds/</span><span class='embexpr_beg'>#{</span><span class='ivar'>@id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/channels</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_wait'>wait</span>
<span class='id identifier rubyid_data'>data</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_c'>c</span><span class='op'>|</span> <span class='const'><span class='object_link'><a href="Channel.html" title="Discorb::Channel (class)">Channel</a></span></span><span class='period'>.</span><span class='id identifier rubyid_make_channel'>make_channel</span><span class='lparen'>(</span><span class='ivar'>@client</span><span class='comma'>,</span> <span class='id identifier rubyid_c'>c</span><span class='rparen'>)</span> <span class='rbrace'>}</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="fetch_emoji-instance_method">
#<strong>fetch_emoji</strong>(id) ⇒ <tt><span class='object_link'><a href="CustomEmoji.html" title="Discorb::CustomEmoji (class)">Discorb::CustomEmoji</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<div class="note notetag">
<strong>Note:</strong>
<div class='inline'><p>This is an asynchronous method, it will return a <code>Async::Task</code> object. Use <code>Async::Task#wait</code> to get the result.</p>
</div>
</div>
<div class="note notetag">
<strong>Note:</strong>
<div class='inline'><p>This method calls HTTP request.</p>
</div>
</div>
<div class="note notetag">
<strong>Note:</strong>
<div class='inline'><p>This querys the API every time. We recommend using <span class='object_link'><a href="#emojis-instance_method" title="Discorb::Guild#emojis (method)">#emojis</a></span> instead.</p>
</div>
</div>
<p>Fetch emoji id of the guild.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>id</span>
<span class='type'>(<tt>#to_s</tt>)</span>
—
<div class='inline'><p>The emoji id.</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="CustomEmoji.html" title="Discorb::CustomEmoji (class)">Discorb::CustomEmoji</a></span></tt>)</span>
—
<div class='inline'><p>The emoji with the given id.</p>
</div>
</li>
</ul>
<p class="tag_title">Raises:</p>
<ul class="raise">
<li>
<span class='type'>(<tt><span class='object_link'><a href="HTTPError.html" title="Discorb::HTTPError (class)">Discorb::HTTPError</a></span></tt>)</span>
—
<div class='inline'><p>HTTP request failed.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
206
207
208
209</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/guild.rb', line 206</span>
<span class='kw'>def</span> <span class='id identifier rubyid_fetch_emoji'>fetch_emoji</span><span class='lparen'>(</span><span class='id identifier rubyid_id'>id</span><span class='rparen'>)</span>
<span class='id identifier rubyid__resp'>_resp</span><span class='comma'>,</span> <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_http'>http</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/guilds/</span><span class='embexpr_beg'>#{</span><span class='ivar'>@id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/emojis/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_wait'>wait</span>
<span class='ivar'>@emojis</span><span class='lbracket'>[</span><span class='id identifier rubyid_e'>e</span><span class='lbracket'>[</span><span class='symbol'>:id</span><span class='rbracket'>]</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="CustomEmoji.html" title="Discorb::CustomEmoji (class)">CustomEmoji</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='ivar'>@client</span><span class='comma'>,</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="fetch_emoji_list-instance_method">
#<strong>fetch_emoji_list</strong> ⇒ <tt><span class='object_link'><a href="Dictionary.html" title="Discorb::Dictionary (class)">Discorb::Dictionary</a></span>{<span class='object_link'><a href="Snowflake.html" title="Discorb::Snowflake (class)">Discorb::Snowflake</a></span> => <span class='object_link'><a href="CustomEmoji.html" title="Discorb::CustomEmoji (class)">Discorb::CustomEmoji</a></span>}</tt>
<span class="aliases">Also known as:
<span class="names"><span id='fetch_emojis-instance_method'>fetch_emojis</span></span>
</span>
</h3><div class="docstring">
<div class="discussion">
<div class="note notetag">
<strong>Note:</strong>
<div class='inline'><p>This is an asynchronous method, it will return a <code>Async::Task</code> object. Use <code>Async::Task#wait</code> to get the result.</p>
</div>
</div>
<div class="note notetag">
<strong>Note:</strong>
<div class='inline'><p>This method calls HTTP request.</p>
</div>
</div>
<div class="note notetag">
<strong>Note:</strong>
<div class='inline'><p>This querys the API every time. We recommend using <span class='object_link'><a href="#emojis-instance_method" title="Discorb::Guild#emojis (method)">#emojis</a></span> instead.</p>
</div>
</div>
<p>Fetch emoji list of the guild.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="Dictionary.html" title="Discorb::Dictionary (class)">Discorb::Dictionary</a></span>{<span class='object_link'><a href="Snowflake.html" title="Discorb::Snowflake (class)">Discorb::Snowflake</a></span> => <span class='object_link'><a href="CustomEmoji.html" title="Discorb::CustomEmoji (class)">Discorb::CustomEmoji</a></span>}</tt>)</span>
—
<div class='inline'><p>A dictionary of emoji in the guild.</p>
</div>
</li>
</ul>
<p class="tag_title">Raises:</p>
<ul class="raise">
<li>
<span class='type'>(<tt><span class='object_link'><a href="HTTPError.html" title="Discorb::HTTPError (class)">Discorb::HTTPError</a></span></tt>)</span>
—
<div class='inline'><p>HTTP request failed.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
180
181
182
183
184
185
186
187
188
189
190
191
192</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/guild.rb', line 180</span>
<span class='kw'>def</span> <span class='id identifier rubyid_fetch_emoji_list'>fetch_emoji_list</span>
<span class='const'>Async</span> <span class='kw'>do</span>
<span class='id identifier rubyid__resp'>_resp</span><span class='comma'>,</span> <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_http'>http</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/guilds/</span><span class='embexpr_beg'>#{</span><span class='ivar'>@id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/emojis</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_wait'>wait</span>
<span class='ivar'>@emojis</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="Dictionary.html" title="Discorb::Dictionary (class)">Dictionary</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Dictionary.html#initialize-instance_method" title="Discorb::Dictionary#initialize (method)">new</a></span></span>
<span class='id identifier rubyid_ids'>ids</span> <span class='op'>=</span> <span class='ivar'>@emojis</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span><span class='lparen'>(</span><span class='op'>&</span><span class='symbol'>:id</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span><span class='lparen'>(</span><span class='op'>&</span><span class='symbol'>:to_s</span><span class='rparen'>)</span>
<span class='id identifier rubyid_data'>data</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_e'>e</span><span class='op'>|</span>
<span class='kw'>next</span> <span class='kw'>if</span> <span class='id identifier rubyid_ids'>ids</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span><span class='lparen'>(</span><span class='id identifier rubyid_e'>e</span><span class='lbracket'>[</span><span class='symbol'>:id</span><span class='rbracket'>]</span><span class='rparen'>)</span>
<span class='ivar'>@emojis</span><span class='lbracket'>[</span><span class='id identifier rubyid_e'>e</span><span class='lbracket'>[</span><span class='symbol'>:id</span><span class='rbracket'>]</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="CustomEmoji.html" title="Discorb::CustomEmoji (class)">CustomEmoji</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='ivar'>@client</span><span class='comma'>,</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='id identifier rubyid_e'>e</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='ivar'>@emojis</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="fetch_integrations-instance_method">
#<strong>fetch_integrations</strong> ⇒ <tt>Array<<span class='object_link'><a href="Integration.html" title="Discorb::Integration (class)">Discorb::Integration</a></span>></tt>
</h3><div class="docstring">
<div class="discussion">
<div class="note notetag">
<strong>Note:</strong>
<div class='inline'><p>This is an asynchronous method, it will return a <code>Async::Task</code> object. Use <code>Async::Task#wait</code> to get the result.</p>
</div>
</div>
<div class="note notetag">
<strong>Note:</strong>
<div class='inline'><p>This method calls HTTP request.</p>
</div>
</div>
<p>Fetch integrations in the guild.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Array<<span class='object_link'><a href="Integration.html" title="Discorb::Integration (class)">Discorb::Integration</a></span>></tt>)</span>
—
<div class='inline'><p>The integrations.</p>
</div>
</li>
</ul>
<p class="tag_title">Raises:</p>
<ul class="raise">
<li>
<span class='type'>(<tt><span class='object_link'><a href="HTTPError.html" title="Discorb::HTTPError (class)">Discorb::HTTPError</a></span></tt>)</span>
—
<div class='inline'><p>HTTP request failed.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
784
785
786
787
788
789</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/guild.rb', line 784</span>
<span class='kw'>def</span> <span class='id identifier rubyid_fetch_integrations'>fetch_integrations</span>
<span class='const'>Async</span> <span class='kw'>do</span>
<span class='id identifier rubyid__resp'>_resp</span><span class='comma'>,</span> <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_http'>http</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/guilds/</span><span class='embexpr_beg'>#{</span><span class='ivar'>@id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/integrations</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_wait'>wait</span>
<span class='id identifier rubyid_data'>data</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_d'>d</span><span class='op'>|</span> <span class='const'><span class='object_link'><a href="Integration.html" title="Discorb::Integration (class)">Integration</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='ivar'>@client</span><span class='comma'>,</span> <span class='id identifier rubyid_d'>d</span><span class='rparen'>)</span> <span class='rbrace'>}</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="fetch_invites-instance_method">
#<strong>fetch_invites</strong> ⇒ <tt>Array<<span class='object_link'><a href="Invite.html" title="Discorb::Invite (class)">Invite</a></span>></tt>
</h3><div class="docstring">
<div class="discussion">
<div class="note notetag">
<strong>Note:</strong>
<div class='inline'><p>This is an asynchronous method, it will return a <code>Async::Task</code> object. Use <code>Async::Task#wait</code> to get the result.</p>
</div>
</div>
<div class="note notetag">
<strong>Note:</strong>
<div class='inline'><p>This method calls HTTP request.</p>
</div>
</div>
<p>Fetch invites in the guild.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Array<<span class='object_link'><a href="Invite.html" title="Discorb::Invite (class)">Invite</a></span>></tt>)</span>
—
<div class='inline'><p>The invites.</p>
</div>
</li>
</ul>
<p class="tag_title">Raises:</p>
<ul class="raise">
<li>
<span class='type'>(<tt><span class='object_link'><a href="HTTPError.html" title="Discorb::HTTPError (class)">Discorb::HTTPError</a></span></tt>)</span>
—
<div class='inline'><p>HTTP request failed.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
770
771
772
773
774
775</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/guild.rb', line 770</span>
<span class='kw'>def</span> <span class='id identifier rubyid_fetch_invites'>fetch_invites</span>
<span class='const'>Async</span> <span class='kw'>do</span>
<span class='id identifier rubyid__resp'>_resp</span><span class='comma'>,</span> <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_http'>http</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/guilds/</span><span class='embexpr_beg'>#{</span><span class='ivar'>@id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/invites</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_wait'>wait</span>
<span class='id identifier rubyid_data'>data</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_d'>d</span><span class='op'>|</span> <span class='const'><span class='object_link'><a href="Invite.html" title="Discorb::Invite (class)">Invite</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='ivar'>@client</span><span class='comma'>,</span> <span class='id identifier rubyid_d'>d</span><span class='rparen'>)</span> <span class='rbrace'>}</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="fetch_member-instance_method">
#<strong>fetch_member</strong>(id) ⇒ <tt><span class='object_link'><a href="Member.html" title="Discorb::Member (class)">Discorb::Member</a></span></tt><sup>?</sup>
</h3><div class="docstring">
<div class="discussion">
<div class="note notetag">
<strong>Note:</strong>
<div class='inline'><p>This is an asynchronous method, it will return a <code>Async::Task</code> object. Use <code>Async::Task#wait</code> to get the result.</p>
</div>
</div>
<div class="note notetag">
<strong>Note:</strong>
<div class='inline'><p>This method calls HTTP request.</p>
</div>
</div>
<div class="note notetag">
<strong>Note:</strong>
<div class='inline'><p>You must enable <code>GUILD_MEMBERS</code> intent to use this method.</p>
</div>
</div>
<p>Fetch a member in the guild.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>id</span>
<span class='type'>(<tt>#to_s</tt>)</span>
—
<div class='inline'><p>The ID of the member to fetch.</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="Member.html" title="Discorb::Member (class)">Discorb::Member</a></span></tt>)</span>
—
<div class='inline'><p>The member.</p>
</div>
</li>
<li>
<span class='type'>(<tt>nil</tt>)</span>
—
<div class='inline'><p>If the member is not found.</p>
</div>
</li>
</ul>
<p class="tag_title">Raises:</p>
<ul class="raise">
<li>
<span class='type'>(<tt><span class='object_link'><a href="HTTPError.html" title="Discorb::HTTPError (class)">Discorb::HTTPError</a></span></tt>)</span>
—
<div class='inline'><p>HTTP request failed.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
512
513
514
515
516
517
518
519
520</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/guild.rb', line 512</span>
<span class='kw'>def</span> <span class='id identifier rubyid_fetch_member'>fetch_member</span><span class='lparen'>(</span><span class='id identifier rubyid_id'>id</span><span class='rparen'>)</span>
<span class='const'>Async</span> <span class='kw'>do</span>
<span class='id identifier rubyid__resp'>_resp</span><span class='comma'>,</span> <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_http'>http</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/guilds/</span><span class='embexpr_beg'>#{</span><span class='ivar'>@id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/members/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_wait'>wait</span>
<span class='kw'>rescue</span> <span class='const'><span class='object_link'><a href="../Discorb.html" title="Discorb (module)">Discorb</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="NotFoundError.html" title="Discorb::NotFoundError (class)">NotFoundError</a></span></span>
<span class='kw'>nil</span>
<span class='kw'>else</span>
<span class='const'><span class='object_link'><a href="Member.html" title="Discorb::Member (class)">Member</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='ivar'>@client</span><span class='comma'>,</span> <span class='ivar'>@id</span><span class='comma'>,</span> <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:user</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="fetch_member_named-instance_method">
#<strong>fetch_member_named</strong> ⇒ <tt><span class='object_link'><a href="Member.html" title="Discorb::Member (class)">Discorb::Member</a></span></tt><sup>?</sup>
</h3><div class="docstring">
<div class="discussion">
<div class="note notetag">
<strong>Note:</strong>
<div class='inline'><p>This is an asynchronous method, it will return a <code>Async::Task</code> object. Use <code>Async::Task#wait</code> to get the result.</p>
</div>
</div>
<div class="note notetag">
<strong>Note:</strong>
<div class='inline'><p>This method calls HTTP request.</p>
</div>
</div>
<p>Almost the same as <span class='object_link'><a href="#fetch_members_named-instance_method" title="Discorb::Guild#fetch_members_named (method)">#fetch_members_named</a></span>, but returns a single member.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="Member.html" title="Discorb::Member (class)">Discorb::Member</a></span></tt>)</span>
—
<div class='inline'><p>The member.</p>
</div>
</li>
<li>
<span class='type'>(<tt>nil</tt>)</span>
—
<div class='inline'><p>If the member is not found.</p>
</div>
</li>
</ul>
<p class="tag_title">Raises:</p>
<ul class="raise">
<li>
<span class='type'>(<tt><span class='object_link'><a href="HTTPError.html" title="Discorb::HTTPError (class)">Discorb::HTTPError</a></span></tt>)</span>
—
<div class='inline'><p>HTTP request failed.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
547
548
549
550
551</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/guild.rb', line 547</span>
<span class='kw'>def</span> <span class='id identifier rubyid_fetch_member_named'>fetch_member_named</span><span class='lparen'>(</span><span class='op'>...</span><span class='rparen'>)</span>
<span class='const'>Async</span> <span class='kw'>do</span>
<span class='id identifier rubyid_fetch_members_named'>fetch_members_named</span><span class='lparen'>(</span><span class='op'>...</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="fetch_members_named-instance_method">
#<strong>fetch_members_named</strong>(name, limit: 1) ⇒ <tt>Array<<span class='object_link'><a href="Member.html" title="Discorb::Member (class)">Discorb::Member</a></span>></tt>
</h3><div class="docstring">
<div class="discussion">
<div class="note notetag">
<strong>Note:</strong>
<div class='inline'><p>This is an asynchronous method, it will return a <code>Async::Task</code> object. Use <code>Async::Task#wait</code> to get the result.</p>
</div>
</div>
<div class="note notetag">
<strong>Note:</strong>
<div class='inline'><p>This method calls HTTP request.</p>
</div>
</div>
<p>Search for members by name in the guild.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>name</span>
<span class='type'>(<tt>String</tt>)</span>
—
<div class='inline'><p>The name of the member to search for.</p>
</div>
</li>
<li>
<span class='name'>limit</span>
<span class='type'>(<tt>Integer</tt>)</span>
<em class="default">(defaults to: <tt>1</tt>)</em>
—
<div class='inline'><p>The maximum number of members to return.</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Array<<span class='object_link'><a href="Member.html" title="Discorb::Member (class)">Discorb::Member</a></span>></tt>)</span>
—
<div class='inline'><p>The list of members.</p>
</div>
</li>
</ul>
<p class="tag_title">Raises:</p>
<ul class="raise">
<li>
<span class='type'>(<tt><span class='object_link'><a href="HTTPError.html" title="Discorb::HTTPError (class)">Discorb::HTTPError</a></span></tt>)</span>
—
<div class='inline'><p>HTTP request failed.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
532
533
534
535
536
537</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/guild.rb', line 532</span>
<span class='kw'>def</span> <span class='id identifier rubyid_fetch_members_named'>fetch_members_named</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='label'>limit:</span> <span class='int'>1</span><span class='rparen'>)</span>
<span class='const'>Async</span> <span class='kw'>do</span>
<span class='id identifier rubyid__resp'>_resp</span><span class='comma'>,</span> <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_http'>http</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/guilds/</span><span class='embexpr_beg'>#{</span><span class='ivar'>@id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/members/search?</span><span class='embexpr_beg'>#{</span><span class='const'>URI</span><span class='period'>.</span><span class='id identifier rubyid_encode_www_form'>encode_www_form</span><span class='lparen'>(</span><span class='lbrace'>{</span> <span class='label'>query:</span> <span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span> <span class='rbrace'>}</span><span class='rparen'>)</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_wait'>wait</span>
<span class='id identifier rubyid_data'>data</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_d'>d</span><span class='op'>|</span> <span class='const'><span class='object_link'><a href="Member.html" title="Discorb::Member (class)">Member</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='ivar'>@client</span><span class='comma'>,</span> <span class='ivar'>@id</span><span class='comma'>,</span> <span class='id identifier rubyid_d'>d</span><span class='lbracket'>[</span><span class='symbol'>:user</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_d'>d</span><span class='rparen'>)</span> <span class='rbrace'>}</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="fetch_prune-instance_method">
#<strong>fetch_prune</strong>(days = 7, roles: []) ⇒ <tt>Integer</tt>
</h3><div class="docstring">
<div class="discussion">
<div class="note notetag">
<strong>Note:</strong>
<div class='inline'><p>This is an asynchronous method, it will return a <code>Async::Task</code> object. Use <code>Async::Task#wait</code> to get the result.</p>
</div>
</div>
<div class="note notetag">
<strong>Note:</strong>
<div class='inline'><p>This method calls HTTP request.</p>
</div>
</div>
<p>Fetch how many members will be pruned.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>days</span>
<span class='type'>(<tt>Integer</tt>)</span>
<em class="default">(defaults to: <tt>7</tt>)</em>
—
<div class='inline'><p>The number of days to prune.</p>
</div>
</li>
<li>
<span class='name'>roles</span>
<span class='type'>(<tt>Array<<span class='object_link'><a href="Role.html" title="Discorb::Role (class)">Discorb::Role</a></span>></tt>)</span>
<em class="default">(defaults to: <tt>[]</tt>)</em>
—
<div class='inline'><p>The roles that include for pruning.</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Integer</tt>)</span>
—
<div class='inline'><p>The number of members that will be pruned.</p>
</div>
</li>
</ul>
<p class="tag_title">Raises:</p>
<ul class="raise">
<li>
<span class='type'>(<tt><span class='object_link'><a href="HTTPError.html" title="Discorb::HTTPError (class)">Discorb::HTTPError</a></span></tt>)</span>
—
<div class='inline'><p>HTTP request failed.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
717
718
719
720
721
722
723
724
725
726
727</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/guild.rb', line 717</span>
<span class='kw'>def</span> <span class='id identifier rubyid_fetch_prune'>fetch_prune</span><span class='lparen'>(</span><span class='id identifier rubyid_days'>days</span> <span class='op'>=</span> <span class='int'>7</span><span class='comma'>,</span> <span class='label'>roles:</span> <span class='lbracket'>[</span><span class='rbracket'>]</span><span class='rparen'>)</span>
<span class='const'>Async</span> <span class='kw'>do</span>
<span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='lbrace'>{</span>
<span class='label'>days:</span> <span class='id identifier rubyid_days'>days</span><span class='comma'>,</span>
<span class='label'>include_roles:</span> <span class='ivar'>@id</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='comma'>,</span>
<span class='rbrace'>}</span>
<span class='id identifier rubyid_param'>param</span><span class='lbracket'>[</span><span class='symbol'>:include_roles</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_roles'>roles</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span><span class='lparen'>(</span><span class='op'>&</span><span class='symbol'>:id</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span><span class='lparen'>(</span><span class='op'>&</span><span class='symbol'>:to_s</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>;</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id identifier rubyid_roles'>roles</span><span class='period'>.</span><span class='id identifier rubyid_any?'>any?</span>
<span class='id identifier rubyid__resp'>_resp</span><span class='comma'>,</span> <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_http'>http</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/guilds/</span><span class='embexpr_beg'>#{</span><span class='ivar'>@id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/prune?</span><span class='embexpr_beg'>#{</span><span class='const'>URI</span><span class='period'>.</span><span class='id identifier rubyid_encode_www_form'>encode_www_form</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span><span class='rparen'>)</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_wait'>wait</span>
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:pruned</span><span class='rbracket'>]</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="fetch_roles-instance_method">
#<strong>fetch_roles</strong> ⇒ <tt>Array<<span class='object_link'><a href="Role.html" title="Discorb::Role (class)">Discorb::Role</a></span>></tt>
</h3><div class="docstring">
<div class="discussion">
<div class="note notetag">
<strong>Note:</strong>
<div class='inline'><p>This is an asynchronous method, it will return a <code>Async::Task</code> object. Use <code>Async::Task#wait</code> to get the result.</p>
</div>
</div>
<div class="note notetag">
<strong>Note:</strong>
<div class='inline'><p>This method calls HTTP request.</p>
</div>
</div>
<p>Fetch a list of roles in the guild.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Array<<span class='object_link'><a href="Role.html" title="Discorb::Role (class)">Discorb::Role</a></span>></tt>)</span>
—
<div class='inline'><p>The list of roles.</p>
</div>
</li>
</ul>
<p class="tag_title">Raises:</p>
<ul class="raise">
<li>
<span class='type'>(<tt><span class='object_link'><a href="HTTPError.html" title="Discorb::HTTPError (class)">Discorb::HTTPError</a></span></tt>)</span>
—
<div class='inline'><p>HTTP request failed.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
673
674
675
676
677
678</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/guild.rb', line 673</span>
<span class='kw'>def</span> <span class='id identifier rubyid_fetch_roles'>fetch_roles</span>
<span class='const'>Async</span> <span class='kw'>do</span>
<span class='id identifier rubyid__resp'>_resp</span><span class='comma'>,</span> <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_http'>http</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/guilds/</span><span class='embexpr_beg'>#{</span><span class='ivar'>@id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/roles</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_wait'>wait</span>
<span class='id identifier rubyid_data'>data</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_d'>d</span><span class='op'>|</span> <span class='const'><span class='object_link'><a href="Role.html" title="Discorb::Role (class)">Role</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='ivar'>@client</span><span class='comma'>,</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='id identifier rubyid_d'>d</span><span class='rparen'>)</span> <span class='rbrace'>}</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="fetch_sticker-instance_method">
#<strong>fetch_sticker</strong>(id) ⇒ <tt><span class='object_link'><a href="Sticker/GuildSticker.html" title="Discorb::Sticker::GuildSticker (class)">Discorb::Sticker::GuildSticker</a></span></tt><sup>?</sup>
</h3><div class="docstring">
<div class="discussion">
<div class="note notetag">
<strong>Note:</strong>
<div class='inline'><p>This is an asynchronous method, it will return a <code>Async::Task</code> object. Use <code>Async::Task#wait</code> to get the result.</p>
</div>
</div>
<div class="note notetag">
<strong>Note:</strong>
<div class='inline'><p>This method calls HTTP request.</p>
</div>
</div>
<p>Fetch the sticker by ID.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>id</span>
<span class='type'>(<tt>#to_s</tt>)</span>
—
<div class='inline'><p>The ID of the sticker.</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="Sticker/GuildSticker.html" title="Discorb::Sticker::GuildSticker (class)">Discorb::Sticker::GuildSticker</a></span></tt>)</span>
—
<div class='inline'><p>The sticker.</p>
</div>
</li>
<li>
<span class='type'>(<tt>nil</tt>)</span>
—
<div class='inline'><p>If the sticker does not exist.</p>
</div>
</li>
</ul>
<p class="tag_title">Raises:</p>
<ul class="raise">
<li>
<span class='type'>(<tt><span class='object_link'><a href="HTTPError.html" title="Discorb::HTTPError (class)">Discorb::HTTPError</a></span></tt>)</span>
—
<div class='inline'><p>HTTP request failed.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
857
858
859
860
861
862
863
864
865</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/guild.rb', line 857</span>
<span class='kw'>def</span> <span class='id identifier rubyid_fetch_sticker'>fetch_sticker</span><span class='lparen'>(</span><span class='id identifier rubyid_id'>id</span><span class='rparen'>)</span>
<span class='const'>Async</span> <span class='kw'>do</span>
<span class='id identifier rubyid__resp'>_resp</span><span class='comma'>,</span> <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_http'>http</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/guilds/</span><span class='embexpr_beg'>#{</span><span class='ivar'>@id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/stickers/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_wait'>wait</span>
<span class='kw'>rescue</span> <span class='const'><span class='object_link'><a href="../Discorb.html" title="Discorb (module)">Discorb</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="NotFoundError.html" title="Discorb::NotFoundError (class)">NotFoundError</a></span></span>
<span class='kw'>nil</span>
<span class='kw'>else</span>
<span class='const'><span class='object_link'><a href="Sticker.html" title="Discorb::Sticker (class)">Sticker</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Sticker/GuildSticker.html" title="Discorb::Sticker::GuildSticker (class)">GuildSticker</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='ivar'>@client</span><span class='comma'>,</span> <span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="fetch_stickers-instance_method">
#<strong>fetch_stickers</strong> ⇒ <tt>Array<<span class='object_link'><a href="Sticker/GuildSticker.html" title="Discorb::Sticker::GuildSticker (class)">Discorb::Sticker::GuildSticker</a></span>></tt>
</h3><div class="docstring">
<div class="discussion">
<div class="note notetag">
<strong>Note:</strong>
<div class='inline'><p>This is an asynchronous method, it will return a <code>Async::Task</code> object. Use <code>Async::Task#wait</code> to get the result.</p>
</div>
</div>
<div class="note notetag">
<strong>Note:</strong>
<div class='inline'><p>This method calls HTTP request.</p>
</div>
</div>
<p>Fetch stickers in the guild.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Array<<span class='object_link'><a href="Sticker/GuildSticker.html" title="Discorb::Sticker::GuildSticker (class)">Discorb::Sticker::GuildSticker</a></span>></tt>)</span>
—
<div class='inline'><p>The stickers.</p>
</div>
</li>
</ul>
<p class="tag_title">Raises:</p>
<ul class="raise">
<li>
<span class='type'>(<tt><span class='object_link'><a href="HTTPError.html" title="Discorb::HTTPError (class)">Discorb::HTTPError</a></span></tt>)</span>
—
<div class='inline'><p>HTTP request failed.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
840
841
842
843
844
845</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/guild.rb', line 840</span>
<span class='kw'>def</span> <span class='id identifier rubyid_fetch_stickers'>fetch_stickers</span>
<span class='const'>Async</span> <span class='kw'>do</span>
<span class='id identifier rubyid__resp'>_resp</span><span class='comma'>,</span> <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_http'>http</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/guilds/</span><span class='embexpr_beg'>#{</span><span class='ivar'>@id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/stickers</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_wait'>wait</span>
<span class='id identifier rubyid_data'>data</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_d'>d</span><span class='op'>|</span> <span class='const'><span class='object_link'><a href="Sticker.html" title="Discorb::Sticker (class)">Sticker</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Sticker/GuildSticker.html" title="Discorb::Sticker::GuildSticker (class)">GuildSticker</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='ivar'>@client</span><span class='comma'>,</span> <span class='id identifier rubyid_d'>d</span><span class='rparen'>)</span> <span class='rbrace'>}</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="fetch_template-instance_method">
#<strong>fetch_template</strong> ⇒ <tt><span class='object_link'><a href="GuildTemplate.html" title="Discorb::GuildTemplate (class)">Discorb::GuildTemplate</a></span></tt><sup>?</sup>
</h3><div class="docstring">
<div class="discussion">
<p>Almost the same as <span class='object_link'><a href="#fetch_templates-instance_method" title="Discorb::Guild#fetch_templates (method)">#fetch_templates</a></span>, but returns a single template.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="GuildTemplate.html" title="Discorb::GuildTemplate (class)">Discorb::GuildTemplate</a></span></tt>)</span>
—
<div class='inline'><p>The template.</p>
</div>
</li>
<li>
<span class='type'>(<tt>nil</tt>)</span>
—
<div class='inline'><p>If the template does not exist.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
887
888
889
890
891</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/guild.rb', line 887</span>
<span class='kw'>def</span> <span class='id identifier rubyid_fetch_template'>fetch_template</span>
<span class='const'>Async</span> <span class='kw'>do</span>
<span class='id identifier rubyid_fetch_templates'>fetch_templates</span><span class='period'>.</span><span class='id identifier rubyid_wait'>wait</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="fetch_templates-instance_method">
#<strong>fetch_templates</strong> ⇒ <tt><span class='object_link'><a href="GuildTemplate.html" title="Discorb::GuildTemplate (class)">Discorb::GuildTemplate</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<div class="note notetag">
<strong>Note:</strong>
<div class='inline'><p>This is an asynchronous method, it will return a <code>Async::Task</code> object. Use <code>Async::Task#wait</code> to get the result.</p>
</div>
</div>
<div class="note notetag">
<strong>Note:</strong>
<div class='inline'><p>This method calls HTTP request.</p>
</div>
</div>
<p>Fetch templates in the guild.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="GuildTemplate.html" title="Discorb::GuildTemplate (class)">Discorb::GuildTemplate</a></span></tt>)</span>
—
<div class='inline'><p>The templates.</p>
</div>
</li>
</ul>
<p class="tag_title">Raises:</p>
<ul class="raise">
<li>
<span class='type'>(<tt><span class='object_link'><a href="HTTPError.html" title="Discorb::HTTPError (class)">Discorb::HTTPError</a></span></tt>)</span>
—
<div class='inline'><p>HTTP request failed.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
874
875
876
877
878
879</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/guild.rb', line 874</span>
<span class='kw'>def</span> <span class='id identifier rubyid_fetch_templates'>fetch_templates</span>
<span class='const'>Async</span> <span class='kw'>do</span>
<span class='id identifier rubyid__resp'>_resp</span><span class='comma'>,</span> <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_http'>http</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/guilds/</span><span class='embexpr_beg'>#{</span><span class='ivar'>@id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/templates</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_wait'>wait</span>
<span class='id identifier rubyid_data'>data</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_d'>d</span><span class='op'>|</span> <span class='const'><span class='object_link'><a href="GuildTemplate.html" title="Discorb::GuildTemplate (class)">GuildTemplate</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='ivar'>@client</span><span class='comma'>,</span> <span class='id identifier rubyid_d'>d</span><span class='rparen'>)</span> <span class='rbrace'>}</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="fetch_vanity_invite-instance_method">
#<strong>fetch_vanity_invite</strong> ⇒ <tt><span class='object_link'><a href="Guild/VanityInvite.html" title="Discorb::Guild::VanityInvite (class)">Discorb::Guild::VanityInvite</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<div class="note notetag">
<strong>Note:</strong>
<div class='inline'><p>This is an asynchronous method, it will return a <code>Async::Task</code> object. Use <code>Async::Task#wait</code> to get the result.</p>
</div>
</div>
<div class="note notetag">
<strong>Note:</strong>
<div class='inline'><p>This method calls HTTP request.</p>
</div>
</div>
<p>Fetch the vanity URL of the guild.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="Guild/VanityInvite.html" title="Discorb::Guild::VanityInvite (class)">Discorb::Guild::VanityInvite</a></span></tt>)</span>
—
<div class='inline'><p>The vanity URL.</p>
</div>
</li>
</ul>
<p class="tag_title">Raises:</p>
<ul class="raise">
<li>
<span class='type'>(<tt><span class='object_link'><a href="HTTPError.html" title="Discorb::HTTPError (class)">Discorb::HTTPError</a></span></tt>)</span>
—
<div class='inline'><p>HTTP request failed.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
812
813
814
815
816
817</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/guild.rb', line 812</span>
<span class='kw'>def</span> <span class='id identifier rubyid_fetch_vanity_invite'>fetch_vanity_invite</span>
<span class='const'>Async</span> <span class='kw'>do</span>
<span class='id identifier rubyid__resp'>_resp</span><span class='comma'>,</span> <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_http'>http</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/guilds/</span><span class='embexpr_beg'>#{</span><span class='ivar'>@id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/vanity-url</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_wait'>wait</span>
<span class='const'><span class='object_link'><a href="Guild/VanityInvite.html" title="Discorb::Guild::VanityInvite (class)">VanityInvite</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='ivar'>@client</span><span class='comma'>,</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="fetch_voice_regions-instance_method">
#<strong>fetch_voice_regions</strong> ⇒ <tt>Array<<span class='object_link'><a href="VoiceRegion.html" title="Discorb::VoiceRegion (class)">Discorb::VoiceRegion</a></span>></tt>
</h3><div class="docstring">
<div class="discussion">
<div class="note notetag">
<strong>Note:</strong>
<div class='inline'><p>This is an asynchronous method, it will return a <code>Async::Task</code> object. Use <code>Async::Task#wait</code> to get the result.</p>
</div>
</div>
<div class="note notetag">
<strong>Note:</strong>
<div class='inline'><p>This method calls HTTP request.</p>
</div>
</div>
<p>Fetch voice regions that are available in the guild.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Array<<span class='object_link'><a href="VoiceRegion.html" title="Discorb::VoiceRegion (class)">Discorb::VoiceRegion</a></span>></tt>)</span>
—
<div class='inline'><p>The available voice regions.</p>
</div>
</li>
</ul>
<p class="tag_title">Raises:</p>
<ul class="raise">
<li>
<span class='type'>(<tt><span class='object_link'><a href="HTTPError.html" title="Discorb::HTTPError (class)">Discorb::HTTPError</a></span></tt>)</span>
—
<div class='inline'><p>HTTP request failed.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
756
757
758
759
760
761</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/guild.rb', line 756</span>
<span class='kw'>def</span> <span class='id identifier rubyid_fetch_voice_regions'>fetch_voice_regions</span>
<span class='const'>Async</span> <span class='kw'>do</span>
<span class='id identifier rubyid__resp'>_resp</span><span class='comma'>,</span> <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_http'>http</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/guilds/</span><span class='embexpr_beg'>#{</span><span class='ivar'>@id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/voice</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_wait'>wait</span>
<span class='id identifier rubyid_data'>data</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_d'>d</span><span class='op'>|</span> <span class='const'><span class='object_link'><a href="VoiceRegion.html" title="Discorb::VoiceRegion (class)">VoiceRegion</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='ivar'>@client</span><span class='comma'>,</span> <span class='id identifier rubyid_d'>d</span><span class='rparen'>)</span> <span class='rbrace'>}</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="fetch_webhooks-instance_method">
#<strong>fetch_webhooks</strong> ⇒ <tt>Array<<span class='object_link'><a href="Webhook.html" title="Discorb::Webhook (class)">Discorb::Webhook</a></span>></tt>
</h3><div class="docstring">
<div class="discussion">
<div class="note notetag">
<strong>Note:</strong>
<div class='inline'><p>This is an asynchronous method, it will return a <code>Async::Task</code> object. Use <code>Async::Task#wait</code> to get the result.</p>
</div>
</div>
<div class="note notetag">
<strong>Note:</strong>
<div class='inline'><p>This method calls HTTP request.</p>
</div>
</div>
<p>Fetch webhooks of the guild.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Array<<span class='object_link'><a href="Webhook.html" title="Discorb::Webhook (class)">Discorb::Webhook</a></span>></tt>)</span>
—
<div class='inline'><p>A list of webhooks in the guild.</p>
</div>
</li>
</ul>
<p class="tag_title">Raises:</p>
<ul class="raise">
<li>
<span class='type'>(<tt><span class='object_link'><a href="HTTPError.html" title="Discorb::HTTPError (class)">Discorb::HTTPError</a></span></tt>)</span>
—
<div class='inline'><p>HTTP request failed.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
241
242
243
244
245
246</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/guild.rb', line 241</span>
<span class='kw'>def</span> <span class='id identifier rubyid_fetch_webhooks'>fetch_webhooks</span>
<span class='const'>Async</span> <span class='kw'>do</span>
<span class='id identifier rubyid__resp'>_resp</span><span class='comma'>,</span> <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_http'>http</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/guilds/</span><span class='embexpr_beg'>#{</span><span class='ivar'>@id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/webhooks</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_wait'>wait</span>
<span class='id identifier rubyid_data'>data</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_webhook'>webhook</span><span class='op'>|</span> <span class='const'><span class='object_link'><a href="Webhook.html" title="Discorb::Webhook (class)">Webhook</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Webhook.html#new-class_method" title="Discorb::Webhook.new (method)">new</a></span></span><span class='lparen'>(</span><span class='lbracket'>[</span><span class='ivar'>@client</span><span class='comma'>,</span> <span class='id identifier rubyid_webhook'>webhook</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='rbrace'>}</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="fetch_welcome_screen-instance_method">
#<strong>fetch_welcome_screen</strong> ⇒ <tt>Discorb::Guild::WelcomeScreen</tt>
</h3><div class="docstring">
<div class="discussion">
<div class="note notetag">
<strong>Note:</strong>
<div class='inline'><p>This is an asynchronous method, it will return a <code>Async::Task</code> object. Use <code>Async::Task#wait</code> to get the result.</p>
</div>
</div>
<div class="note notetag">
<strong>Note:</strong>
<div class='inline'><p>This method calls HTTP request.</p>
</div>
</div>
<p>Fetch the welcome screen of the guild.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Discorb::Guild::WelcomeScreen</tt>)</span>
—
<div class='inline'><p>The welcome screen.</p>
</div>
</li>
</ul>
<p class="tag_title">Raises:</p>
<ul class="raise">
<li>
<span class='type'>(<tt><span class='object_link'><a href="HTTPError.html" title="Discorb::HTTPError (class)">Discorb::HTTPError</a></span></tt>)</span>
—
<div class='inline'><p>HTTP request failed.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
826
827
828
829
830
831</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/guild.rb', line 826</span>
<span class='kw'>def</span> <span class='id identifier rubyid_fetch_welcome_screen'>fetch_welcome_screen</span>
<span class='const'>Async</span> <span class='kw'>do</span>
<span class='id identifier rubyid__resp'>_resp</span><span class='comma'>,</span> <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_http'>http</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/guilds/</span><span class='embexpr_beg'>#{</span><span class='ivar'>@id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/welcome-screen</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_wait'>wait</span>
<span class='const'><span class='object_link'><a href="WelcomeScreen.html" title="Discorb::WelcomeScreen (class)">WelcomeScreen</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='ivar'>@client</span><span class='comma'>,</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="fetch_widget-instance_method">
#<strong>fetch_widget</strong> ⇒ <tt><span class='object_link'><a href="Guild/Widget.html" title="Discorb::Guild::Widget (class)">Discorb::Guild::Widget</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<div class="note notetag">
<strong>Note:</strong>
<div class='inline'><p>This is an asynchronous method, it will return a <code>Async::Task</code> object. Use <code>Async::Task#wait</code> to get the result.</p>
</div>
</div>
<div class="note notetag">
<strong>Note:</strong>
<div class='inline'><p>This method calls HTTP request.</p>
</div>
</div>
<p>Fetch the widget of the guild.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="Guild/Widget.html" title="Discorb::Guild::Widget (class)">Discorb::Guild::Widget</a></span></tt>)</span>
—
<div class='inline'><p>The widget.</p>
</div>
</li>
</ul>
<p class="tag_title">Raises:</p>
<ul class="raise">
<li>
<span class='type'>(<tt><span class='object_link'><a href="HTTPError.html" title="Discorb::HTTPError (class)">Discorb::HTTPError</a></span></tt>)</span>
—
<div class='inline'><p>HTTP request failed.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
798
799
800
801
802
803</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/guild.rb', line 798</span>
<span class='kw'>def</span> <span class='id identifier rubyid_fetch_widget'>fetch_widget</span>
<span class='const'>Async</span> <span class='kw'>do</span>
<span class='id identifier rubyid__resp'>_resp</span><span class='comma'>,</span> <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_http'>http</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/guilds/</span><span class='embexpr_beg'>#{</span><span class='ivar'>@id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/widget</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_wait'>wait</span>
<span class='const'><span class='object_link'><a href="Guild/Widget.html" title="Discorb::Guild::Widget (class)">Widget</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='ivar'>@client</span><span class='comma'>,</span> <span class='ivar'>@id</span><span class='comma'>,</span> <span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="inspect-instance_method">
#<strong>inspect</strong> ⇒ <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
152
153
154</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/guild.rb', line 152</span>
<span class='kw'>def</span> <span class='id identifier rubyid_inspect'>inspect</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>#<</span><span class='embexpr_beg'>#{</span><span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='embexpr_end'>}</span><span class='tstring_content'> \"</span><span class='embexpr_beg'>#{</span><span class='ivar'>@name</span><span class='embexpr_end'>}</span><span class='tstring_content'>\" id=</span><span class='embexpr_beg'>#{</span><span class='ivar'>@id</span><span class='embexpr_end'>}</span><span class='tstring_content'>></span><span class='tstring_end'>"</span></span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="kick_member-instance_method">
#<strong>kick_member</strong>(member, reason: nil) ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<div class="note notetag">
<strong>Note:</strong>
<div class='inline'><p>This is an asynchronous method, it will return a <code>Async::Task</code> object. Use <code>Async::Task#wait</code> to get the result.</p>
</div>
</div>
<div class="note notetag">
<strong>Note:</strong>
<div class='inline'><p>This method calls HTTP request.</p>
</div>
</div>
<p>Kick a member from the guild.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>member</span>
<span class='type'>(<tt><span class='object_link'><a href="Member.html" title="Discorb::Member (class)">Discorb::Member</a></span></tt>)</span>
—
<div class='inline'><p>The member to kick.</p>
</div>
</li>
<li>
<span class='name'>reason</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'><p>The reason for kicking the member.</p>
</div>
</li>
</ul>
<p class="tag_title">Raises:</p>
<ul class="raise">
<li>
<span class='type'>(<tt><span class='object_link'><a href="HTTPError.html" title="Discorb::HTTPError (class)">Discorb::HTTPError</a></span></tt>)</span>
—
<div class='inline'><p>HTTP request failed.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
577
578
579
580
581</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/guild.rb', line 577</span>
<span class='kw'>def</span> <span class='id identifier rubyid_kick_member'>kick_member</span><span class='lparen'>(</span><span class='id identifier rubyid_member'>member</span><span class='comma'>,</span> <span class='label'>reason:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
<span class='const'>Async</span> <span class='kw'>do</span>
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_http'>http</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/guilds/</span><span class='embexpr_beg'>#{</span><span class='ivar'>@id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/members/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_member'>member</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>audit_log_reason:</span> <span class='id identifier rubyid_reason'>reason</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_wait'>wait</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="leave!-instance_method">
#<strong>leave!</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<div class="note notetag">
<strong>Note:</strong>
<div class='inline'><p>This is an asynchronous method, it will return a <code>Async::Task</code> object. Use <code>Async::Task#wait</code> to get the result.</p>
</div>
</div>
<div class="note notetag">
<strong>Note:</strong>
<div class='inline'><p>This method calls HTTP request.</p>
</div>
</div>
<p>Leave the guild.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Raises:</p>
<ul class="raise">
<li>
<span class='type'>(<tt><span class='object_link'><a href="HTTPError.html" title="Discorb::HTTPError (class)">Discorb::HTTPError</a></span></tt>)</span>
—
<div class='inline'><p>HTTP request failed.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
165
166
167
168
169
170</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/guild.rb', line 165</span>
<span class='kw'>def</span> <span class='id identifier rubyid_leave!'>leave!</span>
<span class='const'>Async</span> <span class='kw'>do</span>
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_http'>http</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/users/@me/guilds/</span><span class='embexpr_beg'>#{</span><span class='ivar'>@id</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_wait'>wait</span>
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_guilds'>guilds</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='ivar'>@id</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="me-instance_method">
#<strong>me</strong> ⇒ <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
156
157
158</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/guild.rb', line 156</span>
<span class='kw'>def</span> <span class='id identifier rubyid_me'>me</span>
<span class='ivar'>@members</span><span class='lbracket'>[</span><span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_user'>user</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span><span class='rbracket'>]</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="prune-instance_method">
#<strong>prune</strong>(days = 7, roles: [], reason: nil) ⇒ <tt>Integer</tt>
</h3><div class="docstring">
<div class="discussion">
<div class="note notetag">
<strong>Note:</strong>
<div class='inline'><p>This is an asynchronous method, it will return a <code>Async::Task</code> object. Use <code>Async::Task#wait</code> to get the result.</p>
</div>
</div>
<div class="note notetag">
<strong>Note:</strong>
<div class='inline'><p>This method calls HTTP request.</p>
</div>
</div>
<p>Prune members from the guild.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>days</span>
<span class='type'>(<tt>Integer</tt>)</span>
<em class="default">(defaults to: <tt>7</tt>)</em>
—
<div class='inline'><p>The number of days to prune.</p>
</div>
</li>
<li>
<span class='name'>roles</span>
<span class='type'>(<tt>Array<<span class='object_link'><a href="Role.html" title="Discorb::Role (class)">Discorb::Role</a></span>></tt>)</span>
<em class="default">(defaults to: <tt>[]</tt>)</em>
—
<div class='inline'><p>The roles that include for pruning.</p>
</div>
</li>
<li>
<span class='name'>reason</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'><p>The reason for pruning.</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Integer</tt>)</span>
—
<div class='inline'><p>The number of members that were pruned.</p>
</div>
</li>
</ul>
<p class="tag_title">Raises:</p>
<ul class="raise">
<li>
<span class='type'>(<tt><span class='object_link'><a href="HTTPError.html" title="Discorb::HTTPError (class)">Discorb::HTTPError</a></span></tt>)</span>
—
<div class='inline'><p>HTTP request failed.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
740
741
742
743
744
745
746
747</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/guild.rb', line 740</span>
<span class='kw'>def</span> <span class='id identifier rubyid_prune'>prune</span><span class='lparen'>(</span><span class='id identifier rubyid_days'>days</span> <span class='op'>=</span> <span class='int'>7</span><span class='comma'>,</span> <span class='label'>roles:</span> <span class='lbracket'>[</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='label'>reason:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
<span class='const'>Async</span> <span class='kw'>do</span>
<span class='id identifier rubyid__resp'>_resp</span><span class='comma'>,</span> <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_http'>http</span><span class='period'>.</span><span class='id identifier rubyid_post'>post</span><span class='lparen'>(</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/guilds/</span><span class='embexpr_beg'>#{</span><span class='ivar'>@id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/prune</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='lbrace'>{</span> <span class='label'>days:</span> <span class='id identifier rubyid_days'>days</span><span class='comma'>,</span> <span class='label'>roles:</span> <span class='id identifier rubyid_roles'>roles</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span><span class='lparen'>(</span><span class='op'>&</span><span class='symbol'>:id</span><span class='rparen'>)</span> <span class='rbrace'>}</span><span class='comma'>,</span> <span class='label'>audit_log_reason:</span> <span class='id identifier rubyid_reason'>reason</span><span class='comma'>,</span>
<span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_wait'>wait</span>
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:pruned</span><span class='rbracket'>]</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="public_updates_channel-instance_method">
#<strong>public_updates_channel</strong> ⇒ <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
148
149
150</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/guild.rb', line 148</span>
<span class='kw'>def</span> <span class='id identifier rubyid_public_updates_channel'>public_updates_channel</span>
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_channels'>channels</span><span class='lbracket'>[</span><span class='ivar'>@public_updates_channel_id</span><span class='rbracket'>]</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="rules_channel-instance_method">
#<strong>rules_channel</strong> ⇒ <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
144
145
146</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/guild.rb', line 144</span>
<span class='kw'>def</span> <span class='id identifier rubyid_rules_channel'>rules_channel</span>
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_channels'>channels</span><span class='lbracket'>[</span><span class='ivar'>@rules_channel_id</span><span class='rbracket'>]</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="system_channel-instance_method">
#<strong>system_channel</strong> ⇒ <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
140
141
142</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/guild.rb', line 140</span>
<span class='kw'>def</span> <span class='id identifier rubyid_system_channel'>system_channel</span>
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_channels'>channels</span><span class='lbracket'>[</span><span class='ivar'>@system_channel_id</span><span class='rbracket'>]</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="unban_user-instance_method">
#<strong>unban_user</strong>(user, reason: nil) ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<div class="note notetag">
<strong>Note:</strong>
<div class='inline'><p>This is an asynchronous method, it will return a <code>Async::Task</code> object. Use <code>Async::Task#wait</code> to get the result.</p>
</div>
</div>
<div class="note notetag">
<strong>Note:</strong>
<div class='inline'><p>This method calls HTTP request.</p>
</div>
</div>
<p>Unban a user from the guild.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>user</span>
<span class='type'>(<tt><span class='object_link'><a href="User.html" title="Discorb::User (class)">Discorb::User</a></span></tt>)</span>
—
<div class='inline'><p>The user to unban.</p>
</div>
</li>
<li>
<span class='name'>reason</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'><p>The reason for unbanning the user.</p>
</div>
</li>
</ul>
<p class="tag_title">Raises:</p>
<ul class="raise">
<li>
<span class='type'>(<tt><span class='object_link'><a href="HTTPError.html" title="Discorb::HTTPError (class)">Discorb::HTTPError</a></span></tt>)</span>
—
<div class='inline'><p>HTTP request failed.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
660
661
662
663
664</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/discorb/guild.rb', line 660</span>
<span class='kw'>def</span> <span class='id identifier rubyid_unban_user'>unban_user</span><span class='lparen'>(</span><span class='id identifier rubyid_user'>user</span><span class='comma'>,</span> <span class='label'>reason:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
<span class='const'>Async</span> <span class='kw'>do</span>
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_http'>http</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/guilds/</span><span class='embexpr_beg'>#{</span><span class='ivar'>@id</span><span class='embexpr_end'>}</span><span class='tstring_content'>/bans/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_user'>user</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>audit_log_reason:</span> <span class='id identifier rubyid_reason'>reason</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_wait'>wait</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated from <a href="https://github.com/discorb-lib/discorb/tree/2aa9aa64ce16fc07a85e23bedc0921b16afa837f"><code>2aa9aa64ce16fc07a85e23bedc0921b16afa837f</code></a>, version (main), with YARD 0.9.26.
</div>
</div>
</body>
</html>