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

397 lines
18 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Interface IInviteMetadata
</title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Interface IInviteMetadata
">
<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.IInviteMetadata">
<h1 id="Discord_IInviteMetadata" data-uid="Discord.IInviteMetadata" class="text-break">Interface IInviteMetadata
</h1>
<div class="markdown level0 summary"><p>Represents additional information regarding the generic invite object.</p>
</div>
<div class="markdown level0 conceptual"></div>
<div class="inheritedMembers">
<h5>Inherited Members</h5>
<div>
<a class="xref" href="Discord.IInvite.html#Discord_IInvite_Code">IInvite.Code</a>
</div>
<div>
<a class="xref" href="Discord.IInvite.html#Discord_IInvite_Url">IInvite.Url</a>
</div>
<div>
<a class="xref" href="Discord.IInvite.html#Discord_IInvite_Channel">IInvite.Channel</a>
</div>
<div>
<a class="xref" href="Discord.IInvite.html#Discord_IInvite_ChannelType">IInvite.ChannelType</a>
</div>
<div>
<a class="xref" href="Discord.IInvite.html#Discord_IInvite_ChannelId">IInvite.ChannelId</a>
</div>
<div>
<a class="xref" href="Discord.IInvite.html#Discord_IInvite_ChannelName">IInvite.ChannelName</a>
</div>
<div>
<a class="xref" href="Discord.IInvite.html#Discord_IInvite_Guild">IInvite.Guild</a>
</div>
<div>
<a class="xref" href="Discord.IInvite.html#Discord_IInvite_GuildId">IInvite.GuildId</a>
</div>
<div>
<a class="xref" href="Discord.IInvite.html#Discord_IInvite_GuildName">IInvite.GuildName</a>
</div>
<div>
<a class="xref" href="Discord.IInvite.html#Discord_IInvite_PresenceCount">IInvite.PresenceCount</a>
</div>
<div>
<a class="xref" href="Discord.IInvite.html#Discord_IInvite_MemberCount">IInvite.MemberCount</a>
</div>
<div>
<a class="xref" href="Discord.IEntity-1.html#Discord_IEntity_1_Id">IEntity&lt;String&gt;.Id</a>
</div>
<div>
<a class="xref" href="Discord.IDeletable.html#Discord_IDeletable_DeleteAsync_Discord_RequestOptions_">IDeletable.DeleteAsync(RequestOptions)</a>
</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_IInviteMetadata_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public interface IInviteMetadata : IInvite, IEntity&lt;string&gt;, IDeletable</code></pre>
</div>
<h3 id="properties">Properties
</h3>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goaaats/Discord.Net/new/dev/apiSpec/new?filename=Discord_IInviteMetadata_CreatedAt.md&amp;value=---%0Auid%3A%20Discord.IInviteMetadata.CreatedAt%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/Invites/IInviteMetadata.cs/#L61">View Source</a>
</span>
<a id="Discord_IInviteMetadata_CreatedAt_" data-uid="Discord.IInviteMetadata.CreatedAt*"></a>
<h4 id="Discord_IInviteMetadata_CreatedAt" data-uid="Discord.IInviteMetadata.CreatedAt">CreatedAt</h4>
<div class="markdown level1 summary"><p>Gets when this invite was created.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">DateTimeOffset? CreatedAt { 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>&lt;<span class="xref">System.DateTimeOffset</span>&gt;</td>
<td><p>A <span class="xref">System.DateTimeOffset</span> representing the time of which the invite was first created.</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_IInviteMetadata_Inviter.md&amp;value=---%0Auid%3A%20Discord.IInviteMetadata.Inviter%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/Invites/IInviteMetadata.cs/#L16">View Source</a>
</span>
<a id="Discord_IInviteMetadata_Inviter_" data-uid="Discord.IInviteMetadata.Inviter*"></a>
<h4 id="Discord_IInviteMetadata_Inviter" data-uid="Discord.IInviteMetadata.Inviter">Inviter</h4>
<div class="markdown level1 summary"><p>Gets the user that created this invite.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">IUser Inviter { 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><a class="xref" href="Discord.IUser.html">IUser</a></td>
<td><p>A user that created this invite.</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_IInviteMetadata_IsRevoked.md&amp;value=---%0Auid%3A%20Discord.IInviteMetadata.IsRevoked%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/Invites/IInviteMetadata.cs/#L23">View Source</a>
</span>
<a id="Discord_IInviteMetadata_IsRevoked_" data-uid="Discord.IInviteMetadata.IsRevoked*"></a>
<h4 id="Discord_IInviteMetadata_IsRevoked" data-uid="Discord.IInviteMetadata.IsRevoked">IsRevoked</h4>
<div class="markdown level1 summary"><p>Gets a value that indicates whether the invite has been revoked.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">bool IsRevoked { 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 invite was revoked; otherwise <code>false</code>.</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_IInviteMetadata_IsTemporary.md&amp;value=---%0Auid%3A%20Discord.IInviteMetadata.IsTemporary%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/Invites/IInviteMetadata.cs/#L31">View Source</a>
</span>
<a id="Discord_IInviteMetadata_IsTemporary_" data-uid="Discord.IInviteMetadata.IsTemporary*"></a>
<h4 id="Discord_IInviteMetadata_IsTemporary" data-uid="Discord.IInviteMetadata.IsTemporary">IsTemporary</h4>
<div class="markdown level1 summary"><p>Gets a value that indicates whether the invite is a temporary one.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">bool IsTemporary { 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 users accepting this invite will be removed from the guild when they log off; otherwise
<code>false</code>.</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_IInviteMetadata_MaxAge.md&amp;value=---%0Auid%3A%20Discord.IInviteMetadata.MaxAge%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/Invites/IInviteMetadata.cs/#L39">View Source</a>
</span>
<a id="Discord_IInviteMetadata_MaxAge_" data-uid="Discord.IInviteMetadata.MaxAge*"></a>
<h4 id="Discord_IInviteMetadata_MaxAge" data-uid="Discord.IInviteMetadata.MaxAge">MaxAge</h4>
<div class="markdown level1 summary"><p>Gets the time (in seconds) until the invite expires.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">int? MaxAge { 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>&lt;<span class="xref">System.Int32</span>&gt;</td>
<td><p>An <span class="xref">System.Int32</span> representing the time in seconds until this invite expires; <code>null</code> if this
invite never expires.</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_IInviteMetadata_MaxUses.md&amp;value=---%0Auid%3A%20Discord.IInviteMetadata.MaxUses%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/Invites/IInviteMetadata.cs/#L47">View Source</a>
</span>
<a id="Discord_IInviteMetadata_MaxUses_" data-uid="Discord.IInviteMetadata.MaxUses*"></a>
<h4 id="Discord_IInviteMetadata_MaxUses" data-uid="Discord.IInviteMetadata.MaxUses">MaxUses</h4>
<div class="markdown level1 summary"><p>Gets the max number of uses this invite may have.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">int? MaxUses { 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>&lt;<span class="xref">System.Int32</span>&gt;</td>
<td><p>An <span class="xref">System.Int32</span> representing the number of uses this invite may be accepted until it is removed
from the guild; <code>null</code> if none is set.</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_IInviteMetadata_Uses.md&amp;value=---%0Auid%3A%20Discord.IInviteMetadata.Uses%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/Invites/IInviteMetadata.cs/#L54">View Source</a>
</span>
<a id="Discord_IInviteMetadata_Uses_" data-uid="Discord.IInviteMetadata.Uses*"></a>
<h4 id="Discord_IInviteMetadata_Uses" data-uid="Discord.IInviteMetadata.Uses">Uses</h4>
<div class="markdown level1 summary"><p>Gets the number of times this invite has been used.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">int? Uses { 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>&lt;<span class="xref">System.Int32</span>&gt;</td>
<td><p>An <span class="xref">System.Int32</span> representing the number of times this invite has been used.</p>
</td>
</tr>
</tbody>
</table>
</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_IInviteMetadata.md&amp;value=---%0Auid%3A%20Discord.IInviteMetadata%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/Invites/IInviteMetadata.cs/#L8" class="contribution-link">View Source</a>
</li>
</ul>
</div>
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
</nav>
</div>
</div>
</div>
</div>
<footer>
<div class="grad-bottom"></div>
<div class="footer">
<div class="container">
<span class="pull-right">
<a href="#top">Back to top</a>
</span>
<span>Generated by <strong>DocFX</strong></span>
</div>
</div>
</footer>
</div>
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
<script type="text/javascript" src="../styles/docfx.js"></script>
<script type="text/javascript" src="../styles/main.js"></script>
</body>
</html>
Reference in a new issue View git blame Copy permalink