ToxicMushroom/Dalamud
1
0
Fork 0
mirror of https://github.com/goatcorp/Dalamud.git synced 2025-12-12 18:27:23 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 3
Dalamud/docs/api/Discord.RoleProperties.html
goat 2584122e4e regenerate docs
2020-03-11 21:54:11 +09:00

372 lines
18 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Class RoleProperties
</title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class RoleProperties
">
<meta name="generator" content="docfx 2.50.0.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.RoleProperties">
<h1 id="Discord_RoleProperties" data-uid="Discord.RoleProperties" class="text-break">Class RoleProperties
</h1>
<div class="markdown level0 summary"><p>Properties that are used to modify an <a class="xref" href="Discord.IRole.html">IRole</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">RoleProperties</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_RoleProperties_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class RoleProperties</code></pre>
</div>
<h5 id="Discord_RoleProperties_examples"><strong>Examples</strong></h5>
<p>The following example modifies the role to a mentionable one, renames the role into <code>Sonic</code>, and
changes the color to a light-blue.</p>
<pre><code class="lang-cs">await role.ModifyAsync(x =>
{
x.Name = &quot;Sonic&quot;;
x.Color = new Color(0x1A50BC);
x.Mentionable = true;
});</code></pre>
<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/819a325cec923e4a817ab2f08be5c7bbe0d775d0/apiSpec/new?filename=Discord_RoleProperties_Color.md&amp;value=---%0Auid%3A%20Discord.RoleProperties.Color%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/819a325cec923e4a817ab2f08be5c7bbe0d775d0/src/Discord.Net.Core/Entities/Roles/RoleProperties.cs/#L45">View Source</a>
</span>
<a id="Discord_RoleProperties_Color_" data-uid="Discord.RoleProperties.Color*"></a>
<h4 id="Discord_RoleProperties_Color" data-uid="Discord.RoleProperties.Color">Color</h4>
<div class="markdown level1 summary"><p>Gets or sets the color of the role.</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;Color&gt; Color { 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.Color.html">Color</a>&gt;</td>
<td></td>
</tr>
</tbody>
</table>
<h5 id="Discord_RoleProperties_Color_remarks">Remarks</h5>
<div class="markdown level1 remarks"><p>This value may not be set if the role is an @everyone role.</p>
</div>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goaaats/Discord.Net/new/819a325cec923e4a817ab2f08be5c7bbe0d775d0/apiSpec/new?filename=Discord_RoleProperties_Hoist.md&amp;value=---%0Auid%3A%20Discord.RoleProperties.Hoist%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/819a325cec923e4a817ab2f08be5c7bbe0d775d0/src/Discord.Net.Core/Entities/Roles/RoleProperties.cs/#L52">View Source</a>
</span>
<a id="Discord_RoleProperties_Hoist_" data-uid="Discord.RoleProperties.Hoist*"></a>
<h4 id="Discord_RoleProperties_Hoist" data-uid="Discord.RoleProperties.Hoist">Hoist</h4>
<div class="markdown level1 summary"><p>Gets or sets whether or not this role should be displayed independently in the user list.</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;bool&gt; Hoist { 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.Boolean</span>&gt;</td>
<td></td>
</tr>
</tbody>
</table>
<h5 id="Discord_RoleProperties_Hoist_remarks">Remarks</h5>
<div class="markdown level1 remarks"><p>This value may not be set if the role is an @everyone role.</p>
</div>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goaaats/Discord.Net/new/819a325cec923e4a817ab2f08be5c7bbe0d775d0/apiSpec/new?filename=Discord_RoleProperties_Mentionable.md&amp;value=---%0Auid%3A%20Discord.RoleProperties.Mentionable%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/819a325cec923e4a817ab2f08be5c7bbe0d775d0/src/Discord.Net.Core/Entities/Roles/RoleProperties.cs/#L59">View Source</a>
</span>
<a id="Discord_RoleProperties_Mentionable_" data-uid="Discord.RoleProperties.Mentionable*"></a>
<h4 id="Discord_RoleProperties_Mentionable" data-uid="Discord.RoleProperties.Mentionable">Mentionable</h4>
<div class="markdown level1 summary"><p>Gets or sets whether or not this role can be mentioned.</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;bool&gt; Mentionable { 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.Boolean</span>&gt;</td>
<td></td>
</tr>
</tbody>
</table>
<h5 id="Discord_RoleProperties_Mentionable_remarks">Remarks</h5>
<div class="markdown level1 remarks"><p>This value may not be set if the role is an @everyone role.</p>
</div>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goaaats/Discord.Net/new/819a325cec923e4a817ab2f08be5c7bbe0d775d0/apiSpec/new?filename=Discord_RoleProperties_Name.md&amp;value=---%0Auid%3A%20Discord.RoleProperties.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/819a325cec923e4a817ab2f08be5c7bbe0d775d0/src/Discord.Net.Core/Entities/Roles/RoleProperties.cs/#L27">View Source</a>
</span>
<a id="Discord_RoleProperties_Name_" data-uid="Discord.RoleProperties.Name*"></a>
<h4 id="Discord_RoleProperties_Name" data-uid="Discord.RoleProperties.Name">Name</h4>
<div class="markdown level1 summary"><p>Gets or sets the name of the role.</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>
<h5 id="Discord_RoleProperties_Name_remarks">Remarks</h5>
<div class="markdown level1 remarks"><p>This value may not be set if the role is an @everyone role.</p>
</div>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goaaats/Discord.Net/new/819a325cec923e4a817ab2f08be5c7bbe0d775d0/apiSpec/new?filename=Discord_RoleProperties_Permissions.md&amp;value=---%0Auid%3A%20Discord.RoleProperties.Permissions%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/819a325cec923e4a817ab2f08be5c7bbe0d775d0/src/Discord.Net.Core/Entities/Roles/RoleProperties.cs/#L31">View Source</a>
</span>
<a id="Discord_RoleProperties_Permissions_" data-uid="Discord.RoleProperties.Permissions*"></a>
<h4 id="Discord_RoleProperties_Permissions" data-uid="Discord.RoleProperties.Permissions">Permissions</h4>
<div class="markdown level1 summary"><p>Gets or sets the role's <a class="xref" href="Discord.GuildPermission.html">GuildPermission</a>.</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;GuildPermissions&gt; Permissions { 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.GuildPermissions.html">GuildPermissions</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/819a325cec923e4a817ab2f08be5c7bbe0d775d0/apiSpec/new?filename=Discord_RoleProperties_Position.md&amp;value=---%0Auid%3A%20Discord.RoleProperties.Position%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/819a325cec923e4a817ab2f08be5c7bbe0d775d0/src/Discord.Net.Core/Entities/Roles/RoleProperties.cs/#L38">View Source</a>
</span>
<a id="Discord_RoleProperties_Position_" data-uid="Discord.RoleProperties.Position*"></a>
<h4 id="Discord_RoleProperties_Position" data-uid="Discord.RoleProperties.Position">Position</h4>
<div class="markdown level1 summary"><p>Gets or sets the position of the role. This is 0-based!</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; Position { 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>
<h5 id="Discord_RoleProperties_Position_remarks">Remarks</h5>
<div class="markdown level1 remarks"><p>This value may not be set if the role is an @everyone role.</p>
</div>
<h3 id="seealso">See Also</h3>
<div class="seealso">
<div><a class="xref" href="Discord.IRole.html#Discord_IRole_ModifyAsync_System_Action_Discord_RoleProperties__Discord_RequestOptions_">ModifyAsync</a>(<span class="xref">System.Action</span>&lt;<a class="xref" href="Discord.RoleProperties.html">RoleProperties</a>&gt;, <a class="xref" href="Discord.RequestOptions.html">RequestOptions</a>)</div>
</div>
</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/819a325cec923e4a817ab2f08be5c7bbe0d775d0/apiSpec/new?filename=Discord_RoleProperties.md&amp;value=---%0Auid%3A%20Discord.RoleProperties%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/819a325cec923e4a817ab2f08be5c7bbe0d775d0/src/Discord.Net.Core/Entities/Roles/RoleProperties.cs/#L19" 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>
Reference in a new issue View git blame Copy permalink