mirror of
https://github.com/goatcorp/Dalamud.git
synced 2025-12-12 18:27:23 +01:00
1441 lines
73 KiB
HTML
1441 lines
73 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 SocketWebhookUser
|
|
</title>
|
|
<meta name="viewport" content="width=device-width">
|
|
<meta name="title" content="Class SocketWebhookUser
|
|
">
|
|
<meta name="generator" content="docfx 2.48.1.0">
|
|
|
|
<link rel="shortcut icon" href="../favicon.ico">
|
|
<link rel="stylesheet" href="../styles/docfx.vendor.css">
|
|
<link rel="stylesheet" href="../styles/docfx.css">
|
|
<link rel="stylesheet" href="../styles/main.css">
|
|
<meta property="docfx:navrel" content="">
|
|
<meta property="docfx:tocrel" content="toc.html">
|
|
|
|
|
|
|
|
</head>
|
|
<body data-spy="scroll" data-target="#affix" data-offset="120">
|
|
<div id="wrapper">
|
|
<header>
|
|
|
|
<nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
|
|
<div class="container">
|
|
<div class="navbar-header">
|
|
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
|
|
<span class="sr-only">Toggle navigation</span>
|
|
<span class="icon-bar"></span>
|
|
<span class="icon-bar"></span>
|
|
<span class="icon-bar"></span>
|
|
</button>
|
|
|
|
<a class="navbar-brand" href="../index.html">
|
|
<img id="logo" class="svg" src="../logo.svg" alt="">
|
|
</a>
|
|
</div>
|
|
<div class="collapse navbar-collapse" id="navbar">
|
|
<form class="navbar-form navbar-right" role="search" id="search">
|
|
<div class="form-group">
|
|
<input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
|
|
</div>
|
|
</form>
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
|
|
<div class="subnav navbar navbar-default">
|
|
<div class="container hide-when-search" id="breadcrumb">
|
|
<ul class="breadcrumb">
|
|
<li></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</header>
|
|
<div role="main" class="container body-content hide-when-search">
|
|
|
|
<div class="sidenav hide-when-search">
|
|
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
|
<div class="sidetoggle collapse" id="sidetoggle">
|
|
<div id="sidetoc"></div>
|
|
</div>
|
|
</div>
|
|
<div class="article row grid-right">
|
|
<div class="col-md-10">
|
|
<article class="content wrap" id="_content" data-uid="Discord.WebSocket.SocketWebhookUser">
|
|
|
|
|
|
<h1 id="Discord_WebSocket_SocketWebhookUser" data-uid="Discord.WebSocket.SocketWebhookUser" class="text-break">Class SocketWebhookUser
|
|
</h1>
|
|
<div class="markdown level0 summary"><p>Represents a WebSocket-based webhook 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><<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">SocketWebhookUser</span></div>
|
|
</div>
|
|
<div classs="implements">
|
|
<h5>Implements</h5>
|
|
<div><a class="xref" href="Discord.IWebhookUser.html">IWebhookUser</a></div>
|
|
<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><<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_SocketWebhookUser_syntax">Syntax</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public class SocketWebhookUser : SocketUser, IWebhookUser, IGuildUser, 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/dev/apiSpec/new?filename=Discord_WebSocket_SocketWebhookUser_AvatarId.md&value=---%0Auid%3A%20Discord.WebSocket.SocketWebhookUser.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/dev/src/Discord.Net.WebSocket/Entities/Users/SocketWebhookUser.cs/#L26">View Source</a>
|
|
</span>
|
|
<a id="Discord_WebSocket_SocketWebhookUser_AvatarId_" data-uid="Discord.WebSocket.SocketWebhookUser.AvatarId*"></a>
|
|
<h4 id="Discord_WebSocket_SocketWebhookUser_AvatarId" data-uid="Discord.WebSocket.SocketWebhookUser.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/dev/apiSpec/new?filename=Discord_WebSocket_SocketWebhookUser_DiscriminatorValue.md&value=---%0Auid%3A%20Discord.WebSocket.SocketWebhookUser.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/dev/src/Discord.Net.WebSocket/Entities/Users/SocketWebhookUser.cs/#L24">View Source</a>
|
|
</span>
|
|
<a id="Discord_WebSocket_SocketWebhookUser_DiscriminatorValue_" data-uid="Discord.WebSocket.SocketWebhookUser.DiscriminatorValue*"></a>
|
|
<h4 id="Discord_WebSocket_SocketWebhookUser_DiscriminatorValue" data-uid="Discord.WebSocket.SocketWebhookUser.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/dev/apiSpec/new?filename=Discord_WebSocket_SocketWebhookUser_Guild.md&value=---%0Auid%3A%20Discord.WebSocket.SocketWebhookUser.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/dev/src/Discord.Net.WebSocket/Entities/Users/SocketWebhookUser.cs/#L17">View Source</a>
|
|
</span>
|
|
<a id="Discord_WebSocket_SocketWebhookUser_Guild_" data-uid="Discord.WebSocket.SocketWebhookUser.Guild*"></a>
|
|
<h4 id="Discord_WebSocket_SocketWebhookUser_Guild" data-uid="Discord.WebSocket.SocketWebhookUser.Guild">Guild</h4>
|
|
<div class="markdown level1 summary"><p>Gets the guild of this webhook.</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/dev/apiSpec/new?filename=Discord_WebSocket_SocketWebhookUser_IsBot.md&value=---%0Auid%3A%20Discord.WebSocket.SocketWebhookUser.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/dev/src/Discord.Net.WebSocket/Entities/Users/SocketWebhookUser.cs/#L28">View Source</a>
|
|
</span>
|
|
<a id="Discord_WebSocket_SocketWebhookUser_IsBot_" data-uid="Discord.WebSocket.SocketWebhookUser.IsBot*"></a>
|
|
<h4 id="Discord_WebSocket_SocketWebhookUser_IsBot" data-uid="Discord.WebSocket.SocketWebhookUser.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_SocketWebhookUser_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/dev/apiSpec/new?filename=Discord_WebSocket_SocketWebhookUser_IsWebhook.md&value=---%0Auid%3A%20Discord.WebSocket.SocketWebhookUser.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/dev/src/Discord.Net.WebSocket/Entities/Users/SocketWebhookUser.cs/#L31">View Source</a>
|
|
</span>
|
|
<a id="Discord_WebSocket_SocketWebhookUser_IsWebhook_" data-uid="Discord.WebSocket.SocketWebhookUser.IsWebhook*"></a>
|
|
<h4 id="Discord_WebSocket_SocketWebhookUser_IsWebhook" data-uid="Discord.WebSocket.SocketWebhookUser.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/dev/apiSpec/new?filename=Discord_WebSocket_SocketWebhookUser_Username.md&value=---%0Auid%3A%20Discord.WebSocket.SocketWebhookUser.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/dev/src/Discord.Net.WebSocket/Entities/Users/SocketWebhookUser.cs/#L22">View Source</a>
|
|
</span>
|
|
<a id="Discord_WebSocket_SocketWebhookUser_Username_" data-uid="Discord.WebSocket.SocketWebhookUser.Username*"></a>
|
|
<h4 id="Discord_WebSocket_SocketWebhookUser_Username" data-uid="Discord.WebSocket.SocketWebhookUser.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/dev/apiSpec/new?filename=Discord_WebSocket_SocketWebhookUser_WebhookId.md&value=---%0Auid%3A%20Discord.WebSocket.SocketWebhookUser.WebhookId%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/goaaats/Discord.Net/blob/dev/src/Discord.Net.WebSocket/Entities/Users/SocketWebhookUser.cs/#L19">View Source</a>
|
|
</span>
|
|
<a id="Discord_WebSocket_SocketWebhookUser_WebhookId_" data-uid="Discord.WebSocket.SocketWebhookUser.WebhookId*"></a>
|
|
<h4 id="Discord_WebSocket_SocketWebhookUser_WebhookId" data-uid="Discord.WebSocket.SocketWebhookUser.WebhookId">WebhookId</h4>
|
|
<div class="markdown level1 summary"><p>Gets the ID of a webhook.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public ulong WebhookId { 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.UInt64</span></td>
|
|
<td></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/dev/apiSpec/new?filename=Discord_WebSocket_SocketWebhookUser_Discord_IGuildUser_AddRoleAsync_Discord_IRole_Discord_RequestOptions_.md&value=---%0Auid%3A%20Discord.WebSocket.SocketWebhookUser.Discord%23IGuildUser%23AddRoleAsync(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/dev/src/Discord.Net.WebSocket/Entities/Users/SocketWebhookUser.cs/#L84">View Source</a>
|
|
</span>
|
|
<a id="Discord_WebSocket_SocketWebhookUser_Discord_IGuildUser_AddRoleAsync_" data-uid="Discord.WebSocket.SocketWebhookUser.Discord#IGuildUser#AddRoleAsync*"></a>
|
|
<h4 id="Discord_WebSocket_SocketWebhookUser_Discord_IGuildUser_AddRoleAsync_Discord_IRole_Discord_RequestOptions_" data-uid="Discord.WebSocket.SocketWebhookUser.Discord#IGuildUser#AddRoleAsync(Discord.IRole,Discord.RequestOptions)">IGuildUser.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">Task IGuildUser.AddRoleAsync(IRole role, RequestOptions options)</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>
|
|
<h5 class="exceptions">Exceptions</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Condition</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.NotSupportedException</span></td>
|
|
<td><p>Roles are not supported on webhook users.</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/dev/apiSpec/new?filename=Discord_WebSocket_SocketWebhookUser_Discord_IGuildUser_AddRolesAsync_System_Collections_Generic_IEnumerable_Discord_IRole__Discord_RequestOptions_.md&value=---%0Auid%3A%20Discord.WebSocket.SocketWebhookUser.Discord%23IGuildUser%23AddRolesAsync(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/dev/src/Discord.Net.WebSocket/Entities/Users/SocketWebhookUser.cs/#L89">View Source</a>
|
|
</span>
|
|
<a id="Discord_WebSocket_SocketWebhookUser_Discord_IGuildUser_AddRolesAsync_" data-uid="Discord.WebSocket.SocketWebhookUser.Discord#IGuildUser#AddRolesAsync*"></a>
|
|
<h4 id="Discord_WebSocket_SocketWebhookUser_Discord_IGuildUser_AddRolesAsync_System_Collections_Generic_IEnumerable_Discord_IRole__Discord_RequestOptions_" data-uid="Discord.WebSocket.SocketWebhookUser.Discord#IGuildUser#AddRolesAsync(System.Collections.Generic.IEnumerable{Discord.IRole},Discord.RequestOptions)">IGuildUser.AddRolesAsync(IEnumerable<IRole>, 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">Task IGuildUser.AddRolesAsync(IEnumerable<IRole> roles, RequestOptions options)</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><<a class="xref" href="Discord.IRole.html">IRole</a>></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>
|
|
<h5 class="exceptions">Exceptions</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Condition</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.NotSupportedException</span></td>
|
|
<td><p>Roles are not supported on webhook users.</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/dev/apiSpec/new?filename=Discord_WebSocket_SocketWebhookUser_Discord_IGuildUser_GetPermissions_Discord_IGuildChannel_.md&value=---%0Auid%3A%20Discord.WebSocket.SocketWebhookUser.Discord%23IGuildUser%23GetPermissions(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/dev/src/Discord.Net.WebSocket/Entities/Users/SocketWebhookUser.cs/#L71">View Source</a>
|
|
</span>
|
|
<a id="Discord_WebSocket_SocketWebhookUser_Discord_IGuildUser_GetPermissions_" data-uid="Discord.WebSocket.SocketWebhookUser.Discord#IGuildUser#GetPermissions*"></a>
|
|
<h4 id="Discord_WebSocket_SocketWebhookUser_Discord_IGuildUser_GetPermissions_Discord_IGuildChannel_" data-uid="Discord.WebSocket.SocketWebhookUser.Discord#IGuildUser#GetPermissions(Discord.IGuildChannel)">IGuildUser.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">ChannelPermissions IGuildUser.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/dev/apiSpec/new?filename=Discord_WebSocket_SocketWebhookUser_Discord_IGuildUser_Guild.md&value=---%0Auid%3A%20Discord.WebSocket.SocketWebhookUser.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/dev/src/Discord.Net.WebSocket/Entities/Users/SocketWebhookUser.cs/#L56">View Source</a>
|
|
</span>
|
|
<a id="Discord_WebSocket_SocketWebhookUser_Discord_IGuildUser_Guild_" data-uid="Discord.WebSocket.SocketWebhookUser.Discord#IGuildUser#Guild*"></a>
|
|
<h4 id="Discord_WebSocket_SocketWebhookUser_Discord_IGuildUser_Guild" data-uid="Discord.WebSocket.SocketWebhookUser.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/dev/apiSpec/new?filename=Discord_WebSocket_SocketWebhookUser_Discord_IGuildUser_GuildId.md&value=---%0Auid%3A%20Discord.WebSocket.SocketWebhookUser.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/dev/src/Discord.Net.WebSocket/Entities/Users/SocketWebhookUser.cs/#L58">View Source</a>
|
|
</span>
|
|
<a id="Discord_WebSocket_SocketWebhookUser_Discord_IGuildUser_GuildId_" data-uid="Discord.WebSocket.SocketWebhookUser.Discord#IGuildUser#GuildId*"></a>
|
|
<h4 id="Discord_WebSocket_SocketWebhookUser_Discord_IGuildUser_GuildId" data-uid="Discord.WebSocket.SocketWebhookUser.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/dev/apiSpec/new?filename=Discord_WebSocket_SocketWebhookUser_Discord_IGuildUser_GuildPermissions.md&value=---%0Auid%3A%20Discord.WebSocket.SocketWebhookUser.Discord%23IGuildUser%23GuildPermissions%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/goaaats/Discord.Net/blob/dev/src/Discord.Net.WebSocket/Entities/Users/SocketWebhookUser.cs/#L68">View Source</a>
|
|
</span>
|
|
<a id="Discord_WebSocket_SocketWebhookUser_Discord_IGuildUser_GuildPermissions_" data-uid="Discord.WebSocket.SocketWebhookUser.Discord#IGuildUser#GuildPermissions*"></a>
|
|
<h4 id="Discord_WebSocket_SocketWebhookUser_Discord_IGuildUser_GuildPermissions" data-uid="Discord.WebSocket.SocketWebhookUser.Discord#IGuildUser#GuildPermissions">IGuildUser.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">GuildPermissions IGuildUser.GuildPermissions { 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.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/dev/apiSpec/new?filename=Discord_WebSocket_SocketWebhookUser_Discord_IGuildUser_JoinedAt.md&value=---%0Auid%3A%20Discord.WebSocket.SocketWebhookUser.Discord%23IGuildUser%23JoinedAt%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/goaaats/Discord.Net/blob/dev/src/Discord.Net.WebSocket/Entities/Users/SocketWebhookUser.cs/#L62">View Source</a>
|
|
</span>
|
|
<a id="Discord_WebSocket_SocketWebhookUser_Discord_IGuildUser_JoinedAt_" data-uid="Discord.WebSocket.SocketWebhookUser.Discord#IGuildUser#JoinedAt*"></a>
|
|
<h4 id="Discord_WebSocket_SocketWebhookUser_Discord_IGuildUser_JoinedAt" data-uid="Discord.WebSocket.SocketWebhookUser.Discord#IGuildUser#JoinedAt">IGuildUser.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">DateTimeOffset? IGuildUser.JoinedAt { 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.Nullable</span><<span class="xref">System.DateTimeOffset</span>></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/dev/apiSpec/new?filename=Discord_WebSocket_SocketWebhookUser_Discord_IGuildUser_KickAsync_System_String_Discord_RequestOptions_.md&value=---%0Auid%3A%20Discord.WebSocket.SocketWebhookUser.Discord%23IGuildUser%23KickAsync(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/dev/src/Discord.Net.WebSocket/Entities/Users/SocketWebhookUser.cs/#L74">View Source</a>
|
|
</span>
|
|
<a id="Discord_WebSocket_SocketWebhookUser_Discord_IGuildUser_KickAsync_" data-uid="Discord.WebSocket.SocketWebhookUser.Discord#IGuildUser#KickAsync*"></a>
|
|
<h4 id="Discord_WebSocket_SocketWebhookUser_Discord_IGuildUser_KickAsync_System_String_Discord_RequestOptions_" data-uid="Discord.WebSocket.SocketWebhookUser.Discord#IGuildUser#KickAsync(System.String,Discord.RequestOptions)">IGuildUser.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">Task IGuildUser.KickAsync(string reason, RequestOptions options)</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>
|
|
<h5 class="exceptions">Exceptions</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Condition</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.NotSupportedException</span></td>
|
|
<td><p>Webhook users cannot be kicked.</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/dev/apiSpec/new?filename=Discord_WebSocket_SocketWebhookUser_Discord_IGuildUser_ModifyAsync_System_Action_Discord_GuildUserProperties__Discord_RequestOptions_.md&value=---%0Auid%3A%20Discord.WebSocket.SocketWebhookUser.Discord%23IGuildUser%23ModifyAsync(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/dev/src/Discord.Net.WebSocket/Entities/Users/SocketWebhookUser.cs/#L79">View Source</a>
|
|
</span>
|
|
<a id="Discord_WebSocket_SocketWebhookUser_Discord_IGuildUser_ModifyAsync_" data-uid="Discord.WebSocket.SocketWebhookUser.Discord#IGuildUser#ModifyAsync*"></a>
|
|
<h4 id="Discord_WebSocket_SocketWebhookUser_Discord_IGuildUser_ModifyAsync_System_Action_Discord_GuildUserProperties__Discord_RequestOptions_" data-uid="Discord.WebSocket.SocketWebhookUser.Discord#IGuildUser#ModifyAsync(System.Action{Discord.GuildUserProperties},Discord.RequestOptions)">IGuildUser.ModifyAsync(Action<GuildUserProperties>, 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">Task IGuildUser.ModifyAsync(Action<GuildUserProperties> func, RequestOptions options)</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><<a class="xref" href="Discord.GuildUserProperties.html">GuildUserProperties</a>></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_SocketWebhookUser_Discord_IGuildUser_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>
|
|
<h5 class="exceptions">Exceptions</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Condition</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.NotSupportedException</span></td>
|
|
<td><p>Webhook users cannot be modified.</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/dev/apiSpec/new?filename=Discord_WebSocket_SocketWebhookUser_Discord_IGuildUser_Nickname.md&value=---%0Auid%3A%20Discord.WebSocket.SocketWebhookUser.Discord%23IGuildUser%23Nickname%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/goaaats/Discord.Net/blob/dev/src/Discord.Net.WebSocket/Entities/Users/SocketWebhookUser.cs/#L64">View Source</a>
|
|
</span>
|
|
<a id="Discord_WebSocket_SocketWebhookUser_Discord_IGuildUser_Nickname_" data-uid="Discord.WebSocket.SocketWebhookUser.Discord#IGuildUser#Nickname*"></a>
|
|
<h4 id="Discord_WebSocket_SocketWebhookUser_Discord_IGuildUser_Nickname" data-uid="Discord.WebSocket.SocketWebhookUser.Discord#IGuildUser#Nickname">IGuildUser.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">string IGuildUser.Nickname { 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><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/dev/apiSpec/new?filename=Discord_WebSocket_SocketWebhookUser_Discord_IGuildUser_PremiumSince.md&value=---%0Auid%3A%20Discord.WebSocket.SocketWebhookUser.Discord%23IGuildUser%23PremiumSince%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/goaaats/Discord.Net/blob/dev/src/Discord.Net.WebSocket/Entities/Users/SocketWebhookUser.cs/#L66">View Source</a>
|
|
</span>
|
|
<a id="Discord_WebSocket_SocketWebhookUser_Discord_IGuildUser_PremiumSince_" data-uid="Discord.WebSocket.SocketWebhookUser.Discord#IGuildUser#PremiumSince*"></a>
|
|
<h4 id="Discord_WebSocket_SocketWebhookUser_Discord_IGuildUser_PremiumSince" data-uid="Discord.WebSocket.SocketWebhookUser.Discord#IGuildUser#PremiumSince">IGuildUser.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">DateTimeOffset? IGuildUser.PremiumSince { 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.Nullable</span><<span class="xref">System.DateTimeOffset</span>></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/dev/apiSpec/new?filename=Discord_WebSocket_SocketWebhookUser_Discord_IGuildUser_RemoveRoleAsync_Discord_IRole_Discord_RequestOptions_.md&value=---%0Auid%3A%20Discord.WebSocket.SocketWebhookUser.Discord%23IGuildUser%23RemoveRoleAsync(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/dev/src/Discord.Net.WebSocket/Entities/Users/SocketWebhookUser.cs/#L94">View Source</a>
|
|
</span>
|
|
<a id="Discord_WebSocket_SocketWebhookUser_Discord_IGuildUser_RemoveRoleAsync_" data-uid="Discord.WebSocket.SocketWebhookUser.Discord#IGuildUser#RemoveRoleAsync*"></a>
|
|
<h4 id="Discord_WebSocket_SocketWebhookUser_Discord_IGuildUser_RemoveRoleAsync_Discord_IRole_Discord_RequestOptions_" data-uid="Discord.WebSocket.SocketWebhookUser.Discord#IGuildUser#RemoveRoleAsync(Discord.IRole,Discord.RequestOptions)">IGuildUser.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">Task IGuildUser.RemoveRoleAsync(IRole role, RequestOptions options)</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>
|
|
<h5 class="exceptions">Exceptions</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Condition</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.NotSupportedException</span></td>
|
|
<td><p>Roles are not supported on webhook users.</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/dev/apiSpec/new?filename=Discord_WebSocket_SocketWebhookUser_Discord_IGuildUser_RemoveRolesAsync_System_Collections_Generic_IEnumerable_Discord_IRole__Discord_RequestOptions_.md&value=---%0Auid%3A%20Discord.WebSocket.SocketWebhookUser.Discord%23IGuildUser%23RemoveRolesAsync(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/dev/src/Discord.Net.WebSocket/Entities/Users/SocketWebhookUser.cs/#L99">View Source</a>
|
|
</span>
|
|
<a id="Discord_WebSocket_SocketWebhookUser_Discord_IGuildUser_RemoveRolesAsync_" data-uid="Discord.WebSocket.SocketWebhookUser.Discord#IGuildUser#RemoveRolesAsync*"></a>
|
|
<h4 id="Discord_WebSocket_SocketWebhookUser_Discord_IGuildUser_RemoveRolesAsync_System_Collections_Generic_IEnumerable_Discord_IRole__Discord_RequestOptions_" data-uid="Discord.WebSocket.SocketWebhookUser.Discord#IGuildUser#RemoveRolesAsync(System.Collections.Generic.IEnumerable{Discord.IRole},Discord.RequestOptions)">IGuildUser.RemoveRolesAsync(IEnumerable<IRole>, 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">Task IGuildUser.RemoveRolesAsync(IEnumerable<IRole> roles, RequestOptions options)</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><<a class="xref" href="Discord.IRole.html">IRole</a>></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>
|
|
<h5 class="exceptions">Exceptions</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Condition</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.NotSupportedException</span></td>
|
|
<td><p>Roles are not supported on webhook users.</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/dev/apiSpec/new?filename=Discord_WebSocket_SocketWebhookUser_Discord_IGuildUser_RoleIds.md&value=---%0Auid%3A%20Discord.WebSocket.SocketWebhookUser.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/dev/src/Discord.Net.WebSocket/Entities/Users/SocketWebhookUser.cs/#L60">View Source</a>
|
|
</span>
|
|
<a id="Discord_WebSocket_SocketWebhookUser_Discord_IGuildUser_RoleIds_" data-uid="Discord.WebSocket.SocketWebhookUser.Discord#IGuildUser#RoleIds*"></a>
|
|
<h4 id="Discord_WebSocket_SocketWebhookUser_Discord_IGuildUser_RoleIds" data-uid="Discord.WebSocket.SocketWebhookUser.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<ulong> 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><<span class="xref">System.UInt64</span>></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_SocketWebhookUser_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/dev/apiSpec/new?filename=Discord_WebSocket_SocketWebhookUser_Discord_IVoiceState_IsDeafened.md&value=---%0Auid%3A%20Discord.WebSocket.SocketWebhookUser.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/dev/src/Discord.Net.WebSocket/Entities/Users/SocketWebhookUser.cs/#L104">View Source</a>
|
|
</span>
|
|
<a id="Discord_WebSocket_SocketWebhookUser_Discord_IVoiceState_IsDeafened_" data-uid="Discord.WebSocket.SocketWebhookUser.Discord#IVoiceState#IsDeafened*"></a>
|
|
<h4 id="Discord_WebSocket_SocketWebhookUser_Discord_IVoiceState_IsDeafened" data-uid="Discord.WebSocket.SocketWebhookUser.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/dev/apiSpec/new?filename=Discord_WebSocket_SocketWebhookUser_Discord_IVoiceState_IsMuted.md&value=---%0Auid%3A%20Discord.WebSocket.SocketWebhookUser.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/dev/src/Discord.Net.WebSocket/Entities/Users/SocketWebhookUser.cs/#L106">View Source</a>
|
|
</span>
|
|
<a id="Discord_WebSocket_SocketWebhookUser_Discord_IVoiceState_IsMuted_" data-uid="Discord.WebSocket.SocketWebhookUser.Discord#IVoiceState#IsMuted*"></a>
|
|
<h4 id="Discord_WebSocket_SocketWebhookUser_Discord_IVoiceState_IsMuted" data-uid="Discord.WebSocket.SocketWebhookUser.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/dev/apiSpec/new?filename=Discord_WebSocket_SocketWebhookUser_Discord_IVoiceState_IsSelfDeafened.md&value=---%0Auid%3A%20Discord.WebSocket.SocketWebhookUser.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/dev/src/Discord.Net.WebSocket/Entities/Users/SocketWebhookUser.cs/#L108">View Source</a>
|
|
</span>
|
|
<a id="Discord_WebSocket_SocketWebhookUser_Discord_IVoiceState_IsSelfDeafened_" data-uid="Discord.WebSocket.SocketWebhookUser.Discord#IVoiceState#IsSelfDeafened*"></a>
|
|
<h4 id="Discord_WebSocket_SocketWebhookUser_Discord_IVoiceState_IsSelfDeafened" data-uid="Discord.WebSocket.SocketWebhookUser.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/dev/apiSpec/new?filename=Discord_WebSocket_SocketWebhookUser_Discord_IVoiceState_IsSelfMuted.md&value=---%0Auid%3A%20Discord.WebSocket.SocketWebhookUser.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/dev/src/Discord.Net.WebSocket/Entities/Users/SocketWebhookUser.cs/#L110">View Source</a>
|
|
</span>
|
|
<a id="Discord_WebSocket_SocketWebhookUser_Discord_IVoiceState_IsSelfMuted_" data-uid="Discord.WebSocket.SocketWebhookUser.Discord#IVoiceState#IsSelfMuted*"></a>
|
|
<h4 id="Discord_WebSocket_SocketWebhookUser_Discord_IVoiceState_IsSelfMuted" data-uid="Discord.WebSocket.SocketWebhookUser.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/dev/apiSpec/new?filename=Discord_WebSocket_SocketWebhookUser_Discord_IVoiceState_IsStreaming.md&value=---%0Auid%3A%20Discord.WebSocket.SocketWebhookUser.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/dev/src/Discord.Net.WebSocket/Entities/Users/SocketWebhookUser.cs/#L118">View Source</a>
|
|
</span>
|
|
<a id="Discord_WebSocket_SocketWebhookUser_Discord_IVoiceState_IsStreaming_" data-uid="Discord.WebSocket.SocketWebhookUser.Discord#IVoiceState#IsStreaming*"></a>
|
|
<h4 id="Discord_WebSocket_SocketWebhookUser_Discord_IVoiceState_IsStreaming" data-uid="Discord.WebSocket.SocketWebhookUser.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/dev/apiSpec/new?filename=Discord_WebSocket_SocketWebhookUser_Discord_IVoiceState_IsSuppressed.md&value=---%0Auid%3A%20Discord.WebSocket.SocketWebhookUser.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/dev/src/Discord.Net.WebSocket/Entities/Users/SocketWebhookUser.cs/#L112">View Source</a>
|
|
</span>
|
|
<a id="Discord_WebSocket_SocketWebhookUser_Discord_IVoiceState_IsSuppressed_" data-uid="Discord.WebSocket.SocketWebhookUser.Discord#IVoiceState#IsSuppressed*"></a>
|
|
<h4 id="Discord_WebSocket_SocketWebhookUser_Discord_IVoiceState_IsSuppressed" data-uid="Discord.WebSocket.SocketWebhookUser.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/dev/apiSpec/new?filename=Discord_WebSocket_SocketWebhookUser_Discord_IVoiceState_VoiceChannel.md&value=---%0Auid%3A%20Discord.WebSocket.SocketWebhookUser.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/dev/src/Discord.Net.WebSocket/Entities/Users/SocketWebhookUser.cs/#L114">View Source</a>
|
|
</span>
|
|
<a id="Discord_WebSocket_SocketWebhookUser_Discord_IVoiceState_VoiceChannel_" data-uid="Discord.WebSocket.SocketWebhookUser.Discord#IVoiceState#VoiceChannel*"></a>
|
|
<h4 id="Discord_WebSocket_SocketWebhookUser_Discord_IVoiceState_VoiceChannel" data-uid="Discord.WebSocket.SocketWebhookUser.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/dev/apiSpec/new?filename=Discord_WebSocket_SocketWebhookUser_Discord_IVoiceState_VoiceSessionId.md&value=---%0Auid%3A%20Discord.WebSocket.SocketWebhookUser.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/dev/src/Discord.Net.WebSocket/Entities/Users/SocketWebhookUser.cs/#L116">View Source</a>
|
|
</span>
|
|
<a id="Discord_WebSocket_SocketWebhookUser_Discord_IVoiceState_VoiceSessionId_" data-uid="Discord.WebSocket.SocketWebhookUser.Discord#IVoiceState#VoiceSessionId*"></a>
|
|
<h4 id="Discord_WebSocket_SocketWebhookUser_Discord_IVoiceState_VoiceSessionId" data-uid="Discord.WebSocket.SocketWebhookUser.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.IWebhookUser.html">IWebhookUser</a>
|
|
</div>
|
|
<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<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/dev/apiSpec/new?filename=Discord_WebSocket_SocketWebhookUser.md&value=---%0Auid%3A%20Discord.WebSocket.SocketWebhookUser%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" class="contribution-link">Improve this Doc</a>
|
|
</li>
|
|
<li>
|
|
<a href="https://github.com/goaaats/Discord.Net/blob/dev/src/Discord.Net.WebSocket/Entities/Users/SocketWebhookUser.cs/#L13" 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>
|