mirror of
https://github.com/goatcorp/Dalamud.git
synced 2025-12-13 12:14:16 +01:00
357 lines
16 KiB
HTML
357 lines
16 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 GuildEmote
|
|
</title>
|
|
<meta name="viewport" content="width=device-width">
|
|
<meta name="title" content="Class GuildEmote
|
|
">
|
|
<meta name="generator" content="docfx 2.50.0.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.GuildEmote">
|
|
|
|
|
|
<h1 id="Discord_GuildEmote" data-uid="Discord.GuildEmote" class="text-break">Class GuildEmote
|
|
</h1>
|
|
<div class="markdown level0 summary"><p>An image-based emote that is attached to a guild.</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.Emote.html">Emote</a></div>
|
|
<div class="level2"><span class="xref">GuildEmote</span></div>
|
|
</div>
|
|
<div classs="implements">
|
|
<h5>Implements</h5>
|
|
<div><a class="xref" href="Discord.IEmote.html">IEmote</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>
|
|
<div class="inheritedMembers">
|
|
<h5>Inherited Members</h5>
|
|
<div>
|
|
<a class="xref" href="Discord.Emote.html#Discord_Emote_Name">Emote.Name</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Discord.Emote.html#Discord_Emote_Id">Emote.Id</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Discord.Emote.html#Discord_Emote_Animated">Emote.Animated</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Discord.Emote.html#Discord_Emote_CreatedAt">Emote.CreatedAt</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Discord.Emote.html#Discord_Emote_Url">Emote.Url</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Discord.Emote.html#Discord_Emote_Equals_System_Object_">Emote.Equals(Object)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Discord.Emote.html#Discord_Emote_GetHashCode">Emote.GetHashCode()</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Discord.Emote.html#Discord_Emote_Parse_System_String_">Emote.Parse(String)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Discord.Emote.html#Discord_Emote_TryParse_System_String_Discord_Emote__">Emote.TryParse(String, Emote)</a>
|
|
</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.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_GuildEmote_syntax">Syntax</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public class GuildEmote : Emote, IEmote, ISnowflakeEntity, IEntity<ulong></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/819a325cec923e4a817ab2f08be5c7bbe0d775d0/apiSpec/new?filename=Discord_GuildEmote_CreatorId.md&value=---%0Auid%3A%20Discord.GuildEmote.CreatorId%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/819a325cec923e4a817ab2f08be5c7bbe0d775d0/src/Discord.Net.Core/Entities/Emotes/GuildEmote.cs/#L40">View Source</a>
|
|
</span>
|
|
<a id="Discord_GuildEmote_CreatorId_" data-uid="Discord.GuildEmote.CreatorId*"></a>
|
|
<h4 id="Discord_GuildEmote_CreatorId" data-uid="Discord.GuildEmote.CreatorId">CreatorId</h4>
|
|
<div class="markdown level1 summary"><p>Gets the user ID associated with the creation of this emoji.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public ulong? CreatorId { 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.Nullable</span><<span class="xref">System.UInt64</span>></td>
|
|
<td><p>An <span class="xref">System.UInt64</span> snowflake identifier representing the user who created this emoji;
|
|
<code>null</code> if unknown.</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/819a325cec923e4a817ab2f08be5c7bbe0d775d0/apiSpec/new?filename=Discord_GuildEmote_IsManaged.md&value=---%0Auid%3A%20Discord.GuildEmote.IsManaged%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/819a325cec923e4a817ab2f08be5c7bbe0d775d0/src/Discord.Net.Core/Entities/Emotes/GuildEmote.cs/#L18">View Source</a>
|
|
</span>
|
|
<a id="Discord_GuildEmote_IsManaged_" data-uid="Discord.GuildEmote.IsManaged*"></a>
|
|
<h4 id="Discord_GuildEmote_IsManaged" data-uid="Discord.GuildEmote.IsManaged">IsManaged</h4>
|
|
<div class="markdown level1 summary"><p>Gets whether this emoji is managed by an integration.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public bool IsManaged { 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>A boolean that determines whether or not this emote is managed by a Twitch integration.</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/819a325cec923e4a817ab2f08be5c7bbe0d775d0/apiSpec/new?filename=Discord_GuildEmote_RequireColons.md&value=---%0Auid%3A%20Discord.GuildEmote.RequireColons%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/819a325cec923e4a817ab2f08be5c7bbe0d775d0/src/Discord.Net.Core/Entities/Emotes/GuildEmote.cs/#L25">View Source</a>
|
|
</span>
|
|
<a id="Discord_GuildEmote_RequireColons_" data-uid="Discord.GuildEmote.RequireColons*"></a>
|
|
<h4 id="Discord_GuildEmote_RequireColons" data-uid="Discord.GuildEmote.RequireColons">RequireColons</h4>
|
|
<div class="markdown level1 summary"><p>Gets whether this emoji must be wrapped in colons.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public bool RequireColons { 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>A boolean that determines whether or not this emote requires the use of colons in chat to be used.</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/819a325cec923e4a817ab2f08be5c7bbe0d775d0/apiSpec/new?filename=Discord_GuildEmote_RoleIds.md&value=---%0Auid%3A%20Discord.GuildEmote.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/819a325cec923e4a817ab2f08be5c7bbe0d775d0/src/Discord.Net.Core/Entities/Emotes/GuildEmote.cs/#L32">View Source</a>
|
|
</span>
|
|
<a id="Discord_GuildEmote_RoleIds_" data-uid="Discord.GuildEmote.RoleIds*"></a>
|
|
<h4 id="Discord_GuildEmote_RoleIds" data-uid="Discord.GuildEmote.RoleIds">RoleIds</h4>
|
|
<div class="markdown level1 summary"><p>Gets the roles that are allowed to use this emoji.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public IReadOnlyList<ulong> RoleIds { 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.IReadOnlyList</span><<span class="xref">System.UInt64</span>></td>
|
|
<td><p>A read-only list containing snowflake identifiers for roles that are allowed to use this emoji.</p>
|
|
</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/819a325cec923e4a817ab2f08be5c7bbe0d775d0/apiSpec/new?filename=Discord_GuildEmote_ToString.md&value=---%0Auid%3A%20Discord.GuildEmote.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/819a325cec923e4a817ab2f08be5c7bbe0d775d0/src/Discord.Net.Core/Entities/Emotes/GuildEmote.cs/#L57">View Source</a>
|
|
</span>
|
|
<a id="Discord_GuildEmote_ToString_" data-uid="Discord.GuildEmote.ToString*"></a>
|
|
<h4 id="Discord_GuildEmote_ToString" data-uid="Discord.GuildEmote.ToString">ToString()</h4>
|
|
<div class="markdown level1 summary"><p>Gets the raw representation of the emote.</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 representing the raw presentation of the emote (e.g. <code><:thonkang:282745590985523200></code>).</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="overrides">Overrides</h5>
|
|
<div><a class="xref" href="Discord.Emote.html#Discord_Emote_ToString">Emote.ToString()</a></div>
|
|
<h3 id="implements">Implements</h3>
|
|
<div>
|
|
<a class="xref" href="Discord.IEmote.html">IEmote</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>
|
|
</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/819a325cec923e4a817ab2f08be5c7bbe0d775d0/apiSpec/new?filename=Discord_GuildEmote.md&value=---%0Auid%3A%20Discord.GuildEmote%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/819a325cec923e4a817ab2f08be5c7bbe0d775d0/src/Discord.Net.Core/Entities/Emotes/GuildEmote.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>
|