mirror of
https://github.com/goatcorp/Dalamud.git
synced 2025-12-12 10:17:22 +01:00
644 lines
32 KiB
HTML
644 lines
32 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 SocketSelfUser
|
|
</title>
|
|
<meta name="viewport" content="width=device-width">
|
|
<meta name="title" content="Class SocketSelfUser
|
|
">
|
|
<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.SocketSelfUser">
|
|
|
|
|
|
<h1 id="Discord_WebSocket_SocketSelfUser" data-uid="Discord.WebSocket.SocketSelfUser" class="text-break">Class SocketSelfUser
|
|
</h1>
|
|
<div class="markdown level0 summary"><p>Represents the logged-in WebSocket-based 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">SocketSelfUser</span></div>
|
|
</div>
|
|
<div classs="implements">
|
|
<h5>Implements</h5>
|
|
<div><a class="xref" href="Discord.ISelfUser.html">ISelfUser</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>
|
|
<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_SocketSelfUser_syntax">Syntax</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public class SocketSelfUser : SocketUser, ISelfUser, IUser, ISnowflakeEntity, IEntity<ulong>, IMentionable, IPresence</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_SocketSelfUser_AvatarId.md&value=---%0Auid%3A%20Discord.WebSocket.SocketSelfUser.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/SocketSelfUser.cs/#L30">View Source</a>
|
|
</span>
|
|
<a id="Discord_WebSocket_SocketSelfUser_AvatarId_" data-uid="Discord.WebSocket.SocketSelfUser.AvatarId*"></a>
|
|
<h4 id="Discord_WebSocket_SocketSelfUser_AvatarId" data-uid="Discord.WebSocket.SocketSelfUser.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_SocketSelfUser_DiscriminatorValue.md&value=---%0Auid%3A%20Discord.WebSocket.SocketSelfUser.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/SocketSelfUser.cs/#L28">View Source</a>
|
|
</span>
|
|
<a id="Discord_WebSocket_SocketSelfUser_DiscriminatorValue_" data-uid="Discord.WebSocket.SocketSelfUser.DiscriminatorValue*"></a>
|
|
<h4 id="Discord_WebSocket_SocketSelfUser_DiscriminatorValue" data-uid="Discord.WebSocket.SocketSelfUser.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_SocketSelfUser_Email.md&value=---%0Auid%3A%20Discord.WebSocket.SocketSelfUser.Email%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/SocketSelfUser.cs/#L16">View Source</a>
|
|
</span>
|
|
<a id="Discord_WebSocket_SocketSelfUser_Email_" data-uid="Discord.WebSocket.SocketSelfUser.Email*"></a>
|
|
<h4 id="Discord_WebSocket_SocketSelfUser_Email" data-uid="Discord.WebSocket.SocketSelfUser.Email">Email</h4>
|
|
<div class="markdown level1 summary"><p>Gets the email associated with this user.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public string Email { get; }</code></pre>
|
|
</div>
|
|
<h5 class="propertyValue">Property Value</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.String</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/goaaats/Discord.Net/new/dev/apiSpec/new?filename=Discord_WebSocket_SocketSelfUser_Flags.md&value=---%0Auid%3A%20Discord.WebSocket.SocketSelfUser.Flags%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/SocketSelfUser.cs/#L34">View Source</a>
|
|
</span>
|
|
<a id="Discord_WebSocket_SocketSelfUser_Flags_" data-uid="Discord.WebSocket.SocketSelfUser.Flags*"></a>
|
|
<h4 id="Discord_WebSocket_SocketSelfUser_Flags" data-uid="Discord.WebSocket.SocketSelfUser.Flags">Flags</h4>
|
|
<div class="markdown level1 summary"><p>Gets the flags that are applied to a user's account.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public UserProperties Flags { 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.UserProperties.html">UserProperties</a></td>
|
|
<td><p>The value of flags for this user.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 id="Discord_WebSocket_SocketSelfUser_Flags_remarks">Remarks</h5>
|
|
<div class="markdown level1 remarks"><p>This value is determined by bitwise OR-ing <a class="xref" href="Discord.UserProperties.html">UserProperties</a> values together.</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_SocketSelfUser_IsBot.md&value=---%0Auid%3A%20Discord.WebSocket.SocketSelfUser.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/SocketSelfUser.cs/#L24">View Source</a>
|
|
</span>
|
|
<a id="Discord_WebSocket_SocketSelfUser_IsBot_" data-uid="Discord.WebSocket.SocketSelfUser.IsBot*"></a>
|
|
<h4 id="Discord_WebSocket_SocketSelfUser_IsBot" data-uid="Discord.WebSocket.SocketSelfUser.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_SocketSelfUser_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_SocketSelfUser_IsMfaEnabled.md&value=---%0Auid%3A%20Discord.WebSocket.SocketSelfUser.IsMfaEnabled%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/SocketSelfUser.cs/#L20">View Source</a>
|
|
</span>
|
|
<a id="Discord_WebSocket_SocketSelfUser_IsMfaEnabled_" data-uid="Discord.WebSocket.SocketSelfUser.IsMfaEnabled*"></a>
|
|
<h4 id="Discord_WebSocket_SocketSelfUser_IsMfaEnabled" data-uid="Discord.WebSocket.SocketSelfUser.IsMfaEnabled">IsMfaEnabled</h4>
|
|
<div class="markdown level1 summary"><p>Indicates whether or not this user has MFA enabled on their account.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public bool IsMfaEnabled { get; }</code></pre>
|
|
</div>
|
|
<h5 class="propertyValue">Property Value</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Boolean</span></td>
|
|
<td><p><code>true</code> if this user has enabled multi-factor authentication on their account; <code>false</code> if not.</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_SocketSelfUser_IsVerified.md&value=---%0Auid%3A%20Discord.WebSocket.SocketSelfUser.IsVerified%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/SocketSelfUser.cs/#L18">View Source</a>
|
|
</span>
|
|
<a id="Discord_WebSocket_SocketSelfUser_IsVerified_" data-uid="Discord.WebSocket.SocketSelfUser.IsVerified*"></a>
|
|
<h4 id="Discord_WebSocket_SocketSelfUser_IsVerified" data-uid="Discord.WebSocket.SocketSelfUser.IsVerified">IsVerified</h4>
|
|
<div class="markdown level1 summary"><p>Indicates whether or not this user has their email verified.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public bool IsVerified { get; }</code></pre>
|
|
</div>
|
|
<h5 class="propertyValue">Property Value</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Boolean</span></td>
|
|
<td><p><code>true</code> if this user's email has been verified; <code>false</code> if not.</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_SocketSelfUser_IsWebhook.md&value=---%0Auid%3A%20Discord.WebSocket.SocketSelfUser.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/SocketSelfUser.cs/#L41">View Source</a>
|
|
</span>
|
|
<a id="Discord_WebSocket_SocketSelfUser_IsWebhook_" data-uid="Discord.WebSocket.SocketSelfUser.IsWebhook*"></a>
|
|
<h4 id="Discord_WebSocket_SocketSelfUser_IsWebhook" data-uid="Discord.WebSocket.SocketSelfUser.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_SocketSelfUser_Locale.md&value=---%0Auid%3A%20Discord.WebSocket.SocketSelfUser.Locale%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/SocketSelfUser.cs/#L38">View Source</a>
|
|
</span>
|
|
<a id="Discord_WebSocket_SocketSelfUser_Locale_" data-uid="Discord.WebSocket.SocketSelfUser.Locale*"></a>
|
|
<h4 id="Discord_WebSocket_SocketSelfUser_Locale" data-uid="Discord.WebSocket.SocketSelfUser.Locale">Locale</h4>
|
|
<div class="markdown level1 summary"><p>Gets the user's chosen language option.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public string Locale { get; }</code></pre>
|
|
</div>
|
|
<h5 class="propertyValue">Property Value</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.String</span></td>
|
|
<td><p>The IETF language tag of the user's chosen region, if provided.
|
|
For example, a locale of "English, US" is "en-US", "Chinese (Taiwan)" is "zh-TW", etc.</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_SocketSelfUser_PremiumType.md&value=---%0Auid%3A%20Discord.WebSocket.SocketSelfUser.PremiumType%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/SocketSelfUser.cs/#L36">View Source</a>
|
|
</span>
|
|
<a id="Discord_WebSocket_SocketSelfUser_PremiumType_" data-uid="Discord.WebSocket.SocketSelfUser.PremiumType*"></a>
|
|
<h4 id="Discord_WebSocket_SocketSelfUser_PremiumType" data-uid="Discord.WebSocket.SocketSelfUser.PremiumType">PremiumType</h4>
|
|
<div class="markdown level1 summary"><p>Gets the type of Nitro subscription that is active on this user's account.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public PremiumType PremiumType { 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.PremiumType.html">PremiumType</a></td>
|
|
<td><p>The type of Nitro subscription the user subscribes to, if any.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 id="Discord_WebSocket_SocketSelfUser_PremiumType_remarks">Remarks</h5>
|
|
<div class="markdown level1 remarks"><p>This information may only be available with the identify OAuth scope.</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_SocketSelfUser_Username.md&value=---%0Auid%3A%20Discord.WebSocket.SocketSelfUser.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/SocketSelfUser.cs/#L26">View Source</a>
|
|
</span>
|
|
<a id="Discord_WebSocket_SocketSelfUser_Username_" data-uid="Discord.WebSocket.SocketSelfUser.Username*"></a>
|
|
<h4 id="Discord_WebSocket_SocketSelfUser_Username" data-uid="Discord.WebSocket.SocketSelfUser.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="methods">Methods
|
|
</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_SocketSelfUser_ModifyAsync_System_Action_Discord_SelfUserProperties__Discord_RequestOptions_.md&value=---%0Auid%3A%20Discord.WebSocket.SocketSelfUser.ModifyAsync(System.Action%7BDiscord.SelfUserProperties%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/SocketSelfUser.cs/#L91">View Source</a>
|
|
</span>
|
|
<a id="Discord_WebSocket_SocketSelfUser_ModifyAsync_" data-uid="Discord.WebSocket.SocketSelfUser.ModifyAsync*"></a>
|
|
<h4 id="Discord_WebSocket_SocketSelfUser_ModifyAsync_System_Action_Discord_SelfUserProperties__Discord_RequestOptions_" data-uid="Discord.WebSocket.SocketSelfUser.ModifyAsync(System.Action{Discord.SelfUserProperties},Discord.RequestOptions)">ModifyAsync(Action<SelfUserProperties>, RequestOptions)</h4>
|
|
<div class="markdown level1 summary"><p>Modifies the user's properties.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public Task ModifyAsync(Action<SelfUserProperties> func, RequestOptions options = null)</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Action</span><<a class="xref" href="Discord.SelfUserProperties.html">SelfUserProperties</a>></td>
|
|
<td><span class="parametername">func</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
|
<td><span class="parametername">options</span></td>
|
|
<td></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></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="implements">Implements</h3>
|
|
<div>
|
|
<a class="xref" href="Discord.ISelfUser.html">ISelfUser</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>
|
|
</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_SocketSelfUser.md&value=---%0Auid%3A%20Discord.WebSocket.SocketSelfUser%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/SocketSelfUser.cs/#L12" 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>
|