mirror of
https://github.com/goatcorp/Dalamud.git
synced 2025-12-12 10:17:22 +01:00
346 lines
17 KiB
HTML
346 lines
17 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 AddGuildUserProperties
|
|
</title>
|
|
<meta name="viewport" content="width=device-width">
|
|
<meta name="title" content="Class AddGuildUserProperties
|
|
">
|
|
<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.AddGuildUserProperties">
|
|
|
|
|
|
<h1 id="Discord_AddGuildUserProperties" data-uid="Discord.AddGuildUserProperties" class="text-break">Class AddGuildUserProperties
|
|
</h1>
|
|
<div class="markdown level0 summary"><p>Properties that are used to add a new <a class="xref" href="Discord.IGuildUser.html">IGuildUser</a> to the guild with the following parameters.</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"><span class="xref">AddGuildUserProperties</span></div>
|
|
</div>
|
|
<div class="inheritedMembers">
|
|
<h5>Inherited Members</h5>
|
|
<div>
|
|
<span class="xref">System.Object.ToString()</span>
|
|
</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.html">Discord</a></h6>
|
|
<h6><strong>Assembly</strong>: Discord.Net.Core.dll</h6>
|
|
<h5 id="Discord_AddGuildUserProperties_syntax">Syntax</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public class AddGuildUserProperties</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_AddGuildUserProperties_Deaf.md&value=---%0Auid%3A%20Discord.AddGuildUserProperties.Deaf%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.Core/Entities/Users/AddGuildUserProperties.cs/#L32">View Source</a>
|
|
</span>
|
|
<a id="Discord_AddGuildUserProperties_Deaf_" data-uid="Discord.AddGuildUserProperties.Deaf*"></a>
|
|
<h4 id="Discord_AddGuildUserProperties_Deaf" data-uid="Discord.AddGuildUserProperties.Deaf">Deaf</h4>
|
|
<div class="markdown level1 summary"><p>Gets or sets whether the user should be deafened in a voice channel.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public Optional<bool> Deaf { get; set; }</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.Optional-1.html">Optional</a><<span class="xref">System.Boolean</span>></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 id="Discord_AddGuildUserProperties_Deaf_remarks">Remarks</h5>
|
|
<div class="markdown level1 remarks"><p>If this value is set to <code>true</code>, this user will not be able to hear anyone speak in the guild.</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_AddGuildUserProperties_Mute.md&value=---%0Auid%3A%20Discord.AddGuildUserProperties.Mute%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.Core/Entities/Users/AddGuildUserProperties.cs/#L25">View Source</a>
|
|
</span>
|
|
<a id="Discord_AddGuildUserProperties_Mute_" data-uid="Discord.AddGuildUserProperties.Mute*"></a>
|
|
<h4 id="Discord_AddGuildUserProperties_Mute" data-uid="Discord.AddGuildUserProperties.Mute">Mute</h4>
|
|
<div class="markdown level1 summary"><p>Gets or sets whether the user should be muted in a voice channel.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public Optional<bool> Mute { get; set; }</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.Optional-1.html">Optional</a><<span class="xref">System.Boolean</span>></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 id="Discord_AddGuildUserProperties_Mute_remarks">Remarks</h5>
|
|
<div class="markdown level1 remarks"><p>If this value is set to <code>true</code>, no user will be able to hear this user speak in the guild.</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_AddGuildUserProperties_Nickname.md&value=---%0Auid%3A%20Discord.AddGuildUserProperties.Nickname%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.Core/Entities/Users/AddGuildUserProperties.cs/#L18">View Source</a>
|
|
</span>
|
|
<a id="Discord_AddGuildUserProperties_Nickname_" data-uid="Discord.AddGuildUserProperties.Nickname*"></a>
|
|
<h4 id="Discord_AddGuildUserProperties_Nickname" data-uid="Discord.AddGuildUserProperties.Nickname">Nickname</h4>
|
|
<div class="markdown level1 summary"><p>Gets or sets the user's nickname.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public Optional<string> Nickname { get; set; }</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.Optional-1.html">Optional</a><<span class="xref">System.String</span>></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 id="Discord_AddGuildUserProperties_Nickname_remarks">Remarks</h5>
|
|
<div class="markdown level1 remarks"><p>To clear the user's nickname, this value can be set to <code>null</code> or
|
|
<span class="xref">System.String.Empty</span>.</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_AddGuildUserProperties_RoleIds.md&value=---%0Auid%3A%20Discord.AddGuildUserProperties.RoleIds%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.Core/Entities/Users/AddGuildUserProperties.cs/#L60">View Source</a>
|
|
</span>
|
|
<a id="Discord_AddGuildUserProperties_RoleIds_" data-uid="Discord.AddGuildUserProperties.RoleIds*"></a>
|
|
<h4 id="Discord_AddGuildUserProperties_RoleIds" data-uid="Discord.AddGuildUserProperties.RoleIds">RoleIds</h4>
|
|
<div class="markdown level1 summary"><p>Gets or sets the roles the user should have.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public Optional<IEnumerable<ulong>> RoleIds { get; set; }</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.Optional-1.html">Optional</a><<span class="xref">System.Collections.Generic.IEnumerable</span><<span class="xref">System.UInt64</span>>></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 id="Discord_AddGuildUserProperties_RoleIds_remarks">Remarks</h5>
|
|
<div class="markdown level1 remarks"><p>
|
|
To add a role to a user:
|
|
<a class="xref" href="Discord.IGuildUser.html#Discord_IGuildUser_AddRolesAsync_System_Collections_Generic_IEnumerable_Discord_IRole__Discord_RequestOptions_">AddRolesAsync(IEnumerable<IRole>, RequestOptions)</a>
|
|
</p>
|
|
<p>
|
|
To remove a role from a user:
|
|
<a class="xref" href="Discord.IGuildUser.html#Discord_IGuildUser_RemoveRolesAsync_System_Collections_Generic_IEnumerable_Discord_IRole__Discord_RequestOptions_">RemoveRolesAsync(IEnumerable<IRole>, RequestOptions)</a>
|
|
</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_AddGuildUserProperties_Roles.md&value=---%0Auid%3A%20Discord.AddGuildUserProperties.Roles%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.Core/Entities/Users/AddGuildUserProperties.cs/#L46">View Source</a>
|
|
</span>
|
|
<a id="Discord_AddGuildUserProperties_Roles_" data-uid="Discord.AddGuildUserProperties.Roles*"></a>
|
|
<h4 id="Discord_AddGuildUserProperties_Roles" data-uid="Discord.AddGuildUserProperties.Roles">Roles</h4>
|
|
<div class="markdown level1 summary"><p>Gets or sets the roles the user should have.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public Optional<IEnumerable<IRole>> Roles { get; set; }</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.Optional-1.html">Optional</a><<span class="xref">System.Collections.Generic.IEnumerable</span><<a class="xref" href="Discord.IRole.html">IRole</a>>></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 id="Discord_AddGuildUserProperties_Roles_remarks">Remarks</h5>
|
|
<div class="markdown level1 remarks"><p>
|
|
To add a role to a user:
|
|
<a class="xref" href="Discord.IGuildUser.html#Discord_IGuildUser_AddRolesAsync_System_Collections_Generic_IEnumerable_Discord_IRole__Discord_RequestOptions_">AddRolesAsync(IEnumerable<IRole>, RequestOptions)</a>
|
|
</p>
|
|
<p>
|
|
To remove a role from a user:
|
|
<a class="xref" href="Discord.IGuildUser.html#Discord_IGuildUser_RemoveRolesAsync_System_Collections_Generic_IEnumerable_Discord_IRole__Discord_RequestOptions_">RemoveRolesAsync(IEnumerable<IRole>, RequestOptions)</a>
|
|
</p>
|
|
</div>
|
|
<h3 id="seealso">See Also</h3>
|
|
<div class="seealso">
|
|
<div><a class="xref" href="Discord.IGuild.html#Discord_IGuild_AddGuildUserAsync_System_UInt64_System_String_System_Action_Discord_AddGuildUserProperties__Discord_RequestOptions_">AddGuildUserAsync</a>(<span class="xref">System.UInt64</span>, <span class="xref">System.String</span>, <span class="xref">System.Action</span><<a class="xref" href="Discord.AddGuildUserProperties.html">AddGuildUserProperties</a>>, <a class="xref" href="Discord.RequestOptions.html">RequestOptions</a>)</div>
|
|
</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_AddGuildUserProperties.md&value=---%0Auid%3A%20Discord.AddGuildUserProperties%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.Core/Entities/Users/AddGuildUserProperties.cs/#L9" 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>
|