ToxicMushroom/Dalamud
1
0
Fork 0
mirror of https://github.com/goatcorp/Dalamud.git synced 2025-12-12 10:17:22 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 3
Dalamud/docs/api/Discord.WebSocket.SocketCategoryChannel.html
goat 0a227fd2b7 docs: regenerate
2020-03-24 03:22:08 +09:00

504 lines
26 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Class SocketCategoryChannel
</title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class SocketCategoryChannel
">
<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.SocketCategoryChannel">
<h1 id="Discord_WebSocket_SocketCategoryChannel" data-uid="Discord.WebSocket.SocketCategoryChannel" class="text-break">Class SocketCategoryChannel
</h1>
<div class="markdown level0 summary"><p>Represents a WebSocket-based category channel.</p>
</div>
<div class="markdown level0 conceptual"></div>
<div class="inheritance">
<h5>Inheritance</h5>
<div class="level0"><span class="xref">System.Object</span></div>
<div class="level1"><a class="xref" href="Discord.WebSocket.SocketEntity-1.html">SocketEntity</a>&lt;<span class="xref">System.UInt64</span>&gt;</div>
<div class="level2"><a class="xref" href="Discord.WebSocket.SocketChannel.html">SocketChannel</a></div>
<div class="level3"><a class="xref" href="Discord.WebSocket.SocketGuildChannel.html">SocketGuildChannel</a></div>
<div class="level4"><span class="xref">SocketCategoryChannel</span></div>
</div>
<div classs="implements">
<h5>Implements</h5>
<div><a class="xref" href="Discord.ICategoryChannel.html">ICategoryChannel</a></div>
<div><a class="xref" href="Discord.IGuildChannel.html">IGuildChannel</a></div>
<div><a class="xref" href="Discord.IChannel.html">IChannel</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.IDeletable.html">IDeletable</a></div>
</div>
<div class="inheritedMembers">
<h5>Inherited Members</h5>
<div>
<a class="xref" href="Discord.WebSocket.SocketGuildChannel.html#Discord_WebSocket_SocketGuildChannel_Guild">SocketGuildChannel.Guild</a>
</div>
<div>
<a class="xref" href="Discord.WebSocket.SocketGuildChannel.html#Discord_WebSocket_SocketGuildChannel_Name">SocketGuildChannel.Name</a>
</div>
<div>
<a class="xref" href="Discord.WebSocket.SocketGuildChannel.html#Discord_WebSocket_SocketGuildChannel_Position">SocketGuildChannel.Position</a>
</div>
<div>
<a class="xref" href="Discord.WebSocket.SocketGuildChannel.html#Discord_WebSocket_SocketGuildChannel_PermissionOverwrites">SocketGuildChannel.PermissionOverwrites</a>
</div>
<div>
<a class="xref" href="Discord.WebSocket.SocketGuildChannel.html#Discord_WebSocket_SocketGuildChannel_ModifyAsync_System_Action_Discord_GuildChannelProperties__Discord_RequestOptions_">SocketGuildChannel.ModifyAsync(Action&lt;GuildChannelProperties&gt;, RequestOptions)</a>
</div>
<div>
<a class="xref" href="Discord.WebSocket.SocketGuildChannel.html#Discord_WebSocket_SocketGuildChannel_DeleteAsync_Discord_RequestOptions_">SocketGuildChannel.DeleteAsync(RequestOptions)</a>
</div>
<div>
<a class="xref" href="Discord.WebSocket.SocketGuildChannel.html#Discord_WebSocket_SocketGuildChannel_GetPermissionOverwrite_Discord_IUser_">SocketGuildChannel.GetPermissionOverwrite(IUser)</a>
</div>
<div>
<a class="xref" href="Discord.WebSocket.SocketGuildChannel.html#Discord_WebSocket_SocketGuildChannel_GetPermissionOverwrite_Discord_IRole_">SocketGuildChannel.GetPermissionOverwrite(IRole)</a>
</div>
<div>
<a class="xref" href="Discord.WebSocket.SocketGuildChannel.html#Discord_WebSocket_SocketGuildChannel_AddPermissionOverwriteAsync_Discord_IUser_Discord_OverwritePermissions_Discord_RequestOptions_">SocketGuildChannel.AddPermissionOverwriteAsync(IUser, OverwritePermissions, RequestOptions)</a>
</div>
<div>
<a class="xref" href="Discord.WebSocket.SocketGuildChannel.html#Discord_WebSocket_SocketGuildChannel_AddPermissionOverwriteAsync_Discord_IRole_Discord_OverwritePermissions_Discord_RequestOptions_">SocketGuildChannel.AddPermissionOverwriteAsync(IRole, OverwritePermissions, RequestOptions)</a>
</div>
<div>
<a class="xref" href="Discord.WebSocket.SocketGuildChannel.html#Discord_WebSocket_SocketGuildChannel_RemovePermissionOverwriteAsync_Discord_IUser_Discord_RequestOptions_">SocketGuildChannel.RemovePermissionOverwriteAsync(IUser, RequestOptions)</a>
</div>
<div>
<a class="xref" href="Discord.WebSocket.SocketGuildChannel.html#Discord_WebSocket_SocketGuildChannel_RemovePermissionOverwriteAsync_Discord_IRole_Discord_RequestOptions_">SocketGuildChannel.RemovePermissionOverwriteAsync(IRole, RequestOptions)</a>
</div>
<div>
<a class="xref" href="Discord.WebSocket.SocketGuildChannel.html#Discord_WebSocket_SocketGuildChannel_ToString">SocketGuildChannel.ToString()</a>
</div>
<div>
<a class="xref" href="Discord.WebSocket.SocketGuildChannel.html#Discord_WebSocket_SocketGuildChannel_Discord_IGuildChannel_Guild">SocketGuildChannel.IGuildChannel.Guild</a>
</div>
<div>
<a class="xref" href="Discord.WebSocket.SocketGuildChannel.html#Discord_WebSocket_SocketGuildChannel_Discord_IGuildChannel_GuildId">SocketGuildChannel.IGuildChannel.GuildId</a>
</div>
<div>
<a class="xref" href="Discord.WebSocket.SocketGuildChannel.html#Discord_WebSocket_SocketGuildChannel_Discord_IGuildChannel_GetPermissionOverwrite_Discord_IRole_">SocketGuildChannel.IGuildChannel.GetPermissionOverwrite(IRole)</a>
</div>
<div>
<a class="xref" href="Discord.WebSocket.SocketGuildChannel.html#Discord_WebSocket_SocketGuildChannel_Discord_IGuildChannel_GetPermissionOverwrite_Discord_IUser_">SocketGuildChannel.IGuildChannel.GetPermissionOverwrite(IUser)</a>
</div>
<div>
<a class="xref" href="Discord.WebSocket.SocketGuildChannel.html#Discord_WebSocket_SocketGuildChannel_Discord_IGuildChannel_AddPermissionOverwriteAsync_Discord_IRole_Discord_OverwritePermissions_Discord_RequestOptions_">SocketGuildChannel.IGuildChannel.AddPermissionOverwriteAsync(IRole, OverwritePermissions, RequestOptions)</a>
</div>
<div>
<a class="xref" href="Discord.WebSocket.SocketGuildChannel.html#Discord_WebSocket_SocketGuildChannel_Discord_IGuildChannel_AddPermissionOverwriteAsync_Discord_IUser_Discord_OverwritePermissions_Discord_RequestOptions_">SocketGuildChannel.IGuildChannel.AddPermissionOverwriteAsync(IUser, OverwritePermissions, RequestOptions)</a>
</div>
<div>
<a class="xref" href="Discord.WebSocket.SocketGuildChannel.html#Discord_WebSocket_SocketGuildChannel_Discord_IGuildChannel_RemovePermissionOverwriteAsync_Discord_IRole_Discord_RequestOptions_">SocketGuildChannel.IGuildChannel.RemovePermissionOverwriteAsync(IRole, RequestOptions)</a>
</div>
<div>
<a class="xref" href="Discord.WebSocket.SocketGuildChannel.html#Discord_WebSocket_SocketGuildChannel_Discord_IGuildChannel_RemovePermissionOverwriteAsync_Discord_IUser_Discord_RequestOptions_">SocketGuildChannel.IGuildChannel.RemovePermissionOverwriteAsync(IUser, RequestOptions)</a>
</div>
<div>
<a class="xref" href="Discord.WebSocket.SocketChannel.html#Discord_WebSocket_SocketChannel_CreatedAt">SocketChannel.CreatedAt</a>
</div>
<div>
<a class="xref" href="Discord.WebSocket.SocketChannel.html#Discord_WebSocket_SocketChannel_Discord_IChannel_Name">SocketChannel.IChannel.Name</a>
</div>
<div>
<a class="xref" href="Discord.WebSocket.SocketEntity-1.html#Discord_WebSocket_SocketEntity_1_Id">SocketEntity&lt;UInt64&gt;.Id</a>
</div>
<div>
<span class="xref">System.Object.Equals(System.Object)</span>
</div>
<div>
<span class="xref">System.Object.Equals(System.Object, System.Object)</span>
</div>
<div>
<span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
</div>
<div>
<span class="xref">System.Object.GetHashCode()</span>
</div>
<div>
<span class="xref">System.Object.GetType()</span>
</div>
<div>
<span class="xref">System.Object.MemberwiseClone()</span>
</div>
</div>
<h6><strong>Namespace</strong>: <a class="xref" href="Discord.WebSocket.html">Discord.WebSocket</a></h6>
<h6><strong>Assembly</strong>: Discord.Net.WebSocket.dll</h6>
<h5 id="Discord_WebSocket_SocketCategoryChannel_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class SocketCategoryChannel : SocketGuildChannel, ICategoryChannel, IGuildChannel, IChannel, ISnowflakeEntity, IEntity&lt;ulong&gt;, IDeletable</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_SocketCategoryChannel_Channels.md&amp;value=---%0Auid%3A%20Discord.WebSocket.SocketCategoryChannel.Channels%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/Channels/SocketCategoryChannel.cs/#L31">View Source</a>
</span>
<a id="Discord_WebSocket_SocketCategoryChannel_Channels_" data-uid="Discord.WebSocket.SocketCategoryChannel.Channels*"></a>
<h4 id="Discord_WebSocket_SocketCategoryChannel_Channels" data-uid="Discord.WebSocket.SocketCategoryChannel.Channels">Channels</h4>
<div class="markdown level1 summary"><p>Gets the child channels of this category.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public IReadOnlyCollection&lt;SocketGuildChannel&gt; Channels { get; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Collections.Generic.IReadOnlyCollection</span>&lt;<a class="xref" href="Discord.WebSocket.SocketGuildChannel.html">SocketGuildChannel</a>&gt;</td>
<td><p>A read-only collection of <a class="xref" href="Discord.WebSocket.SocketGuildChannel.html">SocketGuildChannel</a> whose
<a class="xref" href="Discord.INestedChannel.html#Discord_INestedChannel_CategoryId">CategoryId</a> matches the snowflake identifier of this category
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_SocketCategoryChannel_Users.md&amp;value=---%0Auid%3A%20Discord.WebSocket.SocketCategoryChannel.Users%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/Channels/SocketCategoryChannel.cs/#L18">View Source</a>
</span>
<a id="Discord_WebSocket_SocketCategoryChannel_Users_" data-uid="Discord.WebSocket.SocketCategoryChannel.Users*"></a>
<h4 id="Discord_WebSocket_SocketCategoryChannel_Users" data-uid="Discord.WebSocket.SocketCategoryChannel.Users">Users</h4>
<div class="markdown level1 summary"><p>Gets a collection of users that are able to view the channel.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public override IReadOnlyCollection&lt;SocketGuildUser&gt; Users { get; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Collections.Generic.IReadOnlyCollection</span>&lt;<a class="xref" href="Discord.WebSocket.SocketGuildUser.html">SocketGuildUser</a>&gt;</td>
<td><p>A read-only collection of users that can access the channel (i.e. the users seen in the user list).</p>
</td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><a class="xref" href="Discord.WebSocket.SocketGuildChannel.html#Discord_WebSocket_SocketGuildChannel_Users">SocketGuildChannel.Users</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_SocketCategoryChannel_GetUser_System_UInt64_.md&amp;value=---%0Auid%3A%20Discord.WebSocket.SocketCategoryChannel.GetUser(System.UInt64)%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/Channels/SocketCategoryChannel.cs/#L47">View Source</a>
</span>
<a id="Discord_WebSocket_SocketCategoryChannel_GetUser_" data-uid="Discord.WebSocket.SocketCategoryChannel.GetUser*"></a>
<h4 id="Discord_WebSocket_SocketCategoryChannel_GetUser_System_UInt64_" data-uid="Discord.WebSocket.SocketCategoryChannel.GetUser(System.UInt64)">GetUser(UInt64)</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public override SocketGuildUser GetUser(ulong id)</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.UInt64</span></td>
<td><span class="parametername">id</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><a class="xref" href="Discord.WebSocket.SocketGuildUser.html">SocketGuildUser</a></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><a class="xref" href="Discord.WebSocket.SocketGuildChannel.html#Discord_WebSocket_SocketGuildChannel_GetUser_System_UInt64_">SocketGuildChannel.GetUser(UInt64)</a></div>
<h3 id="eii">Explicit Interface Implementations
</h3>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goaaats/Discord.Net/new/dev/apiSpec/new?filename=Discord_WebSocket_SocketCategoryChannel_Discord_IChannel_GetUserAsync_System_UInt64_Discord_CacheMode_Discord_RequestOptions_.md&amp;value=---%0Auid%3A%20Discord.WebSocket.SocketCategoryChannel.Discord%23IChannel%23GetUserAsync(System.UInt64%2CDiscord.CacheMode%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/Channels/SocketCategoryChannel.cs/#L76">View Source</a>
</span>
<a id="Discord_WebSocket_SocketCategoryChannel_Discord_IChannel_GetUserAsync_" data-uid="Discord.WebSocket.SocketCategoryChannel.Discord#IChannel#GetUserAsync*"></a>
<h4 id="Discord_WebSocket_SocketCategoryChannel_Discord_IChannel_GetUserAsync_System_UInt64_Discord_CacheMode_Discord_RequestOptions_" data-uid="Discord.WebSocket.SocketCategoryChannel.Discord#IChannel#GetUserAsync(System.UInt64,Discord.CacheMode,Discord.RequestOptions)">IChannel.GetUserAsync(UInt64, CacheMode, RequestOptions)</h4>
<div class="markdown level1 summary"><p>Gets a user in this channel.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">Task&lt;IUser&gt; IChannel.GetUserAsync(ulong id, CacheMode mode, 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.UInt64</span></td>
<td><span class="parametername">id</span></td>
<td><p>The snowflake identifier of the user (e.g. <code>168693960628371456</code>).</p>
</td>
</tr>
<tr>
<td><a class="xref" href="Discord.CacheMode.html">CacheMode</a></td>
<td><span class="parametername">mode</span></td>
<td><p>The <a class="xref" href="Discord.CacheMode.html">CacheMode</a> that determines whether the object should be fetched from cache.</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>&lt;<a class="xref" href="Discord.IUser.html">IUser</a>&gt;</td>
<td><p>A task that represents the asynchronous get operation. The task result contains a user object that
represents the found user; <code>null</code> if none is found.</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_SocketCategoryChannel_Discord_IGuildChannel_GetUserAsync_System_UInt64_Discord_CacheMode_Discord_RequestOptions_.md&amp;value=---%0Auid%3A%20Discord.WebSocket.SocketCategoryChannel.Discord%23IGuildChannel%23GetUserAsync(System.UInt64%2CDiscord.CacheMode%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/Channels/SocketCategoryChannel.cs/#L68">View Source</a>
</span>
<a id="Discord_WebSocket_SocketCategoryChannel_Discord_IGuildChannel_GetUserAsync_" data-uid="Discord.WebSocket.SocketCategoryChannel.Discord#IGuildChannel#GetUserAsync*"></a>
<h4 id="Discord_WebSocket_SocketCategoryChannel_Discord_IGuildChannel_GetUserAsync_System_UInt64_Discord_CacheMode_Discord_RequestOptions_" data-uid="Discord.WebSocket.SocketCategoryChannel.Discord#IGuildChannel#GetUserAsync(System.UInt64,Discord.CacheMode,Discord.RequestOptions)">IGuildChannel.GetUserAsync(UInt64, CacheMode, RequestOptions)</h4>
<div class="markdown level1 summary"><p>Gets a user in this channel.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">Task&lt;IGuildUser&gt; IGuildChannel.GetUserAsync(ulong id, CacheMode mode, 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.UInt64</span></td>
<td><span class="parametername">id</span></td>
<td><p>The snowflake identifier of the user.</p>
</td>
</tr>
<tr>
<td><a class="xref" href="Discord.CacheMode.html">CacheMode</a></td>
<td><span class="parametername">mode</span></td>
<td><p>The <a class="xref" href="Discord.CacheMode.html">CacheMode</a> that determines whether the object should be fetched from cache.</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>&lt;<a class="xref" href="Discord.IGuildUser.html">IGuildUser</a>&gt;</td>
<td><p>A task representing the asynchronous get operation. The task result contains a guild user object that
represents the user; <code>null</code> if none is found.</p>
</td>
</tr>
</tbody>
</table>
<h3 id="implements">Implements</h3>
<div>
<a class="xref" href="Discord.ICategoryChannel.html">ICategoryChannel</a>
</div>
<div>
<a class="xref" href="Discord.IGuildChannel.html">IGuildChannel</a>
</div>
<div>
<a class="xref" href="Discord.IChannel.html">IChannel</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.IDeletable.html">IDeletable</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_SocketCategoryChannel.md&amp;value=---%0Auid%3A%20Discord.WebSocket.SocketCategoryChannel%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/Channels/SocketCategoryChannel.cs/#L14" class="contribution-link">View Source</a>
</li>
</ul>
</div>
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
</nav>
</div>
</div>
</div>
</div>
<footer>
<div class="grad-bottom"></div>
<div class="footer">
<div class="container">
<span class="pull-right">
<a href="#top">Back to top</a>
</span>
<span>Generated by <strong>DocFX</strong></span>
</div>
</div>
</footer>
</div>
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
<script type="text/javascript" src="../styles/docfx.js"></script>
<script type="text/javascript" src="../styles/main.js"></script>
</body>
</html>
Reference in a new issue View git blame Copy permalink