Dalamud/docs/api/Discord.Rest.RestUser.html
2020-03-24 03:22:08 +09:00

835 lines
40 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 RestUser
</title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class RestUser
">
<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.Rest.RestUser">
<h1 id="Discord_Rest_RestUser" data-uid="Discord.Rest.RestUser" class="text-break">Class RestUser
</h1>
<div class="markdown level0 summary"><p>Represents a REST-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.Rest.RestEntity-1.html">RestEntity</a>&lt;<span class="xref">System.UInt64</span>&gt;</div>
<div class="level2"><span class="xref">RestUser</span></div>
<div class="level3"><a class="xref" href="Discord.Rest.RestGroupUser.html">RestGroupUser</a></div>
<div class="level3"><a class="xref" href="Discord.Rest.RestGuildUser.html">RestGuildUser</a></div>
<div class="level3"><a class="xref" href="Discord.Rest.RestSelfUser.html">RestSelfUser</a></div>
<div class="level3"><a class="xref" href="Discord.Rest.RestWebhookUser.html">RestWebhookUser</a></div>
</div>
<div classs="implements">
<h5>Implements</h5>
<div><a class="xref" href="Discord.IUser.html">IUser</a></div>
<div><a class="xref" href="Discord.ISnowflakeEntity.html">ISnowflakeEntity</a></div>
<div><a class="xref" href="Discord.IEntity-1.html">IEntity</a>&lt;<span class="xref">System.UInt64</span>&gt;</div>
<div><a class="xref" href="Discord.IMentionable.html">IMentionable</a></div>
<div><a class="xref" href="Discord.IPresence.html">IPresence</a></div>
<div><a class="xref" href="Discord.IUpdateable.html">IUpdateable</a></div>
</div>
<div class="inheritedMembers">
<h5>Inherited Members</h5>
<div>
<a class="xref" href="Discord.Rest.RestEntity-1.html#Discord_Rest_RestEntity_1_Id">RestEntity&lt;UInt64&gt;.Id</a>
</div>
<div>
<span class="xref">System.Object.Equals(System.Object)</span>
</div>
<div>
<span class="xref">System.Object.Equals(System.Object, System.Object)</span>
</div>
<div>
<span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
</div>
<div>
<span class="xref">System.Object.GetHashCode()</span>
</div>
<div>
<span class="xref">System.Object.GetType()</span>
</div>
<div>
<span class="xref">System.Object.MemberwiseClone()</span>
</div>
</div>
<h6><strong>Namespace</strong>: <a class="xref" href="Discord.Rest.html">Discord.Rest</a></h6>
<h6><strong>Assembly</strong>: Discord.Net.Rest.dll</h6>
<h5 id="Discord_Rest_RestUser_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class RestUser : RestEntity&lt;ulong&gt;, IUser, ISnowflakeEntity, IEntity&lt;ulong&gt;, IMentionable, IPresence, IUpdateable</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_Rest_RestUser_ActiveClients.md&amp;value=---%0Auid%3A%20Discord.Rest.RestUser.ActiveClients%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.Rest/Entities/Users/RestUser.cs/#L36">View Source</a>
</span>
<a id="Discord_Rest_RestUser_ActiveClients_" data-uid="Discord.Rest.RestUser.ActiveClients*"></a>
<h4 id="Discord_Rest_RestUser_ActiveClients" data-uid="Discord.Rest.RestUser.ActiveClients">ActiveClients</h4>
<div class="markdown level1 summary"><p>Gets the set of clients where this user is currently active.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public virtual IImmutableSet&lt;ClientType&gt; ActiveClients { get; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Collections.Immutable.IImmutableSet</span>&lt;<a class="xref" href="Discord.ClientType.html">ClientType</a>&gt;</td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goaaats/Discord.Net/new/dev/apiSpec/new?filename=Discord_Rest_RestUser_Activity.md&amp;value=---%0Auid%3A%20Discord.Rest.RestUser.Activity%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.Rest/Entities/Users/RestUser.cs/#L32">View Source</a>
</span>
<a id="Discord_Rest_RestUser_Activity_" data-uid="Discord.Rest.RestUser.Activity*"></a>
<h4 id="Discord_Rest_RestUser_Activity" data-uid="Discord.Rest.RestUser.Activity">Activity</h4>
<div class="markdown level1 summary"><p>Gets the activity this user is currently doing.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public virtual IActivity Activity { 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.IActivity.html">IActivity</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_Rest_RestUser_AvatarId.md&amp;value=---%0Auid%3A%20Discord.Rest.RestUser.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.Rest/Entities/Users/RestUser.cs/#L23">View Source</a>
</span>
<a id="Discord_Rest_RestUser_AvatarId_" data-uid="Discord.Rest.RestUser.AvatarId*"></a>
<h4 id="Discord_Rest_RestUser_AvatarId" data-uid="Discord.Rest.RestUser.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 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>
<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_Rest_RestUser_CreatedAt.md&amp;value=---%0Auid%3A%20Discord.Rest.RestUser.CreatedAt%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.Rest/Entities/Users/RestUser.cs/#L26">View Source</a>
</span>
<a id="Discord_Rest_RestUser_CreatedAt_" data-uid="Discord.Rest.RestUser.CreatedAt*"></a>
<h4 id="Discord_Rest_RestUser_CreatedAt" data-uid="Discord.Rest.RestUser.CreatedAt">CreatedAt</h4>
<div class="markdown level1 summary"><p>Gets when the snowflake was created.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public DateTimeOffset CreatedAt { 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.DateTimeOffset</span></td>
<td><p>A <span class="xref">System.DateTimeOffset</span> representing when the entity was first created.</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_Rest_RestUser_Discriminator.md&amp;value=---%0Auid%3A%20Discord.Rest.RestUser.Discriminator%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.Rest/Entities/Users/RestUser.cs/#L28">View Source</a>
</span>
<a id="Discord_Rest_RestUser_Discriminator_" data-uid="Discord.Rest.RestUser.Discriminator*"></a>
<h4 id="Discord_Rest_RestUser_Discriminator" data-uid="Discord.Rest.RestUser.Discriminator">Discriminator</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 string Discriminator { 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_Rest_RestUser_DiscriminatorValue.md&amp;value=---%0Auid%3A%20Discord.Rest.RestUser.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.Rest/Entities/Users/RestUser.cs/#L21">View Source</a>
</span>
<a id="Discord_Rest_RestUser_DiscriminatorValue_" data-uid="Discord.Rest.RestUser.DiscriminatorValue*"></a>
<h4 id="Discord_Rest_RestUser_DiscriminatorValue" data-uid="Discord.Rest.RestUser.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 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>
<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_Rest_RestUser_IsBot.md&amp;value=---%0Auid%3A%20Discord.Rest.RestUser.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.Rest/Entities/Users/RestUser.cs/#L17">View Source</a>
</span>
<a id="Discord_Rest_RestUser_IsBot_" data-uid="Discord.Rest.RestUser.IsBot*"></a>
<h4 id="Discord_Rest_RestUser_IsBot" data-uid="Discord.Rest.RestUser.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 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 id="Discord_Rest_RestUser_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_Rest_RestUser_IsWebhook.md&amp;value=---%0Auid%3A%20Discord.Rest.RestUser.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.Rest/Entities/Users/RestUser.cs/#L38">View Source</a>
</span>
<a id="Discord_Rest_RestUser_IsWebhook_" data-uid="Discord.Rest.RestUser.IsWebhook*"></a>
<h4 id="Discord_Rest_RestUser_IsWebhook" data-uid="Discord.Rest.RestUser.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 virtual 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>
<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_Rest_RestUser_Mention.md&amp;value=---%0Auid%3A%20Discord.Rest.RestUser.Mention%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.Rest/Entities/Users/RestUser.cs/#L30">View Source</a>
</span>
<a id="Discord_Rest_RestUser_Mention_" data-uid="Discord.Rest.RestUser.Mention*"></a>
<h4 id="Discord_Rest_RestUser_Mention" data-uid="Discord.Rest.RestUser.Mention">Mention</h4>
<div class="markdown level1 summary"><p>Returns a special string used to mention this object.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string Mention { get; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.String</span></td>
<td><p>A string that is recognized by Discord as a mention (e.g. &lt;@168693960628371456&gt;).</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_Rest_RestUser_Status.md&amp;value=---%0Auid%3A%20Discord.Rest.RestUser.Status%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.Rest/Entities/Users/RestUser.cs/#L34">View Source</a>
</span>
<a id="Discord_Rest_RestUser_Status_" data-uid="Discord.Rest.RestUser.Status*"></a>
<h4 id="Discord_Rest_RestUser_Status" data-uid="Discord.Rest.RestUser.Status">Status</h4>
<div class="markdown level1 summary"><p>Gets the current status of 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 virtual UserStatus Status { 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.UserStatus.html">UserStatus</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_Rest_RestUser_Username.md&amp;value=---%0Auid%3A%20Discord.Rest.RestUser.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.Rest/Entities/Users/RestUser.cs/#L19">View Source</a>
</span>
<a id="Discord_Rest_RestUser_Username_" data-uid="Discord.Rest.RestUser.Username*"></a>
<h4 id="Discord_Rest_RestUser_Username" data-uid="Discord.Rest.RestUser.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 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>
<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_Rest_RestUser_GetAvatarUrl_Discord_ImageFormat_System_UInt16_.md&amp;value=---%0Auid%3A%20Discord.Rest.RestUser.GetAvatarUrl(Discord.ImageFormat%2CSystem.UInt16)%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.Rest/Entities/Users/RestUser.cs/#L86">View Source</a>
</span>
<a id="Discord_Rest_RestUser_GetAvatarUrl_" data-uid="Discord.Rest.RestUser.GetAvatarUrl*"></a>
<h4 id="Discord_Rest_RestUser_GetAvatarUrl_Discord_ImageFormat_System_UInt16_" data-uid="Discord.Rest.RestUser.GetAvatarUrl(Discord.ImageFormat,System.UInt16)">GetAvatarUrl(ImageFormat, UInt16)</h4>
<div class="markdown level1 summary"><p>Gets the avatar URL for this user.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string GetAvatarUrl(ImageFormat format = ImageFormat.Auto, ushort size = 128)</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.ImageFormat.html">ImageFormat</a></td>
<td><span class="parametername">format</span></td>
<td><p>The format to return.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.UInt16</span></td>
<td><span class="parametername">size</span></td>
<td><p>The size of the image to return in. This can be any power of two between 16 and 2048.</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.String</span></td>
<td><p>A string representing the user's avatar URL; <code>null</code> if the user does not have an avatar in place.</p>
</td>
</tr>
</tbody>
</table>
<h5 id="Discord_Rest_RestUser_GetAvatarUrl_Discord_ImageFormat_System_UInt16__remarks">Remarks</h5>
<div class="markdown level1 remarks"><p>This property retrieves a URL for this user's avatar. In event that the user does not have a valid avatar
(i.e. their avatar identifier is not set), this property will return <code>null</code>. If you wish to
retrieve the default avatar for this user, consider using <a class="xref" href="Discord.IUser.html#Discord_IUser_GetDefaultAvatarUrl">GetDefaultAvatarUrl()</a> (see
example).</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_Rest_RestUser_GetDefaultAvatarUrl.md&amp;value=---%0Auid%3A%20Discord.Rest.RestUser.GetDefaultAvatarUrl%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.Rest/Entities/Users/RestUser.cs/#L90">View Source</a>
</span>
<a id="Discord_Rest_RestUser_GetDefaultAvatarUrl_" data-uid="Discord.Rest.RestUser.GetDefaultAvatarUrl*"></a>
<h4 id="Discord_Rest_RestUser_GetDefaultAvatarUrl" data-uid="Discord.Rest.RestUser.GetDefaultAvatarUrl">GetDefaultAvatarUrl()</h4>
<div class="markdown level1 summary"><p>Gets the default avatar URL for this user.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string GetDefaultAvatarUrl()</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 user's avatar URL.</p>
</td>
</tr>
</tbody>
</table>
<h5 id="Discord_Rest_RestUser_GetDefaultAvatarUrl_remarks">Remarks</h5>
<div class="markdown level1 remarks"><p>This property retrieves a URL for this user's default avatar generated by Discord (Discord logo followed
by a random color as its background). This property will always return a value as it is calculated based
on the user's <a class="xref" href="Discord.IUser.html#Discord_IUser_DiscriminatorValue">DiscriminatorValue</a> (<code>discriminator % 5</code>).</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_Rest_RestUser_GetOrCreateDMChannelAsync_Discord_RequestOptions_.md&amp;value=---%0Auid%3A%20Discord.Rest.RestUser.GetOrCreateDMChannelAsync(Discord.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.Rest/Entities/Users/RestUser.cs/#L82">View Source</a>
</span>
<a id="Discord_Rest_RestUser_GetOrCreateDMChannelAsync_" data-uid="Discord.Rest.RestUser.GetOrCreateDMChannelAsync*"></a>
<h4 id="Discord_Rest_RestUser_GetOrCreateDMChannelAsync_Discord_RequestOptions_" data-uid="Discord.Rest.RestUser.GetOrCreateDMChannelAsync(Discord.RequestOptions)">GetOrCreateDMChannelAsync(RequestOptions)</h4>
<div class="markdown level1 summary"><p>Returns a direct message channel to this user, or create one if it does not already exist.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Task&lt;RestDMChannel&gt; GetOrCreateDMChannelAsync(RequestOptions options = null)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Discord.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>&lt;<a class="xref" href="Discord.Rest.RestDMChannel.html">RestDMChannel</a>&gt;</td>
<td><p>A task that represents the asynchronous get operation. The task result contains a rest DM channel where the user is the recipient.</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_Rest_RestUser_ToString.md&amp;value=---%0Auid%3A%20Discord.Rest.RestUser.ToString%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.Rest/Entities/Users/RestUser.cs/#L99">View Source</a>
</span>
<a id="Discord_Rest_RestUser_ToString_" data-uid="Discord.Rest.RestUser.ToString*"></a>
<h4 id="Discord_Rest_RestUser_ToString" data-uid="Discord.Rest.RestUser.ToString">ToString()</h4>
<div class="markdown level1 summary"><p>Gets the Username#Discriminator of the user.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public override string ToString()</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 that resolves to Username#Discriminator of the user.</p>
</td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><span class="xref">System.Object.ToString()</span></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_Rest_RestUser_UpdateAsync_Discord_RequestOptions_.md&amp;value=---%0Auid%3A%20Discord.Rest.RestUser.UpdateAsync(Discord.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.Rest/Entities/Users/RestUser.cs/#L69">View Source</a>
</span>
<a id="Discord_Rest_RestUser_UpdateAsync_" data-uid="Discord.Rest.RestUser.UpdateAsync*"></a>
<h4 id="Discord_Rest_RestUser_UpdateAsync_Discord_RequestOptions_" data-uid="Discord.Rest.RestUser.UpdateAsync(Discord.RequestOptions)">UpdateAsync(RequestOptions)</h4>
<div class="markdown level1 summary"><p>Updates this object's properties with its current state.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public virtual Task UpdateAsync(RequestOptions options = null)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Discord.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="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_Rest_RestUser_Discord_IUser_GetOrCreateDMChannelAsync_Discord_RequestOptions_.md&amp;value=---%0Auid%3A%20Discord.Rest.RestUser.Discord%23IUser%23GetOrCreateDMChannelAsync(Discord.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.Rest/Entities/Users/RestUser.cs/#L104">View Source</a>
</span>
<a id="Discord_Rest_RestUser_Discord_IUser_GetOrCreateDMChannelAsync_" data-uid="Discord.Rest.RestUser.Discord#IUser#GetOrCreateDMChannelAsync*"></a>
<h4 id="Discord_Rest_RestUser_Discord_IUser_GetOrCreateDMChannelAsync_Discord_RequestOptions_" data-uid="Discord.Rest.RestUser.Discord#IUser#GetOrCreateDMChannelAsync(Discord.RequestOptions)">IUser.GetOrCreateDMChannelAsync(RequestOptions)</h4>
<div class="markdown level1 summary"><p>Gets the direct message channel of this user, or create one if it does not already exist.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">Task&lt;IDMChannel&gt; IUser.GetOrCreateDMChannelAsync(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.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>&lt;<a class="xref" href="Discord.IDMChannel.html">IDMChannel</a>&gt;</td>
<td><p>A task that represents the asynchronous operation for getting or creating a DM channel. The task result
contains the DM channel associated with this user.</p>
</td>
</tr>
</tbody>
</table>
<h5 id="Discord_Rest_RestUser_Discord_IUser_GetOrCreateDMChannelAsync_Discord_RequestOptions__remarks">Remarks</h5>
<div class="markdown level1 remarks"><p>This method is used to obtain or create a channel used to send a direct message.</p>
<div class="WARNING"><h5>warning</h5><p>
In event that the current user cannot send a message to the target user, a channel can and will
still be created by Discord. However, attempting to send a message will yield a
<a class="xref" href="Discord.Net.HttpException.html">HttpException</a> with a 403 as its
<a class="xref" href="Discord.Net.HttpException.html#Discord_Net_HttpException_HttpCode">HttpCode</a>. There are currently no official workarounds by
Discord.
</p></div>
</div>
<h3 id="implements">Implements</h3>
<div>
<a class="xref" href="Discord.IUser.html">IUser</a>
</div>
<div>
<a class="xref" href="Discord.ISnowflakeEntity.html">ISnowflakeEntity</a>
</div>
<div>
<a class="xref" href="Discord.IEntity-1.html">IEntity&lt;TId&gt;</a>
</div>
<div>
<a class="xref" href="Discord.IMentionable.html">IMentionable</a>
</div>
<div>
<a class="xref" href="Discord.IPresence.html">IPresence</a>
</div>
<div>
<a class="xref" href="Discord.IUpdateable.html">IUpdateable</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_Rest_RestUser.md&amp;value=---%0Auid%3A%20Discord.Rest.RestUser%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.Rest/Entities/Users/RestUser.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>