mirror of
https://github.com/goatcorp/Dalamud.git
synced 2025-12-12 18:27:23 +01:00
687 lines
36 KiB
HTML
687 lines
36 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 SocketGroupUser
|
|
</title>
|
|
<meta name="viewport" content="width=device-width">
|
|
<meta name="title" content="Class SocketGroupUser
|
|
">
|
|
<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.SocketGroupUser">
|
|
|
|
|
|
<h1 id="Discord_WebSocket_SocketGroupUser" data-uid="Discord.WebSocket.SocketGroupUser" class="text-break">Class SocketGroupUser
|
|
</h1>
|
|
<div class="markdown level0 summary"></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><<span class="xref">System.UInt64</span>></div>
|
|
<div class="level2"><a class="xref" href="Discord.WebSocket.SocketUser.html">SocketUser</a></div>
|
|
<div class="level3"><span class="xref">SocketGroupUser</span></div>
|
|
</div>
|
|
<div classs="implements">
|
|
<h5>Implements</h5>
|
|
<div><a class="xref" href="Discord.IGroupUser.html">IGroupUser</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><<span class="xref">System.UInt64</span>></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<UInt64>.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_SocketGroupUser_syntax">Syntax</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public class SocketGroupUser : SocketUser, IGroupUser, IUser, ISnowflakeEntity, IEntity<ulong>, 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_SocketGroupUser_AvatarId.md&value=---%0Auid%3A%20Discord.WebSocket.SocketGroupUser.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/SocketGroupUser.cs/#L26">View Source</a>
|
|
</span>
|
|
<a id="Discord_WebSocket_SocketGroupUser_AvatarId_" data-uid="Discord.WebSocket.SocketGroupUser.AvatarId*"></a>
|
|
<h4 id="Discord_WebSocket_SocketGroupUser_AvatarId" data-uid="Discord.WebSocket.SocketGroupUser.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_SocketGroupUser_Channel.md&value=---%0Auid%3A%20Discord.WebSocket.SocketGroupUser.Channel%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/SocketGroupUser.cs/#L15">View Source</a>
|
|
</span>
|
|
<a id="Discord_WebSocket_SocketGroupUser_Channel_" data-uid="Discord.WebSocket.SocketGroupUser.Channel*"></a>
|
|
<h4 id="Discord_WebSocket_SocketGroupUser_Channel" data-uid="Discord.WebSocket.SocketGroupUser.Channel">Channel</h4>
|
|
<div class="markdown level1 summary"><p>Gets the group channel of the user.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public SocketGroupChannel Channel { 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.SocketGroupChannel.html">SocketGroupChannel</a></td>
|
|
<td><p>A <a class="xref" href="Discord.WebSocket.SocketGroupChannel.html">SocketGroupChannel</a> representing the channel of which the 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_SocketGroupUser_DiscriminatorValue.md&value=---%0Auid%3A%20Discord.WebSocket.SocketGroupUser.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/SocketGroupUser.cs/#L24">View Source</a>
|
|
</span>
|
|
<a id="Discord_WebSocket_SocketGroupUser_DiscriminatorValue_" data-uid="Discord.WebSocket.SocketGroupUser.DiscriminatorValue*"></a>
|
|
<h4 id="Discord_WebSocket_SocketGroupUser_DiscriminatorValue" data-uid="Discord.WebSocket.SocketGroupUser.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_SocketGroupUser_IsBot.md&value=---%0Auid%3A%20Discord.WebSocket.SocketGroupUser.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/SocketGroupUser.cs/#L20">View Source</a>
|
|
</span>
|
|
<a id="Discord_WebSocket_SocketGroupUser_IsBot_" data-uid="Discord.WebSocket.SocketGroupUser.IsBot*"></a>
|
|
<h4 id="Discord_WebSocket_SocketGroupUser_IsBot" data-uid="Discord.WebSocket.SocketGroupUser.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_SocketGroupUser_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_SocketGroupUser_IsWebhook.md&value=---%0Auid%3A%20Discord.WebSocket.SocketGroupUser.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/SocketGroupUser.cs/#L31">View Source</a>
|
|
</span>
|
|
<a id="Discord_WebSocket_SocketGroupUser_IsWebhook_" data-uid="Discord.WebSocket.SocketGroupUser.IsWebhook*"></a>
|
|
<h4 id="Discord_WebSocket_SocketGroupUser_IsWebhook" data-uid="Discord.WebSocket.SocketGroupUser.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_SocketGroupUser_Username.md&value=---%0Auid%3A%20Discord.WebSocket.SocketGroupUser.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/SocketGroupUser.cs/#L22">View Source</a>
|
|
</span>
|
|
<a id="Discord_WebSocket_SocketGroupUser_Username_" data-uid="Discord.WebSocket.SocketGroupUser.Username*"></a>
|
|
<h4 id="Discord_WebSocket_SocketGroupUser_Username" data-uid="Discord.WebSocket.SocketGroupUser.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>
|
|
<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_SocketGroupUser_Discord_IVoiceState_IsDeafened.md&value=---%0Auid%3A%20Discord.WebSocket.SocketGroupUser.Discord%23IVoiceState%23IsDeafened%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/SocketGroupUser.cs/#L51">View Source</a>
|
|
</span>
|
|
<a id="Discord_WebSocket_SocketGroupUser_Discord_IVoiceState_IsDeafened_" data-uid="Discord.WebSocket.SocketGroupUser.Discord#IVoiceState#IsDeafened*"></a>
|
|
<h4 id="Discord_WebSocket_SocketGroupUser_Discord_IVoiceState_IsDeafened" data-uid="Discord.WebSocket.SocketGroupUser.Discord#IVoiceState#IsDeafened">IVoiceState.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">bool IVoiceState.IsDeafened { 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.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_SocketGroupUser_Discord_IVoiceState_IsMuted.md&value=---%0Auid%3A%20Discord.WebSocket.SocketGroupUser.Discord%23IVoiceState%23IsMuted%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/SocketGroupUser.cs/#L53">View Source</a>
|
|
</span>
|
|
<a id="Discord_WebSocket_SocketGroupUser_Discord_IVoiceState_IsMuted_" data-uid="Discord.WebSocket.SocketGroupUser.Discord#IVoiceState#IsMuted*"></a>
|
|
<h4 id="Discord_WebSocket_SocketGroupUser_Discord_IVoiceState_IsMuted" data-uid="Discord.WebSocket.SocketGroupUser.Discord#IVoiceState#IsMuted">IVoiceState.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">bool IVoiceState.IsMuted { 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.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_SocketGroupUser_Discord_IVoiceState_IsSelfDeafened.md&value=---%0Auid%3A%20Discord.WebSocket.SocketGroupUser.Discord%23IVoiceState%23IsSelfDeafened%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/SocketGroupUser.cs/#L55">View Source</a>
|
|
</span>
|
|
<a id="Discord_WebSocket_SocketGroupUser_Discord_IVoiceState_IsSelfDeafened_" data-uid="Discord.WebSocket.SocketGroupUser.Discord#IVoiceState#IsSelfDeafened*"></a>
|
|
<h4 id="Discord_WebSocket_SocketGroupUser_Discord_IVoiceState_IsSelfDeafened" data-uid="Discord.WebSocket.SocketGroupUser.Discord#IVoiceState#IsSelfDeafened">IVoiceState.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">bool IVoiceState.IsSelfDeafened { 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.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_SocketGroupUser_Discord_IVoiceState_IsSelfMuted.md&value=---%0Auid%3A%20Discord.WebSocket.SocketGroupUser.Discord%23IVoiceState%23IsSelfMuted%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/SocketGroupUser.cs/#L57">View Source</a>
|
|
</span>
|
|
<a id="Discord_WebSocket_SocketGroupUser_Discord_IVoiceState_IsSelfMuted_" data-uid="Discord.WebSocket.SocketGroupUser.Discord#IVoiceState#IsSelfMuted*"></a>
|
|
<h4 id="Discord_WebSocket_SocketGroupUser_Discord_IVoiceState_IsSelfMuted" data-uid="Discord.WebSocket.SocketGroupUser.Discord#IVoiceState#IsSelfMuted">IVoiceState.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">bool IVoiceState.IsSelfMuted { 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.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_SocketGroupUser_Discord_IVoiceState_IsStreaming.md&value=---%0Auid%3A%20Discord.WebSocket.SocketGroupUser.Discord%23IVoiceState%23IsStreaming%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/SocketGroupUser.cs/#L65">View Source</a>
|
|
</span>
|
|
<a id="Discord_WebSocket_SocketGroupUser_Discord_IVoiceState_IsStreaming_" data-uid="Discord.WebSocket.SocketGroupUser.Discord#IVoiceState#IsStreaming*"></a>
|
|
<h4 id="Discord_WebSocket_SocketGroupUser_Discord_IVoiceState_IsStreaming" data-uid="Discord.WebSocket.SocketGroupUser.Discord#IVoiceState#IsStreaming">IVoiceState.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">bool IVoiceState.IsStreaming { 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.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_SocketGroupUser_Discord_IVoiceState_IsSuppressed.md&value=---%0Auid%3A%20Discord.WebSocket.SocketGroupUser.Discord%23IVoiceState%23IsSuppressed%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/SocketGroupUser.cs/#L59">View Source</a>
|
|
</span>
|
|
<a id="Discord_WebSocket_SocketGroupUser_Discord_IVoiceState_IsSuppressed_" data-uid="Discord.WebSocket.SocketGroupUser.Discord#IVoiceState#IsSuppressed*"></a>
|
|
<h4 id="Discord_WebSocket_SocketGroupUser_Discord_IVoiceState_IsSuppressed" data-uid="Discord.WebSocket.SocketGroupUser.Discord#IVoiceState#IsSuppressed">IVoiceState.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">bool IVoiceState.IsSuppressed { 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.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_SocketGroupUser_Discord_IVoiceState_VoiceChannel.md&value=---%0Auid%3A%20Discord.WebSocket.SocketGroupUser.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/SocketGroupUser.cs/#L61">View Source</a>
|
|
</span>
|
|
<a id="Discord_WebSocket_SocketGroupUser_Discord_IVoiceState_VoiceChannel_" data-uid="Discord.WebSocket.SocketGroupUser.Discord#IVoiceState#VoiceChannel*"></a>
|
|
<h4 id="Discord_WebSocket_SocketGroupUser_Discord_IVoiceState_VoiceChannel" data-uid="Discord.WebSocket.SocketGroupUser.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>
|
|
<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_SocketGroupUser_Discord_IVoiceState_VoiceSessionId.md&value=---%0Auid%3A%20Discord.WebSocket.SocketGroupUser.Discord%23IVoiceState%23VoiceSessionId%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/SocketGroupUser.cs/#L63">View Source</a>
|
|
</span>
|
|
<a id="Discord_WebSocket_SocketGroupUser_Discord_IVoiceState_VoiceSessionId_" data-uid="Discord.WebSocket.SocketGroupUser.Discord#IVoiceState#VoiceSessionId*"></a>
|
|
<h4 id="Discord_WebSocket_SocketGroupUser_Discord_IVoiceState_VoiceSessionId" data-uid="Discord.WebSocket.SocketGroupUser.Discord#IVoiceState#VoiceSessionId">IVoiceState.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">string IVoiceState.VoiceSessionId { 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.String</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="implements">Implements</h3>
|
|
<div>
|
|
<a class="xref" href="Discord.IGroupUser.html">IGroupUser</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<TId></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_SocketGroupUser.md&value=---%0Auid%3A%20Discord.WebSocket.SocketGroupUser%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/SocketGroupUser.cs/#L6" 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>
|