Dalamud/docs/api/Discord.Rest.html
2020-03-11 21:54:11 +09:00

321 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>Namespace Discord.Rest
</title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Namespace Discord.Rest
">
<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.Rest">
<h1 id="Discord_Rest" data-uid="Discord.Rest" class="text-break">Namespace Discord.Rest
</h1>
<div class="markdown level0 summary"></div>
<div class="markdown level0 conceptual"></div>
<div class="markdown level0 remarks"></div>
<h3 id="classes">Classes
</h3>
<h4><a class="xref" href="Discord.Rest.BanAuditLogData.html">BanAuditLogData</a></h4>
<section><p>Contains a piece of audit log data related to a ban.</p>
</section>
<h4><a class="xref" href="Discord.Rest.BaseDiscordClient.html">BaseDiscordClient</a></h4>
<section></section>
<h4><a class="xref" href="Discord.Rest.ChannelCreateAuditLogData.html">ChannelCreateAuditLogData</a></h4>
<section><p>Contains a piece of audit log data related to a channel creation.</p>
</section>
<h4><a class="xref" href="Discord.Rest.ChannelDeleteAuditLogData.html">ChannelDeleteAuditLogData</a></h4>
<section><p>Contains a piece of audit log data related to a channel deletion.</p>
</section>
<h4><a class="xref" href="Discord.Rest.ChannelUpdateAuditLogData.html">ChannelUpdateAuditLogData</a></h4>
<section><p>Contains a piece of audit log data related to a channel update.</p>
</section>
<h4><a class="xref" href="Discord.Rest.ClientExtensions.html">ClientExtensions</a></h4>
<section></section>
<h4><a class="xref" href="Discord.Rest.DiscordRestClient.html">DiscordRestClient</a></h4>
<section><p>Provides a client to send REST-based requests to Discord.</p>
</section>
<h4><a class="xref" href="Discord.Rest.DiscordRestConfig.html">DiscordRestConfig</a></h4>
<section><p>Represents a configuration class for <a class="xref" href="Discord.Rest.DiscordRestClient.html">DiscordRestClient</a>.</p>
</section>
<h4><a class="xref" href="Discord.Rest.EmoteCreateAuditLogData.html">EmoteCreateAuditLogData</a></h4>
<section><p>Contains a piece of audit log data related to an emoji creation.</p>
</section>
<h4><a class="xref" href="Discord.Rest.EmoteDeleteAuditLogData.html">EmoteDeleteAuditLogData</a></h4>
<section><p>Contains a piece of audit log data related to an emoji deletion.</p>
</section>
<h4><a class="xref" href="Discord.Rest.EmoteUpdateAuditLogData.html">EmoteUpdateAuditLogData</a></h4>
<section><p>Contains a piece of audit log data related to an emoji update.</p>
</section>
<h4><a class="xref" href="Discord.Rest.GuildUpdateAuditLogData.html">GuildUpdateAuditLogData</a></h4>
<section><p>Contains a piece of audit log data related to a guild update.</p>
</section>
<h4><a class="xref" href="Discord.Rest.InviteCreateAuditLogData.html">InviteCreateAuditLogData</a></h4>
<section><p>Contains a piece of audit log data related to an invite creation.</p>
</section>
<h4><a class="xref" href="Discord.Rest.InviteDeleteAuditLogData.html">InviteDeleteAuditLogData</a></h4>
<section><p>Contains a piece of audit log data related to an invite removal.</p>
</section>
<h4><a class="xref" href="Discord.Rest.InviteUpdateAuditLogData.html">InviteUpdateAuditLogData</a></h4>
<section><p>Contains a piece of audit log data relating to an invite update.</p>
</section>
<h4><a class="xref" href="Discord.Rest.KickAuditLogData.html">KickAuditLogData</a></h4>
<section><p>Contains a piece of audit log data related to a kick.</p>
</section>
<h4><a class="xref" href="Discord.Rest.MemberRoleAuditLogData.html">MemberRoleAuditLogData</a></h4>
<section><p>Contains a piece of audit log data related to a change in a guild member's roles.</p>
</section>
<h4><a class="xref" href="Discord.Rest.MemberUpdateAuditLogData.html">MemberUpdateAuditLogData</a></h4>
<section><p>Contains a piece of audit log data related to a change in a guild member.</p>
</section>
<h4><a class="xref" href="Discord.Rest.MessageDeleteAuditLogData.html">MessageDeleteAuditLogData</a></h4>
<section><p>Contains a piece of audit log data related to message deletion(s).</p>
</section>
<h4><a class="xref" href="Discord.Rest.OverwriteCreateAuditLogData.html">OverwriteCreateAuditLogData</a></h4>
<section><p>Contains a piece of audit log data for a permissions overwrite creation.</p>
</section>
<h4><a class="xref" href="Discord.Rest.OverwriteDeleteAuditLogData.html">OverwriteDeleteAuditLogData</a></h4>
<section><p>Contains a piece of audit log data related to the deletion of a permission overwrite.</p>
</section>
<h4><a class="xref" href="Discord.Rest.OverwriteUpdateAuditLogData.html">OverwriteUpdateAuditLogData</a></h4>
<section><p>Contains a piece of audit log data related to the update of a permission overwrite.</p>
</section>
<h4><a class="xref" href="Discord.Rest.PruneAuditLogData.html">PruneAuditLogData</a></h4>
<section><p>Contains a piece of audit log data related to a guild prune.</p>
</section>
<h4><a class="xref" href="Discord.Rest.RestApplication.html">RestApplication</a></h4>
<section><p>Represents a REST-based entity that contains information about a Discord application created via the developer portal.</p>
</section>
<h4><a class="xref" href="Discord.Rest.RestAuditLogEntry.html">RestAuditLogEntry</a></h4>
<section><p>Represents a REST-based audit log entry.</p>
</section>
<h4><a class="xref" href="Discord.Rest.RestBan.html">RestBan</a></h4>
<section><p>Represents a REST-based ban object.</p>
</section>
<h4><a class="xref" href="Discord.Rest.RestCategoryChannel.html">RestCategoryChannel</a></h4>
<section><p>Represents a REST-based category channel.</p>
</section>
<h4><a class="xref" href="Discord.Rest.RestChannel.html">RestChannel</a></h4>
<section><p>Represents a generic REST-based channel.</p>
</section>
<h4><a class="xref" href="Discord.Rest.RestConnection.html">RestConnection</a></h4>
<section></section>
<h4><a class="xref" href="Discord.Rest.RestDMChannel.html">RestDMChannel</a></h4>
<section><p>Represents a REST-based direct-message channel.</p>
</section>
<h4><a class="xref" href="Discord.Rest.RestEntity-1.html">RestEntity&lt;T&gt;</a></h4>
<section></section>
<h4><a class="xref" href="Discord.Rest.RestGroupChannel.html">RestGroupChannel</a></h4>
<section><p>Represents a REST-based group-message channel.</p>
</section>
<h4><a class="xref" href="Discord.Rest.RestGroupUser.html">RestGroupUser</a></h4>
<section><p>Represents a REST-based group user.</p>
</section>
<h4><a class="xref" href="Discord.Rest.RestGuild.html">RestGuild</a></h4>
<section><p>Represents a REST-based guild/server.</p>
</section>
<h4><a class="xref" href="Discord.Rest.RestGuildChannel.html">RestGuildChannel</a></h4>
<section><p>Represents a private REST-based group channel.</p>
</section>
<h4><a class="xref" href="Discord.Rest.RestGuildIntegration.html">RestGuildIntegration</a></h4>
<section></section>
<h4><a class="xref" href="Discord.Rest.RestGuildUser.html">RestGuildUser</a></h4>
<section><p>Represents a REST-based guild user.</p>
</section>
<h4><a class="xref" href="Discord.Rest.RestInvite.html">RestInvite</a></h4>
<section></section>
<h4><a class="xref" href="Discord.Rest.RestInviteMetadata.html">RestInviteMetadata</a></h4>
<section><p>Represents additional information regarding the REST-based invite object.</p>
</section>
<h4><a class="xref" href="Discord.Rest.RestMessage.html">RestMessage</a></h4>
<section><p>Represents a REST-based message.</p>
</section>
<h4><a class="xref" href="Discord.Rest.RestNewsChannel.html">RestNewsChannel</a></h4>
<section><p>Represents a REST-based news channel in a guild that has the same properties as a <a class="xref" href="Discord.Rest.RestTextChannel.html">RestTextChannel</a>.</p>
</section>
<h4><a class="xref" href="Discord.Rest.RestReaction.html">RestReaction</a></h4>
<section><p>Represents a REST reaction object.</p>
</section>
<h4><a class="xref" href="Discord.Rest.RestRole.html">RestRole</a></h4>
<section><p>Represents a REST-based role.</p>
</section>
<h4><a class="xref" href="Discord.Rest.RestSelfUser.html">RestSelfUser</a></h4>
<section><p>Represents the logged-in REST-based user.</p>
</section>
<h4><a class="xref" href="Discord.Rest.RestSystemMessage.html">RestSystemMessage</a></h4>
<section><p>Represents a REST-based system message.</p>
</section>
<h4><a class="xref" href="Discord.Rest.RestTextChannel.html">RestTextChannel</a></h4>
<section><p>Represents a REST-based channel in a guild that can send and receive messages.</p>
</section>
<h4><a class="xref" href="Discord.Rest.RestUser.html">RestUser</a></h4>
<section><p>Represents a REST-based user.</p>
</section>
<h4><a class="xref" href="Discord.Rest.RestUserGuild.html">RestUserGuild</a></h4>
<section></section>
<h4><a class="xref" href="Discord.Rest.RestUserMessage.html">RestUserMessage</a></h4>
<section><p>Represents a REST-based message sent by a user.</p>
</section>
<h4><a class="xref" href="Discord.Rest.RestVoiceChannel.html">RestVoiceChannel</a></h4>
<section><p>Represents a REST-based voice channel in a guild.</p>
</section>
<h4><a class="xref" href="Discord.Rest.RestVoiceRegion.html">RestVoiceRegion</a></h4>
<section><p>Represents a REST-based voice region.</p>
</section>
<h4><a class="xref" href="Discord.Rest.RestWebhook.html">RestWebhook</a></h4>
<section></section>
<h4><a class="xref" href="Discord.Rest.RestWebhookUser.html">RestWebhookUser</a></h4>
<section></section>
<h4><a class="xref" href="Discord.Rest.RoleCreateAuditLogData.html">RoleCreateAuditLogData</a></h4>
<section><p>Contains a piece of audit log data related to a role creation.</p>
</section>
<h4><a class="xref" href="Discord.Rest.RoleDeleteAuditLogData.html">RoleDeleteAuditLogData</a></h4>
<section><p>Contains a piece of audit log data relating to a role deletion.</p>
</section>
<h4><a class="xref" href="Discord.Rest.RoleUpdateAuditLogData.html">RoleUpdateAuditLogData</a></h4>
<section><p>Contains a piece of audit log data related to a role update.</p>
</section>
<h4><a class="xref" href="Discord.Rest.UnbanAuditLogData.html">UnbanAuditLogData</a></h4>
<section><p>Contains a piece of audit log data related to an unban.</p>
</section>
<h4><a class="xref" href="Discord.Rest.WebhookCreateAuditLogData.html">WebhookCreateAuditLogData</a></h4>
<section><p>Contains a piece of audit log data related to a webhook creation.</p>
</section>
<h4><a class="xref" href="Discord.Rest.WebhookDeleteAuditLogData.html">WebhookDeleteAuditLogData</a></h4>
<section><p>Contains a piece of audit log data related to a webhook deletion.</p>
</section>
<h4><a class="xref" href="Discord.Rest.WebhookUpdateAuditLogData.html">WebhookUpdateAuditLogData</a></h4>
<section><p>Contains a piece of audit log data related to a webhook update.</p>
</section>
<h3 id="structs">Structs
</h3>
<h4><a class="xref" href="Discord.Rest.ChannelInfo.html">ChannelInfo</a></h4>
<section><p>Represents information for a channel.</p>
</section>
<h4><a class="xref" href="Discord.Rest.GuildInfo.html">GuildInfo</a></h4>
<section><p>Represents information for a guild.</p>
</section>
<h4><a class="xref" href="Discord.Rest.InviteInfo.html">InviteInfo</a></h4>
<section><p>Represents information for an invite.</p>
</section>
<h4><a class="xref" href="Discord.Rest.MemberInfo.html">MemberInfo</a></h4>
<section><p>Represents information for a member.</p>
</section>
<h4><a class="xref" href="Discord.Rest.MemberRoleEditInfo.html">MemberRoleEditInfo</a></h4>
<section><p>An information object representing a change in one of a guild member's roles.</p>
</section>
<h4><a class="xref" href="Discord.Rest.RestGuildEmbed.html">RestGuildEmbed</a></h4>
<section></section>
<h4><a class="xref" href="Discord.Rest.RoleEditInfo.html">RoleEditInfo</a></h4>
<section><p>Represents information for a role edit.</p>
</section>
<h4><a class="xref" href="Discord.Rest.WebhookInfo.html">WebhookInfo</a></h4>
<section><p>Represents information for a webhook.</p>
</section>
<h3 id="interfaces">Interfaces
</h3>
<h4><a class="xref" href="Discord.Rest.IRestAudioChannel.html">IRestAudioChannel</a></h4>
<section></section>
<h4><a class="xref" href="Discord.Rest.IRestMessageChannel.html">IRestMessageChannel</a></h4>
<section><p>Represents a REST-based channel that can send and receive messages.</p>
</section>
<h4><a class="xref" href="Discord.Rest.IRestPrivateChannel.html">IRestPrivateChannel</a></h4>
<section><p>Represents a REST-based channel that is private to select recipients.</p>
</section>
</article>
</div>
<div class="hidden-sm col-md-2" role="complementary">
<div class="sideaffix">
<div class="contribution">
<ul class="nav">
</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>