mirror of
https://github.com/goatcorp/Dalamud.git
synced 2025-12-12 18:27:23 +01:00
958 lines
48 KiB
HTML
958 lines
48 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 RestUserMessage
|
|
</title>
|
|
<meta name="viewport" content="width=device-width">
|
|
<meta name="title" content="Class RestUserMessage
|
|
">
|
|
<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.RestUserMessage">
|
|
|
|
|
|
<h1 id="Discord_Rest_RestUserMessage" data-uid="Discord.Rest.RestUserMessage" class="text-break">Class RestUserMessage
|
|
</h1>
|
|
<div class="markdown level0 summary"><p>Represents a REST-based message sent by a 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><<span class="xref">System.UInt64</span>></div>
|
|
<div class="level2"><a class="xref" href="Discord.Rest.RestMessage.html">RestMessage</a></div>
|
|
<div class="level3"><span class="xref">RestUserMessage</span></div>
|
|
</div>
|
|
<div classs="implements">
|
|
<h5>Implements</h5>
|
|
<div><a class="xref" href="Discord.IUpdateable.html">IUpdateable</a></div>
|
|
<div><a class="xref" href="Discord.IUserMessage.html">IUserMessage</a></div>
|
|
<div><a class="xref" href="Discord.IMessage.html">IMessage</a></div>
|
|
<div><a class="xref" href="Discord.ISnowflakeEntity.html">ISnowflakeEntity</a></div>
|
|
<div><a class="xref" href="Discord.IEntity-1.html">IEntity</a><<span class="xref">System.UInt64</span>></div>
|
|
<div><a class="xref" href="Discord.IDeletable.html">IDeletable</a></div>
|
|
</div>
|
|
<div class="inheritedMembers">
|
|
<h5>Inherited Members</h5>
|
|
<div>
|
|
<a class="xref" href="Discord.Rest.RestMessage.html#Discord_Rest_RestMessage_Channel">RestMessage.Channel</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Discord.Rest.RestMessage.html#Discord_Rest_RestMessage_Author">RestMessage.Author</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Discord.Rest.RestMessage.html#Discord_Rest_RestMessage_Source">RestMessage.Source</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Discord.Rest.RestMessage.html#Discord_Rest_RestMessage_Content">RestMessage.Content</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Discord.Rest.RestMessage.html#Discord_Rest_RestMessage_CreatedAt">RestMessage.CreatedAt</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Discord.Rest.RestMessage.html#Discord_Rest_RestMessage_Timestamp">RestMessage.Timestamp</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Discord.Rest.RestMessage.html#Discord_Rest_RestMessage_Activity">RestMessage.Activity</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Discord.Rest.RestMessage.html#Discord_Rest_RestMessage_Application">RestMessage.Application</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Discord.Rest.RestMessage.html#Discord_Rest_RestMessage_Reference">RestMessage.Reference</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Discord.Rest.RestMessage.html#Discord_Rest_RestMessage_UpdateAsync_Discord_RequestOptions_">RestMessage.UpdateAsync(RequestOptions)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Discord.Rest.RestMessage.html#Discord_Rest_RestMessage_DeleteAsync_Discord_RequestOptions_">RestMessage.DeleteAsync(RequestOptions)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Discord.Rest.RestMessage.html#Discord_Rest_RestMessage_ToString">RestMessage.ToString()</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Discord.Rest.RestMessage.html#Discord_Rest_RestMessage_Discord_IMessage_Type">RestMessage.IMessage.Type</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Discord.Rest.RestMessage.html#Discord_Rest_RestMessage_Discord_IMessage_Author">RestMessage.IMessage.Author</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Discord.Rest.RestMessage.html#Discord_Rest_RestMessage_Discord_IMessage_Attachments">RestMessage.IMessage.Attachments</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Discord.Rest.RestMessage.html#Discord_Rest_RestMessage_Discord_IMessage_Embeds">RestMessage.IMessage.Embeds</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Discord.Rest.RestMessage.html#Discord_Rest_RestMessage_Discord_IMessage_MentionedUserIds">RestMessage.IMessage.MentionedUserIds</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Discord.Rest.RestMessage.html#Discord_Rest_RestMessage_Reactions">RestMessage.Reactions</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Discord.Rest.RestMessage.html#Discord_Rest_RestMessage_AddReactionAsync_Discord_IEmote_Discord_RequestOptions_">RestMessage.AddReactionAsync(IEmote, RequestOptions)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Discord.Rest.RestMessage.html#Discord_Rest_RestMessage_RemoveReactionAsync_Discord_IEmote_Discord_IUser_Discord_RequestOptions_">RestMessage.RemoveReactionAsync(IEmote, IUser, RequestOptions)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Discord.Rest.RestMessage.html#Discord_Rest_RestMessage_RemoveReactionAsync_Discord_IEmote_System_UInt64_Discord_RequestOptions_">RestMessage.RemoveReactionAsync(IEmote, UInt64, RequestOptions)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Discord.Rest.RestMessage.html#Discord_Rest_RestMessage_RemoveAllReactionsAsync_Discord_RequestOptions_">RestMessage.RemoveAllReactionsAsync(RequestOptions)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Discord.Rest.RestMessage.html#Discord_Rest_RestMessage_GetReactionUsersAsync_Discord_IEmote_System_Int32_Discord_RequestOptions_">RestMessage.GetReactionUsersAsync(IEmote, Int32, RequestOptions)</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Discord.Rest.RestEntity-1.html#Discord_Rest_RestEntity_1_Id">RestEntity<UInt64>.Id</a>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.Object.Equals(System.Object)</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.Object.Equals(System.Object, System.Object)</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.Object.GetHashCode()</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.Object.GetType()</span>
|
|
</div>
|
|
<div>
|
|
<span class="xref">System.Object.MemberwiseClone()</span>
|
|
</div>
|
|
</div>
|
|
<h6><strong>Namespace</strong>: <a class="xref" href="Discord.Rest.html">Discord.Rest</a></h6>
|
|
<h6><strong>Assembly</strong>: Discord.Net.Rest.dll</h6>
|
|
<h5 id="Discord_Rest_RestUserMessage_syntax">Syntax</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public class RestUserMessage : RestMessage, IUpdateable, IUserMessage, IMessage, ISnowflakeEntity, IEntity<ulong>, 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_Rest_RestUserMessage_Attachments.md&value=---%0Auid%3A%20Discord.Rest.RestUserMessage.Attachments%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/Messages/RestUserMessage.cs/#L31">View Source</a>
|
|
</span>
|
|
<a id="Discord_Rest_RestUserMessage_Attachments_" data-uid="Discord.Rest.RestUserMessage.Attachments*"></a>
|
|
<h4 id="Discord_Rest_RestUserMessage_Attachments" data-uid="Discord.Rest.RestUserMessage.Attachments">Attachments</h4>
|
|
<div class="markdown level1 summary"><p>Gets a collection of the <a class="xref" href="Discord.Attachment.html">Attachment</a>'s on the message.</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<Attachment> Attachments { 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><<a class="xref" href="Discord.Attachment.html">Attachment</a>></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="overrides">Overrides</h5>
|
|
<div><a class="xref" href="Discord.Rest.RestMessage.html#Discord_Rest_RestMessage_Attachments">RestMessage.Attachments</a></div>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/goaaats/Discord.Net/new/dev/apiSpec/new?filename=Discord_Rest_RestUserMessage_EditedTimestamp.md&value=---%0Auid%3A%20Discord.Rest.RestUserMessage.EditedTimestamp%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/Messages/RestUserMessage.cs/#L29">View Source</a>
|
|
</span>
|
|
<a id="Discord_Rest_RestUserMessage_EditedTimestamp_" data-uid="Discord.Rest.RestUserMessage.EditedTimestamp*"></a>
|
|
<h4 id="Discord_Rest_RestUserMessage_EditedTimestamp" data-uid="Discord.Rest.RestUserMessage.EditedTimestamp">EditedTimestamp</h4>
|
|
<div class="markdown level1 summary"><p>Gets the time of this message's last edit.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public override DateTimeOffset? EditedTimestamp { 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.DateTimeOffset</span>></td>
|
|
<td><p>Time of when the message was last edited; <code>null</code> if the message is never edited.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="overrides">Overrides</h5>
|
|
<div><a class="xref" href="Discord.Rest.RestMessage.html#Discord_Rest_RestMessage_EditedTimestamp">RestMessage.EditedTimestamp</a></div>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/goaaats/Discord.Net/new/dev/apiSpec/new?filename=Discord_Rest_RestUserMessage_Embeds.md&value=---%0Auid%3A%20Discord.Rest.RestUserMessage.Embeds%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/Messages/RestUserMessage.cs/#L33">View Source</a>
|
|
</span>
|
|
<a id="Discord_Rest_RestUserMessage_Embeds_" data-uid="Discord.Rest.RestUserMessage.Embeds*"></a>
|
|
<h4 id="Discord_Rest_RestUserMessage_Embeds" data-uid="Discord.Rest.RestUserMessage.Embeds">Embeds</h4>
|
|
<div class="markdown level1 summary"><p>Gets a collection of the <a class="xref" href="Discord.Embed.html">Embed</a>'s on the message.</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<Embed> Embeds { 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><<a class="xref" href="Discord.Embed.html">Embed</a>></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="overrides">Overrides</h5>
|
|
<div><a class="xref" href="Discord.Rest.RestMessage.html#Discord_Rest_RestMessage_Embeds">RestMessage.Embeds</a></div>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/goaaats/Discord.Net/new/dev/apiSpec/new?filename=Discord_Rest_RestUserMessage_IsPinned.md&value=---%0Auid%3A%20Discord.Rest.RestUserMessage.IsPinned%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/Messages/RestUserMessage.cs/#L25">View Source</a>
|
|
</span>
|
|
<a id="Discord_Rest_RestUserMessage_IsPinned_" data-uid="Discord.Rest.RestUserMessage.IsPinned*"></a>
|
|
<h4 id="Discord_Rest_RestUserMessage_IsPinned" data-uid="Discord.Rest.RestUserMessage.IsPinned">IsPinned</h4>
|
|
<div class="markdown level1 summary"><p>Gets the value that indicates whether this message is pinned.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public override bool IsPinned { get; }</code></pre>
|
|
</div>
|
|
<h5 class="propertyValue">Property Value</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Boolean</span></td>
|
|
<td><p><code>true</code> if this message was added to its channel's pinned messages; otherwise <code>false</code>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="overrides">Overrides</h5>
|
|
<div><a class="xref" href="Discord.Rest.RestMessage.html#Discord_Rest_RestMessage_IsPinned">RestMessage.IsPinned</a></div>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/goaaats/Discord.Net/new/dev/apiSpec/new?filename=Discord_Rest_RestUserMessage_IsSuppressed.md&value=---%0Auid%3A%20Discord.Rest.RestUserMessage.IsSuppressed%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/Messages/RestUserMessage.cs/#L27">View Source</a>
|
|
</span>
|
|
<a id="Discord_Rest_RestUserMessage_IsSuppressed_" data-uid="Discord.Rest.RestUserMessage.IsSuppressed*"></a>
|
|
<h4 id="Discord_Rest_RestUserMessage_IsSuppressed" data-uid="Discord.Rest.RestUserMessage.IsSuppressed">IsSuppressed</h4>
|
|
<div class="markdown level1 summary"><p>Gets the value that indicates whether or not this message's embeds are suppressed.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public override bool IsSuppressed { 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 embeds in this message have been suppressed (made invisible); otherwise <code>false</code>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="overrides">Overrides</h5>
|
|
<div><a class="xref" href="Discord.Rest.RestMessage.html#Discord_Rest_RestMessage_IsSuppressed">RestMessage.IsSuppressed</a></div>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/goaaats/Discord.Net/new/dev/apiSpec/new?filename=Discord_Rest_RestUserMessage_IsTTS.md&value=---%0Auid%3A%20Discord.Rest.RestUserMessage.IsTTS%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/Messages/RestUserMessage.cs/#L23">View Source</a>
|
|
</span>
|
|
<a id="Discord_Rest_RestUserMessage_IsTTS_" data-uid="Discord.Rest.RestUserMessage.IsTTS*"></a>
|
|
<h4 id="Discord_Rest_RestUserMessage_IsTTS" data-uid="Discord.Rest.RestUserMessage.IsTTS">IsTTS</h4>
|
|
<div class="markdown level1 summary"><p>Gets the value that indicates whether this message was meant to be read-aloud by Discord.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public override bool IsTTS { get; }</code></pre>
|
|
</div>
|
|
<h5 class="propertyValue">Property Value</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Boolean</span></td>
|
|
<td><p><code>true</code> if this message was sent as a text-to-speech message; otherwise <code>false</code>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="overrides">Overrides</h5>
|
|
<div><a class="xref" href="Discord.Rest.RestMessage.html#Discord_Rest_RestMessage_IsTTS">RestMessage.IsTTS</a></div>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/goaaats/Discord.Net/new/dev/apiSpec/new?filename=Discord_Rest_RestUserMessage_MentionedChannelIds.md&value=---%0Auid%3A%20Discord.Rest.RestUserMessage.MentionedChannelIds%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/Messages/RestUserMessage.cs/#L35">View Source</a>
|
|
</span>
|
|
<a id="Discord_Rest_RestUserMessage_MentionedChannelIds_" data-uid="Discord.Rest.RestUserMessage.MentionedChannelIds*"></a>
|
|
<h4 id="Discord_Rest_RestUserMessage_MentionedChannelIds" data-uid="Discord.Rest.RestUserMessage.MentionedChannelIds">MentionedChannelIds</h4>
|
|
<div class="markdown level1 summary"><p>Gets the IDs of channels mentioned in this message.</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<ulong> MentionedChannelIds { 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><<span class="xref">System.UInt64</span>></td>
|
|
<td><p>A read-only collection of channel IDs.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="overrides">Overrides</h5>
|
|
<div><a class="xref" href="Discord.Rest.RestMessage.html#Discord_Rest_RestMessage_MentionedChannelIds">RestMessage.MentionedChannelIds</a></div>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/goaaats/Discord.Net/new/dev/apiSpec/new?filename=Discord_Rest_RestUserMessage_MentionedRoleIds.md&value=---%0Auid%3A%20Discord.Rest.RestUserMessage.MentionedRoleIds%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/Messages/RestUserMessage.cs/#L37">View Source</a>
|
|
</span>
|
|
<a id="Discord_Rest_RestUserMessage_MentionedRoleIds_" data-uid="Discord.Rest.RestUserMessage.MentionedRoleIds*"></a>
|
|
<h4 id="Discord_Rest_RestUserMessage_MentionedRoleIds" data-uid="Discord.Rest.RestUserMessage.MentionedRoleIds">MentionedRoleIds</h4>
|
|
<div class="markdown level1 summary"><p>Gets the IDs of roles mentioned in this message.</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<ulong> MentionedRoleIds { 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><<span class="xref">System.UInt64</span>></td>
|
|
<td><p>A read-only collection of role IDs.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="overrides">Overrides</h5>
|
|
<div><a class="xref" href="Discord.Rest.RestMessage.html#Discord_Rest_RestMessage_MentionedRoleIds">RestMessage.MentionedRoleIds</a></div>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/goaaats/Discord.Net/new/dev/apiSpec/new?filename=Discord_Rest_RestUserMessage_MentionedUsers.md&value=---%0Auid%3A%20Discord.Rest.RestUserMessage.MentionedUsers%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/Messages/RestUserMessage.cs/#L39">View Source</a>
|
|
</span>
|
|
<a id="Discord_Rest_RestUserMessage_MentionedUsers_" data-uid="Discord.Rest.RestUserMessage.MentionedUsers*"></a>
|
|
<h4 id="Discord_Rest_RestUserMessage_MentionedUsers" data-uid="Discord.Rest.RestUserMessage.MentionedUsers">MentionedUsers</h4>
|
|
<div class="markdown level1 summary"><p>Gets a collection of the mentioned users in the message.</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<RestUser> MentionedUsers { 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><<a class="xref" href="Discord.Rest.RestUser.html">RestUser</a>></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="overrides">Overrides</h5>
|
|
<div><a class="xref" href="Discord.Rest.RestMessage.html#Discord_Rest_RestMessage_MentionedUsers">RestMessage.MentionedUsers</a></div>
|
|
<span class="small pull-right mobile-hide">
|
|
<span class="divider">|</span>
|
|
<a href="https://github.com/goaaats/Discord.Net/new/dev/apiSpec/new?filename=Discord_Rest_RestUserMessage_Tags.md&value=---%0Auid%3A%20Discord.Rest.RestUserMessage.Tags%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/Messages/RestUserMessage.cs/#L41">View Source</a>
|
|
</span>
|
|
<a id="Discord_Rest_RestUserMessage_Tags_" data-uid="Discord.Rest.RestUserMessage.Tags*"></a>
|
|
<h4 id="Discord_Rest_RestUserMessage_Tags" data-uid="Discord.Rest.RestUserMessage.Tags">Tags</h4>
|
|
<div class="markdown level1 summary"><p>Gets all tags included in this message's content.</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<ITag> Tags { 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><<a class="xref" href="Discord.ITag.html">ITag</a>></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="overrides">Overrides</h5>
|
|
<div><a class="xref" href="Discord.Rest.RestMessage.html#Discord_Rest_RestMessage_Tags">RestMessage.Tags</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_Rest_RestUserMessage_ModifyAsync_System_Action_Discord_MessageProperties__Discord_RequestOptions_.md&value=---%0Auid%3A%20Discord.Rest.RestUserMessage.ModifyAsync(System.Action%7BDiscord.MessageProperties%7D%2CDiscord.RequestOptions)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
|
|
</span>
|
|
<span class="small pull-right mobile-hide">
|
|
<a href="https://github.com/goaaats/Discord.Net/blob/dev/src/Discord.Net.Rest/Entities/Messages/RestUserMessage.cs/#L127">View Source</a>
|
|
</span>
|
|
<a id="Discord_Rest_RestUserMessage_ModifyAsync_" data-uid="Discord.Rest.RestUserMessage.ModifyAsync*"></a>
|
|
<h4 id="Discord_Rest_RestUserMessage_ModifyAsync_System_Action_Discord_MessageProperties__Discord_RequestOptions_" data-uid="Discord.Rest.RestUserMessage.ModifyAsync(System.Action{Discord.MessageProperties},Discord.RequestOptions)">ModifyAsync(Action<MessageProperties>, RequestOptions)</h4>
|
|
<div class="markdown level1 summary"><p>Modifies this message.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public Task ModifyAsync(Action<MessageProperties> func, RequestOptions options = null)</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Action</span><<a class="xref" href="Discord.MessageProperties.html">MessageProperties</a>></td>
|
|
<td><span class="parametername">func</span></td>
|
|
<td><p>A delegate containing the properties to modify the message with.</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></td>
|
|
<td><p>A task that represents the asynchronous modification operation.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 id="Discord_Rest_RestUserMessage_ModifyAsync_System_Action_Discord_MessageProperties__Discord_RequestOptions__remarks">Remarks</h5>
|
|
<div class="markdown level1 remarks"><p>This method modifies this message with the specified properties. To see an example of this
|
|
method and what properties are available, please refer to <a class="xref" href="Discord.MessageProperties.html">MessageProperties</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_Rest_RestUserMessage_ModifySuppressionAsync_System_Boolean_Discord_RequestOptions_.md&value=---%0Auid%3A%20Discord.Rest.RestUserMessage.ModifySuppressionAsync(System.Boolean%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.Rest/Entities/Messages/RestUserMessage.cs/#L140">View Source</a>
|
|
</span>
|
|
<a id="Discord_Rest_RestUserMessage_ModifySuppressionAsync_" data-uid="Discord.Rest.RestUserMessage.ModifySuppressionAsync*"></a>
|
|
<h4 id="Discord_Rest_RestUserMessage_ModifySuppressionAsync_System_Boolean_Discord_RequestOptions_" data-uid="Discord.Rest.RestUserMessage.ModifySuppressionAsync(System.Boolean,Discord.RequestOptions)">ModifySuppressionAsync(Boolean, RequestOptions)</h4>
|
|
<div class="markdown level1 summary"><p>Modifies the suppression of this message.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public Task ModifySuppressionAsync(bool suppressEmbeds, RequestOptions options = null)</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Boolean</span></td>
|
|
<td><span class="parametername">suppressEmbeds</span></td>
|
|
<td><p>Whether or not embeds in this message should be suppressed.</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></td>
|
|
<td><p>A task that represents the asynchronous modification operation.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 id="Discord_Rest_RestUserMessage_ModifySuppressionAsync_System_Boolean_Discord_RequestOptions__remarks">Remarks</h5>
|
|
<div class="markdown level1 remarks"><p>This method modifies whether or not embeds in this message are suppressed (hidden).</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_RestUserMessage_PinAsync_Discord_RequestOptions_.md&value=---%0Auid%3A%20Discord.Rest.RestUserMessage.PinAsync(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/Messages/RestUserMessage.cs/#L134">View Source</a>
|
|
</span>
|
|
<a id="Discord_Rest_RestUserMessage_PinAsync_" data-uid="Discord.Rest.RestUserMessage.PinAsync*"></a>
|
|
<h4 id="Discord_Rest_RestUserMessage_PinAsync_Discord_RequestOptions_" data-uid="Discord.Rest.RestUserMessage.PinAsync(Discord.RequestOptions)">PinAsync(RequestOptions)</h4>
|
|
<div class="markdown level1 summary"><p>Adds this message to its channel's pinned messages.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public Task PinAsync(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></td>
|
|
<td><p>A task that represents the asynchronous operation for pinning this message.</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_RestUserMessage_Resolve_Discord_TagHandling_Discord_TagHandling_Discord_TagHandling_Discord_TagHandling_Discord_TagHandling_.md&value=---%0Auid%3A%20Discord.Rest.RestUserMessage.Resolve(Discord.TagHandling%2CDiscord.TagHandling%2CDiscord.TagHandling%2CDiscord.TagHandling%2CDiscord.TagHandling)%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/Messages/RestUserMessage.cs/#L147">View Source</a>
|
|
</span>
|
|
<a id="Discord_Rest_RestUserMessage_Resolve_" data-uid="Discord.Rest.RestUserMessage.Resolve*"></a>
|
|
<h4 id="Discord_Rest_RestUserMessage_Resolve_Discord_TagHandling_Discord_TagHandling_Discord_TagHandling_Discord_TagHandling_Discord_TagHandling_" data-uid="Discord.Rest.RestUserMessage.Resolve(Discord.TagHandling,Discord.TagHandling,Discord.TagHandling,Discord.TagHandling,Discord.TagHandling)">Resolve(TagHandling, TagHandling, TagHandling, TagHandling, TagHandling)</h4>
|
|
<div class="markdown level1 summary"><p>Transforms this message's text into a human-readable form by resolving its tags.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public string Resolve(TagHandling userHandling = TagHandling.Name, TagHandling channelHandling = TagHandling.Name, TagHandling roleHandling = TagHandling.Name, TagHandling everyoneHandling = TagHandling.Ignore, TagHandling emojiHandling = TagHandling.Name)</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.TagHandling.html">TagHandling</a></td>
|
|
<td><span class="parametername">userHandling</span></td>
|
|
<td><p>Determines how the user tag should be handled.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="Discord.TagHandling.html">TagHandling</a></td>
|
|
<td><span class="parametername">channelHandling</span></td>
|
|
<td><p>Determines how the channel tag should be handled.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="Discord.TagHandling.html">TagHandling</a></td>
|
|
<td><span class="parametername">roleHandling</span></td>
|
|
<td><p>Determines how the role tag should be handled.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="Discord.TagHandling.html">TagHandling</a></td>
|
|
<td><span class="parametername">everyoneHandling</span></td>
|
|
<td><p>Determines how the @everyone tag should be handled.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="Discord.TagHandling.html">TagHandling</a></td>
|
|
<td><span class="parametername">emojiHandling</span></td>
|
|
<td><p>Determines how the emoji tag should be handled.</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></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_RestUserMessage_Resolve_System_Int32_Discord_TagHandling_Discord_TagHandling_Discord_TagHandling_Discord_TagHandling_Discord_TagHandling_.md&value=---%0Auid%3A%20Discord.Rest.RestUserMessage.Resolve(System.Int32%2CDiscord.TagHandling%2CDiscord.TagHandling%2CDiscord.TagHandling%2CDiscord.TagHandling%2CDiscord.TagHandling)%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/Messages/RestUserMessage.cs/#L143">View Source</a>
|
|
</span>
|
|
<a id="Discord_Rest_RestUserMessage_Resolve_" data-uid="Discord.Rest.RestUserMessage.Resolve*"></a>
|
|
<h4 id="Discord_Rest_RestUserMessage_Resolve_System_Int32_Discord_TagHandling_Discord_TagHandling_Discord_TagHandling_Discord_TagHandling_Discord_TagHandling_" data-uid="Discord.Rest.RestUserMessage.Resolve(System.Int32,Discord.TagHandling,Discord.TagHandling,Discord.TagHandling,Discord.TagHandling,Discord.TagHandling)">Resolve(Int32, TagHandling, TagHandling, TagHandling, TagHandling, TagHandling)</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 string Resolve(int startIndex, TagHandling userHandling = TagHandling.Name, TagHandling channelHandling = TagHandling.Name, TagHandling roleHandling = TagHandling.Name, TagHandling everyoneHandling = TagHandling.Ignore, TagHandling emojiHandling = TagHandling.Name)</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.Int32</span></td>
|
|
<td><span class="parametername">startIndex</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="Discord.TagHandling.html">TagHandling</a></td>
|
|
<td><span class="parametername">userHandling</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="Discord.TagHandling.html">TagHandling</a></td>
|
|
<td><span class="parametername">channelHandling</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="Discord.TagHandling.html">TagHandling</a></td>
|
|
<td><span class="parametername">roleHandling</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="Discord.TagHandling.html">TagHandling</a></td>
|
|
<td><span class="parametername">everyoneHandling</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="Discord.TagHandling.html">TagHandling</a></td>
|
|
<td><span class="parametername">emojiHandling</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.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_RestUserMessage_UnpinAsync_Discord_RequestOptions_.md&value=---%0Auid%3A%20Discord.Rest.RestUserMessage.UnpinAsync(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/Messages/RestUserMessage.cs/#L137">View Source</a>
|
|
</span>
|
|
<a id="Discord_Rest_RestUserMessage_UnpinAsync_" data-uid="Discord.Rest.RestUserMessage.UnpinAsync*"></a>
|
|
<h4 id="Discord_Rest_RestUserMessage_UnpinAsync_Discord_RequestOptions_" data-uid="Discord.Rest.RestUserMessage.UnpinAsync(Discord.RequestOptions)">UnpinAsync(RequestOptions)</h4>
|
|
<div class="markdown level1 summary"><p>Removes this message from its channel's pinned messages.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public Task UnpinAsync(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></td>
|
|
<td><p>A task that represents the asynchronous operation for unpinning this message.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="implements">Implements</h3>
|
|
<div>
|
|
<a class="xref" href="Discord.IUpdateable.html">IUpdateable</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Discord.IUserMessage.html">IUserMessage</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Discord.IMessage.html">IMessage</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Discord.ISnowflakeEntity.html">ISnowflakeEntity</a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Discord.IEntity-1.html">IEntity<TId></a>
|
|
</div>
|
|
<div>
|
|
<a class="xref" href="Discord.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_Rest_RestUserMessage.md&value=---%0Auid%3A%20Discord.Rest.RestUserMessage%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/Messages/RestUserMessage.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>
|