Dalamud/docs/api/Discord.GuildProperties.html
2020-03-24 03:22:08 +09:00

770 lines
40 KiB
HTML

<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Class GuildProperties
</title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class GuildProperties
">
<meta name="generator" content="docfx 2.48.1.0">
<link rel="shortcut icon" href="../favicon.ico">
<link rel="stylesheet" href="../styles/docfx.vendor.css">
<link rel="stylesheet" href="../styles/docfx.css">
<link rel="stylesheet" href="../styles/main.css">
<meta property="docfx:navrel" content="">
<meta property="docfx:tocrel" content="toc.html">
</head>
<body data-spy="scroll" data-target="#affix" data-offset="120">
<div id="wrapper">
<header>
<nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="../index.html">
<img id="logo" class="svg" src="../logo.svg" alt="">
</a>
</div>
<div class="collapse navbar-collapse" id="navbar">
<form class="navbar-form navbar-right" role="search" id="search">
<div class="form-group">
<input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
</div>
</form>
</div>
</div>
</nav>
<div class="subnav navbar navbar-default">
<div class="container hide-when-search" id="breadcrumb">
<ul class="breadcrumb">
<li></li>
</ul>
</div>
</div>
</header>
<div role="main" class="container body-content hide-when-search">
<div class="sidenav hide-when-search">
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
<div class="sidetoggle collapse" id="sidetoggle">
<div id="sidetoc"></div>
</div>
</div>
<div class="article row grid-right">
<div class="col-md-10">
<article class="content wrap" id="_content" data-uid="Discord.GuildProperties">
<h1 id="Discord_GuildProperties" data-uid="Discord.GuildProperties" class="text-break">Class GuildProperties
</h1>
<div class="markdown level0 summary"><p>Provides properties that are used to modify an <a class="xref" href="Discord.IGuild.html">IGuild</a> with the specified changes.</p>
</div>
<div class="markdown level0 conceptual"></div>
<div class="inheritance">
<h5>Inheritance</h5>
<div class="level0"><span class="xref">System.Object</span></div>
<div class="level1"><span class="xref">GuildProperties</span></div>
</div>
<div class="inheritedMembers">
<h5>Inherited Members</h5>
<div>
<span class="xref">System.Object.ToString()</span>
</div>
<div>
<span class="xref">System.Object.Equals(System.Object)</span>
</div>
<div>
<span class="xref">System.Object.Equals(System.Object, System.Object)</span>
</div>
<div>
<span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
</div>
<div>
<span class="xref">System.Object.GetHashCode()</span>
</div>
<div>
<span class="xref">System.Object.GetType()</span>
</div>
<div>
<span class="xref">System.Object.MemberwiseClone()</span>
</div>
</div>
<h6><strong>Namespace</strong>: <a class="xref" href="Discord.html">Discord</a></h6>
<h6><strong>Assembly</strong>: Discord.Net.Core.dll</h6>
<h5 id="Discord_GuildProperties_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class GuildProperties</code></pre>
</div>
<h3 id="properties">Properties
</h3>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goaaats/Discord.Net/new/dev/apiSpec/new?filename=Discord_GuildProperties_AfkChannel.md&amp;value=---%0Auid%3A%20Discord.GuildProperties.AfkChannel%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goaaats/Discord.Net/blob/dev/src/Discord.Net.Core/Entities/Guilds/GuildProperties.cs/#L54">View Source</a>
</span>
<a id="Discord_GuildProperties_AfkChannel_" data-uid="Discord.GuildProperties.AfkChannel*"></a>
<h4 id="Discord_GuildProperties_AfkChannel" data-uid="Discord.GuildProperties.AfkChannel">AfkChannel</h4>
<div class="markdown level1 summary"><p>Gets or sets the <a class="xref" href="Discord.IVoiceChannel.html">IVoiceChannel</a> where AFK users should be sent.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Optional&lt;IVoiceChannel&gt; AfkChannel { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Discord.Optional-1.html">Optional</a>&lt;<a class="xref" href="Discord.IVoiceChannel.html">IVoiceChannel</a>&gt;</td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goaaats/Discord.Net/new/dev/apiSpec/new?filename=Discord_GuildProperties_AfkChannelId.md&amp;value=---%0Auid%3A%20Discord.GuildProperties.AfkChannelId%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goaaats/Discord.Net/blob/dev/src/Discord.Net.Core/Entities/Guilds/GuildProperties.cs/#L58">View Source</a>
</span>
<a id="Discord_GuildProperties_AfkChannelId_" data-uid="Discord.GuildProperties.AfkChannelId*"></a>
<h4 id="Discord_GuildProperties_AfkChannelId" data-uid="Discord.GuildProperties.AfkChannelId">AfkChannelId</h4>
<div class="markdown level1 summary"><p>Gets or sets the ID of the <a class="xref" href="Discord.IVoiceChannel.html">IVoiceChannel</a> where AFK users should be sent.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Optional&lt;ulong?&gt; AfkChannelId { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Discord.Optional-1.html">Optional</a>&lt;<span class="xref">System.Nullable</span>&lt;<span class="xref">System.UInt64</span>&gt;&gt;</td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goaaats/Discord.Net/new/dev/apiSpec/new?filename=Discord_GuildProperties_AfkTimeout.md&amp;value=---%0Auid%3A%20Discord.GuildProperties.AfkTimeout%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goaaats/Discord.Net/blob/dev/src/Discord.Net.Core/Entities/Guilds/GuildProperties.cs/#L35">View Source</a>
</span>
<a id="Discord_GuildProperties_AfkTimeout_" data-uid="Discord.GuildProperties.AfkTimeout*"></a>
<h4 id="Discord_GuildProperties_AfkTimeout" data-uid="Discord.GuildProperties.AfkTimeout">AfkTimeout</h4>
<div class="markdown level1 summary"><p>Gets or sets how many seconds before a user is sent to AFK. This value MUST be one of: (60, 300, 900,
1800, 3600).</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Optional&lt;int&gt; AfkTimeout { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Discord.Optional-1.html">Optional</a>&lt;<span class="xref">System.Int32</span>&gt;</td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goaaats/Discord.Net/new/dev/apiSpec/new?filename=Discord_GuildProperties_Banner.md&amp;value=---%0Auid%3A%20Discord.GuildProperties.Banner%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goaaats/Discord.Net/blob/dev/src/Discord.Net.Core/Entities/Guilds/GuildProperties.cs/#L43">View Source</a>
</span>
<a id="Discord_GuildProperties_Banner_" data-uid="Discord.GuildProperties.Banner*"></a>
<h4 id="Discord_GuildProperties_Banner" data-uid="Discord.GuildProperties.Banner">Banner</h4>
<div class="markdown level1 summary"><p>Gets or sets the banner of the guild.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Optional&lt;Image?&gt; Banner { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Discord.Optional-1.html">Optional</a>&lt;<span class="xref">System.Nullable</span>&lt;<a class="xref" href="Discord.Image.html">Image</a>&gt;&gt;</td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goaaats/Discord.Net/new/dev/apiSpec/new?filename=Discord_GuildProperties_DefaultMessageNotifications.md&amp;value=---%0Auid%3A%20Discord.GuildProperties.DefaultMessageNotifications%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goaaats/Discord.Net/blob/dev/src/Discord.Net.Core/Entities/Guilds/GuildProperties.cs/#L30">View Source</a>
</span>
<a id="Discord_GuildProperties_DefaultMessageNotifications_" data-uid="Discord.GuildProperties.DefaultMessageNotifications*"></a>
<h4 id="Discord_GuildProperties_DefaultMessageNotifications" data-uid="Discord.GuildProperties.DefaultMessageNotifications">DefaultMessageNotifications</h4>
<div class="markdown level1 summary"><p>Gets or sets the default message notification state for the guild.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Optional&lt;DefaultMessageNotifications&gt; DefaultMessageNotifications { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Discord.Optional-1.html">Optional</a>&lt;<a class="xref" href="Discord.DefaultMessageNotifications.html">DefaultMessageNotifications</a>&gt;</td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goaaats/Discord.Net/new/dev/apiSpec/new?filename=Discord_GuildProperties_ExplicitContentFilter.md&amp;value=---%0Auid%3A%20Discord.GuildProperties.ExplicitContentFilter%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goaaats/Discord.Net/blob/dev/src/Discord.Net.Core/Entities/Guilds/GuildProperties.cs/#L78">View Source</a>
</span>
<a id="Discord_GuildProperties_ExplicitContentFilter_" data-uid="Discord.GuildProperties.ExplicitContentFilter*"></a>
<h4 id="Discord_GuildProperties_ExplicitContentFilter" data-uid="Discord.GuildProperties.ExplicitContentFilter">ExplicitContentFilter</h4>
<div class="markdown level1 summary"><p>Gets or sets the explicit content filter level of this guild.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Optional&lt;ExplicitContentFilterLevel&gt; ExplicitContentFilter { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Discord.Optional-1.html">Optional</a>&lt;<a class="xref" href="Discord.ExplicitContentFilterLevel.html">ExplicitContentFilterLevel</a>&gt;</td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goaaats/Discord.Net/new/dev/apiSpec/new?filename=Discord_GuildProperties_Icon.md&amp;value=---%0Auid%3A%20Discord.GuildProperties.Icon%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goaaats/Discord.Net/blob/dev/src/Discord.Net.Core/Entities/Guilds/GuildProperties.cs/#L39">View Source</a>
</span>
<a id="Discord_GuildProperties_Icon_" data-uid="Discord.GuildProperties.Icon*"></a>
<h4 id="Discord_GuildProperties_Icon" data-uid="Discord.GuildProperties.Icon">Icon</h4>
<div class="markdown level1 summary"><p>Gets or sets the icon of the guild.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Optional&lt;Image?&gt; Icon { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Discord.Optional-1.html">Optional</a>&lt;<span class="xref">System.Nullable</span>&lt;<a class="xref" href="Discord.Image.html">Image</a>&gt;&gt;</td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goaaats/Discord.Net/new/dev/apiSpec/new?filename=Discord_GuildProperties_Name.md&amp;value=---%0Auid%3A%20Discord.GuildProperties.Name%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goaaats/Discord.Net/blob/dev/src/Discord.Net.Core/Entities/Guilds/GuildProperties.cs/#L14">View Source</a>
</span>
<a id="Discord_GuildProperties_Name_" data-uid="Discord.GuildProperties.Name*"></a>
<h4 id="Discord_GuildProperties_Name" data-uid="Discord.GuildProperties.Name">Name</h4>
<div class="markdown level1 summary"><p>Gets or sets the name of the guild. Must be within 100 characters.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Optional&lt;string&gt; Name { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Discord.Optional-1.html">Optional</a>&lt;<span class="xref">System.String</span>&gt;</td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goaaats/Discord.Net/new/dev/apiSpec/new?filename=Discord_GuildProperties_Owner.md&amp;value=---%0Auid%3A%20Discord.GuildProperties.Owner%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goaaats/Discord.Net/blob/dev/src/Discord.Net.Core/Entities/Guilds/GuildProperties.cs/#L70">View Source</a>
</span>
<a id="Discord_GuildProperties_Owner_" data-uid="Discord.GuildProperties.Owner*"></a>
<h4 id="Discord_GuildProperties_Owner" data-uid="Discord.GuildProperties.Owner">Owner</h4>
<div class="markdown level1 summary"><p>Gets or sets the owner of this guild.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Optional&lt;IUser&gt; Owner { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Discord.Optional-1.html">Optional</a>&lt;<a class="xref" href="Discord.IUser.html">IUser</a>&gt;</td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goaaats/Discord.Net/new/dev/apiSpec/new?filename=Discord_GuildProperties_OwnerId.md&amp;value=---%0Auid%3A%20Discord.GuildProperties.OwnerId%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goaaats/Discord.Net/blob/dev/src/Discord.Net.Core/Entities/Guilds/GuildProperties.cs/#L74">View Source</a>
</span>
<a id="Discord_GuildProperties_OwnerId_" data-uid="Discord.GuildProperties.OwnerId*"></a>
<h4 id="Discord_GuildProperties_OwnerId" data-uid="Discord.GuildProperties.OwnerId">OwnerId</h4>
<div class="markdown level1 summary"><p>Gets or sets the ID of the owner of this guild.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Optional&lt;ulong&gt; OwnerId { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Discord.Optional-1.html">Optional</a>&lt;<span class="xref">System.UInt64</span>&gt;</td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goaaats/Discord.Net/new/dev/apiSpec/new?filename=Discord_GuildProperties_PreferredCulture.md&amp;value=---%0Auid%3A%20Discord.GuildProperties.PreferredCulture%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goaaats/Discord.Net/blob/dev/src/Discord.Net.Core/Entities/Guilds/GuildProperties.cs/#L110">View Source</a>
</span>
<a id="Discord_GuildProperties_PreferredCulture_" data-uid="Discord.GuildProperties.PreferredCulture*"></a>
<h4 id="Discord_GuildProperties_PreferredCulture" data-uid="Discord.GuildProperties.PreferredCulture">PreferredCulture</h4>
<div class="markdown level1 summary"><p>Gets or sets the preferred locale of the guild.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Optional&lt;CultureInfo&gt; PreferredCulture { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Discord.Optional-1.html">Optional</a>&lt;<span class="xref">System.Globalization.CultureInfo</span>&gt;</td>
<td></td>
</tr>
</tbody>
</table>
<h5 id="Discord_GuildProperties_PreferredCulture_remarks">Remarks</h5>
<div class="markdown level1 remarks"><p>The <a class="xref" href="Discord.GuildProperties.html#Discord_GuildProperties_PreferredLocale">PreferredLocale</a> property takes precedence
over this property. When <a class="xref" href="Discord.GuildProperties.html#Discord_GuildProperties_PreferredLocale">PreferredLocale</a> is set,
the value of <a class="xref" href="Discord.GuildProperties.html#Discord_GuildProperties_PreferredCulture">PreferredCulture</a> will be unused.</p>
</div>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goaaats/Discord.Net/new/dev/apiSpec/new?filename=Discord_GuildProperties_PreferredLocale.md&amp;value=---%0Auid%3A%20Discord.GuildProperties.PreferredLocale%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goaaats/Discord.Net/blob/dev/src/Discord.Net.Core/Entities/Guilds/GuildProperties.cs/#L101">View Source</a>
</span>
<a id="Discord_GuildProperties_PreferredLocale_" data-uid="Discord.GuildProperties.PreferredLocale*"></a>
<h4 id="Discord_GuildProperties_PreferredLocale" data-uid="Discord.GuildProperties.PreferredLocale">PreferredLocale</h4>
<div class="markdown level1 summary"><p>Gets or sets the preferred locale of the guild in IETF BCP 47 language tag format.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Optional&lt;string&gt; PreferredLocale { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Discord.Optional-1.html">Optional</a>&lt;<span class="xref">System.String</span>&gt;</td>
<td></td>
</tr>
</tbody>
</table>
<h5 id="Discord_GuildProperties_PreferredLocale_remarks">Remarks</h5>
<div class="markdown level1 remarks"><p>This property takes precedence over <a class="xref" href="Discord.GuildProperties.html#Discord_GuildProperties_PreferredCulture">PreferredCulture</a>.
When it is set, the value of <a class="xref" href="Discord.GuildProperties.html#Discord_GuildProperties_PreferredCulture">PreferredCulture</a>
will not be used.</p>
</div>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goaaats/Discord.Net/new/dev/apiSpec/new?filename=Discord_GuildProperties_Region.md&amp;value=---%0Auid%3A%20Discord.GuildProperties.Region%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goaaats/Discord.Net/blob/dev/src/Discord.Net.Core/Entities/Guilds/GuildProperties.cs/#L18">View Source</a>
</span>
<a id="Discord_GuildProperties_Region_" data-uid="Discord.GuildProperties.Region*"></a>
<h4 id="Discord_GuildProperties_Region" data-uid="Discord.GuildProperties.Region">Region</h4>
<div class="markdown level1 summary"><p>Gets or sets the region for the guild's voice connections.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Optional&lt;IVoiceRegion&gt; Region { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Discord.Optional-1.html">Optional</a>&lt;<a class="xref" href="Discord.IVoiceRegion.html">IVoiceRegion</a>&gt;</td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goaaats/Discord.Net/new/dev/apiSpec/new?filename=Discord_GuildProperties_RegionId.md&amp;value=---%0Auid%3A%20Discord.GuildProperties.RegionId%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goaaats/Discord.Net/blob/dev/src/Discord.Net.Core/Entities/Guilds/GuildProperties.cs/#L22">View Source</a>
</span>
<a id="Discord_GuildProperties_RegionId_" data-uid="Discord.GuildProperties.RegionId*"></a>
<h4 id="Discord_GuildProperties_RegionId" data-uid="Discord.GuildProperties.RegionId">RegionId</h4>
<div class="markdown level1 summary"><p>Gets or sets the ID of the region for the guild's voice connections.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Optional&lt;string&gt; RegionId { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Discord.Optional-1.html">Optional</a>&lt;<span class="xref">System.String</span>&gt;</td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goaaats/Discord.Net/new/dev/apiSpec/new?filename=Discord_GuildProperties_Splash.md&amp;value=---%0Auid%3A%20Discord.GuildProperties.Splash%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goaaats/Discord.Net/blob/dev/src/Discord.Net.Core/Entities/Guilds/GuildProperties.cs/#L50">View Source</a>
</span>
<a id="Discord_GuildProperties_Splash_" data-uid="Discord.GuildProperties.Splash*"></a>
<h4 id="Discord_GuildProperties_Splash" data-uid="Discord.GuildProperties.Splash">Splash</h4>
<div class="markdown level1 summary"><p>Gets or sets the guild's splash image.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Optional&lt;Image?&gt; Splash { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Discord.Optional-1.html">Optional</a>&lt;<span class="xref">System.Nullable</span>&lt;<a class="xref" href="Discord.Image.html">Image</a>&gt;&gt;</td>
<td></td>
</tr>
</tbody>
</table>
<h5 id="Discord_GuildProperties_Splash_remarks">Remarks</h5>
<div class="markdown level1 remarks"><p>The guild must be partnered for this value to have any effect.</p>
</div>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goaaats/Discord.Net/new/dev/apiSpec/new?filename=Discord_GuildProperties_SystemChannel.md&amp;value=---%0Auid%3A%20Discord.GuildProperties.SystemChannel%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goaaats/Discord.Net/blob/dev/src/Discord.Net.Core/Entities/Guilds/GuildProperties.cs/#L62">View Source</a>
</span>
<a id="Discord_GuildProperties_SystemChannel_" data-uid="Discord.GuildProperties.SystemChannel*"></a>
<h4 id="Discord_GuildProperties_SystemChannel" data-uid="Discord.GuildProperties.SystemChannel">SystemChannel</h4>
<div class="markdown level1 summary"><p>Gets or sets the <a class="xref" href="Discord.ITextChannel.html">ITextChannel</a> where system messages should be sent.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Optional&lt;ITextChannel&gt; SystemChannel { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Discord.Optional-1.html">Optional</a>&lt;<a class="xref" href="Discord.ITextChannel.html">ITextChannel</a>&gt;</td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goaaats/Discord.Net/new/dev/apiSpec/new?filename=Discord_GuildProperties_SystemChannelFlags.md&amp;value=---%0Auid%3A%20Discord.GuildProperties.SystemChannelFlags%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goaaats/Discord.Net/blob/dev/src/Discord.Net.Core/Entities/Guilds/GuildProperties.cs/#L92">View Source</a>
</span>
<a id="Discord_GuildProperties_SystemChannelFlags_" data-uid="Discord.GuildProperties.SystemChannelFlags*"></a>
<h4 id="Discord_GuildProperties_SystemChannelFlags" data-uid="Discord.GuildProperties.SystemChannelFlags">SystemChannelFlags</h4>
<div class="markdown level1 summary"><p>Gets or sets the flags that DISABLE types of system channel messages.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Optional&lt;SystemChannelMessageDeny&gt; SystemChannelFlags { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Discord.Optional-1.html">Optional</a>&lt;<a class="xref" href="Discord.SystemChannelMessageDeny.html">SystemChannelMessageDeny</a>&gt;</td>
<td></td>
</tr>
</tbody>
</table>
<h5 id="Discord_GuildProperties_SystemChannelFlags_remarks">Remarks</h5>
<div class="markdown level1 remarks"><p>These flags are inverted. Setting a flag will disable that system channel message from being sent.
A value of <a class="xref" href="Discord.SystemChannelMessageDeny.html#Discord_SystemChannelMessageDeny_None">None</a> will allow all system channel message types to be sent,
given that the <a class="xref" href="Discord.GuildProperties.html#Discord_GuildProperties_SystemChannelId">SystemChannelId</a> has also been set.
A value of <a class="xref" href="Discord.SystemChannelMessageDeny.html#Discord_SystemChannelMessageDeny_GuildBoost">GuildBoost</a> will deny guild boost messages from being sent, and allow all
other types of messages.
Refer to the extension methods <a class="xref" href="Discord.GuildExtensions.html#Discord_GuildExtensions_GetGuildBoostMessagesEnabled_Discord_IGuild_">GetGuildBoostMessagesEnabled(IGuild)</a> and
<a class="xref" href="Discord.GuildExtensions.html#Discord_GuildExtensions_GetWelcomeMessagesEnabled_Discord_IGuild_">GetWelcomeMessagesEnabled(IGuild)</a> to check if these system channel message types
are enabled, without the need to manipulate the logic of the flag.</p>
</div>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goaaats/Discord.Net/new/dev/apiSpec/new?filename=Discord_GuildProperties_SystemChannelId.md&amp;value=---%0Auid%3A%20Discord.GuildProperties.SystemChannelId%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goaaats/Discord.Net/blob/dev/src/Discord.Net.Core/Entities/Guilds/GuildProperties.cs/#L66">View Source</a>
</span>
<a id="Discord_GuildProperties_SystemChannelId_" data-uid="Discord.GuildProperties.SystemChannelId*"></a>
<h4 id="Discord_GuildProperties_SystemChannelId" data-uid="Discord.GuildProperties.SystemChannelId">SystemChannelId</h4>
<div class="markdown level1 summary"><p>Gets or sets the ID of the <a class="xref" href="Discord.ITextChannel.html">ITextChannel</a> where system messages should be sent.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Optional&lt;ulong?&gt; SystemChannelId { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Discord.Optional-1.html">Optional</a>&lt;<span class="xref">System.Nullable</span>&lt;<span class="xref">System.UInt64</span>&gt;&gt;</td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goaaats/Discord.Net/new/dev/apiSpec/new?filename=Discord_GuildProperties_VerificationLevel.md&amp;value=---%0Auid%3A%20Discord.GuildProperties.VerificationLevel%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/goaaats/Discord.Net/blob/dev/src/Discord.Net.Core/Entities/Guilds/GuildProperties.cs/#L26">View Source</a>
</span>
<a id="Discord_GuildProperties_VerificationLevel_" data-uid="Discord.GuildProperties.VerificationLevel*"></a>
<h4 id="Discord_GuildProperties_VerificationLevel" data-uid="Discord.GuildProperties.VerificationLevel">VerificationLevel</h4>
<div class="markdown level1 summary"><p>Gets or sets the verification level new users need to achieve before speaking.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Optional&lt;VerificationLevel&gt; VerificationLevel { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Discord.Optional-1.html">Optional</a>&lt;<a class="xref" href="Discord.VerificationLevel.html">VerificationLevel</a>&gt;</td>
<td></td>
</tr>
</tbody>
</table>
</article>
</div>
<div class="hidden-sm col-md-2" role="complementary">
<div class="sideaffix">
<div class="contribution">
<ul class="nav">
<li>
<a href="https://github.com/goaaats/Discord.Net/new/dev/apiSpec/new?filename=Discord_GuildProperties.md&amp;value=---%0Auid%3A%20Discord.GuildProperties%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" class="contribution-link">Improve this Doc</a>
</li>
<li>
<a href="https://github.com/goaaats/Discord.Net/blob/dev/src/Discord.Net.Core/Entities/Guilds/GuildProperties.cs/#L9" class="contribution-link">View Source</a>
</li>
</ul>
</div>
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
</nav>
</div>
</div>
</div>
</div>
<footer>
<div class="grad-bottom"></div>
<div class="footer">
<div class="container">
<span class="pull-right">
<a href="#top">Back to top</a>
</span>
<span>Generated by <strong>DocFX</strong></span>
</div>
</div>
</footer>
</div>
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
<script type="text/javascript" src="../styles/docfx.js"></script>
<script type="text/javascript" src="../styles/main.js"></script>
</body>
</html>