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.WebSocket.SocketGuildUser.html
goat 2584122e4e regenerate docs
2020-03-11 21:54:11 +09:00

1472 lines
78 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 SocketGuildUser
</title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class SocketGuildUser
">
<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.WebSocket.SocketGuildUser">
<h1 id="Discord_WebSocket_SocketGuildUser" data-uid="Discord.WebSocket.SocketGuildUser" class="text-break">Class SocketGuildUser
</h1>
<div class="markdown level0 summary"><p>Represents a WebSocket-based guild user.</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"><a class="xref" href="Discord.WebSocket.SocketEntity-1.html">SocketEntity</a>&lt;<span class="xref">System.UInt64</span>&gt;</div>
<div class="level2"><a class="xref" href="Discord.WebSocket.SocketUser.html">SocketUser</a></div>
<div class="level3"><span class="xref">SocketGuildUser</span></div>
</div>
<div classs="implements">
<h5>Implements</h5>
<div><a class="xref" href="Discord.IGuildUser.html">IGuildUser</a></div>
<div><a class="xref" href="Discord.IUser.html">IUser</a></div>
<div><a class="xref" href="Discord.ISnowflakeEntity.html">ISnowflakeEntity</a></div>
<div><a class="xref" href="Discord.IEntity-1.html">IEntity</a>&lt;<span class="xref">System.UInt64</span>&gt;</div>
<div><a class="xref" href="Discord.IMentionable.html">IMentionable</a></div>
<div><a class="xref" href="Discord.IPresence.html">IPresence</a></div>
<div><a class="xref" href="Discord.IVoiceState.html">IVoiceState</a></div>
</div>
<div class="inheritedMembers">
<h5>Inherited Members</h5>
<div>
<a class="xref" href="Discord.WebSocket.SocketUser.html#Discord_WebSocket_SocketUser_CreatedAt">SocketUser.CreatedAt</a>
</div>
<div>
<a class="xref" href="Discord.WebSocket.SocketUser.html#Discord_WebSocket_SocketUser_Discriminator">SocketUser.Discriminator</a>
</div>
<div>
<a class="xref" href="Discord.WebSocket.SocketUser.html#Discord_WebSocket_SocketUser_Mention">SocketUser.Mention</a>
</div>
<div>
<a class="xref" href="Discord.WebSocket.SocketUser.html#Discord_WebSocket_SocketUser_Activity">SocketUser.Activity</a>
</div>
<div>
<a class="xref" href="Discord.WebSocket.SocketUser.html#Discord_WebSocket_SocketUser_Status">SocketUser.Status</a>
</div>
<div>
<a class="xref" href="Discord.WebSocket.SocketUser.html#Discord_WebSocket_SocketUser_ActiveClients">SocketUser.ActiveClients</a>
</div>
<div>
<a class="xref" href="Discord.WebSocket.SocketUser.html#Discord_WebSocket_SocketUser_MutualGuilds">SocketUser.MutualGuilds</a>
</div>
<div>
<a class="xref" href="Discord.WebSocket.SocketUser.html#Discord_WebSocket_SocketUser_GetOrCreateDMChannelAsync_Discord_RequestOptions_">SocketUser.GetOrCreateDMChannelAsync(RequestOptions)</a>
</div>
<div>
<a class="xref" href="Discord.WebSocket.SocketUser.html#Discord_WebSocket_SocketUser_GetAvatarUrl_Discord_ImageFormat_System_UInt16_">SocketUser.GetAvatarUrl(ImageFormat, UInt16)</a>
</div>
<div>
<a class="xref" href="Discord.WebSocket.SocketUser.html#Discord_WebSocket_SocketUser_GetDefaultAvatarUrl">SocketUser.GetDefaultAvatarUrl()</a>
</div>
<div>
<a class="xref" href="Discord.WebSocket.SocketUser.html#Discord_WebSocket_SocketUser_ToString">SocketUser.ToString()</a>
</div>
<div>
<a class="xref" href="Discord.WebSocket.SocketEntity-1.html#Discord_WebSocket_SocketEntity_1_Id">SocketEntity&lt;UInt64&gt;.Id</a>
</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.WebSocket.html">Discord.WebSocket</a></h6>
<h6><strong>Assembly</strong>: Discord.Net.WebSocket.dll</h6>
<h5 id="Discord_WebSocket_SocketGuildUser_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class SocketGuildUser : SocketUser, IGuildUser, IUser, ISnowflakeEntity, IEntity&lt;ulong&gt;, IMentionable, IPresence, IVoiceState</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/819a325cec923e4a817ab2f08be5c7bbe0d775d0/apiSpec/new?filename=Discord_WebSocket_SocketGuildUser_AudioStream.md&amp;value=---%0Auid%3A%20Discord.WebSocket.SocketGuildUser.AudioStream%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.WebSocket/Entities/Users/SocketGuildUser.cs/#L80">View Source</a>
</span>
<a id="Discord_WebSocket_SocketGuildUser_AudioStream_" data-uid="Discord.WebSocket.SocketGuildUser.AudioStream*"></a>
<h4 id="Discord_WebSocket_SocketGuildUser_AudioStream" data-uid="Discord.WebSocket.SocketGuildUser.AudioStream">AudioStream</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public AudioInStream AudioStream { get; }</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.Audio.AudioInStream.html">AudioInStream</a></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_WebSocket_SocketGuildUser_AvatarId.md&amp;value=---%0Auid%3A%20Discord.WebSocket.SocketGuildUser.AvatarId%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.WebSocket/Entities/Users/SocketGuildUser.cs/#L40">View Source</a>
</span>
<a id="Discord_WebSocket_SocketGuildUser_AvatarId_" data-uid="Discord.WebSocket.SocketGuildUser.AvatarId*"></a>
<h4 id="Discord_WebSocket_SocketGuildUser_AvatarId" data-uid="Discord.WebSocket.SocketGuildUser.AvatarId">AvatarId</h4>
<div class="markdown level1 summary"><p>Gets the identifier of this user's avatar.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public override string AvatarId { get; }</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><span class="xref">System.String</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><a class="xref" href="Discord.WebSocket.SocketUser.html#Discord_WebSocket_SocketUser_AvatarId">SocketUser.AvatarId</a></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_WebSocket_SocketGuildUser_DiscriminatorValue.md&amp;value=---%0Auid%3A%20Discord.WebSocket.SocketGuildUser.DiscriminatorValue%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.WebSocket/Entities/Users/SocketGuildUser.cs/#L38">View Source</a>
</span>
<a id="Discord_WebSocket_SocketGuildUser_DiscriminatorValue_" data-uid="Discord.WebSocket.SocketGuildUser.DiscriminatorValue*"></a>
<h4 id="Discord_WebSocket_SocketGuildUser_DiscriminatorValue" data-uid="Discord.WebSocket.SocketGuildUser.DiscriminatorValue">DiscriminatorValue</h4>
<div class="markdown level1 summary"><p>Gets the per-username unique ID for this user.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public override ushort DiscriminatorValue { get; }</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><span class="xref">System.UInt16</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><a class="xref" href="Discord.WebSocket.SocketUser.html#Discord_WebSocket_SocketUser_DiscriminatorValue">SocketUser.DiscriminatorValue</a></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_WebSocket_SocketGuildUser_Guild.md&amp;value=---%0Auid%3A%20Discord.WebSocket.SocketGuildUser.Guild%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.WebSocket/Entities/Users/SocketGuildUser.cs/#L29">View Source</a>
</span>
<a id="Discord_WebSocket_SocketGuildUser_Guild_" data-uid="Discord.WebSocket.SocketGuildUser.Guild*"></a>
<h4 id="Discord_WebSocket_SocketGuildUser_Guild" data-uid="Discord.WebSocket.SocketGuildUser.Guild">Guild</h4>
<div class="markdown level1 summary"><p>Gets the guild the user is in.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public SocketGuild Guild { get; }</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.WebSocket.SocketGuild.html">SocketGuild</a></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_WebSocket_SocketGuildUser_GuildPermissions.md&amp;value=---%0Auid%3A%20Discord.WebSocket.SocketGuildUser.GuildPermissions%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.WebSocket/Entities/Users/SocketGuildUser.cs/#L42">View Source</a>
</span>
<a id="Discord_WebSocket_SocketGuildUser_GuildPermissions_" data-uid="Discord.WebSocket.SocketGuildUser.GuildPermissions*"></a>
<h4 id="Discord_WebSocket_SocketGuildUser_GuildPermissions" data-uid="Discord.WebSocket.SocketGuildUser.GuildPermissions">GuildPermissions</h4>
<div class="markdown level1 summary"><p>Gets the guild-level permissions for this user.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public GuildPermissions GuildPermissions { get; }</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.GuildPermissions.html">GuildPermissions</a></td>
<td><p>A <a class="xref" href="Discord.GuildPermissions.html">GuildPermissions</a> structure for this user, representing what
permissions this user has in the guild.</p>
</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_WebSocket_SocketGuildUser_Hierarchy.md&amp;value=---%0Auid%3A%20Discord.WebSocket.SocketGuildUser.Hierarchy%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.WebSocket/Entities/Users/SocketGuildUser.cs/#L91">View Source</a>
</span>
<a id="Discord_WebSocket_SocketGuildUser_Hierarchy_" data-uid="Discord.WebSocket.SocketGuildUser.Hierarchy*"></a>
<h4 id="Discord_WebSocket_SocketGuildUser_Hierarchy" data-uid="Discord.WebSocket.SocketGuildUser.Hierarchy">Hierarchy</h4>
<div class="markdown level1 summary"><p>Returns the position of the user within the role hierarchy.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public int Hierarchy { get; }</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><span class="xref">System.Int32</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 id="Discord_WebSocket_SocketGuildUser_Hierarchy_remarks">Remarks</h5>
<div class="markdown level1 remarks"><p>The returned value equal to the position of the highest role the user has, or
<span class="xref">System.Int32.MaxValue</span> if user is the server owner.</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_WebSocket_SocketGuildUser_IsBot.md&amp;value=---%0Auid%3A%20Discord.WebSocket.SocketGuildUser.IsBot%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.WebSocket/Entities/Users/SocketGuildUser.cs/#L34">View Source</a>
</span>
<a id="Discord_WebSocket_SocketGuildUser_IsBot_" data-uid="Discord.WebSocket.SocketGuildUser.IsBot*"></a>
<h4 id="Discord_WebSocket_SocketGuildUser_IsBot" data-uid="Discord.WebSocket.SocketGuildUser.IsBot">IsBot</h4>
<div class="markdown level1 summary"><p>Gets a value that indicates whether this user is identified as a bot.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public override bool IsBot { get; }</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><span class="xref">System.Boolean</span></td>
<td><p><code>true</code> if the user is a bot application; otherwise <code>false</code>.</p>
</td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><a class="xref" href="Discord.WebSocket.SocketUser.html#Discord_WebSocket_SocketUser_IsBot">SocketUser.IsBot</a></div>
<h5 id="Discord_WebSocket_SocketGuildUser_IsBot_remarks">Remarks</h5>
<div class="markdown level1 remarks"><p>This property retrieves a value that indicates whether this user is a registered bot application
(indicated by the blue BOT tag within the official chat client).</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_WebSocket_SocketGuildUser_IsDeafened.md&amp;value=---%0Auid%3A%20Discord.WebSocket.SocketGuildUser.IsDeafened%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.WebSocket/Entities/Users/SocketGuildUser.cs/#L54">View Source</a>
</span>
<a id="Discord_WebSocket_SocketGuildUser_IsDeafened_" data-uid="Discord.WebSocket.SocketGuildUser.IsDeafened*"></a>
<h4 id="Discord_WebSocket_SocketGuildUser_IsDeafened" data-uid="Discord.WebSocket.SocketGuildUser.IsDeafened">IsDeafened</h4>
<div class="markdown level1 summary"><p>Gets a value that indicates whether this user is deafened by 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 bool IsDeafened { get; }</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><span class="xref">System.Boolean</span></td>
<td><p><code>true</code> if the user is deafened (i.e. not permitted to listen to or speak to others) by the guild;
otherwise <code>false</code>.</p>
</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_WebSocket_SocketGuildUser_IsMuted.md&amp;value=---%0Auid%3A%20Discord.WebSocket.SocketGuildUser.IsMuted%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.WebSocket/Entities/Users/SocketGuildUser.cs/#L56">View Source</a>
</span>
<a id="Discord_WebSocket_SocketGuildUser_IsMuted_" data-uid="Discord.WebSocket.SocketGuildUser.IsMuted*"></a>
<h4 id="Discord_WebSocket_SocketGuildUser_IsMuted" data-uid="Discord.WebSocket.SocketGuildUser.IsMuted">IsMuted</h4>
<div class="markdown level1 summary"><p>Gets a value that indicates whether this user is muted (i.e. not permitted to speak via voice) by 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 bool IsMuted { get; }</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><span class="xref">System.Boolean</span></td>
<td><p><code>true</code> if this user is muted by the guild; otherwise <code>false</code>.</p>
</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_WebSocket_SocketGuildUser_IsSelfDeafened.md&amp;value=---%0Auid%3A%20Discord.WebSocket.SocketGuildUser.IsSelfDeafened%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.WebSocket/Entities/Users/SocketGuildUser.cs/#L48">View Source</a>
</span>
<a id="Discord_WebSocket_SocketGuildUser_IsSelfDeafened_" data-uid="Discord.WebSocket.SocketGuildUser.IsSelfDeafened*"></a>
<h4 id="Discord_WebSocket_SocketGuildUser_IsSelfDeafened" data-uid="Discord.WebSocket.SocketGuildUser.IsSelfDeafened">IsSelfDeafened</h4>
<div class="markdown level1 summary"><p>Gets a value that indicates whether this user has marked themselves as deafened.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public bool IsSelfDeafened { get; }</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><span class="xref">System.Boolean</span></td>
<td><p><code>true</code> if this user has deafened themselves (i.e. not permitted to listen to or speak to others); otherwise <code>false</code>.</p>
</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_WebSocket_SocketGuildUser_IsSelfMuted.md&amp;value=---%0Auid%3A%20Discord.WebSocket.SocketGuildUser.IsSelfMuted%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.WebSocket/Entities/Users/SocketGuildUser.cs/#L50">View Source</a>
</span>
<a id="Discord_WebSocket_SocketGuildUser_IsSelfMuted_" data-uid="Discord.WebSocket.SocketGuildUser.IsSelfMuted*"></a>
<h4 id="Discord_WebSocket_SocketGuildUser_IsSelfMuted" data-uid="Discord.WebSocket.SocketGuildUser.IsSelfMuted">IsSelfMuted</h4>
<div class="markdown level1 summary"><p>Gets a value that indicates whether this user has marked themselves as muted (i.e. not permitted to
speak via voice).</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public bool IsSelfMuted { get; }</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><span class="xref">System.Boolean</span></td>
<td><p><code>true</code> if this user has muted themselves; otherwise <code>false</code>.</p>
</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_WebSocket_SocketGuildUser_IsStreaming.md&amp;value=---%0Auid%3A%20Discord.WebSocket.SocketGuildUser.IsStreaming%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.WebSocket/Entities/Users/SocketGuildUser.cs/#L58">View Source</a>
</span>
<a id="Discord_WebSocket_SocketGuildUser_IsStreaming_" data-uid="Discord.WebSocket.SocketGuildUser.IsStreaming*"></a>
<h4 id="Discord_WebSocket_SocketGuildUser_IsStreaming" data-uid="Discord.WebSocket.SocketGuildUser.IsStreaming">IsStreaming</h4>
<div class="markdown level1 summary"><p>Gets a value that indicates if this user is streaming in a voice channel.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public bool IsStreaming { get; }</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><span class="xref">System.Boolean</span></td>
<td><p><code>true</code> if the user is streaming; otherwise <code>false</code>.</p>
</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_WebSocket_SocketGuildUser_IsSuppressed.md&amp;value=---%0Auid%3A%20Discord.WebSocket.SocketGuildUser.IsSuppressed%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.WebSocket/Entities/Users/SocketGuildUser.cs/#L52">View Source</a>
</span>
<a id="Discord_WebSocket_SocketGuildUser_IsSuppressed_" data-uid="Discord.WebSocket.SocketGuildUser.IsSuppressed*"></a>
<h4 id="Discord_WebSocket_SocketGuildUser_IsSuppressed" data-uid="Discord.WebSocket.SocketGuildUser.IsSuppressed">IsSuppressed</h4>
<div class="markdown level1 summary"><p>Gets a value that indicates whether the user is muted by the current user.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public bool IsSuppressed { get; }</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><span class="xref">System.Boolean</span></td>
<td><p><code>true</code> if the guild is temporarily blocking audio to/from this user; otherwise <code>false</code>.</p>
</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_WebSocket_SocketGuildUser_IsWebhook.md&amp;value=---%0Auid%3A%20Discord.WebSocket.SocketGuildUser.IsWebhook%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.WebSocket/Entities/Users/SocketGuildUser.cs/#L46">View Source</a>
</span>
<a id="Discord_WebSocket_SocketGuildUser_IsWebhook_" data-uid="Discord.WebSocket.SocketGuildUser.IsWebhook*"></a>
<h4 id="Discord_WebSocket_SocketGuildUser_IsWebhook" data-uid="Discord.WebSocket.SocketGuildUser.IsWebhook">IsWebhook</h4>
<div class="markdown level1 summary"><p>Gets a value that indicates whether this user is a webhook user.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public override bool IsWebhook { get; }</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><span class="xref">System.Boolean</span></td>
<td><p><code>true</code> if the user is a webhook; otherwise <code>false</code>.</p>
</td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><a class="xref" href="Discord.WebSocket.SocketUser.html#Discord_WebSocket_SocketUser_IsWebhook">SocketUser.IsWebhook</a></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_WebSocket_SocketGuildUser_JoinedAt.md&amp;value=---%0Auid%3A%20Discord.WebSocket.SocketGuildUser.JoinedAt%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.WebSocket/Entities/Users/SocketGuildUser.cs/#L60">View Source</a>
</span>
<a id="Discord_WebSocket_SocketGuildUser_JoinedAt_" data-uid="Discord.WebSocket.SocketGuildUser.JoinedAt*"></a>
<h4 id="Discord_WebSocket_SocketGuildUser_JoinedAt" data-uid="Discord.WebSocket.SocketGuildUser.JoinedAt">JoinedAt</h4>
<div class="markdown level1 summary"><p>Gets when this user joined 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 DateTimeOffset? JoinedAt { get; }</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><span class="xref">System.Nullable</span>&lt;<span class="xref">System.DateTimeOffset</span>&gt;</td>
<td><p>A <span class="xref">System.DateTimeOffset</span> representing the time of which the user has joined the guild;
<code>null</code> when it cannot be obtained.</p>
</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_WebSocket_SocketGuildUser_Nickname.md&amp;value=---%0Auid%3A%20Discord.WebSocket.SocketGuildUser.Nickname%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.WebSocket/Entities/Users/SocketGuildUser.cs/#L31">View Source</a>
</span>
<a id="Discord_WebSocket_SocketGuildUser_Nickname_" data-uid="Discord.WebSocket.SocketGuildUser.Nickname*"></a>
<h4 id="Discord_WebSocket_SocketGuildUser_Nickname" data-uid="Discord.WebSocket.SocketGuildUser.Nickname">Nickname</h4>
<div class="markdown level1 summary"><p>Gets the nickname for this user.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string Nickname { get; }</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><span class="xref">System.String</span></td>
<td><p>A string representing the nickname of the user; <code>null</code> if none is set.</p>
</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_WebSocket_SocketGuildUser_PremiumSince.md&amp;value=---%0Auid%3A%20Discord.WebSocket.SocketGuildUser.PremiumSince%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.WebSocket/Entities/Users/SocketGuildUser.cs/#L82">View Source</a>
</span>
<a id="Discord_WebSocket_SocketGuildUser_PremiumSince_" data-uid="Discord.WebSocket.SocketGuildUser.PremiumSince*"></a>
<h4 id="Discord_WebSocket_SocketGuildUser_PremiumSince" data-uid="Discord.WebSocket.SocketGuildUser.PremiumSince">PremiumSince</h4>
<div class="markdown level1 summary"><p>Gets the date and time for when this user's guild boost began.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public DateTimeOffset? PremiumSince { get; }</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><span class="xref">System.Nullable</span>&lt;<span class="xref">System.DateTimeOffset</span>&gt;</td>
<td><p>A <span class="xref">System.DateTimeOffset</span> for when the user began boosting this guild; <code>null</code> if they are not boosting the guild.</p>
</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_WebSocket_SocketGuildUser_Roles.md&amp;value=---%0Auid%3A%20Discord.WebSocket.SocketGuildUser.Roles%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.WebSocket/Entities/Users/SocketGuildUser.cs/#L64">View Source</a>
</span>
<a id="Discord_WebSocket_SocketGuildUser_Roles_" data-uid="Discord.WebSocket.SocketGuildUser.Roles*"></a>
<h4 id="Discord_WebSocket_SocketGuildUser_Roles" data-uid="Discord.WebSocket.SocketGuildUser.Roles">Roles</h4>
<div class="markdown level1 summary"><p>Returns a collection of roles that the user possesses.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public IReadOnlyCollection&lt;SocketRole&gt; Roles { get; }</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><span class="xref">System.Collections.Generic.IReadOnlyCollection</span>&lt;<a class="xref" href="Discord.WebSocket.SocketRole.html">SocketRole</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_WebSocket_SocketGuildUser_Username.md&amp;value=---%0Auid%3A%20Discord.WebSocket.SocketGuildUser.Username%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.WebSocket/Entities/Users/SocketGuildUser.cs/#L36">View Source</a>
</span>
<a id="Discord_WebSocket_SocketGuildUser_Username_" data-uid="Discord.WebSocket.SocketGuildUser.Username*"></a>
<h4 id="Discord_WebSocket_SocketGuildUser_Username" data-uid="Discord.WebSocket.SocketGuildUser.Username">Username</h4>
<div class="markdown level1 summary"><p>Gets the username for this user.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public override string Username { get; }</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><span class="xref">System.String</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><a class="xref" href="Discord.WebSocket.SocketUser.html#Discord_WebSocket_SocketUser_Username">SocketUser.Username</a></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_WebSocket_SocketGuildUser_VoiceChannel.md&amp;value=---%0Auid%3A%20Discord.WebSocket.SocketGuildUser.VoiceChannel%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.WebSocket/Entities/Users/SocketGuildUser.cs/#L69">View Source</a>
</span>
<a id="Discord_WebSocket_SocketGuildUser_VoiceChannel_" data-uid="Discord.WebSocket.SocketGuildUser.VoiceChannel*"></a>
<h4 id="Discord_WebSocket_SocketGuildUser_VoiceChannel" data-uid="Discord.WebSocket.SocketGuildUser.VoiceChannel">VoiceChannel</h4>
<div class="markdown level1 summary"><p>Returns the voice channel the user is in, or <code>null</code> if none.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public SocketVoiceChannel VoiceChannel { get; }</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.WebSocket.SocketVoiceChannel.html">SocketVoiceChannel</a></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_WebSocket_SocketGuildUser_VoiceSessionId.md&amp;value=---%0Auid%3A%20Discord.WebSocket.SocketGuildUser.VoiceSessionId%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.WebSocket/Entities/Users/SocketGuildUser.cs/#L71">View Source</a>
</span>
<a id="Discord_WebSocket_SocketGuildUser_VoiceSessionId_" data-uid="Discord.WebSocket.SocketGuildUser.VoiceSessionId*"></a>
<h4 id="Discord_WebSocket_SocketGuildUser_VoiceSessionId" data-uid="Discord.WebSocket.SocketGuildUser.VoiceSessionId">VoiceSessionId</h4>
<div class="markdown level1 summary"><p>Gets the unique identifier for this user's voice session.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string VoiceSessionId { get; }</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><span class="xref">System.String</span></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_WebSocket_SocketGuildUser_VoiceState.md&amp;value=---%0Auid%3A%20Discord.WebSocket.SocketGuildUser.VoiceState%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.WebSocket/Entities/Users/SocketGuildUser.cs/#L79">View Source</a>
</span>
<a id="Discord_WebSocket_SocketGuildUser_VoiceState_" data-uid="Discord.WebSocket.SocketGuildUser.VoiceState*"></a>
<h4 id="Discord_WebSocket_SocketGuildUser_VoiceState" data-uid="Discord.WebSocket.SocketGuildUser.VoiceState">VoiceState</h4>
<div class="markdown level1 summary"><p>Gets the voice connection status of the user if any.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public SocketVoiceState? VoiceState { get; }</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><span class="xref">System.Nullable</span>&lt;<a class="xref" href="Discord.WebSocket.SocketVoiceState.html">SocketVoiceState</a>&gt;</td>
<td><p>A <a class="xref" href="Discord.WebSocket.SocketVoiceState.html">SocketVoiceState</a> representing the user's voice status; <code>null</code> if the user is not
connected to a voice channel.</p>
</td>
</tr>
</tbody>
</table>
<h3 id="methods">Methods
</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_WebSocket_SocketGuildUser_AddRoleAsync_Discord_IRole_Discord_RequestOptions_.md&amp;value=---%0Auid%3A%20Discord.WebSocket.SocketGuildUser.AddRoleAsync(Discord.IRole%2CDiscord.RequestOptions)%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.WebSocket/Entities/Users/SocketGuildUser.cs/#L174">View Source</a>
</span>
<a id="Discord_WebSocket_SocketGuildUser_AddRoleAsync_" data-uid="Discord.WebSocket.SocketGuildUser.AddRoleAsync*"></a>
<h4 id="Discord_WebSocket_SocketGuildUser_AddRoleAsync_Discord_IRole_Discord_RequestOptions_" data-uid="Discord.WebSocket.SocketGuildUser.AddRoleAsync(Discord.IRole,Discord.RequestOptions)">AddRoleAsync(IRole, RequestOptions)</h4>
<div class="markdown level1 summary"><p>Adds the specified role to this user in 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 Task AddRoleAsync(IRole role, RequestOptions options = null)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Discord.IRole.html">IRole</a></td>
<td><span class="parametername">role</span></td>
<td><p>The role to be added to the user.</p>
</td>
</tr>
<tr>
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
<td><span class="parametername">options</span></td>
<td><p>The options to be used when sending the request.</p>
</td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Threading.Tasks.Task</span></td>
<td><p>A task that represents the asynchronous role addition operation.</p>
</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_WebSocket_SocketGuildUser_AddRolesAsync_System_Collections_Generic_IEnumerable_Discord_IRole__Discord_RequestOptions_.md&amp;value=---%0Auid%3A%20Discord.WebSocket.SocketGuildUser.AddRolesAsync(System.Collections.Generic.IEnumerable%7BDiscord.IRole%7D%2CDiscord.RequestOptions)%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.WebSocket/Entities/Users/SocketGuildUser.cs/#L177">View Source</a>
</span>
<a id="Discord_WebSocket_SocketGuildUser_AddRolesAsync_" data-uid="Discord.WebSocket.SocketGuildUser.AddRolesAsync*"></a>
<h4 id="Discord_WebSocket_SocketGuildUser_AddRolesAsync_System_Collections_Generic_IEnumerable_Discord_IRole__Discord_RequestOptions_" data-uid="Discord.WebSocket.SocketGuildUser.AddRolesAsync(System.Collections.Generic.IEnumerable{Discord.IRole},Discord.RequestOptions)">AddRolesAsync(IEnumerable&lt;IRole&gt;, RequestOptions)</h4>
<div class="markdown level1 summary"><p>Adds the specified <code data-dev-comment-type="paramref" class="paramref">roles</code> to this user in 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 Task AddRolesAsync(IEnumerable&lt;IRole&gt; roles, RequestOptions options = null)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Collections.Generic.IEnumerable</span>&lt;<a class="xref" href="Discord.IRole.html">IRole</a>&gt;</td>
<td><span class="parametername">roles</span></td>
<td><p>The roles to be added to the user.</p>
</td>
</tr>
<tr>
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
<td><span class="parametername">options</span></td>
<td><p>The options to be used when sending the request.</p>
</td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Threading.Tasks.Task</span></td>
<td><p>A task that represents the asynchronous role addition operation.</p>
</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_WebSocket_SocketGuildUser_GetPermissions_Discord_IGuildChannel_.md&amp;value=---%0Auid%3A%20Discord.WebSocket.SocketGuildUser.GetPermissions(Discord.IGuildChannel)%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.WebSocket/Entities/Users/SocketGuildUser.cs/#L187">View Source</a>
</span>
<a id="Discord_WebSocket_SocketGuildUser_GetPermissions_" data-uid="Discord.WebSocket.SocketGuildUser.GetPermissions*"></a>
<h4 id="Discord_WebSocket_SocketGuildUser_GetPermissions_Discord_IGuildChannel_" data-uid="Discord.WebSocket.SocketGuildUser.GetPermissions(Discord.IGuildChannel)">GetPermissions(IGuildChannel)</h4>
<div class="markdown level1 summary"><p>Gets the level permissions granted to this user to a given channel.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public ChannelPermissions GetPermissions(IGuildChannel channel)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Discord.IGuildChannel.html">IGuildChannel</a></td>
<td><span class="parametername">channel</span></td>
<td><p>The channel to get the permission from.</p>
</td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</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.ChannelPermissions.html">ChannelPermissions</a></td>
<td><p>A <a class="xref" href="Discord.ChannelPermissions.html">ChannelPermissions</a> structure representing the permissions that a user has in the
specified channel.</p>
</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_WebSocket_SocketGuildUser_KickAsync_System_String_Discord_RequestOptions_.md&amp;value=---%0Auid%3A%20Discord.WebSocket.SocketGuildUser.KickAsync(System.String%2CDiscord.RequestOptions)%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.WebSocket/Entities/Users/SocketGuildUser.cs/#L171">View Source</a>
</span>
<a id="Discord_WebSocket_SocketGuildUser_KickAsync_" data-uid="Discord.WebSocket.SocketGuildUser.KickAsync*"></a>
<h4 id="Discord_WebSocket_SocketGuildUser_KickAsync_System_String_Discord_RequestOptions_" data-uid="Discord.WebSocket.SocketGuildUser.KickAsync(System.String,Discord.RequestOptions)">KickAsync(String, RequestOptions)</h4>
<div class="markdown level1 summary"><p>Kicks this user from 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 Task KickAsync(string reason = null, RequestOptions options = null)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">reason</span></td>
<td><p>The reason for the kick which will be recorded in the audit log.</p>
</td>
</tr>
<tr>
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
<td><span class="parametername">options</span></td>
<td><p>The options to be used when sending the request.</p>
</td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Threading.Tasks.Task</span></td>
<td><p>A task that represents the asynchronous kick operation.</p>
</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_WebSocket_SocketGuildUser_ModifyAsync_System_Action_Discord_GuildUserProperties__Discord_RequestOptions_.md&amp;value=---%0Auid%3A%20Discord.WebSocket.SocketGuildUser.ModifyAsync(System.Action%7BDiscord.GuildUserProperties%7D%2CDiscord.RequestOptions)%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.WebSocket/Entities/Users/SocketGuildUser.cs/#L168">View Source</a>
</span>
<a id="Discord_WebSocket_SocketGuildUser_ModifyAsync_" data-uid="Discord.WebSocket.SocketGuildUser.ModifyAsync*"></a>
<h4 id="Discord_WebSocket_SocketGuildUser_ModifyAsync_System_Action_Discord_GuildUserProperties__Discord_RequestOptions_" data-uid="Discord.WebSocket.SocketGuildUser.ModifyAsync(System.Action{Discord.GuildUserProperties},Discord.RequestOptions)">ModifyAsync(Action&lt;GuildUserProperties&gt;, RequestOptions)</h4>
<div class="markdown level1 summary"><p>Modifies this user's properties in 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 Task ModifyAsync(Action&lt;GuildUserProperties&gt; func, RequestOptions options = null)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Action</span>&lt;<a class="xref" href="Discord.GuildUserProperties.html">GuildUserProperties</a>&gt;</td>
<td><span class="parametername">func</span></td>
<td><p>The delegate containing the properties to modify the user with.</p>
</td>
</tr>
<tr>
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
<td><span class="parametername">options</span></td>
<td><p>The options to be used when sending the request.</p>
</td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Threading.Tasks.Task</span></td>
<td><p>A task that represents the asynchronous modification operation.</p>
</td>
</tr>
</tbody>
</table>
<h5 id="Discord_WebSocket_SocketGuildUser_ModifyAsync_System_Action_Discord_GuildUserProperties__Discord_RequestOptions__remarks">Remarks</h5>
<div class="markdown level1 remarks"><p>This method modifies the current guild user with the specified properties. To see an example of this
method and what properties are available, please refer to <a class="xref" href="Discord.GuildUserProperties.html">GuildUserProperties</a>.</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_WebSocket_SocketGuildUser_RemoveRoleAsync_Discord_IRole_Discord_RequestOptions_.md&amp;value=---%0Auid%3A%20Discord.WebSocket.SocketGuildUser.RemoveRoleAsync(Discord.IRole%2CDiscord.RequestOptions)%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.WebSocket/Entities/Users/SocketGuildUser.cs/#L180">View Source</a>
</span>
<a id="Discord_WebSocket_SocketGuildUser_RemoveRoleAsync_" data-uid="Discord.WebSocket.SocketGuildUser.RemoveRoleAsync*"></a>
<h4 id="Discord_WebSocket_SocketGuildUser_RemoveRoleAsync_Discord_IRole_Discord_RequestOptions_" data-uid="Discord.WebSocket.SocketGuildUser.RemoveRoleAsync(Discord.IRole,Discord.RequestOptions)">RemoveRoleAsync(IRole, RequestOptions)</h4>
<div class="markdown level1 summary"><p>Removes the specified <code data-dev-comment-type="paramref" class="paramref">role</code> from this user in 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 Task RemoveRoleAsync(IRole role, RequestOptions options = null)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Discord.IRole.html">IRole</a></td>
<td><span class="parametername">role</span></td>
<td><p>The role to be removed from the user.</p>
</td>
</tr>
<tr>
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
<td><span class="parametername">options</span></td>
<td><p>The options to be used when sending the request.</p>
</td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Threading.Tasks.Task</span></td>
<td><p>A task that represents the asynchronous role removal operation.</p>
</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_WebSocket_SocketGuildUser_RemoveRolesAsync_System_Collections_Generic_IEnumerable_Discord_IRole__Discord_RequestOptions_.md&amp;value=---%0Auid%3A%20Discord.WebSocket.SocketGuildUser.RemoveRolesAsync(System.Collections.Generic.IEnumerable%7BDiscord.IRole%7D%2CDiscord.RequestOptions)%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.WebSocket/Entities/Users/SocketGuildUser.cs/#L183">View Source</a>
</span>
<a id="Discord_WebSocket_SocketGuildUser_RemoveRolesAsync_" data-uid="Discord.WebSocket.SocketGuildUser.RemoveRolesAsync*"></a>
<h4 id="Discord_WebSocket_SocketGuildUser_RemoveRolesAsync_System_Collections_Generic_IEnumerable_Discord_IRole__Discord_RequestOptions_" data-uid="Discord.WebSocket.SocketGuildUser.RemoveRolesAsync(System.Collections.Generic.IEnumerable{Discord.IRole},Discord.RequestOptions)">RemoveRolesAsync(IEnumerable&lt;IRole&gt;, RequestOptions)</h4>
<div class="markdown level1 summary"><p>Removes the specified <code data-dev-comment-type="paramref" class="paramref">roles</code> from this user in 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 Task RemoveRolesAsync(IEnumerable&lt;IRole&gt; roles, RequestOptions options = null)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Collections.Generic.IEnumerable</span>&lt;<a class="xref" href="Discord.IRole.html">IRole</a>&gt;</td>
<td><span class="parametername">roles</span></td>
<td><p>The roles to be removed from the user.</p>
</td>
</tr>
<tr>
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
<td><span class="parametername">options</span></td>
<td><p>The options to be used when sending the request.</p>
</td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Threading.Tasks.Task</span></td>
<td><p>A task that represents the asynchronous role removal operation.</p>
</td>
</tr>
</tbody>
</table>
<h3 id="eii">Explicit Interface Implementations
</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_WebSocket_SocketGuildUser_Discord_IGuildUser_Guild.md&amp;value=---%0Auid%3A%20Discord.WebSocket.SocketGuildUser.Discord%23IGuildUser%23Guild%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.WebSocket/Entities/Users/SocketGuildUser.cs/#L195">View Source</a>
</span>
<a id="Discord_WebSocket_SocketGuildUser_Discord_IGuildUser_Guild_" data-uid="Discord.WebSocket.SocketGuildUser.Discord#IGuildUser#Guild*"></a>
<h4 id="Discord_WebSocket_SocketGuildUser_Discord_IGuildUser_Guild" data-uid="Discord.WebSocket.SocketGuildUser.Discord#IGuildUser#Guild">IGuildUser.Guild</h4>
<div class="markdown level1 summary"><p>Gets the guild for this user.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">IGuild IGuildUser.Guild { get; }</code></pre>
</div>
<h5 class="returns">Returns</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.IGuild.html">IGuild</a></td>
<td><p>A guild object that this user belongs to.</p>
</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_WebSocket_SocketGuildUser_Discord_IGuildUser_GuildId.md&amp;value=---%0Auid%3A%20Discord.WebSocket.SocketGuildUser.Discord%23IGuildUser%23GuildId%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.WebSocket/Entities/Users/SocketGuildUser.cs/#L197">View Source</a>
</span>
<a id="Discord_WebSocket_SocketGuildUser_Discord_IGuildUser_GuildId_" data-uid="Discord.WebSocket.SocketGuildUser.Discord#IGuildUser#GuildId*"></a>
<h4 id="Discord_WebSocket_SocketGuildUser_Discord_IGuildUser_GuildId" data-uid="Discord.WebSocket.SocketGuildUser.Discord#IGuildUser#GuildId">IGuildUser.GuildId</h4>
<div class="markdown level1 summary"><p>Gets the ID of the guild for this user.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">ulong IGuildUser.GuildId { get; }</code></pre>
</div>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.UInt64</span></td>
<td><p>An <span class="xref">System.UInt64</span> representing the snowflake identifier of the guild that this user belongs to.</p>
</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_WebSocket_SocketGuildUser_Discord_IGuildUser_RoleIds.md&amp;value=---%0Auid%3A%20Discord.WebSocket.SocketGuildUser.Discord%23IGuildUser%23RoleIds%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.WebSocket/Entities/Users/SocketGuildUser.cs/#L199">View Source</a>
</span>
<a id="Discord_WebSocket_SocketGuildUser_Discord_IGuildUser_RoleIds_" data-uid="Discord.WebSocket.SocketGuildUser.Discord#IGuildUser#RoleIds*"></a>
<h4 id="Discord_WebSocket_SocketGuildUser_Discord_IGuildUser_RoleIds" data-uid="Discord.WebSocket.SocketGuildUser.Discord#IGuildUser#RoleIds">IGuildUser.RoleIds</h4>
<div class="markdown level1 summary"><p>Gets a collection of IDs for the roles that this user currently possesses in the guild.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">IReadOnlyCollection&lt;ulong&gt; IGuildUser.RoleIds { get; }</code></pre>
</div>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Collections.Generic.IReadOnlyCollection</span>&lt;<span class="xref">System.UInt64</span>&gt;</td>
<td><p>A read-only collection of <span class="xref">System.UInt64</span>, each representing a snowflake identifier for a role that
this user possesses.</p>
</td>
</tr>
</tbody>
</table>
<h5 id="Discord_WebSocket_SocketGuildUser_Discord_IGuildUser_RoleIds_remarks">Remarks</h5>
<div class="markdown level1 remarks"><p>This property returns a read-only collection of the identifiers of the roles that this user possesses.
For WebSocket users, a Roles property can be found in place of this property. Due to the REST
implementation, only a collection of identifiers can be retrieved instead of the full role objects.</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_WebSocket_SocketGuildUser_Discord_IVoiceState_VoiceChannel.md&amp;value=---%0Auid%3A%20Discord.WebSocket.SocketGuildUser.Discord%23IVoiceState%23VoiceChannel%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.WebSocket/Entities/Users/SocketGuildUser.cs/#L203">View Source</a>
</span>
<a id="Discord_WebSocket_SocketGuildUser_Discord_IVoiceState_VoiceChannel_" data-uid="Discord.WebSocket.SocketGuildUser.Discord#IVoiceState#VoiceChannel*"></a>
<h4 id="Discord_WebSocket_SocketGuildUser_Discord_IVoiceState_VoiceChannel" data-uid="Discord.WebSocket.SocketGuildUser.Discord#IVoiceState#VoiceChannel">IVoiceState.VoiceChannel</h4>
<div class="markdown level1 summary"><p>Gets the voice channel this user is currently in.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">IVoiceChannel IVoiceState.VoiceChannel { get; }</code></pre>
</div>
<h5 class="returns">Returns</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.IVoiceChannel.html">IVoiceChannel</a></td>
<td><p>A generic voice channel object representing the voice channel that the user is currently in; <code>null</code>
if none.</p>
</td>
</tr>
</tbody>
</table>
<h3 id="implements">Implements</h3>
<div>
<a class="xref" href="Discord.IGuildUser.html">IGuildUser</a>
</div>
<div>
<a class="xref" href="Discord.IUser.html">IUser</a>
</div>
<div>
<a class="xref" href="Discord.ISnowflakeEntity.html">ISnowflakeEntity</a>
</div>
<div>
<a class="xref" href="Discord.IEntity-1.html">IEntity&lt;TId&gt;</a>
</div>
<div>
<a class="xref" href="Discord.IMentionable.html">IMentionable</a>
</div>
<div>
<a class="xref" href="Discord.IPresence.html">IPresence</a>
</div>
<div>
<a class="xref" href="Discord.IVoiceState.html">IVoiceState</a>
</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_WebSocket_SocketGuildUser.md&amp;value=---%0Auid%3A%20Discord.WebSocket.SocketGuildUser%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.WebSocket/Entities/Users/SocketGuildUser.cs/#L18" 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