mirror of
https://github.com/goatcorp/Dalamud.git
synced 2025-12-13 12:14:16 +01:00
docs: regenerate
This commit is contained in:
parent
3479919ab6
commit
31af5d8d77
88 changed files with 9028 additions and 3189 deletions
|
|
@ -217,7 +217,7 @@ public Actor this[int index] { get; }</code></pre>
|
|||
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_ClientState_Actors_ActorTable_Length.md&value=---%0Auid%3A%20Dalamud.Game.ClientState.Actors.ActorTable.Length%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/Dalamud/blob/master/Dalamud/Game/ClientState/Actors/ActorTable.cs/#L125">View Source</a>
|
||||
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Game/ClientState/Actors/ActorTable.cs/#L103">View Source</a>
|
||||
</span>
|
||||
<a id="Dalamud_Game_ClientState_Actors_ActorTable_Length_" data-uid="Dalamud.Game.ClientState.Actors.ActorTable.Length*"></a>
|
||||
<h4 id="Dalamud_Game_ClientState_Actors_ActorTable_Length" data-uid="Dalamud.Game.ClientState.Actors.ActorTable.Length">Length</h4>
|
||||
|
|
@ -250,7 +250,7 @@ public Actor this[int index] { get; }</code></pre>
|
|||
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_ClientState_Actors_ActorTable_GetEnumerator.md&value=---%0Auid%3A%20Dalamud.Game.ClientState.Actors.ActorTable.GetEnumerator%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/Dalamud/blob/master/Dalamud/Game/ClientState/Actors/ActorTable.cs/#L114">View Source</a>
|
||||
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Game/ClientState/Actors/ActorTable.cs/#L88">View Source</a>
|
||||
</span>
|
||||
<a id="Dalamud_Game_ClientState_Actors_ActorTable_GetEnumerator_" data-uid="Dalamud.Game.ClientState.Actors.ActorTable.GetEnumerator*"></a>
|
||||
<h4 id="Dalamud_Game_ClientState_Actors_ActorTable_GetEnumerator" data-uid="Dalamud.Game.ClientState.Actors.ActorTable.GetEnumerator">GetEnumerator()</h4>
|
||||
|
|
@ -282,7 +282,7 @@ public Actor this[int index] { get; }</code></pre>
|
|||
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_ClientState_Actors_ActorTable_System_Collections_Generic_IReadOnlyCollection_Dalamud_Game_ClientState_Actors_Types_Actor__Count.md&value=---%0Auid%3A%20Dalamud.Game.ClientState.Actors.ActorTable.System%23Collections%23Generic%23IReadOnlyCollection%7BDalamud%23Game%23ClientState%23Actors%23Types%23Actor%7D%23Count%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/Dalamud/blob/master/Dalamud/Game/ClientState/Actors/ActorTable.cs/#L127">View Source</a>
|
||||
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Game/ClientState/Actors/ActorTable.cs/#L105">View Source</a>
|
||||
</span>
|
||||
<a id="Dalamud_Game_ClientState_Actors_ActorTable_System_Collections_Generic_IReadOnlyCollection_Dalamud_Game_ClientState_Actors_Types_Actor__Count_" data-uid="Dalamud.Game.ClientState.Actors.ActorTable.System#Collections#Generic#IReadOnlyCollection{Dalamud#Game#ClientState#Actors#Types#Actor}#Count*"></a>
|
||||
<h4 id="Dalamud_Game_ClientState_Actors_ActorTable_System_Collections_Generic_IReadOnlyCollection_Dalamud_Game_ClientState_Actors_Types_Actor__Count" data-uid="Dalamud.Game.ClientState.Actors.ActorTable.System#Collections#Generic#IReadOnlyCollection{Dalamud#Game#ClientState#Actors#Types#Actor}#Count">IReadOnlyCollection<Actor>.Count</h4>
|
||||
|
|
@ -312,7 +312,7 @@ public Actor this[int index] { get; }</code></pre>
|
|||
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_ClientState_Actors_ActorTable_System_Collections_ICollection_CopyTo_System_Array_System_Int32_.md&value=---%0Auid%3A%20Dalamud.Game.ClientState.Actors.ActorTable.System%23Collections%23ICollection%23CopyTo(System.Array%2CSystem.Int32)%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/Dalamud/blob/master/Dalamud/Game/ClientState/Actors/ActorTable.cs/#L135">View Source</a>
|
||||
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Game/ClientState/Actors/ActorTable.cs/#L113">View Source</a>
|
||||
</span>
|
||||
<a id="Dalamud_Game_ClientState_Actors_ActorTable_System_Collections_ICollection_CopyTo_" data-uid="Dalamud.Game.ClientState.Actors.ActorTable.System#Collections#ICollection#CopyTo*"></a>
|
||||
<h4 id="Dalamud_Game_ClientState_Actors_ActorTable_System_Collections_ICollection_CopyTo_System_Array_System_Int32_" data-uid="Dalamud.Game.ClientState.Actors.ActorTable.System#Collections#ICollection#CopyTo(System.Array,System.Int32)">ICollection.CopyTo(Array, Int32)</h4>
|
||||
|
|
@ -349,7 +349,7 @@ public Actor this[int index] { get; }</code></pre>
|
|||
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_ClientState_Actors_ActorTable_System_Collections_ICollection_Count.md&value=---%0Auid%3A%20Dalamud.Game.ClientState.Actors.ActorTable.System%23Collections%23ICollection%23Count%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/Dalamud/blob/master/Dalamud/Game/ClientState/Actors/ActorTable.cs/#L129">View Source</a>
|
||||
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Game/ClientState/Actors/ActorTable.cs/#L107">View Source</a>
|
||||
</span>
|
||||
<a id="Dalamud_Game_ClientState_Actors_ActorTable_System_Collections_ICollection_Count_" data-uid="Dalamud.Game.ClientState.Actors.ActorTable.System#Collections#ICollection#Count*"></a>
|
||||
<h4 id="Dalamud_Game_ClientState_Actors_ActorTable_System_Collections_ICollection_Count" data-uid="Dalamud.Game.ClientState.Actors.ActorTable.System#Collections#ICollection#Count">ICollection.Count</h4>
|
||||
|
|
@ -379,7 +379,7 @@ public Actor this[int index] { get; }</code></pre>
|
|||
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_ClientState_Actors_ActorTable_System_Collections_ICollection_IsSynchronized.md&value=---%0Auid%3A%20Dalamud.Game.ClientState.Actors.ActorTable.System%23Collections%23ICollection%23IsSynchronized%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/Dalamud/blob/master/Dalamud/Game/ClientState/Actors/ActorTable.cs/#L131">View Source</a>
|
||||
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Game/ClientState/Actors/ActorTable.cs/#L109">View Source</a>
|
||||
</span>
|
||||
<a id="Dalamud_Game_ClientState_Actors_ActorTable_System_Collections_ICollection_IsSynchronized_" data-uid="Dalamud.Game.ClientState.Actors.ActorTable.System#Collections#ICollection#IsSynchronized*"></a>
|
||||
<h4 id="Dalamud_Game_ClientState_Actors_ActorTable_System_Collections_ICollection_IsSynchronized" data-uid="Dalamud.Game.ClientState.Actors.ActorTable.System#Collections#ICollection#IsSynchronized">ICollection.IsSynchronized</h4>
|
||||
|
|
@ -409,7 +409,7 @@ public Actor this[int index] { get; }</code></pre>
|
|||
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_ClientState_Actors_ActorTable_System_Collections_ICollection_SyncRoot.md&value=---%0Auid%3A%20Dalamud.Game.ClientState.Actors.ActorTable.System%23Collections%23ICollection%23SyncRoot%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/Dalamud/blob/master/Dalamud/Game/ClientState/Actors/ActorTable.cs/#L133">View Source</a>
|
||||
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Game/ClientState/Actors/ActorTable.cs/#L111">View Source</a>
|
||||
</span>
|
||||
<a id="Dalamud_Game_ClientState_Actors_ActorTable_System_Collections_ICollection_SyncRoot_" data-uid="Dalamud.Game.ClientState.Actors.ActorTable.System#Collections#ICollection#SyncRoot*"></a>
|
||||
<h4 id="Dalamud_Game_ClientState_Actors_ActorTable_System_Collections_ICollection_SyncRoot" data-uid="Dalamud.Game.ClientState.Actors.ActorTable.System#Collections#ICollection#SyncRoot">ICollection.SyncRoot</h4>
|
||||
|
|
@ -439,7 +439,7 @@ public Actor this[int index] { get; }</code></pre>
|
|||
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_ClientState_Actors_ActorTable_System_Collections_IEnumerable_GetEnumerator.md&value=---%0Auid%3A%20Dalamud.Game.ClientState.Actors.ActorTable.System%23Collections%23IEnumerable%23GetEnumerator%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/Dalamud/blob/master/Dalamud/Game/ClientState/Actors/ActorTable.cs/#L118">View Source</a>
|
||||
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Game/ClientState/Actors/ActorTable.cs/#L96">View Source</a>
|
||||
</span>
|
||||
<a id="Dalamud_Game_ClientState_Actors_ActorTable_System_Collections_IEnumerable_GetEnumerator_" data-uid="Dalamud.Game.ClientState.Actors.ActorTable.System#Collections#IEnumerable#GetEnumerator*"></a>
|
||||
<h4 id="Dalamud_Game_ClientState_Actors_ActorTable_System_Collections_IEnumerable_GetEnumerator" data-uid="Dalamud.Game.ClientState.Actors.ActorTable.System#Collections#IEnumerable#GetEnumerator">IEnumerable.GetEnumerator()</h4>
|
||||
|
|
|
|||
|
|
@ -410,6 +410,37 @@ This ranges from -pi to pi radians.</p>
|
|||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_ClientState_Actors_Types_Actor_TargetActorID.md&value=---%0Auid%3A%20Dalamud.Game.ClientState.Actors.Types.Actor.TargetActorID%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/Dalamud/blob/master/Dalamud/Game/ClientState/Actors/Types/Actor.cs/#L72">View Source</a>
|
||||
</span>
|
||||
<a id="Dalamud_Game_ClientState_Actors_Types_Actor_TargetActorID_" data-uid="Dalamud.Game.ClientState.Actors.Types.Actor.TargetActorID*"></a>
|
||||
<h4 id="Dalamud_Game_ClientState_Actors_Types_Actor_TargetActorID" data-uid="Dalamud.Game.ClientState.Actors.Types.Actor.TargetActorID">TargetActorID</h4>
|
||||
<div class="markdown level1 summary"><p>The target of the actor</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public virtual int TargetActorID { 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.Int32</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_ClientState_Actors_Types_Actor_YalmDistanceX.md&value=---%0Auid%3A%20Dalamud.Game.ClientState.Actors.Types.Actor.YalmDistanceX%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>
|
||||
|
|
|
|||
|
|
@ -116,6 +116,9 @@
|
|||
<div>
|
||||
<a class="xref" href="Dalamud.Game.ClientState.Actors.Types.Actor.html#Dalamud_Game_ClientState_Actors_Types_Actor_YalmDistanceY">Actor.YalmDistanceY</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Dalamud.Game.ClientState.Actors.Types.Actor.html#Dalamud_Game_ClientState_Actors_Types_Actor_TargetActorID">Actor.TargetActorID</a>
|
||||
</div>
|
||||
<div>
|
||||
<span class="xref">System.Object.ToString()</span>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -283,6 +283,39 @@
|
|||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_ClientState_Actors_Types_NonPlayer_BattleNpc_TargetActorID.md&value=---%0Auid%3A%20Dalamud.Game.ClientState.Actors.Types.NonPlayer.BattleNpc.TargetActorID%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/Dalamud/blob/master/Dalamud/Game/ClientState/Actors/Types/NonPlayer/BattleNpc.cs/#L29">View Source</a>
|
||||
</span>
|
||||
<a id="Dalamud_Game_ClientState_Actors_Types_NonPlayer_BattleNpc_TargetActorID_" data-uid="Dalamud.Game.ClientState.Actors.Types.NonPlayer.BattleNpc.TargetActorID*"></a>
|
||||
<h4 id="Dalamud_Game_ClientState_Actors_Types_NonPlayer_BattleNpc_TargetActorID" data-uid="Dalamud.Game.ClientState.Actors.Types.NonPlayer.BattleNpc.TargetActorID">TargetActorID</h4>
|
||||
<div class="markdown level1 summary"><p>Target of the Battle NPC</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public override int TargetActorID { 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.Int32</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 class="overrides">Overrides</h5>
|
||||
<div><a class="xref" href="Dalamud.Game.ClientState.Actors.Types.Actor.html#Dalamud_Game_ClientState_Actors_Types_Actor_TargetActorID">Actor.TargetActorID</a></div>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
|
|
|
|||
|
|
@ -137,6 +137,9 @@
|
|||
<div>
|
||||
<a class="xref" href="Dalamud.Game.ClientState.Actors.Types.Actor.html#Dalamud_Game_ClientState_Actors_Types_Actor_YalmDistanceY">Actor.YalmDistanceY</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="Dalamud.Game.ClientState.Actors.Types.Actor.html#Dalamud_Game_ClientState_Actors_Types_Actor_TargetActorID">Actor.TargetActorID</a>
|
||||
</div>
|
||||
<div>
|
||||
<span class="xref">System.Object.ToString()</span>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -307,6 +307,39 @@
|
|||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_ClientState_Actors_Types_PlayerCharacter_TargetActorID.md&value=---%0Auid%3A%20Dalamud.Game.ClientState.Actors.Types.PlayerCharacter.TargetActorID%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/Dalamud/blob/master/Dalamud/Game/ClientState/Actors/Types/PlayerCharacter.cs/#L36">View Source</a>
|
||||
</span>
|
||||
<a id="Dalamud_Game_ClientState_Actors_Types_PlayerCharacter_TargetActorID_" data-uid="Dalamud.Game.ClientState.Actors.Types.PlayerCharacter.TargetActorID*"></a>
|
||||
<h4 id="Dalamud_Game_ClientState_Actors_Types_PlayerCharacter_TargetActorID" data-uid="Dalamud.Game.ClientState.Actors.Types.PlayerCharacter.TargetActorID">TargetActorID</h4>
|
||||
<div class="markdown level1 summary"><p>Target of the PlayerCharacter</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public override int TargetActorID { 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.Int32</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 class="overrides">Overrides</h5>
|
||||
<div><a class="xref" href="Dalamud.Game.ClientState.Actors.Types.Actor.html#Dalamud_Game_ClientState_Actors_Types_Actor_TargetActorID">Actor.TargetActorID</a></div>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
|
|
|
|||
|
|
@ -123,7 +123,7 @@
|
|||
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_ClientState_ClientState__ctor_Dalamud_Dalamud_Dalamud_DalamudStartInfo_Dalamud_Game_SigScanner_.md&value=---%0Auid%3A%20Dalamud.Game.ClientState.ClientState.%23ctor(Dalamud.Dalamud%2CDalamud.DalamudStartInfo%2CDalamud.Game.SigScanner)%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/Dalamud/blob/master/Dalamud/Game/ClientState/ClientState.cs/#L101">View Source</a>
|
||||
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Game/ClientState/ClientState.cs/#L106">View Source</a>
|
||||
</span>
|
||||
<a id="Dalamud_Game_ClientState_ClientState__ctor_" data-uid="Dalamud.Game.ClientState.ClientState.#ctor*"></a>
|
||||
<h4 id="Dalamud_Game_ClientState_ClientState__ctor_Dalamud_Dalamud_Dalamud_DalamudStartInfo_Dalamud_Game_SigScanner_" data-uid="Dalamud.Game.ClientState.ClientState.#ctor(Dalamud.Dalamud,Dalamud.DalamudStartInfo,Dalamud.Game.SigScanner)">ClientState(Dalamud, DalamudStartInfo, SigScanner)</h4>
|
||||
|
|
@ -225,6 +225,36 @@
|
|||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_ClientState_ClientState_Condition.md&value=---%0Auid%3A%20Dalamud.Game.ClientState.ClientState.Condition%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/Dalamud/blob/master/Dalamud/Game/ClientState/ClientState.cs/#L98">View Source</a>
|
||||
</span>
|
||||
<h4 id="Dalamud_Game_ClientState_ClientState_Condition" data-uid="Dalamud.Game.ClientState.ClientState.Condition">Condition</h4>
|
||||
<div class="markdown level1 summary"><p>Provides access to client conditions/player state. Allows you to check if a player is in a duty, mounted, etc.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public Condition Condition</code></pre>
|
||||
</div>
|
||||
<h5 class="fieldValue">Field 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="Dalamud.Game.ClientState.Condition.html">Condition</a></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_ClientState_ClientState_JobGauges.md&value=---%0Auid%3A%20Dalamud.Game.ClientState.ClientState.JobGauges%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>
|
||||
|
|
@ -447,7 +477,7 @@ public PlayerCharacter LocalPlayer { get; }</code></pre>
|
|||
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_ClientState_ClientState_Dispose.md&value=---%0Auid%3A%20Dalamud.Game.ClientState.ClientState.Dispose%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/Dalamud/blob/master/Dalamud/Game/ClientState/ClientState.cs/#L131">View Source</a>
|
||||
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Game/ClientState/ClientState.cs/#L138">View Source</a>
|
||||
</span>
|
||||
<a id="Dalamud_Game_ClientState_ClientState_Dispose_" data-uid="Dalamud.Game.ClientState.ClientState.Dispose*"></a>
|
||||
<h4 id="Dalamud_Game_ClientState_ClientState_Dispose" data-uid="Dalamud.Game.ClientState.ClientState.Dispose">Dispose()</h4>
|
||||
|
|
@ -462,7 +492,7 @@ public PlayerCharacter LocalPlayer { get; }</code></pre>
|
|||
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_ClientState_ClientState_Enable.md&value=---%0Auid%3A%20Dalamud.Game.ClientState.ClientState.Enable%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/Dalamud/blob/master/Dalamud/Game/ClientState/ClientState.cs/#L126">View Source</a>
|
||||
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Game/ClientState/ClientState.cs/#L133">View Source</a>
|
||||
</span>
|
||||
<a id="Dalamud_Game_ClientState_ClientState_Enable_" data-uid="Dalamud.Game.ClientState.ClientState.Enable*"></a>
|
||||
<h4 id="Dalamud_Game_ClientState_ClientState_Enable" data-uid="Dalamud.Game.ClientState.ClientState.Enable">Enable()</h4>
|
||||
|
|
|
|||
238
docs/api/Dalamud.Game.ClientState.Condition.html
Normal file
238
docs/api/Dalamud.Game.ClientState.Condition.html
Normal file
|
|
@ -0,0 +1,238 @@
|
|||
<!DOCTYPE html>
|
||||
<!--[if IE]><![endif]-->
|
||||
<html>
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||||
<title>Class Condition
|
||||
</title>
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<meta name="title" content="Class Condition
|
||||
">
|
||||
<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="Dalamud.Game.ClientState.Condition">
|
||||
|
||||
|
||||
<h1 id="Dalamud_Game_ClientState_Condition" data-uid="Dalamud.Game.ClientState.Condition" class="text-break">Class Condition
|
||||
</h1>
|
||||
<div class="markdown level0 summary"><p>Provides access to conditions (generally player state). You can check whether a player is in combat, mounted, etc.</p>
|
||||
</div>
|
||||
<div class="markdown level0 conceptual"></div>
|
||||
<div class="inheritance">
|
||||
<h5>Inheritance</h5>
|
||||
<div class="level0"><span class="xref">System.Object</span></div>
|
||||
<div class="level1"><span class="xref">Condition</span></div>
|
||||
</div>
|
||||
<div class="inheritedMembers">
|
||||
<h5>Inherited Members</h5>
|
||||
<div>
|
||||
<span class="xref">System.Object.ToString()</span>
|
||||
</div>
|
||||
<div>
|
||||
<span class="xref">System.Object.Equals(System.Object)</span>
|
||||
</div>
|
||||
<div>
|
||||
<span class="xref">System.Object.Equals(System.Object, System.Object)</span>
|
||||
</div>
|
||||
<div>
|
||||
<span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
|
||||
</div>
|
||||
<div>
|
||||
<span class="xref">System.Object.GetHashCode()</span>
|
||||
</div>
|
||||
<div>
|
||||
<span class="xref">System.Object.GetType()</span>
|
||||
</div>
|
||||
<div>
|
||||
<span class="xref">System.Object.MemberwiseClone()</span>
|
||||
</div>
|
||||
</div>
|
||||
<h6><strong>Namespace</strong>: <a class="xref" href="Dalamud.Game.ClientState.html">Dalamud.Game.ClientState</a></h6>
|
||||
<h6><strong>Assembly</strong>: Dalamud.dll</h6>
|
||||
<h5 id="Dalamud_Game_ClientState_Condition_syntax">Syntax</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class Condition</code></pre>
|
||||
</div>
|
||||
<h3 id="fields">Fields
|
||||
</h3>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_ClientState_Condition_MaxConditionEntries.md&value=---%0Auid%3A%20Dalamud.Game.ClientState.Condition.MaxConditionEntries%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/Dalamud/blob/master/Dalamud/Game/ClientState/Condition.cs/#L18">View Source</a>
|
||||
</span>
|
||||
<h4 id="Dalamud_Game_ClientState_Condition_MaxConditionEntries" data-uid="Dalamud.Game.ClientState.Condition.MaxConditionEntries">MaxConditionEntries</h4>
|
||||
<div class="markdown level1 summary"><p>The current max number of conditions. You can get this just by looking at the condition sheet and how many rows it has.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public const int MaxConditionEntries = 100</code></pre>
|
||||
</div>
|
||||
<h5 class="fieldValue">Field 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.Int32</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3 id="properties">Properties
|
||||
</h3>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_ClientState_Condition_Item_Dalamud_Game_ClientState_ConditionFlag_.md&value=---%0Auid%3A%20Dalamud.Game.ClientState.Condition.Item(Dalamud.Game.ClientState.ConditionFlag)%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/Dalamud/blob/master/Dalamud/Game/ClientState/Condition.cs/#L29">View Source</a>
|
||||
</span>
|
||||
<a id="Dalamud_Game_ClientState_Condition_Item_" data-uid="Dalamud.Game.ClientState.Condition.Item*"></a>
|
||||
<h4 id="Dalamud_Game_ClientState_Condition_Item_Dalamud_Game_ClientState_ConditionFlag_" data-uid="Dalamud.Game.ClientState.Condition.Item(Dalamud.Game.ClientState.ConditionFlag)">Item[ConditionFlag]</h4>
|
||||
<div class="markdown level1 summary"><p>Check the value of a specific condition/state flag.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public bool this[ConditionFlag flag] { get; }</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="Dalamud.Game.ClientState.ConditionFlag.html">ConditionFlag</a></td>
|
||||
<td><span class="parametername">flag</span></td>
|
||||
<td><p>The condition flag to check</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<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></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/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_ClientState_Condition.md&value=---%0Auid%3A%20Dalamud.Game.ClientState.Condition%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/Dalamud/blob/master/Dalamud/Game/ClientState/Condition.cs/#L11" 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>
|
||||
569
docs/api/Dalamud.Game.ClientState.ConditionFlag.html
Normal file
569
docs/api/Dalamud.Game.ClientState.ConditionFlag.html
Normal file
|
|
@ -0,0 +1,569 @@
|
|||
<!DOCTYPE html>
|
||||
<!--[if IE]><![endif]-->
|
||||
<html>
|
||||
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||||
<title>Enum ConditionFlag
|
||||
</title>
|
||||
<meta name="viewport" content="width=device-width">
|
||||
<meta name="title" content="Enum ConditionFlag
|
||||
">
|
||||
<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="Dalamud.Game.ClientState.ConditionFlag">
|
||||
|
||||
|
||||
<h1 id="Dalamud_Game_ClientState_ConditionFlag" data-uid="Dalamud.Game.ClientState.ConditionFlag" class="text-break">Enum ConditionFlag
|
||||
</h1>
|
||||
<div class="markdown level0 summary"><p>Possible state flags (or conditions as they're called internally) that can be set on the local client.</p>
|
||||
<p>These come from LogMessage (somewhere) and directly map to each state field managed by the client. As of 5.25, it maps to
|
||||
LogMessage row 7700 and onwards, which can be checked by looking at the Condition sheet and looking at what column 2 maps to.</p>
|
||||
</div>
|
||||
<div class="markdown level0 conceptual"></div>
|
||||
<h6><strong>Namespace</strong>: <a class="xref" href="Dalamud.Game.ClientState.html">Dalamud.Game.ClientState</a></h6>
|
||||
<h6><strong>Assembly</strong>: Dalamud.dll</h6>
|
||||
<h5 id="Dalamud_Game_ClientState_ConditionFlag_syntax">Syntax</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public enum ConditionFlag</code></pre>
|
||||
</div>
|
||||
<h3 id="fields">Fields
|
||||
</h3>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
<thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td id="Dalamud_Game_ClientState_ConditionFlag_AutorunActive">AutorunActive</td>
|
||||
<td><p>Unable to execute command while auto-run is active.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td id="Dalamud_Game_ClientState_ConditionFlag_BeingMoved">BeingMoved</td>
|
||||
<td><p>Unable to execute command while being moved.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td id="Dalamud_Game_ClientState_ConditionFlag_BetweenAreas">BetweenAreas</td>
|
||||
<td><p>Unable to execute command while between areas.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td id="Dalamud_Game_ClientState_ConditionFlag_BetweenAreas51">BetweenAreas51</td>
|
||||
<td><p>Unable to execute command while between areas.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td id="Dalamud_Game_ClientState_ConditionFlag_BoundByDuty">BoundByDuty</td>
|
||||
<td><p>Unable to execute command while bound by duty.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td id="Dalamud_Game_ClientState_ConditionFlag_BoundByDuty56">BoundByDuty56</td>
|
||||
<td><p>Unable to execute command while bound by duty.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td id="Dalamud_Game_ClientState_ConditionFlag_BoundByDuty95">BoundByDuty95</td>
|
||||
<td><p>Unable to execute command while bound by duty.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td id="Dalamud_Game_ClientState_ConditionFlag_BoundToDuty97">BoundToDuty97</td>
|
||||
<td><p>Unable to execute command while bound by duty.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td id="Dalamud_Game_ClientState_ConditionFlag_CarryingItem">CarryingItem</td>
|
||||
<td><p>Unable to execute command while carrying an item.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td id="Dalamud_Game_ClientState_ConditionFlag_CarryingObject">CarryingObject</td>
|
||||
<td><p>Unable to execute command while carrying an object.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td id="Dalamud_Game_ClientState_ConditionFlag_Casting">Casting</td>
|
||||
<td><p>Unable to execute command while casting.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td id="Dalamud_Game_ClientState_ConditionFlag_Casting87">Casting87</td>
|
||||
<td><p>Unable to execute command while casting.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td id="Dalamud_Game_ClientState_ConditionFlag_ChocoboRacing">ChocoboRacing</td>
|
||||
<td><p>Unable to execute command while chocobo racing.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td id="Dalamud_Game_ClientState_ConditionFlag_ConditionLocation">ConditionLocation</td>
|
||||
<td><p>Unable to execute command at this location.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td id="Dalamud_Game_ClientState_ConditionFlag_Crafting">Crafting</td>
|
||||
<td><p>Unable to execute command while crafting.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td id="Dalamud_Game_ClientState_ConditionFlag_Crafting40">Crafting40</td>
|
||||
<td><p>Unable to execute command while crafting.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td id="Dalamud_Game_ClientState_ConditionFlag_CreatingCharacter">CreatingCharacter</td>
|
||||
<td><p>Unable to execute command while creating a character.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td id="Dalamud_Game_ClientState_ConditionFlag_Diving">Diving</td>
|
||||
<td><p>Unable to execute command while diving.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td id="Dalamud_Game_ClientState_ConditionFlag_DutyRecorderPlayback">DutyRecorderPlayback</td>
|
||||
<td><p>Unable to execute command while playing duty record.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td id="Dalamud_Game_ClientState_ConditionFlag_Emoting">Emoting</td>
|
||||
<td><p>Unable to execute command during an emote.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td id="Dalamud_Game_ClientState_ConditionFlag_Fishing">Fishing</td>
|
||||
<td><p>Unable to execute command while fishing.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td id="Dalamud_Game_ClientState_ConditionFlag_Gathering">Gathering</td>
|
||||
<td><p>Unable to execute command while gathering.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td id="Dalamud_Game_ClientState_ConditionFlag_Gathering42">Gathering42</td>
|
||||
<td><p>Unable to execute command while gathering.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td id="Dalamud_Game_ClientState_ConditionFlag_InCombat">InCombat</td>
|
||||
<td><p>Unable to execute command during combat.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td id="Dalamud_Game_ClientState_ConditionFlag_InDeepDungeon">InDeepDungeon</td>
|
||||
<td><p>Unable to execute command while delving into a deep dungeon.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td id="Dalamud_Game_ClientState_ConditionFlag_InDuelingArea">InDuelingArea</td>
|
||||
<td><p>Unable to execute command while in a dueling area.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td id="Dalamud_Game_ClientState_ConditionFlag_InFlight">InFlight</td>
|
||||
<td><p>Unable to execute command while in flight.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td id="Dalamud_Game_ClientState_ConditionFlag_InThatPosition">InThatPosition</td>
|
||||
<td><p>Unable to execute command while in that position.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td id="Dalamud_Game_ClientState_ConditionFlag_InThisState88">InThisState88</td>
|
||||
<td><p>Unable to execute command in this state.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td id="Dalamud_Game_ClientState_ConditionFlag_InThisState89">InThisState89</td>
|
||||
<td><p>Unable to execute command in this state.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td id="Dalamud_Game_ClientState_ConditionFlag_Jumping">Jumping</td>
|
||||
<td><p>Unable to execute command while jumping.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td id="Dalamud_Game_ClientState_ConditionFlag_Jumping61">Jumping61</td>
|
||||
<td><p>Unable to execute command while jumping.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td id="Dalamud_Game_ClientState_ConditionFlag_LoggingOut">LoggingOut</td>
|
||||
<td><p>Unable to execute command while logging out.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td id="Dalamud_Game_ClientState_ConditionFlag_MeldingMateria">MeldingMateria</td>
|
||||
<td><p>Unable to execute command while melding materia.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td id="Dalamud_Game_ClientState_ConditionFlag_Mounted">Mounted</td>
|
||||
<td><p>Unable to execute command while mounted.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td id="Dalamud_Game_ClientState_ConditionFlag_Mounted2">Mounted2</td>
|
||||
<td><p>Unable to execute command while mounted.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td id="Dalamud_Game_ClientState_ConditionFlag_Mounting">Mounting</td>
|
||||
<td><p>Unable to execute command while mounting.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td id="Dalamud_Game_ClientState_ConditionFlag_Mounting71">Mounting71</td>
|
||||
<td><p>Unable to execute command while mounting.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td id="Dalamud_Game_ClientState_ConditionFlag_None">None</td>
|
||||
<td><p>Unused.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td id="Dalamud_Game_ClientState_ConditionFlag_NormalConditions">NormalConditions</td>
|
||||
<td><p>Unable to execute command under normal conditions.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td id="Dalamud_Game_ClientState_ConditionFlag_Occupied">Occupied</td>
|
||||
<td><p>Unable to execute command while occupied.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td id="Dalamud_Game_ClientState_ConditionFlag_Occupied30">Occupied30</td>
|
||||
<td><p>Unable to execute command while occupied.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td id="Dalamud_Game_ClientState_ConditionFlag_Occupied33">Occupied33</td>
|
||||
<td><p>Unable to execute command while occupied.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td id="Dalamud_Game_ClientState_ConditionFlag_Occupied38">Occupied38</td>
|
||||
<td><p>Unable to execute command while occupied.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td id="Dalamud_Game_ClientState_ConditionFlag_Occupied39">Occupied39</td>
|
||||
<td><p>Unable to execute command while occupied.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td id="Dalamud_Game_ClientState_ConditionFlag_OccupiedInCutSceneEvent">OccupiedInCutSceneEvent</td>
|
||||
<td><p>Unable to execute command while occupied.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td id="Dalamud_Game_ClientState_ConditionFlag_OccupiedInEvent">OccupiedInEvent</td>
|
||||
<td><p>Unable to execute command while occupied.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td id="Dalamud_Game_ClientState_ConditionFlag_OccupiedInQuestEvent">OccupiedInQuestEvent</td>
|
||||
<td><p>Unable to execute command while occupied.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td id="Dalamud_Game_ClientState_ConditionFlag_OccupiedSummoningBell">OccupiedSummoningBell</td>
|
||||
<td><p>Unable to execute command while occupied.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td id="Dalamud_Game_ClientState_ConditionFlag_OnFreeTrial">OnFreeTrial</td>
|
||||
<td><p>Unable to execute command while on the free trial.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td id="Dalamud_Game_ClientState_ConditionFlag_OperatingSiegeMachine">OperatingSiegeMachine</td>
|
||||
<td><p>Unable to execute command while operating a siege machine.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td id="Dalamud_Game_ClientState_ConditionFlag_ParticipatingInCrossWorldPartyOrAlliance">ParticipatingInCrossWorldPartyOrAlliance</td>
|
||||
<td><p>Unable to execute command while participating in a cross-world party or alliance.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td id="Dalamud_Game_ClientState_ConditionFlag_ParticipatingInCustomMatch">ParticipatingInCustomMatch</td>
|
||||
<td><p>Unable to execute command while participating in a custom match.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td id="Dalamud_Game_ClientState_ConditionFlag_Performing">Performing</td>
|
||||
<td><p>Unable to execute command while performing.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td id="Dalamud_Game_ClientState_ConditionFlag_PlayingLordOfVerminion">PlayingLordOfVerminion</td>
|
||||
<td><p>Unable to execute command while playing Lord of Verminion.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td id="Dalamud_Game_ClientState_ConditionFlag_PlayingMiniGame">PlayingMiniGame</td>
|
||||
<td><p>Unable to execute command while playing a mini-game.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td id="Dalamud_Game_ClientState_ConditionFlag_PreparingToCraft">PreparingToCraft</td>
|
||||
<td><p>Unable to execute command while preparing to craft.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td id="Dalamud_Game_ClientState_ConditionFlag_PvPDisplayActive">PvPDisplayActive</td>
|
||||
<td><p>Unable to execute command while the PvP display is active.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td id="Dalamud_Game_ClientState_ConditionFlag_ReadyingVisitOtherWorld">ReadyingVisitOtherWorld</td>
|
||||
<td><p>Unable to execute command while readying to visit another World.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td id="Dalamud_Game_ClientState_ConditionFlag_RegisteringForRaceOrMatch">RegisteringForRaceOrMatch</td>
|
||||
<td><p>Unable to execute command while registering for a race or match.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td id="Dalamud_Game_ClientState_ConditionFlag_RegisteringForTripleTriadMatch">RegisteringForTripleTriadMatch</td>
|
||||
<td><p>Unable to execute command while registering for a Triple Triad match.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td id="Dalamud_Game_ClientState_ConditionFlag_RolePlaying">RolePlaying</td>
|
||||
<td><p>Unable to execute command while role-playing.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td id="Dalamud_Game_ClientState_ConditionFlag_Stealthed">Stealthed</td>
|
||||
<td><p>Unable to execute command while stealthed.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td id="Dalamud_Game_ClientState_ConditionFlag_SufferingStatusAffliction">SufferingStatusAffliction</td>
|
||||
<td><p>Unable to execute command while suffering status affliction.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td id="Dalamud_Game_ClientState_ConditionFlag_SufferingStatusAffliction2">SufferingStatusAffliction2</td>
|
||||
<td><p>Unable to execute command while suffering status affliction.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td id="Dalamud_Game_ClientState_ConditionFlag_SufferingStatusAffliction63">SufferingStatusAffliction63</td>
|
||||
<td><p>Unable to execute command while suffering status affliction.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td id="Dalamud_Game_ClientState_ConditionFlag_SufferingStatusAffliction72">SufferingStatusAffliction72</td>
|
||||
<td><p>Unable to execute command while suffering status affliction.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td id="Dalamud_Game_ClientState_ConditionFlag_SufferingStatusAffliction73">SufferingStatusAffliction73</td>
|
||||
<td><p>Unable to execute command while suffering status affliction.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td id="Dalamud_Game_ClientState_ConditionFlag_Swimming">Swimming</td>
|
||||
<td><p>Unable to execute command while swimming.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td id="Dalamud_Game_ClientState_ConditionFlag_SystemError">SystemError</td>
|
||||
<td><p>Unable to execute command due to system error.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td id="Dalamud_Game_ClientState_ConditionFlag_TradeOpen">TradeOpen</td>
|
||||
<td><p>Unable to execute command while a trade is open.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td id="Dalamud_Game_ClientState_ConditionFlag_Transformed">Transformed</td>
|
||||
<td><p>Unable to execute command while transformed.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td id="Dalamud_Game_ClientState_ConditionFlag_Unconscious">Unconscious</td>
|
||||
<td><p>Unable to execute command while unconscious.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td id="Dalamud_Game_ClientState_ConditionFlag_Unknown57">Unknown57</td>
|
||||
<td><p>Unable to execute command at this time.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td id="Dalamud_Game_ClientState_ConditionFlag_UsingHousingFunctions">UsingHousingFunctions</td>
|
||||
<td><p>Unable to execute command while using housing functions.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td id="Dalamud_Game_ClientState_ConditionFlag_UsingParasol">UsingParasol</td>
|
||||
<td><p>Unable to execute command while using a parasol.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td id="Dalamud_Game_ClientState_ConditionFlag_UsingPartyFinder">UsingPartyFinder</td>
|
||||
<td><p>Unable to execute command while using the Party Finder.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td id="Dalamud_Game_ClientState_ConditionFlag_WaitingForDuty">WaitingForDuty</td>
|
||||
<td><p>Unable to execute command while waiting for duty.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td id="Dalamud_Game_ClientState_ConditionFlag_WaitingForDutyFinder">WaitingForDutyFinder</td>
|
||||
<td><p>Unable to execute command while waiting for Duty Finder.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td id="Dalamud_Game_ClientState_ConditionFlag_WaitingForRaceOrMatch">WaitingForRaceOrMatch</td>
|
||||
<td><p>Unable to execute command while waiting for a race or match.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td id="Dalamud_Game_ClientState_ConditionFlag_WaitingForTripleTriadMatch">WaitingForTripleTriadMatch</td>
|
||||
<td><p>Unable to execute command while waiting for a Triple Triad match.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td id="Dalamud_Game_ClientState_ConditionFlag_WaitingForTripleTriadMatch83">WaitingForTripleTriadMatch83</td>
|
||||
<td><p>Unable to execute command while waiting for a Triple Triad match.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td id="Dalamud_Game_ClientState_ConditionFlag_WaitingToVisitOtherWorld">WaitingToVisitOtherWorld</td>
|
||||
<td><p>Unable to execute command while waiting to visit another World.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td id="Dalamud_Game_ClientState_ConditionFlag_WatchingCutscene">WatchingCutscene</td>
|
||||
<td><p>Unable to execute command while watching a cutscene.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td id="Dalamud_Game_ClientState_ConditionFlag_WatchingCutscene78">WatchingCutscene78</td>
|
||||
<td><p>Unable to execute command while watching a cutscene.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</thead></thead></table>
|
||||
<h3 id="extensionmethods">Extension Methods</h3>
|
||||
<div>
|
||||
<a class="xref" href="Dalamud.Game.Chat.EnumExtensions.html#Dalamud_Game_Chat_EnumExtensions_GetAttribute__1_System_Enum_">EnumExtensions.GetAttribute<TAttribute>()</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/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_ClientState_ConditionFlag.md&value=---%0Auid%3A%20Dalamud.Game.ClientState.ConditionFlag%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/Dalamud/blob/master/Dalamud/Game/ClientState/ConditionFlag.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>
|
||||
|
|
@ -164,7 +164,7 @@
|
|||
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_ClientState_PartyList_Count.md&value=---%0Auid%3A%20Dalamud.Game.ClientState.PartyList.Count%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/Dalamud/blob/master/Dalamud/Game/ClientState/PartyList.cs/#L113">View Source</a>
|
||||
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Game/ClientState/PartyList.cs/#L90">View Source</a>
|
||||
</span>
|
||||
<a id="Dalamud_Game_ClientState_PartyList_Count_" data-uid="Dalamud.Game.ClientState.PartyList.Count*"></a>
|
||||
<h4 id="Dalamud_Game_ClientState_PartyList_Count" data-uid="Dalamud.Game.ClientState.PartyList.Count">Count</h4>
|
||||
|
|
@ -194,7 +194,7 @@
|
|||
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_ClientState_PartyList_IsSynchronized.md&value=---%0Auid%3A%20Dalamud.Game.ClientState.PartyList.IsSynchronized%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/Dalamud/blob/master/Dalamud/Game/ClientState/PartyList.cs/#L117">View Source</a>
|
||||
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Game/ClientState/PartyList.cs/#L94">View Source</a>
|
||||
</span>
|
||||
<a id="Dalamud_Game_ClientState_PartyList_IsSynchronized_" data-uid="Dalamud.Game.ClientState.PartyList.IsSynchronized*"></a>
|
||||
<h4 id="Dalamud_Game_ClientState_PartyList_IsSynchronized" data-uid="Dalamud.Game.ClientState.PartyList.IsSynchronized">IsSynchronized</h4>
|
||||
|
|
@ -271,7 +271,7 @@
|
|||
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_ClientState_PartyList_Length.md&value=---%0Auid%3A%20Dalamud.Game.ClientState.PartyList.Length%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/Dalamud/blob/master/Dalamud/Game/ClientState/PartyList.cs/#L109">View Source</a>
|
||||
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Game/ClientState/PartyList.cs/#L86">View Source</a>
|
||||
</span>
|
||||
<a id="Dalamud_Game_ClientState_PartyList_Length_" data-uid="Dalamud.Game.ClientState.PartyList.Length*"></a>
|
||||
<h4 id="Dalamud_Game_ClientState_PartyList_Length" data-uid="Dalamud.Game.ClientState.PartyList.Length">Length</h4>
|
||||
|
|
@ -301,7 +301,7 @@
|
|||
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_ClientState_PartyList_SyncRoot.md&value=---%0Auid%3A%20Dalamud.Game.ClientState.PartyList.SyncRoot%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/Dalamud/blob/master/Dalamud/Game/ClientState/PartyList.cs/#L115">View Source</a>
|
||||
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Game/ClientState/PartyList.cs/#L92">View Source</a>
|
||||
</span>
|
||||
<a id="Dalamud_Game_ClientState_PartyList_SyncRoot_" data-uid="Dalamud.Game.ClientState.PartyList.SyncRoot*"></a>
|
||||
<h4 id="Dalamud_Game_ClientState_PartyList_SyncRoot" data-uid="Dalamud.Game.ClientState.PartyList.SyncRoot">SyncRoot</h4>
|
||||
|
|
@ -400,7 +400,7 @@
|
|||
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_ClientState_PartyList_GetEnumerator.md&value=---%0Auid%3A%20Dalamud.Game.ClientState.PartyList.GetEnumerator%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/Dalamud/blob/master/Dalamud/Game/ClientState/PartyList.cs/#L105">View Source</a>
|
||||
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Game/ClientState/PartyList.cs/#L76">View Source</a>
|
||||
</span>
|
||||
<a id="Dalamud_Game_ClientState_PartyList_GetEnumerator_" data-uid="Dalamud.Game.ClientState.PartyList.GetEnumerator*"></a>
|
||||
<h4 id="Dalamud_Game_ClientState_PartyList_GetEnumerator" data-uid="Dalamud.Game.ClientState.PartyList.GetEnumerator">GetEnumerator()</h4>
|
||||
|
|
@ -432,7 +432,7 @@
|
|||
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_ClientState_PartyList_System_Collections_Generic_IReadOnlyCollection_Dalamud_Game_ClientState_Actors_Types_PartyMember__Count.md&value=---%0Auid%3A%20Dalamud.Game.ClientState.PartyList.System%23Collections%23Generic%23IReadOnlyCollection%7BDalamud%23Game%23ClientState%23Actors%23Types%23PartyMember%7D%23Count%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/Dalamud/blob/master/Dalamud/Game/ClientState/PartyList.cs/#L111">View Source</a>
|
||||
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Game/ClientState/PartyList.cs/#L88">View Source</a>
|
||||
</span>
|
||||
<a id="Dalamud_Game_ClientState_PartyList_System_Collections_Generic_IReadOnlyCollection_Dalamud_Game_ClientState_Actors_Types_PartyMember__Count_" data-uid="Dalamud.Game.ClientState.PartyList.System#Collections#Generic#IReadOnlyCollection{Dalamud#Game#ClientState#Actors#Types#PartyMember}#Count*"></a>
|
||||
<h4 id="Dalamud_Game_ClientState_PartyList_System_Collections_Generic_IReadOnlyCollection_Dalamud_Game_ClientState_Actors_Types_PartyMember__Count" data-uid="Dalamud.Game.ClientState.PartyList.System#Collections#Generic#IReadOnlyCollection{Dalamud#Game#ClientState#Actors#Types#PartyMember}#Count">IReadOnlyCollection<PartyMember>.Count</h4>
|
||||
|
|
@ -462,7 +462,7 @@
|
|||
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_ClientState_PartyList_System_Collections_IEnumerable_GetEnumerator.md&value=---%0Auid%3A%20Dalamud.Game.ClientState.PartyList.System%23Collections%23IEnumerable%23GetEnumerator%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/Dalamud/blob/master/Dalamud/Game/ClientState/PartyList.cs/#L107">View Source</a>
|
||||
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Game/ClientState/PartyList.cs/#L84">View Source</a>
|
||||
</span>
|
||||
<a id="Dalamud_Game_ClientState_PartyList_System_Collections_IEnumerable_GetEnumerator_" data-uid="Dalamud.Game.ClientState.PartyList.System#Collections#IEnumerable#GetEnumerator*"></a>
|
||||
<h4 id="Dalamud_Game_ClientState_PartyList_System_Collections_IEnumerable_GetEnumerator" data-uid="Dalamud.Game.ClientState.PartyList.System#Collections#IEnumerable#GetEnumerator">IEnumerable.GetEnumerator()</h4>
|
||||
|
|
|
|||
|
|
@ -134,12 +134,41 @@
|
|||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_ClientState_Structs_Actor_BattleNpcTargetActorId.md&value=---%0Auid%3A%20Dalamud.Game.ClientState.Structs.Actor.BattleNpcTargetActorId%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/Dalamud/blob/master/Dalamud/Game/ClientState/Structs/Actor.cs/#L34">View Source</a>
|
||||
</span>
|
||||
<h4 id="Dalamud_Game_ClientState_Structs_Actor_BattleNpcTargetActorId" data-uid="Dalamud.Game.ClientState.Structs.Actor.BattleNpcTargetActorId">BattleNpcTargetActorId</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 int BattleNpcTargetActorId</code></pre>
|
||||
</div>
|
||||
<h5 class="fieldValue">Field 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.Int32</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_ClientState_Structs_Actor_ClassJob.md&value=---%0Auid%3A%20Dalamud.Game.ClientState.Structs.Actor.ClassJob%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/Dalamud/blob/master/Dalamud/Game/ClientState/Structs/Actor.cs/#L49">View Source</a>
|
||||
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Game/ClientState/Structs/Actor.cs/#L50">View Source</a>
|
||||
</span>
|
||||
<h4 id="Dalamud_Game_ClientState_Structs_Actor_ClassJob" data-uid="Dalamud.Game.ClientState.Structs.Actor.ClassJob">ClassJob</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
|
|
@ -168,7 +197,7 @@
|
|||
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_ClientState_Structs_Actor_CompanyTag.md&value=---%0Auid%3A%20Dalamud.Game.ClientState.Structs.Actor.CompanyTag%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/Dalamud/blob/master/Dalamud/Game/ClientState/Structs/Actor.cs/#L37">View Source</a>
|
||||
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Game/ClientState/Structs/Actor.cs/#L38">View Source</a>
|
||||
</span>
|
||||
<h4 id="Dalamud_Game_ClientState_Structs_Actor_CompanyTag" data-uid="Dalamud.Game.ClientState.Structs.Actor.CompanyTag">CompanyTag</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
|
|
@ -197,7 +226,7 @@
|
|||
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_ClientState_Structs_Actor_CurrentHp.md&value=---%0Auid%3A%20Dalamud.Game.ClientState.Structs.Actor.CurrentHp%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/Dalamud/blob/master/Dalamud/Game/ClientState/Structs/Actor.cs/#L42">View Source</a>
|
||||
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Game/ClientState/Structs/Actor.cs/#L43">View Source</a>
|
||||
</span>
|
||||
<h4 id="Dalamud_Game_ClientState_Structs_Actor_CurrentHp" data-uid="Dalamud.Game.ClientState.Structs.Actor.CurrentHp">CurrentHp</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
|
|
@ -226,7 +255,7 @@
|
|||
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_ClientState_Structs_Actor_CurrentMp.md&value=---%0Auid%3A%20Dalamud.Game.ClientState.Structs.Actor.CurrentMp%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/Dalamud/blob/master/Dalamud/Game/ClientState/Structs/Actor.cs/#L44">View Source</a>
|
||||
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Game/ClientState/Structs/Actor.cs/#L45">View Source</a>
|
||||
</span>
|
||||
<h4 id="Dalamud_Game_ClientState_Structs_Actor_CurrentMp" data-uid="Dalamud.Game.ClientState.Structs.Actor.CurrentMp">CurrentMp</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
|
|
@ -255,7 +284,7 @@
|
|||
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_ClientState_Structs_Actor_CurrentWorld.md&value=---%0Auid%3A%20Dalamud.Game.ClientState.Structs.Actor.CurrentWorld%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/Dalamud/blob/master/Dalamud/Game/ClientState/Structs/Actor.cs/#L40">View Source</a>
|
||||
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Game/ClientState/Structs/Actor.cs/#L41">View Source</a>
|
||||
</span>
|
||||
<h4 id="Dalamud_Game_ClientState_Structs_Actor_CurrentWorld" data-uid="Dalamud.Game.ClientState.Structs.Actor.CurrentWorld">CurrentWorld</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
|
|
@ -342,7 +371,7 @@
|
|||
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_ClientState_Structs_Actor_HomeWorld.md&value=---%0Auid%3A%20Dalamud.Game.ClientState.Structs.Actor.HomeWorld%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/Dalamud/blob/master/Dalamud/Game/ClientState/Structs/Actor.cs/#L41">View Source</a>
|
||||
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Game/ClientState/Structs/Actor.cs/#L42">View Source</a>
|
||||
</span>
|
||||
<h4 id="Dalamud_Game_ClientState_Structs_Actor_HomeWorld" data-uid="Dalamud.Game.ClientState.Structs.Actor.HomeWorld">HomeWorld</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
|
|
@ -400,7 +429,7 @@
|
|||
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_ClientState_Structs_Actor_Level.md&value=---%0Auid%3A%20Dalamud.Game.ClientState.Structs.Actor.Level%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/Dalamud/blob/master/Dalamud/Game/ClientState/Structs/Actor.cs/#L50">View Source</a>
|
||||
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Game/ClientState/Structs/Actor.cs/#L51">View Source</a>
|
||||
</span>
|
||||
<h4 id="Dalamud_Game_ClientState_Structs_Actor_Level" data-uid="Dalamud.Game.ClientState.Structs.Actor.Level">Level</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
|
|
@ -429,7 +458,7 @@
|
|||
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_ClientState_Structs_Actor_MaxHp.md&value=---%0Auid%3A%20Dalamud.Game.ClientState.Structs.Actor.MaxHp%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/Dalamud/blob/master/Dalamud/Game/ClientState/Structs/Actor.cs/#L43">View Source</a>
|
||||
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Game/ClientState/Structs/Actor.cs/#L44">View Source</a>
|
||||
</span>
|
||||
<h4 id="Dalamud_Game_ClientState_Structs_Actor_MaxHp" data-uid="Dalamud.Game.ClientState.Structs.Actor.MaxHp">MaxHp</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
|
|
@ -458,7 +487,7 @@
|
|||
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_ClientState_Structs_Actor_MaxMp.md&value=---%0Auid%3A%20Dalamud.Game.ClientState.Structs.Actor.MaxMp%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/Dalamud/blob/master/Dalamud/Game/ClientState/Structs/Actor.cs/#L48">View Source</a>
|
||||
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Game/ClientState/Structs/Actor.cs/#L49">View Source</a>
|
||||
</span>
|
||||
<h4 id="Dalamud_Game_ClientState_Structs_Actor_MaxMp" data-uid="Dalamud.Game.ClientState.Structs.Actor.MaxMp">MaxMp</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
|
|
@ -516,7 +545,7 @@
|
|||
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_ClientState_Structs_Actor_NameId.md&value=---%0Auid%3A%20Dalamud.Game.ClientState.Structs.Actor.NameId%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/Dalamud/blob/master/Dalamud/Game/ClientState/Structs/Actor.cs/#L39">View Source</a>
|
||||
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Game/ClientState/Structs/Actor.cs/#L40">View Source</a>
|
||||
</span>
|
||||
<h4 id="Dalamud_Game_ClientState_Structs_Actor_NameId" data-uid="Dalamud.Game.ClientState.Structs.Actor.NameId">NameId</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
|
|
@ -598,6 +627,35 @@
|
|||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_ClientState_Structs_Actor_PlayerCharacterTargetActorId.md&value=---%0Auid%3A%20Dalamud.Game.ClientState.Structs.Actor.PlayerCharacterTargetActorId%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/Dalamud/blob/master/Dalamud/Game/ClientState/Structs/Actor.cs/#L33">View Source</a>
|
||||
</span>
|
||||
<h4 id="Dalamud_Game_ClientState_Structs_Actor_PlayerCharacterTargetActorId" data-uid="Dalamud.Game.ClientState.Structs.Actor.PlayerCharacterTargetActorId">PlayerCharacterTargetActorId</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 int PlayerCharacterTargetActorId</code></pre>
|
||||
</div>
|
||||
<h5 class="fieldValue">Field 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.Int32</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_ClientState_Structs_Actor_PlayerTargetStatus.md&value=---%0Auid%3A%20Dalamud.Game.ClientState.Structs.Actor.PlayerTargetStatus%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>
|
||||
|
|
@ -714,41 +772,12 @@
|
|||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_ClientState_Structs_Actor_TargetActorId.md&value=---%0Auid%3A%20Dalamud.Game.ClientState.Structs.Actor.TargetActorId%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/Dalamud/blob/master/Dalamud/Game/ClientState/Structs/Actor.cs/#L33">View Source</a>
|
||||
</span>
|
||||
<h4 id="Dalamud_Game_ClientState_Structs_Actor_TargetActorId" data-uid="Dalamud.Game.ClientState.Structs.Actor.TargetActorId">TargetActorId</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 int TargetActorId</code></pre>
|
||||
</div>
|
||||
<h5 class="fieldValue">Field 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.Int32</span></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_ClientState_Structs_Actor_UIStatusEffects.md&value=---%0Auid%3A%20Dalamud.Game.ClientState.Structs.Actor.UIStatusEffects%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/Dalamud/blob/master/Dalamud/Game/ClientState/Structs/Actor.cs/#L51">View Source</a>
|
||||
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Game/ClientState/Structs/Actor.cs/#L52">View Source</a>
|
||||
</span>
|
||||
<h4 id="Dalamud_Game_ClientState_Structs_Actor_UIStatusEffects" data-uid="Dalamud.Game.ClientState.Structs.Actor.UIStatusEffects">UIStatusEffects</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
|
|
|
|||
|
|
@ -79,6 +79,9 @@
|
|||
</h3>
|
||||
<h4><a class="xref" href="Dalamud.Game.ClientState.ClientState.html">ClientState</a></h4>
|
||||
<section><p>This class represents the state of the game client at the time of access.</p>
|
||||
</section>
|
||||
<h4><a class="xref" href="Dalamud.Game.ClientState.Condition.html">Condition</a></h4>
|
||||
<section><p>Provides access to conditions (generally player state). You can check whether a player is in combat, mounted, etc.</p>
|
||||
</section>
|
||||
<h4><a class="xref" href="Dalamud.Game.ClientState.JobGauges.html">JobGauges</a></h4>
|
||||
<section></section>
|
||||
|
|
@ -88,6 +91,13 @@ all keyboard keys, indexed by virtual vkCode</p>
|
|||
</section>
|
||||
<h4><a class="xref" href="Dalamud.Game.ClientState.PartyList.html">PartyList</a></h4>
|
||||
<section></section>
|
||||
<h3 id="enums">Enums
|
||||
</h3>
|
||||
<h4><a class="xref" href="Dalamud.Game.ClientState.ConditionFlag.html">ConditionFlag</a></h4>
|
||||
<section><p>Possible state flags (or conditions as they're called internally) that can be set on the local client.</p>
|
||||
<p>These come from LogMessage (somewhere) and directly map to each state field managed by the client. As of 5.25, it maps to
|
||||
LogMessage row 7700 and onwards, which can be checked by looking at the Condition sheet and looking at what column 2 maps to.</p>
|
||||
</section>
|
||||
</article>
|
||||
</div>
|
||||
|
||||
|
|
|
|||
|
|
@ -324,7 +324,7 @@ later to be processed when UpdateQueue() is called.</p>
|
|||
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_Internal_Gui_ChatGui_PrintError_System_String_.md&value=---%0Auid%3A%20Dalamud.Game.Internal.Gui.ChatGui.PrintError(System.String)%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/Dalamud/blob/master/Dalamud/Game/Internal/Gui/ChatGui.cs/#L208">View Source</a>
|
||||
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Game/Internal/Gui/ChatGui.cs/#L209">View Source</a>
|
||||
</span>
|
||||
<a id="Dalamud_Game_Internal_Gui_ChatGui_PrintError_" data-uid="Dalamud.Game.Internal.Gui.ChatGui.PrintError*"></a>
|
||||
<h4 id="Dalamud_Game_Internal_Gui_ChatGui_PrintError_System_String_" data-uid="Dalamud.Game.Internal.Gui.ChatGui.PrintError(System.String)">PrintError(String)</h4>
|
||||
|
|
@ -356,7 +356,7 @@ later to be processed when UpdateQueue() is called.</p>
|
|||
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Game_Internal_Gui_ChatGui_UpdateQueue_Dalamud_Game_Internal_Framework_.md&value=---%0Auid%3A%20Dalamud.Game.Internal.Gui.ChatGui.UpdateQueue(Dalamud.Game.Internal.Framework)%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/Dalamud/blob/master/Dalamud/Game/Internal/Gui/ChatGui.cs/#L219">View Source</a>
|
||||
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Game/Internal/Gui/ChatGui.cs/#L220">View Source</a>
|
||||
</span>
|
||||
<a id="Dalamud_Game_Internal_Gui_ChatGui_UpdateQueue_" data-uid="Dalamud.Game.Internal.Gui.ChatGui.UpdateQueue*"></a>
|
||||
<h4 id="Dalamud_Game_Internal_Gui_ChatGui_UpdateQueue_Dalamud_Game_Internal_Framework_" data-uid="Dalamud.Game.Internal.Gui.ChatGui.UpdateQueue(Dalamud.Game.Internal.Framework)">UpdateQueue(Framework)</h4>
|
||||
|
|
|
|||
|
|
@ -503,7 +503,7 @@ Place your cursor on the line calling a static address, and create and IDA sig.<
|
|||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public IntPtr GetStaticAddressFromSig(string signature, int offset)</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public IntPtr GetStaticAddressFromSig(string signature, int offset = 0)</code></pre>
|
||||
</div>
|
||||
<h5 class="parameters">Parameters</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
|
|
|
|||
|
|
@ -117,7 +117,7 @@
|
|||
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Interface_MySinkExtensions_EventSink_Serilog_Configuration_LoggerSinkConfiguration_System_IFormatProvider_.md&value=---%0Auid%3A%20Dalamud.Interface.MySinkExtensions.EventSink(Serilog.Configuration.LoggerSinkConfiguration%2CSystem.IFormatProvider)%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/Dalamud/blob/master/Dalamud/Interface/SerilogEventSink.cs/#L41">View Source</a>
|
||||
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Interface/SerilogEventSink.cs/#L42">View Source</a>
|
||||
</span>
|
||||
<a id="Dalamud_Interface_MySinkExtensions_EventSink_" data-uid="Dalamud.Interface.MySinkExtensions.EventSink*"></a>
|
||||
<h4 id="Dalamud_Interface_MySinkExtensions_EventSink_Serilog_Configuration_LoggerSinkConfiguration_System_IFormatProvider_" data-uid="Dalamud.Interface.MySinkExtensions.EventSink(Serilog.Configuration.LoggerSinkConfiguration,System.IFormatProvider)">EventSink(LoggerSinkConfiguration, IFormatProvider)</h4>
|
||||
|
|
@ -175,7 +175,7 @@
|
|||
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Interface_MySinkExtensions.md&value=---%0Auid%3A%20Dalamud.Interface.MySinkExtensions%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/Dalamud/blob/master/Dalamud/Interface/SerilogEventSink.cs/#L39" class="contribution-link">View Source</a>
|
||||
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Interface/SerilogEventSink.cs/#L40" class="contribution-link">View Source</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -121,7 +121,7 @@
|
|||
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Interface_SerilogEventSink__ctor_System_IFormatProvider_.md&value=---%0Auid%3A%20Dalamud.Interface.SerilogEventSink.%23ctor(System.IFormatProvider)%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/Dalamud/blob/master/Dalamud/Interface/SerilogEventSink.cs/#L21">View Source</a>
|
||||
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Interface/SerilogEventSink.cs/#L22">View Source</a>
|
||||
</span>
|
||||
<a id="Dalamud_Interface_SerilogEventSink__ctor_" data-uid="Dalamud.Interface.SerilogEventSink.#ctor*"></a>
|
||||
<h4 id="Dalamud_Interface_SerilogEventSink__ctor_System_IFormatProvider_" data-uid="Dalamud.Interface.SerilogEventSink.#ctor(System.IFormatProvider)">SerilogEventSink(IFormatProvider)</h4>
|
||||
|
|
@ -155,7 +155,7 @@
|
|||
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Interface_SerilogEventSink_Instance.md&value=---%0Auid%3A%20Dalamud.Interface.SerilogEventSink.Instance%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/Dalamud/blob/master/Dalamud/Interface/SerilogEventSink.cs/#L17">View Source</a>
|
||||
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Interface/SerilogEventSink.cs/#L18">View Source</a>
|
||||
</span>
|
||||
<h4 id="Dalamud_Interface_SerilogEventSink_Instance" data-uid="Dalamud.Interface.SerilogEventSink.Instance">Instance</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
|
|
@ -186,7 +186,7 @@
|
|||
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Interface_SerilogEventSink_Emit_Serilog_Events_LogEvent_.md&value=---%0Auid%3A%20Dalamud.Interface.SerilogEventSink.Emit(Serilog.Events.LogEvent)%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/Dalamud/blob/master/Dalamud/Interface/SerilogEventSink.cs/#L28">View Source</a>
|
||||
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Interface/SerilogEventSink.cs/#L29">View Source</a>
|
||||
</span>
|
||||
<a id="Dalamud_Interface_SerilogEventSink_Emit_" data-uid="Dalamud.Interface.SerilogEventSink.Emit*"></a>
|
||||
<h4 id="Dalamud_Interface_SerilogEventSink_Emit_Serilog_Events_LogEvent_" data-uid="Dalamud.Interface.SerilogEventSink.Emit(Serilog.Events.LogEvent)">Emit(LogEvent)</h4>
|
||||
|
|
@ -220,14 +220,14 @@
|
|||
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Interface_SerilogEventSink_OnLogLine.md&value=---%0Auid%3A%20Dalamud.Interface.SerilogEventSink.OnLogLine%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/Dalamud/blob/master/Dalamud/Interface/SerilogEventSink.cs/#L19">View Source</a>
|
||||
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Interface/SerilogEventSink.cs/#L20">View Source</a>
|
||||
</span>
|
||||
<h4 id="Dalamud_Interface_SerilogEventSink_OnLogLine" data-uid="Dalamud.Interface.SerilogEventSink.OnLogLine">OnLogLine</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 event EventHandler<string> OnLogLine</code></pre>
|
||||
<pre><code class="lang-csharp hljs">public event EventHandler<(string line, LogEventLevel level)> OnLogLine</code></pre>
|
||||
</div>
|
||||
<h5 class="eventType">Event Type</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
|
|
@ -239,7 +239,7 @@
|
|||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.EventHandler</span><<span class="xref">System.String</span>></td>
|
||||
<td><span class="xref">System.EventHandler</span><<span class="xref">System.ValueTuple</span><<span class="xref">System.String</span>, <span class="xref">Serilog.Events.LogEventLevel</span>>></td>
|
||||
<td></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
|
@ -259,7 +259,7 @@
|
|||
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Interface_SerilogEventSink.md&value=---%0Auid%3A%20Dalamud.Interface.SerilogEventSink%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/Dalamud/blob/master/Dalamud/Interface/SerilogEventSink.cs/#L13" class="contribution-link">View Source</a>
|
||||
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Interface/SerilogEventSink.cs/#L14" class="contribution-link">View Source</a>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -123,7 +123,7 @@ It can be used to draw custom windows and overlays.</p>
|
|||
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Interface_UiBuilder__ctor_Dalamud_Interface_InterfaceManager_System_String_.md&value=---%0Auid%3A%20Dalamud.Interface.UiBuilder.%23ctor(Dalamud.Interface.InterfaceManager%2CSystem.String)%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/Dalamud/blob/master/Dalamud/Interface/UiBuilder.cs/#L41">View Source</a>
|
||||
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Interface/UiBuilder.cs/#L50">View Source</a>
|
||||
</span>
|
||||
<a id="Dalamud_Interface_UiBuilder__ctor_" data-uid="Dalamud.Interface.UiBuilder.#ctor*"></a>
|
||||
<h4 id="Dalamud_Interface_UiBuilder__ctor_Dalamud_Interface_InterfaceManager_System_String_" data-uid="Dalamud.Interface.UiBuilder.#ctor(Dalamud.Interface.InterfaceManager,System.String)">UiBuilder(InterfaceManager, String)</h4>
|
||||
|
|
@ -165,7 +165,7 @@ It can be used to draw custom windows and overlays.</p>
|
|||
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Interface_UiBuilder_OnOpenConfigUi.md&value=---%0Auid%3A%20Dalamud.Interface.UiBuilder.OnOpenConfigUi%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/Dalamud/blob/master/Dalamud/Interface/UiBuilder.cs/#L106">View Source</a>
|
||||
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Interface/UiBuilder.cs/#L116">View Source</a>
|
||||
</span>
|
||||
<h4 id="Dalamud_Interface_UiBuilder_OnOpenConfigUi" data-uid="Dalamud.Interface.UiBuilder.OnOpenConfigUi">OnOpenConfigUi</h4>
|
||||
<div class="markdown level1 summary"><p>Event that is fired when the plugin should open its configuration interface.</p>
|
||||
|
|
@ -259,7 +259,7 @@ It can be used to draw custom windows and overlays.</p>
|
|||
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Interface_UiBuilder_OnBuildFonts.md&value=---%0Auid%3A%20Dalamud.Interface.UiBuilder.OnBuildFonts%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/Dalamud/blob/master/Dalamud/Interface/UiBuilder.cs/#L89">View Source</a>
|
||||
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Interface/UiBuilder.cs/#L99">View Source</a>
|
||||
</span>
|
||||
<a id="Dalamud_Interface_UiBuilder_OnBuildFonts_" data-uid="Dalamud.Interface.UiBuilder.OnBuildFonts*"></a>
|
||||
<h4 id="Dalamud_Interface_UiBuilder_OnBuildFonts" data-uid="Dalamud.Interface.UiBuilder.OnBuildFonts">OnBuildFonts</h4>
|
||||
|
|
@ -296,7 +296,7 @@ pointers inside this handler.<br>
|
|||
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Interface_UiBuilder_Dispose.md&value=---%0Auid%3A%20Dalamud.Interface.UiBuilder.Dispose%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/Dalamud/blob/master/Dalamud/Interface/UiBuilder.cs/#L51">View Source</a>
|
||||
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Interface/UiBuilder.cs/#L61">View Source</a>
|
||||
</span>
|
||||
<a id="Dalamud_Interface_UiBuilder_Dispose_" data-uid="Dalamud.Interface.UiBuilder.Dispose*"></a>
|
||||
<h4 id="Dalamud_Interface_UiBuilder_Dispose" data-uid="Dalamud.Interface.UiBuilder.Dispose">Dispose()</h4>
|
||||
|
|
@ -312,7 +312,7 @@ pointers inside this handler.<br>
|
|||
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Interface_UiBuilder_LoadImage_System_Byte___.md&value=---%0Auid%3A%20Dalamud.Interface.UiBuilder.LoadImage(System.Byte%5B%5D)%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/Dalamud/blob/master/Dalamud/Interface/UiBuilder.cs/#L68">View Source</a>
|
||||
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Interface/UiBuilder.cs/#L78">View Source</a>
|
||||
</span>
|
||||
<a id="Dalamud_Interface_UiBuilder_LoadImage_" data-uid="Dalamud.Interface.UiBuilder.LoadImage*"></a>
|
||||
<h4 id="Dalamud_Interface_UiBuilder_LoadImage_System_Byte___" data-uid="Dalamud.Interface.UiBuilder.LoadImage(System.Byte[])">LoadImage(Byte[])</h4>
|
||||
|
|
@ -362,7 +362,7 @@ pointers inside this handler.<br>
|
|||
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Interface_UiBuilder_LoadImage_System_String_.md&value=---%0Auid%3A%20Dalamud.Interface.UiBuilder.LoadImage(System.String)%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/Dalamud/blob/master/Dalamud/Interface/UiBuilder.cs/#L60">View Source</a>
|
||||
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Interface/UiBuilder.cs/#L70">View Source</a>
|
||||
</span>
|
||||
<a id="Dalamud_Interface_UiBuilder_LoadImage_" data-uid="Dalamud.Interface.UiBuilder.LoadImage*"></a>
|
||||
<h4 id="Dalamud_Interface_UiBuilder_LoadImage_System_String_" data-uid="Dalamud.Interface.UiBuilder.LoadImage(System.String)">LoadImage(String)</h4>
|
||||
|
|
@ -412,7 +412,7 @@ pointers inside this handler.<br>
|
|||
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Interface_UiBuilder_LoadImageRaw_System_Byte___System_Int32_System_Int32_System_Int32_.md&value=---%0Auid%3A%20Dalamud.Interface.UiBuilder.LoadImageRaw(System.Byte%5B%5D%2CSystem.Int32%2CSystem.Int32%2CSystem.Int32)%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/Dalamud/blob/master/Dalamud/Interface/UiBuilder.cs/#L79">View Source</a>
|
||||
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Interface/UiBuilder.cs/#L89">View Source</a>
|
||||
</span>
|
||||
<a id="Dalamud_Interface_UiBuilder_LoadImageRaw_" data-uid="Dalamud.Interface.UiBuilder.LoadImageRaw*"></a>
|
||||
<h4 id="Dalamud_Interface_UiBuilder_LoadImageRaw_System_Byte___System_Int32_System_Int32_System_Int32_" data-uid="Dalamud.Interface.UiBuilder.LoadImageRaw(System.Byte[],System.Int32,System.Int32,System.Int32)">LoadImageRaw(Byte[], Int32, Int32, Int32)</h4>
|
||||
|
|
@ -480,7 +480,7 @@ pointers inside this handler.<br>
|
|||
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Interface_UiBuilder_RebuildFonts.md&value=---%0Auid%3A%20Dalamud.Interface.UiBuilder.RebuildFonts%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/Dalamud/blob/master/Dalamud/Interface/UiBuilder.cs/#L100">View Source</a>
|
||||
<a href="https://github.com/goaaats/Dalamud/blob/master/Dalamud/Interface/UiBuilder.cs/#L110">View Source</a>
|
||||
</span>
|
||||
<a id="Dalamud_Interface_UiBuilder_RebuildFonts_" data-uid="Dalamud.Interface.UiBuilder.RebuildFonts*"></a>
|
||||
<h4 id="Dalamud_Interface_UiBuilder_RebuildFonts" data-uid="Dalamud.Interface.UiBuilder.RebuildFonts">RebuildFonts()</h4>
|
||||
|
|
|
|||
|
|
@ -73,7 +73,8 @@
|
|||
|
||||
<h1 id="Discord_Attachment" data-uid="Discord.Attachment" class="text-break">Class Attachment
|
||||
</h1>
|
||||
<div class="markdown level0 summary"></div>
|
||||
<div class="markdown level0 summary"><p>Represents a message attachment found in a <a class="xref" href="Discord.IUserMessage.html">IUserMessage</a>.</p>
|
||||
</div>
|
||||
<div class="markdown level0 conceptual"></div>
|
||||
<div class="inheritance">
|
||||
<h5>Inheritance</h5>
|
||||
|
|
@ -122,7 +123,8 @@
|
|||
</span>
|
||||
<a id="Discord_Attachment_Filename_" data-uid="Discord.Attachment.Filename*"></a>
|
||||
<h4 id="Discord_Attachment_Filename" data-uid="Discord.Attachment.Filename">Filename</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the filename of this attachment.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -139,7 +141,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td></td>
|
||||
<td><p>A string containing the full filename of this attachment (e.g. <code>textFile.txt</code>).</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -152,7 +155,8 @@
|
|||
</span>
|
||||
<a id="Discord_Attachment_Height_" data-uid="Discord.Attachment.Height*"></a>
|
||||
<h4 id="Discord_Attachment_Height" data-uid="Discord.Attachment.Height">Height</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the height of this attachment.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -169,7 +173,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Nullable</span><<span class="xref">System.Int32</span>></td>
|
||||
<td></td>
|
||||
<td><p>The height of this attachment if it is a picture; otherwise <code>null</code>.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -182,7 +187,8 @@
|
|||
</span>
|
||||
<a id="Discord_Attachment_Id_" data-uid="Discord.Attachment.Id*"></a>
|
||||
<h4 id="Discord_Attachment_Id" data-uid="Discord.Attachment.Id">Id</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the ID of this attachment.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -199,7 +205,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.UInt64</span></td>
|
||||
<td></td>
|
||||
<td><p>A snowflake ID associated with this attachment.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -212,7 +219,8 @@
|
|||
</span>
|
||||
<a id="Discord_Attachment_ProxyUrl_" data-uid="Discord.Attachment.ProxyUrl*"></a>
|
||||
<h4 id="Discord_Attachment_ProxyUrl" data-uid="Discord.Attachment.ProxyUrl">ProxyUrl</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a proxied URL of this attachment.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -229,7 +237,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td></td>
|
||||
<td><p>A string containing the proxied URL of this attachment.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -242,7 +251,8 @@
|
|||
</span>
|
||||
<a id="Discord_Attachment_Size_" data-uid="Discord.Attachment.Size*"></a>
|
||||
<h4 id="Discord_Attachment_Size" data-uid="Discord.Attachment.Size">Size</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the file size of this attachment.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -259,7 +269,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Int32</span></td>
|
||||
<td></td>
|
||||
<td><p>The size of this attachment in bytes.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -272,7 +283,8 @@
|
|||
</span>
|
||||
<a id="Discord_Attachment_Url_" data-uid="Discord.Attachment.Url*"></a>
|
||||
<h4 id="Discord_Attachment_Url" data-uid="Discord.Attachment.Url">Url</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the URL of this attachment.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -289,7 +301,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td></td>
|
||||
<td><p>A string containing the URL of this attachment.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -302,7 +315,8 @@
|
|||
</span>
|
||||
<a id="Discord_Attachment_Width_" data-uid="Discord.Attachment.Width*"></a>
|
||||
<h4 id="Discord_Attachment_Width" data-uid="Discord.Attachment.Width">Width</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the width of this attachment.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -319,7 +333,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Nullable</span><<span class="xref">System.Int32</span>></td>
|
||||
<td></td>
|
||||
<td><p>The width of this attachment if it is a picture; otherwise <code>null</code>.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
|
|||
|
|
@ -102,7 +102,6 @@
|
|||
<h5 id="Discord_Cacheable_2_syntax">Syntax</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public struct Cacheable<TEntity, TId>
|
||||
|
||||
where TEntity : IEntity<TId> where TId : IEquatable<TId></code></pre>
|
||||
</div>
|
||||
<h5 class="typeParameters">Type Parameters</h5>
|
||||
|
|
|
|||
|
|
@ -226,7 +226,8 @@
|
|||
</span>
|
||||
<a id="Discord_Commands_ShardedCommandContext_Discord_Commands_ICommandContext_Client_" data-uid="Discord.Commands.ShardedCommandContext.Discord#Commands#ICommandContext#Client*"></a>
|
||||
<h4 id="Discord_Commands_ShardedCommandContext_Discord_Commands_ICommandContext_Client" data-uid="Discord.Commands.ShardedCommandContext.Discord#Commands#ICommandContext#Client">ICommandContext.Client</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the <a class="xref" href="Discord.IDiscordClient.html">IDiscordClient</a> that the command is executed with.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
|
|||
|
|
@ -357,7 +357,8 @@
|
|||
</span>
|
||||
<a id="Discord_Commands_SocketCommandContext_Discord_Commands_ICommandContext_Channel_" data-uid="Discord.Commands.SocketCommandContext.Discord#Commands#ICommandContext#Channel*"></a>
|
||||
<h4 id="Discord_Commands_SocketCommandContext_Discord_Commands_ICommandContext_Channel" data-uid="Discord.Commands.SocketCommandContext.Discord#Commands#ICommandContext#Channel">ICommandContext.Channel</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the <a class="xref" href="Discord.IMessageChannel.html">IMessageChannel</a> that the command is executed in.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -387,7 +388,8 @@
|
|||
</span>
|
||||
<a id="Discord_Commands_SocketCommandContext_Discord_Commands_ICommandContext_Client_" data-uid="Discord.Commands.SocketCommandContext.Discord#Commands#ICommandContext#Client*"></a>
|
||||
<h4 id="Discord_Commands_SocketCommandContext_Discord_Commands_ICommandContext_Client" data-uid="Discord.Commands.SocketCommandContext.Discord#Commands#ICommandContext#Client">ICommandContext.Client</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the <a class="xref" href="Discord.IDiscordClient.html">IDiscordClient</a> that the command is executed with.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -417,7 +419,8 @@
|
|||
</span>
|
||||
<a id="Discord_Commands_SocketCommandContext_Discord_Commands_ICommandContext_Guild_" data-uid="Discord.Commands.SocketCommandContext.Discord#Commands#ICommandContext#Guild*"></a>
|
||||
<h4 id="Discord_Commands_SocketCommandContext_Discord_Commands_ICommandContext_Guild" data-uid="Discord.Commands.SocketCommandContext.Discord#Commands#ICommandContext#Guild">ICommandContext.Guild</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the <a class="xref" href="Discord.IGuild.html">IGuild</a> that the command is executed in.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -447,7 +450,8 @@
|
|||
</span>
|
||||
<a id="Discord_Commands_SocketCommandContext_Discord_Commands_ICommandContext_Message_" data-uid="Discord.Commands.SocketCommandContext.Discord#Commands#ICommandContext#Message*"></a>
|
||||
<h4 id="Discord_Commands_SocketCommandContext_Discord_Commands_ICommandContext_Message" data-uid="Discord.Commands.SocketCommandContext.Discord#Commands#ICommandContext#Message">ICommandContext.Message</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the <a class="xref" href="Discord.IUserMessage.html">IUserMessage</a> that the command is interpreted from.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -477,7 +481,8 @@
|
|||
</span>
|
||||
<a id="Discord_Commands_SocketCommandContext_Discord_Commands_ICommandContext_User_" data-uid="Discord.Commands.SocketCommandContext.Discord#Commands#ICommandContext#User*"></a>
|
||||
<h4 id="Discord_Commands_SocketCommandContext_Discord_Commands_ICommandContext_User" data-uid="Discord.Commands.SocketCommandContext.Discord#Commands#ICommandContext#User">ICommandContext.User</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the <a class="xref" href="Discord.IUser.html">IUser</a> who executed the command.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
|
|||
|
|
@ -123,7 +123,8 @@
|
|||
</span>
|
||||
<a id="Discord_Embed_Author_" data-uid="Discord.Embed.Author*"></a>
|
||||
<h4 id="Discord_Embed_Author" data-uid="Discord.Embed.Author">Author</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the author field of this embed.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -140,7 +141,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Nullable</span><<a class="xref" href="Discord.EmbedAuthor.html">EmbedAuthor</a>></td>
|
||||
<td></td>
|
||||
<td><p>The author field of the embed, or <code>null</code> if none is set.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -153,7 +155,8 @@
|
|||
</span>
|
||||
<a id="Discord_Embed_Color_" data-uid="Discord.Embed.Color*"></a>
|
||||
<h4 id="Discord_Embed_Color" data-uid="Discord.Embed.Color">Color</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the color of this embed.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -170,7 +173,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Nullable</span><<a class="xref" href="Discord.Color.html">Color</a>></td>
|
||||
<td></td>
|
||||
<td><p>The color of the embed present on the side of the embed, or <code>null</code> if none is set.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -183,7 +187,8 @@
|
|||
</span>
|
||||
<a id="Discord_Embed_Description_" data-uid="Discord.Embed.Description*"></a>
|
||||
<h4 id="Discord_Embed_Description" data-uid="Discord.Embed.Description">Description</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the description of this embed.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -200,7 +205,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td></td>
|
||||
<td><p>The description field of the embed.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -213,7 +219,8 @@
|
|||
</span>
|
||||
<a id="Discord_Embed_Fields_" data-uid="Discord.Embed.Fields*"></a>
|
||||
<h4 id="Discord_Embed_Fields" data-uid="Discord.Embed.Fields">Fields</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the fields of the embed.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -230,7 +237,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Collections.Immutable.ImmutableArray</span><<a class="xref" href="Discord.EmbedField.html">EmbedField</a>></td>
|
||||
<td></td>
|
||||
<td><p>An array of the fields of the embed.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -243,7 +251,8 @@
|
|||
</span>
|
||||
<a id="Discord_Embed_Footer_" data-uid="Discord.Embed.Footer*"></a>
|
||||
<h4 id="Discord_Embed_Footer" data-uid="Discord.Embed.Footer">Footer</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the footer field of this embed.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -260,7 +269,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Nullable</span><<a class="xref" href="Discord.EmbedFooter.html">EmbedFooter</a>></td>
|
||||
<td></td>
|
||||
<td><p>The author field of the embed, or <code>null</code> if none is set.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -273,7 +283,8 @@
|
|||
</span>
|
||||
<a id="Discord_Embed_Image_" data-uid="Discord.Embed.Image*"></a>
|
||||
<h4 id="Discord_Embed_Image" data-uid="Discord.Embed.Image">Image</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the image of this embed.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -290,7 +301,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Nullable</span><<a class="xref" href="Discord.EmbedImage.html">EmbedImage</a>></td>
|
||||
<td></td>
|
||||
<td><p>The image of the embed, or <code>null</code> if none is set.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -334,7 +346,8 @@
|
|||
</span>
|
||||
<a id="Discord_Embed_Provider_" data-uid="Discord.Embed.Provider*"></a>
|
||||
<h4 id="Discord_Embed_Provider" data-uid="Discord.Embed.Provider">Provider</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the provider of this embed.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -351,7 +364,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Nullable</span><<a class="xref" href="Discord.EmbedProvider.html">EmbedProvider</a>></td>
|
||||
<td></td>
|
||||
<td><p>The source of the embed, or <code>null</code> if none is set.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -364,7 +378,8 @@
|
|||
</span>
|
||||
<a id="Discord_Embed_Thumbnail_" data-uid="Discord.Embed.Thumbnail*"></a>
|
||||
<h4 id="Discord_Embed_Thumbnail" data-uid="Discord.Embed.Thumbnail">Thumbnail</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the thumbnail featured in this embed.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -381,7 +396,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Nullable</span><<a class="xref" href="Discord.EmbedThumbnail.html">EmbedThumbnail</a>></td>
|
||||
<td></td>
|
||||
<td><p>The thumbnail featured in the embed, or <code>null</code> if none is set.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -394,7 +410,8 @@
|
|||
</span>
|
||||
<a id="Discord_Embed_Timestamp_" data-uid="Discord.Embed.Timestamp*"></a>
|
||||
<h4 id="Discord_Embed_Timestamp" data-uid="Discord.Embed.Timestamp">Timestamp</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the timestamp of this embed.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -411,7 +428,9 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Nullable</span><<span class="xref">System.DateTimeOffset</span>></td>
|
||||
<td></td>
|
||||
<td><p>A <span class="xref">System.DateTimeOffset</span> based on the timestamp present at the bottom left of the embed, or
|
||||
<code>null</code> if none is set.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -424,7 +443,8 @@
|
|||
</span>
|
||||
<a id="Discord_Embed_Title_" data-uid="Discord.Embed.Title*"></a>
|
||||
<h4 id="Discord_Embed_Title" data-uid="Discord.Embed.Title">Title</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the title of this embed.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -441,7 +461,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td></td>
|
||||
<td><p>The title of the embed.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -454,7 +475,8 @@
|
|||
</span>
|
||||
<a id="Discord_Embed_Type_" data-uid="Discord.Embed.Type*"></a>
|
||||
<h4 id="Discord_Embed_Type" data-uid="Discord.Embed.Type">Type</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the type of this embed.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -471,7 +493,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.EmbedType.html">EmbedType</a></td>
|
||||
<td></td>
|
||||
<td><p>The type of the embed.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -484,7 +507,8 @@
|
|||
</span>
|
||||
<a id="Discord_Embed_Url_" data-uid="Discord.Embed.Url*"></a>
|
||||
<h4 id="Discord_Embed_Url" data-uid="Discord.Embed.Url">Url</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the title URL of this embed.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -501,7 +525,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td></td>
|
||||
<td><p>A string containing the URL set in a title of the embed.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -514,7 +539,8 @@
|
|||
</span>
|
||||
<a id="Discord_Embed_Video_" data-uid="Discord.Embed.Video*"></a>
|
||||
<h4 id="Discord_Embed_Video" data-uid="Discord.Embed.Video">Video</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the video of this embed.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -531,7 +557,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Nullable</span><<a class="xref" href="Discord.EmbedVideo.html">EmbedVideo</a>></td>
|
||||
<td></td>
|
||||
<td><p>The video of the embed, or <code>null</code> if none is set.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
|
|||
|
|
@ -153,7 +153,8 @@
|
|||
</span>
|
||||
<a id="Discord_Emoji_Name_" data-uid="Discord.Emoji.Name*"></a>
|
||||
<h4 id="Discord_Emoji_Name" data-uid="Discord.Emoji.Name">Name</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the display name or Unicode representation of this emote.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -170,7 +171,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td></td>
|
||||
<td><p>A string representing the display name or the Unicode representation (e.g. <code>🤔</code>) of this emote.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
|
|||
|
|
@ -152,7 +152,8 @@
|
|||
</span>
|
||||
<a id="Discord_Emote_CreatedAt_" data-uid="Discord.Emote.CreatedAt*"></a>
|
||||
<h4 id="Discord_Emote_CreatedAt" data-uid="Discord.Emote.CreatedAt">CreatedAt</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets when the snowflake was created.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -169,7 +170,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.DateTimeOffset</span></td>
|
||||
<td></td>
|
||||
<td><p>A <span class="xref">System.DateTimeOffset</span> representing when the entity was first created.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -212,7 +214,8 @@
|
|||
</span>
|
||||
<a id="Discord_Emote_Name_" data-uid="Discord.Emote.Name*"></a>
|
||||
<h4 id="Discord_Emote_Name" data-uid="Discord.Emote.Name">Name</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the display name or Unicode representation of this emote.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -229,7 +232,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td></td>
|
||||
<td><p>A string representing the display name or the Unicode representation (e.g. <code>🤔</code>) of this emote.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
|
|||
|
|
@ -179,7 +179,8 @@
|
|||
</span>
|
||||
<a id="Discord_Game_Details_" data-uid="Discord.Game.Details*"></a>
|
||||
<h4 id="Discord_Game_Details" data-uid="Discord.Game.Details">Details</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the details on what the player is currently doing.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -196,7 +197,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td></td>
|
||||
<td><p>A string describing what the player is doing.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -209,7 +211,8 @@
|
|||
</span>
|
||||
<a id="Discord_Game_Flags_" data-uid="Discord.Game.Flags*"></a>
|
||||
<h4 id="Discord_Game_Flags" data-uid="Discord.Game.Flags">Flags</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the flags that are relevant to this activity.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -226,10 +229,14 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.ActivityProperties.html">ActivityProperties</a></td>
|
||||
<td></td>
|
||||
<td><p>The value of flags for this activity.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 id="Discord_Game_Flags_remarks">Remarks</h5>
|
||||
<div class="markdown level1 remarks"><p>This value is determined by bitwise OR-ing <a class="xref" href="Discord.ActivityProperties.html">ActivityProperties</a> values together.</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_Game_Name.md&value=---%0Auid%3A%20Discord.Game.Name%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>
|
||||
|
|
@ -239,7 +246,8 @@
|
|||
</span>
|
||||
<a id="Discord_Game_Name_" data-uid="Discord.Game.Name*"></a>
|
||||
<h4 id="Discord_Game_Name" data-uid="Discord.Game.Name">Name</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the name of the activity.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -256,7 +264,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td></td>
|
||||
<td><p>A string containing the name of the activity that the user is doing.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -269,7 +278,8 @@
|
|||
</span>
|
||||
<a id="Discord_Game_Type_" data-uid="Discord.Game.Type*"></a>
|
||||
<h4 id="Discord_Game_Type" data-uid="Discord.Game.Type">Type</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the type of the activity.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -286,7 +296,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.ActivityType.html">ActivityType</a></td>
|
||||
<td></td>
|
||||
<td><p>The type of activity.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
|
|||
|
|
@ -80,7 +80,6 @@
|
|||
<h5 id="Discord_IEntity_1_syntax">Syntax</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public interface IEntity<TId>
|
||||
|
||||
where TId : IEquatable<TId></code></pre>
|
||||
</div>
|
||||
<h5 class="typeParameters">Type Parameters</h5>
|
||||
|
|
|
|||
|
|
@ -233,7 +233,6 @@
|
|||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static T? ToNullable<T>(this Optional<T> val)
|
||||
|
||||
where T : struct</code></pre>
|
||||
</div>
|
||||
<h5 class="parameters">Parameters</h5>
|
||||
|
|
|
|||
|
|
@ -190,7 +190,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_BaseDiscordClient_TokenType_" data-uid="Discord.Rest.BaseDiscordClient.TokenType*"></a>
|
||||
<h4 id="Discord_Rest_BaseDiscordClient_TokenType" data-uid="Discord.Rest.BaseDiscordClient.TokenType">TokenType</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the token type of the logged-in user.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -237,7 +238,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_BaseDiscordClient_GetRecommendedShardCountAsync_" data-uid="Discord.Rest.BaseDiscordClient.GetRecommendedShardCountAsync*"></a>
|
||||
<h4 id="Discord_Rest_BaseDiscordClient_GetRecommendedShardCountAsync_Discord_RequestOptions_" data-uid="Discord.Rest.BaseDiscordClient.GetRecommendedShardCountAsync(Discord.RequestOptions)">GetRecommendedShardCountAsync(RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the recommended shard count as suggested by Discord.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -256,7 +258,8 @@
|
|||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -271,7 +274,9 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span><<span class="xref">System.Int32</span>></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous get operation. The task result contains an <span class="xref">System.Int32</span>
|
||||
that represents the number of shards that should be used with this account.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -462,7 +467,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_BaseDiscordClient_Discord_IDiscordClient_ConnectionState_" data-uid="Discord.Rest.BaseDiscordClient.Discord#IDiscordClient#ConnectionState*"></a>
|
||||
<h4 id="Discord_Rest_BaseDiscordClient_Discord_IDiscordClient_ConnectionState" data-uid="Discord.Rest.BaseDiscordClient.Discord#IDiscordClient#ConnectionState">IDiscordClient.ConnectionState</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the current state of connection.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -492,7 +498,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_BaseDiscordClient_Discord_IDiscordClient_CreateGuildAsync_" data-uid="Discord.Rest.BaseDiscordClient.Discord#IDiscordClient#CreateGuildAsync*"></a>
|
||||
<h4 id="Discord_Rest_BaseDiscordClient_Discord_IDiscordClient_CreateGuildAsync_System_String_Discord_IVoiceRegion_System_IO_Stream_Discord_RequestOptions_" data-uid="Discord.Rest.BaseDiscordClient.Discord#IDiscordClient#CreateGuildAsync(System.String,Discord.IVoiceRegion,System.IO.Stream,Discord.RequestOptions)">IDiscordClient.CreateGuildAsync(String, IVoiceRegion, Stream, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Creates a guild for the logged-in user who is in less than 10 active guilds.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -511,22 +518,26 @@
|
|||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td><span class="parametername">name</span></td>
|
||||
<td></td>
|
||||
<td><p>The name of the new guild.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.IVoiceRegion.html">IVoiceRegion</a></td>
|
||||
<td><span class="parametername">region</span></td>
|
||||
<td></td>
|
||||
<td><p>The voice region to create the guild with.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.IO.Stream</span></td>
|
||||
<td><span class="parametername">jpegIcon</span></td>
|
||||
<td></td>
|
||||
<td><p>The icon of the guild.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -541,10 +552,17 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span><<a class="xref" href="Discord.IGuild.html">IGuild</a>></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous creation operation. The task result contains the created guild.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 id="Discord_Rest_BaseDiscordClient_Discord_IDiscordClient_CreateGuildAsync_System_String_Discord_IVoiceRegion_System_IO_Stream_Discord_RequestOptions__remarks">Remarks</h5>
|
||||
<div class="markdown level1 remarks"><p>This method creates a new guild on behalf of the logged-in user.</p>
|
||||
<div class="WARNING"><h5>warning</h5><p>
|
||||
Due to Discord's limitation, this method will only work for users that are in less than 10 guilds.
|
||||
</p></div>
|
||||
</div>
|
||||
<h5 class="exceptions">Exceptions</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
|
|
@ -570,7 +588,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_BaseDiscordClient_Discord_IDiscordClient_CurrentUser_" data-uid="Discord.Rest.BaseDiscordClient.Discord#IDiscordClient#CurrentUser*"></a>
|
||||
<h4 id="Discord_Rest_BaseDiscordClient_Discord_IDiscordClient_CurrentUser" data-uid="Discord.Rest.BaseDiscordClient.Discord#IDiscordClient#CurrentUser">IDiscordClient.CurrentUser</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the currently logged-in user.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -600,7 +619,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_BaseDiscordClient_Discord_IDiscordClient_GetApplicationInfoAsync_" data-uid="Discord.Rest.BaseDiscordClient.Discord#IDiscordClient#GetApplicationInfoAsync*"></a>
|
||||
<h4 id="Discord_Rest_BaseDiscordClient_Discord_IDiscordClient_GetApplicationInfoAsync_Discord_RequestOptions_" data-uid="Discord.Rest.BaseDiscordClient.Discord#IDiscordClient#GetApplicationInfoAsync(Discord.RequestOptions)">IDiscordClient.GetApplicationInfoAsync(RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a Discord application information for the logged-in user.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -619,7 +639,8 @@
|
|||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -634,10 +655,16 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span><<a class="xref" href="Discord.IApplication.html">IApplication</a>></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous get operation. The task result contains the application
|
||||
information.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 id="Discord_Rest_BaseDiscordClient_Discord_IDiscordClient_GetApplicationInfoAsync_Discord_RequestOptions__remarks">Remarks</h5>
|
||||
<div class="markdown level1 remarks"><p>This method reflects your application information you submitted when creating a Discord application via
|
||||
the Developer Portal.</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_BaseDiscordClient_Discord_IDiscordClient_GetChannelAsync_System_UInt64_Discord_CacheMode_Discord_RequestOptions_.md&value=---%0Auid%3A%20Discord.Rest.BaseDiscordClient.Discord%23IDiscordClient%23GetChannelAsync(System.UInt64%2CDiscord.CacheMode%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>
|
||||
|
|
@ -647,7 +674,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_BaseDiscordClient_Discord_IDiscordClient_GetChannelAsync_" data-uid="Discord.Rest.BaseDiscordClient.Discord#IDiscordClient#GetChannelAsync*"></a>
|
||||
<h4 id="Discord_Rest_BaseDiscordClient_Discord_IDiscordClient_GetChannelAsync_System_UInt64_Discord_CacheMode_Discord_RequestOptions_" data-uid="Discord.Rest.BaseDiscordClient.Discord#IDiscordClient#GetChannelAsync(System.UInt64,Discord.CacheMode,Discord.RequestOptions)">IDiscordClient.GetChannelAsync(UInt64, CacheMode, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a generic channel.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -666,17 +694,20 @@
|
|||
<tr>
|
||||
<td><span class="xref">System.UInt64</span></td>
|
||||
<td><span class="parametername">id</span></td>
|
||||
<td></td>
|
||||
<td><p>The snowflake identifier of the channel (e.g. <code>381889909113225237</code>).</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.CacheMode.html">CacheMode</a></td>
|
||||
<td><span class="parametername">mode</span></td>
|
||||
<td></td>
|
||||
<td><p>The <a class="xref" href="Discord.CacheMode.html">CacheMode</a> that determines whether the object should be fetched from cache.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -691,7 +722,9 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span><<a class="xref" href="Discord.IChannel.html">IChannel</a>></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous get operation. The task result contains the channel associated
|
||||
with the snowflake identifier; <code>null</code> when the channel cannot be found.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -704,7 +737,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_BaseDiscordClient_Discord_IDiscordClient_GetConnectionsAsync_" data-uid="Discord.Rest.BaseDiscordClient.Discord#IDiscordClient#GetConnectionsAsync*"></a>
|
||||
<h4 id="Discord_Rest_BaseDiscordClient_Discord_IDiscordClient_GetConnectionsAsync_Discord_RequestOptions_" data-uid="Discord.Rest.BaseDiscordClient.Discord#IDiscordClient#GetConnectionsAsync(Discord.RequestOptions)">IDiscordClient.GetConnectionsAsync(RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the connections that the user has set up.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -723,7 +757,8 @@
|
|||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -738,7 +773,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span><<span class="xref">System.Collections.Generic.IReadOnlyCollection</span><<a class="xref" href="Discord.IConnection.html">IConnection</a>>></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous get operation. The task result contains a read-only collection of connections.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -751,7 +787,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_BaseDiscordClient_Discord_IDiscordClient_GetDMChannelsAsync_" data-uid="Discord.Rest.BaseDiscordClient.Discord#IDiscordClient#GetDMChannelsAsync*"></a>
|
||||
<h4 id="Discord_Rest_BaseDiscordClient_Discord_IDiscordClient_GetDMChannelsAsync_Discord_CacheMode_Discord_RequestOptions_" data-uid="Discord.Rest.BaseDiscordClient.Discord#IDiscordClient#GetDMChannelsAsync(Discord.CacheMode,Discord.RequestOptions)">IDiscordClient.GetDMChannelsAsync(CacheMode, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a collection of direct message channels opened in this session.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -770,12 +807,14 @@
|
|||
<tr>
|
||||
<td><a class="xref" href="Discord.CacheMode.html">CacheMode</a></td>
|
||||
<td><span class="parametername">mode</span></td>
|
||||
<td></td>
|
||||
<td><p>The <a class="xref" href="Discord.CacheMode.html">CacheMode</a> that determines whether the object should be fetched from cache.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -790,10 +829,19 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span><<span class="xref">System.Collections.Generic.IReadOnlyCollection</span><<a class="xref" href="Discord.IDMChannel.html">IDMChannel</a>>></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous get operation. The task result contains a read-only collection
|
||||
of direct-message channels that the user currently partakes in.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 id="Discord_Rest_BaseDiscordClient_Discord_IDiscordClient_GetDMChannelsAsync_Discord_CacheMode_Discord_RequestOptions__remarks">Remarks</h5>
|
||||
<div class="markdown level1 remarks"><p>This method returns a collection of currently opened direct message channels.</p>
|
||||
<div class="WARNING"><h5>warning</h5><p>
|
||||
This method will not return previously opened DM channels outside of the current session! If you
|
||||
have just started the client, this may return an empty collection.
|
||||
</p></div>
|
||||
</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_BaseDiscordClient_Discord_IDiscordClient_GetGroupChannelsAsync_Discord_CacheMode_Discord_RequestOptions_.md&value=---%0Auid%3A%20Discord.Rest.BaseDiscordClient.Discord%23IDiscordClient%23GetGroupChannelsAsync(Discord.CacheMode%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>
|
||||
|
|
@ -803,7 +851,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_BaseDiscordClient_Discord_IDiscordClient_GetGroupChannelsAsync_" data-uid="Discord.Rest.BaseDiscordClient.Discord#IDiscordClient#GetGroupChannelsAsync*"></a>
|
||||
<h4 id="Discord_Rest_BaseDiscordClient_Discord_IDiscordClient_GetGroupChannelsAsync_Discord_CacheMode_Discord_RequestOptions_" data-uid="Discord.Rest.BaseDiscordClient.Discord#IDiscordClient#GetGroupChannelsAsync(Discord.CacheMode,Discord.RequestOptions)">IDiscordClient.GetGroupChannelsAsync(CacheMode, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a collection of group channels opened in this session.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -822,12 +871,14 @@
|
|||
<tr>
|
||||
<td><a class="xref" href="Discord.CacheMode.html">CacheMode</a></td>
|
||||
<td><span class="parametername">mode</span></td>
|
||||
<td></td>
|
||||
<td><p>The <a class="xref" href="Discord.CacheMode.html">CacheMode</a> that determines whether the object should be fetched from cache.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -842,10 +893,19 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span><<span class="xref">System.Collections.Generic.IReadOnlyCollection</span><<a class="xref" href="Discord.IGroupChannel.html">IGroupChannel</a>>></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous get operation. The task result contains a read-only collection
|
||||
of group channels that the user currently partakes in.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 id="Discord_Rest_BaseDiscordClient_Discord_IDiscordClient_GetGroupChannelsAsync_Discord_CacheMode_Discord_RequestOptions__remarks">Remarks</h5>
|
||||
<div class="markdown level1 remarks"><p>This method returns a collection of currently opened group channels.</p>
|
||||
<div class="WARNING"><h5>warning</h5><p>
|
||||
This method will not return previously opened group channels outside of the current session! If you
|
||||
have just started the client, this may return an empty collection.
|
||||
</p></div>
|
||||
</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_BaseDiscordClient_Discord_IDiscordClient_GetGuildAsync_System_UInt64_Discord_CacheMode_Discord_RequestOptions_.md&value=---%0Auid%3A%20Discord.Rest.BaseDiscordClient.Discord%23IDiscordClient%23GetGuildAsync(System.UInt64%2CDiscord.CacheMode%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>
|
||||
|
|
@ -855,7 +915,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_BaseDiscordClient_Discord_IDiscordClient_GetGuildAsync_" data-uid="Discord.Rest.BaseDiscordClient.Discord#IDiscordClient#GetGuildAsync*"></a>
|
||||
<h4 id="Discord_Rest_BaseDiscordClient_Discord_IDiscordClient_GetGuildAsync_System_UInt64_Discord_CacheMode_Discord_RequestOptions_" data-uid="Discord.Rest.BaseDiscordClient.Discord#IDiscordClient#GetGuildAsync(System.UInt64,Discord.CacheMode,Discord.RequestOptions)">IDiscordClient.GetGuildAsync(UInt64, CacheMode, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a guild.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -874,17 +935,20 @@
|
|||
<tr>
|
||||
<td><span class="xref">System.UInt64</span></td>
|
||||
<td><span class="parametername">id</span></td>
|
||||
<td></td>
|
||||
<td><p>The guild snowflake identifier.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.CacheMode.html">CacheMode</a></td>
|
||||
<td><span class="parametername">mode</span></td>
|
||||
<td></td>
|
||||
<td><p>The <a class="xref" href="Discord.CacheMode.html">CacheMode</a> that determines whether the object should be fetched from cache.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -899,7 +963,9 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span><<a class="xref" href="Discord.IGuild.html">IGuild</a>></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous get operation. The task result contains the guild associated
|
||||
with the snowflake identifier; <code>null</code> when the guild cannot be found.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -912,7 +978,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_BaseDiscordClient_Discord_IDiscordClient_GetGuildsAsync_" data-uid="Discord.Rest.BaseDiscordClient.Discord#IDiscordClient#GetGuildsAsync*"></a>
|
||||
<h4 id="Discord_Rest_BaseDiscordClient_Discord_IDiscordClient_GetGuildsAsync_Discord_CacheMode_Discord_RequestOptions_" data-uid="Discord.Rest.BaseDiscordClient.Discord#IDiscordClient#GetGuildsAsync(Discord.CacheMode,Discord.RequestOptions)">IDiscordClient.GetGuildsAsync(CacheMode, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a collection of guilds that the user is currently in.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -931,12 +998,14 @@
|
|||
<tr>
|
||||
<td><a class="xref" href="Discord.CacheMode.html">CacheMode</a></td>
|
||||
<td><span class="parametername">mode</span></td>
|
||||
<td></td>
|
||||
<td><p>The <a class="xref" href="Discord.CacheMode.html">CacheMode</a> that determines whether the object should be fetched from cache.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -951,7 +1020,9 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span><<span class="xref">System.Collections.Generic.IReadOnlyCollection</span><<a class="xref" href="Discord.IGuild.html">IGuild</a>>></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous get operation. The task result contains a read-only collection
|
||||
of guilds that the current user is in.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -964,7 +1035,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_BaseDiscordClient_Discord_IDiscordClient_GetInviteAsync_" data-uid="Discord.Rest.BaseDiscordClient.Discord#IDiscordClient#GetInviteAsync*"></a>
|
||||
<h4 id="Discord_Rest_BaseDiscordClient_Discord_IDiscordClient_GetInviteAsync_System_String_Discord_RequestOptions_" data-uid="Discord.Rest.BaseDiscordClient.Discord#IDiscordClient#GetInviteAsync(System.String,Discord.RequestOptions)">IDiscordClient.GetInviteAsync(String, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets an invite.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -983,12 +1055,14 @@
|
|||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td><span class="parametername">inviteId</span></td>
|
||||
<td></td>
|
||||
<td><p>The invitation identifier.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1003,7 +1077,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span><<a class="xref" href="Discord.IInvite.html">IInvite</a>></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous get operation. The task result contains the invite information.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1016,7 +1091,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_BaseDiscordClient_Discord_IDiscordClient_GetPrivateChannelsAsync_" data-uid="Discord.Rest.BaseDiscordClient.Discord#IDiscordClient#GetPrivateChannelsAsync*"></a>
|
||||
<h4 id="Discord_Rest_BaseDiscordClient_Discord_IDiscordClient_GetPrivateChannelsAsync_Discord_CacheMode_Discord_RequestOptions_" data-uid="Discord.Rest.BaseDiscordClient.Discord#IDiscordClient#GetPrivateChannelsAsync(Discord.CacheMode,Discord.RequestOptions)">IDiscordClient.GetPrivateChannelsAsync(CacheMode, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a collection of private channels opened in this session.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1035,12 +1111,14 @@
|
|||
<tr>
|
||||
<td><a class="xref" href="Discord.CacheMode.html">CacheMode</a></td>
|
||||
<td><span class="parametername">mode</span></td>
|
||||
<td></td>
|
||||
<td><p>The <a class="xref" href="Discord.CacheMode.html">CacheMode</a> that determines whether the object should be fetched from cache.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1055,10 +1133,20 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span><<span class="xref">System.Collections.Generic.IReadOnlyCollection</span><<a class="xref" href="Discord.IPrivateChannel.html">IPrivateChannel</a>>></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous get operation. The task result contains a read-only collection
|
||||
of private channels that the user currently partakes in.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 id="Discord_Rest_BaseDiscordClient_Discord_IDiscordClient_GetPrivateChannelsAsync_Discord_CacheMode_Discord_RequestOptions__remarks">Remarks</h5>
|
||||
<div class="markdown level1 remarks"><p>This method will retrieve all private channels (including direct-message, group channel and such) that
|
||||
are currently opened in this session.</p>
|
||||
<div class="WARNING"><h5>warning</h5><p>
|
||||
This method will not return previously opened private channels outside of the current session! If
|
||||
you have just started the client, this may return an empty collection.
|
||||
</p></div>
|
||||
</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_BaseDiscordClient_Discord_IDiscordClient_GetUserAsync_System_String_System_String_Discord_RequestOptions_.md&value=---%0Auid%3A%20Discord.Rest.BaseDiscordClient.Discord%23IDiscordClient%23GetUserAsync(System.String%2CSystem.String%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>
|
||||
|
|
@ -1068,7 +1156,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_BaseDiscordClient_Discord_IDiscordClient_GetUserAsync_" data-uid="Discord.Rest.BaseDiscordClient.Discord#IDiscordClient#GetUserAsync*"></a>
|
||||
<h4 id="Discord_Rest_BaseDiscordClient_Discord_IDiscordClient_GetUserAsync_System_String_System_String_Discord_RequestOptions_" data-uid="Discord.Rest.BaseDiscordClient.Discord#IDiscordClient#GetUserAsync(System.String,System.String,Discord.RequestOptions)">IDiscordClient.GetUserAsync(String, String, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a user.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1087,17 +1176,20 @@
|
|||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td><span class="parametername">username</span></td>
|
||||
<td></td>
|
||||
<td><p>The name of the user (e.g. <code>Still</code>).</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td><span class="parametername">discriminator</span></td>
|
||||
<td></td>
|
||||
<td><p>The discriminator value of the user (e.g. <code>2876</code>).</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1112,7 +1204,9 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span><<a class="xref" href="Discord.IUser.html">IUser</a>></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous get operation. The task result contains the user associated with
|
||||
the name and the discriminator; <code>null</code> if the user is not found.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1125,7 +1219,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_BaseDiscordClient_Discord_IDiscordClient_GetUserAsync_" data-uid="Discord.Rest.BaseDiscordClient.Discord#IDiscordClient#GetUserAsync*"></a>
|
||||
<h4 id="Discord_Rest_BaseDiscordClient_Discord_IDiscordClient_GetUserAsync_System_UInt64_Discord_CacheMode_Discord_RequestOptions_" data-uid="Discord.Rest.BaseDiscordClient.Discord#IDiscordClient#GetUserAsync(System.UInt64,Discord.CacheMode,Discord.RequestOptions)">IDiscordClient.GetUserAsync(UInt64, CacheMode, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a user.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1144,17 +1239,20 @@
|
|||
<tr>
|
||||
<td><span class="xref">System.UInt64</span></td>
|
||||
<td><span class="parametername">id</span></td>
|
||||
<td></td>
|
||||
<td><p>The snowflake identifier of the user (e.g. <code>168693960628371456</code>).</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.CacheMode.html">CacheMode</a></td>
|
||||
<td><span class="parametername">mode</span></td>
|
||||
<td></td>
|
||||
<td><p>The <a class="xref" href="Discord.CacheMode.html">CacheMode</a> that determines whether the object should be fetched from cache.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1169,7 +1267,9 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span><<a class="xref" href="Discord.IUser.html">IUser</a>></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous get operation. The task result contains the user associated with
|
||||
the snowflake identifier; <code>null</code> if the user is not found.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1182,7 +1282,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_BaseDiscordClient_Discord_IDiscordClient_GetVoiceRegionAsync_" data-uid="Discord.Rest.BaseDiscordClient.Discord#IDiscordClient#GetVoiceRegionAsync*"></a>
|
||||
<h4 id="Discord_Rest_BaseDiscordClient_Discord_IDiscordClient_GetVoiceRegionAsync_System_String_Discord_RequestOptions_" data-uid="Discord.Rest.BaseDiscordClient.Discord#IDiscordClient#GetVoiceRegionAsync(System.String,Discord.RequestOptions)">IDiscordClient.GetVoiceRegionAsync(String, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a voice region.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1201,12 +1302,14 @@
|
|||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td><span class="parametername">id</span></td>
|
||||
<td></td>
|
||||
<td><p>The identifier of the voice region (e.g. <code>eu-central</code> ).</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1221,7 +1324,9 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span><<a class="xref" href="Discord.IVoiceRegion.html">IVoiceRegion</a>></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous get operation. The task result contains the voice region
|
||||
associated with the identifier; <code>null</code> if the voice region is not found.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1234,7 +1339,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_BaseDiscordClient_Discord_IDiscordClient_GetVoiceRegionsAsync_" data-uid="Discord.Rest.BaseDiscordClient.Discord#IDiscordClient#GetVoiceRegionsAsync*"></a>
|
||||
<h4 id="Discord_Rest_BaseDiscordClient_Discord_IDiscordClient_GetVoiceRegionsAsync_Discord_RequestOptions_" data-uid="Discord.Rest.BaseDiscordClient.Discord#IDiscordClient#GetVoiceRegionsAsync(Discord.RequestOptions)">IDiscordClient.GetVoiceRegionsAsync(RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a collection of the available voice regions.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1253,7 +1359,8 @@
|
|||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1268,7 +1375,9 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span><<span class="xref">System.Collections.Generic.IReadOnlyCollection</span><<a class="xref" href="Discord.IVoiceRegion.html">IVoiceRegion</a>>></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous get operation. The task result contains a read-only collection
|
||||
with all of the available voice regions in this session.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1281,7 +1390,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_BaseDiscordClient_Discord_IDiscordClient_GetWebhookAsync_" data-uid="Discord.Rest.BaseDiscordClient.Discord#IDiscordClient#GetWebhookAsync*"></a>
|
||||
<h4 id="Discord_Rest_BaseDiscordClient_Discord_IDiscordClient_GetWebhookAsync_System_UInt64_Discord_RequestOptions_" data-uid="Discord.Rest.BaseDiscordClient.Discord#IDiscordClient#GetWebhookAsync(System.UInt64,Discord.RequestOptions)">IDiscordClient.GetWebhookAsync(UInt64, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a webhook available.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1300,12 +1410,14 @@
|
|||
<tr>
|
||||
<td><span class="xref">System.UInt64</span></td>
|
||||
<td><span class="parametername">id</span></td>
|
||||
<td></td>
|
||||
<td><p>The identifier of the webhook.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1320,7 +1432,9 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span><<a class="xref" href="Discord.IWebhook.html">IWebhook</a>></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous get operation. The task result contains a webhook associated
|
||||
with the identifier; <code>null</code> if the webhook is not found.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1333,7 +1447,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_BaseDiscordClient_Discord_IDiscordClient_StartAsync_" data-uid="Discord.Rest.BaseDiscordClient.Discord#IDiscordClient#StartAsync*"></a>
|
||||
<h4 id="Discord_Rest_BaseDiscordClient_Discord_IDiscordClient_StartAsync" data-uid="Discord.Rest.BaseDiscordClient.Discord#IDiscordClient#StartAsync">IDiscordClient.StartAsync()</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Starts the connection between Discord and the client..</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1350,10 +1465,18 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous start operation.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 id="Discord_Rest_BaseDiscordClient_Discord_IDiscordClient_StartAsync_remarks">Remarks</h5>
|
||||
<div class="markdown level1 remarks"><p>This method will initialize the connection between the client and Discord.</p>
|
||||
<div class="IMPORTANT"><h5>important</h5><p>
|
||||
This method will immediately return after it is called, as it will initialize the connection on
|
||||
another thread.
|
||||
</p></div>
|
||||
</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_BaseDiscordClient_Discord_IDiscordClient_StopAsync.md&value=---%0Auid%3A%20Discord.Rest.BaseDiscordClient.Discord%23IDiscordClient%23StopAsync%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>
|
||||
|
|
@ -1363,7 +1486,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_BaseDiscordClient_Discord_IDiscordClient_StopAsync_" data-uid="Discord.Rest.BaseDiscordClient.Discord#IDiscordClient#StopAsync*"></a>
|
||||
<h4 id="Discord_Rest_BaseDiscordClient_Discord_IDiscordClient_StopAsync" data-uid="Discord.Rest.BaseDiscordClient.Discord#IDiscordClient#StopAsync">IDiscordClient.StopAsync()</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Stops the connection between Discord and the client.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1380,7 +1504,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous stop operation.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
|
|||
|
|
@ -1173,7 +1173,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_DiscordRestClient_Discord_IDiscordClient_CreateGuildAsync_" data-uid="Discord.Rest.DiscordRestClient.Discord#IDiscordClient#CreateGuildAsync*"></a>
|
||||
<h4 id="Discord_Rest_DiscordRestClient_Discord_IDiscordClient_CreateGuildAsync_System_String_Discord_IVoiceRegion_System_IO_Stream_Discord_RequestOptions_" data-uid="Discord.Rest.DiscordRestClient.Discord#IDiscordClient#CreateGuildAsync(System.String,Discord.IVoiceRegion,System.IO.Stream,Discord.RequestOptions)">IDiscordClient.CreateGuildAsync(String, IVoiceRegion, Stream, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Creates a guild for the logged-in user who is in less than 10 active guilds.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1192,22 +1193,26 @@
|
|||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td><span class="parametername">name</span></td>
|
||||
<td></td>
|
||||
<td><p>The name of the new guild.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.IVoiceRegion.html">IVoiceRegion</a></td>
|
||||
<td><span class="parametername">region</span></td>
|
||||
<td></td>
|
||||
<td><p>The voice region to create the guild with.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.IO.Stream</span></td>
|
||||
<td><span class="parametername">jpegIcon</span></td>
|
||||
<td></td>
|
||||
<td><p>The icon of the guild.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1222,10 +1227,17 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span><<a class="xref" href="Discord.IGuild.html">IGuild</a>></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous creation operation. The task result contains the created guild.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 id="Discord_Rest_DiscordRestClient_Discord_IDiscordClient_CreateGuildAsync_System_String_Discord_IVoiceRegion_System_IO_Stream_Discord_RequestOptions__remarks">Remarks</h5>
|
||||
<div class="markdown level1 remarks"><p>This method creates a new guild on behalf of the logged-in user.</p>
|
||||
<div class="WARNING"><h5>warning</h5><p>
|
||||
Due to Discord's limitation, this method will only work for users that are in less than 10 guilds.
|
||||
</p></div>
|
||||
</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_DiscordRestClient_Discord_IDiscordClient_GetApplicationInfoAsync_Discord_RequestOptions_.md&value=---%0Auid%3A%20Discord.Rest.DiscordRestClient.Discord%23IDiscordClient%23GetApplicationInfoAsync(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>
|
||||
|
|
@ -1235,7 +1247,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_DiscordRestClient_Discord_IDiscordClient_GetApplicationInfoAsync_" data-uid="Discord.Rest.DiscordRestClient.Discord#IDiscordClient#GetApplicationInfoAsync*"></a>
|
||||
<h4 id="Discord_Rest_DiscordRestClient_Discord_IDiscordClient_GetApplicationInfoAsync_Discord_RequestOptions_" data-uid="Discord.Rest.DiscordRestClient.Discord#IDiscordClient#GetApplicationInfoAsync(Discord.RequestOptions)">IDiscordClient.GetApplicationInfoAsync(RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a Discord application information for the logged-in user.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1254,7 +1267,8 @@
|
|||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1269,10 +1283,16 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span><<a class="xref" href="Discord.IApplication.html">IApplication</a>></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous get operation. The task result contains the application
|
||||
information.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 id="Discord_Rest_DiscordRestClient_Discord_IDiscordClient_GetApplicationInfoAsync_Discord_RequestOptions__remarks">Remarks</h5>
|
||||
<div class="markdown level1 remarks"><p>This method reflects your application information you submitted when creating a Discord application via
|
||||
the Developer Portal.</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_DiscordRestClient_Discord_IDiscordClient_GetChannelAsync_System_UInt64_Discord_CacheMode_Discord_RequestOptions_.md&value=---%0Auid%3A%20Discord.Rest.DiscordRestClient.Discord%23IDiscordClient%23GetChannelAsync(System.UInt64%2CDiscord.CacheMode%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>
|
||||
|
|
@ -1282,7 +1302,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_DiscordRestClient_Discord_IDiscordClient_GetChannelAsync_" data-uid="Discord.Rest.DiscordRestClient.Discord#IDiscordClient#GetChannelAsync*"></a>
|
||||
<h4 id="Discord_Rest_DiscordRestClient_Discord_IDiscordClient_GetChannelAsync_System_UInt64_Discord_CacheMode_Discord_RequestOptions_" data-uid="Discord.Rest.DiscordRestClient.Discord#IDiscordClient#GetChannelAsync(System.UInt64,Discord.CacheMode,Discord.RequestOptions)">IDiscordClient.GetChannelAsync(UInt64, CacheMode, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a generic channel.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1301,17 +1322,20 @@
|
|||
<tr>
|
||||
<td><span class="xref">System.UInt64</span></td>
|
||||
<td><span class="parametername">id</span></td>
|
||||
<td></td>
|
||||
<td><p>The snowflake identifier of the channel (e.g. <code>381889909113225237</code>).</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.CacheMode.html">CacheMode</a></td>
|
||||
<td><span class="parametername">mode</span></td>
|
||||
<td></td>
|
||||
<td><p>The <a class="xref" href="Discord.CacheMode.html">CacheMode</a> that determines whether the object should be fetched from cache.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1326,7 +1350,9 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span><<a class="xref" href="Discord.IChannel.html">IChannel</a>></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous get operation. The task result contains the channel associated
|
||||
with the snowflake identifier; <code>null</code> when the channel cannot be found.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1339,7 +1365,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_DiscordRestClient_Discord_IDiscordClient_GetConnectionsAsync_" data-uid="Discord.Rest.DiscordRestClient.Discord#IDiscordClient#GetConnectionsAsync*"></a>
|
||||
<h4 id="Discord_Rest_DiscordRestClient_Discord_IDiscordClient_GetConnectionsAsync_Discord_RequestOptions_" data-uid="Discord.Rest.DiscordRestClient.Discord#IDiscordClient#GetConnectionsAsync(Discord.RequestOptions)">IDiscordClient.GetConnectionsAsync(RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the connections that the user has set up.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1358,7 +1385,8 @@
|
|||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1373,7 +1401,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span><<span class="xref">System.Collections.Generic.IReadOnlyCollection</span><<a class="xref" href="Discord.IConnection.html">IConnection</a>>></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous get operation. The task result contains a read-only collection of connections.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1386,7 +1415,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_DiscordRestClient_Discord_IDiscordClient_GetDMChannelsAsync_" data-uid="Discord.Rest.DiscordRestClient.Discord#IDiscordClient#GetDMChannelsAsync*"></a>
|
||||
<h4 id="Discord_Rest_DiscordRestClient_Discord_IDiscordClient_GetDMChannelsAsync_Discord_CacheMode_Discord_RequestOptions_" data-uid="Discord.Rest.DiscordRestClient.Discord#IDiscordClient#GetDMChannelsAsync(Discord.CacheMode,Discord.RequestOptions)">IDiscordClient.GetDMChannelsAsync(CacheMode, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a collection of direct message channels opened in this session.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1405,12 +1435,14 @@
|
|||
<tr>
|
||||
<td><a class="xref" href="Discord.CacheMode.html">CacheMode</a></td>
|
||||
<td><span class="parametername">mode</span></td>
|
||||
<td></td>
|
||||
<td><p>The <a class="xref" href="Discord.CacheMode.html">CacheMode</a> that determines whether the object should be fetched from cache.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1425,10 +1457,19 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span><<span class="xref">System.Collections.Generic.IReadOnlyCollection</span><<a class="xref" href="Discord.IDMChannel.html">IDMChannel</a>>></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous get operation. The task result contains a read-only collection
|
||||
of direct-message channels that the user currently partakes in.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 id="Discord_Rest_DiscordRestClient_Discord_IDiscordClient_GetDMChannelsAsync_Discord_CacheMode_Discord_RequestOptions__remarks">Remarks</h5>
|
||||
<div class="markdown level1 remarks"><p>This method returns a collection of currently opened direct message channels.</p>
|
||||
<div class="WARNING"><h5>warning</h5><p>
|
||||
This method will not return previously opened DM channels outside of the current session! If you
|
||||
have just started the client, this may return an empty collection.
|
||||
</p></div>
|
||||
</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_DiscordRestClient_Discord_IDiscordClient_GetGroupChannelsAsync_Discord_CacheMode_Discord_RequestOptions_.md&value=---%0Auid%3A%20Discord.Rest.DiscordRestClient.Discord%23IDiscordClient%23GetGroupChannelsAsync(Discord.CacheMode%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>
|
||||
|
|
@ -1438,7 +1479,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_DiscordRestClient_Discord_IDiscordClient_GetGroupChannelsAsync_" data-uid="Discord.Rest.DiscordRestClient.Discord#IDiscordClient#GetGroupChannelsAsync*"></a>
|
||||
<h4 id="Discord_Rest_DiscordRestClient_Discord_IDiscordClient_GetGroupChannelsAsync_Discord_CacheMode_Discord_RequestOptions_" data-uid="Discord.Rest.DiscordRestClient.Discord#IDiscordClient#GetGroupChannelsAsync(Discord.CacheMode,Discord.RequestOptions)">IDiscordClient.GetGroupChannelsAsync(CacheMode, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a collection of group channels opened in this session.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1457,12 +1499,14 @@
|
|||
<tr>
|
||||
<td><a class="xref" href="Discord.CacheMode.html">CacheMode</a></td>
|
||||
<td><span class="parametername">mode</span></td>
|
||||
<td></td>
|
||||
<td><p>The <a class="xref" href="Discord.CacheMode.html">CacheMode</a> that determines whether the object should be fetched from cache.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1477,10 +1521,19 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span><<span class="xref">System.Collections.Generic.IReadOnlyCollection</span><<a class="xref" href="Discord.IGroupChannel.html">IGroupChannel</a>>></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous get operation. The task result contains a read-only collection
|
||||
of group channels that the user currently partakes in.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 id="Discord_Rest_DiscordRestClient_Discord_IDiscordClient_GetGroupChannelsAsync_Discord_CacheMode_Discord_RequestOptions__remarks">Remarks</h5>
|
||||
<div class="markdown level1 remarks"><p>This method returns a collection of currently opened group channels.</p>
|
||||
<div class="WARNING"><h5>warning</h5><p>
|
||||
This method will not return previously opened group channels outside of the current session! If you
|
||||
have just started the client, this may return an empty collection.
|
||||
</p></div>
|
||||
</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_DiscordRestClient_Discord_IDiscordClient_GetGuildAsync_System_UInt64_Discord_CacheMode_Discord_RequestOptions_.md&value=---%0Auid%3A%20Discord.Rest.DiscordRestClient.Discord%23IDiscordClient%23GetGuildAsync(System.UInt64%2CDiscord.CacheMode%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>
|
||||
|
|
@ -1490,7 +1543,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_DiscordRestClient_Discord_IDiscordClient_GetGuildAsync_" data-uid="Discord.Rest.DiscordRestClient.Discord#IDiscordClient#GetGuildAsync*"></a>
|
||||
<h4 id="Discord_Rest_DiscordRestClient_Discord_IDiscordClient_GetGuildAsync_System_UInt64_Discord_CacheMode_Discord_RequestOptions_" data-uid="Discord.Rest.DiscordRestClient.Discord#IDiscordClient#GetGuildAsync(System.UInt64,Discord.CacheMode,Discord.RequestOptions)">IDiscordClient.GetGuildAsync(UInt64, CacheMode, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a guild.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1509,17 +1563,20 @@
|
|||
<tr>
|
||||
<td><span class="xref">System.UInt64</span></td>
|
||||
<td><span class="parametername">id</span></td>
|
||||
<td></td>
|
||||
<td><p>The guild snowflake identifier.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.CacheMode.html">CacheMode</a></td>
|
||||
<td><span class="parametername">mode</span></td>
|
||||
<td></td>
|
||||
<td><p>The <a class="xref" href="Discord.CacheMode.html">CacheMode</a> that determines whether the object should be fetched from cache.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1534,7 +1591,9 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span><<a class="xref" href="Discord.IGuild.html">IGuild</a>></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous get operation. The task result contains the guild associated
|
||||
with the snowflake identifier; <code>null</code> when the guild cannot be found.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1547,7 +1606,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_DiscordRestClient_Discord_IDiscordClient_GetGuildsAsync_" data-uid="Discord.Rest.DiscordRestClient.Discord#IDiscordClient#GetGuildsAsync*"></a>
|
||||
<h4 id="Discord_Rest_DiscordRestClient_Discord_IDiscordClient_GetGuildsAsync_Discord_CacheMode_Discord_RequestOptions_" data-uid="Discord.Rest.DiscordRestClient.Discord#IDiscordClient#GetGuildsAsync(Discord.CacheMode,Discord.RequestOptions)">IDiscordClient.GetGuildsAsync(CacheMode, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a collection of guilds that the user is currently in.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1566,12 +1626,14 @@
|
|||
<tr>
|
||||
<td><a class="xref" href="Discord.CacheMode.html">CacheMode</a></td>
|
||||
<td><span class="parametername">mode</span></td>
|
||||
<td></td>
|
||||
<td><p>The <a class="xref" href="Discord.CacheMode.html">CacheMode</a> that determines whether the object should be fetched from cache.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1586,7 +1648,9 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span><<span class="xref">System.Collections.Generic.IReadOnlyCollection</span><<a class="xref" href="Discord.IGuild.html">IGuild</a>>></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous get operation. The task result contains a read-only collection
|
||||
of guilds that the current user is in.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1651,7 +1715,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_DiscordRestClient_Discord_IDiscordClient_GetPrivateChannelsAsync_" data-uid="Discord.Rest.DiscordRestClient.Discord#IDiscordClient#GetPrivateChannelsAsync*"></a>
|
||||
<h4 id="Discord_Rest_DiscordRestClient_Discord_IDiscordClient_GetPrivateChannelsAsync_Discord_CacheMode_Discord_RequestOptions_" data-uid="Discord.Rest.DiscordRestClient.Discord#IDiscordClient#GetPrivateChannelsAsync(Discord.CacheMode,Discord.RequestOptions)">IDiscordClient.GetPrivateChannelsAsync(CacheMode, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a collection of private channels opened in this session.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1670,12 +1735,14 @@
|
|||
<tr>
|
||||
<td><a class="xref" href="Discord.CacheMode.html">CacheMode</a></td>
|
||||
<td><span class="parametername">mode</span></td>
|
||||
<td></td>
|
||||
<td><p>The <a class="xref" href="Discord.CacheMode.html">CacheMode</a> that determines whether the object should be fetched from cache.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1690,10 +1757,20 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span><<span class="xref">System.Collections.Generic.IReadOnlyCollection</span><<a class="xref" href="Discord.IPrivateChannel.html">IPrivateChannel</a>>></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous get operation. The task result contains a read-only collection
|
||||
of private channels that the user currently partakes in.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 id="Discord_Rest_DiscordRestClient_Discord_IDiscordClient_GetPrivateChannelsAsync_Discord_CacheMode_Discord_RequestOptions__remarks">Remarks</h5>
|
||||
<div class="markdown level1 remarks"><p>This method will retrieve all private channels (including direct-message, group channel and such) that
|
||||
are currently opened in this session.</p>
|
||||
<div class="WARNING"><h5>warning</h5><p>
|
||||
This method will not return previously opened private channels outside of the current session! If
|
||||
you have just started the client, this may return an empty collection.
|
||||
</p></div>
|
||||
</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_DiscordRestClient_Discord_IDiscordClient_GetUserAsync_System_UInt64_Discord_CacheMode_Discord_RequestOptions_.md&value=---%0Auid%3A%20Discord.Rest.DiscordRestClient.Discord%23IDiscordClient%23GetUserAsync(System.UInt64%2CDiscord.CacheMode%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>
|
||||
|
|
@ -1703,7 +1780,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_DiscordRestClient_Discord_IDiscordClient_GetUserAsync_" data-uid="Discord.Rest.DiscordRestClient.Discord#IDiscordClient#GetUserAsync*"></a>
|
||||
<h4 id="Discord_Rest_DiscordRestClient_Discord_IDiscordClient_GetUserAsync_System_UInt64_Discord_CacheMode_Discord_RequestOptions_" data-uid="Discord.Rest.DiscordRestClient.Discord#IDiscordClient#GetUserAsync(System.UInt64,Discord.CacheMode,Discord.RequestOptions)">IDiscordClient.GetUserAsync(UInt64, CacheMode, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a user.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1722,17 +1800,20 @@
|
|||
<tr>
|
||||
<td><span class="xref">System.UInt64</span></td>
|
||||
<td><span class="parametername">id</span></td>
|
||||
<td></td>
|
||||
<td><p>The snowflake identifier of the user (e.g. <code>168693960628371456</code>).</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.CacheMode.html">CacheMode</a></td>
|
||||
<td><span class="parametername">mode</span></td>
|
||||
<td></td>
|
||||
<td><p>The <a class="xref" href="Discord.CacheMode.html">CacheMode</a> that determines whether the object should be fetched from cache.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1747,7 +1828,9 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span><<a class="xref" href="Discord.IUser.html">IUser</a>></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous get operation. The task result contains the user associated with
|
||||
the snowflake identifier; <code>null</code> if the user is not found.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1760,7 +1843,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_DiscordRestClient_Discord_IDiscordClient_GetVoiceRegionAsync_" data-uid="Discord.Rest.DiscordRestClient.Discord#IDiscordClient#GetVoiceRegionAsync*"></a>
|
||||
<h4 id="Discord_Rest_DiscordRestClient_Discord_IDiscordClient_GetVoiceRegionAsync_System_String_Discord_RequestOptions_" data-uid="Discord.Rest.DiscordRestClient.Discord#IDiscordClient#GetVoiceRegionAsync(System.String,Discord.RequestOptions)">IDiscordClient.GetVoiceRegionAsync(String, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a voice region.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1779,12 +1863,14 @@
|
|||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td><span class="parametername">id</span></td>
|
||||
<td></td>
|
||||
<td><p>The identifier of the voice region (e.g. <code>eu-central</code> ).</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1799,7 +1885,9 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span><<a class="xref" href="Discord.IVoiceRegion.html">IVoiceRegion</a>></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous get operation. The task result contains the voice region
|
||||
associated with the identifier; <code>null</code> if the voice region is not found.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1812,7 +1900,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_DiscordRestClient_Discord_IDiscordClient_GetVoiceRegionsAsync_" data-uid="Discord.Rest.DiscordRestClient.Discord#IDiscordClient#GetVoiceRegionsAsync*"></a>
|
||||
<h4 id="Discord_Rest_DiscordRestClient_Discord_IDiscordClient_GetVoiceRegionsAsync_Discord_RequestOptions_" data-uid="Discord.Rest.DiscordRestClient.Discord#IDiscordClient#GetVoiceRegionsAsync(Discord.RequestOptions)">IDiscordClient.GetVoiceRegionsAsync(RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a collection of the available voice regions.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1831,7 +1920,8 @@
|
|||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1846,7 +1936,9 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span><<span class="xref">System.Collections.Generic.IReadOnlyCollection</span><<a class="xref" href="Discord.IVoiceRegion.html">IVoiceRegion</a>>></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous get operation. The task result contains a read-only collection
|
||||
with all of the available voice regions in this session.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1859,7 +1951,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_DiscordRestClient_Discord_IDiscordClient_GetWebhookAsync_" data-uid="Discord.Rest.DiscordRestClient.Discord#IDiscordClient#GetWebhookAsync*"></a>
|
||||
<h4 id="Discord_Rest_DiscordRestClient_Discord_IDiscordClient_GetWebhookAsync_System_UInt64_Discord_RequestOptions_" data-uid="Discord.Rest.DiscordRestClient.Discord#IDiscordClient#GetWebhookAsync(System.UInt64,Discord.RequestOptions)">IDiscordClient.GetWebhookAsync(UInt64, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a webhook available.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1878,12 +1971,14 @@
|
|||
<tr>
|
||||
<td><span class="xref">System.UInt64</span></td>
|
||||
<td><span class="parametername">id</span></td>
|
||||
<td></td>
|
||||
<td><p>The identifier of the webhook.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1898,7 +1993,9 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span><<a class="xref" href="Discord.IWebhook.html">IWebhook</a>></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous get operation. The task result contains a webhook associated
|
||||
with the identifier; <code>null</code> if the webhook is not found.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
|
|||
|
|
@ -160,7 +160,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestApplication_CreatedAt_" data-uid="Discord.Rest.RestApplication.CreatedAt*"></a>
|
||||
<h4 id="Discord_Rest_RestApplication_CreatedAt" data-uid="Discord.Rest.RestApplication.CreatedAt">CreatedAt</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets when the snowflake was created.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -177,7 +178,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.DateTimeOffset</span></td>
|
||||
<td></td>
|
||||
<td><p>A <span class="xref">System.DateTimeOffset</span> representing when the entity was first created.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -190,7 +192,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestApplication_Description_" data-uid="Discord.Rest.RestApplication.Description*"></a>
|
||||
<h4 id="Discord_Rest_RestApplication_Description" data-uid="Discord.Rest.RestApplication.Description">Description</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the description of the application.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -250,7 +253,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestApplication_IconUrl_" data-uid="Discord.Rest.RestApplication.IconUrl*"></a>
|
||||
<h4 id="Discord_Rest_RestApplication_IconUrl" data-uid="Discord.Rest.RestApplication.IconUrl">IconUrl</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the icon URL of the application.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -280,7 +284,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestApplication_Name_" data-uid="Discord.Rest.RestApplication.Name*"></a>
|
||||
<h4 id="Discord_Rest_RestApplication_Name" data-uid="Discord.Rest.RestApplication.Name">Name</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the name of the application.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -310,7 +315,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestApplication_Owner_" data-uid="Discord.Rest.RestApplication.Owner*"></a>
|
||||
<h4 id="Discord_Rest_RestApplication_Owner" data-uid="Discord.Rest.RestApplication.Owner">Owner</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the partial user object containing info on the owner of the application.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -340,7 +346,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestApplication_RPCOrigins_" data-uid="Discord.Rest.RestApplication.RPCOrigins*"></a>
|
||||
<h4 id="Discord_Rest_RestApplication_RPCOrigins" data-uid="Discord.Rest.RestApplication.RPCOrigins">RPCOrigins</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the RPC origins of the application.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
|
|||
|
|
@ -132,7 +132,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestAuditLogEntry_Action_" data-uid="Discord.Rest.RestAuditLogEntry.Action*"></a>
|
||||
<h4 id="Discord_Rest_RestAuditLogEntry_Action" data-uid="Discord.Rest.RestAuditLogEntry.Action">Action</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the action which occurred to create this entry.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -149,7 +150,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.ActionType.html">ActionType</a></td>
|
||||
<td></td>
|
||||
<td><p>The type of action for this audit log entry.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -162,7 +164,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestAuditLogEntry_CreatedAt_" data-uid="Discord.Rest.RestAuditLogEntry.CreatedAt*"></a>
|
||||
<h4 id="Discord_Rest_RestAuditLogEntry_CreatedAt" data-uid="Discord.Rest.RestAuditLogEntry.CreatedAt">CreatedAt</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets when the snowflake was created.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -179,7 +182,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.DateTimeOffset</span></td>
|
||||
<td></td>
|
||||
<td><p>A <span class="xref">System.DateTimeOffset</span> representing when the entity was first created.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -192,7 +196,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestAuditLogEntry_Data_" data-uid="Discord.Rest.RestAuditLogEntry.Data*"></a>
|
||||
<h4 id="Discord_Rest_RestAuditLogEntry_Data" data-uid="Discord.Rest.RestAuditLogEntry.Data">Data</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the data for this entry.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -209,7 +214,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.IAuditLogData.html">IAuditLogData</a></td>
|
||||
<td></td>
|
||||
<td><p>An <a class="xref" href="Discord.IAuditLogData.html">IAuditLogData</a> for this audit log entry; <code>null</code> if no data is available.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -222,7 +228,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestAuditLogEntry_Reason_" data-uid="Discord.Rest.RestAuditLogEntry.Reason*"></a>
|
||||
<h4 id="Discord_Rest_RestAuditLogEntry_Reason" data-uid="Discord.Rest.RestAuditLogEntry.Reason">Reason</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the reason behind the change.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -239,7 +246,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td></td>
|
||||
<td><p>A string containing the reason for the change; <code>null</code> if none is provided.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -252,7 +260,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestAuditLogEntry_User_" data-uid="Discord.Rest.RestAuditLogEntry.User*"></a>
|
||||
<h4 id="Discord_Rest_RestAuditLogEntry_User" data-uid="Discord.Rest.RestAuditLogEntry.User">User</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the user responsible for causing the changes.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -269,7 +278,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.IUser.html">IUser</a></td>
|
||||
<td></td>
|
||||
<td><p>A user object.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
|
|||
|
|
@ -123,7 +123,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestBan_Reason_" data-uid="Discord.Rest.RestBan.Reason*"></a>
|
||||
<h4 id="Discord_Rest_RestBan_Reason" data-uid="Discord.Rest.RestBan.Reason">Reason</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the reason why the user is banned if specified.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -140,7 +141,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td></td>
|
||||
<td><p>A string containing the reason behind the ban; <code>null</code> if none is specified.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -223,7 +225,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestBan_Discord_IBan_User_" data-uid="Discord.Rest.RestBan.Discord#IBan#User*"></a>
|
||||
<h4 id="Discord_Rest_RestBan_Discord_IBan_User" data-uid="Discord.Rest.RestBan.Discord#IBan#User">IBan.User</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the banned user.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -240,7 +243,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.IUser.html">IUser</a></td>
|
||||
<td></td>
|
||||
<td><p>A user that was banned.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
|
|||
|
|
@ -210,7 +210,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestCategoryChannel_Discord_IChannel_GetUserAsync_" data-uid="Discord.Rest.RestCategoryChannel.Discord#IChannel#GetUserAsync*"></a>
|
||||
<h4 id="Discord_Rest_RestCategoryChannel_Discord_IChannel_GetUserAsync_System_UInt64_Discord_CacheMode_Discord_RequestOptions_" data-uid="Discord.Rest.RestCategoryChannel.Discord#IChannel#GetUserAsync(System.UInt64,Discord.CacheMode,Discord.RequestOptions)">IChannel.GetUserAsync(UInt64, CacheMode, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a user in this channel.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -229,17 +230,20 @@
|
|||
<tr>
|
||||
<td><span class="xref">System.UInt64</span></td>
|
||||
<td><span class="parametername">id</span></td>
|
||||
<td></td>
|
||||
<td><p>The snowflake identifier of the user (e.g. <code>168693960628371456</code>).</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.CacheMode.html">CacheMode</a></td>
|
||||
<td><span class="parametername">mode</span></td>
|
||||
<td></td>
|
||||
<td><p>The <a class="xref" href="Discord.CacheMode.html">CacheMode</a> that determines whether the object should be fetched from cache.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -254,7 +258,9 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span><<a class="xref" href="Discord.IUser.html">IUser</a>></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous get operation. The task result contains a user object that
|
||||
represents the found user; <code>null</code> if none is found.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -283,7 +289,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestCategoryChannel_Discord_IChannel_GetUsersAsync_" data-uid="Discord.Rest.RestCategoryChannel.Discord#IChannel#GetUsersAsync*"></a>
|
||||
<h4 id="Discord_Rest_RestCategoryChannel_Discord_IChannel_GetUsersAsync_Discord_CacheMode_Discord_RequestOptions_" data-uid="Discord.Rest.RestCategoryChannel.Discord#IChannel#GetUsersAsync(Discord.CacheMode,Discord.RequestOptions)">IChannel.GetUsersAsync(CacheMode, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a collection of users that are able to view the channel or are currently in this channel.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -302,12 +309,14 @@
|
|||
<tr>
|
||||
<td><a class="xref" href="Discord.CacheMode.html">CacheMode</a></td>
|
||||
<td><span class="parametername">mode</span></td>
|
||||
<td></td>
|
||||
<td><p>The <a class="xref" href="Discord.CacheMode.html">CacheMode</a> that determines whether the object should be fetched from cache.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -322,10 +331,23 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Collections.Generic.IAsyncEnumerable</span><<span class="xref">System.Collections.Generic.IReadOnlyCollection</span><<a class="xref" href="Discord.IUser.html">IUser</a>>></td>
|
||||
<td></td>
|
||||
<td><p>Paged collection of users.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 id="Discord_Rest_RestCategoryChannel_Discord_IChannel_GetUsersAsync_Discord_CacheMode_Discord_RequestOptions__remarks">Remarks</h5>
|
||||
<div class="markdown level1 remarks"><div class="IMPORTANT"><h5>important</h5><p>
|
||||
The returned collection is an asynchronous enumerable object; one must call
|
||||
<a class="xref" href="Discord.AsyncEnumerableExtensions.html#Discord_AsyncEnumerableExtensions_FlattenAsync__1_System_Collections_Generic_IAsyncEnumerable_System_Collections_Generic_IEnumerable___0___">FlattenAsync<T>(IAsyncEnumerable<IEnumerable<T>>)</a> to access the individual messages as a
|
||||
collection.
|
||||
</p></div>
|
||||
This method will attempt to fetch all users that is able to view this channel or is currently in this channel.
|
||||
The library will attempt to split up the requests according to and <a class="xref" href="Discord.DiscordConfig.html#Discord_DiscordConfig_MaxUsersPerBatch">MaxUsersPerBatch</a>.
|
||||
In other words, if there are 3000 users, and the <a class="xref" href="Discord.DiscordConfig.html#Discord_DiscordConfig_MaxUsersPerBatch">MaxUsersPerBatch</a> constant
|
||||
is <code>1000</code>, the request will be split into 3 individual requests; thus returning 53individual asynchronous
|
||||
responses, hence the need of flattening.
|
||||
</div>
|
||||
<h5 class="exceptions">Exceptions</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
|
|
|
|||
|
|
@ -136,7 +136,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestChannel_CreatedAt_" data-uid="Discord.Rest.RestChannel.CreatedAt*"></a>
|
||||
<h4 id="Discord_Rest_RestChannel_CreatedAt" data-uid="Discord.Rest.RestChannel.CreatedAt">CreatedAt</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets when the snowflake was created.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -153,7 +154,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.DateTimeOffset</span></td>
|
||||
<td></td>
|
||||
<td><p>A <span class="xref">System.DateTimeOffset</span> representing when the entity was first created.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -168,7 +170,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestChannel_UpdateAsync_" data-uid="Discord.Rest.RestChannel.UpdateAsync*"></a>
|
||||
<h4 id="Discord_Rest_RestChannel_UpdateAsync_Discord_RequestOptions_" data-uid="Discord.Rest.RestChannel.UpdateAsync(Discord.RequestOptions)">UpdateAsync(RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Updates this object's properties with its current state.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -217,7 +220,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestChannel_Discord_IChannel_GetUserAsync_" data-uid="Discord.Rest.RestChannel.Discord#IChannel#GetUserAsync*"></a>
|
||||
<h4 id="Discord_Rest_RestChannel_Discord_IChannel_GetUserAsync_System_UInt64_Discord_CacheMode_Discord_RequestOptions_" data-uid="Discord.Rest.RestChannel.Discord#IChannel#GetUserAsync(System.UInt64,Discord.CacheMode,Discord.RequestOptions)">IChannel.GetUserAsync(UInt64, CacheMode, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a user in this channel.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -236,17 +240,20 @@
|
|||
<tr>
|
||||
<td><span class="xref">System.UInt64</span></td>
|
||||
<td><span class="parametername">id</span></td>
|
||||
<td></td>
|
||||
<td><p>The snowflake identifier of the user (e.g. <code>168693960628371456</code>).</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.CacheMode.html">CacheMode</a></td>
|
||||
<td><span class="parametername">mode</span></td>
|
||||
<td></td>
|
||||
<td><p>The <a class="xref" href="Discord.CacheMode.html">CacheMode</a> that determines whether the object should be fetched from cache.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -261,7 +268,9 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span><<a class="xref" href="Discord.IUser.html">IUser</a>></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous get operation. The task result contains a user object that
|
||||
represents the found user; <code>null</code> if none is found.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -274,7 +283,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestChannel_Discord_IChannel_GetUsersAsync_" data-uid="Discord.Rest.RestChannel.Discord#IChannel#GetUsersAsync*"></a>
|
||||
<h4 id="Discord_Rest_RestChannel_Discord_IChannel_GetUsersAsync_Discord_CacheMode_Discord_RequestOptions_" data-uid="Discord.Rest.RestChannel.Discord#IChannel#GetUsersAsync(Discord.CacheMode,Discord.RequestOptions)">IChannel.GetUsersAsync(CacheMode, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a collection of users that are able to view the channel or are currently in this channel.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -293,12 +303,14 @@
|
|||
<tr>
|
||||
<td><a class="xref" href="Discord.CacheMode.html">CacheMode</a></td>
|
||||
<td><span class="parametername">mode</span></td>
|
||||
<td></td>
|
||||
<td><p>The <a class="xref" href="Discord.CacheMode.html">CacheMode</a> that determines whether the object should be fetched from cache.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -313,10 +325,23 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Collections.Generic.IAsyncEnumerable</span><<span class="xref">System.Collections.Generic.IReadOnlyCollection</span><<a class="xref" href="Discord.IUser.html">IUser</a>>></td>
|
||||
<td></td>
|
||||
<td><p>Paged collection of users.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 id="Discord_Rest_RestChannel_Discord_IChannel_GetUsersAsync_Discord_CacheMode_Discord_RequestOptions__remarks">Remarks</h5>
|
||||
<div class="markdown level1 remarks"><div class="IMPORTANT"><h5>important</h5><p>
|
||||
The returned collection is an asynchronous enumerable object; one must call
|
||||
<a class="xref" href="Discord.AsyncEnumerableExtensions.html#Discord_AsyncEnumerableExtensions_FlattenAsync__1_System_Collections_Generic_IAsyncEnumerable_System_Collections_Generic_IEnumerable___0___">FlattenAsync<T>(IAsyncEnumerable<IEnumerable<T>>)</a> to access the individual messages as a
|
||||
collection.
|
||||
</p></div>
|
||||
This method will attempt to fetch all users that is able to view this channel or is currently in this channel.
|
||||
The library will attempt to split up the requests according to and <a class="xref" href="Discord.DiscordConfig.html#Discord_DiscordConfig_MaxUsersPerBatch">MaxUsersPerBatch</a>.
|
||||
In other words, if there are 3000 users, and the <a class="xref" href="Discord.DiscordConfig.html#Discord_DiscordConfig_MaxUsersPerBatch">MaxUsersPerBatch</a> constant
|
||||
is <code>1000</code>, the request will be split into 3 individual requests; thus returning 53individual asynchronous
|
||||
responses, hence the need of flattening.
|
||||
</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_RestChannel_Discord_IChannel_Name.md&value=---%0Auid%3A%20Discord.Rest.RestChannel.Discord%23IChannel%23Name%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>
|
||||
|
|
@ -326,7 +351,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestChannel_Discord_IChannel_Name_" data-uid="Discord.Rest.RestChannel.Discord#IChannel#Name*"></a>
|
||||
<h4 id="Discord_Rest_RestChannel_Discord_IChannel_Name" data-uid="Discord.Rest.RestChannel.Discord#IChannel#Name">IChannel.Name</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the name of this channel.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -343,7 +369,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td></td>
|
||||
<td><p>A string containing the name of this channel.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
|
|||
|
|
@ -122,7 +122,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestConnection_Id_" data-uid="Discord.Rest.RestConnection.Id*"></a>
|
||||
<h4 id="Discord_Rest_RestConnection_Id" data-uid="Discord.Rest.RestConnection.Id">Id</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the ID of the connection account.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -139,7 +140,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td></td>
|
||||
<td><p>A <span class="xref">System.String</span> representing the unique identifier value of this connection.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -152,7 +154,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestConnection_IntegrationIds_" data-uid="Discord.Rest.RestConnection.IntegrationIds*"></a>
|
||||
<h4 id="Discord_Rest_RestConnection_IntegrationIds" data-uid="Discord.Rest.RestConnection.IntegrationIds">IntegrationIds</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a <span class="xref">System.Collections.Generic.IReadOnlyCollection<T></span> of integration IDs.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -169,7 +172,9 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Collections.Generic.IReadOnlyCollection</span><<span class="xref">System.UInt64</span>></td>
|
||||
<td></td>
|
||||
<td><p>An <span class="xref">System.Collections.Generic.IReadOnlyCollection<T></span> containing <span class="xref">System.UInt64</span>
|
||||
representations of unique identifier values of integrations.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -182,7 +187,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestConnection_IsRevoked_" data-uid="Discord.Rest.RestConnection.IsRevoked*"></a>
|
||||
<h4 id="Discord_Rest_RestConnection_IsRevoked" data-uid="Discord.Rest.RestConnection.IsRevoked">IsRevoked</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets whether the connection is revoked.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -199,7 +205,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td></td>
|
||||
<td><p>A value which if true indicates that this connection has been revoked, otherwise false.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -212,7 +219,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestConnection_Name_" data-uid="Discord.Rest.RestConnection.Name*"></a>
|
||||
<h4 id="Discord_Rest_RestConnection_Name" data-uid="Discord.Rest.RestConnection.Name">Name</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the username of the connection account.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -229,7 +237,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td></td>
|
||||
<td><p>A string containing the name of this connection.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -242,7 +251,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestConnection_Type_" data-uid="Discord.Rest.RestConnection.Type*"></a>
|
||||
<h4 id="Discord_Rest_RestConnection_Type" data-uid="Discord.Rest.RestConnection.Type">Type</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the service of the connection (twitch, youtube).</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -259,7 +269,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td></td>
|
||||
<td><p>A string containing the name of this type of connection.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
|
|||
File diff suppressed because it is too large
Load diff
|
|
@ -144,7 +144,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestGroupChannel_Name_" data-uid="Discord.Rest.RestGroupChannel.Name*"></a>
|
||||
<h4 id="Discord_Rest_RestGroupChannel_Name" data-uid="Discord.Rest.RestGroupChannel.Name">Name</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the name of this channel.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -161,7 +162,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td></td>
|
||||
<td><p>A string containing the name of this channel.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -236,7 +238,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestGroupChannel_DeleteMessageAsync_" data-uid="Discord.Rest.RestGroupChannel.DeleteMessageAsync*"></a>
|
||||
<h4 id="Discord_Rest_RestGroupChannel_DeleteMessageAsync_Discord_IMessage_Discord_RequestOptions_" data-uid="Discord.Rest.RestGroupChannel.DeleteMessageAsync(Discord.IMessage,Discord.RequestOptions)">DeleteMessageAsync(IMessage, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Deletes a message based on the provided message in this channel.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -255,12 +258,14 @@
|
|||
<tr>
|
||||
<td><a class="xref" href="Discord.IMessage.html">IMessage</a></td>
|
||||
<td><span class="parametername">message</span></td>
|
||||
<td></td>
|
||||
<td><p>The message that would be removed.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -275,7 +280,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous removal operation.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -288,7 +294,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestGroupChannel_DeleteMessageAsync_" data-uid="Discord.Rest.RestGroupChannel.DeleteMessageAsync*"></a>
|
||||
<h4 id="Discord_Rest_RestGroupChannel_DeleteMessageAsync_System_UInt64_Discord_RequestOptions_" data-uid="Discord.Rest.RestGroupChannel.DeleteMessageAsync(System.UInt64,Discord.RequestOptions)">DeleteMessageAsync(UInt64, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Deletes a message.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -307,12 +314,14 @@
|
|||
<tr>
|
||||
<td><span class="xref">System.UInt64</span></td>
|
||||
<td><span class="parametername">messageId</span></td>
|
||||
<td></td>
|
||||
<td><p>The snowflake identifier of the message that would be removed.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -327,7 +336,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous removal operation.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -340,7 +350,9 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestGroupChannel_EnterTypingState_" data-uid="Discord.Rest.RestGroupChannel.EnterTypingState*"></a>
|
||||
<h4 id="Discord_Rest_RestGroupChannel_EnterTypingState_Discord_RequestOptions_" data-uid="Discord.Rest.RestGroupChannel.EnterTypingState(Discord.RequestOptions)">EnterTypingState(RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Continuously broadcasts the "user is typing" message to all users in this channel until the returned
|
||||
object is disposed.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -359,7 +371,8 @@
|
|||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -374,7 +387,9 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.IDisposable</span></td>
|
||||
<td></td>
|
||||
<td><p>A disposable object that, upon its disposal, will stop the client from broadcasting its typing state in
|
||||
this channel.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -387,7 +402,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestGroupChannel_GetMessageAsync_" data-uid="Discord.Rest.RestGroupChannel.GetMessageAsync*"></a>
|
||||
<h4 id="Discord_Rest_RestGroupChannel_GetMessageAsync_System_UInt64_Discord_RequestOptions_" data-uid="Discord.Rest.RestGroupChannel.GetMessageAsync(System.UInt64,Discord.RequestOptions)">GetMessageAsync(UInt64, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a message from this message channel.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -406,12 +422,14 @@
|
|||
<tr>
|
||||
<td><span class="xref">System.UInt64</span></td>
|
||||
<td><span class="parametername">id</span></td>
|
||||
<td></td>
|
||||
<td><p>The snowflake identifier of the message.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -426,10 +444,16 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span><<a class="xref" href="Discord.Rest.RestMessage.html">RestMessage</a>></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents an asynchronous get operation for retrieving the message. The task result contains
|
||||
the retrieved message; <code>null</code> if no message is found with the specified identifier.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 id="Discord_Rest_RestGroupChannel_GetMessageAsync_System_UInt64_Discord_RequestOptions__remarks">Remarks</h5>
|
||||
<div class="markdown level1 remarks"><p>This method follows the same behavior as described in <a class="xref" href="Discord.IMessageChannel.html#Discord_IMessageChannel_GetMessageAsync_System_UInt64_Discord_CacheMode_Discord_RequestOptions_">GetMessageAsync(UInt64, CacheMode, RequestOptions)</a>.
|
||||
Please visit its documentation for more details on this method.</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_RestGroupChannel_GetMessagesAsync_Discord_IMessage_Discord_Direction_System_Int32_Discord_RequestOptions_.md&value=---%0Auid%3A%20Discord.Rest.RestGroupChannel.GetMessagesAsync(Discord.IMessage%2CDiscord.Direction%2CSystem.Int32%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>
|
||||
|
|
@ -439,7 +463,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestGroupChannel_GetMessagesAsync_" data-uid="Discord.Rest.RestGroupChannel.GetMessagesAsync*"></a>
|
||||
<h4 id="Discord_Rest_RestGroupChannel_GetMessagesAsync_Discord_IMessage_Discord_Direction_System_Int32_Discord_RequestOptions_" data-uid="Discord.Rest.RestGroupChannel.GetMessagesAsync(Discord.IMessage,Discord.Direction,System.Int32,Discord.RequestOptions)">GetMessagesAsync(IMessage, Direction, Int32, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a collection of messages in this channel.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -458,22 +483,26 @@
|
|||
<tr>
|
||||
<td><a class="xref" href="Discord.IMessage.html">IMessage</a></td>
|
||||
<td><span class="parametername">fromMessage</span></td>
|
||||
<td></td>
|
||||
<td><p>The starting message to get the messages from.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.Direction.html">Direction</a></td>
|
||||
<td><span class="parametername">dir</span></td>
|
||||
<td></td>
|
||||
<td><p>The direction of the messages to be gotten from.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.Int32</span></td>
|
||||
<td><span class="parametername">limit</span></td>
|
||||
<td></td>
|
||||
<td><p>The numbers of message to be gotten from.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -488,10 +517,15 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Collections.Generic.IAsyncEnumerable</span><<span class="xref">System.Collections.Generic.IReadOnlyCollection</span><<a class="xref" href="Discord.Rest.RestMessage.html">RestMessage</a>>></td>
|
||||
<td></td>
|
||||
<td><p>Paged collection of messages.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 id="Discord_Rest_RestGroupChannel_GetMessagesAsync_Discord_IMessage_Discord_Direction_System_Int32_Discord_RequestOptions__remarks">Remarks</h5>
|
||||
<div class="markdown level1 remarks"><p>This method follows the same behavior as described in <a class="xref" href="Discord.IMessageChannel.html#Discord_IMessageChannel_GetMessagesAsync_Discord_IMessage_Discord_Direction_System_Int32_Discord_CacheMode_Discord_RequestOptions_">GetMessagesAsync(IMessage, Direction, Int32, CacheMode, RequestOptions)</a>.
|
||||
Please visit its documentation for more details on this method.</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_RestGroupChannel_GetMessagesAsync_System_Int32_Discord_RequestOptions_.md&value=---%0Auid%3A%20Discord.Rest.RestGroupChannel.GetMessagesAsync(System.Int32%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>
|
||||
|
|
@ -501,7 +535,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestGroupChannel_GetMessagesAsync_" data-uid="Discord.Rest.RestGroupChannel.GetMessagesAsync*"></a>
|
||||
<h4 id="Discord_Rest_RestGroupChannel_GetMessagesAsync_System_Int32_Discord_RequestOptions_" data-uid="Discord.Rest.RestGroupChannel.GetMessagesAsync(System.Int32,Discord.RequestOptions)">GetMessagesAsync(Int32, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the last N messages from this message channel.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -520,12 +555,14 @@
|
|||
<tr>
|
||||
<td><span class="xref">System.Int32</span></td>
|
||||
<td><span class="parametername">limit</span></td>
|
||||
<td></td>
|
||||
<td><p>The numbers of message to be gotten from.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -540,10 +577,15 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Collections.Generic.IAsyncEnumerable</span><<span class="xref">System.Collections.Generic.IReadOnlyCollection</span><<a class="xref" href="Discord.Rest.RestMessage.html">RestMessage</a>>></td>
|
||||
<td></td>
|
||||
<td><p>Paged collection of messages.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 id="Discord_Rest_RestGroupChannel_GetMessagesAsync_System_Int32_Discord_RequestOptions__remarks">Remarks</h5>
|
||||
<div class="markdown level1 remarks"><p>This method follows the same behavior as described in <a class="xref" href="Discord.IMessageChannel.html#Discord_IMessageChannel_GetMessagesAsync_System_Int32_Discord_CacheMode_Discord_RequestOptions_">GetMessagesAsync(Int32, CacheMode, RequestOptions)</a>.
|
||||
Please visit its documentation for more details on this method.</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_RestGroupChannel_GetMessagesAsync_System_UInt64_Discord_Direction_System_Int32_Discord_RequestOptions_.md&value=---%0Auid%3A%20Discord.Rest.RestGroupChannel.GetMessagesAsync(System.UInt64%2CDiscord.Direction%2CSystem.Int32%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>
|
||||
|
|
@ -553,7 +595,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestGroupChannel_GetMessagesAsync_" data-uid="Discord.Rest.RestGroupChannel.GetMessagesAsync*"></a>
|
||||
<h4 id="Discord_Rest_RestGroupChannel_GetMessagesAsync_System_UInt64_Discord_Direction_System_Int32_Discord_RequestOptions_" data-uid="Discord.Rest.RestGroupChannel.GetMessagesAsync(System.UInt64,Discord.Direction,System.Int32,Discord.RequestOptions)">GetMessagesAsync(UInt64, Direction, Int32, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a collection of messages in this channel.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -572,22 +615,26 @@
|
|||
<tr>
|
||||
<td><span class="xref">System.UInt64</span></td>
|
||||
<td><span class="parametername">fromMessageId</span></td>
|
||||
<td></td>
|
||||
<td><p>The ID of the starting message to get the messages from.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.Direction.html">Direction</a></td>
|
||||
<td><span class="parametername">dir</span></td>
|
||||
<td></td>
|
||||
<td><p>The direction of the messages to be gotten from.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.Int32</span></td>
|
||||
<td><span class="parametername">limit</span></td>
|
||||
<td></td>
|
||||
<td><p>The numbers of message to be gotten from.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -602,10 +649,15 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Collections.Generic.IAsyncEnumerable</span><<span class="xref">System.Collections.Generic.IReadOnlyCollection</span><<a class="xref" href="Discord.Rest.RestMessage.html">RestMessage</a>>></td>
|
||||
<td></td>
|
||||
<td><p>Paged collection of messages.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 id="Discord_Rest_RestGroupChannel_GetMessagesAsync_System_UInt64_Discord_Direction_System_Int32_Discord_RequestOptions__remarks">Remarks</h5>
|
||||
<div class="markdown level1 remarks"><p>This method follows the same behavior as described in <a class="xref" href="Discord.IMessageChannel.html#Discord_IMessageChannel_GetMessagesAsync_System_UInt64_Discord_Direction_System_Int32_Discord_CacheMode_Discord_RequestOptions_">GetMessagesAsync(UInt64, Direction, Int32, CacheMode, RequestOptions)</a>.
|
||||
Please visit its documentation for more details on this method.</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_RestGroupChannel_GetPinnedMessagesAsync_Discord_RequestOptions_.md&value=---%0Auid%3A%20Discord.Rest.RestGroupChannel.GetPinnedMessagesAsync(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>
|
||||
|
|
@ -615,7 +667,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestGroupChannel_GetPinnedMessagesAsync_" data-uid="Discord.Rest.RestGroupChannel.GetPinnedMessagesAsync*"></a>
|
||||
<h4 id="Discord_Rest_RestGroupChannel_GetPinnedMessagesAsync_Discord_RequestOptions_" data-uid="Discord.Rest.RestGroupChannel.GetPinnedMessagesAsync(Discord.RequestOptions)">GetPinnedMessagesAsync(RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a collection of pinned messages in this channel.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -634,7 +687,8 @@
|
|||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -649,10 +703,16 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span><<span class="xref">System.Collections.Generic.IReadOnlyCollection</span><<a class="xref" href="Discord.Rest.RestMessage.html">RestMessage</a>>></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous get operation for retrieving pinned messages in this channel.
|
||||
The task result contains a collection of messages found in the pinned messages.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 id="Discord_Rest_RestGroupChannel_GetPinnedMessagesAsync_Discord_RequestOptions__remarks">Remarks</h5>
|
||||
<div class="markdown level1 remarks"><p>This method follows the same behavior as described in <a class="xref" href="Discord.IMessageChannel.html#Discord_IMessageChannel_GetPinnedMessagesAsync_Discord_RequestOptions_">GetPinnedMessagesAsync(RequestOptions)</a>.
|
||||
Please visit its documentation for more details on this method.</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_RestGroupChannel_GetUser_System_UInt64_.md&value=---%0Auid%3A%20Discord.Rest.RestGroupChannel.GetUser(System.UInt64)%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>
|
||||
|
|
@ -709,7 +769,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestGroupChannel_LeaveAsync_" data-uid="Discord.Rest.RestGroupChannel.LeaveAsync*"></a>
|
||||
<h4 id="Discord_Rest_RestGroupChannel_LeaveAsync_Discord_RequestOptions_" data-uid="Discord.Rest.RestGroupChannel.LeaveAsync(Discord.RequestOptions)">LeaveAsync(RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Leaves this group.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -728,7 +789,8 @@
|
|||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -743,7 +805,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous leave operation.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -756,7 +819,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestGroupChannel_SendFileAsync_" data-uid="Discord.Rest.RestGroupChannel.SendFileAsync*"></a>
|
||||
<h4 id="Discord_Rest_RestGroupChannel_SendFileAsync_System_IO_Stream_System_String_System_String_System_Boolean_Discord_Embed_Discord_RequestOptions_System_Boolean_" data-uid="Discord.Rest.RestGroupChannel.SendFileAsync(System.IO.Stream,System.String,System.String,System.Boolean,Discord.Embed,Discord.RequestOptions,System.Boolean)">SendFileAsync(Stream, String, String, Boolean, Embed, RequestOptions, Boolean)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Sends a file to this message channel with an optional caption.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -775,32 +839,38 @@
|
|||
<tr>
|
||||
<td><span class="xref">System.IO.Stream</span></td>
|
||||
<td><span class="parametername">stream</span></td>
|
||||
<td></td>
|
||||
<td><p>The <span class="xref">System.IO.Stream</span> of the file to be sent.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td><span class="parametername">filename</span></td>
|
||||
<td></td>
|
||||
<td><p>The name of the attachment.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td><span class="parametername">text</span></td>
|
||||
<td></td>
|
||||
<td><p>The message to be sent.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td><span class="parametername">isTTS</span></td>
|
||||
<td></td>
|
||||
<td><p>Whether the message should be read aloud by Discord or not.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.Embed.html">Embed</a></td>
|
||||
<td><span class="parametername">embed</span></td>
|
||||
<td></td>
|
||||
<td><p>The <a class="xref" href="Discord.EmbedType.html#Discord_EmbedType_Rich">Rich</a> <a class="xref" href="Discord.Embed.html">Embed</a> to be sent.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
|
|
@ -820,10 +890,16 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span><<a class="xref" href="Discord.Rest.RestUserMessage.html">RestUserMessage</a>></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents an asynchronous send operation for delivering the message. The task result
|
||||
contains the sent message.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 id="Discord_Rest_RestGroupChannel_SendFileAsync_System_IO_Stream_System_String_System_String_System_Boolean_Discord_Embed_Discord_RequestOptions_System_Boolean__remarks">Remarks</h5>
|
||||
<div class="markdown level1 remarks"><p>This method follows the same behavior as described in <a class="xref" href="Discord.IMessageChannel.html#Discord_IMessageChannel_SendFileAsync_System_IO_Stream_System_String_System_String_System_Boolean_Discord_Embed_Discord_RequestOptions_System_Boolean_">SendFileAsync(Stream, String, String, Boolean, Embed, RequestOptions, Boolean)</a>.
|
||||
Please visit its documentation for more details on this method.</p>
|
||||
</div>
|
||||
<h5 class="exceptions">Exceptions</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
|
|
@ -849,7 +925,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestGroupChannel_SendFileAsync_" data-uid="Discord.Rest.RestGroupChannel.SendFileAsync*"></a>
|
||||
<h4 id="Discord_Rest_RestGroupChannel_SendFileAsync_System_String_System_String_System_Boolean_Discord_Embed_Discord_RequestOptions_System_Boolean_" data-uid="Discord.Rest.RestGroupChannel.SendFileAsync(System.String,System.String,System.Boolean,Discord.Embed,Discord.RequestOptions,System.Boolean)">SendFileAsync(String, String, Boolean, Embed, RequestOptions, Boolean)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Sends a file to this message channel with an optional caption.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -868,27 +945,32 @@
|
|||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td><span class="parametername">filePath</span></td>
|
||||
<td></td>
|
||||
<td><p>The file path of the file.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td><span class="parametername">text</span></td>
|
||||
<td></td>
|
||||
<td><p>The message to be sent.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td><span class="parametername">isTTS</span></td>
|
||||
<td></td>
|
||||
<td><p>Whether the message should be read aloud by Discord or not.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.Embed.html">Embed</a></td>
|
||||
<td><span class="parametername">embed</span></td>
|
||||
<td></td>
|
||||
<td><p>The <a class="xref" href="Discord.EmbedType.html#Discord_EmbedType_Rich">Rich</a> <a class="xref" href="Discord.Embed.html">Embed</a> to be sent.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
|
|
@ -908,10 +990,17 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span><<a class="xref" href="Discord.Rest.RestUserMessage.html">RestUserMessage</a>></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents an asynchronous send operation for delivering the message. The task result
|
||||
contains the sent message.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 id="Discord_Rest_RestGroupChannel_SendFileAsync_System_String_System_String_System_Boolean_Discord_Embed_Discord_RequestOptions_System_Boolean__remarks">Remarks</h5>
|
||||
<div class="markdown level1 remarks"><p>This method follows the same behavior as described in
|
||||
<a class="xref" href="Discord.IMessageChannel.html#Discord_IMessageChannel_SendFileAsync_System_String_System_String_System_Boolean_Discord_Embed_Discord_RequestOptions_System_Boolean_">SendFileAsync(String, String, Boolean, Embed, RequestOptions, Boolean)</a>. Please visit
|
||||
its documentation for more details on this method.</p>
|
||||
</div>
|
||||
<h5 class="exceptions">Exceptions</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
|
|
@ -980,7 +1069,8 @@ characters.</p>
|
|||
</span>
|
||||
<a id="Discord_Rest_RestGroupChannel_SendMessageAsync_" data-uid="Discord.Rest.RestGroupChannel.SendMessageAsync*"></a>
|
||||
<h4 id="Discord_Rest_RestGroupChannel_SendMessageAsync_System_String_System_Boolean_Discord_Embed_Discord_RequestOptions_" data-uid="Discord.Rest.RestGroupChannel.SendMessageAsync(System.String,System.Boolean,Discord.Embed,Discord.RequestOptions)">SendMessageAsync(String, Boolean, Embed, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Sends a message to this message channel.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -999,22 +1089,26 @@ characters.</p>
|
|||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td><span class="parametername">text</span></td>
|
||||
<td></td>
|
||||
<td><p>The message to be sent.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td><span class="parametername">isTTS</span></td>
|
||||
<td></td>
|
||||
<td><p>Determines whether the message should be read aloud by Discord or not.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.Embed.html">Embed</a></td>
|
||||
<td><span class="parametername">embed</span></td>
|
||||
<td></td>
|
||||
<td><p>The <a class="xref" href="Discord.EmbedType.html#Discord_EmbedType_Rich">Rich</a> <a class="xref" href="Discord.Embed.html">Embed</a> to be sent.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1029,10 +1123,16 @@ characters.</p>
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span><<a class="xref" href="Discord.Rest.RestUserMessage.html">RestUserMessage</a>></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents an asynchronous send operation for delivering the message. The task result
|
||||
contains the sent message.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 id="Discord_Rest_RestGroupChannel_SendMessageAsync_System_String_System_Boolean_Discord_Embed_Discord_RequestOptions__remarks">Remarks</h5>
|
||||
<div class="markdown level1 remarks"><p>This method follows the same behavior as described in <a class="xref" href="Discord.IMessageChannel.html#Discord_IMessageChannel_SendMessageAsync_System_String_System_Boolean_Discord_Embed_Discord_RequestOptions_">SendMessageAsync(String, Boolean, Embed, RequestOptions)</a>.
|
||||
Please visit its documentation for more details on this method.</p>
|
||||
</div>
|
||||
<h5 class="exceptions">Exceptions</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
|
|
@ -1090,7 +1190,8 @@ characters.</p>
|
|||
</span>
|
||||
<a id="Discord_Rest_RestGroupChannel_TriggerTypingAsync_" data-uid="Discord.Rest.RestGroupChannel.TriggerTypingAsync*"></a>
|
||||
<h4 id="Discord_Rest_RestGroupChannel_TriggerTypingAsync_Discord_RequestOptions_" data-uid="Discord.Rest.RestGroupChannel.TriggerTypingAsync(Discord.RequestOptions)">TriggerTypingAsync(RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Broadcasts the "user is typing" message to all users in this channel, lasting 10 seconds.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1109,7 +1210,8 @@ characters.</p>
|
|||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1124,7 +1226,8 @@ characters.</p>
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous operation that triggers the broadcast.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1137,7 +1240,8 @@ characters.</p>
|
|||
</span>
|
||||
<a id="Discord_Rest_RestGroupChannel_UpdateAsync_" data-uid="Discord.Rest.RestGroupChannel.UpdateAsync*"></a>
|
||||
<h4 id="Discord_Rest_RestGroupChannel_UpdateAsync_Discord_RequestOptions_" data-uid="Discord.Rest.RestGroupChannel.UpdateAsync(Discord.RequestOptions)">UpdateAsync(RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Updates this object's properties with its current state.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1188,7 +1292,8 @@ characters.</p>
|
|||
</span>
|
||||
<a id="Discord_Rest_RestGroupChannel_Discord_IAudioChannel_ConnectAsync_" data-uid="Discord.Rest.RestGroupChannel.Discord#IAudioChannel#ConnectAsync*"></a>
|
||||
<h4 id="Discord_Rest_RestGroupChannel_Discord_IAudioChannel_ConnectAsync_System_Boolean_System_Boolean_System_Boolean_" data-uid="Discord.Rest.RestGroupChannel.Discord#IAudioChannel#ConnectAsync(System.Boolean,System.Boolean,System.Boolean)">IAudioChannel.ConnectAsync(Boolean, Boolean, Boolean)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Connects to this audio channel.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1207,17 +1312,20 @@ characters.</p>
|
|||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td><span class="parametername">selfDeaf</span></td>
|
||||
<td></td>
|
||||
<td><p>Determines whether the client should deaf itself upon connection.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td><span class="parametername">selfMute</span></td>
|
||||
<td></td>
|
||||
<td><p>Determines whether the client should mute itself upon connection.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td><span class="parametername">external</span></td>
|
||||
<td></td>
|
||||
<td><p>Determines whether the audio client is an external one or not.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1232,7 +1340,9 @@ characters.</p>
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span><<a class="xref" href="Discord.Audio.IAudioClient.html">IAudioClient</a>></td>
|
||||
<td></td>
|
||||
<td><p>A task representing the asynchronous connection operation. The task result contains the
|
||||
<a class="xref" href="Discord.Audio.IAudioClient.html">IAudioClient</a> responsible for the connection.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
|
|||
|
|
@ -186,7 +186,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestGroupUser_Discord_IVoiceState_IsDeafened_" data-uid="Discord.Rest.RestGroupUser.Discord#IVoiceState#IsDeafened*"></a>
|
||||
<h4 id="Discord_Rest_RestGroupUser_Discord_IVoiceState_IsDeafened" data-uid="Discord.Rest.RestGroupUser.Discord#IVoiceState#IsDeafened">IVoiceState.IsDeafened</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a value that indicates whether this user is deafened by the guild.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -203,7 +204,9 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td></td>
|
||||
<td><p><code>true</code> if the user is deafened (i.e. not permitted to listen to or speak to others) by the guild;
|
||||
otherwise <code>false</code>.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -216,7 +219,9 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestGroupUser_Discord_IVoiceState_IsMuted_" data-uid="Discord.Rest.RestGroupUser.Discord#IVoiceState#IsMuted*"></a>
|
||||
<h4 id="Discord_Rest_RestGroupUser_Discord_IVoiceState_IsMuted" data-uid="Discord.Rest.RestGroupUser.Discord#IVoiceState#IsMuted">IVoiceState.IsMuted</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a value that indicates whether this user is muted (i.e. not permitted to speak via voice) by the
|
||||
guild.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -233,7 +238,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td></td>
|
||||
<td><p><code>true</code> if this user is muted by the guild; otherwise <code>false</code>.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -246,7 +252,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestGroupUser_Discord_IVoiceState_IsSelfDeafened_" data-uid="Discord.Rest.RestGroupUser.Discord#IVoiceState#IsSelfDeafened*"></a>
|
||||
<h4 id="Discord_Rest_RestGroupUser_Discord_IVoiceState_IsSelfDeafened" data-uid="Discord.Rest.RestGroupUser.Discord#IVoiceState#IsSelfDeafened">IVoiceState.IsSelfDeafened</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a value that indicates whether this user has marked themselves as deafened.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -263,7 +270,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td></td>
|
||||
<td><p><code>true</code> if this user has deafened themselves (i.e. not permitted to listen to or speak to others); otherwise <code>false</code>.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -276,7 +284,9 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestGroupUser_Discord_IVoiceState_IsSelfMuted_" data-uid="Discord.Rest.RestGroupUser.Discord#IVoiceState#IsSelfMuted*"></a>
|
||||
<h4 id="Discord_Rest_RestGroupUser_Discord_IVoiceState_IsSelfMuted" data-uid="Discord.Rest.RestGroupUser.Discord#IVoiceState#IsSelfMuted">IVoiceState.IsSelfMuted</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a value that indicates whether this user has marked themselves as muted (i.e. not permitted to
|
||||
speak via voice).</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -293,7 +303,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td></td>
|
||||
<td><p><code>true</code> if this user has muted themselves; otherwise <code>false</code>.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -306,7 +317,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestGroupUser_Discord_IVoiceState_IsStreaming_" data-uid="Discord.Rest.RestGroupUser.Discord#IVoiceState#IsStreaming*"></a>
|
||||
<h4 id="Discord_Rest_RestGroupUser_Discord_IVoiceState_IsStreaming" data-uid="Discord.Rest.RestGroupUser.Discord#IVoiceState#IsStreaming">IVoiceState.IsStreaming</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a value that indicates if this user is streaming in a voice channel.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -323,7 +335,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td></td>
|
||||
<td><p><code>true</code> if the user is streaming; otherwise <code>false</code>.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -336,7 +349,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestGroupUser_Discord_IVoiceState_IsSuppressed_" data-uid="Discord.Rest.RestGroupUser.Discord#IVoiceState#IsSuppressed*"></a>
|
||||
<h4 id="Discord_Rest_RestGroupUser_Discord_IVoiceState_IsSuppressed" data-uid="Discord.Rest.RestGroupUser.Discord#IVoiceState#IsSuppressed">IVoiceState.IsSuppressed</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a value that indicates whether the user is muted by the current user.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -353,7 +367,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td></td>
|
||||
<td><p><code>true</code> if the guild is temporarily blocking audio to/from this user; otherwise <code>false</code>.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -366,7 +381,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestGroupUser_Discord_IVoiceState_VoiceChannel_" data-uid="Discord.Rest.RestGroupUser.Discord#IVoiceState#VoiceChannel*"></a>
|
||||
<h4 id="Discord_Rest_RestGroupUser_Discord_IVoiceState_VoiceChannel" data-uid="Discord.Rest.RestGroupUser.Discord#IVoiceState#VoiceChannel">IVoiceState.VoiceChannel</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the voice channel this user is currently in.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -383,7 +399,9 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.IVoiceChannel.html">IVoiceChannel</a></td>
|
||||
<td></td>
|
||||
<td><p>A generic voice channel object representing the voice channel that the user is currently in; <code>null</code>
|
||||
if none.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -396,7 +414,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestGroupUser_Discord_IVoiceState_VoiceSessionId_" data-uid="Discord.Rest.RestGroupUser.Discord#IVoiceState#VoiceSessionId*"></a>
|
||||
<h4 id="Discord_Rest_RestGroupUser_Discord_IVoiceState_VoiceSessionId" data-uid="Discord.Rest.RestGroupUser.Discord#IVoiceState#VoiceSessionId">IVoiceState.VoiceSessionId</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the unique identifier for this user's voice session.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
|
|||
File diff suppressed because it is too large
Load diff
|
|
@ -142,7 +142,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestGuildChannel_GuildId_" data-uid="Discord.Rest.RestGuildChannel.GuildId*"></a>
|
||||
<h4 id="Discord_Rest_RestGuildChannel_GuildId" data-uid="Discord.Rest.RestGuildChannel.GuildId">GuildId</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the guild ID associated with this channel.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -159,7 +160,9 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.UInt64</span></td>
|
||||
<td></td>
|
||||
<td><p>An <span class="xref">System.UInt64</span> representing the guild snowflake identifier for the guild that this channel
|
||||
belongs to.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -172,7 +175,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestGuildChannel_Name_" data-uid="Discord.Rest.RestGuildChannel.Name*"></a>
|
||||
<h4 id="Discord_Rest_RestGuildChannel_Name" data-uid="Discord.Rest.RestGuildChannel.Name">Name</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the name of this channel.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -189,7 +193,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td></td>
|
||||
<td><p>A string containing the name of this channel.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -202,7 +207,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestGuildChannel_PermissionOverwrites_" data-uid="Discord.Rest.RestGuildChannel.PermissionOverwrites*"></a>
|
||||
<h4 id="Discord_Rest_RestGuildChannel_PermissionOverwrites" data-uid="Discord.Rest.RestGuildChannel.PermissionOverwrites">PermissionOverwrites</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a collection of permission overwrites for this channel.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -219,7 +225,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Collections.Generic.IReadOnlyCollection</span><<a class="xref" href="Discord.Overwrite.html">Overwrite</a>></td>
|
||||
<td></td>
|
||||
<td><p>A collection of overwrites associated with this channel.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -232,7 +239,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestGuildChannel_Position_" data-uid="Discord.Rest.RestGuildChannel.Position*"></a>
|
||||
<h4 id="Discord_Rest_RestGuildChannel_Position" data-uid="Discord.Rest.RestGuildChannel.Position">Position</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the position of this channel.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -249,7 +257,9 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Int32</span></td>
|
||||
<td></td>
|
||||
<td><p>An <span class="xref">System.Int32</span> representing the position of this channel in the guild's channel list relative to
|
||||
others of the same type.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -388,7 +398,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestGuildChannel_DeleteAsync_" data-uid="Discord.Rest.RestGuildChannel.DeleteAsync*"></a>
|
||||
<h4 id="Discord_Rest_RestGuildChannel_DeleteAsync_Discord_RequestOptions_" data-uid="Discord.Rest.RestGuildChannel.DeleteAsync(Discord.RequestOptions)">DeleteAsync(RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Deletes this object and all its children.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -407,7 +418,8 @@
|
|||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -535,7 +547,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestGuildChannel_ModifyAsync_" data-uid="Discord.Rest.RestGuildChannel.ModifyAsync*"></a>
|
||||
<h4 id="Discord_Rest_RestGuildChannel_ModifyAsync_System_Action_Discord_GuildChannelProperties__Discord_RequestOptions_" data-uid="Discord.Rest.RestGuildChannel.ModifyAsync(System.Action{Discord.GuildChannelProperties},Discord.RequestOptions)">ModifyAsync(Action<GuildChannelProperties>, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Modifies this guild channel.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -554,12 +567,14 @@
|
|||
<tr>
|
||||
<td><span class="xref">System.Action</span><<a class="xref" href="Discord.GuildChannelProperties.html">GuildChannelProperties</a>></td>
|
||||
<td><span class="parametername">func</span></td>
|
||||
<td></td>
|
||||
<td><p>The delegate containing the properties to modify the channel with.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -574,10 +589,15 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous modification operation.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 id="Discord_Rest_RestGuildChannel_ModifyAsync_System_Action_Discord_GuildChannelProperties__Discord_RequestOptions__remarks">Remarks</h5>
|
||||
<div class="markdown level1 remarks"><p>This method modifies the current guild channel with the specified properties. To see an example of this
|
||||
method and what properties are available, please refer to <a class="xref" href="Discord.GuildChannelProperties.html">GuildChannelProperties</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_RestGuildChannel_RemovePermissionOverwriteAsync_Discord_IRole_Discord_RequestOptions_.md&value=---%0Auid%3A%20Discord.Rest.RestGuildChannel.RemovePermissionOverwriteAsync(Discord.IRole%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>
|
||||
|
|
@ -733,7 +753,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestGuildChannel_UpdateAsync_" data-uid="Discord.Rest.RestGuildChannel.UpdateAsync*"></a>
|
||||
<h4 id="Discord_Rest_RestGuildChannel_UpdateAsync_Discord_RequestOptions_" data-uid="Discord.Rest.RestGuildChannel.UpdateAsync(Discord.RequestOptions)">UpdateAsync(RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Updates this object's properties with its current state.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -784,7 +805,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestGuildChannel_Discord_IChannel_GetUserAsync_" data-uid="Discord.Rest.RestGuildChannel.Discord#IChannel#GetUserAsync*"></a>
|
||||
<h4 id="Discord_Rest_RestGuildChannel_Discord_IChannel_GetUserAsync_System_UInt64_Discord_CacheMode_Discord_RequestOptions_" data-uid="Discord.Rest.RestGuildChannel.Discord#IChannel#GetUserAsync(System.UInt64,Discord.CacheMode,Discord.RequestOptions)">IChannel.GetUserAsync(UInt64, CacheMode, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a user in this channel.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -803,17 +825,20 @@
|
|||
<tr>
|
||||
<td><span class="xref">System.UInt64</span></td>
|
||||
<td><span class="parametername">id</span></td>
|
||||
<td></td>
|
||||
<td><p>The snowflake identifier of the user (e.g. <code>168693960628371456</code>).</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.CacheMode.html">CacheMode</a></td>
|
||||
<td><span class="parametername">mode</span></td>
|
||||
<td></td>
|
||||
<td><p>The <a class="xref" href="Discord.CacheMode.html">CacheMode</a> that determines whether the object should be fetched from cache.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -828,7 +853,9 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span><<a class="xref" href="Discord.IUser.html">IUser</a>></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous get operation. The task result contains a user object that
|
||||
represents the found user; <code>null</code> if none is found.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -841,7 +868,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestGuildChannel_Discord_IChannel_GetUsersAsync_" data-uid="Discord.Rest.RestGuildChannel.Discord#IChannel#GetUsersAsync*"></a>
|
||||
<h4 id="Discord_Rest_RestGuildChannel_Discord_IChannel_GetUsersAsync_Discord_CacheMode_Discord_RequestOptions_" data-uid="Discord.Rest.RestGuildChannel.Discord#IChannel#GetUsersAsync(Discord.CacheMode,Discord.RequestOptions)">IChannel.GetUsersAsync(CacheMode, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a collection of users that are able to view the channel or are currently in this channel.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -860,12 +888,14 @@
|
|||
<tr>
|
||||
<td><a class="xref" href="Discord.CacheMode.html">CacheMode</a></td>
|
||||
<td><span class="parametername">mode</span></td>
|
||||
<td></td>
|
||||
<td><p>The <a class="xref" href="Discord.CacheMode.html">CacheMode</a> that determines whether the object should be fetched from cache.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -880,10 +910,23 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Collections.Generic.IAsyncEnumerable</span><<span class="xref">System.Collections.Generic.IReadOnlyCollection</span><<a class="xref" href="Discord.IUser.html">IUser</a>>></td>
|
||||
<td></td>
|
||||
<td><p>Paged collection of users.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 id="Discord_Rest_RestGuildChannel_Discord_IChannel_GetUsersAsync_Discord_CacheMode_Discord_RequestOptions__remarks">Remarks</h5>
|
||||
<div class="markdown level1 remarks"><div class="IMPORTANT"><h5>important</h5><p>
|
||||
The returned collection is an asynchronous enumerable object; one must call
|
||||
<a class="xref" href="Discord.AsyncEnumerableExtensions.html#Discord_AsyncEnumerableExtensions_FlattenAsync__1_System_Collections_Generic_IAsyncEnumerable_System_Collections_Generic_IEnumerable___0___">FlattenAsync<T>(IAsyncEnumerable<IEnumerable<T>>)</a> to access the individual messages as a
|
||||
collection.
|
||||
</p></div>
|
||||
This method will attempt to fetch all users that is able to view this channel or is currently in this channel.
|
||||
The library will attempt to split up the requests according to and <a class="xref" href="Discord.DiscordConfig.html#Discord_DiscordConfig_MaxUsersPerBatch">MaxUsersPerBatch</a>.
|
||||
In other words, if there are 3000 users, and the <a class="xref" href="Discord.DiscordConfig.html#Discord_DiscordConfig_MaxUsersPerBatch">MaxUsersPerBatch</a> constant
|
||||
is <code>1000</code>, the request will be split into 3 individual requests; thus returning 53individual asynchronous
|
||||
responses, hence the need of flattening.
|
||||
</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_RestGuildChannel_Discord_IGuildChannel_AddPermissionOverwriteAsync_Discord_IRole_Discord_OverwritePermissions_Discord_RequestOptions_.md&value=---%0Auid%3A%20Discord.Rest.RestGuildChannel.Discord%23IGuildChannel%23AddPermissionOverwriteAsync(Discord.IRole%2CDiscord.OverwritePermissions%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>
|
||||
|
|
@ -893,7 +936,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestGuildChannel_Discord_IGuildChannel_AddPermissionOverwriteAsync_" data-uid="Discord.Rest.RestGuildChannel.Discord#IGuildChannel#AddPermissionOverwriteAsync*"></a>
|
||||
<h4 id="Discord_Rest_RestGuildChannel_Discord_IGuildChannel_AddPermissionOverwriteAsync_Discord_IRole_Discord_OverwritePermissions_Discord_RequestOptions_" data-uid="Discord.Rest.RestGuildChannel.Discord#IGuildChannel#AddPermissionOverwriteAsync(Discord.IRole,Discord.OverwritePermissions,Discord.RequestOptions)">IGuildChannel.AddPermissionOverwriteAsync(IRole, OverwritePermissions, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Adds or updates the permission overwrite for the given role.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -912,17 +956,20 @@
|
|||
<tr>
|
||||
<td><a class="xref" href="Discord.IRole.html">IRole</a></td>
|
||||
<td><span class="parametername">role</span></td>
|
||||
<td></td>
|
||||
<td><p>The role to add the overwrite to.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.OverwritePermissions.html">OverwritePermissions</a></td>
|
||||
<td><span class="parametername">permissions</span></td>
|
||||
<td></td>
|
||||
<td><p>The overwrite to add to the role.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -937,7 +984,9 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
||||
<td></td>
|
||||
<td><p>A task representing the asynchronous permission operation for adding the specified permissions to the
|
||||
channel.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -950,7 +999,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestGuildChannel_Discord_IGuildChannel_AddPermissionOverwriteAsync_" data-uid="Discord.Rest.RestGuildChannel.Discord#IGuildChannel#AddPermissionOverwriteAsync*"></a>
|
||||
<h4 id="Discord_Rest_RestGuildChannel_Discord_IGuildChannel_AddPermissionOverwriteAsync_Discord_IUser_Discord_OverwritePermissions_Discord_RequestOptions_" data-uid="Discord.Rest.RestGuildChannel.Discord#IGuildChannel#AddPermissionOverwriteAsync(Discord.IUser,Discord.OverwritePermissions,Discord.RequestOptions)">IGuildChannel.AddPermissionOverwriteAsync(IUser, OverwritePermissions, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Adds or updates the permission overwrite for the given user.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -969,17 +1019,20 @@
|
|||
<tr>
|
||||
<td><a class="xref" href="Discord.IUser.html">IUser</a></td>
|
||||
<td><span class="parametername">user</span></td>
|
||||
<td></td>
|
||||
<td><p>The user to add the overwrite to.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.OverwritePermissions.html">OverwritePermissions</a></td>
|
||||
<td><span class="parametername">permissions</span></td>
|
||||
<td></td>
|
||||
<td><p>The overwrite to add to the user.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -994,7 +1047,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
||||
<td></td>
|
||||
<td><p>A task representing the asynchronous permission operation for adding the specified permissions to the channel.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1007,7 +1061,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestGuildChannel_Discord_IGuildChannel_GetPermissionOverwrite_" data-uid="Discord.Rest.RestGuildChannel.Discord#IGuildChannel#GetPermissionOverwrite*"></a>
|
||||
<h4 id="Discord_Rest_RestGuildChannel_Discord_IGuildChannel_GetPermissionOverwrite_Discord_IRole_" data-uid="Discord.Rest.RestGuildChannel.Discord#IGuildChannel#GetPermissionOverwrite(Discord.IRole)">IGuildChannel.GetPermissionOverwrite(IRole)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the permission overwrite for a specific role.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1026,7 +1081,8 @@
|
|||
<tr>
|
||||
<td><a class="xref" href="Discord.IRole.html">IRole</a></td>
|
||||
<td><span class="parametername">role</span></td>
|
||||
<td></td>
|
||||
<td><p>The role to get the overwrite from.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1041,7 +1097,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Nullable</span><<a class="xref" href="Discord.OverwritePermissions.html">OverwritePermissions</a>></td>
|
||||
<td></td>
|
||||
<td><p>An overwrite object for the targeted role; <code>null</code> if none is set.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1054,7 +1111,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestGuildChannel_Discord_IGuildChannel_GetPermissionOverwrite_" data-uid="Discord.Rest.RestGuildChannel.Discord#IGuildChannel#GetPermissionOverwrite*"></a>
|
||||
<h4 id="Discord_Rest_RestGuildChannel_Discord_IGuildChannel_GetPermissionOverwrite_Discord_IUser_" data-uid="Discord.Rest.RestGuildChannel.Discord#IGuildChannel#GetPermissionOverwrite(Discord.IUser)">IGuildChannel.GetPermissionOverwrite(IUser)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the permission overwrite for a specific user.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1073,7 +1131,8 @@
|
|||
<tr>
|
||||
<td><a class="xref" href="Discord.IUser.html">IUser</a></td>
|
||||
<td><span class="parametername">user</span></td>
|
||||
<td></td>
|
||||
<td><p>The user to get the overwrite from.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1088,7 +1147,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Nullable</span><<a class="xref" href="Discord.OverwritePermissions.html">OverwritePermissions</a>></td>
|
||||
<td></td>
|
||||
<td><p>An overwrite object for the targeted user; <code>null</code> if none is set.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1101,7 +1161,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestGuildChannel_Discord_IGuildChannel_GetUserAsync_" data-uid="Discord.Rest.RestGuildChannel.Discord#IGuildChannel#GetUserAsync*"></a>
|
||||
<h4 id="Discord_Rest_RestGuildChannel_Discord_IGuildChannel_GetUserAsync_System_UInt64_Discord_CacheMode_Discord_RequestOptions_" data-uid="Discord.Rest.RestGuildChannel.Discord#IGuildChannel#GetUserAsync(System.UInt64,Discord.CacheMode,Discord.RequestOptions)">IGuildChannel.GetUserAsync(UInt64, CacheMode, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a user in this channel.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1120,17 +1181,20 @@
|
|||
<tr>
|
||||
<td><span class="xref">System.UInt64</span></td>
|
||||
<td><span class="parametername">id</span></td>
|
||||
<td></td>
|
||||
<td><p>The snowflake identifier of the user.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.CacheMode.html">CacheMode</a></td>
|
||||
<td><span class="parametername">mode</span></td>
|
||||
<td></td>
|
||||
<td><p>The <a class="xref" href="Discord.CacheMode.html">CacheMode</a> that determines whether the object should be fetched from cache.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1145,7 +1209,9 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span><<a class="xref" href="Discord.IGuildUser.html">IGuildUser</a>></td>
|
||||
<td></td>
|
||||
<td><p>A task representing the asynchronous get operation. The task result contains a guild user object that
|
||||
represents the user; <code>null</code> if none is found.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1158,7 +1224,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestGuildChannel_Discord_IGuildChannel_GetUsersAsync_" data-uid="Discord.Rest.RestGuildChannel.Discord#IGuildChannel#GetUsersAsync*"></a>
|
||||
<h4 id="Discord_Rest_RestGuildChannel_Discord_IGuildChannel_GetUsersAsync_Discord_CacheMode_Discord_RequestOptions_" data-uid="Discord.Rest.RestGuildChannel.Discord#IGuildChannel#GetUsersAsync(Discord.CacheMode,Discord.RequestOptions)">IGuildChannel.GetUsersAsync(CacheMode, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a collection of users that are able to view the channel or are currently in this channel.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1177,12 +1244,14 @@
|
|||
<tr>
|
||||
<td><a class="xref" href="Discord.CacheMode.html">CacheMode</a></td>
|
||||
<td><span class="parametername">mode</span></td>
|
||||
<td></td>
|
||||
<td><p>The <a class="xref" href="Discord.CacheMode.html">CacheMode</a> that determines whether the object should be fetched from cache.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1197,10 +1266,15 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Collections.Generic.IAsyncEnumerable</span><<span class="xref">System.Collections.Generic.IReadOnlyCollection</span><<a class="xref" href="Discord.IGuildUser.html">IGuildUser</a>>></td>
|
||||
<td></td>
|
||||
<td><p>Paged collection of users.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 id="Discord_Rest_RestGuildChannel_Discord_IGuildChannel_GetUsersAsync_Discord_CacheMode_Discord_RequestOptions__remarks">Remarks</h5>
|
||||
<div class="markdown level1 remarks"><p>This method follows the same behavior as described in <a class="xref" href="Discord.IChannel.html#Discord_IChannel_GetUsersAsync_Discord_CacheMode_Discord_RequestOptions_">GetUsersAsync(CacheMode, RequestOptions)</a>.
|
||||
Please visit its documentation for more details on this method.</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_RestGuildChannel_Discord_IGuildChannel_Guild.md&value=---%0Auid%3A%20Discord.Rest.RestGuildChannel.Discord%23IGuildChannel%23Guild%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>
|
||||
|
|
@ -1210,7 +1284,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestGuildChannel_Discord_IGuildChannel_Guild_" data-uid="Discord.Rest.RestGuildChannel.Discord#IGuildChannel#Guild*"></a>
|
||||
<h4 id="Discord_Rest_RestGuildChannel_Discord_IGuildChannel_Guild" data-uid="Discord.Rest.RestGuildChannel.Discord#IGuildChannel#Guild">IGuildChannel.Guild</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the guild associated with this channel.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1227,7 +1302,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.IGuild.html">IGuild</a></td>
|
||||
<td></td>
|
||||
<td><p>A guild object that this channel belongs to.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1240,7 +1316,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestGuildChannel_Discord_IGuildChannel_RemovePermissionOverwriteAsync_" data-uid="Discord.Rest.RestGuildChannel.Discord#IGuildChannel#RemovePermissionOverwriteAsync*"></a>
|
||||
<h4 id="Discord_Rest_RestGuildChannel_Discord_IGuildChannel_RemovePermissionOverwriteAsync_Discord_IRole_Discord_RequestOptions_" data-uid="Discord.Rest.RestGuildChannel.Discord#IGuildChannel#RemovePermissionOverwriteAsync(Discord.IRole,Discord.RequestOptions)">IGuildChannel.RemovePermissionOverwriteAsync(IRole, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Removes the permission overwrite for the given role, if one exists.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1259,12 +1336,14 @@
|
|||
<tr>
|
||||
<td><a class="xref" href="Discord.IRole.html">IRole</a></td>
|
||||
<td><span class="parametername">role</span></td>
|
||||
<td></td>
|
||||
<td><p>The role to remove the overwrite from.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1279,7 +1358,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
||||
<td></td>
|
||||
<td><p>A task representing the asynchronous operation for removing the specified permissions from the channel.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1292,7 +1372,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestGuildChannel_Discord_IGuildChannel_RemovePermissionOverwriteAsync_" data-uid="Discord.Rest.RestGuildChannel.Discord#IGuildChannel#RemovePermissionOverwriteAsync*"></a>
|
||||
<h4 id="Discord_Rest_RestGuildChannel_Discord_IGuildChannel_RemovePermissionOverwriteAsync_Discord_IUser_Discord_RequestOptions_" data-uid="Discord.Rest.RestGuildChannel.Discord#IGuildChannel#RemovePermissionOverwriteAsync(Discord.IUser,Discord.RequestOptions)">IGuildChannel.RemovePermissionOverwriteAsync(IUser, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Removes the permission overwrite for the given user, if one exists.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1311,12 +1392,14 @@
|
|||
<tr>
|
||||
<td><a class="xref" href="Discord.IUser.html">IUser</a></td>
|
||||
<td><span class="parametername">user</span></td>
|
||||
<td></td>
|
||||
<td><p>The user to remove the overwrite from.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1331,7 +1414,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
||||
<td></td>
|
||||
<td><p>A task representing the asynchronous operation for removing the specified permissions from the channel.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
|
|||
|
|
@ -127,7 +127,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestGuildIntegration_Account_" data-uid="Discord.Rest.RestGuildIntegration.Account*"></a>
|
||||
<h4 id="Discord_Rest_RestGuildIntegration_Account" data-uid="Discord.Rest.RestGuildIntegration.Account">Account</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets integration account information.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -157,7 +158,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestGuildIntegration_ExpireBehavior_" data-uid="Discord.Rest.RestGuildIntegration.ExpireBehavior*"></a>
|
||||
<h4 id="Discord_Rest_RestGuildIntegration_ExpireBehavior" data-uid="Discord.Rest.RestGuildIntegration.ExpireBehavior">ExpireBehavior</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the ID that this integration uses for "subscribers".</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -187,7 +189,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestGuildIntegration_ExpireGracePeriod_" data-uid="Discord.Rest.RestGuildIntegration.ExpireGracePeriod*"></a>
|
||||
<h4 id="Discord_Rest_RestGuildIntegration_ExpireGracePeriod" data-uid="Discord.Rest.RestGuildIntegration.ExpireGracePeriod">ExpireGracePeriod</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the grace period before expiring "subscribers".</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -247,7 +250,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestGuildIntegration_IsEnabled_" data-uid="Discord.Rest.RestGuildIntegration.IsEnabled*"></a>
|
||||
<h4 id="Discord_Rest_RestGuildIntegration_IsEnabled" data-uid="Discord.Rest.RestGuildIntegration.IsEnabled">IsEnabled</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a value that indicates whether this integration is enabled or not.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -264,7 +268,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td></td>
|
||||
<td><p><code>true</code> if this integration is enabled; otherwise <code>false</code>.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -277,7 +282,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestGuildIntegration_IsSyncing_" data-uid="Discord.Rest.RestGuildIntegration.IsSyncing*"></a>
|
||||
<h4 id="Discord_Rest_RestGuildIntegration_IsSyncing" data-uid="Discord.Rest.RestGuildIntegration.IsSyncing">IsSyncing</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a value that indicates whether this integration is syncing or not.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -294,10 +300,15 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td></td>
|
||||
<td><p><code>true</code> if this integration is syncing; otherwise <code>false</code>.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 id="Discord_Rest_RestGuildIntegration_IsSyncing_remarks">Remarks</h5>
|
||||
<div class="markdown level1 remarks"><p>An integration with syncing enabled will update its "subscribers" on an interval, while one with syncing
|
||||
disabled will not. A user must manually choose when sync the integration if syncing is disabled.</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_RestGuildIntegration_Name.md&value=---%0Auid%3A%20Discord.Rest.RestGuildIntegration.Name%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>
|
||||
|
|
@ -307,7 +318,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestGuildIntegration_Name_" data-uid="Discord.Rest.RestGuildIntegration.Name*"></a>
|
||||
<h4 id="Discord_Rest_RestGuildIntegration_Name" data-uid="Discord.Rest.RestGuildIntegration.Name">Name</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the integration name.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -324,7 +336,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td></td>
|
||||
<td><p>A string containing the name of this integration.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -367,7 +380,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestGuildIntegration_SyncedAt_" data-uid="Discord.Rest.RestGuildIntegration.SyncedAt*"></a>
|
||||
<h4 id="Discord_Rest_RestGuildIntegration_SyncedAt" data-uid="Discord.Rest.RestGuildIntegration.SyncedAt">SyncedAt</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets when this integration was last synced.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -384,7 +398,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.DateTimeOffset</span></td>
|
||||
<td></td>
|
||||
<td><p>A <span class="xref">System.DateTimeOffset</span> containing a date and time of day when the integration was last synced.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -397,7 +412,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestGuildIntegration_Type_" data-uid="Discord.Rest.RestGuildIntegration.Type*"></a>
|
||||
<h4 id="Discord_Rest_RestGuildIntegration_Type" data-uid="Discord.Rest.RestGuildIntegration.Type">Type</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the integration type (Twitch, YouTube, etc).</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -414,7 +430,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td></td>
|
||||
<td><p>A string containing the name of the type of integration.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
|
|||
|
|
@ -183,7 +183,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestGuildUser_GuildId_" data-uid="Discord.Rest.RestGuildUser.GuildId*"></a>
|
||||
<h4 id="Discord_Rest_RestGuildUser_GuildId" data-uid="Discord.Rest.RestGuildUser.GuildId">GuildId</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the ID of the guild for this user.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -200,7 +201,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.UInt64</span></td>
|
||||
<td></td>
|
||||
<td><p>An <span class="xref">System.UInt64</span> representing the snowflake identifier of the guild that this user belongs to.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -213,7 +215,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestGuildUser_GuildPermissions_" data-uid="Discord.Rest.RestGuildUser.GuildPermissions*"></a>
|
||||
<h4 id="Discord_Rest_RestGuildUser_GuildPermissions" data-uid="Discord.Rest.RestGuildUser.GuildPermissions">GuildPermissions</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the guild-level permissions for this user.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -230,7 +233,9 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.GuildPermissions.html">GuildPermissions</a></td>
|
||||
<td></td>
|
||||
<td><p>A <a class="xref" href="Discord.GuildPermissions.html">GuildPermissions</a> structure for this user, representing what
|
||||
permissions this user has in the guild.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -259,7 +264,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestGuildUser_IsDeafened_" data-uid="Discord.Rest.RestGuildUser.IsDeafened*"></a>
|
||||
<h4 id="Discord_Rest_RestGuildUser_IsDeafened" data-uid="Discord.Rest.RestGuildUser.IsDeafened">IsDeafened</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a value that indicates whether this user is deafened by the guild.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -276,7 +282,9 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td></td>
|
||||
<td><p><code>true</code> if the user is deafened (i.e. not permitted to listen to or speak to others) by the guild;
|
||||
otherwise <code>false</code>.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -289,7 +297,9 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestGuildUser_IsMuted_" data-uid="Discord.Rest.RestGuildUser.IsMuted*"></a>
|
||||
<h4 id="Discord_Rest_RestGuildUser_IsMuted" data-uid="Discord.Rest.RestGuildUser.IsMuted">IsMuted</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a value that indicates whether this user is muted (i.e. not permitted to speak via voice) by the
|
||||
guild.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -306,7 +316,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td></td>
|
||||
<td><p><code>true</code> if this user is muted by the guild; otherwise <code>false</code>.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -319,7 +330,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestGuildUser_JoinedAt_" data-uid="Discord.Rest.RestGuildUser.JoinedAt*"></a>
|
||||
<h4 id="Discord_Rest_RestGuildUser_JoinedAt" data-uid="Discord.Rest.RestGuildUser.JoinedAt">JoinedAt</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets when this user joined the guild.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -336,7 +348,9 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Nullable</span><<span class="xref">System.DateTimeOffset</span>></td>
|
||||
<td></td>
|
||||
<td><p>A <span class="xref">System.DateTimeOffset</span> representing the time of which the user has joined the guild;
|
||||
<code>null</code> when it cannot be obtained.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -349,7 +363,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestGuildUser_Nickname_" data-uid="Discord.Rest.RestGuildUser.Nickname*"></a>
|
||||
<h4 id="Discord_Rest_RestGuildUser_Nickname" data-uid="Discord.Rest.RestGuildUser.Nickname">Nickname</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the nickname for this user.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -366,7 +381,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td></td>
|
||||
<td><p>A string representing the nickname of the user; <code>null</code> if none is set.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -379,7 +395,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestGuildUser_PremiumSince_" data-uid="Discord.Rest.RestGuildUser.PremiumSince*"></a>
|
||||
<h4 id="Discord_Rest_RestGuildUser_PremiumSince" data-uid="Discord.Rest.RestGuildUser.PremiumSince">PremiumSince</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the date and time for when this user's guild boost began.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -396,7 +413,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Nullable</span><<span class="xref">System.DateTimeOffset</span>></td>
|
||||
<td></td>
|
||||
<td><p>A <span class="xref">System.DateTimeOffset</span> for when the user began boosting this guild; <code>null</code> if they are not boosting the guild.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -409,7 +427,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestGuildUser_RoleIds_" data-uid="Discord.Rest.RestGuildUser.RoleIds*"></a>
|
||||
<h4 id="Discord_Rest_RestGuildUser_RoleIds" data-uid="Discord.Rest.RestGuildUser.RoleIds">RoleIds</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a collection of IDs for the roles that this user currently possesses in the guild.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -426,10 +445,17 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Collections.Generic.IReadOnlyCollection</span><<span class="xref">System.UInt64</span>></td>
|
||||
<td></td>
|
||||
<td><p>A read-only collection of <span class="xref">System.UInt64</span>, each representing a snowflake identifier for a role that
|
||||
this user possesses.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 id="Discord_Rest_RestGuildUser_RoleIds_remarks">Remarks</h5>
|
||||
<div class="markdown level1 remarks"><p>This property returns a read-only collection of the identifiers of the roles that this user possesses.
|
||||
For WebSocket users, a Roles property can be found in place of this property. Due to the REST
|
||||
implementation, only a collection of identifiers can be retrieved instead of the full role objects.</p>
|
||||
</div>
|
||||
<h3 id="methods">Methods
|
||||
</h3>
|
||||
<span class="small pull-right mobile-hide">
|
||||
|
|
@ -441,7 +467,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestGuildUser_AddRoleAsync_" data-uid="Discord.Rest.RestGuildUser.AddRoleAsync*"></a>
|
||||
<h4 id="Discord_Rest_RestGuildUser_AddRoleAsync_Discord_IRole_Discord_RequestOptions_" data-uid="Discord.Rest.RestGuildUser.AddRoleAsync(Discord.IRole,Discord.RequestOptions)">AddRoleAsync(IRole, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Adds the specified role to this user in the guild.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -460,12 +487,14 @@
|
|||
<tr>
|
||||
<td><a class="xref" href="Discord.IRole.html">IRole</a></td>
|
||||
<td><span class="parametername">role</span></td>
|
||||
<td></td>
|
||||
<td><p>The role to be added to the user.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -480,7 +509,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous role addition operation.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -493,7 +523,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestGuildUser_AddRolesAsync_" data-uid="Discord.Rest.RestGuildUser.AddRolesAsync*"></a>
|
||||
<h4 id="Discord_Rest_RestGuildUser_AddRolesAsync_System_Collections_Generic_IEnumerable_Discord_IRole__Discord_RequestOptions_" data-uid="Discord.Rest.RestGuildUser.AddRolesAsync(System.Collections.Generic.IEnumerable{Discord.IRole},Discord.RequestOptions)">AddRolesAsync(IEnumerable<IRole>, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Adds the specified <code data-dev-comment-type="paramref" class="paramref">roles</code> to this user in the guild.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -512,12 +543,14 @@
|
|||
<tr>
|
||||
<td><span class="xref">System.Collections.Generic.IEnumerable</span><<a class="xref" href="Discord.IRole.html">IRole</a>></td>
|
||||
<td><span class="parametername">roles</span></td>
|
||||
<td></td>
|
||||
<td><p>The roles to be added to the user.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -532,7 +565,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous role addition operation.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -545,7 +579,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestGuildUser_GetPermissions_" data-uid="Discord.Rest.RestGuildUser.GetPermissions*"></a>
|
||||
<h4 id="Discord_Rest_RestGuildUser_GetPermissions_Discord_IGuildChannel_" data-uid="Discord.Rest.RestGuildUser.GetPermissions(Discord.IGuildChannel)">GetPermissions(IGuildChannel)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the level permissions granted to this user to a given channel.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -564,7 +599,8 @@
|
|||
<tr>
|
||||
<td><a class="xref" href="Discord.IGuildChannel.html">IGuildChannel</a></td>
|
||||
<td><span class="parametername">channel</span></td>
|
||||
<td></td>
|
||||
<td><p>The channel to get the permission from.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -579,7 +615,9 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.ChannelPermissions.html">ChannelPermissions</a></td>
|
||||
<td></td>
|
||||
<td><p>A <a class="xref" href="Discord.ChannelPermissions.html">ChannelPermissions</a> structure representing the permissions that a user has in the
|
||||
specified channel.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -608,7 +646,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestGuildUser_KickAsync_" data-uid="Discord.Rest.RestGuildUser.KickAsync*"></a>
|
||||
<h4 id="Discord_Rest_RestGuildUser_KickAsync_System_String_Discord_RequestOptions_" data-uid="Discord.Rest.RestGuildUser.KickAsync(System.String,Discord.RequestOptions)">KickAsync(String, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Kicks this user from this guild.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -627,12 +666,14 @@
|
|||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td><span class="parametername">reason</span></td>
|
||||
<td></td>
|
||||
<td><p>The reason for the kick which will be recorded in the audit log.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -647,7 +688,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous kick operation.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -660,7 +702,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestGuildUser_ModifyAsync_" data-uid="Discord.Rest.RestGuildUser.ModifyAsync*"></a>
|
||||
<h4 id="Discord_Rest_RestGuildUser_ModifyAsync_System_Action_Discord_GuildUserProperties__Discord_RequestOptions_" data-uid="Discord.Rest.RestGuildUser.ModifyAsync(System.Action{Discord.GuildUserProperties},Discord.RequestOptions)">ModifyAsync(Action<GuildUserProperties>, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Modifies this user's properties in this guild.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -679,12 +722,14 @@
|
|||
<tr>
|
||||
<td><span class="xref">System.Action</span><<a class="xref" href="Discord.GuildUserProperties.html">GuildUserProperties</a>></td>
|
||||
<td><span class="parametername">func</span></td>
|
||||
<td></td>
|
||||
<td><p>The delegate containing the properties to modify the user with.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -699,10 +744,15 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous modification operation.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 id="Discord_Rest_RestGuildUser_ModifyAsync_System_Action_Discord_GuildUserProperties__Discord_RequestOptions__remarks">Remarks</h5>
|
||||
<div class="markdown level1 remarks"><p>This method modifies the current guild user with the specified properties. To see an example of this
|
||||
method and what properties are available, please refer to <a class="xref" href="Discord.GuildUserProperties.html">GuildUserProperties</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_RestGuildUser_RemoveRoleAsync_Discord_IRole_Discord_RequestOptions_.md&value=---%0Auid%3A%20Discord.Rest.RestGuildUser.RemoveRoleAsync(Discord.IRole%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>
|
||||
|
|
@ -712,7 +762,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestGuildUser_RemoveRoleAsync_" data-uid="Discord.Rest.RestGuildUser.RemoveRoleAsync*"></a>
|
||||
<h4 id="Discord_Rest_RestGuildUser_RemoveRoleAsync_Discord_IRole_Discord_RequestOptions_" data-uid="Discord.Rest.RestGuildUser.RemoveRoleAsync(Discord.IRole,Discord.RequestOptions)">RemoveRoleAsync(IRole, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Removes the specified <code data-dev-comment-type="paramref" class="paramref">role</code> from this user in the guild.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -731,12 +782,14 @@
|
|||
<tr>
|
||||
<td><a class="xref" href="Discord.IRole.html">IRole</a></td>
|
||||
<td><span class="parametername">role</span></td>
|
||||
<td></td>
|
||||
<td><p>The role to be removed from the user.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -751,7 +804,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous role removal operation.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -764,7 +818,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestGuildUser_RemoveRolesAsync_" data-uid="Discord.Rest.RestGuildUser.RemoveRolesAsync*"></a>
|
||||
<h4 id="Discord_Rest_RestGuildUser_RemoveRolesAsync_System_Collections_Generic_IEnumerable_Discord_IRole__Discord_RequestOptions_" data-uid="Discord.Rest.RestGuildUser.RemoveRolesAsync(System.Collections.Generic.IEnumerable{Discord.IRole},Discord.RequestOptions)">RemoveRolesAsync(IEnumerable<IRole>, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Removes the specified <code data-dev-comment-type="paramref" class="paramref">roles</code> from this user in the guild.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -783,12 +838,14 @@
|
|||
<tr>
|
||||
<td><span class="xref">System.Collections.Generic.IEnumerable</span><<a class="xref" href="Discord.IRole.html">IRole</a>></td>
|
||||
<td><span class="parametername">roles</span></td>
|
||||
<td></td>
|
||||
<td><p>The roles to be removed from the user.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -803,7 +860,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous role removal operation.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -816,7 +874,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestGuildUser_UpdateAsync_" data-uid="Discord.Rest.RestGuildUser.UpdateAsync*"></a>
|
||||
<h4 id="Discord_Rest_RestGuildUser_UpdateAsync_Discord_RequestOptions_" data-uid="Discord.Rest.RestGuildUser.UpdateAsync(Discord.RequestOptions)">UpdateAsync(RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Updates this object's properties with its current state.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -867,7 +926,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestGuildUser_Discord_IGuildUser_Guild_" data-uid="Discord.Rest.RestGuildUser.Discord#IGuildUser#Guild*"></a>
|
||||
<h4 id="Discord_Rest_RestGuildUser_Discord_IGuildUser_Guild" data-uid="Discord.Rest.RestGuildUser.Discord#IGuildUser#Guild">IGuildUser.Guild</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the guild for this user.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -884,7 +944,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.IGuild.html">IGuild</a></td>
|
||||
<td></td>
|
||||
<td><p>A guild object that this user belongs to.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -897,7 +958,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestGuildUser_Discord_IVoiceState_IsSelfDeafened_" data-uid="Discord.Rest.RestGuildUser.Discord#IVoiceState#IsSelfDeafened*"></a>
|
||||
<h4 id="Discord_Rest_RestGuildUser_Discord_IVoiceState_IsSelfDeafened" data-uid="Discord.Rest.RestGuildUser.Discord#IVoiceState#IsSelfDeafened">IVoiceState.IsSelfDeafened</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a value that indicates whether this user has marked themselves as deafened.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -914,7 +976,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td></td>
|
||||
<td><p><code>true</code> if this user has deafened themselves (i.e. not permitted to listen to or speak to others); otherwise <code>false</code>.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -927,7 +990,9 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestGuildUser_Discord_IVoiceState_IsSelfMuted_" data-uid="Discord.Rest.RestGuildUser.Discord#IVoiceState#IsSelfMuted*"></a>
|
||||
<h4 id="Discord_Rest_RestGuildUser_Discord_IVoiceState_IsSelfMuted" data-uid="Discord.Rest.RestGuildUser.Discord#IVoiceState#IsSelfMuted">IVoiceState.IsSelfMuted</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a value that indicates whether this user has marked themselves as muted (i.e. not permitted to
|
||||
speak via voice).</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -944,7 +1009,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td></td>
|
||||
<td><p><code>true</code> if this user has muted themselves; otherwise <code>false</code>.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -957,7 +1023,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestGuildUser_Discord_IVoiceState_IsStreaming_" data-uid="Discord.Rest.RestGuildUser.Discord#IVoiceState#IsStreaming*"></a>
|
||||
<h4 id="Discord_Rest_RestGuildUser_Discord_IVoiceState_IsStreaming" data-uid="Discord.Rest.RestGuildUser.Discord#IVoiceState#IsStreaming">IVoiceState.IsStreaming</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a value that indicates if this user is streaming in a voice channel.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -974,7 +1041,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td></td>
|
||||
<td><p><code>true</code> if the user is streaming; otherwise <code>false</code>.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -987,7 +1055,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestGuildUser_Discord_IVoiceState_IsSuppressed_" data-uid="Discord.Rest.RestGuildUser.Discord#IVoiceState#IsSuppressed*"></a>
|
||||
<h4 id="Discord_Rest_RestGuildUser_Discord_IVoiceState_IsSuppressed" data-uid="Discord.Rest.RestGuildUser.Discord#IVoiceState#IsSuppressed">IVoiceState.IsSuppressed</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a value that indicates whether the user is muted by the current user.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1004,7 +1073,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td></td>
|
||||
<td><p><code>true</code> if the guild is temporarily blocking audio to/from this user; otherwise <code>false</code>.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1017,7 +1087,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestGuildUser_Discord_IVoiceState_VoiceChannel_" data-uid="Discord.Rest.RestGuildUser.Discord#IVoiceState#VoiceChannel*"></a>
|
||||
<h4 id="Discord_Rest_RestGuildUser_Discord_IVoiceState_VoiceChannel" data-uid="Discord.Rest.RestGuildUser.Discord#IVoiceState#VoiceChannel">IVoiceState.VoiceChannel</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the voice channel this user is currently in.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1034,7 +1105,9 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.IVoiceChannel.html">IVoiceChannel</a></td>
|
||||
<td></td>
|
||||
<td><p>A generic voice channel object representing the voice channel that the user is currently in; <code>null</code>
|
||||
if none.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1047,7 +1120,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestGuildUser_Discord_IVoiceState_VoiceSessionId_" data-uid="Discord.Rest.RestGuildUser.Discord#IVoiceState#VoiceSessionId*"></a>
|
||||
<h4 id="Discord_Rest_RestGuildUser_Discord_IVoiceState_VoiceSessionId" data-uid="Discord.Rest.RestGuildUser.Discord#IVoiceState#VoiceSessionId">IVoiceState.VoiceSessionId</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the unique identifier for this user's voice session.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
|
|||
|
|
@ -130,7 +130,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestInvite_ChannelId_" data-uid="Discord.Rest.RestInvite.ChannelId*"></a>
|
||||
<h4 id="Discord_Rest_RestInvite_ChannelId" data-uid="Discord.Rest.RestInvite.ChannelId">ChannelId</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the ID of the channel this invite is linked to.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -147,7 +148,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.UInt64</span></td>
|
||||
<td></td>
|
||||
<td><p>An <span class="xref">System.UInt64</span> representing the channel snowflake identifier that the invite points to.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -160,7 +162,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestInvite_ChannelName_" data-uid="Discord.Rest.RestInvite.ChannelName*"></a>
|
||||
<h4 id="Discord_Rest_RestInvite_ChannelName" data-uid="Discord.Rest.RestInvite.ChannelName">ChannelName</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the name of the channel this invite is linked to.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -177,7 +180,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td></td>
|
||||
<td><p>A string containing the name of the channel that the invite points to.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -220,7 +224,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestInvite_Code_" data-uid="Discord.Rest.RestInvite.Code*"></a>
|
||||
<h4 id="Discord_Rest_RestInvite_Code" data-uid="Discord.Rest.RestInvite.Code">Code</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the unique identifier for this invite.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -237,7 +242,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td></td>
|
||||
<td><p>A string containing the invite code (e.g. <code>FTqNnyS</code>).</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -250,7 +256,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestInvite_GuildId_" data-uid="Discord.Rest.RestInvite.GuildId*"></a>
|
||||
<h4 id="Discord_Rest_RestInvite_GuildId" data-uid="Discord.Rest.RestInvite.GuildId">GuildId</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the ID of the guild this invite is linked to.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -267,7 +274,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Nullable</span><<span class="xref">System.UInt64</span>></td>
|
||||
<td></td>
|
||||
<td><p>An <span class="xref">System.UInt64</span> representing the guild snowflake identifier that the invite points to.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -280,7 +288,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestInvite_GuildName_" data-uid="Discord.Rest.RestInvite.GuildName*"></a>
|
||||
<h4 id="Discord_Rest_RestInvite_GuildName" data-uid="Discord.Rest.RestInvite.GuildName">GuildName</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the name of the guild this invite is linked to.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -297,7 +306,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td></td>
|
||||
<td><p>A string containing the name of the guild that the invite points to.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -310,7 +320,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestInvite_MemberCount_" data-uid="Discord.Rest.RestInvite.MemberCount*"></a>
|
||||
<h4 id="Discord_Rest_RestInvite_MemberCount" data-uid="Discord.Rest.RestInvite.MemberCount">MemberCount</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the approximated count of total members in the guild.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -327,7 +338,9 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Nullable</span><<span class="xref">System.Int32</span>></td>
|
||||
<td></td>
|
||||
<td><p>An <span class="xref">System.Int32</span> representing the approximated total member count of the guild that the
|
||||
invite points to; <code>null</code> if one cannot be obtained.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -340,7 +353,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestInvite_PresenceCount_" data-uid="Discord.Rest.RestInvite.PresenceCount*"></a>
|
||||
<h4 id="Discord_Rest_RestInvite_PresenceCount" data-uid="Discord.Rest.RestInvite.PresenceCount">PresenceCount</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the approximated count of online members in the guild.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -357,7 +371,9 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Nullable</span><<span class="xref">System.Int32</span>></td>
|
||||
<td></td>
|
||||
<td><p>An <span class="xref">System.Int32</span> representing the approximated online member count of the guild that the
|
||||
invite points to; <code>null</code> if one cannot be obtained.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -370,7 +386,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestInvite_Url_" data-uid="Discord.Rest.RestInvite.Url*"></a>
|
||||
<h4 id="Discord_Rest_RestInvite_Url" data-uid="Discord.Rest.RestInvite.Url">Url</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the URL used to accept this invite using <a class="xref" href="Discord.IInvite.html#Discord_IInvite_Code">Code</a>.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -387,7 +404,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td></td>
|
||||
<td><p>A string containing the full invite URL (e.g. <code>https://discord.gg/FTqNnyS</code>).</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -402,7 +420,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestInvite_DeleteAsync_" data-uid="Discord.Rest.RestInvite.DeleteAsync*"></a>
|
||||
<h4 id="Discord_Rest_RestInvite_DeleteAsync_Discord_RequestOptions_" data-uid="Discord.Rest.RestInvite.DeleteAsync(Discord.RequestOptions)">DeleteAsync(RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Deletes this object and all its children.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -421,7 +440,8 @@
|
|||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -483,7 +503,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestInvite_UpdateAsync_" data-uid="Discord.Rest.RestInvite.UpdateAsync*"></a>
|
||||
<h4 id="Discord_Rest_RestInvite_UpdateAsync_Discord_RequestOptions_" data-uid="Discord.Rest.RestInvite.UpdateAsync(Discord.RequestOptions)">UpdateAsync(RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Updates this object's properties with its current state.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -532,7 +553,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestInvite_Discord_IInvite_Channel_" data-uid="Discord.Rest.RestInvite.Discord#IInvite#Channel*"></a>
|
||||
<h4 id="Discord_Rest_RestInvite_Discord_IInvite_Channel" data-uid="Discord.Rest.RestInvite.Discord#IInvite#Channel">IInvite.Channel</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the channel this invite is linked to.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -549,7 +571,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.IChannel.html">IChannel</a></td>
|
||||
<td></td>
|
||||
<td><p>A generic channel that the invite points to.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -562,7 +585,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestInvite_Discord_IInvite_Guild_" data-uid="Discord.Rest.RestInvite.Discord#IInvite#Guild*"></a>
|
||||
<h4 id="Discord_Rest_RestInvite_Discord_IInvite_Guild" data-uid="Discord.Rest.RestInvite.Discord#IInvite#Guild">IInvite.Guild</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the guild this invite is linked to.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -579,7 +603,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.IGuild.html">IGuild</a></td>
|
||||
<td></td>
|
||||
<td><p>A guild object representing the guild that the invite points to.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
|
|||
|
|
@ -174,7 +174,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestInviteMetadata_CreatedAt_" data-uid="Discord.Rest.RestInviteMetadata.CreatedAt*"></a>
|
||||
<h4 id="Discord_Rest_RestInviteMetadata_CreatedAt" data-uid="Discord.Rest.RestInviteMetadata.CreatedAt">CreatedAt</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<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">
|
||||
|
|
@ -191,7 +192,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Nullable</span><<span class="xref">System.DateTimeOffset</span>></td>
|
||||
<td></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>
|
||||
|
|
@ -235,7 +237,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestInviteMetadata_IsRevoked_" data-uid="Discord.Rest.RestInviteMetadata.IsRevoked*"></a>
|
||||
<h4 id="Discord_Rest_RestInviteMetadata_IsRevoked" data-uid="Discord.Rest.RestInviteMetadata.IsRevoked">IsRevoked</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<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">
|
||||
|
|
@ -252,7 +255,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td></td>
|
||||
<td><p><code>true</code> if this invite was revoked; otherwise <code>false</code>.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -265,7 +269,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestInviteMetadata_IsTemporary_" data-uid="Discord.Rest.RestInviteMetadata.IsTemporary*"></a>
|
||||
<h4 id="Discord_Rest_RestInviteMetadata_IsTemporary" data-uid="Discord.Rest.RestInviteMetadata.IsTemporary">IsTemporary</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<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">
|
||||
|
|
@ -282,7 +287,9 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td></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>
|
||||
|
|
@ -295,7 +302,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestInviteMetadata_MaxAge_" data-uid="Discord.Rest.RestInviteMetadata.MaxAge*"></a>
|
||||
<h4 id="Discord_Rest_RestInviteMetadata_MaxAge" data-uid="Discord.Rest.RestInviteMetadata.MaxAge">MaxAge</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<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">
|
||||
|
|
@ -312,7 +320,9 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Nullable</span><<span class="xref">System.Int32</span>></td>
|
||||
<td></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>
|
||||
|
|
@ -325,7 +335,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestInviteMetadata_MaxUses_" data-uid="Discord.Rest.RestInviteMetadata.MaxUses*"></a>
|
||||
<h4 id="Discord_Rest_RestInviteMetadata_MaxUses" data-uid="Discord.Rest.RestInviteMetadata.MaxUses">MaxUses</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<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">
|
||||
|
|
@ -342,7 +353,9 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Nullable</span><<span class="xref">System.Int32</span>></td>
|
||||
<td></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>
|
||||
|
|
@ -355,7 +368,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestInviteMetadata_Uses_" data-uid="Discord.Rest.RestInviteMetadata.Uses*"></a>
|
||||
<h4 id="Discord_Rest_RestInviteMetadata_Uses" data-uid="Discord.Rest.RestInviteMetadata.Uses">Uses</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<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">
|
||||
|
|
@ -372,7 +386,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Nullable</span><<span class="xref">System.Int32</span>></td>
|
||||
<td></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>
|
||||
|
|
@ -387,7 +402,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestInviteMetadata_Discord_IInviteMetadata_Inviter_" data-uid="Discord.Rest.RestInviteMetadata.Discord#IInviteMetadata#Inviter*"></a>
|
||||
<h4 id="Discord_Rest_RestInviteMetadata_Discord_IInviteMetadata_Inviter" data-uid="Discord.Rest.RestInviteMetadata.Discord#IInviteMetadata#Inviter">IInviteMetadata.Inviter</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<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">
|
||||
|
|
@ -404,7 +420,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.IUser.html">IUser</a></td>
|
||||
<td></td>
|
||||
<td><p>A user that created this invite.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
|
|||
|
|
@ -133,7 +133,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestMessage_Activity_" data-uid="Discord.Rest.RestMessage.Activity*"></a>
|
||||
<h4 id="Discord_Rest_RestMessage_Activity" data-uid="Discord.Rest.RestMessage.Activity">Activity</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the activity associated with a message.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -150,10 +151,15 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.MessageActivity.html">MessageActivity</a></td>
|
||||
<td></td>
|
||||
<td><p>A message's activity, if any is associated.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 id="Discord_Rest_RestMessage_Activity_remarks">Remarks</h5>
|
||||
<div class="markdown level1 remarks"><p>Sent with Rich Presence-related chat embeds. This often refers to activity that requires end-user's
|
||||
interaction, such as a Spotify Invite activity.</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_RestMessage_Application.md&value=---%0Auid%3A%20Discord.Rest.RestMessage.Application%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>
|
||||
|
|
@ -163,7 +169,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestMessage_Application_" data-uid="Discord.Rest.RestMessage.Application*"></a>
|
||||
<h4 id="Discord_Rest_RestMessage_Application" data-uid="Discord.Rest.RestMessage.Application">Application</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the application associated with a message.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -180,10 +187,14 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.MessageApplication.html">MessageApplication</a></td>
|
||||
<td></td>
|
||||
<td><p>A message's application, if any is associated.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 id="Discord_Rest_RestMessage_Application_remarks">Remarks</h5>
|
||||
<div class="markdown level1 remarks"><p>Sent with Rich-Presence-related chat embeds.</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_RestMessage_Attachments.md&value=---%0Auid%3A%20Discord.Rest.RestMessage.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>
|
||||
|
|
@ -255,7 +266,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestMessage_Channel_" data-uid="Discord.Rest.RestMessage.Channel*"></a>
|
||||
<h4 id="Discord_Rest_RestMessage_Channel" data-uid="Discord.Rest.RestMessage.Channel">Channel</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the source channel of the message.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -285,7 +297,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestMessage_Content_" data-uid="Discord.Rest.RestMessage.Content*"></a>
|
||||
<h4 id="Discord_Rest_RestMessage_Content" data-uid="Discord.Rest.RestMessage.Content">Content</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the content for this message.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -302,7 +315,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td></td>
|
||||
<td><p>A string that contains the body of the message; note that this field may be empty if there is an embed.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -315,7 +329,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestMessage_CreatedAt_" data-uid="Discord.Rest.RestMessage.CreatedAt*"></a>
|
||||
<h4 id="Discord_Rest_RestMessage_CreatedAt" data-uid="Discord.Rest.RestMessage.CreatedAt">CreatedAt</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets when the snowflake was created.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -332,7 +347,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.DateTimeOffset</span></td>
|
||||
<td></td>
|
||||
<td><p>A <span class="xref">System.DateTimeOffset</span> representing when the entity was first created.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -345,7 +361,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestMessage_EditedTimestamp_" data-uid="Discord.Rest.RestMessage.EditedTimestamp*"></a>
|
||||
<h4 id="Discord_Rest_RestMessage_EditedTimestamp" data-uid="Discord.Rest.RestMessage.EditedTimestamp">EditedTimestamp</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<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">
|
||||
|
|
@ -362,7 +379,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Nullable</span><<span class="xref">System.DateTimeOffset</span>></td>
|
||||
<td></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>
|
||||
|
|
@ -406,7 +424,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestMessage_IsPinned_" data-uid="Discord.Rest.RestMessage.IsPinned*"></a>
|
||||
<h4 id="Discord_Rest_RestMessage_IsPinned" data-uid="Discord.Rest.RestMessage.IsPinned">IsPinned</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<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">
|
||||
|
|
@ -423,7 +442,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td></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>
|
||||
|
|
@ -436,7 +456,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestMessage_IsSuppressed_" data-uid="Discord.Rest.RestMessage.IsSuppressed*"></a>
|
||||
<h4 id="Discord_Rest_RestMessage_IsSuppressed" data-uid="Discord.Rest.RestMessage.IsSuppressed">IsSuppressed</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<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">
|
||||
|
|
@ -453,7 +474,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td></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>
|
||||
|
|
@ -466,7 +488,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestMessage_IsTTS_" data-uid="Discord.Rest.RestMessage.IsTTS*"></a>
|
||||
<h4 id="Discord_Rest_RestMessage_IsTTS" data-uid="Discord.Rest.RestMessage.IsTTS">IsTTS</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<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">
|
||||
|
|
@ -483,7 +506,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td></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>
|
||||
|
|
@ -496,7 +520,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestMessage_MentionedChannelIds_" data-uid="Discord.Rest.RestMessage.MentionedChannelIds*"></a>
|
||||
<h4 id="Discord_Rest_RestMessage_MentionedChannelIds" data-uid="Discord.Rest.RestMessage.MentionedChannelIds">MentionedChannelIds</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<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">
|
||||
|
|
@ -513,7 +538,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Collections.Generic.IReadOnlyCollection</span><<span class="xref">System.UInt64</span>></td>
|
||||
<td></td>
|
||||
<td><p>A read-only collection of channel IDs.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -526,7 +552,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestMessage_MentionedRoleIds_" data-uid="Discord.Rest.RestMessage.MentionedRoleIds*"></a>
|
||||
<h4 id="Discord_Rest_RestMessage_MentionedRoleIds" data-uid="Discord.Rest.RestMessage.MentionedRoleIds">MentionedRoleIds</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<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">
|
||||
|
|
@ -543,7 +570,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Collections.Generic.IReadOnlyCollection</span><<span class="xref">System.UInt64</span>></td>
|
||||
<td></td>
|
||||
<td><p>A read-only collection of role IDs.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -587,7 +615,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestMessage_Reactions_" data-uid="Discord.Rest.RestMessage.Reactions*"></a>
|
||||
<h4 id="Discord_Rest_RestMessage_Reactions" data-uid="Discord.Rest.RestMessage.Reactions">Reactions</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets all reactions included in this message.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -617,7 +646,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestMessage_Reference_" data-uid="Discord.Rest.RestMessage.Reference*"></a>
|
||||
<h4 id="Discord_Rest_RestMessage_Reference" data-uid="Discord.Rest.RestMessage.Reference">Reference</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the reference to the original message if it was crossposted.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -634,10 +664,15 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.MessageReference.html">MessageReference</a></td>
|
||||
<td></td>
|
||||
<td><p>A message's reference, if any is associated.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 id="Discord_Rest_RestMessage_Reference_remarks">Remarks</h5>
|
||||
<div class="markdown level1 remarks"><p>Sent with Cross-posted messages, meaning they were published from news channels
|
||||
and received by subscriber channels.</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_RestMessage_Source.md&value=---%0Auid%3A%20Discord.Rest.RestMessage.Source%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>
|
||||
|
|
@ -647,7 +682,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestMessage_Source_" data-uid="Discord.Rest.RestMessage.Source*"></a>
|
||||
<h4 id="Discord_Rest_RestMessage_Source" data-uid="Discord.Rest.RestMessage.Source">Source</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the source type of this message.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -677,7 +713,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestMessage_Tags_" data-uid="Discord.Rest.RestMessage.Tags*"></a>
|
||||
<h4 id="Discord_Rest_RestMessage_Tags" data-uid="Discord.Rest.RestMessage.Tags">Tags</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<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">
|
||||
|
|
@ -707,7 +744,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestMessage_Timestamp_" data-uid="Discord.Rest.RestMessage.Timestamp*"></a>
|
||||
<h4 id="Discord_Rest_RestMessage_Timestamp" data-uid="Discord.Rest.RestMessage.Timestamp">Timestamp</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the time this message was sent.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -724,7 +762,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.DateTimeOffset</span></td>
|
||||
<td></td>
|
||||
<td><p>Time of when the message was sent.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -739,7 +778,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestMessage_AddReactionAsync_" data-uid="Discord.Rest.RestMessage.AddReactionAsync*"></a>
|
||||
<h4 id="Discord_Rest_RestMessage_AddReactionAsync_Discord_IEmote_Discord_RequestOptions_" data-uid="Discord.Rest.RestMessage.AddReactionAsync(Discord.IEmote,Discord.RequestOptions)">AddReactionAsync(IEmote, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Adds a reaction to this message.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -758,12 +798,14 @@
|
|||
<tr>
|
||||
<td><a class="xref" href="Discord.IEmote.html">IEmote</a></td>
|
||||
<td><span class="parametername">emote</span></td>
|
||||
<td></td>
|
||||
<td><p>The emoji used to react to this message.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -778,10 +820,15 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous operation for adding a reaction to this message.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 id="Discord_Rest_RestMessage_AddReactionAsync_Discord_IEmote_Discord_RequestOptions__seealso">See Also</h5>
|
||||
<div class="seealso">
|
||||
<div><a class="xref" href="Discord.IEmote.html">IEmote</a></div>
|
||||
</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_RestMessage_DeleteAsync_Discord_RequestOptions_.md&value=---%0Auid%3A%20Discord.Rest.RestMessage.DeleteAsync(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>
|
||||
|
|
@ -791,7 +838,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestMessage_DeleteAsync_" data-uid="Discord.Rest.RestMessage.DeleteAsync*"></a>
|
||||
<h4 id="Discord_Rest_RestMessage_DeleteAsync_Discord_RequestOptions_" data-uid="Discord.Rest.RestMessage.DeleteAsync(Discord.RequestOptions)">DeleteAsync(RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Deletes this object and all its children.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -810,7 +858,8 @@
|
|||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -838,7 +887,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestMessage_GetReactionUsersAsync_" data-uid="Discord.Rest.RestMessage.GetReactionUsersAsync*"></a>
|
||||
<h4 id="Discord_Rest_RestMessage_GetReactionUsersAsync_Discord_IEmote_System_Int32_Discord_RequestOptions_" data-uid="Discord.Rest.RestMessage.GetReactionUsersAsync(Discord.IEmote,System.Int32,Discord.RequestOptions)">GetReactionUsersAsync(IEmote, Int32, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets all users that reacted to a message with a given emote.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -862,12 +912,14 @@
|
|||
<tr>
|
||||
<td><span class="xref">System.Int32</span></td>
|
||||
<td><span class="parametername">limit</span></td>
|
||||
<td></td>
|
||||
<td><p>The number of users to request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -882,7 +934,10 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Collections.Generic.IAsyncEnumerable</span><<span class="xref">System.Collections.Generic.IReadOnlyCollection</span><<a class="xref" href="Discord.IUser.html">IUser</a>>></td>
|
||||
<td></td>
|
||||
<td><p>A paged collection containing a read-only collection of users that has reacted to this message.
|
||||
Flattening the paginated response into a collection of users with
|
||||
<a class="xref" href="Discord.AsyncEnumerableExtensions.html#Discord_AsyncEnumerableExtensions_FlattenAsync__1_System_Collections_Generic_IAsyncEnumerable_System_Collections_Generic_IEnumerable___0___">FlattenAsync<T>(IAsyncEnumerable<IEnumerable<T>>)</a> is required if you wish to access the users.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -895,7 +950,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestMessage_RemoveAllReactionsAsync_" data-uid="Discord.Rest.RestMessage.RemoveAllReactionsAsync*"></a>
|
||||
<h4 id="Discord_Rest_RestMessage_RemoveAllReactionsAsync_Discord_RequestOptions_" data-uid="Discord.Rest.RestMessage.RemoveAllReactionsAsync(Discord.RequestOptions)">RemoveAllReactionsAsync(RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Removes all reactions from this message.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -914,7 +970,8 @@
|
|||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -929,7 +986,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous removal operation.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -942,7 +1000,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestMessage_RemoveReactionAsync_" data-uid="Discord.Rest.RestMessage.RemoveReactionAsync*"></a>
|
||||
<h4 id="Discord_Rest_RestMessage_RemoveReactionAsync_Discord_IEmote_Discord_IUser_Discord_RequestOptions_" data-uid="Discord.Rest.RestMessage.RemoveReactionAsync(Discord.IEmote,Discord.IUser,Discord.RequestOptions)">RemoveReactionAsync(IEmote, IUser, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Removes a reaction from message.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -961,17 +1020,20 @@
|
|||
<tr>
|
||||
<td><a class="xref" href="Discord.IEmote.html">IEmote</a></td>
|
||||
<td><span class="parametername">emote</span></td>
|
||||
<td></td>
|
||||
<td><p>The emoji used to react to this message.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.IUser.html">IUser</a></td>
|
||||
<td><span class="parametername">user</span></td>
|
||||
<td></td>
|
||||
<td><p>The user that added the emoji.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -986,10 +1048,15 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous operation for removing a reaction to this message.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 id="Discord_Rest_RestMessage_RemoveReactionAsync_Discord_IEmote_Discord_IUser_Discord_RequestOptions__seealso">See Also</h5>
|
||||
<div class="seealso">
|
||||
<div><a class="xref" href="Discord.IEmote.html">IEmote</a></div>
|
||||
</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_RestMessage_RemoveReactionAsync_Discord_IEmote_System_UInt64_Discord_RequestOptions_.md&value=---%0Auid%3A%20Discord.Rest.RestMessage.RemoveReactionAsync(Discord.IEmote%2CSystem.UInt64%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>
|
||||
|
|
@ -999,7 +1066,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestMessage_RemoveReactionAsync_" data-uid="Discord.Rest.RestMessage.RemoveReactionAsync*"></a>
|
||||
<h4 id="Discord_Rest_RestMessage_RemoveReactionAsync_Discord_IEmote_System_UInt64_Discord_RequestOptions_" data-uid="Discord.Rest.RestMessage.RemoveReactionAsync(Discord.IEmote,System.UInt64,Discord.RequestOptions)">RemoveReactionAsync(IEmote, UInt64, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Removes a reaction from message.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1018,17 +1086,20 @@
|
|||
<tr>
|
||||
<td><a class="xref" href="Discord.IEmote.html">IEmote</a></td>
|
||||
<td><span class="parametername">emote</span></td>
|
||||
<td></td>
|
||||
<td><p>The emoji used to react to this message.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.UInt64</span></td>
|
||||
<td><span class="parametername">userId</span></td>
|
||||
<td></td>
|
||||
<td><p>The ID of the user that added the emoji.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1043,10 +1114,15 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous operation for removing a reaction to this message.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 id="Discord_Rest_RestMessage_RemoveReactionAsync_Discord_IEmote_System_UInt64_Discord_RequestOptions__seealso">See Also</h5>
|
||||
<div class="seealso">
|
||||
<div><a class="xref" href="Discord.IEmote.html">IEmote</a></div>
|
||||
</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_RestMessage_ToString.md&value=---%0Auid%3A%20Discord.Rest.RestMessage.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>
|
||||
|
|
@ -1090,7 +1166,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestMessage_UpdateAsync_" data-uid="Discord.Rest.RestMessage.UpdateAsync*"></a>
|
||||
<h4 id="Discord_Rest_RestMessage_UpdateAsync_Discord_RequestOptions_" data-uid="Discord.Rest.RestMessage.UpdateAsync(Discord.RequestOptions)">UpdateAsync(RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Updates this object's properties with its current state.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1139,7 +1216,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestMessage_Discord_IMessage_Attachments_" data-uid="Discord.Rest.RestMessage.Discord#IMessage#Attachments*"></a>
|
||||
<h4 id="Discord_Rest_RestMessage_Discord_IMessage_Attachments" data-uid="Discord.Rest.RestMessage.Discord#IMessage#Attachments">IMessage.Attachments</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets all attachments included in this message.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1156,10 +1234,16 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Collections.Generic.IReadOnlyCollection</span><<a class="xref" href="Discord.IAttachment.html">IAttachment</a>></td>
|
||||
<td></td>
|
||||
<td><p>A read-only collection of attachments.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 id="Discord_Rest_RestMessage_Discord_IMessage_Attachments_remarks">Remarks</h5>
|
||||
<div class="markdown level1 remarks"><p>This property gets a read-only collection of attachments associated with this message. Depending on the
|
||||
user's end-client, a sent message may contain one or more attachments. For example, mobile users may
|
||||
attach more than one file in their message, while the desktop client only allows for one.</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_RestMessage_Discord_IMessage_Author.md&value=---%0Auid%3A%20Discord.Rest.RestMessage.Discord%23IMessage%23Author%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>
|
||||
|
|
@ -1199,7 +1283,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestMessage_Discord_IMessage_Embeds_" data-uid="Discord.Rest.RestMessage.Discord#IMessage#Embeds*"></a>
|
||||
<h4 id="Discord_Rest_RestMessage_Discord_IMessage_Embeds" data-uid="Discord.Rest.RestMessage.Discord#IMessage#Embeds">IMessage.Embeds</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets all embeds included in this message.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1216,7 +1301,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Collections.Generic.IReadOnlyCollection</span><<a class="xref" href="Discord.IEmbed.html">IEmbed</a>></td>
|
||||
<td></td>
|
||||
<td><p>A read-only collection of embed objects.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1229,7 +1315,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestMessage_Discord_IMessage_MentionedUserIds_" data-uid="Discord.Rest.RestMessage.Discord#IMessage#MentionedUserIds*"></a>
|
||||
<h4 id="Discord_Rest_RestMessage_Discord_IMessage_MentionedUserIds" data-uid="Discord.Rest.RestMessage.Discord#IMessage#MentionedUserIds">IMessage.MentionedUserIds</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the IDs of users mentioned in this message.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1246,7 +1333,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Collections.Generic.IReadOnlyCollection</span><<span class="xref">System.UInt64</span>></td>
|
||||
<td></td>
|
||||
<td><p>A read-only collection of user IDs.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1259,7 +1347,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestMessage_Discord_IMessage_Type_" data-uid="Discord.Rest.RestMessage.Discord#IMessage#Type*"></a>
|
||||
<h4 id="Discord_Rest_RestMessage_Discord_IMessage_Type" data-uid="Discord.Rest.RestMessage.Discord#IMessage#Type">IMessage.Type</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the type of this system message.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
|
|||
|
|
@ -157,7 +157,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestReaction_Emote_" data-uid="Discord.Rest.RestReaction.Emote*"></a>
|
||||
<h4 id="Discord_Rest_RestReaction_Emote" data-uid="Discord.Rest.RestReaction.Emote">Emote</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>The <a class="xref" href="Discord.IEmote.html">IEmote</a> used in the reaction.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
|
|||
|
|
@ -132,7 +132,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestRole_Color_" data-uid="Discord.Rest.RestRole.Color*"></a>
|
||||
<h4 id="Discord_Rest_RestRole_Color" data-uid="Discord.Rest.RestRole.Color">Color</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the color given to users of this role.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -149,7 +150,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.Color.html">Color</a></td>
|
||||
<td></td>
|
||||
<td><p>A <a class="xref" href="Discord.IRole.html#Discord_IRole_Color">Color</a> struct representing the color of this role.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -162,7 +164,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestRole_CreatedAt_" data-uid="Discord.Rest.RestRole.CreatedAt*"></a>
|
||||
<h4 id="Discord_Rest_RestRole_CreatedAt" data-uid="Discord.Rest.RestRole.CreatedAt">CreatedAt</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets when the snowflake was created.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -179,7 +182,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.DateTimeOffset</span></td>
|
||||
<td></td>
|
||||
<td><p>A <span class="xref">System.DateTimeOffset</span> representing when the entity was first created.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -223,7 +227,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestRole_IsHoisted_" data-uid="Discord.Rest.RestRole.IsHoisted*"></a>
|
||||
<h4 id="Discord_Rest_RestRole_IsHoisted" data-uid="Discord.Rest.RestRole.IsHoisted">IsHoisted</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a value that indicates whether the role can be separated in the user list.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -240,7 +245,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td></td>
|
||||
<td><p><code>true</code> if users of this role are separated in the user list; otherwise <code>false</code>.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -253,7 +259,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestRole_IsManaged_" data-uid="Discord.Rest.RestRole.IsManaged*"></a>
|
||||
<h4 id="Discord_Rest_RestRole_IsManaged" data-uid="Discord.Rest.RestRole.IsManaged">IsManaged</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a value that indicates whether the role is managed by Discord.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -270,7 +277,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td></td>
|
||||
<td><p><code>true</code> if this role is automatically managed by Discord; otherwise <code>false</code>.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -283,7 +291,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestRole_IsMentionable_" data-uid="Discord.Rest.RestRole.IsMentionable*"></a>
|
||||
<h4 id="Discord_Rest_RestRole_IsMentionable" data-uid="Discord.Rest.RestRole.IsMentionable">IsMentionable</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a value that indicates whether the role is mentionable.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -300,7 +309,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td></td>
|
||||
<td><p><code>true</code> if this role may be mentioned in messages; otherwise <code>false</code>.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -313,7 +323,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestRole_Mention_" data-uid="Discord.Rest.RestRole.Mention*"></a>
|
||||
<h4 id="Discord_Rest_RestRole_Mention" data-uid="Discord.Rest.RestRole.Mention">Mention</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Returns a special string used to mention this object.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -330,7 +341,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td></td>
|
||||
<td><p>A string that is recognized by Discord as a mention (e.g. <@168693960628371456>).</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -343,7 +355,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestRole_Name_" data-uid="Discord.Rest.RestRole.Name*"></a>
|
||||
<h4 id="Discord_Rest_RestRole_Name" data-uid="Discord.Rest.RestRole.Name">Name</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the name of this role.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -360,7 +373,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td></td>
|
||||
<td><p>A string containing the name of this role.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -373,7 +387,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestRole_Permissions_" data-uid="Discord.Rest.RestRole.Permissions*"></a>
|
||||
<h4 id="Discord_Rest_RestRole_Permissions" data-uid="Discord.Rest.RestRole.Permissions">Permissions</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the permissions granted to members of this role.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -390,7 +405,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.GuildPermissions.html">GuildPermissions</a></td>
|
||||
<td></td>
|
||||
<td><p>A <a class="xref" href="Discord.GuildPermissions.html">GuildPermissions</a> struct that this role possesses.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -403,7 +419,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestRole_Position_" data-uid="Discord.Rest.RestRole.Position*"></a>
|
||||
<h4 id="Discord_Rest_RestRole_Position" data-uid="Discord.Rest.RestRole.Position">Position</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets this role's position relative to other roles in the same guild.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -420,7 +437,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Int32</span></td>
|
||||
<td></td>
|
||||
<td><p>An <span class="xref">System.Int32</span> representing the position of the role in the role list of the guild.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -482,7 +500,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestRole_DeleteAsync_" data-uid="Discord.Rest.RestRole.DeleteAsync*"></a>
|
||||
<h4 id="Discord_Rest_RestRole_DeleteAsync_Discord_RequestOptions_" data-uid="Discord.Rest.RestRole.DeleteAsync(Discord.RequestOptions)">DeleteAsync(RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Deletes this object and all its children.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -501,7 +520,8 @@
|
|||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -529,7 +549,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestRole_ModifyAsync_" data-uid="Discord.Rest.RestRole.ModifyAsync*"></a>
|
||||
<h4 id="Discord_Rest_RestRole_ModifyAsync_System_Action_Discord_RoleProperties__Discord_RequestOptions_" data-uid="Discord.Rest.RestRole.ModifyAsync(System.Action{Discord.RoleProperties},Discord.RequestOptions)">ModifyAsync(Action<RoleProperties>, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Modifies this role.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -548,12 +569,14 @@
|
|||
<tr>
|
||||
<td><span class="xref">System.Action</span><<a class="xref" href="Discord.RoleProperties.html">RoleProperties</a>></td>
|
||||
<td><span class="parametername">func</span></td>
|
||||
<td></td>
|
||||
<td><p>A delegate containing the properties to modify the role with.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -568,10 +591,15 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous modification operation.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 id="Discord_Rest_RestRole_ModifyAsync_System_Action_Discord_RoleProperties__Discord_RequestOptions__remarks">Remarks</h5>
|
||||
<div class="markdown level1 remarks"><p>This method modifies this role with the specified properties. To see an example of this
|
||||
method and what properties are available, please refer to <a class="xref" href="Discord.RoleProperties.html">RoleProperties</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_RestRole_ToString.md&value=---%0Auid%3A%20Discord.Rest.RestRole.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>
|
||||
|
|
@ -617,7 +645,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestRole_Discord_IRole_Guild_" data-uid="Discord.Rest.RestRole.Discord#IRole#Guild*"></a>
|
||||
<h4 id="Discord_Rest_RestRole_Discord_IRole_Guild" data-uid="Discord.Rest.RestRole.Discord#IRole#Guild">IRole.Guild</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the guild that owns this role.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -634,7 +663,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.IGuild.html">IGuild</a></td>
|
||||
<td></td>
|
||||
<td><p>A guild representing the parent guild of this role.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
|
|||
|
|
@ -182,7 +182,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestSelfUser_Email_" data-uid="Discord.Rest.RestSelfUser.Email*"></a>
|
||||
<h4 id="Discord_Rest_RestSelfUser_Email" data-uid="Discord.Rest.RestSelfUser.Email">Email</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the email associated with this user.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -212,7 +213,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestSelfUser_Flags_" data-uid="Discord.Rest.RestSelfUser.Flags*"></a>
|
||||
<h4 id="Discord_Rest_RestSelfUser_Flags" data-uid="Discord.Rest.RestSelfUser.Flags">Flags</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the flags that are applied to a user's account.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -229,10 +231,14 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.UserProperties.html">UserProperties</a></td>
|
||||
<td></td>
|
||||
<td><p>The value of flags for this user.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 id="Discord_Rest_RestSelfUser_Flags_remarks">Remarks</h5>
|
||||
<div class="markdown level1 remarks"><p>This value is determined by bitwise OR-ing <a class="xref" href="Discord.UserProperties.html">UserProperties</a> values together.</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_RestSelfUser_IsMfaEnabled.md&value=---%0Auid%3A%20Discord.Rest.RestSelfUser.IsMfaEnabled%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>
|
||||
|
|
@ -242,7 +248,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestSelfUser_IsMfaEnabled_" data-uid="Discord.Rest.RestSelfUser.IsMfaEnabled*"></a>
|
||||
<h4 id="Discord_Rest_RestSelfUser_IsMfaEnabled" data-uid="Discord.Rest.RestSelfUser.IsMfaEnabled">IsMfaEnabled</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Indicates whether or not this user has MFA enabled on their account.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -259,7 +266,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td></td>
|
||||
<td><p><code>true</code> if this user has enabled multi-factor authentication on their account; <code>false</code> if not.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -272,7 +280,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestSelfUser_IsVerified_" data-uid="Discord.Rest.RestSelfUser.IsVerified*"></a>
|
||||
<h4 id="Discord_Rest_RestSelfUser_IsVerified" data-uid="Discord.Rest.RestSelfUser.IsVerified">IsVerified</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Indicates whether or not this user has their email verified.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -289,7 +298,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td></td>
|
||||
<td><p><code>true</code> if this user's email has been verified; <code>false</code> if not.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -302,7 +312,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestSelfUser_Locale_" data-uid="Discord.Rest.RestSelfUser.Locale*"></a>
|
||||
<h4 id="Discord_Rest_RestSelfUser_Locale" data-uid="Discord.Rest.RestSelfUser.Locale">Locale</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the user's chosen language option.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -319,7 +330,9 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td></td>
|
||||
<td><p>The IETF language tag of the user's chosen region, if provided.
|
||||
For example, a locale of "English, US" is "en-US", "Chinese (Taiwan)" is "zh-TW", etc.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -332,7 +345,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestSelfUser_PremiumType_" data-uid="Discord.Rest.RestSelfUser.PremiumType*"></a>
|
||||
<h4 id="Discord_Rest_RestSelfUser_PremiumType" data-uid="Discord.Rest.RestSelfUser.PremiumType">PremiumType</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the type of Nitro subscription that is active on this user's account.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -349,10 +363,14 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.PremiumType.html">PremiumType</a></td>
|
||||
<td></td>
|
||||
<td><p>The type of Nitro subscription the user subscribes to, if any.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 id="Discord_Rest_RestSelfUser_PremiumType_remarks">Remarks</h5>
|
||||
<div class="markdown level1 remarks"><p>This information may only be available with the identify OAuth scope.</p>
|
||||
</div>
|
||||
<h3 id="methods">Methods
|
||||
</h3>
|
||||
<span class="small pull-right mobile-hide">
|
||||
|
|
@ -364,7 +382,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestSelfUser_ModifyAsync_" data-uid="Discord.Rest.RestSelfUser.ModifyAsync*"></a>
|
||||
<h4 id="Discord_Rest_RestSelfUser_ModifyAsync_System_Action_Discord_SelfUserProperties__Discord_RequestOptions_" data-uid="Discord.Rest.RestSelfUser.ModifyAsync(System.Action{Discord.SelfUserProperties},Discord.RequestOptions)">ModifyAsync(Action<SelfUserProperties>, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Modifies the user's properties.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -432,7 +451,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestSelfUser_UpdateAsync_" data-uid="Discord.Rest.RestSelfUser.UpdateAsync*"></a>
|
||||
<h4 id="Discord_Rest_RestSelfUser_UpdateAsync_Discord_RequestOptions_" data-uid="Discord.Rest.RestSelfUser.UpdateAsync(Discord.RequestOptions)">UpdateAsync(RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Updates this object's properties with its current state.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
|
|||
|
|
@ -232,7 +232,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestSystemMessage_Type_" data-uid="Discord.Rest.RestSystemMessage.Type*"></a>
|
||||
<h4 id="Discord_Rest_RestSystemMessage_Type" data-uid="Discord.Rest.RestSystemMessage.Type">Type</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the type of this system message.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
|
|||
File diff suppressed because it is too large
Load diff
|
|
@ -136,7 +136,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestUser_ActiveClients_" data-uid="Discord.Rest.RestUser.ActiveClients*"></a>
|
||||
<h4 id="Discord_Rest_RestUser_ActiveClients" data-uid="Discord.Rest.RestUser.ActiveClients">ActiveClients</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the set of clients where this user is currently active.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -166,7 +167,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestUser_Activity_" data-uid="Discord.Rest.RestUser.Activity*"></a>
|
||||
<h4 id="Discord_Rest_RestUser_Activity" data-uid="Discord.Rest.RestUser.Activity">Activity</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the activity this user is currently doing.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -196,7 +198,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestUser_AvatarId_" data-uid="Discord.Rest.RestUser.AvatarId*"></a>
|
||||
<h4 id="Discord_Rest_RestUser_AvatarId" data-uid="Discord.Rest.RestUser.AvatarId">AvatarId</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the identifier of this user's avatar.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -226,7 +229,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestUser_CreatedAt_" data-uid="Discord.Rest.RestUser.CreatedAt*"></a>
|
||||
<h4 id="Discord_Rest_RestUser_CreatedAt" data-uid="Discord.Rest.RestUser.CreatedAt">CreatedAt</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets when the snowflake was created.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -243,7 +247,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.DateTimeOffset</span></td>
|
||||
<td></td>
|
||||
<td><p>A <span class="xref">System.DateTimeOffset</span> representing when the entity was first created.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -256,7 +261,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestUser_Discriminator_" data-uid="Discord.Rest.RestUser.Discriminator*"></a>
|
||||
<h4 id="Discord_Rest_RestUser_Discriminator" data-uid="Discord.Rest.RestUser.Discriminator">Discriminator</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the per-username unique ID for this user.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -286,7 +292,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestUser_DiscriminatorValue_" data-uid="Discord.Rest.RestUser.DiscriminatorValue*"></a>
|
||||
<h4 id="Discord_Rest_RestUser_DiscriminatorValue" data-uid="Discord.Rest.RestUser.DiscriminatorValue">DiscriminatorValue</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the per-username unique ID for this user.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -316,7 +323,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestUser_IsBot_" data-uid="Discord.Rest.RestUser.IsBot*"></a>
|
||||
<h4 id="Discord_Rest_RestUser_IsBot" data-uid="Discord.Rest.RestUser.IsBot">IsBot</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a value that indicates whether this user is identified as a bot.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -333,10 +341,15 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td></td>
|
||||
<td><p><code>true</code> if the user is a bot application; otherwise <code>false</code>.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 id="Discord_Rest_RestUser_IsBot_remarks">Remarks</h5>
|
||||
<div class="markdown level1 remarks"><p>This property retrieves a value that indicates whether this user is a registered bot application
|
||||
(indicated by the blue BOT tag within the official chat client).</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_RestUser_IsWebhook.md&value=---%0Auid%3A%20Discord.Rest.RestUser.IsWebhook%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>
|
||||
|
|
@ -346,7 +359,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestUser_IsWebhook_" data-uid="Discord.Rest.RestUser.IsWebhook*"></a>
|
||||
<h4 id="Discord_Rest_RestUser_IsWebhook" data-uid="Discord.Rest.RestUser.IsWebhook">IsWebhook</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a value that indicates whether this user is a webhook user.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -363,7 +377,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td></td>
|
||||
<td><p><code>true</code> if the user is a webhook; otherwise <code>false</code>.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -376,7 +391,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestUser_Mention_" data-uid="Discord.Rest.RestUser.Mention*"></a>
|
||||
<h4 id="Discord_Rest_RestUser_Mention" data-uid="Discord.Rest.RestUser.Mention">Mention</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Returns a special string used to mention this object.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -393,7 +409,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td></td>
|
||||
<td><p>A string that is recognized by Discord as a mention (e.g. <@168693960628371456>).</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -406,7 +423,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestUser_Status_" data-uid="Discord.Rest.RestUser.Status*"></a>
|
||||
<h4 id="Discord_Rest_RestUser_Status" data-uid="Discord.Rest.RestUser.Status">Status</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the current status of this user.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -436,7 +454,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestUser_Username_" data-uid="Discord.Rest.RestUser.Username*"></a>
|
||||
<h4 id="Discord_Rest_RestUser_Username" data-uid="Discord.Rest.RestUser.Username">Username</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the username for this user.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -468,7 +487,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestUser_GetAvatarUrl_" data-uid="Discord.Rest.RestUser.GetAvatarUrl*"></a>
|
||||
<h4 id="Discord_Rest_RestUser_GetAvatarUrl_Discord_ImageFormat_System_UInt16_" data-uid="Discord.Rest.RestUser.GetAvatarUrl(Discord.ImageFormat,System.UInt16)">GetAvatarUrl(ImageFormat, UInt16)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the avatar URL for this user.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -487,12 +507,14 @@
|
|||
<tr>
|
||||
<td><a class="xref" href="Discord.ImageFormat.html">ImageFormat</a></td>
|
||||
<td><span class="parametername">format</span></td>
|
||||
<td></td>
|
||||
<td><p>The format to return.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.UInt16</span></td>
|
||||
<td><span class="parametername">size</span></td>
|
||||
<td></td>
|
||||
<td><p>The size of the image to return in. This can be any power of two between 16 and 2048.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -507,10 +529,17 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td></td>
|
||||
<td><p>A string representing the user's avatar URL; <code>null</code> if the user does not have an avatar in place.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 id="Discord_Rest_RestUser_GetAvatarUrl_Discord_ImageFormat_System_UInt16__remarks">Remarks</h5>
|
||||
<div class="markdown level1 remarks"><p>This property retrieves a URL for this user's avatar. In event that the user does not have a valid avatar
|
||||
(i.e. their avatar identifier is not set), this property will return <code>null</code>. If you wish to
|
||||
retrieve the default avatar for this user, consider using <a class="xref" href="Discord.IUser.html#Discord_IUser_GetDefaultAvatarUrl">GetDefaultAvatarUrl()</a> (see
|
||||
example).</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_RestUser_GetDefaultAvatarUrl.md&value=---%0Auid%3A%20Discord.Rest.RestUser.GetDefaultAvatarUrl%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>
|
||||
|
|
@ -520,7 +549,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestUser_GetDefaultAvatarUrl_" data-uid="Discord.Rest.RestUser.GetDefaultAvatarUrl*"></a>
|
||||
<h4 id="Discord_Rest_RestUser_GetDefaultAvatarUrl" data-uid="Discord.Rest.RestUser.GetDefaultAvatarUrl">GetDefaultAvatarUrl()</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the default avatar URL for this user.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -537,10 +567,16 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td></td>
|
||||
<td><p>A string representing the user's avatar URL.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 id="Discord_Rest_RestUser_GetDefaultAvatarUrl_remarks">Remarks</h5>
|
||||
<div class="markdown level1 remarks"><p>This property retrieves a URL for this user's default avatar generated by Discord (Discord logo followed
|
||||
by a random color as its background). This property will always return a value as it is calculated based
|
||||
on the user's <a class="xref" href="Discord.IUser.html#Discord_IUser_DiscriminatorValue">DiscriminatorValue</a> (<code>discriminator % 5</code>).</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_RestUser_GetOrCreateDMChannelAsync_Discord_RequestOptions_.md&value=---%0Auid%3A%20Discord.Rest.RestUser.GetOrCreateDMChannelAsync(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>
|
||||
|
|
@ -634,7 +670,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestUser_UpdateAsync_" data-uid="Discord.Rest.RestUser.UpdateAsync*"></a>
|
||||
<h4 id="Discord_Rest_RestUser_UpdateAsync_Discord_RequestOptions_" data-uid="Discord.Rest.RestUser.UpdateAsync(Discord.RequestOptions)">UpdateAsync(RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Updates this object's properties with its current state.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -683,7 +720,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestUser_Discord_IUser_GetOrCreateDMChannelAsync_" data-uid="Discord.Rest.RestUser.Discord#IUser#GetOrCreateDMChannelAsync*"></a>
|
||||
<h4 id="Discord_Rest_RestUser_Discord_IUser_GetOrCreateDMChannelAsync_Discord_RequestOptions_" data-uid="Discord.Rest.RestUser.Discord#IUser#GetOrCreateDMChannelAsync(Discord.RequestOptions)">IUser.GetOrCreateDMChannelAsync(RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the direct message channel of this user, or create one if it does not already exist.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -702,7 +740,8 @@
|
|||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -717,10 +756,22 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span><<a class="xref" href="Discord.IDMChannel.html">IDMChannel</a>></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous operation for getting or creating a DM channel. The task result
|
||||
contains the DM channel associated with this user.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 id="Discord_Rest_RestUser_Discord_IUser_GetOrCreateDMChannelAsync_Discord_RequestOptions__remarks">Remarks</h5>
|
||||
<div class="markdown level1 remarks"><p>This method is used to obtain or create a channel used to send a direct message.</p>
|
||||
<div class="WARNING"><h5>warning</h5><p>
|
||||
In event that the current user cannot send a message to the target user, a channel can and will
|
||||
still be created by Discord. However, attempting to send a message will yield a
|
||||
<span class="xref">Discord.Net.HttpException</span> with a 403 as its
|
||||
<span class="xref">Discord.Net.HttpException.HttpCode</span>. There are currently no official workarounds by
|
||||
Discord.
|
||||
</p></div>
|
||||
</div>
|
||||
<h3 id="implements">Implements</h3>
|
||||
<div>
|
||||
<a class="xref" href="Discord.IUser.html">IUser</a>
|
||||
|
|
|
|||
|
|
@ -129,7 +129,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestUserGuild_CreatedAt_" data-uid="Discord.Rest.RestUserGuild.CreatedAt*"></a>
|
||||
<h4 id="Discord_Rest_RestUserGuild_CreatedAt" data-uid="Discord.Rest.RestUserGuild.CreatedAt">CreatedAt</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets when the snowflake was created.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -146,7 +147,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.DateTimeOffset</span></td>
|
||||
<td></td>
|
||||
<td><p>A <span class="xref">System.DateTimeOffset</span> representing when the entity was first created.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -159,7 +161,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestUserGuild_IconUrl_" data-uid="Discord.Rest.RestUserGuild.IconUrl*"></a>
|
||||
<h4 id="Discord_Rest_RestUserGuild_IconUrl" data-uid="Discord.Rest.RestUserGuild.IconUrl">IconUrl</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the icon URL associated with this guild, or <code>null</code> if one is not set.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -189,7 +192,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestUserGuild_IsOwner_" data-uid="Discord.Rest.RestUserGuild.IsOwner*"></a>
|
||||
<h4 id="Discord_Rest_RestUserGuild_IsOwner" data-uid="Discord.Rest.RestUserGuild.IsOwner">IsOwner</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Returns <code>true</code> if the current user owns this guild.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -219,7 +223,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestUserGuild_Name_" data-uid="Discord.Rest.RestUserGuild.Name*"></a>
|
||||
<h4 id="Discord_Rest_RestUserGuild_Name" data-uid="Discord.Rest.RestUserGuild.Name">Name</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the name of this guild.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -249,7 +254,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestUserGuild_Permissions_" data-uid="Discord.Rest.RestUserGuild.Permissions*"></a>
|
||||
<h4 id="Discord_Rest_RestUserGuild_Permissions" data-uid="Discord.Rest.RestUserGuild.Permissions">Permissions</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Returns the current user's permissions for this guild.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -281,7 +287,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestUserGuild_DeleteAsync_" data-uid="Discord.Rest.RestUserGuild.DeleteAsync*"></a>
|
||||
<h4 id="Discord_Rest_RestUserGuild_DeleteAsync_Discord_RequestOptions_" data-uid="Discord.Rest.RestUserGuild.DeleteAsync(Discord.RequestOptions)">DeleteAsync(RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Deletes this object and all its children.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -300,7 +307,8 @@
|
|||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
|
|||
|
|
@ -202,7 +202,8 @@
|
|||
</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"></div>
|
||||
<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">
|
||||
|
|
@ -234,7 +235,8 @@
|
|||
</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"></div>
|
||||
<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">
|
||||
|
|
@ -251,7 +253,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Nullable</span><<span class="xref">System.DateTimeOffset</span>></td>
|
||||
<td></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>
|
||||
|
|
@ -266,7 +269,8 @@
|
|||
</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"></div>
|
||||
<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">
|
||||
|
|
@ -298,7 +302,8 @@
|
|||
</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"></div>
|
||||
<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">
|
||||
|
|
@ -315,7 +320,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td></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>
|
||||
|
|
@ -330,7 +336,8 @@
|
|||
</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"></div>
|
||||
<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">
|
||||
|
|
@ -347,7 +354,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td></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>
|
||||
|
|
@ -362,7 +370,8 @@
|
|||
</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"></div>
|
||||
<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">
|
||||
|
|
@ -379,7 +388,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td></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>
|
||||
|
|
@ -394,7 +404,8 @@
|
|||
</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"></div>
|
||||
<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">
|
||||
|
|
@ -411,7 +422,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Collections.Generic.IReadOnlyCollection</span><<span class="xref">System.UInt64</span>></td>
|
||||
<td></td>
|
||||
<td><p>A read-only collection of channel IDs.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -426,7 +438,8 @@
|
|||
</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"></div>
|
||||
<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">
|
||||
|
|
@ -443,7 +456,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Collections.Generic.IReadOnlyCollection</span><<span class="xref">System.UInt64</span>></td>
|
||||
<td></td>
|
||||
<td><p>A read-only collection of role IDs.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -458,7 +472,8 @@
|
|||
</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"></div>
|
||||
<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">
|
||||
|
|
@ -490,7 +505,8 @@
|
|||
</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"></div>
|
||||
<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">
|
||||
|
|
@ -524,7 +540,8 @@
|
|||
</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"></div>
|
||||
<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">
|
||||
|
|
@ -543,12 +560,14 @@
|
|||
<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></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></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -563,10 +582,15 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
||||
<td></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>
|
||||
|
|
@ -576,7 +600,8 @@
|
|||
</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"></div>
|
||||
<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">
|
||||
|
|
@ -595,12 +620,14 @@
|
|||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td><span class="parametername">suppressEmbeds</span></td>
|
||||
<td></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></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -615,10 +642,14 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
||||
<td></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>
|
||||
|
|
@ -628,7 +659,8 @@
|
|||
</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"></div>
|
||||
<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">
|
||||
|
|
@ -647,7 +679,8 @@
|
|||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -662,7 +695,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous operation for pinning this message.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -675,7 +709,8 @@
|
|||
</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"></div>
|
||||
<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">
|
||||
|
|
@ -694,27 +729,32 @@
|
|||
<tr>
|
||||
<td><a class="xref" href="Discord.TagHandling.html">TagHandling</a></td>
|
||||
<td><span class="parametername">userHandling</span></td>
|
||||
<td></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></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></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></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></td>
|
||||
<td><p>Determines how the emoji tag should be handled.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -814,7 +854,8 @@
|
|||
</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"></div>
|
||||
<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">
|
||||
|
|
@ -833,7 +874,8 @@
|
|||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -848,7 +890,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous operation for unpinning this message.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
|
|||
|
|
@ -213,7 +213,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestVoiceChannel_Bitrate_" data-uid="Discord.Rest.RestVoiceChannel.Bitrate*"></a>
|
||||
<h4 id="Discord_Rest_RestVoiceChannel_Bitrate" data-uid="Discord.Rest.RestVoiceChannel.Bitrate">Bitrate</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the bit-rate that the clients in this voice channel are requested to use.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -230,7 +231,9 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Int32</span></td>
|
||||
<td></td>
|
||||
<td><p>An <span class="xref">System.Int32</span> representing the bit-rate (bps) that this voice channel defines and requests the
|
||||
client(s) to use.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -243,7 +246,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestVoiceChannel_CategoryId_" data-uid="Discord.Rest.RestVoiceChannel.CategoryId*"></a>
|
||||
<h4 id="Discord_Rest_RestVoiceChannel_CategoryId" data-uid="Discord.Rest.RestVoiceChannel.CategoryId">CategoryId</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the parent (category) ID of this channel in the guild's channel list.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -260,7 +264,9 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Nullable</span><<span class="xref">System.UInt64</span>></td>
|
||||
<td></td>
|
||||
<td><p>A <span class="xref">System.UInt64</span> representing the snowflake identifier of the parent of this channel;
|
||||
<code>null</code> if none is set.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -273,7 +279,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestVoiceChannel_UserLimit_" data-uid="Discord.Rest.RestVoiceChannel.UserLimit*"></a>
|
||||
<h4 id="Discord_Rest_RestVoiceChannel_UserLimit" data-uid="Discord.Rest.RestVoiceChannel.UserLimit">UserLimit</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the max number of users allowed to be connected to this channel at once.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -290,7 +297,9 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Nullable</span><<span class="xref">System.Int32</span>></td>
|
||||
<td></td>
|
||||
<td><p>An <span class="xref">System.Int32</span> representing the maximum number of users that are allowed to be connected to this
|
||||
channel at once; <code>null</code> if a limit is not set.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -305,7 +314,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestVoiceChannel_CreateInviteAsync_" data-uid="Discord.Rest.RestVoiceChannel.CreateInviteAsync*"></a>
|
||||
<h4 id="Discord_Rest_RestVoiceChannel_CreateInviteAsync_System_Nullable_System_Int32__System_Nullable_System_Int32__System_Boolean_System_Boolean_Discord_RequestOptions_" data-uid="Discord.Rest.RestVoiceChannel.CreateInviteAsync(System.Nullable{System.Int32},System.Nullable{System.Int32},System.Boolean,System.Boolean,Discord.RequestOptions)">CreateInviteAsync(Nullable<Int32>, Nullable<Int32>, Boolean, Boolean, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Creates a new invite to this channel.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -324,27 +334,32 @@
|
|||
<tr>
|
||||
<td><span class="xref">System.Nullable</span><<span class="xref">System.Int32</span>></td>
|
||||
<td><span class="parametername">maxAge</span></td>
|
||||
<td></td>
|
||||
<td><p>The time (in seconds) until the invite expires. Set to <code>null</code> to never expire.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.Nullable</span><<span class="xref">System.Int32</span>></td>
|
||||
<td><span class="parametername">maxUses</span></td>
|
||||
<td></td>
|
||||
<td><p>The max amount of times this invite may be used. Set to <code>null</code> to have unlimited uses.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td><span class="parametername">isTemporary</span></td>
|
||||
<td></td>
|
||||
<td><p>If <code>true</code>, the user accepting this invite will be kicked from the guild after closing their client.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td><span class="parametername">isUnique</span></td>
|
||||
<td></td>
|
||||
<td><p>If <code>true</code>, don't try to reuse a similar invite (useful for creating many unique one time use invites).</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -359,7 +374,9 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span><<a class="xref" href="Discord.IInviteMetadata.html">IInviteMetadata</a>></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous invite creation operation. The task result contains an invite
|
||||
metadata object containing information for the created invite.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -423,7 +440,8 @@ representing the parent of this channel; <code>null</code> if none is set.</p>
|
|||
</span>
|
||||
<a id="Discord_Rest_RestVoiceChannel_GetInvitesAsync_" data-uid="Discord.Rest.RestVoiceChannel.GetInvitesAsync*"></a>
|
||||
<h4 id="Discord_Rest_RestVoiceChannel_GetInvitesAsync_Discord_RequestOptions_" data-uid="Discord.Rest.RestVoiceChannel.GetInvitesAsync(Discord.RequestOptions)">GetInvitesAsync(RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a collection of all invites to this channel.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -442,7 +460,8 @@ representing the parent of this channel; <code>null</code> if none is set.</p>
|
|||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -457,7 +476,9 @@ representing the parent of this channel; <code>null</code> if none is set.</p>
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span><<span class="xref">System.Collections.Generic.IReadOnlyCollection</span><<a class="xref" href="Discord.IInviteMetadata.html">IInviteMetadata</a>>></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous get operation. The task result contains a read-only collection
|
||||
of invite metadata that are created for this channel.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -470,7 +491,8 @@ representing the parent of this channel; <code>null</code> if none is set.</p>
|
|||
</span>
|
||||
<a id="Discord_Rest_RestVoiceChannel_ModifyAsync_" data-uid="Discord.Rest.RestVoiceChannel.ModifyAsync*"></a>
|
||||
<h4 id="Discord_Rest_RestVoiceChannel_ModifyAsync_System_Action_Discord_VoiceChannelProperties__Discord_RequestOptions_" data-uid="Discord.Rest.RestVoiceChannel.ModifyAsync(System.Action{Discord.VoiceChannelProperties},Discord.RequestOptions)">ModifyAsync(Action<VoiceChannelProperties>, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Modifies this voice channel.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -489,12 +511,14 @@ representing the parent of this channel; <code>null</code> if none is set.</p>
|
|||
<tr>
|
||||
<td><span class="xref">System.Action</span><<a class="xref" href="Discord.VoiceChannelProperties.html">VoiceChannelProperties</a>></td>
|
||||
<td><span class="parametername">func</span></td>
|
||||
<td></td>
|
||||
<td><p>The properties to modify the channel with.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -509,10 +533,15 @@ representing the parent of this channel; <code>null</code> if none is set.</p>
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous modification operation.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 id="Discord_Rest_RestVoiceChannel_ModifyAsync_System_Action_Discord_VoiceChannelProperties__Discord_RequestOptions__seealso">See Also</h5>
|
||||
<div class="seealso">
|
||||
<div><a class="xref" href="Discord.VoiceChannelProperties.html">VoiceChannelProperties</a></div>
|
||||
</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_RestVoiceChannel_SyncPermissionsAsync_Discord_RequestOptions_.md&value=---%0Auid%3A%20Discord.Rest.RestVoiceChannel.SyncPermissionsAsync(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>
|
||||
|
|
@ -522,7 +551,8 @@ representing the parent of this channel; <code>null</code> if none is set.</p>
|
|||
</span>
|
||||
<a id="Discord_Rest_RestVoiceChannel_SyncPermissionsAsync_" data-uid="Discord.Rest.RestVoiceChannel.SyncPermissionsAsync*"></a>
|
||||
<h4 id="Discord_Rest_RestVoiceChannel_SyncPermissionsAsync_Discord_RequestOptions_" data-uid="Discord.Rest.RestVoiceChannel.SyncPermissionsAsync(Discord.RequestOptions)">SyncPermissionsAsync(RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Syncs the permissions of this nested channel with its parent's.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -541,7 +571,8 @@ representing the parent of this channel; <code>null</code> if none is set.</p>
|
|||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -556,7 +587,8 @@ representing the parent of this channel; <code>null</code> if none is set.</p>
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous operation for syncing channel permissions with its parent's.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -571,7 +603,8 @@ representing the parent of this channel; <code>null</code> if none is set.</p>
|
|||
</span>
|
||||
<a id="Discord_Rest_RestVoiceChannel_Discord_IAudioChannel_ConnectAsync_" data-uid="Discord.Rest.RestVoiceChannel.Discord#IAudioChannel#ConnectAsync*"></a>
|
||||
<h4 id="Discord_Rest_RestVoiceChannel_Discord_IAudioChannel_ConnectAsync_System_Boolean_System_Boolean_System_Boolean_" data-uid="Discord.Rest.RestVoiceChannel.Discord#IAudioChannel#ConnectAsync(System.Boolean,System.Boolean,System.Boolean)">IAudioChannel.ConnectAsync(Boolean, Boolean, Boolean)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Connects to this audio channel.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -590,17 +623,20 @@ representing the parent of this channel; <code>null</code> if none is set.</p>
|
|||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td><span class="parametername">selfDeaf</span></td>
|
||||
<td></td>
|
||||
<td><p>Determines whether the client should deaf itself upon connection.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td><span class="parametername">selfMute</span></td>
|
||||
<td></td>
|
||||
<td><p>Determines whether the client should mute itself upon connection.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td><span class="parametername">external</span></td>
|
||||
<td></td>
|
||||
<td><p>Determines whether the audio client is an external one or not.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -615,7 +651,9 @@ representing the parent of this channel; <code>null</code> if none is set.</p>
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span><<a class="xref" href="Discord.Audio.IAudioClient.html">IAudioClient</a>></td>
|
||||
<td></td>
|
||||
<td><p>A task representing the asynchronous connection operation. The task result contains the
|
||||
<a class="xref" href="Discord.Audio.IAudioClient.html">IAudioClient</a> responsible for the connection.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -674,7 +712,8 @@ representing the parent of this channel; <code>null</code> if none is set.</p>
|
|||
</span>
|
||||
<a id="Discord_Rest_RestVoiceChannel_Discord_IGuildChannel_GetUserAsync_" data-uid="Discord.Rest.RestVoiceChannel.Discord#IGuildChannel#GetUserAsync*"></a>
|
||||
<h4 id="Discord_Rest_RestVoiceChannel_Discord_IGuildChannel_GetUserAsync_System_UInt64_Discord_CacheMode_Discord_RequestOptions_" data-uid="Discord.Rest.RestVoiceChannel.Discord#IGuildChannel#GetUserAsync(System.UInt64,Discord.CacheMode,Discord.RequestOptions)">IGuildChannel.GetUserAsync(UInt64, CacheMode, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a user in this channel.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -693,17 +732,20 @@ representing the parent of this channel; <code>null</code> if none is set.</p>
|
|||
<tr>
|
||||
<td><span class="xref">System.UInt64</span></td>
|
||||
<td><span class="parametername">id</span></td>
|
||||
<td></td>
|
||||
<td><p>The snowflake identifier of the user.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.CacheMode.html">CacheMode</a></td>
|
||||
<td><span class="parametername">mode</span></td>
|
||||
<td></td>
|
||||
<td><p>The <a class="xref" href="Discord.CacheMode.html">CacheMode</a> that determines whether the object should be fetched from cache.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -718,7 +760,9 @@ representing the parent of this channel; <code>null</code> if none is set.</p>
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span><<a class="xref" href="Discord.IGuildUser.html">IGuildUser</a>></td>
|
||||
<td></td>
|
||||
<td><p>A task representing the asynchronous get operation. The task result contains a guild user object that
|
||||
represents the user; <code>null</code> if none is found.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -731,7 +775,8 @@ representing the parent of this channel; <code>null</code> if none is set.</p>
|
|||
</span>
|
||||
<a id="Discord_Rest_RestVoiceChannel_Discord_IGuildChannel_GetUsersAsync_" data-uid="Discord.Rest.RestVoiceChannel.Discord#IGuildChannel#GetUsersAsync*"></a>
|
||||
<h4 id="Discord_Rest_RestVoiceChannel_Discord_IGuildChannel_GetUsersAsync_Discord_CacheMode_Discord_RequestOptions_" data-uid="Discord.Rest.RestVoiceChannel.Discord#IGuildChannel#GetUsersAsync(Discord.CacheMode,Discord.RequestOptions)">IGuildChannel.GetUsersAsync(CacheMode, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a collection of users that are able to view the channel or are currently in this channel.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -750,12 +795,14 @@ representing the parent of this channel; <code>null</code> if none is set.</p>
|
|||
<tr>
|
||||
<td><a class="xref" href="Discord.CacheMode.html">CacheMode</a></td>
|
||||
<td><span class="parametername">mode</span></td>
|
||||
<td></td>
|
||||
<td><p>The <a class="xref" href="Discord.CacheMode.html">CacheMode</a> that determines whether the object should be fetched from cache.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -770,10 +817,15 @@ representing the parent of this channel; <code>null</code> if none is set.</p>
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Collections.Generic.IAsyncEnumerable</span><<span class="xref">System.Collections.Generic.IReadOnlyCollection</span><<a class="xref" href="Discord.IGuildUser.html">IGuildUser</a>>></td>
|
||||
<td></td>
|
||||
<td><p>Paged collection of users.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 id="Discord_Rest_RestVoiceChannel_Discord_IGuildChannel_GetUsersAsync_Discord_CacheMode_Discord_RequestOptions__remarks">Remarks</h5>
|
||||
<div class="markdown level1 remarks"><p>This method follows the same behavior as described in <a class="xref" href="Discord.IChannel.html#Discord_IChannel_GetUsersAsync_Discord_CacheMode_Discord_RequestOptions_">GetUsersAsync(CacheMode, RequestOptions)</a>.
|
||||
Please visit its documentation for more details on this method.</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_RestVoiceChannel_Discord_INestedChannel_GetCategoryAsync_Discord_CacheMode_Discord_RequestOptions_.md&value=---%0Auid%3A%20Discord.Rest.RestVoiceChannel.Discord%23INestedChannel%23GetCategoryAsync(Discord.CacheMode%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>
|
||||
|
|
@ -783,7 +835,8 @@ representing the parent of this channel; <code>null</code> if none is set.</p>
|
|||
</span>
|
||||
<a id="Discord_Rest_RestVoiceChannel_Discord_INestedChannel_GetCategoryAsync_" data-uid="Discord.Rest.RestVoiceChannel.Discord#INestedChannel#GetCategoryAsync*"></a>
|
||||
<h4 id="Discord_Rest_RestVoiceChannel_Discord_INestedChannel_GetCategoryAsync_Discord_CacheMode_Discord_RequestOptions_" data-uid="Discord.Rest.RestVoiceChannel.Discord#INestedChannel#GetCategoryAsync(Discord.CacheMode,Discord.RequestOptions)">INestedChannel.GetCategoryAsync(CacheMode, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the parent (category) channel of this channel.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -802,12 +855,14 @@ representing the parent of this channel; <code>null</code> if none is set.</p>
|
|||
<tr>
|
||||
<td><a class="xref" href="Discord.CacheMode.html">CacheMode</a></td>
|
||||
<td><span class="parametername">mode</span></td>
|
||||
<td></td>
|
||||
<td><p>The <a class="xref" href="Discord.CacheMode.html">CacheMode</a> that determines whether the object should be fetched from cache.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -822,7 +877,9 @@ representing the parent of this channel; <code>null</code> if none is set.</p>
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span><<a class="xref" href="Discord.ICategoryChannel.html">ICategoryChannel</a>></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous get operation. The task result contains the category channel
|
||||
representing the parent of this channel; <code>null</code> if none is set.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
|
|||
|
|
@ -128,7 +128,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestVoiceRegion_IsCustom_" data-uid="Discord.Rest.RestVoiceRegion.IsCustom*"></a>
|
||||
<h4 id="Discord_Rest_RestVoiceRegion_IsCustom" data-uid="Discord.Rest.RestVoiceRegion.IsCustom">IsCustom</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a value that indicates whether this voice region is custom-made for events.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -145,7 +146,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td></td>
|
||||
<td><p><code>true</code> if this is a custom voice region (used for events/etc); otherwise <code>false</code>/</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -158,7 +160,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestVoiceRegion_IsDeprecated_" data-uid="Discord.Rest.RestVoiceRegion.IsDeprecated*"></a>
|
||||
<h4 id="Discord_Rest_RestVoiceRegion_IsDeprecated" data-uid="Discord.Rest.RestVoiceRegion.IsDeprecated">IsDeprecated</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a value that indicates whether this voice region is no longer being maintained.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -175,7 +178,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td></td>
|
||||
<td><p><code>true</code> if this is a deprecated voice region; otherwise <code>false</code>.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -188,7 +192,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestVoiceRegion_IsOptimal_" data-uid="Discord.Rest.RestVoiceRegion.IsOptimal*"></a>
|
||||
<h4 id="Discord_Rest_RestVoiceRegion_IsOptimal" data-uid="Discord.Rest.RestVoiceRegion.IsOptimal">IsOptimal</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a value that indicates whether this voice region is optimal for your client in terms of latency.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -205,7 +210,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td></td>
|
||||
<td><p><code>true</code> if this voice region is the closest to your machine; otherwise <code>false</code> .</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -218,7 +224,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestVoiceRegion_IsVip_" data-uid="Discord.Rest.RestVoiceRegion.IsVip*"></a>
|
||||
<h4 id="Discord_Rest_RestVoiceRegion_IsVip" data-uid="Discord.Rest.RestVoiceRegion.IsVip">IsVip</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a value that indicates whether or not this voice region is exclusive to partnered servers.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -235,7 +242,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td></td>
|
||||
<td><p><code>true</code> if this voice region is exclusive to VIP accounts; otherwise <code>false</code>.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -248,7 +256,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestVoiceRegion_Name_" data-uid="Discord.Rest.RestVoiceRegion.Name*"></a>
|
||||
<h4 id="Discord_Rest_RestVoiceRegion_Name" data-uid="Discord.Rest.RestVoiceRegion.Name">Name</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the name of this voice region.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -265,7 +274,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td></td>
|
||||
<td><p>A string that represents the human-readable name of this voice region (e.g. <code>Central Europe</code>).</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
|
|||
|
|
@ -130,7 +130,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestWebhook_AvatarId_" data-uid="Discord.Rest.RestWebhook.AvatarId*"></a>
|
||||
<h4 id="Discord_Rest_RestWebhook_AvatarId" data-uid="Discord.Rest.RestWebhook.AvatarId">AvatarId</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the ID of this webhook's default avatar.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -160,7 +161,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestWebhook_ChannelId_" data-uid="Discord.Rest.RestWebhook.ChannelId*"></a>
|
||||
<h4 id="Discord_Rest_RestWebhook_ChannelId" data-uid="Discord.Rest.RestWebhook.ChannelId">ChannelId</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the ID of the channel for this webhook.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -190,7 +192,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestWebhook_CreatedAt_" data-uid="Discord.Rest.RestWebhook.CreatedAt*"></a>
|
||||
<h4 id="Discord_Rest_RestWebhook_CreatedAt" data-uid="Discord.Rest.RestWebhook.CreatedAt">CreatedAt</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets when the snowflake was created.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -207,7 +210,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.DateTimeOffset</span></td>
|
||||
<td></td>
|
||||
<td><p>A <span class="xref">System.DateTimeOffset</span> representing when the entity was first created.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -220,7 +224,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestWebhook_Creator_" data-uid="Discord.Rest.RestWebhook.Creator*"></a>
|
||||
<h4 id="Discord_Rest_RestWebhook_Creator" data-uid="Discord.Rest.RestWebhook.Creator">Creator</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the user that created this webhook.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -250,7 +255,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestWebhook_GuildId_" data-uid="Discord.Rest.RestWebhook.GuildId*"></a>
|
||||
<h4 id="Discord_Rest_RestWebhook_GuildId" data-uid="Discord.Rest.RestWebhook.GuildId">GuildId</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the ID of the guild owning this webhook.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -280,7 +286,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestWebhook_Name_" data-uid="Discord.Rest.RestWebhook.Name*"></a>
|
||||
<h4 id="Discord_Rest_RestWebhook_Name" data-uid="Discord.Rest.RestWebhook.Name">Name</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the default name of this webhook.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -310,7 +317,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestWebhook_Token_" data-uid="Discord.Rest.RestWebhook.Token*"></a>
|
||||
<h4 id="Discord_Rest_RestWebhook_Token" data-uid="Discord.Rest.RestWebhook.Token">Token</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the token of this webhook.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -342,7 +350,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestWebhook_DeleteAsync_" data-uid="Discord.Rest.RestWebhook.DeleteAsync*"></a>
|
||||
<h4 id="Discord_Rest_RestWebhook_DeleteAsync_Discord_RequestOptions_" data-uid="Discord.Rest.RestWebhook.DeleteAsync(Discord.RequestOptions)">DeleteAsync(RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Deletes this object and all its children.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -361,7 +370,8 @@
|
|||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -389,7 +399,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestWebhook_GetAvatarUrl_" data-uid="Discord.Rest.RestWebhook.GetAvatarUrl*"></a>
|
||||
<h4 id="Discord_Rest_RestWebhook_GetAvatarUrl_Discord_ImageFormat_System_UInt16_" data-uid="Discord.Rest.RestWebhook.GetAvatarUrl(Discord.ImageFormat,System.UInt16)">GetAvatarUrl(ImageFormat, UInt16)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the URL to this webhook's default avatar.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -525,7 +536,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestWebhook_UpdateAsync_" data-uid="Discord.Rest.RestWebhook.UpdateAsync*"></a>
|
||||
<h4 id="Discord_Rest_RestWebhook_UpdateAsync_Discord_RequestOptions_" data-uid="Discord.Rest.RestWebhook.UpdateAsync(Discord.RequestOptions)">UpdateAsync(RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Updates this object's properties with its current state.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -574,7 +586,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestWebhook_Discord_IWebhook_Channel_" data-uid="Discord.Rest.RestWebhook.Discord#IWebhook#Channel*"></a>
|
||||
<h4 id="Discord_Rest_RestWebhook_Discord_IWebhook_Channel" data-uid="Discord.Rest.RestWebhook.Discord#IWebhook#Channel">IWebhook.Channel</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the channel for this webhook.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -604,7 +617,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestWebhook_Discord_IWebhook_Guild_" data-uid="Discord.Rest.RestWebhook.Discord#IWebhook#Guild*"></a>
|
||||
<h4 id="Discord_Rest_RestWebhook_Discord_IWebhook_Guild" data-uid="Discord.Rest.RestWebhook.Discord#IWebhook#Guild">IWebhook.Guild</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the guild owning this webhook.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -634,7 +648,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestWebhook_Discord_IWebhook_ModifyAsync_" data-uid="Discord.Rest.RestWebhook.Discord#IWebhook#ModifyAsync*"></a>
|
||||
<h4 id="Discord_Rest_RestWebhook_Discord_IWebhook_ModifyAsync_System_Action_Discord_WebhookProperties__Discord_RequestOptions_" data-uid="Discord.Rest.RestWebhook.Discord#IWebhook#ModifyAsync(System.Action{Discord.WebhookProperties},Discord.RequestOptions)">IWebhook.ModifyAsync(Action<WebhookProperties>, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Modifies this webhook.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
|
|||
|
|
@ -183,7 +183,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestWebhookUser_GuildId_" data-uid="Discord.Rest.RestWebhookUser.GuildId*"></a>
|
||||
<h4 id="Discord_Rest_RestWebhookUser_GuildId" data-uid="Discord.Rest.RestWebhookUser.GuildId">GuildId</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the ID of the guild for this user.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -200,7 +201,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.UInt64</span></td>
|
||||
<td></td>
|
||||
<td><p>An <span class="xref">System.UInt64</span> representing the snowflake identifier of the guild that this user belongs to.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -213,7 +215,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestWebhookUser_IsWebhook_" data-uid="Discord.Rest.RestWebhookUser.IsWebhook*"></a>
|
||||
<h4 id="Discord_Rest_RestWebhookUser_IsWebhook" data-uid="Discord.Rest.RestWebhookUser.IsWebhook">IsWebhook</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a value that indicates whether this user is a webhook user.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -230,7 +233,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td></td>
|
||||
<td><p><code>true</code> if the user is a webhook; otherwise <code>false</code>.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -245,7 +249,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestWebhookUser_PremiumSince_" data-uid="Discord.Rest.RestWebhookUser.PremiumSince*"></a>
|
||||
<h4 id="Discord_Rest_RestWebhookUser_PremiumSince" data-uid="Discord.Rest.RestWebhookUser.PremiumSince">PremiumSince</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the date and time for when this user's guild boost began.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -262,7 +267,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Nullable</span><<span class="xref">System.DateTimeOffset</span>></td>
|
||||
<td></td>
|
||||
<td><p>A <span class="xref">System.DateTimeOffset</span> for when the user began boosting this guild; <code>null</code> if they are not boosting the guild.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -275,7 +281,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestWebhookUser_WebhookId_" data-uid="Discord.Rest.RestWebhookUser.WebhookId*"></a>
|
||||
<h4 id="Discord_Rest_RestWebhookUser_WebhookId" data-uid="Discord.Rest.RestWebhookUser.WebhookId">WebhookId</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the ID of a webhook.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -307,7 +314,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestWebhookUser_Discord_IGuildUser_AddRoleAsync_" data-uid="Discord.Rest.RestWebhookUser.Discord#IGuildUser#AddRoleAsync*"></a>
|
||||
<h4 id="Discord_Rest_RestWebhookUser_Discord_IGuildUser_AddRoleAsync_Discord_IRole_Discord_RequestOptions_" data-uid="Discord.Rest.RestWebhookUser.Discord#IGuildUser#AddRoleAsync(Discord.IRole,Discord.RequestOptions)">IGuildUser.AddRoleAsync(IRole, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Adds the specified role to this user in the guild.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -326,12 +334,14 @@
|
|||
<tr>
|
||||
<td><a class="xref" href="Discord.IRole.html">IRole</a></td>
|
||||
<td><span class="parametername">role</span></td>
|
||||
<td></td>
|
||||
<td><p>The role to be added to the user.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -346,7 +356,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous role addition operation.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -359,7 +370,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestWebhookUser_Discord_IGuildUser_AddRolesAsync_" data-uid="Discord.Rest.RestWebhookUser.Discord#IGuildUser#AddRolesAsync*"></a>
|
||||
<h4 id="Discord_Rest_RestWebhookUser_Discord_IGuildUser_AddRolesAsync_System_Collections_Generic_IEnumerable_Discord_IRole__Discord_RequestOptions_" data-uid="Discord.Rest.RestWebhookUser.Discord#IGuildUser#AddRolesAsync(System.Collections.Generic.IEnumerable{Discord.IRole},Discord.RequestOptions)">IGuildUser.AddRolesAsync(IEnumerable<IRole>, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Adds the specified <code data-dev-comment-type="paramref" class="paramref">roles</code> to this user in the guild.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -378,12 +390,14 @@
|
|||
<tr>
|
||||
<td><span class="xref">System.Collections.Generic.IEnumerable</span><<a class="xref" href="Discord.IRole.html">IRole</a>></td>
|
||||
<td><span class="parametername">roles</span></td>
|
||||
<td></td>
|
||||
<td><p>The roles to be added to the user.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -398,7 +412,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous role addition operation.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -411,7 +426,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestWebhookUser_Discord_IGuildUser_GetPermissions_" data-uid="Discord.Rest.RestWebhookUser.Discord#IGuildUser#GetPermissions*"></a>
|
||||
<h4 id="Discord_Rest_RestWebhookUser_Discord_IGuildUser_GetPermissions_Discord_IGuildChannel_" data-uid="Discord.Rest.RestWebhookUser.Discord#IGuildUser#GetPermissions(Discord.IGuildChannel)">IGuildUser.GetPermissions(IGuildChannel)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the level permissions granted to this user to a given channel.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -430,7 +446,8 @@
|
|||
<tr>
|
||||
<td><a class="xref" href="Discord.IGuildChannel.html">IGuildChannel</a></td>
|
||||
<td><span class="parametername">channel</span></td>
|
||||
<td></td>
|
||||
<td><p>The channel to get the permission from.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -445,7 +462,9 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.ChannelPermissions.html">ChannelPermissions</a></td>
|
||||
<td></td>
|
||||
<td><p>A <a class="xref" href="Discord.ChannelPermissions.html">ChannelPermissions</a> structure representing the permissions that a user has in the
|
||||
specified channel.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -458,7 +477,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestWebhookUser_Discord_IGuildUser_Guild_" data-uid="Discord.Rest.RestWebhookUser.Discord#IGuildUser#Guild*"></a>
|
||||
<h4 id="Discord_Rest_RestWebhookUser_Discord_IGuildUser_Guild" data-uid="Discord.Rest.RestWebhookUser.Discord#IGuildUser#Guild">IGuildUser.Guild</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the guild for this user.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -475,7 +495,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.IGuild.html">IGuild</a></td>
|
||||
<td></td>
|
||||
<td><p>A guild object that this user belongs to.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -488,7 +509,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestWebhookUser_Discord_IGuildUser_GuildPermissions_" data-uid="Discord.Rest.RestWebhookUser.Discord#IGuildUser#GuildPermissions*"></a>
|
||||
<h4 id="Discord_Rest_RestWebhookUser_Discord_IGuildUser_GuildPermissions" data-uid="Discord.Rest.RestWebhookUser.Discord#IGuildUser#GuildPermissions">IGuildUser.GuildPermissions</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the guild-level permissions for this user.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -505,7 +527,9 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.GuildPermissions.html">GuildPermissions</a></td>
|
||||
<td></td>
|
||||
<td><p>A <a class="xref" href="Discord.GuildPermissions.html">GuildPermissions</a> structure for this user, representing what
|
||||
permissions this user has in the guild.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -518,7 +542,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestWebhookUser_Discord_IGuildUser_JoinedAt_" data-uid="Discord.Rest.RestWebhookUser.Discord#IGuildUser#JoinedAt*"></a>
|
||||
<h4 id="Discord_Rest_RestWebhookUser_Discord_IGuildUser_JoinedAt" data-uid="Discord.Rest.RestWebhookUser.Discord#IGuildUser#JoinedAt">IGuildUser.JoinedAt</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets when this user joined the guild.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -535,7 +560,9 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Nullable</span><<span class="xref">System.DateTimeOffset</span>></td>
|
||||
<td></td>
|
||||
<td><p>A <span class="xref">System.DateTimeOffset</span> representing the time of which the user has joined the guild;
|
||||
<code>null</code> when it cannot be obtained.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -548,7 +575,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestWebhookUser_Discord_IGuildUser_KickAsync_" data-uid="Discord.Rest.RestWebhookUser.Discord#IGuildUser#KickAsync*"></a>
|
||||
<h4 id="Discord_Rest_RestWebhookUser_Discord_IGuildUser_KickAsync_System_String_Discord_RequestOptions_" data-uid="Discord.Rest.RestWebhookUser.Discord#IGuildUser#KickAsync(System.String,Discord.RequestOptions)">IGuildUser.KickAsync(String, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Kicks this user from this guild.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -567,12 +595,14 @@
|
|||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td><span class="parametername">reason</span></td>
|
||||
<td></td>
|
||||
<td><p>The reason for the kick which will be recorded in the audit log.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -587,7 +617,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous kick operation.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -600,7 +631,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestWebhookUser_Discord_IGuildUser_ModifyAsync_" data-uid="Discord.Rest.RestWebhookUser.Discord#IGuildUser#ModifyAsync*"></a>
|
||||
<h4 id="Discord_Rest_RestWebhookUser_Discord_IGuildUser_ModifyAsync_System_Action_Discord_GuildUserProperties__Discord_RequestOptions_" data-uid="Discord.Rest.RestWebhookUser.Discord#IGuildUser#ModifyAsync(System.Action{Discord.GuildUserProperties},Discord.RequestOptions)">IGuildUser.ModifyAsync(Action<GuildUserProperties>, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Modifies this user's properties in this guild.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -619,12 +651,14 @@
|
|||
<tr>
|
||||
<td><span class="xref">System.Action</span><<a class="xref" href="Discord.GuildUserProperties.html">GuildUserProperties</a>></td>
|
||||
<td><span class="parametername">func</span></td>
|
||||
<td></td>
|
||||
<td><p>The delegate containing the properties to modify the user with.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -639,10 +673,15 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous modification operation.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 id="Discord_Rest_RestWebhookUser_Discord_IGuildUser_ModifyAsync_System_Action_Discord_GuildUserProperties__Discord_RequestOptions__remarks">Remarks</h5>
|
||||
<div class="markdown level1 remarks"><p>This method modifies the current guild user with the specified properties. To see an example of this
|
||||
method and what properties are available, please refer to <a class="xref" href="Discord.GuildUserProperties.html">GuildUserProperties</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_RestWebhookUser_Discord_IGuildUser_Nickname.md&value=---%0Auid%3A%20Discord.Rest.RestWebhookUser.Discord%23IGuildUser%23Nickname%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>
|
||||
|
|
@ -652,7 +691,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestWebhookUser_Discord_IGuildUser_Nickname_" data-uid="Discord.Rest.RestWebhookUser.Discord#IGuildUser#Nickname*"></a>
|
||||
<h4 id="Discord_Rest_RestWebhookUser_Discord_IGuildUser_Nickname" data-uid="Discord.Rest.RestWebhookUser.Discord#IGuildUser#Nickname">IGuildUser.Nickname</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the nickname for this user.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -669,7 +709,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td></td>
|
||||
<td><p>A string representing the nickname of the user; <code>null</code> if none is set.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -682,7 +723,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestWebhookUser_Discord_IGuildUser_RemoveRoleAsync_" data-uid="Discord.Rest.RestWebhookUser.Discord#IGuildUser#RemoveRoleAsync*"></a>
|
||||
<h4 id="Discord_Rest_RestWebhookUser_Discord_IGuildUser_RemoveRoleAsync_Discord_IRole_Discord_RequestOptions_" data-uid="Discord.Rest.RestWebhookUser.Discord#IGuildUser#RemoveRoleAsync(Discord.IRole,Discord.RequestOptions)">IGuildUser.RemoveRoleAsync(IRole, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Removes the specified <code data-dev-comment-type="paramref" class="paramref">role</code> from this user in the guild.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -701,12 +743,14 @@
|
|||
<tr>
|
||||
<td><a class="xref" href="Discord.IRole.html">IRole</a></td>
|
||||
<td><span class="parametername">role</span></td>
|
||||
<td></td>
|
||||
<td><p>The role to be removed from the user.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -721,7 +765,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous role removal operation.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -734,7 +779,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestWebhookUser_Discord_IGuildUser_RemoveRolesAsync_" data-uid="Discord.Rest.RestWebhookUser.Discord#IGuildUser#RemoveRolesAsync*"></a>
|
||||
<h4 id="Discord_Rest_RestWebhookUser_Discord_IGuildUser_RemoveRolesAsync_System_Collections_Generic_IEnumerable_Discord_IRole__Discord_RequestOptions_" data-uid="Discord.Rest.RestWebhookUser.Discord#IGuildUser#RemoveRolesAsync(System.Collections.Generic.IEnumerable{Discord.IRole},Discord.RequestOptions)">IGuildUser.RemoveRolesAsync(IEnumerable<IRole>, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Removes the specified <code data-dev-comment-type="paramref" class="paramref">roles</code> from this user in the guild.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -753,12 +799,14 @@
|
|||
<tr>
|
||||
<td><span class="xref">System.Collections.Generic.IEnumerable</span><<a class="xref" href="Discord.IRole.html">IRole</a>></td>
|
||||
<td><span class="parametername">roles</span></td>
|
||||
<td></td>
|
||||
<td><p>The roles to be removed from the user.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -773,7 +821,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous role removal operation.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -786,7 +835,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestWebhookUser_Discord_IGuildUser_RoleIds_" data-uid="Discord.Rest.RestWebhookUser.Discord#IGuildUser#RoleIds*"></a>
|
||||
<h4 id="Discord_Rest_RestWebhookUser_Discord_IGuildUser_RoleIds" data-uid="Discord.Rest.RestWebhookUser.Discord#IGuildUser#RoleIds">IGuildUser.RoleIds</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a collection of IDs for the roles that this user currently possesses in the guild.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -803,10 +853,17 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Collections.Generic.IReadOnlyCollection</span><<span class="xref">System.UInt64</span>></td>
|
||||
<td></td>
|
||||
<td><p>A read-only collection of <span class="xref">System.UInt64</span>, each representing a snowflake identifier for a role that
|
||||
this user possesses.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 id="Discord_Rest_RestWebhookUser_Discord_IGuildUser_RoleIds_remarks">Remarks</h5>
|
||||
<div class="markdown level1 remarks"><p>This property returns a read-only collection of the identifiers of the roles that this user possesses.
|
||||
For WebSocket users, a Roles property can be found in place of this property. Due to the REST
|
||||
implementation, only a collection of identifiers can be retrieved instead of the full role objects.</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_RestWebhookUser_Discord_IVoiceState_IsDeafened.md&value=---%0Auid%3A%20Discord.Rest.RestWebhookUser.Discord%23IVoiceState%23IsDeafened%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>
|
||||
|
|
@ -816,7 +873,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestWebhookUser_Discord_IVoiceState_IsDeafened_" data-uid="Discord.Rest.RestWebhookUser.Discord#IVoiceState#IsDeafened*"></a>
|
||||
<h4 id="Discord_Rest_RestWebhookUser_Discord_IVoiceState_IsDeafened" data-uid="Discord.Rest.RestWebhookUser.Discord#IVoiceState#IsDeafened">IVoiceState.IsDeafened</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a value that indicates whether this user is deafened by the guild.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -833,7 +891,9 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td></td>
|
||||
<td><p><code>true</code> if the user is deafened (i.e. not permitted to listen to or speak to others) by the guild;
|
||||
otherwise <code>false</code>.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -846,7 +906,9 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestWebhookUser_Discord_IVoiceState_IsMuted_" data-uid="Discord.Rest.RestWebhookUser.Discord#IVoiceState#IsMuted*"></a>
|
||||
<h4 id="Discord_Rest_RestWebhookUser_Discord_IVoiceState_IsMuted" data-uid="Discord.Rest.RestWebhookUser.Discord#IVoiceState#IsMuted">IVoiceState.IsMuted</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a value that indicates whether this user is muted (i.e. not permitted to speak via voice) by the
|
||||
guild.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -863,7 +925,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td></td>
|
||||
<td><p><code>true</code> if this user is muted by the guild; otherwise <code>false</code>.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -876,7 +939,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestWebhookUser_Discord_IVoiceState_IsSelfDeafened_" data-uid="Discord.Rest.RestWebhookUser.Discord#IVoiceState#IsSelfDeafened*"></a>
|
||||
<h4 id="Discord_Rest_RestWebhookUser_Discord_IVoiceState_IsSelfDeafened" data-uid="Discord.Rest.RestWebhookUser.Discord#IVoiceState#IsSelfDeafened">IVoiceState.IsSelfDeafened</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a value that indicates whether this user has marked themselves as deafened.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -893,7 +957,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td></td>
|
||||
<td><p><code>true</code> if this user has deafened themselves (i.e. not permitted to listen to or speak to others); otherwise <code>false</code>.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -906,7 +971,9 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestWebhookUser_Discord_IVoiceState_IsSelfMuted_" data-uid="Discord.Rest.RestWebhookUser.Discord#IVoiceState#IsSelfMuted*"></a>
|
||||
<h4 id="Discord_Rest_RestWebhookUser_Discord_IVoiceState_IsSelfMuted" data-uid="Discord.Rest.RestWebhookUser.Discord#IVoiceState#IsSelfMuted">IVoiceState.IsSelfMuted</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a value that indicates whether this user has marked themselves as muted (i.e. not permitted to
|
||||
speak via voice).</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -923,7 +990,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td></td>
|
||||
<td><p><code>true</code> if this user has muted themselves; otherwise <code>false</code>.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -936,7 +1004,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestWebhookUser_Discord_IVoiceState_IsStreaming_" data-uid="Discord.Rest.RestWebhookUser.Discord#IVoiceState#IsStreaming*"></a>
|
||||
<h4 id="Discord_Rest_RestWebhookUser_Discord_IVoiceState_IsStreaming" data-uid="Discord.Rest.RestWebhookUser.Discord#IVoiceState#IsStreaming">IVoiceState.IsStreaming</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a value that indicates if this user is streaming in a voice channel.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -953,7 +1022,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td></td>
|
||||
<td><p><code>true</code> if the user is streaming; otherwise <code>false</code>.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -966,7 +1036,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestWebhookUser_Discord_IVoiceState_IsSuppressed_" data-uid="Discord.Rest.RestWebhookUser.Discord#IVoiceState#IsSuppressed*"></a>
|
||||
<h4 id="Discord_Rest_RestWebhookUser_Discord_IVoiceState_IsSuppressed" data-uid="Discord.Rest.RestWebhookUser.Discord#IVoiceState#IsSuppressed">IVoiceState.IsSuppressed</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a value that indicates whether the user is muted by the current user.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -983,7 +1054,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td></td>
|
||||
<td><p><code>true</code> if the guild is temporarily blocking audio to/from this user; otherwise <code>false</code>.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -996,7 +1068,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestWebhookUser_Discord_IVoiceState_VoiceChannel_" data-uid="Discord.Rest.RestWebhookUser.Discord#IVoiceState#VoiceChannel*"></a>
|
||||
<h4 id="Discord_Rest_RestWebhookUser_Discord_IVoiceState_VoiceChannel" data-uid="Discord.Rest.RestWebhookUser.Discord#IVoiceState#VoiceChannel">IVoiceState.VoiceChannel</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the voice channel this user is currently in.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1013,7 +1086,9 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.IVoiceChannel.html">IVoiceChannel</a></td>
|
||||
<td></td>
|
||||
<td><p>A generic voice channel object representing the voice channel that the user is currently in; <code>null</code>
|
||||
if none.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1026,7 +1101,8 @@
|
|||
</span>
|
||||
<a id="Discord_Rest_RestWebhookUser_Discord_IVoiceState_VoiceSessionId_" data-uid="Discord.Rest.RestWebhookUser.Discord#IVoiceState#VoiceSessionId*"></a>
|
||||
<h4 id="Discord_Rest_RestWebhookUser_Discord_IVoiceState_VoiceSessionId" data-uid="Discord.Rest.RestWebhookUser.Discord#IVoiceState#VoiceSessionId">IVoiceState.VoiceSessionId</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the unique identifier for this user's voice session.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
|
|||
|
|
@ -1218,7 +1218,8 @@ found.</p>
|
|||
</span>
|
||||
<a id="Discord_WebSocket_BaseSocketClient_StartAsync_" data-uid="Discord.WebSocket.BaseSocketClient.StartAsync*"></a>
|
||||
<h4 id="Discord_WebSocket_BaseSocketClient_StartAsync" data-uid="Discord.WebSocket.BaseSocketClient.StartAsync">StartAsync()</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Starts the connection between Discord and the client..</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1235,10 +1236,18 @@ found.</p>
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous start operation.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 id="Discord_WebSocket_BaseSocketClient_StartAsync_remarks">Remarks</h5>
|
||||
<div class="markdown level1 remarks"><p>This method will initialize the connection between the client and Discord.</p>
|
||||
<div class="IMPORTANT"><h5>important</h5><p>
|
||||
This method will immediately return after it is called, as it will initialize the connection on
|
||||
another thread.
|
||||
</p></div>
|
||||
</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_WebSocket_BaseSocketClient_StopAsync.md&value=---%0Auid%3A%20Discord.WebSocket.BaseSocketClient.StopAsync%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>
|
||||
|
|
@ -1248,7 +1257,8 @@ found.</p>
|
|||
</span>
|
||||
<a id="Discord_WebSocket_BaseSocketClient_StopAsync_" data-uid="Discord.WebSocket.BaseSocketClient.StopAsync*"></a>
|
||||
<h4 id="Discord_WebSocket_BaseSocketClient_StopAsync" data-uid="Discord.WebSocket.BaseSocketClient.StopAsync">StopAsync()</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Stops the connection between Discord and the client.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1265,7 +1275,8 @@ found.</p>
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous stop operation.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -2436,7 +2447,8 @@ public async Task HandleReactionAddedAsync(Cacheable<IUserMessage, ulong> cac
|
|||
</span>
|
||||
<a id="Discord_WebSocket_BaseSocketClient_Discord_IDiscordClient_CreateGuildAsync_" data-uid="Discord.WebSocket.BaseSocketClient.Discord#IDiscordClient#CreateGuildAsync*"></a>
|
||||
<h4 id="Discord_WebSocket_BaseSocketClient_Discord_IDiscordClient_CreateGuildAsync_System_String_Discord_IVoiceRegion_System_IO_Stream_Discord_RequestOptions_" data-uid="Discord.WebSocket.BaseSocketClient.Discord#IDiscordClient#CreateGuildAsync(System.String,Discord.IVoiceRegion,System.IO.Stream,Discord.RequestOptions)">IDiscordClient.CreateGuildAsync(String, IVoiceRegion, Stream, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Creates a guild for the logged-in user who is in less than 10 active guilds.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -2455,22 +2467,26 @@ public async Task HandleReactionAddedAsync(Cacheable<IUserMessage, ulong> cac
|
|||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td><span class="parametername">name</span></td>
|
||||
<td></td>
|
||||
<td><p>The name of the new guild.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.IVoiceRegion.html">IVoiceRegion</a></td>
|
||||
<td><span class="parametername">region</span></td>
|
||||
<td></td>
|
||||
<td><p>The voice region to create the guild with.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.IO.Stream</span></td>
|
||||
<td><span class="parametername">jpegIcon</span></td>
|
||||
<td></td>
|
||||
<td><p>The icon of the guild.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -2485,10 +2501,17 @@ public async Task HandleReactionAddedAsync(Cacheable<IUserMessage, ulong> cac
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span><<a class="xref" href="Discord.IGuild.html">IGuild</a>></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous creation operation. The task result contains the created guild.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 id="Discord_WebSocket_BaseSocketClient_Discord_IDiscordClient_CreateGuildAsync_System_String_Discord_IVoiceRegion_System_IO_Stream_Discord_RequestOptions__remarks">Remarks</h5>
|
||||
<div class="markdown level1 remarks"><p>This method creates a new guild on behalf of the logged-in user.</p>
|
||||
<div class="WARNING"><h5>warning</h5><p>
|
||||
Due to Discord's limitation, this method will only work for users that are in less than 10 guilds.
|
||||
</p></div>
|
||||
</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_WebSocket_BaseSocketClient_Discord_IDiscordClient_GetApplicationInfoAsync_Discord_RequestOptions_.md&value=---%0Auid%3A%20Discord.WebSocket.BaseSocketClient.Discord%23IDiscordClient%23GetApplicationInfoAsync(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>
|
||||
|
|
@ -2498,7 +2521,8 @@ public async Task HandleReactionAddedAsync(Cacheable<IUserMessage, ulong> cac
|
|||
</span>
|
||||
<a id="Discord_WebSocket_BaseSocketClient_Discord_IDiscordClient_GetApplicationInfoAsync_" data-uid="Discord.WebSocket.BaseSocketClient.Discord#IDiscordClient#GetApplicationInfoAsync*"></a>
|
||||
<h4 id="Discord_WebSocket_BaseSocketClient_Discord_IDiscordClient_GetApplicationInfoAsync_Discord_RequestOptions_" data-uid="Discord.WebSocket.BaseSocketClient.Discord#IDiscordClient#GetApplicationInfoAsync(Discord.RequestOptions)">IDiscordClient.GetApplicationInfoAsync(RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a Discord application information for the logged-in user.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -2517,7 +2541,8 @@ public async Task HandleReactionAddedAsync(Cacheable<IUserMessage, ulong> cac
|
|||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -2532,10 +2557,16 @@ public async Task HandleReactionAddedAsync(Cacheable<IUserMessage, ulong> cac
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span><<a class="xref" href="Discord.IApplication.html">IApplication</a>></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous get operation. The task result contains the application
|
||||
information.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 id="Discord_WebSocket_BaseSocketClient_Discord_IDiscordClient_GetApplicationInfoAsync_Discord_RequestOptions__remarks">Remarks</h5>
|
||||
<div class="markdown level1 remarks"><p>This method reflects your application information you submitted when creating a Discord application via
|
||||
the Developer Portal.</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_WebSocket_BaseSocketClient_Discord_IDiscordClient_GetChannelAsync_System_UInt64_Discord_CacheMode_Discord_RequestOptions_.md&value=---%0Auid%3A%20Discord.WebSocket.BaseSocketClient.Discord%23IDiscordClient%23GetChannelAsync(System.UInt64%2CDiscord.CacheMode%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>
|
||||
|
|
@ -2545,7 +2576,8 @@ public async Task HandleReactionAddedAsync(Cacheable<IUserMessage, ulong> cac
|
|||
</span>
|
||||
<a id="Discord_WebSocket_BaseSocketClient_Discord_IDiscordClient_GetChannelAsync_" data-uid="Discord.WebSocket.BaseSocketClient.Discord#IDiscordClient#GetChannelAsync*"></a>
|
||||
<h4 id="Discord_WebSocket_BaseSocketClient_Discord_IDiscordClient_GetChannelAsync_System_UInt64_Discord_CacheMode_Discord_RequestOptions_" data-uid="Discord.WebSocket.BaseSocketClient.Discord#IDiscordClient#GetChannelAsync(System.UInt64,Discord.CacheMode,Discord.RequestOptions)">IDiscordClient.GetChannelAsync(UInt64, CacheMode, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a generic channel.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -2564,17 +2596,20 @@ public async Task HandleReactionAddedAsync(Cacheable<IUserMessage, ulong> cac
|
|||
<tr>
|
||||
<td><span class="xref">System.UInt64</span></td>
|
||||
<td><span class="parametername">id</span></td>
|
||||
<td></td>
|
||||
<td><p>The snowflake identifier of the channel (e.g. <code>381889909113225237</code>).</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.CacheMode.html">CacheMode</a></td>
|
||||
<td><span class="parametername">mode</span></td>
|
||||
<td></td>
|
||||
<td><p>The <a class="xref" href="Discord.CacheMode.html">CacheMode</a> that determines whether the object should be fetched from cache.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -2589,7 +2624,9 @@ public async Task HandleReactionAddedAsync(Cacheable<IUserMessage, ulong> cac
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span><<a class="xref" href="Discord.IChannel.html">IChannel</a>></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous get operation. The task result contains the channel associated
|
||||
with the snowflake identifier; <code>null</code> when the channel cannot be found.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -2602,7 +2639,8 @@ public async Task HandleReactionAddedAsync(Cacheable<IUserMessage, ulong> cac
|
|||
</span>
|
||||
<a id="Discord_WebSocket_BaseSocketClient_Discord_IDiscordClient_GetConnectionsAsync_" data-uid="Discord.WebSocket.BaseSocketClient.Discord#IDiscordClient#GetConnectionsAsync*"></a>
|
||||
<h4 id="Discord_WebSocket_BaseSocketClient_Discord_IDiscordClient_GetConnectionsAsync_Discord_RequestOptions_" data-uid="Discord.WebSocket.BaseSocketClient.Discord#IDiscordClient#GetConnectionsAsync(Discord.RequestOptions)">IDiscordClient.GetConnectionsAsync(RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the connections that the user has set up.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -2621,7 +2659,8 @@ public async Task HandleReactionAddedAsync(Cacheable<IUserMessage, ulong> cac
|
|||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -2636,7 +2675,8 @@ public async Task HandleReactionAddedAsync(Cacheable<IUserMessage, ulong> cac
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span><<span class="xref">System.Collections.Generic.IReadOnlyCollection</span><<a class="xref" href="Discord.IConnection.html">IConnection</a>>></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous get operation. The task result contains a read-only collection of connections.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -2649,7 +2689,8 @@ public async Task HandleReactionAddedAsync(Cacheable<IUserMessage, ulong> cac
|
|||
</span>
|
||||
<a id="Discord_WebSocket_BaseSocketClient_Discord_IDiscordClient_GetGuildAsync_" data-uid="Discord.WebSocket.BaseSocketClient.Discord#IDiscordClient#GetGuildAsync*"></a>
|
||||
<h4 id="Discord_WebSocket_BaseSocketClient_Discord_IDiscordClient_GetGuildAsync_System_UInt64_Discord_CacheMode_Discord_RequestOptions_" data-uid="Discord.WebSocket.BaseSocketClient.Discord#IDiscordClient#GetGuildAsync(System.UInt64,Discord.CacheMode,Discord.RequestOptions)">IDiscordClient.GetGuildAsync(UInt64, CacheMode, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a guild.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -2668,17 +2709,20 @@ public async Task HandleReactionAddedAsync(Cacheable<IUserMessage, ulong> cac
|
|||
<tr>
|
||||
<td><span class="xref">System.UInt64</span></td>
|
||||
<td><span class="parametername">id</span></td>
|
||||
<td></td>
|
||||
<td><p>The guild snowflake identifier.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.CacheMode.html">CacheMode</a></td>
|
||||
<td><span class="parametername">mode</span></td>
|
||||
<td></td>
|
||||
<td><p>The <a class="xref" href="Discord.CacheMode.html">CacheMode</a> that determines whether the object should be fetched from cache.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -2693,7 +2737,9 @@ public async Task HandleReactionAddedAsync(Cacheable<IUserMessage, ulong> cac
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span><<a class="xref" href="Discord.IGuild.html">IGuild</a>></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous get operation. The task result contains the guild associated
|
||||
with the snowflake identifier; <code>null</code> when the guild cannot be found.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -2706,7 +2752,8 @@ public async Task HandleReactionAddedAsync(Cacheable<IUserMessage, ulong> cac
|
|||
</span>
|
||||
<a id="Discord_WebSocket_BaseSocketClient_Discord_IDiscordClient_GetGuildsAsync_" data-uid="Discord.WebSocket.BaseSocketClient.Discord#IDiscordClient#GetGuildsAsync*"></a>
|
||||
<h4 id="Discord_WebSocket_BaseSocketClient_Discord_IDiscordClient_GetGuildsAsync_Discord_CacheMode_Discord_RequestOptions_" data-uid="Discord.WebSocket.BaseSocketClient.Discord#IDiscordClient#GetGuildsAsync(Discord.CacheMode,Discord.RequestOptions)">IDiscordClient.GetGuildsAsync(CacheMode, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a collection of guilds that the user is currently in.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -2725,12 +2772,14 @@ public async Task HandleReactionAddedAsync(Cacheable<IUserMessage, ulong> cac
|
|||
<tr>
|
||||
<td><a class="xref" href="Discord.CacheMode.html">CacheMode</a></td>
|
||||
<td><span class="parametername">mode</span></td>
|
||||
<td></td>
|
||||
<td><p>The <a class="xref" href="Discord.CacheMode.html">CacheMode</a> that determines whether the object should be fetched from cache.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -2745,7 +2794,9 @@ public async Task HandleReactionAddedAsync(Cacheable<IUserMessage, ulong> cac
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span><<span class="xref">System.Collections.Generic.IReadOnlyCollection</span><<a class="xref" href="Discord.IGuild.html">IGuild</a>>></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous get operation. The task result contains a read-only collection
|
||||
of guilds that the current user is in.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -2758,7 +2809,8 @@ public async Task HandleReactionAddedAsync(Cacheable<IUserMessage, ulong> cac
|
|||
</span>
|
||||
<a id="Discord_WebSocket_BaseSocketClient_Discord_IDiscordClient_GetInviteAsync_" data-uid="Discord.WebSocket.BaseSocketClient.Discord#IDiscordClient#GetInviteAsync*"></a>
|
||||
<h4 id="Discord_WebSocket_BaseSocketClient_Discord_IDiscordClient_GetInviteAsync_System_String_Discord_RequestOptions_" data-uid="Discord.WebSocket.BaseSocketClient.Discord#IDiscordClient#GetInviteAsync(System.String,Discord.RequestOptions)">IDiscordClient.GetInviteAsync(String, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets an invite.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -2777,12 +2829,14 @@ public async Task HandleReactionAddedAsync(Cacheable<IUserMessage, ulong> cac
|
|||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td><span class="parametername">inviteId</span></td>
|
||||
<td></td>
|
||||
<td><p>The invitation identifier.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -2797,7 +2851,8 @@ public async Task HandleReactionAddedAsync(Cacheable<IUserMessage, ulong> cac
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span><<a class="xref" href="Discord.IInvite.html">IInvite</a>></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous get operation. The task result contains the invite information.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -2810,7 +2865,8 @@ public async Task HandleReactionAddedAsync(Cacheable<IUserMessage, ulong> cac
|
|||
</span>
|
||||
<a id="Discord_WebSocket_BaseSocketClient_Discord_IDiscordClient_GetPrivateChannelsAsync_" data-uid="Discord.WebSocket.BaseSocketClient.Discord#IDiscordClient#GetPrivateChannelsAsync*"></a>
|
||||
<h4 id="Discord_WebSocket_BaseSocketClient_Discord_IDiscordClient_GetPrivateChannelsAsync_Discord_CacheMode_Discord_RequestOptions_" data-uid="Discord.WebSocket.BaseSocketClient.Discord#IDiscordClient#GetPrivateChannelsAsync(Discord.CacheMode,Discord.RequestOptions)">IDiscordClient.GetPrivateChannelsAsync(CacheMode, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a collection of private channels opened in this session.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -2829,12 +2885,14 @@ public async Task HandleReactionAddedAsync(Cacheable<IUserMessage, ulong> cac
|
|||
<tr>
|
||||
<td><a class="xref" href="Discord.CacheMode.html">CacheMode</a></td>
|
||||
<td><span class="parametername">mode</span></td>
|
||||
<td></td>
|
||||
<td><p>The <a class="xref" href="Discord.CacheMode.html">CacheMode</a> that determines whether the object should be fetched from cache.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -2849,10 +2907,20 @@ public async Task HandleReactionAddedAsync(Cacheable<IUserMessage, ulong> cac
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span><<span class="xref">System.Collections.Generic.IReadOnlyCollection</span><<a class="xref" href="Discord.IPrivateChannel.html">IPrivateChannel</a>>></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous get operation. The task result contains a read-only collection
|
||||
of private channels that the user currently partakes in.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 id="Discord_WebSocket_BaseSocketClient_Discord_IDiscordClient_GetPrivateChannelsAsync_Discord_CacheMode_Discord_RequestOptions__remarks">Remarks</h5>
|
||||
<div class="markdown level1 remarks"><p>This method will retrieve all private channels (including direct-message, group channel and such) that
|
||||
are currently opened in this session.</p>
|
||||
<div class="WARNING"><h5>warning</h5><p>
|
||||
This method will not return previously opened private channels outside of the current session! If
|
||||
you have just started the client, this may return an empty collection.
|
||||
</p></div>
|
||||
</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_WebSocket_BaseSocketClient_Discord_IDiscordClient_GetUserAsync_System_String_System_String_Discord_RequestOptions_.md&value=---%0Auid%3A%20Discord.WebSocket.BaseSocketClient.Discord%23IDiscordClient%23GetUserAsync(System.String%2CSystem.String%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>
|
||||
|
|
@ -2862,7 +2930,8 @@ public async Task HandleReactionAddedAsync(Cacheable<IUserMessage, ulong> cac
|
|||
</span>
|
||||
<a id="Discord_WebSocket_BaseSocketClient_Discord_IDiscordClient_GetUserAsync_" data-uid="Discord.WebSocket.BaseSocketClient.Discord#IDiscordClient#GetUserAsync*"></a>
|
||||
<h4 id="Discord_WebSocket_BaseSocketClient_Discord_IDiscordClient_GetUserAsync_System_String_System_String_Discord_RequestOptions_" data-uid="Discord.WebSocket.BaseSocketClient.Discord#IDiscordClient#GetUserAsync(System.String,System.String,Discord.RequestOptions)">IDiscordClient.GetUserAsync(String, String, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a user.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -2881,17 +2950,20 @@ public async Task HandleReactionAddedAsync(Cacheable<IUserMessage, ulong> cac
|
|||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td><span class="parametername">username</span></td>
|
||||
<td></td>
|
||||
<td><p>The name of the user (e.g. <code>Still</code>).</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td><span class="parametername">discriminator</span></td>
|
||||
<td></td>
|
||||
<td><p>The discriminator value of the user (e.g. <code>2876</code>).</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -2906,7 +2978,9 @@ public async Task HandleReactionAddedAsync(Cacheable<IUserMessage, ulong> cac
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span><<a class="xref" href="Discord.IUser.html">IUser</a>></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous get operation. The task result contains the user associated with
|
||||
the name and the discriminator; <code>null</code> if the user is not found.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -2919,7 +2993,8 @@ public async Task HandleReactionAddedAsync(Cacheable<IUserMessage, ulong> cac
|
|||
</span>
|
||||
<a id="Discord_WebSocket_BaseSocketClient_Discord_IDiscordClient_GetUserAsync_" data-uid="Discord.WebSocket.BaseSocketClient.Discord#IDiscordClient#GetUserAsync*"></a>
|
||||
<h4 id="Discord_WebSocket_BaseSocketClient_Discord_IDiscordClient_GetUserAsync_System_UInt64_Discord_CacheMode_Discord_RequestOptions_" data-uid="Discord.WebSocket.BaseSocketClient.Discord#IDiscordClient#GetUserAsync(System.UInt64,Discord.CacheMode,Discord.RequestOptions)">IDiscordClient.GetUserAsync(UInt64, CacheMode, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a user.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -2938,17 +3013,20 @@ public async Task HandleReactionAddedAsync(Cacheable<IUserMessage, ulong> cac
|
|||
<tr>
|
||||
<td><span class="xref">System.UInt64</span></td>
|
||||
<td><span class="parametername">id</span></td>
|
||||
<td></td>
|
||||
<td><p>The snowflake identifier of the user (e.g. <code>168693960628371456</code>).</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.CacheMode.html">CacheMode</a></td>
|
||||
<td><span class="parametername">mode</span></td>
|
||||
<td></td>
|
||||
<td><p>The <a class="xref" href="Discord.CacheMode.html">CacheMode</a> that determines whether the object should be fetched from cache.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -2963,7 +3041,9 @@ public async Task HandleReactionAddedAsync(Cacheable<IUserMessage, ulong> cac
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span><<a class="xref" href="Discord.IUser.html">IUser</a>></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous get operation. The task result contains the user associated with
|
||||
the snowflake identifier; <code>null</code> if the user is not found.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -2976,7 +3056,8 @@ public async Task HandleReactionAddedAsync(Cacheable<IUserMessage, ulong> cac
|
|||
</span>
|
||||
<a id="Discord_WebSocket_BaseSocketClient_Discord_IDiscordClient_GetVoiceRegionAsync_" data-uid="Discord.WebSocket.BaseSocketClient.Discord#IDiscordClient#GetVoiceRegionAsync*"></a>
|
||||
<h4 id="Discord_WebSocket_BaseSocketClient_Discord_IDiscordClient_GetVoiceRegionAsync_System_String_Discord_RequestOptions_" data-uid="Discord.WebSocket.BaseSocketClient.Discord#IDiscordClient#GetVoiceRegionAsync(System.String,Discord.RequestOptions)">IDiscordClient.GetVoiceRegionAsync(String, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a voice region.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -2995,12 +3076,14 @@ public async Task HandleReactionAddedAsync(Cacheable<IUserMessage, ulong> cac
|
|||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td><span class="parametername">id</span></td>
|
||||
<td></td>
|
||||
<td><p>The identifier of the voice region (e.g. <code>eu-central</code> ).</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -3015,7 +3098,9 @@ public async Task HandleReactionAddedAsync(Cacheable<IUserMessage, ulong> cac
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span><<a class="xref" href="Discord.IVoiceRegion.html">IVoiceRegion</a>></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous get operation. The task result contains the voice region
|
||||
associated with the identifier; <code>null</code> if the voice region is not found.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -3028,7 +3113,8 @@ public async Task HandleReactionAddedAsync(Cacheable<IUserMessage, ulong> cac
|
|||
</span>
|
||||
<a id="Discord_WebSocket_BaseSocketClient_Discord_IDiscordClient_GetVoiceRegionsAsync_" data-uid="Discord.WebSocket.BaseSocketClient.Discord#IDiscordClient#GetVoiceRegionsAsync*"></a>
|
||||
<h4 id="Discord_WebSocket_BaseSocketClient_Discord_IDiscordClient_GetVoiceRegionsAsync_Discord_RequestOptions_" data-uid="Discord.WebSocket.BaseSocketClient.Discord#IDiscordClient#GetVoiceRegionsAsync(Discord.RequestOptions)">IDiscordClient.GetVoiceRegionsAsync(RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a collection of the available voice regions.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -3047,7 +3133,8 @@ public async Task HandleReactionAddedAsync(Cacheable<IUserMessage, ulong> cac
|
|||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -3062,7 +3149,9 @@ public async Task HandleReactionAddedAsync(Cacheable<IUserMessage, ulong> cac
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span><<span class="xref">System.Collections.Generic.IReadOnlyCollection</span><<a class="xref" href="Discord.IVoiceRegion.html">IVoiceRegion</a>>></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous get operation. The task result contains a read-only collection
|
||||
with all of the available voice regions in this session.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
|
|||
|
|
@ -406,7 +406,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_DiscordShardedClient_Activity_" data-uid="Discord.WebSocket.DiscordShardedClient.Activity*"></a>
|
||||
<h4 id="Discord_WebSocket_DiscordShardedClient_Activity" data-uid="Discord.WebSocket.DiscordShardedClient.Activity">Activity</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the activity for the logged-in user.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -423,7 +424,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.IActivity.html">IActivity</a></td>
|
||||
<td></td>
|
||||
<td><p>An activity object that represents the user's current activity.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -438,7 +440,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_DiscordShardedClient_Guilds_" data-uid="Discord.WebSocket.DiscordShardedClient.Guilds*"></a>
|
||||
<h4 id="Discord_WebSocket_DiscordShardedClient_Guilds" data-uid="Discord.WebSocket.DiscordShardedClient.Guilds">Guilds</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a collection of guilds that the user is currently in.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -455,7 +458,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Collections.Generic.IReadOnlyCollection</span><<a class="xref" href="Discord.WebSocket.SocketGuild.html">SocketGuild</a>></td>
|
||||
<td></td>
|
||||
<td><p>A read-only collection of guilds that the current user is in.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -470,7 +474,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_DiscordShardedClient_Latency_" data-uid="Discord.WebSocket.DiscordShardedClient.Latency*"></a>
|
||||
<h4 id="Discord_WebSocket_DiscordShardedClient_Latency" data-uid="Discord.WebSocket.DiscordShardedClient.Latency">Latency</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the estimated round-trip latency, in milliseconds, to the gateway server.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -487,7 +492,9 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Int32</span></td>
|
||||
<td></td>
|
||||
<td><p>An <span class="xref">System.Int32</span> that represents the round-trip latency to the WebSocket server. Please
|
||||
note that this value does not represent a "true" latency for operations such as sending a message.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -502,7 +509,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_DiscordShardedClient_PrivateChannels_" data-uid="Discord.WebSocket.DiscordShardedClient.PrivateChannels*"></a>
|
||||
<h4 id="Discord_WebSocket_DiscordShardedClient_PrivateChannels" data-uid="Discord.WebSocket.DiscordShardedClient.PrivateChannels">PrivateChannels</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a collection of private channels opened in this session.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -519,12 +527,21 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Collections.Generic.IReadOnlyCollection</span><<a class="xref" href="Discord.WebSocket.ISocketPrivateChannel.html">ISocketPrivateChannel</a>></td>
|
||||
<td></td>
|
||||
<td><p>A read-only collection of private channels that the user currently partakes in.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 class="overrides">Overrides</h5>
|
||||
<div><a class="xref" href="Discord.WebSocket.BaseSocketClient.html#Discord_WebSocket_BaseSocketClient_PrivateChannels">BaseSocketClient.PrivateChannels</a></div>
|
||||
<h5 id="Discord_WebSocket_DiscordShardedClient_PrivateChannels_remarks">Remarks</h5>
|
||||
<div class="markdown level1 remarks"><p>This method will retrieve all private channels (including direct-message, group channel and such) that
|
||||
are currently opened in this session.</p>
|
||||
<div class="WARNING"><h5>warning</h5><p>
|
||||
This method will not return previously opened private channels outside of the current session! If
|
||||
you have just started the client, this may return an empty collection.
|
||||
</p></div>
|
||||
</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_WebSocket_DiscordShardedClient_Rest.md&value=---%0Auid%3A%20Discord.WebSocket.DiscordShardedClient.Rest%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>
|
||||
|
|
@ -597,7 +614,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_DiscordShardedClient_Status_" data-uid="Discord.WebSocket.DiscordShardedClient.Status*"></a>
|
||||
<h4 id="Discord_WebSocket_DiscordShardedClient_Status" data-uid="Discord.WebSocket.DiscordShardedClient.Status">Status</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the status for the logged-in user.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -614,7 +632,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.UserStatus.html">UserStatus</a></td>
|
||||
<td></td>
|
||||
<td><p>A status object that represents the user's online presence status.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -629,7 +648,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_DiscordShardedClient_VoiceRegions_" data-uid="Discord.WebSocket.DiscordShardedClient.VoiceRegions*"></a>
|
||||
<h4 id="Discord_WebSocket_DiscordShardedClient_VoiceRegions" data-uid="Discord.WebSocket.DiscordShardedClient.VoiceRegions">VoiceRegions</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a collection of available voice regions.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -646,7 +666,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Collections.Generic.IReadOnlyCollection</span><<a class="xref" href="Discord.Rest.RestVoiceRegion.html">RestVoiceRegion</a>></td>
|
||||
<td></td>
|
||||
<td><p>A read-only collection of voice regions that the user has access to.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -663,7 +684,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_DiscordShardedClient_DownloadUsersAsync_" data-uid="Discord.WebSocket.DiscordShardedClient.DownloadUsersAsync*"></a>
|
||||
<h4 id="Discord_WebSocket_DiscordShardedClient_DownloadUsersAsync_System_Collections_Generic_IEnumerable_Discord_IGuild__" data-uid="Discord.WebSocket.DiscordShardedClient.DownloadUsersAsync(System.Collections.Generic.IEnumerable{Discord.IGuild})">DownloadUsersAsync(IEnumerable<IGuild>)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Attempts to download users into the user cache for the selected guilds.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -682,7 +704,8 @@
|
|||
<tr>
|
||||
<td><span class="xref">System.Collections.Generic.IEnumerable</span><<a class="xref" href="Discord.IGuild.html">IGuild</a>></td>
|
||||
<td><span class="parametername">guilds</span></td>
|
||||
<td></td>
|
||||
<td><p>The guilds to download the members from.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -697,7 +720,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous download operation.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -728,7 +752,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_DiscordShardedClient_GetApplicationInfoAsync_" data-uid="Discord.WebSocket.DiscordShardedClient.GetApplicationInfoAsync*"></a>
|
||||
<h4 id="Discord_WebSocket_DiscordShardedClient_GetApplicationInfoAsync_Discord_RequestOptions_" data-uid="Discord.WebSocket.DiscordShardedClient.GetApplicationInfoAsync(Discord.RequestOptions)">GetApplicationInfoAsync(RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a Discord application information for the logged-in user.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -747,7 +772,8 @@
|
|||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -762,12 +788,18 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span><<a class="xref" href="Discord.Rest.RestApplication.html">RestApplication</a>></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous get operation. The task result contains the application
|
||||
information.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 class="overrides">Overrides</h5>
|
||||
<div><a class="xref" href="Discord.WebSocket.BaseSocketClient.html#Discord_WebSocket_BaseSocketClient_GetApplicationInfoAsync_Discord_RequestOptions_">BaseSocketClient.GetApplicationInfoAsync(RequestOptions)</a></div>
|
||||
<h5 id="Discord_WebSocket_DiscordShardedClient_GetApplicationInfoAsync_Discord_RequestOptions__remarks">Remarks</h5>
|
||||
<div class="markdown level1 remarks"><p>This method reflects your application information you submitted when creating a Discord application via
|
||||
the Developer Portal.</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_WebSocket_DiscordShardedClient_GetChannel_System_UInt64_.md&value=---%0Auid%3A%20Discord.WebSocket.DiscordShardedClient.GetChannel(System.UInt64)%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>
|
||||
|
|
@ -777,7 +809,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_DiscordShardedClient_GetChannel_" data-uid="Discord.WebSocket.DiscordShardedClient.GetChannel*"></a>
|
||||
<h4 id="Discord_WebSocket_DiscordShardedClient_GetChannel_System_UInt64_" data-uid="Discord.WebSocket.DiscordShardedClient.GetChannel(System.UInt64)">GetChannel(UInt64)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a channel.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -796,7 +829,8 @@
|
|||
<tr>
|
||||
<td><span class="xref">System.UInt64</span></td>
|
||||
<td><span class="parametername">id</span></td>
|
||||
<td></td>
|
||||
<td><p>The snowflake identifier of the channel (e.g. <code>381889909113225237</code>).</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -811,7 +845,9 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.WebSocket.SocketChannel.html">SocketChannel</a></td>
|
||||
<td></td>
|
||||
<td><p>A generic WebSocket-based channel object (voice, text, category, etc.) associated with the identifier;
|
||||
<code>null</code> when the channel cannot be found.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -826,7 +862,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_DiscordShardedClient_GetGuild_" data-uid="Discord.WebSocket.DiscordShardedClient.GetGuild*"></a>
|
||||
<h4 id="Discord_WebSocket_DiscordShardedClient_GetGuild_System_UInt64_" data-uid="Discord.WebSocket.DiscordShardedClient.GetGuild(System.UInt64)">GetGuild(UInt64)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a guild.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -845,7 +882,8 @@
|
|||
<tr>
|
||||
<td><span class="xref">System.UInt64</span></td>
|
||||
<td><span class="parametername">id</span></td>
|
||||
<td></td>
|
||||
<td><p>The guild snowflake identifier.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -860,7 +898,9 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.WebSocket.SocketGuild.html">SocketGuild</a></td>
|
||||
<td></td>
|
||||
<td><p>A WebSocket-based guild associated with the snowflake identifier; <code>null</code> when the guild cannot be
|
||||
found.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1016,7 +1056,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_DiscordShardedClient_GetUser_" data-uid="Discord.WebSocket.DiscordShardedClient.GetUser*"></a>
|
||||
<h4 id="Discord_WebSocket_DiscordShardedClient_GetUser_System_String_System_String_" data-uid="Discord.WebSocket.DiscordShardedClient.GetUser(System.String,System.String)">GetUser(String, String)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a user.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1035,12 +1076,14 @@
|
|||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td><span class="parametername">username</span></td>
|
||||
<td></td>
|
||||
<td><p>The name of the user.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td><span class="parametername">discriminator</span></td>
|
||||
<td></td>
|
||||
<td><p>The discriminator value of the user.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1055,12 +1098,27 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.WebSocket.SocketUser.html">SocketUser</a></td>
|
||||
<td></td>
|
||||
<td><p>A generic WebSocket-based user; <code>null</code> when the user cannot be found.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 class="overrides">Overrides</h5>
|
||||
<div><a class="xref" href="Discord.WebSocket.BaseSocketClient.html#Discord_WebSocket_BaseSocketClient_GetUser_System_String_System_String_">BaseSocketClient.GetUser(String, String)</a></div>
|
||||
<h5 id="Discord_WebSocket_DiscordShardedClient_GetUser_System_String_System_String__remarks">Remarks</h5>
|
||||
<div class="markdown level1 remarks"><p>This method gets the user present in the WebSocket cache with the given condition.</p>
|
||||
<div class="WARNING"><h5>warning</h5><p>
|
||||
Sometimes a user may return <code>null</code> due to Discord not sending offline users in large guilds
|
||||
(i.e. guild with 100+ members) actively. To download users on startup and to see more information
|
||||
about this subject, see <a class="xref" href="Discord.WebSocket.DiscordSocketConfig.html#Discord_WebSocket_DiscordSocketConfig_AlwaysDownloadUsers">AlwaysDownloadUsers</a>.
|
||||
</p></div>
|
||||
<div class="NOTE"><h5>note</h5><p>
|
||||
This method does not attempt to fetch users that the logged-in user does not have access to (i.e.
|
||||
users who don't share mutual guild(s) with the current user). If you wish to get a user that you do
|
||||
not have access to, consider using the REST implementation of
|
||||
<a class="xref" href="Discord.Rest.DiscordRestClient.html#Discord_Rest_DiscordRestClient_GetUserAsync_System_UInt64_Discord_RequestOptions_">GetUserAsync(UInt64, RequestOptions)</a>.
|
||||
</p></div>
|
||||
</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_WebSocket_DiscordShardedClient_GetUser_System_UInt64_.md&value=---%0Auid%3A%20Discord.WebSocket.DiscordShardedClient.GetUser(System.UInt64)%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>
|
||||
|
|
@ -1070,7 +1128,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_DiscordShardedClient_GetUser_" data-uid="Discord.WebSocket.DiscordShardedClient.GetUser*"></a>
|
||||
<h4 id="Discord_WebSocket_DiscordShardedClient_GetUser_System_UInt64_" data-uid="Discord.WebSocket.DiscordShardedClient.GetUser(System.UInt64)">GetUser(UInt64)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a generic user.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1089,7 +1148,8 @@
|
|||
<tr>
|
||||
<td><span class="xref">System.UInt64</span></td>
|
||||
<td><span class="parametername">id</span></td>
|
||||
<td></td>
|
||||
<td><p>The user snowflake ID.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1104,12 +1164,27 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.WebSocket.SocketUser.html">SocketUser</a></td>
|
||||
<td></td>
|
||||
<td><p>A generic WebSocket-based user; <code>null</code> when the user cannot be found.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 class="overrides">Overrides</h5>
|
||||
<div><a class="xref" href="Discord.WebSocket.BaseSocketClient.html#Discord_WebSocket_BaseSocketClient_GetUser_System_UInt64_">BaseSocketClient.GetUser(UInt64)</a></div>
|
||||
<h5 id="Discord_WebSocket_DiscordShardedClient_GetUser_System_UInt64__remarks">Remarks</h5>
|
||||
<div class="markdown level1 remarks"><p>This method gets the user present in the WebSocket cache with the given condition.</p>
|
||||
<div class="WARNING"><h5>warning</h5><p>
|
||||
Sometimes a user may return <code>null</code> due to Discord not sending offline users in large guilds
|
||||
(i.e. guild with 100+ members) actively. To download users on startup and to see more information
|
||||
about this subject, see <a class="xref" href="Discord.WebSocket.DiscordSocketConfig.html#Discord_WebSocket_DiscordSocketConfig_AlwaysDownloadUsers">AlwaysDownloadUsers</a>.
|
||||
</p></div>
|
||||
<div class="NOTE"><h5>note</h5><p>
|
||||
This method does not attempt to fetch users that the logged-in user does not have access to (i.e.
|
||||
users who don't share mutual guild(s) with the current user). If you wish to get a user that you do
|
||||
not have access to, consider using the REST implementation of
|
||||
<a class="xref" href="Discord.Rest.DiscordRestClient.html#Discord_Rest_DiscordRestClient_GetUserAsync_System_UInt64_Discord_RequestOptions_">GetUserAsync(UInt64, RequestOptions)</a>.
|
||||
</p></div>
|
||||
</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_WebSocket_DiscordShardedClient_GetVoiceRegion_System_String_.md&value=---%0Auid%3A%20Discord.WebSocket.DiscordShardedClient.GetVoiceRegion(System.String)%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>
|
||||
|
|
@ -1119,7 +1194,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_DiscordShardedClient_GetVoiceRegion_" data-uid="Discord.WebSocket.DiscordShardedClient.GetVoiceRegion*"></a>
|
||||
<h4 id="Discord_WebSocket_DiscordShardedClient_GetVoiceRegion_System_String_" data-uid="Discord.WebSocket.DiscordShardedClient.GetVoiceRegion(System.String)">GetVoiceRegion(String)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a voice region.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1138,7 +1214,8 @@
|
|||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td><span class="parametername">id</span></td>
|
||||
<td></td>
|
||||
<td><p>The identifier of the voice region (e.g. <code>eu-central</code> ).</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1153,7 +1230,9 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.Rest.RestVoiceRegion.html">RestVoiceRegion</a></td>
|
||||
<td></td>
|
||||
<td><p>A REST-based voice region associated with the identifier; <code>null</code> if the voice region is not
|
||||
found.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1168,7 +1247,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_DiscordShardedClient_SetActivityAsync_" data-uid="Discord.WebSocket.DiscordShardedClient.SetActivityAsync*"></a>
|
||||
<h4 id="Discord_WebSocket_DiscordShardedClient_SetActivityAsync_Discord_IActivity_" data-uid="Discord.WebSocket.DiscordShardedClient.SetActivityAsync(Discord.IActivity)">SetActivityAsync(IActivity)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Sets the <code data-dev-comment-type="paramref" class="paramref">activity</code> of the logged-in user.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1187,7 +1267,8 @@
|
|||
<tr>
|
||||
<td><a class="xref" href="Discord.IActivity.html">IActivity</a></td>
|
||||
<td><span class="parametername">activity</span></td>
|
||||
<td></td>
|
||||
<td><p>The activity to be set.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1202,12 +1283,23 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous set operation.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 class="overrides">Overrides</h5>
|
||||
<div><a class="xref" href="Discord.WebSocket.BaseSocketClient.html#Discord_WebSocket_BaseSocketClient_SetActivityAsync_Discord_IActivity_">BaseSocketClient.SetActivityAsync(IActivity)</a></div>
|
||||
<h5 id="Discord_WebSocket_DiscordShardedClient_SetActivityAsync_Discord_IActivity__remarks">Remarks</h5>
|
||||
<div class="markdown level1 remarks"><p>This method sets the <code data-dev-comment-type="paramref" class="paramref">activity</code> of the user.</p>
|
||||
<div class="NOTE"><h5>note</h5><p>
|
||||
Discord will only accept setting of name and the type of activity.
|
||||
</p></div>
|
||||
<div class="WARNING"><h5>warning</h5><p>
|
||||
Rich Presence cannot be set via this method or client. Rich Presence is strictly limited to RPC
|
||||
clients only.
|
||||
</p></div>
|
||||
</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_WebSocket_DiscordShardedClient_SetGameAsync_System_String_System_String_Discord_ActivityType_.md&value=---%0Auid%3A%20Discord.WebSocket.DiscordShardedClient.SetGameAsync(System.String%2CSystem.String%2CDiscord.ActivityType)%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>
|
||||
|
|
@ -1217,7 +1309,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_DiscordShardedClient_SetGameAsync_" data-uid="Discord.WebSocket.DiscordShardedClient.SetGameAsync*"></a>
|
||||
<h4 id="Discord_WebSocket_DiscordShardedClient_SetGameAsync_System_String_System_String_Discord_ActivityType_" data-uid="Discord.WebSocket.DiscordShardedClient.SetGameAsync(System.String,System.String,Discord.ActivityType)">SetGameAsync(String, String, ActivityType)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Sets the game of the user.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1236,17 +1329,20 @@
|
|||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td><span class="parametername">name</span></td>
|
||||
<td></td>
|
||||
<td><p>The name of the game.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td><span class="parametername">streamUrl</span></td>
|
||||
<td></td>
|
||||
<td><p>If streaming, the URL of the stream. Must be a valid Twitch URL.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.ActivityType.html">ActivityType</a></td>
|
||||
<td><span class="parametername">type</span></td>
|
||||
<td></td>
|
||||
<td><p>The type of the game.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1261,7 +1357,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous set operation.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1276,7 +1373,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_DiscordShardedClient_SetStatusAsync_" data-uid="Discord.WebSocket.DiscordShardedClient.SetStatusAsync*"></a>
|
||||
<h4 id="Discord_WebSocket_DiscordShardedClient_SetStatusAsync_Discord_UserStatus_" data-uid="Discord.WebSocket.DiscordShardedClient.SetStatusAsync(Discord.UserStatus)">SetStatusAsync(UserStatus)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Sets the current status of the user (e.g. Online, Do not Disturb).</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1295,7 +1393,8 @@
|
|||
<tr>
|
||||
<td><a class="xref" href="Discord.UserStatus.html">UserStatus</a></td>
|
||||
<td><span class="parametername">status</span></td>
|
||||
<td></td>
|
||||
<td><p>The new status to be set.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1310,7 +1409,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous set operation.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1325,7 +1425,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_DiscordShardedClient_StartAsync_" data-uid="Discord.WebSocket.DiscordShardedClient.StartAsync*"></a>
|
||||
<h4 id="Discord_WebSocket_DiscordShardedClient_StartAsync" data-uid="Discord.WebSocket.DiscordShardedClient.StartAsync">StartAsync()</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Starts the connection between Discord and the client..</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1342,12 +1443,20 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous start operation.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 class="overrides">Overrides</h5>
|
||||
<div><a class="xref" href="Discord.WebSocket.BaseSocketClient.html#Discord_WebSocket_BaseSocketClient_StartAsync">BaseSocketClient.StartAsync()</a></div>
|
||||
<h5 id="Discord_WebSocket_DiscordShardedClient_StartAsync_remarks">Remarks</h5>
|
||||
<div class="markdown level1 remarks"><p>This method will initialize the connection between the client and Discord.</p>
|
||||
<div class="IMPORTANT"><h5>important</h5><p>
|
||||
This method will immediately return after it is called, as it will initialize the connection on
|
||||
another thread.
|
||||
</p></div>
|
||||
</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_WebSocket_DiscordShardedClient_StopAsync.md&value=---%0Auid%3A%20Discord.WebSocket.DiscordShardedClient.StopAsync%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>
|
||||
|
|
@ -1357,7 +1466,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_DiscordShardedClient_StopAsync_" data-uid="Discord.WebSocket.DiscordShardedClient.StopAsync*"></a>
|
||||
<h4 id="Discord_WebSocket_DiscordShardedClient_StopAsync" data-uid="Discord.WebSocket.DiscordShardedClient.StopAsync">StopAsync()</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Stops the connection between Discord and the client.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1374,7 +1484,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous stop operation.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1513,7 +1624,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_DiscordShardedClient_Discord_IDiscordClient_CreateGuildAsync_" data-uid="Discord.WebSocket.DiscordShardedClient.Discord#IDiscordClient#CreateGuildAsync*"></a>
|
||||
<h4 id="Discord_WebSocket_DiscordShardedClient_Discord_IDiscordClient_CreateGuildAsync_System_String_Discord_IVoiceRegion_System_IO_Stream_Discord_RequestOptions_" data-uid="Discord.WebSocket.DiscordShardedClient.Discord#IDiscordClient#CreateGuildAsync(System.String,Discord.IVoiceRegion,System.IO.Stream,Discord.RequestOptions)">IDiscordClient.CreateGuildAsync(String, IVoiceRegion, Stream, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Creates a guild for the logged-in user who is in less than 10 active guilds.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1532,22 +1644,26 @@
|
|||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td><span class="parametername">name</span></td>
|
||||
<td></td>
|
||||
<td><p>The name of the new guild.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.IVoiceRegion.html">IVoiceRegion</a></td>
|
||||
<td><span class="parametername">region</span></td>
|
||||
<td></td>
|
||||
<td><p>The voice region to create the guild with.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.IO.Stream</span></td>
|
||||
<td><span class="parametername">jpegIcon</span></td>
|
||||
<td></td>
|
||||
<td><p>The icon of the guild.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1562,10 +1678,17 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span><<a class="xref" href="Discord.IGuild.html">IGuild</a>></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous creation operation. The task result contains the created guild.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 id="Discord_WebSocket_DiscordShardedClient_Discord_IDiscordClient_CreateGuildAsync_System_String_Discord_IVoiceRegion_System_IO_Stream_Discord_RequestOptions__remarks">Remarks</h5>
|
||||
<div class="markdown level1 remarks"><p>This method creates a new guild on behalf of the logged-in user.</p>
|
||||
<div class="WARNING"><h5>warning</h5><p>
|
||||
Due to Discord's limitation, this method will only work for users that are in less than 10 guilds.
|
||||
</p></div>
|
||||
</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_WebSocket_DiscordShardedClient_Discord_IDiscordClient_GetApplicationInfoAsync_Discord_RequestOptions_.md&value=---%0Auid%3A%20Discord.WebSocket.DiscordShardedClient.Discord%23IDiscordClient%23GetApplicationInfoAsync(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>
|
||||
|
|
@ -1575,7 +1698,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_DiscordShardedClient_Discord_IDiscordClient_GetApplicationInfoAsync_" data-uid="Discord.WebSocket.DiscordShardedClient.Discord#IDiscordClient#GetApplicationInfoAsync*"></a>
|
||||
<h4 id="Discord_WebSocket_DiscordShardedClient_Discord_IDiscordClient_GetApplicationInfoAsync_Discord_RequestOptions_" data-uid="Discord.WebSocket.DiscordShardedClient.Discord#IDiscordClient#GetApplicationInfoAsync(Discord.RequestOptions)">IDiscordClient.GetApplicationInfoAsync(RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a Discord application information for the logged-in user.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1594,7 +1718,8 @@
|
|||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1609,10 +1734,16 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span><<a class="xref" href="Discord.IApplication.html">IApplication</a>></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous get operation. The task result contains the application
|
||||
information.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 id="Discord_WebSocket_DiscordShardedClient_Discord_IDiscordClient_GetApplicationInfoAsync_Discord_RequestOptions__remarks">Remarks</h5>
|
||||
<div class="markdown level1 remarks"><p>This method reflects your application information you submitted when creating a Discord application via
|
||||
the Developer Portal.</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_WebSocket_DiscordShardedClient_Discord_IDiscordClient_GetChannelAsync_System_UInt64_Discord_CacheMode_Discord_RequestOptions_.md&value=---%0Auid%3A%20Discord.WebSocket.DiscordShardedClient.Discord%23IDiscordClient%23GetChannelAsync(System.UInt64%2CDiscord.CacheMode%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>
|
||||
|
|
@ -1622,7 +1753,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_DiscordShardedClient_Discord_IDiscordClient_GetChannelAsync_" data-uid="Discord.WebSocket.DiscordShardedClient.Discord#IDiscordClient#GetChannelAsync*"></a>
|
||||
<h4 id="Discord_WebSocket_DiscordShardedClient_Discord_IDiscordClient_GetChannelAsync_System_UInt64_Discord_CacheMode_Discord_RequestOptions_" data-uid="Discord.WebSocket.DiscordShardedClient.Discord#IDiscordClient#GetChannelAsync(System.UInt64,Discord.CacheMode,Discord.RequestOptions)">IDiscordClient.GetChannelAsync(UInt64, CacheMode, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a generic channel.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1641,17 +1773,20 @@
|
|||
<tr>
|
||||
<td><span class="xref">System.UInt64</span></td>
|
||||
<td><span class="parametername">id</span></td>
|
||||
<td></td>
|
||||
<td><p>The snowflake identifier of the channel (e.g. <code>381889909113225237</code>).</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.CacheMode.html">CacheMode</a></td>
|
||||
<td><span class="parametername">mode</span></td>
|
||||
<td></td>
|
||||
<td><p>The <a class="xref" href="Discord.CacheMode.html">CacheMode</a> that determines whether the object should be fetched from cache.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1666,7 +1801,9 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span><<a class="xref" href="Discord.IChannel.html">IChannel</a>></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous get operation. The task result contains the channel associated
|
||||
with the snowflake identifier; <code>null</code> when the channel cannot be found.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1679,7 +1816,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_DiscordShardedClient_Discord_IDiscordClient_GetConnectionsAsync_" data-uid="Discord.WebSocket.DiscordShardedClient.Discord#IDiscordClient#GetConnectionsAsync*"></a>
|
||||
<h4 id="Discord_WebSocket_DiscordShardedClient_Discord_IDiscordClient_GetConnectionsAsync_Discord_RequestOptions_" data-uid="Discord.WebSocket.DiscordShardedClient.Discord#IDiscordClient#GetConnectionsAsync(Discord.RequestOptions)">IDiscordClient.GetConnectionsAsync(RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the connections that the user has set up.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1698,7 +1836,8 @@
|
|||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1713,7 +1852,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span><<span class="xref">System.Collections.Generic.IReadOnlyCollection</span><<a class="xref" href="Discord.IConnection.html">IConnection</a>>></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous get operation. The task result contains a read-only collection of connections.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1726,7 +1866,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_DiscordShardedClient_Discord_IDiscordClient_GetGuildAsync_" data-uid="Discord.WebSocket.DiscordShardedClient.Discord#IDiscordClient#GetGuildAsync*"></a>
|
||||
<h4 id="Discord_WebSocket_DiscordShardedClient_Discord_IDiscordClient_GetGuildAsync_System_UInt64_Discord_CacheMode_Discord_RequestOptions_" data-uid="Discord.WebSocket.DiscordShardedClient.Discord#IDiscordClient#GetGuildAsync(System.UInt64,Discord.CacheMode,Discord.RequestOptions)">IDiscordClient.GetGuildAsync(UInt64, CacheMode, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a guild.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1745,17 +1886,20 @@
|
|||
<tr>
|
||||
<td><span class="xref">System.UInt64</span></td>
|
||||
<td><span class="parametername">id</span></td>
|
||||
<td></td>
|
||||
<td><p>The guild snowflake identifier.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.CacheMode.html">CacheMode</a></td>
|
||||
<td><span class="parametername">mode</span></td>
|
||||
<td></td>
|
||||
<td><p>The <a class="xref" href="Discord.CacheMode.html">CacheMode</a> that determines whether the object should be fetched from cache.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1770,7 +1914,9 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span><<a class="xref" href="Discord.IGuild.html">IGuild</a>></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous get operation. The task result contains the guild associated
|
||||
with the snowflake identifier; <code>null</code> when the guild cannot be found.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1783,7 +1929,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_DiscordShardedClient_Discord_IDiscordClient_GetGuildsAsync_" data-uid="Discord.WebSocket.DiscordShardedClient.Discord#IDiscordClient#GetGuildsAsync*"></a>
|
||||
<h4 id="Discord_WebSocket_DiscordShardedClient_Discord_IDiscordClient_GetGuildsAsync_Discord_CacheMode_Discord_RequestOptions_" data-uid="Discord.WebSocket.DiscordShardedClient.Discord#IDiscordClient#GetGuildsAsync(Discord.CacheMode,Discord.RequestOptions)">IDiscordClient.GetGuildsAsync(CacheMode, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a collection of guilds that the user is currently in.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1802,12 +1949,14 @@
|
|||
<tr>
|
||||
<td><a class="xref" href="Discord.CacheMode.html">CacheMode</a></td>
|
||||
<td><span class="parametername">mode</span></td>
|
||||
<td></td>
|
||||
<td><p>The <a class="xref" href="Discord.CacheMode.html">CacheMode</a> that determines whether the object should be fetched from cache.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1822,7 +1971,9 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span><<span class="xref">System.Collections.Generic.IReadOnlyCollection</span><<a class="xref" href="Discord.IGuild.html">IGuild</a>>></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous get operation. The task result contains a read-only collection
|
||||
of guilds that the current user is in.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1835,7 +1986,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_DiscordShardedClient_Discord_IDiscordClient_GetInviteAsync_" data-uid="Discord.WebSocket.DiscordShardedClient.Discord#IDiscordClient#GetInviteAsync*"></a>
|
||||
<h4 id="Discord_WebSocket_DiscordShardedClient_Discord_IDiscordClient_GetInviteAsync_System_String_Discord_RequestOptions_" data-uid="Discord.WebSocket.DiscordShardedClient.Discord#IDiscordClient#GetInviteAsync(System.String,Discord.RequestOptions)">IDiscordClient.GetInviteAsync(String, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets an invite.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1854,12 +2006,14 @@
|
|||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td><span class="parametername">inviteId</span></td>
|
||||
<td></td>
|
||||
<td><p>The invitation identifier.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1874,7 +2028,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span><<a class="xref" href="Discord.IInvite.html">IInvite</a>></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous get operation. The task result contains the invite information.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1887,7 +2042,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_DiscordShardedClient_Discord_IDiscordClient_GetPrivateChannelsAsync_" data-uid="Discord.WebSocket.DiscordShardedClient.Discord#IDiscordClient#GetPrivateChannelsAsync*"></a>
|
||||
<h4 id="Discord_WebSocket_DiscordShardedClient_Discord_IDiscordClient_GetPrivateChannelsAsync_Discord_CacheMode_Discord_RequestOptions_" data-uid="Discord.WebSocket.DiscordShardedClient.Discord#IDiscordClient#GetPrivateChannelsAsync(Discord.CacheMode,Discord.RequestOptions)">IDiscordClient.GetPrivateChannelsAsync(CacheMode, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a collection of private channels opened in this session.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1906,12 +2062,14 @@
|
|||
<tr>
|
||||
<td><a class="xref" href="Discord.CacheMode.html">CacheMode</a></td>
|
||||
<td><span class="parametername">mode</span></td>
|
||||
<td></td>
|
||||
<td><p>The <a class="xref" href="Discord.CacheMode.html">CacheMode</a> that determines whether the object should be fetched from cache.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1926,10 +2084,20 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span><<span class="xref">System.Collections.Generic.IReadOnlyCollection</span><<a class="xref" href="Discord.IPrivateChannel.html">IPrivateChannel</a>>></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous get operation. The task result contains a read-only collection
|
||||
of private channels that the user currently partakes in.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 id="Discord_WebSocket_DiscordShardedClient_Discord_IDiscordClient_GetPrivateChannelsAsync_Discord_CacheMode_Discord_RequestOptions__remarks">Remarks</h5>
|
||||
<div class="markdown level1 remarks"><p>This method will retrieve all private channels (including direct-message, group channel and such) that
|
||||
are currently opened in this session.</p>
|
||||
<div class="WARNING"><h5>warning</h5><p>
|
||||
This method will not return previously opened private channels outside of the current session! If
|
||||
you have just started the client, this may return an empty collection.
|
||||
</p></div>
|
||||
</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_WebSocket_DiscordShardedClient_Discord_IDiscordClient_GetUserAsync_System_String_System_String_Discord_RequestOptions_.md&value=---%0Auid%3A%20Discord.WebSocket.DiscordShardedClient.Discord%23IDiscordClient%23GetUserAsync(System.String%2CSystem.String%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>
|
||||
|
|
@ -1939,7 +2107,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_DiscordShardedClient_Discord_IDiscordClient_GetUserAsync_" data-uid="Discord.WebSocket.DiscordShardedClient.Discord#IDiscordClient#GetUserAsync*"></a>
|
||||
<h4 id="Discord_WebSocket_DiscordShardedClient_Discord_IDiscordClient_GetUserAsync_System_String_System_String_Discord_RequestOptions_" data-uid="Discord.WebSocket.DiscordShardedClient.Discord#IDiscordClient#GetUserAsync(System.String,System.String,Discord.RequestOptions)">IDiscordClient.GetUserAsync(String, String, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a user.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1958,17 +2127,20 @@
|
|||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td><span class="parametername">username</span></td>
|
||||
<td></td>
|
||||
<td><p>The name of the user (e.g. <code>Still</code>).</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td><span class="parametername">discriminator</span></td>
|
||||
<td></td>
|
||||
<td><p>The discriminator value of the user (e.g. <code>2876</code>).</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1983,7 +2155,9 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span><<a class="xref" href="Discord.IUser.html">IUser</a>></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous get operation. The task result contains the user associated with
|
||||
the name and the discriminator; <code>null</code> if the user is not found.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1996,7 +2170,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_DiscordShardedClient_Discord_IDiscordClient_GetUserAsync_" data-uid="Discord.WebSocket.DiscordShardedClient.Discord#IDiscordClient#GetUserAsync*"></a>
|
||||
<h4 id="Discord_WebSocket_DiscordShardedClient_Discord_IDiscordClient_GetUserAsync_System_UInt64_Discord_CacheMode_Discord_RequestOptions_" data-uid="Discord.WebSocket.DiscordShardedClient.Discord#IDiscordClient#GetUserAsync(System.UInt64,Discord.CacheMode,Discord.RequestOptions)">IDiscordClient.GetUserAsync(UInt64, CacheMode, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a user.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -2015,17 +2190,20 @@
|
|||
<tr>
|
||||
<td><span class="xref">System.UInt64</span></td>
|
||||
<td><span class="parametername">id</span></td>
|
||||
<td></td>
|
||||
<td><p>The snowflake identifier of the user (e.g. <code>168693960628371456</code>).</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.CacheMode.html">CacheMode</a></td>
|
||||
<td><span class="parametername">mode</span></td>
|
||||
<td></td>
|
||||
<td><p>The <a class="xref" href="Discord.CacheMode.html">CacheMode</a> that determines whether the object should be fetched from cache.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -2040,7 +2218,9 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span><<a class="xref" href="Discord.IUser.html">IUser</a>></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous get operation. The task result contains the user associated with
|
||||
the snowflake identifier; <code>null</code> if the user is not found.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -2053,7 +2233,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_DiscordShardedClient_Discord_IDiscordClient_GetVoiceRegionAsync_" data-uid="Discord.WebSocket.DiscordShardedClient.Discord#IDiscordClient#GetVoiceRegionAsync*"></a>
|
||||
<h4 id="Discord_WebSocket_DiscordShardedClient_Discord_IDiscordClient_GetVoiceRegionAsync_System_String_Discord_RequestOptions_" data-uid="Discord.WebSocket.DiscordShardedClient.Discord#IDiscordClient#GetVoiceRegionAsync(System.String,Discord.RequestOptions)">IDiscordClient.GetVoiceRegionAsync(String, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a voice region.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -2072,12 +2253,14 @@
|
|||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td><span class="parametername">id</span></td>
|
||||
<td></td>
|
||||
<td><p>The identifier of the voice region (e.g. <code>eu-central</code> ).</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -2092,7 +2275,9 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span><<a class="xref" href="Discord.IVoiceRegion.html">IVoiceRegion</a>></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous get operation. The task result contains the voice region
|
||||
associated with the identifier; <code>null</code> if the voice region is not found.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -2105,7 +2290,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_DiscordShardedClient_Discord_IDiscordClient_GetVoiceRegionsAsync_" data-uid="Discord.WebSocket.DiscordShardedClient.Discord#IDiscordClient#GetVoiceRegionsAsync*"></a>
|
||||
<h4 id="Discord_WebSocket_DiscordShardedClient_Discord_IDiscordClient_GetVoiceRegionsAsync_Discord_RequestOptions_" data-uid="Discord.WebSocket.DiscordShardedClient.Discord#IDiscordClient#GetVoiceRegionsAsync(Discord.RequestOptions)">IDiscordClient.GetVoiceRegionsAsync(RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a collection of the available voice regions.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -2124,7 +2310,8 @@
|
|||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -2139,7 +2326,9 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span><<span class="xref">System.Collections.Generic.IReadOnlyCollection</span><<a class="xref" href="Discord.IVoiceRegion.html">IVoiceRegion</a>>></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous get operation. The task result contains a read-only collection
|
||||
with all of the available voice regions in this session.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
|
|||
File diff suppressed because it is too large
Load diff
|
|
@ -237,7 +237,8 @@ channel.</p>
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketCategoryChannel_Users_" data-uid="Discord.WebSocket.SocketCategoryChannel.Users*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketCategoryChannel_Users" data-uid="Discord.WebSocket.SocketCategoryChannel.Users">Users</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a collection of users that are able to view the channel.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -254,7 +255,8 @@ channel.</p>
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Collections.Generic.IReadOnlyCollection</span><<a class="xref" href="Discord.WebSocket.SocketGuildUser.html">SocketGuildUser</a>></td>
|
||||
<td></td>
|
||||
<td><p>A read-only collection of users that can access the channel (i.e. the users seen in the user list).</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -322,7 +324,8 @@ channel.</p>
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketCategoryChannel_Discord_IChannel_GetUserAsync_" data-uid="Discord.WebSocket.SocketCategoryChannel.Discord#IChannel#GetUserAsync*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketCategoryChannel_Discord_IChannel_GetUserAsync_System_UInt64_Discord_CacheMode_Discord_RequestOptions_" data-uid="Discord.WebSocket.SocketCategoryChannel.Discord#IChannel#GetUserAsync(System.UInt64,Discord.CacheMode,Discord.RequestOptions)">IChannel.GetUserAsync(UInt64, CacheMode, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a user in this channel.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -341,17 +344,20 @@ channel.</p>
|
|||
<tr>
|
||||
<td><span class="xref">System.UInt64</span></td>
|
||||
<td><span class="parametername">id</span></td>
|
||||
<td></td>
|
||||
<td><p>The snowflake identifier of the user (e.g. <code>168693960628371456</code>).</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.CacheMode.html">CacheMode</a></td>
|
||||
<td><span class="parametername">mode</span></td>
|
||||
<td></td>
|
||||
<td><p>The <a class="xref" href="Discord.CacheMode.html">CacheMode</a> that determines whether the object should be fetched from cache.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -366,7 +372,9 @@ channel.</p>
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span><<a class="xref" href="Discord.IUser.html">IUser</a>></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous get operation. The task result contains a user object that
|
||||
represents the found user; <code>null</code> if none is found.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -379,7 +387,8 @@ channel.</p>
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketCategoryChannel_Discord_IGuildChannel_GetUserAsync_" data-uid="Discord.WebSocket.SocketCategoryChannel.Discord#IGuildChannel#GetUserAsync*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketCategoryChannel_Discord_IGuildChannel_GetUserAsync_System_UInt64_Discord_CacheMode_Discord_RequestOptions_" data-uid="Discord.WebSocket.SocketCategoryChannel.Discord#IGuildChannel#GetUserAsync(System.UInt64,Discord.CacheMode,Discord.RequestOptions)">IGuildChannel.GetUserAsync(UInt64, CacheMode, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a user in this channel.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -398,17 +407,20 @@ channel.</p>
|
|||
<tr>
|
||||
<td><span class="xref">System.UInt64</span></td>
|
||||
<td><span class="parametername">id</span></td>
|
||||
<td></td>
|
||||
<td><p>The snowflake identifier of the user.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.CacheMode.html">CacheMode</a></td>
|
||||
<td><span class="parametername">mode</span></td>
|
||||
<td></td>
|
||||
<td><p>The <a class="xref" href="Discord.CacheMode.html">CacheMode</a> that determines whether the object should be fetched from cache.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -423,7 +435,9 @@ channel.</p>
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span><<a class="xref" href="Discord.IGuildUser.html">IGuildUser</a>></td>
|
||||
<td></td>
|
||||
<td><p>A task representing the asynchronous get operation. The task result contains a guild user object that
|
||||
represents the user; <code>null</code> if none is found.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
|
|||
|
|
@ -251,7 +251,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketChannel_Discord_IChannel_GetUserAsync_" data-uid="Discord.WebSocket.SocketChannel.Discord#IChannel#GetUserAsync*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketChannel_Discord_IChannel_GetUserAsync_System_UInt64_Discord_CacheMode_Discord_RequestOptions_" data-uid="Discord.WebSocket.SocketChannel.Discord#IChannel#GetUserAsync(System.UInt64,Discord.CacheMode,Discord.RequestOptions)">IChannel.GetUserAsync(UInt64, CacheMode, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a user in this channel.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -270,17 +271,20 @@
|
|||
<tr>
|
||||
<td><span class="xref">System.UInt64</span></td>
|
||||
<td><span class="parametername">id</span></td>
|
||||
<td></td>
|
||||
<td><p>The snowflake identifier of the user (e.g. <code>168693960628371456</code>).</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.CacheMode.html">CacheMode</a></td>
|
||||
<td><span class="parametername">mode</span></td>
|
||||
<td></td>
|
||||
<td><p>The <a class="xref" href="Discord.CacheMode.html">CacheMode</a> that determines whether the object should be fetched from cache.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -295,7 +299,9 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span><<a class="xref" href="Discord.IUser.html">IUser</a>></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous get operation. The task result contains a user object that
|
||||
represents the found user; <code>null</code> if none is found.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -308,7 +314,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketChannel_Discord_IChannel_Name_" data-uid="Discord.WebSocket.SocketChannel.Discord#IChannel#Name*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketChannel_Discord_IChannel_Name" data-uid="Discord.WebSocket.SocketChannel.Discord#IChannel#Name">IChannel.Name</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the name of this channel.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -325,7 +332,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td></td>
|
||||
<td><p>A string containing the name of this channel.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
|
|||
|
|
@ -138,7 +138,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketDMChannel_CachedMessages_" data-uid="Discord.WebSocket.SocketDMChannel.CachedMessages*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketDMChannel_CachedMessages" data-uid="Discord.WebSocket.SocketDMChannel.CachedMessages">CachedMessages</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets all messages in this channel's cache.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -155,7 +156,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Collections.Generic.IReadOnlyCollection</span><<a class="xref" href="Discord.WebSocket.SocketMessage.html">SocketMessage</a>></td>
|
||||
<td></td>
|
||||
<td><p>A read-only collection of WebSocket-based messages.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -232,7 +234,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketDMChannel_CloseAsync_" data-uid="Discord.WebSocket.SocketDMChannel.CloseAsync*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketDMChannel_CloseAsync_Discord_RequestOptions_" data-uid="Discord.WebSocket.SocketDMChannel.CloseAsync(Discord.RequestOptions)">CloseAsync(RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Closes this private channel, removing it from your channel list.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -251,7 +254,8 @@
|
|||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -266,7 +270,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous close operation.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -279,7 +284,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketDMChannel_DeleteMessageAsync_" data-uid="Discord.WebSocket.SocketDMChannel.DeleteMessageAsync*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketDMChannel_DeleteMessageAsync_Discord_IMessage_Discord_RequestOptions_" data-uid="Discord.WebSocket.SocketDMChannel.DeleteMessageAsync(Discord.IMessage,Discord.RequestOptions)">DeleteMessageAsync(IMessage, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Deletes a message based on the provided message in this channel.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -298,12 +304,14 @@
|
|||
<tr>
|
||||
<td><a class="xref" href="Discord.IMessage.html">IMessage</a></td>
|
||||
<td><span class="parametername">message</span></td>
|
||||
<td></td>
|
||||
<td><p>The message that would be removed.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -318,7 +326,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous removal operation.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -331,7 +340,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketDMChannel_DeleteMessageAsync_" data-uid="Discord.WebSocket.SocketDMChannel.DeleteMessageAsync*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketDMChannel_DeleteMessageAsync_System_UInt64_Discord_RequestOptions_" data-uid="Discord.WebSocket.SocketDMChannel.DeleteMessageAsync(System.UInt64,Discord.RequestOptions)">DeleteMessageAsync(UInt64, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Deletes a message.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -350,12 +360,14 @@
|
|||
<tr>
|
||||
<td><span class="xref">System.UInt64</span></td>
|
||||
<td><span class="parametername">messageId</span></td>
|
||||
<td></td>
|
||||
<td><p>The snowflake identifier of the message that would be removed.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -370,7 +382,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous removal operation.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -383,7 +396,9 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketDMChannel_EnterTypingState_" data-uid="Discord.WebSocket.SocketDMChannel.EnterTypingState*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketDMChannel_EnterTypingState_Discord_RequestOptions_" data-uid="Discord.WebSocket.SocketDMChannel.EnterTypingState(Discord.RequestOptions)">EnterTypingState(RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Continuously broadcasts the "user is typing" message to all users in this channel until the returned
|
||||
object is disposed.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -402,7 +417,8 @@
|
|||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -417,7 +433,9 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.IDisposable</span></td>
|
||||
<td></td>
|
||||
<td><p>A disposable object that, upon its disposal, will stop the client from broadcasting its typing state in
|
||||
this channel.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -430,7 +448,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketDMChannel_GetCachedMessage_" data-uid="Discord.WebSocket.SocketDMChannel.GetCachedMessage*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketDMChannel_GetCachedMessage_System_UInt64_" data-uid="Discord.WebSocket.SocketDMChannel.GetCachedMessage(System.UInt64)">GetCachedMessage(UInt64)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a cached message from this channel.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -449,7 +468,8 @@
|
|||
<tr>
|
||||
<td><span class="xref">System.UInt64</span></td>
|
||||
<td><span class="parametername">id</span></td>
|
||||
<td></td>
|
||||
<td><p>The snowflake identifier of the message.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -464,10 +484,23 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.WebSocket.SocketMessage.html">SocketMessage</a></td>
|
||||
<td></td>
|
||||
<td><p>A WebSocket-based message object; <code>null</code> if it does not exist in the cache or if caching is not
|
||||
enabled.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 id="Discord_WebSocket_SocketDMChannel_GetCachedMessage_System_UInt64__remarks">Remarks</h5>
|
||||
<div class="markdown level1 remarks"><div class="WARNING"><h5>warning</h5><p>
|
||||
This method requires the use of cache, which is not enabled by default; if caching is not enabled,
|
||||
this method will always return <code>null</code>. Please refer to
|
||||
<a class="xref" href="Discord.WebSocket.DiscordSocketConfig.html#Discord_WebSocket_DiscordSocketConfig_MessageCacheSize">MessageCacheSize</a> for more details.
|
||||
</p></div>
|
||||
<p>
|
||||
This method retrieves the message from the local WebSocket cache and does not send any additional
|
||||
request to Discord. This message may be a message that has been deleted.
|
||||
</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_WebSocket_SocketDMChannel_GetCachedMessages_Discord_IMessage_Discord_Direction_System_Int32_.md&value=---%0Auid%3A%20Discord.WebSocket.SocketDMChannel.GetCachedMessages(Discord.IMessage%2CDiscord.Direction%2CSystem.Int32)%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>
|
||||
|
|
@ -477,7 +510,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketDMChannel_GetCachedMessages_" data-uid="Discord.WebSocket.SocketDMChannel.GetCachedMessages*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketDMChannel_GetCachedMessages_Discord_IMessage_Discord_Direction_System_Int32_" data-uid="Discord.WebSocket.SocketDMChannel.GetCachedMessages(Discord.IMessage,Discord.Direction,System.Int32)">GetCachedMessages(IMessage, Direction, Int32)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the last N cached messages starting from a certain message in this message channel.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -496,17 +530,20 @@
|
|||
<tr>
|
||||
<td><a class="xref" href="Discord.IMessage.html">IMessage</a></td>
|
||||
<td><span class="parametername">fromMessage</span></td>
|
||||
<td></td>
|
||||
<td><p>The message to start the fetching from.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.Direction.html">Direction</a></td>
|
||||
<td><span class="parametername">dir</span></td>
|
||||
<td></td>
|
||||
<td><p>The direction of which the message should be gotten from.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.Int32</span></td>
|
||||
<td><span class="parametername">limit</span></td>
|
||||
<td></td>
|
||||
<td><p>The number of messages to get.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -521,10 +558,24 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Collections.Generic.IReadOnlyCollection</span><<a class="xref" href="Discord.WebSocket.SocketMessage.html">SocketMessage</a>></td>
|
||||
<td></td>
|
||||
<td><p>A read-only collection of WebSocket-based messages.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 id="Discord_WebSocket_SocketDMChannel_GetCachedMessages_Discord_IMessage_Discord_Direction_System_Int32__remarks">Remarks</h5>
|
||||
<div class="markdown level1 remarks"><div class="WARNING"><h5>warning</h5><p>
|
||||
This method requires the use of cache, which is not enabled by default; if caching is not enabled,
|
||||
this method will always return an empty collection. Please refer to
|
||||
<a class="xref" href="Discord.WebSocket.DiscordSocketConfig.html#Discord_WebSocket_DiscordSocketConfig_MessageCacheSize">MessageCacheSize</a> for more details.
|
||||
</p></div>
|
||||
<p>
|
||||
This method retrieves the message(s) from the local WebSocket cache and does not send any additional
|
||||
request to Discord. This read-only collection may include messages that have been deleted. The
|
||||
maximum number of messages that can be retrieved from this method depends on the
|
||||
<a class="xref" href="Discord.WebSocket.DiscordSocketConfig.html#Discord_WebSocket_DiscordSocketConfig_MessageCacheSize">MessageCacheSize</a> set.
|
||||
</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_WebSocket_SocketDMChannel_GetCachedMessages_System_Int32_.md&value=---%0Auid%3A%20Discord.WebSocket.SocketDMChannel.GetCachedMessages(System.Int32)%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>
|
||||
|
|
@ -534,7 +585,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketDMChannel_GetCachedMessages_" data-uid="Discord.WebSocket.SocketDMChannel.GetCachedMessages*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketDMChannel_GetCachedMessages_System_Int32_" data-uid="Discord.WebSocket.SocketDMChannel.GetCachedMessages(System.Int32)">GetCachedMessages(Int32)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the last N cached messages from this message channel.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -553,7 +605,8 @@
|
|||
<tr>
|
||||
<td><span class="xref">System.Int32</span></td>
|
||||
<td><span class="parametername">limit</span></td>
|
||||
<td></td>
|
||||
<td><p>The number of messages to get.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -568,10 +621,24 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Collections.Generic.IReadOnlyCollection</span><<a class="xref" href="Discord.WebSocket.SocketMessage.html">SocketMessage</a>></td>
|
||||
<td></td>
|
||||
<td><p>A read-only collection of WebSocket-based messages.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 id="Discord_WebSocket_SocketDMChannel_GetCachedMessages_System_Int32__remarks">Remarks</h5>
|
||||
<div class="markdown level1 remarks"><div class="WARNING"><h5>warning</h5><p>
|
||||
This method requires the use of cache, which is not enabled by default; if caching is not enabled,
|
||||
this method will always return an empty collection. Please refer to
|
||||
<a class="xref" href="Discord.WebSocket.DiscordSocketConfig.html#Discord_WebSocket_DiscordSocketConfig_MessageCacheSize">MessageCacheSize</a> for more details.
|
||||
</p></div>
|
||||
<p>
|
||||
This method retrieves the message(s) from the local WebSocket cache and does not send any additional
|
||||
request to Discord. This read-only collection may include messages that have been deleted. The
|
||||
maximum number of messages that can be retrieved from this method depends on the
|
||||
<a class="xref" href="Discord.WebSocket.DiscordSocketConfig.html#Discord_WebSocket_DiscordSocketConfig_MessageCacheSize">MessageCacheSize</a> set.
|
||||
</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_WebSocket_SocketDMChannel_GetCachedMessages_System_UInt64_Discord_Direction_System_Int32_.md&value=---%0Auid%3A%20Discord.WebSocket.SocketDMChannel.GetCachedMessages(System.UInt64%2CDiscord.Direction%2CSystem.Int32)%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>
|
||||
|
|
@ -581,7 +648,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketDMChannel_GetCachedMessages_" data-uid="Discord.WebSocket.SocketDMChannel.GetCachedMessages*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketDMChannel_GetCachedMessages_System_UInt64_Discord_Direction_System_Int32_" data-uid="Discord.WebSocket.SocketDMChannel.GetCachedMessages(System.UInt64,Discord.Direction,System.Int32)">GetCachedMessages(UInt64, Direction, Int32)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the last N cached messages starting from a certain message in this message channel.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -600,17 +668,20 @@
|
|||
<tr>
|
||||
<td><span class="xref">System.UInt64</span></td>
|
||||
<td><span class="parametername">fromMessageId</span></td>
|
||||
<td></td>
|
||||
<td><p>The message ID to start the fetching from.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.Direction.html">Direction</a></td>
|
||||
<td><span class="parametername">dir</span></td>
|
||||
<td></td>
|
||||
<td><p>The direction of which the message should be gotten from.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.Int32</span></td>
|
||||
<td><span class="parametername">limit</span></td>
|
||||
<td></td>
|
||||
<td><p>The number of messages to get.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -625,10 +696,24 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Collections.Generic.IReadOnlyCollection</span><<a class="xref" href="Discord.WebSocket.SocketMessage.html">SocketMessage</a>></td>
|
||||
<td></td>
|
||||
<td><p>A read-only collection of WebSocket-based messages.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 id="Discord_WebSocket_SocketDMChannel_GetCachedMessages_System_UInt64_Discord_Direction_System_Int32__remarks">Remarks</h5>
|
||||
<div class="markdown level1 remarks"><div class="WARNING"><h5>warning</h5><p>
|
||||
This method requires the use of cache, which is not enabled by default; if caching is not enabled,
|
||||
this method will always return an empty collection. Please refer to
|
||||
<a class="xref" href="Discord.WebSocket.DiscordSocketConfig.html#Discord_WebSocket_DiscordSocketConfig_MessageCacheSize">MessageCacheSize</a> for more details.
|
||||
</p></div>
|
||||
<p>
|
||||
This method retrieves the message(s) from the local WebSocket cache and does not send any additional
|
||||
request to Discord. This read-only collection may include messages that have been deleted. The
|
||||
maximum number of messages that can be retrieved from this method depends on the
|
||||
<a class="xref" href="Discord.WebSocket.DiscordSocketConfig.html#Discord_WebSocket_DiscordSocketConfig_MessageCacheSize">MessageCacheSize</a> set.
|
||||
</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_WebSocket_SocketDMChannel_GetMessageAsync_System_UInt64_Discord_RequestOptions_.md&value=---%0Auid%3A%20Discord.WebSocket.SocketDMChannel.GetMessageAsync(System.UInt64%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>
|
||||
|
|
@ -898,7 +983,8 @@ Please visit its documentation for more details on this method.</p>
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketDMChannel_GetPinnedMessagesAsync_" data-uid="Discord.WebSocket.SocketDMChannel.GetPinnedMessagesAsync*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketDMChannel_GetPinnedMessagesAsync_Discord_RequestOptions_" data-uid="Discord.WebSocket.SocketDMChannel.GetPinnedMessagesAsync(Discord.RequestOptions)">GetPinnedMessagesAsync(RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a read-only collection of pinned messages in this channel.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -917,7 +1003,8 @@ Please visit its documentation for more details on this method.</p>
|
|||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -932,10 +1019,16 @@ Please visit its documentation for more details on this method.</p>
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span><<span class="xref">System.Collections.Generic.IReadOnlyCollection</span><<a class="xref" href="Discord.Rest.RestMessage.html">RestMessage</a>>></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous get operation for retrieving pinned messages in this channel.
|
||||
The task result contains a read-only collection of messages found in the pinned messages.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 id="Discord_WebSocket_SocketDMChannel_GetPinnedMessagesAsync_Discord_RequestOptions__remarks">Remarks</h5>
|
||||
<div class="markdown level1 remarks"><p>This method follows the same behavior as described in <a class="xref" href="Discord.IMessageChannel.html#Discord_IMessageChannel_GetPinnedMessagesAsync_Discord_RequestOptions_">GetPinnedMessagesAsync(RequestOptions)</a>.
|
||||
Please visit its documentation for more details on this method.</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_WebSocket_SocketDMChannel_GetUser_System_UInt64_.md&value=---%0Auid%3A%20Discord.WebSocket.SocketDMChannel.GetUser(System.UInt64)%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>
|
||||
|
|
@ -995,7 +1088,8 @@ Please visit its documentation for more details on this method.</p>
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketDMChannel_SendFileAsync_" data-uid="Discord.WebSocket.SocketDMChannel.SendFileAsync*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketDMChannel_SendFileAsync_System_IO_Stream_System_String_System_String_System_Boolean_Discord_Embed_Discord_RequestOptions_System_Boolean_" data-uid="Discord.WebSocket.SocketDMChannel.SendFileAsync(System.IO.Stream,System.String,System.String,System.Boolean,Discord.Embed,Discord.RequestOptions,System.Boolean)">SendFileAsync(Stream, String, String, Boolean, Embed, RequestOptions, Boolean)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Sends a file to this message channel with an optional caption.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1014,37 +1108,44 @@ Please visit its documentation for more details on this method.</p>
|
|||
<tr>
|
||||
<td><span class="xref">System.IO.Stream</span></td>
|
||||
<td><span class="parametername">stream</span></td>
|
||||
<td></td>
|
||||
<td><p>The <span class="xref">System.IO.Stream</span> of the file to be sent.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td><span class="parametername">filename</span></td>
|
||||
<td></td>
|
||||
<td><p>The name of the attachment.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td><span class="parametername">text</span></td>
|
||||
<td></td>
|
||||
<td><p>The message to be sent.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td><span class="parametername">isTTS</span></td>
|
||||
<td></td>
|
||||
<td><p>Whether the message should be read aloud by Discord or not.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.Embed.html">Embed</a></td>
|
||||
<td><span class="parametername">embed</span></td>
|
||||
<td></td>
|
||||
<td><p>The <a class="xref" href="Discord.EmbedType.html#Discord_EmbedType_Rich">Rich</a> <a class="xref" href="Discord.Embed.html">Embed</a> to be sent.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td><span class="parametername">isSpoiler</span></td>
|
||||
<td></td>
|
||||
<td><p>Whether the message attachment should be hidden as a spoiler.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1059,10 +1160,16 @@ Please visit its documentation for more details on this method.</p>
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span><<a class="xref" href="Discord.Rest.RestUserMessage.html">RestUserMessage</a>></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents an asynchronous send operation for delivering the message. The task result
|
||||
contains the sent message.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 id="Discord_WebSocket_SocketDMChannel_SendFileAsync_System_IO_Stream_System_String_System_String_System_Boolean_Discord_Embed_Discord_RequestOptions_System_Boolean__remarks">Remarks</h5>
|
||||
<div class="markdown level1 remarks"><p>This method follows the same behavior as described in <a class="xref" href="Discord.IMessageChannel.html#Discord_IMessageChannel_SendFileAsync_System_IO_Stream_System_String_System_String_System_Boolean_Discord_Embed_Discord_RequestOptions_System_Boolean_">SendFileAsync(Stream, String, String, Boolean, Embed, RequestOptions, Boolean)</a>.
|
||||
Please visit its documentation for more details on this method.</p>
|
||||
</div>
|
||||
<h5 class="exceptions">Exceptions</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
|
|
@ -1088,7 +1195,8 @@ Please visit its documentation for more details on this method.</p>
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketDMChannel_SendFileAsync_" data-uid="Discord.WebSocket.SocketDMChannel.SendFileAsync*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketDMChannel_SendFileAsync_System_String_System_String_System_Boolean_Discord_Embed_Discord_RequestOptions_System_Boolean_" data-uid="Discord.WebSocket.SocketDMChannel.SendFileAsync(System.String,System.String,System.Boolean,Discord.Embed,Discord.RequestOptions,System.Boolean)">SendFileAsync(String, String, Boolean, Embed, RequestOptions, Boolean)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Sends a file to this message channel with an optional caption.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1107,32 +1215,38 @@ Please visit its documentation for more details on this method.</p>
|
|||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td><span class="parametername">filePath</span></td>
|
||||
<td></td>
|
||||
<td><p>The file path of the file.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td><span class="parametername">text</span></td>
|
||||
<td></td>
|
||||
<td><p>The message to be sent.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td><span class="parametername">isTTS</span></td>
|
||||
<td></td>
|
||||
<td><p>Whether the message should be read aloud by Discord or not.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.Embed.html">Embed</a></td>
|
||||
<td><span class="parametername">embed</span></td>
|
||||
<td></td>
|
||||
<td><p>The <a class="xref" href="Discord.EmbedType.html#Discord_EmbedType_Rich">Rich</a> <a class="xref" href="Discord.Embed.html">Embed</a> to be sent.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td><span class="parametername">isSpoiler</span></td>
|
||||
<td></td>
|
||||
<td><p>Whether the message attachment should be hidden as a spoiler.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1147,10 +1261,16 @@ Please visit its documentation for more details on this method.</p>
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span><<a class="xref" href="Discord.Rest.RestUserMessage.html">RestUserMessage</a>></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents an asynchronous send operation for delivering the message. The task result
|
||||
contains the sent message.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 id="Discord_WebSocket_SocketDMChannel_SendFileAsync_System_String_System_String_System_Boolean_Discord_Embed_Discord_RequestOptions_System_Boolean__remarks">Remarks</h5>
|
||||
<div class="markdown level1 remarks"><p>This method follows the same behavior as described in <a class="xref" href="Discord.IMessageChannel.html#Discord_IMessageChannel_SendFileAsync_System_String_System_String_System_Boolean_Discord_Embed_Discord_RequestOptions_System_Boolean_">SendFileAsync(String, String, Boolean, Embed, RequestOptions, Boolean)</a>.
|
||||
Please visit its documentation for more details on this method.</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_WebSocket_SocketDMChannel_SendMessageAsync_System_String_System_Boolean_Discord_Embed_Discord_RequestOptions_.md&value=---%0Auid%3A%20Discord.WebSocket.SocketDMChannel.SendMessageAsync(System.String%2CSystem.Boolean%2CDiscord.Embed%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>
|
||||
|
|
@ -1160,7 +1280,8 @@ Please visit its documentation for more details on this method.</p>
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketDMChannel_SendMessageAsync_" data-uid="Discord.WebSocket.SocketDMChannel.SendMessageAsync*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketDMChannel_SendMessageAsync_System_String_System_Boolean_Discord_Embed_Discord_RequestOptions_" data-uid="Discord.WebSocket.SocketDMChannel.SendMessageAsync(System.String,System.Boolean,Discord.Embed,Discord.RequestOptions)">SendMessageAsync(String, Boolean, Embed, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Sends a message to this message channel.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1179,22 +1300,26 @@ Please visit its documentation for more details on this method.</p>
|
|||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td><span class="parametername">text</span></td>
|
||||
<td></td>
|
||||
<td><p>The message to be sent.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td><span class="parametername">isTTS</span></td>
|
||||
<td></td>
|
||||
<td><p>Determines whether the message should be read aloud by Discord or not.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.Embed.html">Embed</a></td>
|
||||
<td><span class="parametername">embed</span></td>
|
||||
<td></td>
|
||||
<td><p>The <a class="xref" href="Discord.EmbedType.html#Discord_EmbedType_Rich">Rich</a> <a class="xref" href="Discord.Embed.html">Embed</a> to be sent.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1209,10 +1334,16 @@ Please visit its documentation for more details on this method.</p>
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span><<a class="xref" href="Discord.Rest.RestUserMessage.html">RestUserMessage</a>></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents an asynchronous send operation for delivering the message. The task result
|
||||
contains the sent message.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 id="Discord_WebSocket_SocketDMChannel_SendMessageAsync_System_String_System_Boolean_Discord_Embed_Discord_RequestOptions__remarks">Remarks</h5>
|
||||
<div class="markdown level1 remarks"><p>This method follows the same behavior as described in <a class="xref" href="Discord.IMessageChannel.html#Discord_IMessageChannel_SendMessageAsync_System_String_System_Boolean_Discord_Embed_Discord_RequestOptions_">SendMessageAsync(String, Boolean, Embed, RequestOptions)</a>.
|
||||
Please visit its documentation for more details on this method.</p>
|
||||
</div>
|
||||
<h5 class="exceptions">Exceptions</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
|
|
@ -1271,7 +1402,8 @@ Please visit its documentation for more details on this method.</p>
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketDMChannel_TriggerTypingAsync_" data-uid="Discord.WebSocket.SocketDMChannel.TriggerTypingAsync*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketDMChannel_TriggerTypingAsync_Discord_RequestOptions_" data-uid="Discord.WebSocket.SocketDMChannel.TriggerTypingAsync(Discord.RequestOptions)">TriggerTypingAsync(RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Broadcasts the "user is typing" message to all users in this channel, lasting 10 seconds.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1290,7 +1422,8 @@ Please visit its documentation for more details on this method.</p>
|
|||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1305,7 +1438,8 @@ Please visit its documentation for more details on this method.</p>
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous operation that triggers the broadcast.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1320,7 +1454,8 @@ Please visit its documentation for more details on this method.</p>
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketDMChannel_Discord_IChannel_GetUserAsync_" data-uid="Discord.WebSocket.SocketDMChannel.Discord#IChannel#GetUserAsync*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketDMChannel_Discord_IChannel_GetUserAsync_System_UInt64_Discord_CacheMode_Discord_RequestOptions_" data-uid="Discord.WebSocket.SocketDMChannel.Discord#IChannel#GetUserAsync(System.UInt64,Discord.CacheMode,Discord.RequestOptions)">IChannel.GetUserAsync(UInt64, CacheMode, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a user in this channel.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1339,17 +1474,20 @@ Please visit its documentation for more details on this method.</p>
|
|||
<tr>
|
||||
<td><span class="xref">System.UInt64</span></td>
|
||||
<td><span class="parametername">id</span></td>
|
||||
<td></td>
|
||||
<td><p>The snowflake identifier of the user (e.g. <code>168693960628371456</code>).</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.CacheMode.html">CacheMode</a></td>
|
||||
<td><span class="parametername">mode</span></td>
|
||||
<td></td>
|
||||
<td><p>The <a class="xref" href="Discord.CacheMode.html">CacheMode</a> that determines whether the object should be fetched from cache.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1364,7 +1502,9 @@ Please visit its documentation for more details on this method.</p>
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span><<a class="xref" href="Discord.IUser.html">IUser</a>></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous get operation. The task result contains a user object that
|
||||
represents the found user; <code>null</code> if none is found.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1377,7 +1517,8 @@ Please visit its documentation for more details on this method.</p>
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketDMChannel_Discord_IChannel_Name_" data-uid="Discord.WebSocket.SocketDMChannel.Discord#IChannel#Name*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketDMChannel_Discord_IChannel_Name" data-uid="Discord.WebSocket.SocketDMChannel.Discord#IChannel#Name">IChannel.Name</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the name of this channel.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1394,7 +1535,8 @@ Please visit its documentation for more details on this method.</p>
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td></td>
|
||||
<td><p>A string containing the name of this channel.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1407,7 +1549,8 @@ Please visit its documentation for more details on this method.</p>
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketDMChannel_Discord_IDMChannel_Recipient_" data-uid="Discord.WebSocket.SocketDMChannel.Discord#IDMChannel#Recipient*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketDMChannel_Discord_IDMChannel_Recipient" data-uid="Discord.WebSocket.SocketDMChannel.Discord#IDMChannel#Recipient">IDMChannel.Recipient</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the recipient of all messages in this channel.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1424,7 +1567,8 @@ Please visit its documentation for more details on this method.</p>
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.IUser.html">IUser</a></td>
|
||||
<td></td>
|
||||
<td><p>A user object that represents the other user in this channel.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1437,7 +1581,8 @@ Please visit its documentation for more details on this method.</p>
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketDMChannel_Discord_IMessageChannel_GetMessageAsync_" data-uid="Discord.WebSocket.SocketDMChannel.Discord#IMessageChannel#GetMessageAsync*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketDMChannel_Discord_IMessageChannel_GetMessageAsync_System_UInt64_Discord_CacheMode_Discord_RequestOptions_" data-uid="Discord.WebSocket.SocketDMChannel.Discord#IMessageChannel#GetMessageAsync(System.UInt64,Discord.CacheMode,Discord.RequestOptions)">IMessageChannel.GetMessageAsync(UInt64, CacheMode, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a message from this message channel.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1456,17 +1601,20 @@ Please visit its documentation for more details on this method.</p>
|
|||
<tr>
|
||||
<td><span class="xref">System.UInt64</span></td>
|
||||
<td><span class="parametername">id</span></td>
|
||||
<td></td>
|
||||
<td><p>The snowflake identifier of the message.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.CacheMode.html">CacheMode</a></td>
|
||||
<td><span class="parametername">mode</span></td>
|
||||
<td></td>
|
||||
<td><p>The <a class="xref" href="Discord.CacheMode.html">CacheMode</a> that determines whether the object should be fetched from cache.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1481,7 +1629,9 @@ Please visit its documentation for more details on this method.</p>
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span><<a class="xref" href="Discord.IMessage.html">IMessage</a>></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents an asynchronous get operation for retrieving the message. The task result contains
|
||||
the retrieved message; <code>null</code> if no message is found with the specified identifier.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1494,7 +1644,8 @@ Please visit its documentation for more details on this method.</p>
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketDMChannel_Discord_IMessageChannel_GetPinnedMessagesAsync_" data-uid="Discord.WebSocket.SocketDMChannel.Discord#IMessageChannel#GetPinnedMessagesAsync*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketDMChannel_Discord_IMessageChannel_GetPinnedMessagesAsync_Discord_RequestOptions_" data-uid="Discord.WebSocket.SocketDMChannel.Discord#IMessageChannel#GetPinnedMessagesAsync(Discord.RequestOptions)">IMessageChannel.GetPinnedMessagesAsync(RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a collection of pinned messages in this channel.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1513,7 +1664,8 @@ Please visit its documentation for more details on this method.</p>
|
|||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1528,7 +1680,9 @@ Please visit its documentation for more details on this method.</p>
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span><<span class="xref">System.Collections.Generic.IReadOnlyCollection</span><<a class="xref" href="Discord.IMessage.html">IMessage</a>>></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous get operation for retrieving pinned messages in this channel.
|
||||
The task result contains a collection of messages found in the pinned messages.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1541,7 +1695,8 @@ Please visit its documentation for more details on this method.</p>
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketDMChannel_Discord_IMessageChannel_SendFileAsync_" data-uid="Discord.WebSocket.SocketDMChannel.Discord#IMessageChannel#SendFileAsync*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketDMChannel_Discord_IMessageChannel_SendFileAsync_System_IO_Stream_System_String_System_String_System_Boolean_Discord_Embed_Discord_RequestOptions_System_Boolean_" data-uid="Discord.WebSocket.SocketDMChannel.Discord#IMessageChannel#SendFileAsync(System.IO.Stream,System.String,System.String,System.Boolean,Discord.Embed,Discord.RequestOptions,System.Boolean)">IMessageChannel.SendFileAsync(Stream, String, String, Boolean, Embed, RequestOptions, Boolean)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Sends a file to this message channel with an optional caption.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1560,37 +1715,44 @@ Please visit its documentation for more details on this method.</p>
|
|||
<tr>
|
||||
<td><span class="xref">System.IO.Stream</span></td>
|
||||
<td><span class="parametername">stream</span></td>
|
||||
<td></td>
|
||||
<td><p>The <span class="xref">System.IO.Stream</span> of the file to be sent.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td><span class="parametername">filename</span></td>
|
||||
<td></td>
|
||||
<td><p>The name of the attachment.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td><span class="parametername">text</span></td>
|
||||
<td></td>
|
||||
<td><p>The message to be sent.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td><span class="parametername">isTTS</span></td>
|
||||
<td></td>
|
||||
<td><p>Whether the message should be read aloud by Discord or not.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.Embed.html">Embed</a></td>
|
||||
<td><span class="parametername">embed</span></td>
|
||||
<td></td>
|
||||
<td><p>The <a class="xref" href="Discord.EmbedType.html#Discord_EmbedType_Rich">Rich</a> <a class="xref" href="Discord.Embed.html">Embed</a> to be sent.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td><span class="parametername">isSpoiler</span></td>
|
||||
<td></td>
|
||||
<td><p>Whether the message attachment should be hidden as a spoiler.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1605,10 +1767,20 @@ Please visit its documentation for more details on this method.</p>
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span><<a class="xref" href="Discord.IUserMessage.html">IUserMessage</a>></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents an asynchronous send operation for delivering the message. The task result
|
||||
contains the sent message.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 id="Discord_WebSocket_SocketDMChannel_Discord_IMessageChannel_SendFileAsync_System_IO_Stream_System_String_System_String_System_Boolean_Discord_Embed_Discord_RequestOptions_System_Boolean__remarks">Remarks</h5>
|
||||
<div class="markdown level1 remarks"><p>This method sends a file as if you are uploading an attachment directly from your Discord client.</p>
|
||||
<div class="NOTE"><h5>note</h5><p>
|
||||
If you wish to upload an image and have it embedded in a <a class="xref" href="Discord.EmbedType.html#Discord_EmbedType_Rich">Rich</a> embed,
|
||||
you may upload the file and refer to the file with "attachment://filename.ext" in the
|
||||
<a class="xref" href="Discord.EmbedBuilder.html#Discord_EmbedBuilder_ImageUrl">ImageUrl</a>. See the example section for its usage.
|
||||
</p></div>
|
||||
</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_WebSocket_SocketDMChannel_Discord_IMessageChannel_SendFileAsync_System_String_System_String_System_Boolean_Discord_Embed_Discord_RequestOptions_System_Boolean_.md&value=---%0Auid%3A%20Discord.WebSocket.SocketDMChannel.Discord%23IMessageChannel%23SendFileAsync(System.String%2CSystem.String%2CSystem.Boolean%2CDiscord.Embed%2CDiscord.RequestOptions%2CSystem.Boolean)%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>
|
||||
|
|
@ -1618,7 +1790,8 @@ Please visit its documentation for more details on this method.</p>
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketDMChannel_Discord_IMessageChannel_SendFileAsync_" data-uid="Discord.WebSocket.SocketDMChannel.Discord#IMessageChannel#SendFileAsync*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketDMChannel_Discord_IMessageChannel_SendFileAsync_System_String_System_String_System_Boolean_Discord_Embed_Discord_RequestOptions_System_Boolean_" data-uid="Discord.WebSocket.SocketDMChannel.Discord#IMessageChannel#SendFileAsync(System.String,System.String,System.Boolean,Discord.Embed,Discord.RequestOptions,System.Boolean)">IMessageChannel.SendFileAsync(String, String, Boolean, Embed, RequestOptions, Boolean)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Sends a file to this message channel with an optional caption.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1637,32 +1810,38 @@ Please visit its documentation for more details on this method.</p>
|
|||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td><span class="parametername">filePath</span></td>
|
||||
<td></td>
|
||||
<td><p>The file path of the file.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td><span class="parametername">text</span></td>
|
||||
<td></td>
|
||||
<td><p>The message to be sent.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td><span class="parametername">isTTS</span></td>
|
||||
<td></td>
|
||||
<td><p>Whether the message should be read aloud by Discord or not.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.Embed.html">Embed</a></td>
|
||||
<td><span class="parametername">embed</span></td>
|
||||
<td></td>
|
||||
<td><p>The <a class="xref" href="Discord.EmbedType.html#Discord_EmbedType_Rich">Rich</a> <a class="xref" href="Discord.Embed.html">Embed</a> to be sent.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td><span class="parametername">isSpoiler</span></td>
|
||||
<td></td>
|
||||
<td><p>Whether the message attachment should be hidden as a spoiler.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1677,10 +1856,20 @@ Please visit its documentation for more details on this method.</p>
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span><<a class="xref" href="Discord.IUserMessage.html">IUserMessage</a>></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents an asynchronous send operation for delivering the message. The task result
|
||||
contains the sent message.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 id="Discord_WebSocket_SocketDMChannel_Discord_IMessageChannel_SendFileAsync_System_String_System_String_System_Boolean_Discord_Embed_Discord_RequestOptions_System_Boolean__remarks">Remarks</h5>
|
||||
<div class="markdown level1 remarks"><p>This method sends a file as if you are uploading an attachment directly from your Discord client.</p>
|
||||
<div class="NOTE"><h5>note</h5><p>
|
||||
If you wish to upload an image and have it embedded in a <a class="xref" href="Discord.EmbedType.html#Discord_EmbedType_Rich">Rich</a> embed,
|
||||
you may upload the file and refer to the file with "attachment://filename.ext" in the
|
||||
<a class="xref" href="Discord.EmbedBuilder.html#Discord_EmbedBuilder_ImageUrl">ImageUrl</a>. See the example section for its usage.
|
||||
</p></div>
|
||||
</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_WebSocket_SocketDMChannel_Discord_IMessageChannel_SendMessageAsync_System_String_System_Boolean_Discord_Embed_Discord_RequestOptions_.md&value=---%0Auid%3A%20Discord.WebSocket.SocketDMChannel.Discord%23IMessageChannel%23SendMessageAsync(System.String%2CSystem.Boolean%2CDiscord.Embed%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>
|
||||
|
|
@ -1690,7 +1879,8 @@ Please visit its documentation for more details on this method.</p>
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketDMChannel_Discord_IMessageChannel_SendMessageAsync_" data-uid="Discord.WebSocket.SocketDMChannel.Discord#IMessageChannel#SendMessageAsync*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketDMChannel_Discord_IMessageChannel_SendMessageAsync_System_String_System_Boolean_Discord_Embed_Discord_RequestOptions_" data-uid="Discord.WebSocket.SocketDMChannel.Discord#IMessageChannel#SendMessageAsync(System.String,System.Boolean,Discord.Embed,Discord.RequestOptions)">IMessageChannel.SendMessageAsync(String, Boolean, Embed, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Sends a message to this message channel.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1709,22 +1899,26 @@ Please visit its documentation for more details on this method.</p>
|
|||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td><span class="parametername">text</span></td>
|
||||
<td></td>
|
||||
<td><p>The message to be sent.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td><span class="parametername">isTTS</span></td>
|
||||
<td></td>
|
||||
<td><p>Determines whether the message should be read aloud by Discord or not.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.Embed.html">Embed</a></td>
|
||||
<td><span class="parametername">embed</span></td>
|
||||
<td></td>
|
||||
<td><p>The <a class="xref" href="Discord.EmbedType.html#Discord_EmbedType_Rich">Rich</a> <a class="xref" href="Discord.Embed.html">Embed</a> to be sent.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1739,7 +1933,9 @@ Please visit its documentation for more details on this method.</p>
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span><<a class="xref" href="Discord.IUserMessage.html">IUserMessage</a>></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents an asynchronous send operation for delivering the message. The task result
|
||||
contains the sent message.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1752,7 +1948,8 @@ Please visit its documentation for more details on this method.</p>
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketDMChannel_Discord_IPrivateChannel_Recipients_" data-uid="Discord.WebSocket.SocketDMChannel.Discord#IPrivateChannel#Recipients*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketDMChannel_Discord_IPrivateChannel_Recipients" data-uid="Discord.WebSocket.SocketDMChannel.Discord#IPrivateChannel#Recipients">IPrivateChannel.Recipients</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the users that can access this channel.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1769,7 +1966,8 @@ Please visit its documentation for more details on this method.</p>
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Collections.Generic.IReadOnlyCollection</span><<a class="xref" href="Discord.IUser.html">IUser</a>></td>
|
||||
<td></td>
|
||||
<td><p>A read-only collection of users that can access this channel.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
|
|||
File diff suppressed because it is too large
Load diff
|
|
@ -166,7 +166,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketGroupUser_AvatarId_" data-uid="Discord.WebSocket.SocketGroupUser.AvatarId*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketGroupUser_AvatarId" data-uid="Discord.WebSocket.SocketGroupUser.AvatarId">AvatarId</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the identifier of this user's avatar.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -230,7 +231,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketGroupUser_DiscriminatorValue_" data-uid="Discord.WebSocket.SocketGroupUser.DiscriminatorValue*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketGroupUser_DiscriminatorValue" data-uid="Discord.WebSocket.SocketGroupUser.DiscriminatorValue">DiscriminatorValue</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the per-username unique ID for this user.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -262,7 +264,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketGroupUser_IsBot_" data-uid="Discord.WebSocket.SocketGroupUser.IsBot*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketGroupUser_IsBot" data-uid="Discord.WebSocket.SocketGroupUser.IsBot">IsBot</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a value that indicates whether this user is identified as a bot.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -279,12 +282,17 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td></td>
|
||||
<td><p><code>true</code> if the user is a bot application; otherwise <code>false</code>.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 class="overrides">Overrides</h5>
|
||||
<div><a class="xref" href="Discord.WebSocket.SocketUser.html#Discord_WebSocket_SocketUser_IsBot">SocketUser.IsBot</a></div>
|
||||
<h5 id="Discord_WebSocket_SocketGroupUser_IsBot_remarks">Remarks</h5>
|
||||
<div class="markdown level1 remarks"><p>This property retrieves a value that indicates whether this user is a registered bot application
|
||||
(indicated by the blue BOT tag within the official chat client).</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_WebSocket_SocketGroupUser_IsWebhook.md&value=---%0Auid%3A%20Discord.WebSocket.SocketGroupUser.IsWebhook%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>
|
||||
|
|
@ -294,7 +302,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketGroupUser_IsWebhook_" data-uid="Discord.WebSocket.SocketGroupUser.IsWebhook*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketGroupUser_IsWebhook" data-uid="Discord.WebSocket.SocketGroupUser.IsWebhook">IsWebhook</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a value that indicates whether this user is a webhook user.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -311,7 +320,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td></td>
|
||||
<td><p><code>true</code> if the user is a webhook; otherwise <code>false</code>.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -326,7 +336,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketGroupUser_Username_" data-uid="Discord.WebSocket.SocketGroupUser.Username*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketGroupUser_Username" data-uid="Discord.WebSocket.SocketGroupUser.Username">Username</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the username for this user.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -360,7 +371,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketGroupUser_Discord_IVoiceState_IsDeafened_" data-uid="Discord.WebSocket.SocketGroupUser.Discord#IVoiceState#IsDeafened*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketGroupUser_Discord_IVoiceState_IsDeafened" data-uid="Discord.WebSocket.SocketGroupUser.Discord#IVoiceState#IsDeafened">IVoiceState.IsDeafened</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a value that indicates whether this user is deafened by the guild.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -377,7 +389,9 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td></td>
|
||||
<td><p><code>true</code> if the user is deafened (i.e. not permitted to listen to or speak to others) by the guild;
|
||||
otherwise <code>false</code>.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -390,7 +404,9 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketGroupUser_Discord_IVoiceState_IsMuted_" data-uid="Discord.WebSocket.SocketGroupUser.Discord#IVoiceState#IsMuted*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketGroupUser_Discord_IVoiceState_IsMuted" data-uid="Discord.WebSocket.SocketGroupUser.Discord#IVoiceState#IsMuted">IVoiceState.IsMuted</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a value that indicates whether this user is muted (i.e. not permitted to speak via voice) by the
|
||||
guild.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -407,7 +423,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td></td>
|
||||
<td><p><code>true</code> if this user is muted by the guild; otherwise <code>false</code>.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -420,7 +437,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketGroupUser_Discord_IVoiceState_IsSelfDeafened_" data-uid="Discord.WebSocket.SocketGroupUser.Discord#IVoiceState#IsSelfDeafened*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketGroupUser_Discord_IVoiceState_IsSelfDeafened" data-uid="Discord.WebSocket.SocketGroupUser.Discord#IVoiceState#IsSelfDeafened">IVoiceState.IsSelfDeafened</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a value that indicates whether this user has marked themselves as deafened.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -437,7 +455,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td></td>
|
||||
<td><p><code>true</code> if this user has deafened themselves (i.e. not permitted to listen to or speak to others); otherwise <code>false</code>.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -450,7 +469,9 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketGroupUser_Discord_IVoiceState_IsSelfMuted_" data-uid="Discord.WebSocket.SocketGroupUser.Discord#IVoiceState#IsSelfMuted*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketGroupUser_Discord_IVoiceState_IsSelfMuted" data-uid="Discord.WebSocket.SocketGroupUser.Discord#IVoiceState#IsSelfMuted">IVoiceState.IsSelfMuted</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a value that indicates whether this user has marked themselves as muted (i.e. not permitted to
|
||||
speak via voice).</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -467,7 +488,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td></td>
|
||||
<td><p><code>true</code> if this user has muted themselves; otherwise <code>false</code>.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -480,7 +502,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketGroupUser_Discord_IVoiceState_IsStreaming_" data-uid="Discord.WebSocket.SocketGroupUser.Discord#IVoiceState#IsStreaming*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketGroupUser_Discord_IVoiceState_IsStreaming" data-uid="Discord.WebSocket.SocketGroupUser.Discord#IVoiceState#IsStreaming">IVoiceState.IsStreaming</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a value that indicates if this user is streaming in a voice channel.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -497,7 +520,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td></td>
|
||||
<td><p><code>true</code> if the user is streaming; otherwise <code>false</code>.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -510,7 +534,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketGroupUser_Discord_IVoiceState_IsSuppressed_" data-uid="Discord.WebSocket.SocketGroupUser.Discord#IVoiceState#IsSuppressed*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketGroupUser_Discord_IVoiceState_IsSuppressed" data-uid="Discord.WebSocket.SocketGroupUser.Discord#IVoiceState#IsSuppressed">IVoiceState.IsSuppressed</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a value that indicates whether the user is muted by the current user.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -527,7 +552,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td></td>
|
||||
<td><p><code>true</code> if the guild is temporarily blocking audio to/from this user; otherwise <code>false</code>.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -540,7 +566,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketGroupUser_Discord_IVoiceState_VoiceChannel_" data-uid="Discord.WebSocket.SocketGroupUser.Discord#IVoiceState#VoiceChannel*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketGroupUser_Discord_IVoiceState_VoiceChannel" data-uid="Discord.WebSocket.SocketGroupUser.Discord#IVoiceState#VoiceChannel">IVoiceState.VoiceChannel</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the voice channel this user is currently in.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -557,7 +584,9 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.IVoiceChannel.html">IVoiceChannel</a></td>
|
||||
<td></td>
|
||||
<td><p>A generic voice channel object representing the voice channel that the user is currently in; <code>null</code>
|
||||
if none.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -570,7 +599,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketGroupUser_Discord_IVoiceState_VoiceSessionId_" data-uid="Discord.WebSocket.SocketGroupUser.Discord#IVoiceState#VoiceSessionId*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketGroupUser_Discord_IVoiceState_VoiceSessionId" data-uid="Discord.WebSocket.SocketGroupUser.Discord#IVoiceState#VoiceSessionId">IVoiceState.VoiceSessionId</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the unique identifier for this user's voice session.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
|
|||
File diff suppressed because it is too large
Load diff
|
|
@ -173,7 +173,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketGuildChannel_Name_" data-uid="Discord.WebSocket.SocketGuildChannel.Name*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketGuildChannel_Name" data-uid="Discord.WebSocket.SocketGuildChannel.Name">Name</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the name of this channel.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -190,7 +191,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td></td>
|
||||
<td><p>A string containing the name of this channel.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -203,7 +205,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketGuildChannel_PermissionOverwrites_" data-uid="Discord.WebSocket.SocketGuildChannel.PermissionOverwrites*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketGuildChannel_PermissionOverwrites" data-uid="Discord.WebSocket.SocketGuildChannel.PermissionOverwrites">PermissionOverwrites</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a collection of permission overwrites for this channel.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -220,7 +223,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Collections.Generic.IReadOnlyCollection</span><<a class="xref" href="Discord.Overwrite.html">Overwrite</a>></td>
|
||||
<td></td>
|
||||
<td><p>A collection of overwrites associated with this channel.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -233,7 +237,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketGuildChannel_Position_" data-uid="Discord.WebSocket.SocketGuildChannel.Position*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketGuildChannel_Position" data-uid="Discord.WebSocket.SocketGuildChannel.Position">Position</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the position of this channel.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -250,7 +255,9 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Int32</span></td>
|
||||
<td></td>
|
||||
<td><p>An <span class="xref">System.Int32</span> representing the position of this channel in the guild's channel list relative to
|
||||
others of the same type.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -421,7 +428,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketGuildChannel_DeleteAsync_" data-uid="Discord.WebSocket.SocketGuildChannel.DeleteAsync*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketGuildChannel_DeleteAsync_Discord_RequestOptions_" data-uid="Discord.WebSocket.SocketGuildChannel.DeleteAsync(Discord.RequestOptions)">DeleteAsync(RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Deletes this object and all its children.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -440,7 +448,8 @@
|
|||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -615,7 +624,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketGuildChannel_ModifyAsync_" data-uid="Discord.WebSocket.SocketGuildChannel.ModifyAsync*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketGuildChannel_ModifyAsync_System_Action_Discord_GuildChannelProperties__Discord_RequestOptions_" data-uid="Discord.WebSocket.SocketGuildChannel.ModifyAsync(System.Action{Discord.GuildChannelProperties},Discord.RequestOptions)">ModifyAsync(Action<GuildChannelProperties>, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Modifies this guild channel.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -634,12 +644,14 @@
|
|||
<tr>
|
||||
<td><span class="xref">System.Action</span><<a class="xref" href="Discord.GuildChannelProperties.html">GuildChannelProperties</a>></td>
|
||||
<td><span class="parametername">func</span></td>
|
||||
<td></td>
|
||||
<td><p>The delegate containing the properties to modify the channel with.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -654,10 +666,15 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous modification operation.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 id="Discord_WebSocket_SocketGuildChannel_ModifyAsync_System_Action_Discord_GuildChannelProperties__Discord_RequestOptions__remarks">Remarks</h5>
|
||||
<div class="markdown level1 remarks"><p>This method modifies the current guild channel with the specified properties. To see an example of this
|
||||
method and what properties are available, please refer to <a class="xref" href="Discord.GuildChannelProperties.html">GuildChannelProperties</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_WebSocket_SocketGuildChannel_RemovePermissionOverwriteAsync_Discord_IRole_Discord_RequestOptions_.md&value=---%0Auid%3A%20Discord.WebSocket.SocketGuildChannel.RemovePermissionOverwriteAsync(Discord.IRole%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>
|
||||
|
|
@ -815,7 +832,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketGuildChannel_Discord_IChannel_GetUserAsync_" data-uid="Discord.WebSocket.SocketGuildChannel.Discord#IChannel#GetUserAsync*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketGuildChannel_Discord_IChannel_GetUserAsync_System_UInt64_Discord_CacheMode_Discord_RequestOptions_" data-uid="Discord.WebSocket.SocketGuildChannel.Discord#IChannel#GetUserAsync(System.UInt64,Discord.CacheMode,Discord.RequestOptions)">IChannel.GetUserAsync(UInt64, CacheMode, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a user in this channel.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -834,17 +852,20 @@
|
|||
<tr>
|
||||
<td><span class="xref">System.UInt64</span></td>
|
||||
<td><span class="parametername">id</span></td>
|
||||
<td></td>
|
||||
<td><p>The snowflake identifier of the user (e.g. <code>168693960628371456</code>).</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.CacheMode.html">CacheMode</a></td>
|
||||
<td><span class="parametername">mode</span></td>
|
||||
<td></td>
|
||||
<td><p>The <a class="xref" href="Discord.CacheMode.html">CacheMode</a> that determines whether the object should be fetched from cache.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -859,7 +880,9 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span><<a class="xref" href="Discord.IUser.html">IUser</a>></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous get operation. The task result contains a user object that
|
||||
represents the found user; <code>null</code> if none is found.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -872,7 +895,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketGuildChannel_Discord_IGuildChannel_AddPermissionOverwriteAsync_" data-uid="Discord.WebSocket.SocketGuildChannel.Discord#IGuildChannel#AddPermissionOverwriteAsync*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketGuildChannel_Discord_IGuildChannel_AddPermissionOverwriteAsync_Discord_IRole_Discord_OverwritePermissions_Discord_RequestOptions_" data-uid="Discord.WebSocket.SocketGuildChannel.Discord#IGuildChannel#AddPermissionOverwriteAsync(Discord.IRole,Discord.OverwritePermissions,Discord.RequestOptions)">IGuildChannel.AddPermissionOverwriteAsync(IRole, OverwritePermissions, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Adds or updates the permission overwrite for the given role.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -891,17 +915,20 @@
|
|||
<tr>
|
||||
<td><a class="xref" href="Discord.IRole.html">IRole</a></td>
|
||||
<td><span class="parametername">role</span></td>
|
||||
<td></td>
|
||||
<td><p>The role to add the overwrite to.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.OverwritePermissions.html">OverwritePermissions</a></td>
|
||||
<td><span class="parametername">permissions</span></td>
|
||||
<td></td>
|
||||
<td><p>The overwrite to add to the role.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -916,7 +943,9 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
||||
<td></td>
|
||||
<td><p>A task representing the asynchronous permission operation for adding the specified permissions to the
|
||||
channel.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -929,7 +958,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketGuildChannel_Discord_IGuildChannel_AddPermissionOverwriteAsync_" data-uid="Discord.WebSocket.SocketGuildChannel.Discord#IGuildChannel#AddPermissionOverwriteAsync*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketGuildChannel_Discord_IGuildChannel_AddPermissionOverwriteAsync_Discord_IUser_Discord_OverwritePermissions_Discord_RequestOptions_" data-uid="Discord.WebSocket.SocketGuildChannel.Discord#IGuildChannel#AddPermissionOverwriteAsync(Discord.IUser,Discord.OverwritePermissions,Discord.RequestOptions)">IGuildChannel.AddPermissionOverwriteAsync(IUser, OverwritePermissions, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Adds or updates the permission overwrite for the given user.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -948,17 +978,20 @@
|
|||
<tr>
|
||||
<td><a class="xref" href="Discord.IUser.html">IUser</a></td>
|
||||
<td><span class="parametername">user</span></td>
|
||||
<td></td>
|
||||
<td><p>The user to add the overwrite to.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.OverwritePermissions.html">OverwritePermissions</a></td>
|
||||
<td><span class="parametername">permissions</span></td>
|
||||
<td></td>
|
||||
<td><p>The overwrite to add to the user.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -973,7 +1006,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
||||
<td></td>
|
||||
<td><p>A task representing the asynchronous permission operation for adding the specified permissions to the channel.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -986,7 +1020,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketGuildChannel_Discord_IGuildChannel_GetPermissionOverwrite_" data-uid="Discord.WebSocket.SocketGuildChannel.Discord#IGuildChannel#GetPermissionOverwrite*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketGuildChannel_Discord_IGuildChannel_GetPermissionOverwrite_Discord_IRole_" data-uid="Discord.WebSocket.SocketGuildChannel.Discord#IGuildChannel#GetPermissionOverwrite(Discord.IRole)">IGuildChannel.GetPermissionOverwrite(IRole)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the permission overwrite for a specific role.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1005,7 +1040,8 @@
|
|||
<tr>
|
||||
<td><a class="xref" href="Discord.IRole.html">IRole</a></td>
|
||||
<td><span class="parametername">role</span></td>
|
||||
<td></td>
|
||||
<td><p>The role to get the overwrite from.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1020,7 +1056,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Nullable</span><<a class="xref" href="Discord.OverwritePermissions.html">OverwritePermissions</a>></td>
|
||||
<td></td>
|
||||
<td><p>An overwrite object for the targeted role; <code>null</code> if none is set.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1033,7 +1070,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketGuildChannel_Discord_IGuildChannel_GetPermissionOverwrite_" data-uid="Discord.WebSocket.SocketGuildChannel.Discord#IGuildChannel#GetPermissionOverwrite*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketGuildChannel_Discord_IGuildChannel_GetPermissionOverwrite_Discord_IUser_" data-uid="Discord.WebSocket.SocketGuildChannel.Discord#IGuildChannel#GetPermissionOverwrite(Discord.IUser)">IGuildChannel.GetPermissionOverwrite(IUser)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the permission overwrite for a specific user.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1052,7 +1090,8 @@
|
|||
<tr>
|
||||
<td><a class="xref" href="Discord.IUser.html">IUser</a></td>
|
||||
<td><span class="parametername">user</span></td>
|
||||
<td></td>
|
||||
<td><p>The user to get the overwrite from.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1067,7 +1106,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Nullable</span><<a class="xref" href="Discord.OverwritePermissions.html">OverwritePermissions</a>></td>
|
||||
<td></td>
|
||||
<td><p>An overwrite object for the targeted user; <code>null</code> if none is set.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1080,7 +1120,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketGuildChannel_Discord_IGuildChannel_GetUserAsync_" data-uid="Discord.WebSocket.SocketGuildChannel.Discord#IGuildChannel#GetUserAsync*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketGuildChannel_Discord_IGuildChannel_GetUserAsync_System_UInt64_Discord_CacheMode_Discord_RequestOptions_" data-uid="Discord.WebSocket.SocketGuildChannel.Discord#IGuildChannel#GetUserAsync(System.UInt64,Discord.CacheMode,Discord.RequestOptions)">IGuildChannel.GetUserAsync(UInt64, CacheMode, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a user in this channel.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1099,17 +1140,20 @@
|
|||
<tr>
|
||||
<td><span class="xref">System.UInt64</span></td>
|
||||
<td><span class="parametername">id</span></td>
|
||||
<td></td>
|
||||
<td><p>The snowflake identifier of the user.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.CacheMode.html">CacheMode</a></td>
|
||||
<td><span class="parametername">mode</span></td>
|
||||
<td></td>
|
||||
<td><p>The <a class="xref" href="Discord.CacheMode.html">CacheMode</a> that determines whether the object should be fetched from cache.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1124,7 +1168,9 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span><<a class="xref" href="Discord.IGuildUser.html">IGuildUser</a>></td>
|
||||
<td></td>
|
||||
<td><p>A task representing the asynchronous get operation. The task result contains a guild user object that
|
||||
represents the user; <code>null</code> if none is found.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1137,7 +1183,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketGuildChannel_Discord_IGuildChannel_Guild_" data-uid="Discord.WebSocket.SocketGuildChannel.Discord#IGuildChannel#Guild*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketGuildChannel_Discord_IGuildChannel_Guild" data-uid="Discord.WebSocket.SocketGuildChannel.Discord#IGuildChannel#Guild">IGuildChannel.Guild</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the guild associated with this channel.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1154,7 +1201,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.IGuild.html">IGuild</a></td>
|
||||
<td></td>
|
||||
<td><p>A guild object that this channel belongs to.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1167,7 +1215,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketGuildChannel_Discord_IGuildChannel_GuildId_" data-uid="Discord.WebSocket.SocketGuildChannel.Discord#IGuildChannel#GuildId*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketGuildChannel_Discord_IGuildChannel_GuildId" data-uid="Discord.WebSocket.SocketGuildChannel.Discord#IGuildChannel#GuildId">IGuildChannel.GuildId</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the guild ID associated with this channel.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1184,7 +1233,9 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.UInt64</span></td>
|
||||
<td></td>
|
||||
<td><p>An <span class="xref">System.UInt64</span> representing the guild snowflake identifier for the guild that this channel
|
||||
belongs to.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1197,7 +1248,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketGuildChannel_Discord_IGuildChannel_RemovePermissionOverwriteAsync_" data-uid="Discord.WebSocket.SocketGuildChannel.Discord#IGuildChannel#RemovePermissionOverwriteAsync*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketGuildChannel_Discord_IGuildChannel_RemovePermissionOverwriteAsync_Discord_IRole_Discord_RequestOptions_" data-uid="Discord.WebSocket.SocketGuildChannel.Discord#IGuildChannel#RemovePermissionOverwriteAsync(Discord.IRole,Discord.RequestOptions)">IGuildChannel.RemovePermissionOverwriteAsync(IRole, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Removes the permission overwrite for the given role, if one exists.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1216,12 +1268,14 @@
|
|||
<tr>
|
||||
<td><a class="xref" href="Discord.IRole.html">IRole</a></td>
|
||||
<td><span class="parametername">role</span></td>
|
||||
<td></td>
|
||||
<td><p>The role to remove the overwrite from.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1236,7 +1290,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
||||
<td></td>
|
||||
<td><p>A task representing the asynchronous operation for removing the specified permissions from the channel.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1249,7 +1304,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketGuildChannel_Discord_IGuildChannel_RemovePermissionOverwriteAsync_" data-uid="Discord.WebSocket.SocketGuildChannel.Discord#IGuildChannel#RemovePermissionOverwriteAsync*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketGuildChannel_Discord_IGuildChannel_RemovePermissionOverwriteAsync_Discord_IUser_Discord_RequestOptions_" data-uid="Discord.WebSocket.SocketGuildChannel.Discord#IGuildChannel#RemovePermissionOverwriteAsync(Discord.IUser,Discord.RequestOptions)">IGuildChannel.RemovePermissionOverwriteAsync(IUser, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Removes the permission overwrite for the given user, if one exists.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1268,12 +1324,14 @@
|
|||
<tr>
|
||||
<td><a class="xref" href="Discord.IUser.html">IUser</a></td>
|
||||
<td><span class="parametername">user</span></td>
|
||||
<td></td>
|
||||
<td><p>The user to remove the overwrite from.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1288,7 +1346,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
||||
<td></td>
|
||||
<td><p>A task representing the asynchronous operation for removing the specified permissions from the channel.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
|
|||
|
|
@ -197,7 +197,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketGuildUser_AvatarId_" data-uid="Discord.WebSocket.SocketGuildUser.AvatarId*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketGuildUser_AvatarId" data-uid="Discord.WebSocket.SocketGuildUser.AvatarId">AvatarId</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the identifier of this user's avatar.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -229,7 +230,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketGuildUser_DiscriminatorValue_" data-uid="Discord.WebSocket.SocketGuildUser.DiscriminatorValue*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketGuildUser_DiscriminatorValue" data-uid="Discord.WebSocket.SocketGuildUser.DiscriminatorValue">DiscriminatorValue</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the per-username unique ID for this user.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -292,7 +294,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketGuildUser_GuildPermissions_" data-uid="Discord.WebSocket.SocketGuildUser.GuildPermissions*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketGuildUser_GuildPermissions" data-uid="Discord.WebSocket.SocketGuildUser.GuildPermissions">GuildPermissions</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the guild-level permissions for this user.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -309,7 +312,9 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.GuildPermissions.html">GuildPermissions</a></td>
|
||||
<td></td>
|
||||
<td><p>A <a class="xref" href="Discord.GuildPermissions.html">GuildPermissions</a> structure for this user, representing what
|
||||
permissions this user has in the guild.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -357,7 +362,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketGuildUser_IsBot_" data-uid="Discord.WebSocket.SocketGuildUser.IsBot*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketGuildUser_IsBot" data-uid="Discord.WebSocket.SocketGuildUser.IsBot">IsBot</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a value that indicates whether this user is identified as a bot.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -374,12 +380,17 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td></td>
|
||||
<td><p><code>true</code> if the user is a bot application; otherwise <code>false</code>.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 class="overrides">Overrides</h5>
|
||||
<div><a class="xref" href="Discord.WebSocket.SocketUser.html#Discord_WebSocket_SocketUser_IsBot">SocketUser.IsBot</a></div>
|
||||
<h5 id="Discord_WebSocket_SocketGuildUser_IsBot_remarks">Remarks</h5>
|
||||
<div class="markdown level1 remarks"><p>This property retrieves a value that indicates whether this user is a registered bot application
|
||||
(indicated by the blue BOT tag within the official chat client).</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_WebSocket_SocketGuildUser_IsDeafened.md&value=---%0Auid%3A%20Discord.WebSocket.SocketGuildUser.IsDeafened%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>
|
||||
|
|
@ -389,7 +400,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketGuildUser_IsDeafened_" data-uid="Discord.WebSocket.SocketGuildUser.IsDeafened*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketGuildUser_IsDeafened" data-uid="Discord.WebSocket.SocketGuildUser.IsDeafened">IsDeafened</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a value that indicates whether this user is deafened by the guild.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -406,7 +418,9 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td></td>
|
||||
<td><p><code>true</code> if the user is deafened (i.e. not permitted to listen to or speak to others) by the guild;
|
||||
otherwise <code>false</code>.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -419,7 +433,9 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketGuildUser_IsMuted_" data-uid="Discord.WebSocket.SocketGuildUser.IsMuted*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketGuildUser_IsMuted" data-uid="Discord.WebSocket.SocketGuildUser.IsMuted">IsMuted</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a value that indicates whether this user is muted (i.e. not permitted to speak via voice) by the
|
||||
guild.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -436,7 +452,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td></td>
|
||||
<td><p><code>true</code> if this user is muted by the guild; otherwise <code>false</code>.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -449,7 +466,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketGuildUser_IsSelfDeafened_" data-uid="Discord.WebSocket.SocketGuildUser.IsSelfDeafened*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketGuildUser_IsSelfDeafened" data-uid="Discord.WebSocket.SocketGuildUser.IsSelfDeafened">IsSelfDeafened</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a value that indicates whether this user has marked themselves as deafened.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -466,7 +484,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td></td>
|
||||
<td><p><code>true</code> if this user has deafened themselves (i.e. not permitted to listen to or speak to others); otherwise <code>false</code>.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -479,7 +498,9 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketGuildUser_IsSelfMuted_" data-uid="Discord.WebSocket.SocketGuildUser.IsSelfMuted*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketGuildUser_IsSelfMuted" data-uid="Discord.WebSocket.SocketGuildUser.IsSelfMuted">IsSelfMuted</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a value that indicates whether this user has marked themselves as muted (i.e. not permitted to
|
||||
speak via voice).</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -496,7 +517,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td></td>
|
||||
<td><p><code>true</code> if this user has muted themselves; otherwise <code>false</code>.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -509,7 +531,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketGuildUser_IsStreaming_" data-uid="Discord.WebSocket.SocketGuildUser.IsStreaming*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketGuildUser_IsStreaming" data-uid="Discord.WebSocket.SocketGuildUser.IsStreaming">IsStreaming</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a value that indicates if this user is streaming in a voice channel.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -526,7 +549,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td></td>
|
||||
<td><p><code>true</code> if the user is streaming; otherwise <code>false</code>.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -539,7 +563,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketGuildUser_IsSuppressed_" data-uid="Discord.WebSocket.SocketGuildUser.IsSuppressed*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketGuildUser_IsSuppressed" data-uid="Discord.WebSocket.SocketGuildUser.IsSuppressed">IsSuppressed</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a value that indicates whether the user is muted by the current user.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -556,7 +581,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td></td>
|
||||
<td><p><code>true</code> if the guild is temporarily blocking audio to/from this user; otherwise <code>false</code>.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -569,7 +595,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketGuildUser_IsWebhook_" data-uid="Discord.WebSocket.SocketGuildUser.IsWebhook*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketGuildUser_IsWebhook" data-uid="Discord.WebSocket.SocketGuildUser.IsWebhook">IsWebhook</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a value that indicates whether this user is a webhook user.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -586,7 +613,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td></td>
|
||||
<td><p><code>true</code> if the user is a webhook; otherwise <code>false</code>.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -601,7 +629,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketGuildUser_JoinedAt_" data-uid="Discord.WebSocket.SocketGuildUser.JoinedAt*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketGuildUser_JoinedAt" data-uid="Discord.WebSocket.SocketGuildUser.JoinedAt">JoinedAt</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets when this user joined the guild.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -618,7 +647,9 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Nullable</span><<span class="xref">System.DateTimeOffset</span>></td>
|
||||
<td></td>
|
||||
<td><p>A <span class="xref">System.DateTimeOffset</span> representing the time of which the user has joined the guild;
|
||||
<code>null</code> when it cannot be obtained.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -631,7 +662,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketGuildUser_Nickname_" data-uid="Discord.WebSocket.SocketGuildUser.Nickname*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketGuildUser_Nickname" data-uid="Discord.WebSocket.SocketGuildUser.Nickname">Nickname</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the nickname for this user.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -648,7 +680,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td></td>
|
||||
<td><p>A string representing the nickname of the user; <code>null</code> if none is set.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -661,7 +694,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketGuildUser_PremiumSince_" data-uid="Discord.WebSocket.SocketGuildUser.PremiumSince*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketGuildUser_PremiumSince" data-uid="Discord.WebSocket.SocketGuildUser.PremiumSince">PremiumSince</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the date and time for when this user's guild boost began.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -678,7 +712,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Nullable</span><<span class="xref">System.DateTimeOffset</span>></td>
|
||||
<td></td>
|
||||
<td><p>A <span class="xref">System.DateTimeOffset</span> for when the user began boosting this guild; <code>null</code> if they are not boosting the guild.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -722,7 +757,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketGuildUser_Username_" data-uid="Discord.WebSocket.SocketGuildUser.Username*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketGuildUser_Username" data-uid="Discord.WebSocket.SocketGuildUser.Username">Username</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the username for this user.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -785,7 +821,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketGuildUser_VoiceSessionId_" data-uid="Discord.WebSocket.SocketGuildUser.VoiceSessionId*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketGuildUser_VoiceSessionId" data-uid="Discord.WebSocket.SocketGuildUser.VoiceSessionId">VoiceSessionId</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the unique identifier for this user's voice session.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -850,7 +887,8 @@ connected to a voice channel.</p>
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketGuildUser_AddRoleAsync_" data-uid="Discord.WebSocket.SocketGuildUser.AddRoleAsync*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketGuildUser_AddRoleAsync_Discord_IRole_Discord_RequestOptions_" data-uid="Discord.WebSocket.SocketGuildUser.AddRoleAsync(Discord.IRole,Discord.RequestOptions)">AddRoleAsync(IRole, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Adds the specified role to this user in the guild.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -869,12 +907,14 @@ connected to a voice channel.</p>
|
|||
<tr>
|
||||
<td><a class="xref" href="Discord.IRole.html">IRole</a></td>
|
||||
<td><span class="parametername">role</span></td>
|
||||
<td></td>
|
||||
<td><p>The role to be added to the user.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -889,7 +929,8 @@ connected to a voice channel.</p>
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous role addition operation.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -902,7 +943,8 @@ connected to a voice channel.</p>
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketGuildUser_AddRolesAsync_" data-uid="Discord.WebSocket.SocketGuildUser.AddRolesAsync*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketGuildUser_AddRolesAsync_System_Collections_Generic_IEnumerable_Discord_IRole__Discord_RequestOptions_" data-uid="Discord.WebSocket.SocketGuildUser.AddRolesAsync(System.Collections.Generic.IEnumerable{Discord.IRole},Discord.RequestOptions)">AddRolesAsync(IEnumerable<IRole>, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Adds the specified <code data-dev-comment-type="paramref" class="paramref">roles</code> to this user in the guild.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -921,12 +963,14 @@ connected to a voice channel.</p>
|
|||
<tr>
|
||||
<td><span class="xref">System.Collections.Generic.IEnumerable</span><<a class="xref" href="Discord.IRole.html">IRole</a>></td>
|
||||
<td><span class="parametername">roles</span></td>
|
||||
<td></td>
|
||||
<td><p>The roles to be added to the user.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -941,7 +985,8 @@ connected to a voice channel.</p>
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous role addition operation.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -954,7 +999,8 @@ connected to a voice channel.</p>
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketGuildUser_GetPermissions_" data-uid="Discord.WebSocket.SocketGuildUser.GetPermissions*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketGuildUser_GetPermissions_Discord_IGuildChannel_" data-uid="Discord.WebSocket.SocketGuildUser.GetPermissions(Discord.IGuildChannel)">GetPermissions(IGuildChannel)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the level permissions granted to this user to a given channel.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -973,7 +1019,8 @@ connected to a voice channel.</p>
|
|||
<tr>
|
||||
<td><a class="xref" href="Discord.IGuildChannel.html">IGuildChannel</a></td>
|
||||
<td><span class="parametername">channel</span></td>
|
||||
<td></td>
|
||||
<td><p>The channel to get the permission from.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -988,7 +1035,9 @@ connected to a voice channel.</p>
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.ChannelPermissions.html">ChannelPermissions</a></td>
|
||||
<td></td>
|
||||
<td><p>A <a class="xref" href="Discord.ChannelPermissions.html">ChannelPermissions</a> structure representing the permissions that a user has in the
|
||||
specified channel.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1001,7 +1050,8 @@ connected to a voice channel.</p>
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketGuildUser_KickAsync_" data-uid="Discord.WebSocket.SocketGuildUser.KickAsync*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketGuildUser_KickAsync_System_String_Discord_RequestOptions_" data-uid="Discord.WebSocket.SocketGuildUser.KickAsync(System.String,Discord.RequestOptions)">KickAsync(String, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Kicks this user from this guild.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1020,12 +1070,14 @@ connected to a voice channel.</p>
|
|||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td><span class="parametername">reason</span></td>
|
||||
<td></td>
|
||||
<td><p>The reason for the kick which will be recorded in the audit log.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1040,7 +1092,8 @@ connected to a voice channel.</p>
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous kick operation.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1053,7 +1106,8 @@ connected to a voice channel.</p>
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketGuildUser_ModifyAsync_" data-uid="Discord.WebSocket.SocketGuildUser.ModifyAsync*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketGuildUser_ModifyAsync_System_Action_Discord_GuildUserProperties__Discord_RequestOptions_" data-uid="Discord.WebSocket.SocketGuildUser.ModifyAsync(System.Action{Discord.GuildUserProperties},Discord.RequestOptions)">ModifyAsync(Action<GuildUserProperties>, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Modifies this user's properties in this guild.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1072,12 +1126,14 @@ connected to a voice channel.</p>
|
|||
<tr>
|
||||
<td><span class="xref">System.Action</span><<a class="xref" href="Discord.GuildUserProperties.html">GuildUserProperties</a>></td>
|
||||
<td><span class="parametername">func</span></td>
|
||||
<td></td>
|
||||
<td><p>The delegate containing the properties to modify the user with.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1092,10 +1148,15 @@ connected to a voice channel.</p>
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous modification operation.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 id="Discord_WebSocket_SocketGuildUser_ModifyAsync_System_Action_Discord_GuildUserProperties__Discord_RequestOptions__remarks">Remarks</h5>
|
||||
<div class="markdown level1 remarks"><p>This method modifies the current guild user with the specified properties. To see an example of this
|
||||
method and what properties are available, please refer to <a class="xref" href="Discord.GuildUserProperties.html">GuildUserProperties</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_WebSocket_SocketGuildUser_RemoveRoleAsync_Discord_IRole_Discord_RequestOptions_.md&value=---%0Auid%3A%20Discord.WebSocket.SocketGuildUser.RemoveRoleAsync(Discord.IRole%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>
|
||||
|
|
@ -1105,7 +1166,8 @@ connected to a voice channel.</p>
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketGuildUser_RemoveRoleAsync_" data-uid="Discord.WebSocket.SocketGuildUser.RemoveRoleAsync*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketGuildUser_RemoveRoleAsync_Discord_IRole_Discord_RequestOptions_" data-uid="Discord.WebSocket.SocketGuildUser.RemoveRoleAsync(Discord.IRole,Discord.RequestOptions)">RemoveRoleAsync(IRole, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Removes the specified <code data-dev-comment-type="paramref" class="paramref">role</code> from this user in the guild.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1124,12 +1186,14 @@ connected to a voice channel.</p>
|
|||
<tr>
|
||||
<td><a class="xref" href="Discord.IRole.html">IRole</a></td>
|
||||
<td><span class="parametername">role</span></td>
|
||||
<td></td>
|
||||
<td><p>The role to be removed from the user.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1144,7 +1208,8 @@ connected to a voice channel.</p>
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous role removal operation.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1157,7 +1222,8 @@ connected to a voice channel.</p>
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketGuildUser_RemoveRolesAsync_" data-uid="Discord.WebSocket.SocketGuildUser.RemoveRolesAsync*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketGuildUser_RemoveRolesAsync_System_Collections_Generic_IEnumerable_Discord_IRole__Discord_RequestOptions_" data-uid="Discord.WebSocket.SocketGuildUser.RemoveRolesAsync(System.Collections.Generic.IEnumerable{Discord.IRole},Discord.RequestOptions)">RemoveRolesAsync(IEnumerable<IRole>, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Removes the specified <code data-dev-comment-type="paramref" class="paramref">roles</code> from this user in the guild.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1176,12 +1242,14 @@ connected to a voice channel.</p>
|
|||
<tr>
|
||||
<td><span class="xref">System.Collections.Generic.IEnumerable</span><<a class="xref" href="Discord.IRole.html">IRole</a>></td>
|
||||
<td><span class="parametername">roles</span></td>
|
||||
<td></td>
|
||||
<td><p>The roles to be removed from the user.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1196,7 +1264,8 @@ connected to a voice channel.</p>
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous role removal operation.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1211,7 +1280,8 @@ connected to a voice channel.</p>
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketGuildUser_Discord_IGuildUser_Guild_" data-uid="Discord.WebSocket.SocketGuildUser.Discord#IGuildUser#Guild*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketGuildUser_Discord_IGuildUser_Guild" data-uid="Discord.WebSocket.SocketGuildUser.Discord#IGuildUser#Guild">IGuildUser.Guild</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the guild for this user.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1228,7 +1298,8 @@ connected to a voice channel.</p>
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.IGuild.html">IGuild</a></td>
|
||||
<td></td>
|
||||
<td><p>A guild object that this user belongs to.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1241,7 +1312,8 @@ connected to a voice channel.</p>
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketGuildUser_Discord_IGuildUser_GuildId_" data-uid="Discord.WebSocket.SocketGuildUser.Discord#IGuildUser#GuildId*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketGuildUser_Discord_IGuildUser_GuildId" data-uid="Discord.WebSocket.SocketGuildUser.Discord#IGuildUser#GuildId">IGuildUser.GuildId</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the ID of the guild for this user.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1258,7 +1330,8 @@ connected to a voice channel.</p>
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.UInt64</span></td>
|
||||
<td></td>
|
||||
<td><p>An <span class="xref">System.UInt64</span> representing the snowflake identifier of the guild that this user belongs to.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1271,7 +1344,8 @@ connected to a voice channel.</p>
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketGuildUser_Discord_IGuildUser_RoleIds_" data-uid="Discord.WebSocket.SocketGuildUser.Discord#IGuildUser#RoleIds*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketGuildUser_Discord_IGuildUser_RoleIds" data-uid="Discord.WebSocket.SocketGuildUser.Discord#IGuildUser#RoleIds">IGuildUser.RoleIds</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a collection of IDs for the roles that this user currently possesses in the guild.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1288,10 +1362,17 @@ connected to a voice channel.</p>
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Collections.Generic.IReadOnlyCollection</span><<span class="xref">System.UInt64</span>></td>
|
||||
<td></td>
|
||||
<td><p>A read-only collection of <span class="xref">System.UInt64</span>, each representing a snowflake identifier for a role that
|
||||
this user possesses.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 id="Discord_WebSocket_SocketGuildUser_Discord_IGuildUser_RoleIds_remarks">Remarks</h5>
|
||||
<div class="markdown level1 remarks"><p>This property returns a read-only collection of the identifiers of the roles that this user possesses.
|
||||
For WebSocket users, a Roles property can be found in place of this property. Due to the REST
|
||||
implementation, only a collection of identifiers can be retrieved instead of the full role objects.</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_WebSocket_SocketGuildUser_Discord_IVoiceState_VoiceChannel.md&value=---%0Auid%3A%20Discord.WebSocket.SocketGuildUser.Discord%23IVoiceState%23VoiceChannel%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>
|
||||
|
|
@ -1301,7 +1382,8 @@ connected to a voice channel.</p>
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketGuildUser_Discord_IVoiceState_VoiceChannel_" data-uid="Discord.WebSocket.SocketGuildUser.Discord#IVoiceState#VoiceChannel*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketGuildUser_Discord_IVoiceState_VoiceChannel" data-uid="Discord.WebSocket.SocketGuildUser.Discord#IVoiceState#VoiceChannel">IVoiceState.VoiceChannel</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the voice channel this user is currently in.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1318,7 +1400,9 @@ connected to a voice channel.</p>
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.IVoiceChannel.html">IVoiceChannel</a></td>
|
||||
<td></td>
|
||||
<td><p>A generic voice channel object representing the voice channel that the user is currently in; <code>null</code>
|
||||
if none.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
|
|||
|
|
@ -132,7 +132,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketMessage_Activity_" data-uid="Discord.WebSocket.SocketMessage.Activity*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketMessage_Activity" data-uid="Discord.WebSocket.SocketMessage.Activity">Activity</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the activity associated with a message.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -149,10 +150,15 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.MessageActivity.html">MessageActivity</a></td>
|
||||
<td></td>
|
||||
<td><p>A message's activity, if any is associated.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 id="Discord_WebSocket_SocketMessage_Activity_remarks">Remarks</h5>
|
||||
<div class="markdown level1 remarks"><p>Sent with Rich Presence-related chat embeds. This often refers to activity that requires end-user's
|
||||
interaction, such as a Spotify Invite activity.</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_WebSocket_SocketMessage_Application.md&value=---%0Auid%3A%20Discord.WebSocket.SocketMessage.Application%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>
|
||||
|
|
@ -162,7 +168,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketMessage_Application_" data-uid="Discord.WebSocket.SocketMessage.Application*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketMessage_Application" data-uid="Discord.WebSocket.SocketMessage.Application">Application</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the application associated with a message.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -179,10 +186,14 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.MessageApplication.html">MessageApplication</a></td>
|
||||
<td></td>
|
||||
<td><p>A message's application, if any is associated.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 id="Discord_WebSocket_SocketMessage_Application_remarks">Remarks</h5>
|
||||
<div class="markdown level1 remarks"><p>Sent with Rich-Presence-related chat embeds.</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_WebSocket_SocketMessage_Attachments.md&value=---%0Auid%3A%20Discord.WebSocket.SocketMessage.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>
|
||||
|
|
@ -288,7 +299,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketMessage_Content_" data-uid="Discord.WebSocket.SocketMessage.Content*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketMessage_Content" data-uid="Discord.WebSocket.SocketMessage.Content">Content</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the content for this message.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -305,7 +317,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td></td>
|
||||
<td><p>A string that contains the body of the message; note that this field may be empty if there is an embed.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -318,7 +331,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketMessage_CreatedAt_" data-uid="Discord.WebSocket.SocketMessage.CreatedAt*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketMessage_CreatedAt" data-uid="Discord.WebSocket.SocketMessage.CreatedAt">CreatedAt</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets when the snowflake was created.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -335,7 +349,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.DateTimeOffset</span></td>
|
||||
<td></td>
|
||||
<td><p>A <span class="xref">System.DateTimeOffset</span> representing when the entity was first created.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -348,7 +363,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketMessage_EditedTimestamp_" data-uid="Discord.WebSocket.SocketMessage.EditedTimestamp*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketMessage_EditedTimestamp" data-uid="Discord.WebSocket.SocketMessage.EditedTimestamp">EditedTimestamp</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<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">
|
||||
|
|
@ -365,7 +381,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Nullable</span><<span class="xref">System.DateTimeOffset</span>></td>
|
||||
<td></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>
|
||||
|
|
@ -410,7 +427,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketMessage_IsPinned_" data-uid="Discord.WebSocket.SocketMessage.IsPinned*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketMessage_IsPinned" data-uid="Discord.WebSocket.SocketMessage.IsPinned">IsPinned</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<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">
|
||||
|
|
@ -427,7 +445,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td></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>
|
||||
|
|
@ -440,7 +459,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketMessage_IsSuppressed_" data-uid="Discord.WebSocket.SocketMessage.IsSuppressed*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketMessage_IsSuppressed" data-uid="Discord.WebSocket.SocketMessage.IsSuppressed">IsSuppressed</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<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">
|
||||
|
|
@ -457,7 +477,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td></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>
|
||||
|
|
@ -470,7 +491,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketMessage_IsTTS_" data-uid="Discord.WebSocket.SocketMessage.IsTTS*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketMessage_IsTTS" data-uid="Discord.WebSocket.SocketMessage.IsTTS">IsTTS</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<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">
|
||||
|
|
@ -487,7 +509,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td></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>
|
||||
|
|
@ -596,7 +619,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketMessage_Reactions_" data-uid="Discord.WebSocket.SocketMessage.Reactions*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketMessage_Reactions" data-uid="Discord.WebSocket.SocketMessage.Reactions">Reactions</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets all reactions included in this message.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -626,7 +650,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketMessage_Reference_" data-uid="Discord.WebSocket.SocketMessage.Reference*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketMessage_Reference" data-uid="Discord.WebSocket.SocketMessage.Reference">Reference</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the reference to the original message if it was crossposted.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -643,10 +668,15 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.MessageReference.html">MessageReference</a></td>
|
||||
<td></td>
|
||||
<td><p>A message's reference, if any is associated.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 id="Discord_WebSocket_SocketMessage_Reference_remarks">Remarks</h5>
|
||||
<div class="markdown level1 remarks"><p>Sent with Cross-posted messages, meaning they were published from news channels
|
||||
and received by subscriber channels.</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_WebSocket_SocketMessage_Source.md&value=---%0Auid%3A%20Discord.WebSocket.SocketMessage.Source%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>
|
||||
|
|
@ -656,7 +686,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketMessage_Source_" data-uid="Discord.WebSocket.SocketMessage.Source*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketMessage_Source" data-uid="Discord.WebSocket.SocketMessage.Source">Source</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the source type of this message.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -686,7 +717,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketMessage_Tags_" data-uid="Discord.WebSocket.SocketMessage.Tags*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketMessage_Tags" data-uid="Discord.WebSocket.SocketMessage.Tags">Tags</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<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">
|
||||
|
|
@ -716,7 +748,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketMessage_Timestamp_" data-uid="Discord.WebSocket.SocketMessage.Timestamp*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketMessage_Timestamp" data-uid="Discord.WebSocket.SocketMessage.Timestamp">Timestamp</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the time this message was sent.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -733,7 +766,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.DateTimeOffset</span></td>
|
||||
<td></td>
|
||||
<td><p>Time of when the message was sent.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -748,7 +782,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketMessage_AddReactionAsync_" data-uid="Discord.WebSocket.SocketMessage.AddReactionAsync*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketMessage_AddReactionAsync_Discord_IEmote_Discord_RequestOptions_" data-uid="Discord.WebSocket.SocketMessage.AddReactionAsync(Discord.IEmote,Discord.RequestOptions)">AddReactionAsync(IEmote, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Adds a reaction to this message.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -767,12 +802,14 @@
|
|||
<tr>
|
||||
<td><a class="xref" href="Discord.IEmote.html">IEmote</a></td>
|
||||
<td><span class="parametername">emote</span></td>
|
||||
<td></td>
|
||||
<td><p>The emoji used to react to this message.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -787,10 +824,15 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous operation for adding a reaction to this message.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 id="Discord_WebSocket_SocketMessage_AddReactionAsync_Discord_IEmote_Discord_RequestOptions__seealso">See Also</h5>
|
||||
<div class="seealso">
|
||||
<div><a class="xref" href="Discord.IEmote.html">IEmote</a></div>
|
||||
</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_WebSocket_SocketMessage_DeleteAsync_Discord_RequestOptions_.md&value=---%0Auid%3A%20Discord.WebSocket.SocketMessage.DeleteAsync(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>
|
||||
|
|
@ -800,7 +842,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketMessage_DeleteAsync_" data-uid="Discord.WebSocket.SocketMessage.DeleteAsync*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketMessage_DeleteAsync_Discord_RequestOptions_" data-uid="Discord.WebSocket.SocketMessage.DeleteAsync(Discord.RequestOptions)">DeleteAsync(RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Deletes this object and all its children.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -819,7 +862,8 @@
|
|||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -904,7 +948,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketMessage_RemoveAllReactionsAsync_" data-uid="Discord.WebSocket.SocketMessage.RemoveAllReactionsAsync*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketMessage_RemoveAllReactionsAsync_Discord_RequestOptions_" data-uid="Discord.WebSocket.SocketMessage.RemoveAllReactionsAsync(Discord.RequestOptions)">RemoveAllReactionsAsync(RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Removes all reactions from this message.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -923,7 +968,8 @@
|
|||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -938,7 +984,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous removal operation.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -951,7 +998,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketMessage_RemoveReactionAsync_" data-uid="Discord.WebSocket.SocketMessage.RemoveReactionAsync*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketMessage_RemoveReactionAsync_Discord_IEmote_Discord_IUser_Discord_RequestOptions_" data-uid="Discord.WebSocket.SocketMessage.RemoveReactionAsync(Discord.IEmote,Discord.IUser,Discord.RequestOptions)">RemoveReactionAsync(IEmote, IUser, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Removes a reaction from message.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -970,17 +1018,20 @@
|
|||
<tr>
|
||||
<td><a class="xref" href="Discord.IEmote.html">IEmote</a></td>
|
||||
<td><span class="parametername">emote</span></td>
|
||||
<td></td>
|
||||
<td><p>The emoji used to react to this message.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.IUser.html">IUser</a></td>
|
||||
<td><span class="parametername">user</span></td>
|
||||
<td></td>
|
||||
<td><p>The user that added the emoji.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -995,10 +1046,15 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous operation for removing a reaction to this message.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 id="Discord_WebSocket_SocketMessage_RemoveReactionAsync_Discord_IEmote_Discord_IUser_Discord_RequestOptions__seealso">See Also</h5>
|
||||
<div class="seealso">
|
||||
<div><a class="xref" href="Discord.IEmote.html">IEmote</a></div>
|
||||
</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_WebSocket_SocketMessage_RemoveReactionAsync_Discord_IEmote_System_UInt64_Discord_RequestOptions_.md&value=---%0Auid%3A%20Discord.WebSocket.SocketMessage.RemoveReactionAsync(Discord.IEmote%2CSystem.UInt64%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>
|
||||
|
|
@ -1008,7 +1064,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketMessage_RemoveReactionAsync_" data-uid="Discord.WebSocket.SocketMessage.RemoveReactionAsync*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketMessage_RemoveReactionAsync_Discord_IEmote_System_UInt64_Discord_RequestOptions_" data-uid="Discord.WebSocket.SocketMessage.RemoveReactionAsync(Discord.IEmote,System.UInt64,Discord.RequestOptions)">RemoveReactionAsync(IEmote, UInt64, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Removes a reaction from message.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1027,17 +1084,20 @@
|
|||
<tr>
|
||||
<td><a class="xref" href="Discord.IEmote.html">IEmote</a></td>
|
||||
<td><span class="parametername">emote</span></td>
|
||||
<td></td>
|
||||
<td><p>The emoji used to react to this message.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.UInt64</span></td>
|
||||
<td><span class="parametername">userId</span></td>
|
||||
<td></td>
|
||||
<td><p>The ID of the user that added the emoji.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1052,10 +1112,15 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous operation for removing a reaction to this message.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 id="Discord_WebSocket_SocketMessage_RemoveReactionAsync_Discord_IEmote_System_UInt64_Discord_RequestOptions__seealso">See Also</h5>
|
||||
<div class="seealso">
|
||||
<div><a class="xref" href="Discord.IEmote.html">IEmote</a></div>
|
||||
</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_WebSocket_SocketMessage_ToString.md&value=---%0Auid%3A%20Discord.WebSocket.SocketMessage.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>
|
||||
|
|
@ -1101,7 +1166,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketMessage_Discord_IMessage_Attachments_" data-uid="Discord.WebSocket.SocketMessage.Discord#IMessage#Attachments*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketMessage_Discord_IMessage_Attachments" data-uid="Discord.WebSocket.SocketMessage.Discord#IMessage#Attachments">IMessage.Attachments</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets all attachments included in this message.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1118,10 +1184,16 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Collections.Generic.IReadOnlyCollection</span><<a class="xref" href="Discord.IAttachment.html">IAttachment</a>></td>
|
||||
<td></td>
|
||||
<td><p>A read-only collection of attachments.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 id="Discord_WebSocket_SocketMessage_Discord_IMessage_Attachments_remarks">Remarks</h5>
|
||||
<div class="markdown level1 remarks"><p>This property gets a read-only collection of attachments associated with this message. Depending on the
|
||||
user's end-client, a sent message may contain one or more attachments. For example, mobile users may
|
||||
attach more than one file in their message, while the desktop client only allows for one.</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_WebSocket_SocketMessage_Discord_IMessage_Author.md&value=---%0Auid%3A%20Discord.WebSocket.SocketMessage.Discord%23IMessage%23Author%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>
|
||||
|
|
@ -1131,7 +1203,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketMessage_Discord_IMessage_Author_" data-uid="Discord.WebSocket.SocketMessage.Discord#IMessage#Author*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketMessage_Discord_IMessage_Author" data-uid="Discord.WebSocket.SocketMessage.Discord#IMessage#Author">IMessage.Author</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the author of this message.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1161,7 +1234,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketMessage_Discord_IMessage_Channel_" data-uid="Discord.WebSocket.SocketMessage.Discord#IMessage#Channel*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketMessage_Discord_IMessage_Channel" data-uid="Discord.WebSocket.SocketMessage.Discord#IMessage#Channel">IMessage.Channel</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the source channel of the message.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1191,7 +1265,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketMessage_Discord_IMessage_Embeds_" data-uid="Discord.WebSocket.SocketMessage.Discord#IMessage#Embeds*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketMessage_Discord_IMessage_Embeds" data-uid="Discord.WebSocket.SocketMessage.Discord#IMessage#Embeds">IMessage.Embeds</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets all embeds included in this message.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1208,7 +1283,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Collections.Generic.IReadOnlyCollection</span><<a class="xref" href="Discord.IEmbed.html">IEmbed</a>></td>
|
||||
<td></td>
|
||||
<td><p>A read-only collection of embed objects.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1221,7 +1297,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketMessage_Discord_IMessage_MentionedChannelIds_" data-uid="Discord.WebSocket.SocketMessage.Discord#IMessage#MentionedChannelIds*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketMessage_Discord_IMessage_MentionedChannelIds" data-uid="Discord.WebSocket.SocketMessage.Discord#IMessage#MentionedChannelIds">IMessage.MentionedChannelIds</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<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">
|
||||
|
|
@ -1238,7 +1315,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Collections.Generic.IReadOnlyCollection</span><<span class="xref">System.UInt64</span>></td>
|
||||
<td></td>
|
||||
<td><p>A read-only collection of channel IDs.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1251,7 +1329,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketMessage_Discord_IMessage_MentionedRoleIds_" data-uid="Discord.WebSocket.SocketMessage.Discord#IMessage#MentionedRoleIds*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketMessage_Discord_IMessage_MentionedRoleIds" data-uid="Discord.WebSocket.SocketMessage.Discord#IMessage#MentionedRoleIds">IMessage.MentionedRoleIds</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<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">
|
||||
|
|
@ -1268,7 +1347,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Collections.Generic.IReadOnlyCollection</span><<span class="xref">System.UInt64</span>></td>
|
||||
<td></td>
|
||||
<td><p>A read-only collection of role IDs.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1281,7 +1361,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketMessage_Discord_IMessage_MentionedUserIds_" data-uid="Discord.WebSocket.SocketMessage.Discord#IMessage#MentionedUserIds*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketMessage_Discord_IMessage_MentionedUserIds" data-uid="Discord.WebSocket.SocketMessage.Discord#IMessage#MentionedUserIds">IMessage.MentionedUserIds</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the IDs of users mentioned in this message.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1298,7 +1379,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Collections.Generic.IReadOnlyCollection</span><<span class="xref">System.UInt64</span>></td>
|
||||
<td></td>
|
||||
<td><p>A read-only collection of user IDs.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1311,7 +1393,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketMessage_Discord_IMessage_Type_" data-uid="Discord.WebSocket.SocketMessage.Discord#IMessage#Type*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketMessage_Discord_IMessage_Type" data-uid="Discord.WebSocket.SocketMessage.Discord#IMessage#Type">IMessage.Type</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the type of this system message.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
|
|||
|
|
@ -345,7 +345,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketNewsChannel_SlowModeInterval_" data-uid="Discord.WebSocket.SocketNewsChannel.SlowModeInterval*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketNewsChannel_SlowModeInterval" data-uid="Discord.WebSocket.SocketNewsChannel.SlowModeInterval">SlowModeInterval</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the current slow-mode delay for this channel.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -362,7 +363,9 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Int32</span></td>
|
||||
<td></td>
|
||||
<td><p>An <span class="xref">System.Int32</span> representing the time in seconds required before the user can send another
|
||||
message; <code>0</code> if disabled.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
|
|||
|
|
@ -115,7 +115,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketPresence_ActiveClients_" data-uid="Discord.WebSocket.SocketPresence.ActiveClients*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketPresence_ActiveClients" data-uid="Discord.WebSocket.SocketPresence.ActiveClients">ActiveClients</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the set of clients where this user is currently active.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -145,7 +146,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketPresence_Activity_" data-uid="Discord.WebSocket.SocketPresence.Activity*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketPresence_Activity" data-uid="Discord.WebSocket.SocketPresence.Activity">Activity</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the activity this user is currently doing.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -175,7 +177,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketPresence_Status_" data-uid="Discord.WebSocket.SocketPresence.Status*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketPresence_Status" data-uid="Discord.WebSocket.SocketPresence.Status">Status</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the current status of this user.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
|
|||
|
|
@ -152,7 +152,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketReaction_Emote_" data-uid="Discord.WebSocket.SocketReaction.Emote*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketReaction_Emote" data-uid="Discord.WebSocket.SocketReaction.Emote">Emote</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>The <a class="xref" href="Discord.IEmote.html">IEmote</a> used in the reaction.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
|
|||
|
|
@ -132,7 +132,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketRole_Color_" data-uid="Discord.WebSocket.SocketRole.Color*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketRole_Color" data-uid="Discord.WebSocket.SocketRole.Color">Color</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the color given to users of this role.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -149,7 +150,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.Color.html">Color</a></td>
|
||||
<td></td>
|
||||
<td><p>A <a class="xref" href="Discord.IRole.html#Discord_IRole_Color">Color</a> struct representing the color of this role.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -162,7 +164,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketRole_CreatedAt_" data-uid="Discord.WebSocket.SocketRole.CreatedAt*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketRole_CreatedAt" data-uid="Discord.WebSocket.SocketRole.CreatedAt">CreatedAt</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets when the snowflake was created.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -179,7 +182,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.DateTimeOffset</span></td>
|
||||
<td></td>
|
||||
<td><p>A <span class="xref">System.DateTimeOffset</span> representing when the entity was first created.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -256,7 +260,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketRole_IsHoisted_" data-uid="Discord.WebSocket.SocketRole.IsHoisted*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketRole_IsHoisted" data-uid="Discord.WebSocket.SocketRole.IsHoisted">IsHoisted</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a value that indicates whether the role can be separated in the user list.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -273,7 +278,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td></td>
|
||||
<td><p><code>true</code> if users of this role are separated in the user list; otherwise <code>false</code>.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -286,7 +292,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketRole_IsManaged_" data-uid="Discord.WebSocket.SocketRole.IsManaged*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketRole_IsManaged" data-uid="Discord.WebSocket.SocketRole.IsManaged">IsManaged</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a value that indicates whether the role is managed by Discord.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -303,7 +310,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td></td>
|
||||
<td><p><code>true</code> if this role is automatically managed by Discord; otherwise <code>false</code>.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -316,7 +324,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketRole_IsMentionable_" data-uid="Discord.WebSocket.SocketRole.IsMentionable*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketRole_IsMentionable" data-uid="Discord.WebSocket.SocketRole.IsMentionable">IsMentionable</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a value that indicates whether the role is mentionable.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -333,7 +342,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td></td>
|
||||
<td><p><code>true</code> if this role may be mentioned in messages; otherwise <code>false</code>.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -376,7 +386,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketRole_Mention_" data-uid="Discord.WebSocket.SocketRole.Mention*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketRole_Mention" data-uid="Discord.WebSocket.SocketRole.Mention">Mention</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Returns a special string used to mention this object.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -393,7 +404,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td></td>
|
||||
<td><p>A string that is recognized by Discord as a mention (e.g. <@168693960628371456>).</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -406,7 +418,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketRole_Name_" data-uid="Discord.WebSocket.SocketRole.Name*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketRole_Name" data-uid="Discord.WebSocket.SocketRole.Name">Name</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the name of this role.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -423,7 +436,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td></td>
|
||||
<td><p>A string containing the name of this role.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -436,7 +450,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketRole_Permissions_" data-uid="Discord.WebSocket.SocketRole.Permissions*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketRole_Permissions" data-uid="Discord.WebSocket.SocketRole.Permissions">Permissions</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the permissions granted to members of this role.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -453,7 +468,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.GuildPermissions.html">GuildPermissions</a></td>
|
||||
<td></td>
|
||||
<td><p>A <a class="xref" href="Discord.GuildPermissions.html">GuildPermissions</a> struct that this role possesses.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -466,7 +482,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketRole_Position_" data-uid="Discord.WebSocket.SocketRole.Position*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketRole_Position" data-uid="Discord.WebSocket.SocketRole.Position">Position</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets this role's position relative to other roles in the same guild.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -483,7 +500,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Int32</span></td>
|
||||
<td></td>
|
||||
<td><p>An <span class="xref">System.Int32</span> representing the position of the role in the role list of the guild.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -545,7 +563,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketRole_DeleteAsync_" data-uid="Discord.WebSocket.SocketRole.DeleteAsync*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketRole_DeleteAsync_Discord_RequestOptions_" data-uid="Discord.WebSocket.SocketRole.DeleteAsync(Discord.RequestOptions)">DeleteAsync(RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Deletes this object and all its children.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -564,7 +583,8 @@
|
|||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -592,7 +612,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketRole_ModifyAsync_" data-uid="Discord.WebSocket.SocketRole.ModifyAsync*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketRole_ModifyAsync_System_Action_Discord_RoleProperties__Discord_RequestOptions_" data-uid="Discord.WebSocket.SocketRole.ModifyAsync(System.Action{Discord.RoleProperties},Discord.RequestOptions)">ModifyAsync(Action<RoleProperties>, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Modifies this role.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -611,12 +632,14 @@
|
|||
<tr>
|
||||
<td><span class="xref">System.Action</span><<a class="xref" href="Discord.RoleProperties.html">RoleProperties</a>></td>
|
||||
<td><span class="parametername">func</span></td>
|
||||
<td></td>
|
||||
<td><p>A delegate containing the properties to modify the role with.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -631,10 +654,15 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous modification operation.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 id="Discord_WebSocket_SocketRole_ModifyAsync_System_Action_Discord_RoleProperties__Discord_RequestOptions__remarks">Remarks</h5>
|
||||
<div class="markdown level1 remarks"><p>This method modifies this role with the specified properties. To see an example of this
|
||||
method and what properties are available, please refer to <a class="xref" href="Discord.RoleProperties.html">RoleProperties</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_WebSocket_SocketRole_ToString.md&value=---%0Auid%3A%20Discord.WebSocket.SocketRole.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>
|
||||
|
|
@ -680,7 +708,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketRole_Discord_IRole_Guild_" data-uid="Discord.WebSocket.SocketRole.Discord#IRole#Guild*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketRole_Discord_IRole_Guild" data-uid="Discord.WebSocket.SocketRole.Discord#IRole#Guild">IRole.Guild</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the guild that owns this role.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -697,7 +726,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.IGuild.html">IGuild</a></td>
|
||||
<td></td>
|
||||
<td><p>A guild representing the parent guild of this role.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
|
|||
|
|
@ -166,7 +166,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketSelfUser_AvatarId_" data-uid="Discord.WebSocket.SocketSelfUser.AvatarId*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketSelfUser_AvatarId" data-uid="Discord.WebSocket.SocketSelfUser.AvatarId">AvatarId</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the identifier of this user's avatar.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -198,7 +199,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketSelfUser_DiscriminatorValue_" data-uid="Discord.WebSocket.SocketSelfUser.DiscriminatorValue*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketSelfUser_DiscriminatorValue" data-uid="Discord.WebSocket.SocketSelfUser.DiscriminatorValue">DiscriminatorValue</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the per-username unique ID for this user.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -230,7 +232,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketSelfUser_Email_" data-uid="Discord.WebSocket.SocketSelfUser.Email*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketSelfUser_Email" data-uid="Discord.WebSocket.SocketSelfUser.Email">Email</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the email associated with this user.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -260,7 +263,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketSelfUser_Flags_" data-uid="Discord.WebSocket.SocketSelfUser.Flags*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketSelfUser_Flags" data-uid="Discord.WebSocket.SocketSelfUser.Flags">Flags</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the flags that are applied to a user's account.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -277,10 +281,14 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.UserProperties.html">UserProperties</a></td>
|
||||
<td></td>
|
||||
<td><p>The value of flags for this user.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 id="Discord_WebSocket_SocketSelfUser_Flags_remarks">Remarks</h5>
|
||||
<div class="markdown level1 remarks"><p>This value is determined by bitwise OR-ing <a class="xref" href="Discord.UserProperties.html">UserProperties</a> values together.</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_WebSocket_SocketSelfUser_IsBot.md&value=---%0Auid%3A%20Discord.WebSocket.SocketSelfUser.IsBot%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>
|
||||
|
|
@ -290,7 +298,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketSelfUser_IsBot_" data-uid="Discord.WebSocket.SocketSelfUser.IsBot*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketSelfUser_IsBot" data-uid="Discord.WebSocket.SocketSelfUser.IsBot">IsBot</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a value that indicates whether this user is identified as a bot.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -307,12 +316,17 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td></td>
|
||||
<td><p><code>true</code> if the user is a bot application; otherwise <code>false</code>.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 class="overrides">Overrides</h5>
|
||||
<div><a class="xref" href="Discord.WebSocket.SocketUser.html#Discord_WebSocket_SocketUser_IsBot">SocketUser.IsBot</a></div>
|
||||
<h5 id="Discord_WebSocket_SocketSelfUser_IsBot_remarks">Remarks</h5>
|
||||
<div class="markdown level1 remarks"><p>This property retrieves a value that indicates whether this user is a registered bot application
|
||||
(indicated by the blue BOT tag within the official chat client).</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_WebSocket_SocketSelfUser_IsMfaEnabled.md&value=---%0Auid%3A%20Discord.WebSocket.SocketSelfUser.IsMfaEnabled%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>
|
||||
|
|
@ -322,7 +336,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketSelfUser_IsMfaEnabled_" data-uid="Discord.WebSocket.SocketSelfUser.IsMfaEnabled*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketSelfUser_IsMfaEnabled" data-uid="Discord.WebSocket.SocketSelfUser.IsMfaEnabled">IsMfaEnabled</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Indicates whether or not this user has MFA enabled on their account.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -339,7 +354,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td></td>
|
||||
<td><p><code>true</code> if this user has enabled multi-factor authentication on their account; <code>false</code> if not.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -352,7 +368,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketSelfUser_IsVerified_" data-uid="Discord.WebSocket.SocketSelfUser.IsVerified*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketSelfUser_IsVerified" data-uid="Discord.WebSocket.SocketSelfUser.IsVerified">IsVerified</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Indicates whether or not this user has their email verified.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -369,7 +386,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td></td>
|
||||
<td><p><code>true</code> if this user's email has been verified; <code>false</code> if not.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -382,7 +400,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketSelfUser_IsWebhook_" data-uid="Discord.WebSocket.SocketSelfUser.IsWebhook*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketSelfUser_IsWebhook" data-uid="Discord.WebSocket.SocketSelfUser.IsWebhook">IsWebhook</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a value that indicates whether this user is a webhook user.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -399,7 +418,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td></td>
|
||||
<td><p><code>true</code> if the user is a webhook; otherwise <code>false</code>.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -414,7 +434,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketSelfUser_Locale_" data-uid="Discord.WebSocket.SocketSelfUser.Locale*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketSelfUser_Locale" data-uid="Discord.WebSocket.SocketSelfUser.Locale">Locale</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the user's chosen language option.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -431,7 +452,9 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td></td>
|
||||
<td><p>The IETF language tag of the user's chosen region, if provided.
|
||||
For example, a locale of "English, US" is "en-US", "Chinese (Taiwan)" is "zh-TW", etc.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -444,7 +467,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketSelfUser_PremiumType_" data-uid="Discord.WebSocket.SocketSelfUser.PremiumType*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketSelfUser_PremiumType" data-uid="Discord.WebSocket.SocketSelfUser.PremiumType">PremiumType</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the type of Nitro subscription that is active on this user's account.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -461,10 +485,14 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.PremiumType.html">PremiumType</a></td>
|
||||
<td></td>
|
||||
<td><p>The type of Nitro subscription the user subscribes to, if any.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 id="Discord_WebSocket_SocketSelfUser_PremiumType_remarks">Remarks</h5>
|
||||
<div class="markdown level1 remarks"><p>This information may only be available with the identify OAuth scope.</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_WebSocket_SocketSelfUser_Username.md&value=---%0Auid%3A%20Discord.WebSocket.SocketSelfUser.Username%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>
|
||||
|
|
@ -474,7 +502,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketSelfUser_Username_" data-uid="Discord.WebSocket.SocketSelfUser.Username*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketSelfUser_Username" data-uid="Discord.WebSocket.SocketSelfUser.Username">Username</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the username for this user.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -508,7 +537,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketSelfUser_ModifyAsync_" data-uid="Discord.WebSocket.SocketSelfUser.ModifyAsync*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketSelfUser_ModifyAsync_System_Action_Discord_SelfUserProperties__Discord_RequestOptions_" data-uid="Discord.WebSocket.SocketSelfUser.ModifyAsync(System.Action{Discord.SelfUserProperties},Discord.RequestOptions)">ModifyAsync(Action<SelfUserProperties>, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Modifies the user's properties.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
|
|||
|
|
@ -237,7 +237,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketSystemMessage_Type_" data-uid="Discord.WebSocket.SocketSystemMessage.Type*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketSystemMessage_Type" data-uid="Discord.WebSocket.SocketSystemMessage.Type">Type</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the type of this system message.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
|
|||
File diff suppressed because it is too large
Load diff
|
|
@ -168,7 +168,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketUnknownUser_AvatarId_" data-uid="Discord.WebSocket.SocketUnknownUser.AvatarId*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketUnknownUser_AvatarId" data-uid="Discord.WebSocket.SocketUnknownUser.AvatarId">AvatarId</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the identifier of this user's avatar.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -200,7 +201,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketUnknownUser_DiscriminatorValue_" data-uid="Discord.WebSocket.SocketUnknownUser.DiscriminatorValue*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketUnknownUser_DiscriminatorValue" data-uid="Discord.WebSocket.SocketUnknownUser.DiscriminatorValue">DiscriminatorValue</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the per-username unique ID for this user.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -232,7 +234,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketUnknownUser_IsBot_" data-uid="Discord.WebSocket.SocketUnknownUser.IsBot*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketUnknownUser_IsBot" data-uid="Discord.WebSocket.SocketUnknownUser.IsBot">IsBot</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a value that indicates whether this user is identified as a bot.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -249,12 +252,17 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td></td>
|
||||
<td><p><code>true</code> if the user is a bot application; otherwise <code>false</code>.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 class="overrides">Overrides</h5>
|
||||
<div><a class="xref" href="Discord.WebSocket.SocketUser.html#Discord_WebSocket_SocketUser_IsBot">SocketUser.IsBot</a></div>
|
||||
<h5 id="Discord_WebSocket_SocketUnknownUser_IsBot_remarks">Remarks</h5>
|
||||
<div class="markdown level1 remarks"><p>This property retrieves a value that indicates whether this user is a registered bot application
|
||||
(indicated by the blue BOT tag within the official chat client).</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_WebSocket_SocketUnknownUser_IsWebhook.md&value=---%0Auid%3A%20Discord.WebSocket.SocketUnknownUser.IsWebhook%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>
|
||||
|
|
@ -264,7 +272,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketUnknownUser_IsWebhook_" data-uid="Discord.WebSocket.SocketUnknownUser.IsWebhook*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketUnknownUser_IsWebhook" data-uid="Discord.WebSocket.SocketUnknownUser.IsWebhook">IsWebhook</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a value that indicates whether this user is a webhook user.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -281,7 +290,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td></td>
|
||||
<td><p><code>true</code> if the user is a webhook; otherwise <code>false</code>.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -296,7 +306,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketUnknownUser_Username_" data-uid="Discord.WebSocket.SocketUnknownUser.Username*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketUnknownUser_Username" data-uid="Discord.WebSocket.SocketUnknownUser.Username">Username</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the username for this user.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
|
|||
|
|
@ -136,7 +136,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketUser_ActiveClients_" data-uid="Discord.WebSocket.SocketUser.ActiveClients*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketUser_ActiveClients" data-uid="Discord.WebSocket.SocketUser.ActiveClients">ActiveClients</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the set of clients where this user is currently active.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -166,7 +167,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketUser_Activity_" data-uid="Discord.WebSocket.SocketUser.Activity*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketUser_Activity" data-uid="Discord.WebSocket.SocketUser.Activity">Activity</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the activity this user is currently doing.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -196,7 +198,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketUser_AvatarId_" data-uid="Discord.WebSocket.SocketUser.AvatarId*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketUser_AvatarId" data-uid="Discord.WebSocket.SocketUser.AvatarId">AvatarId</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the identifier of this user's avatar.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -226,7 +229,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketUser_CreatedAt_" data-uid="Discord.WebSocket.SocketUser.CreatedAt*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketUser_CreatedAt" data-uid="Discord.WebSocket.SocketUser.CreatedAt">CreatedAt</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets when the snowflake was created.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -243,7 +247,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.DateTimeOffset</span></td>
|
||||
<td></td>
|
||||
<td><p>A <span class="xref">System.DateTimeOffset</span> representing when the entity was first created.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -256,7 +261,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketUser_Discriminator_" data-uid="Discord.WebSocket.SocketUser.Discriminator*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketUser_Discriminator" data-uid="Discord.WebSocket.SocketUser.Discriminator">Discriminator</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the per-username unique ID for this user.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -286,7 +292,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketUser_DiscriminatorValue_" data-uid="Discord.WebSocket.SocketUser.DiscriminatorValue*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketUser_DiscriminatorValue" data-uid="Discord.WebSocket.SocketUser.DiscriminatorValue">DiscriminatorValue</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the per-username unique ID for this user.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -316,7 +323,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketUser_IsBot_" data-uid="Discord.WebSocket.SocketUser.IsBot*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketUser_IsBot" data-uid="Discord.WebSocket.SocketUser.IsBot">IsBot</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a value that indicates whether this user is identified as a bot.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -333,10 +341,15 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td></td>
|
||||
<td><p><code>true</code> if the user is a bot application; otherwise <code>false</code>.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 id="Discord_WebSocket_SocketUser_IsBot_remarks">Remarks</h5>
|
||||
<div class="markdown level1 remarks"><p>This property retrieves a value that indicates whether this user is a registered bot application
|
||||
(indicated by the blue BOT tag within the official chat client).</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_WebSocket_SocketUser_IsWebhook.md&value=---%0Auid%3A%20Discord.WebSocket.SocketUser.IsWebhook%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>
|
||||
|
|
@ -346,7 +359,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketUser_IsWebhook_" data-uid="Discord.WebSocket.SocketUser.IsWebhook*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketUser_IsWebhook" data-uid="Discord.WebSocket.SocketUser.IsWebhook">IsWebhook</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a value that indicates whether this user is a webhook user.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -363,7 +377,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td></td>
|
||||
<td><p><code>true</code> if the user is a webhook; otherwise <code>false</code>.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -376,7 +391,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketUser_Mention_" data-uid="Discord.WebSocket.SocketUser.Mention*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketUser_Mention" data-uid="Discord.WebSocket.SocketUser.Mention">Mention</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Returns a special string used to mention this object.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -393,7 +409,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td></td>
|
||||
<td><p>A string that is recognized by Discord as a mention (e.g. <@168693960628371456>).</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -437,7 +454,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketUser_Status_" data-uid="Discord.WebSocket.SocketUser.Status*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketUser_Status" data-uid="Discord.WebSocket.SocketUser.Status">Status</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the current status of this user.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -467,7 +485,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketUser_Username_" data-uid="Discord.WebSocket.SocketUser.Username*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketUser_Username" data-uid="Discord.WebSocket.SocketUser.Username">Username</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the username for this user.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -499,7 +518,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketUser_GetAvatarUrl_" data-uid="Discord.WebSocket.SocketUser.GetAvatarUrl*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketUser_GetAvatarUrl_Discord_ImageFormat_System_UInt16_" data-uid="Discord.WebSocket.SocketUser.GetAvatarUrl(Discord.ImageFormat,System.UInt16)">GetAvatarUrl(ImageFormat, UInt16)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the avatar URL for this user.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -518,12 +538,14 @@
|
|||
<tr>
|
||||
<td><a class="xref" href="Discord.ImageFormat.html">ImageFormat</a></td>
|
||||
<td><span class="parametername">format</span></td>
|
||||
<td></td>
|
||||
<td><p>The format to return.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.UInt16</span></td>
|
||||
<td><span class="parametername">size</span></td>
|
||||
<td></td>
|
||||
<td><p>The size of the image to return in. This can be any power of two between 16 and 2048.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -538,10 +560,17 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td></td>
|
||||
<td><p>A string representing the user's avatar URL; <code>null</code> if the user does not have an avatar in place.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 id="Discord_WebSocket_SocketUser_GetAvatarUrl_Discord_ImageFormat_System_UInt16__remarks">Remarks</h5>
|
||||
<div class="markdown level1 remarks"><p>This property retrieves a URL for this user's avatar. In event that the user does not have a valid avatar
|
||||
(i.e. their avatar identifier is not set), this property will return <code>null</code>. If you wish to
|
||||
retrieve the default avatar for this user, consider using <a class="xref" href="Discord.IUser.html#Discord_IUser_GetDefaultAvatarUrl">GetDefaultAvatarUrl()</a> (see
|
||||
example).</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_WebSocket_SocketUser_GetDefaultAvatarUrl.md&value=---%0Auid%3A%20Discord.WebSocket.SocketUser.GetDefaultAvatarUrl%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>
|
||||
|
|
@ -551,7 +580,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketUser_GetDefaultAvatarUrl_" data-uid="Discord.WebSocket.SocketUser.GetDefaultAvatarUrl*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketUser_GetDefaultAvatarUrl" data-uid="Discord.WebSocket.SocketUser.GetDefaultAvatarUrl">GetDefaultAvatarUrl()</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the default avatar URL for this user.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -568,10 +598,16 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td></td>
|
||||
<td><p>A string representing the user's avatar URL.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 id="Discord_WebSocket_SocketUser_GetDefaultAvatarUrl_remarks">Remarks</h5>
|
||||
<div class="markdown level1 remarks"><p>This property retrieves a URL for this user's default avatar generated by Discord (Discord logo followed
|
||||
by a random color as its background). This property will always return a value as it is calculated based
|
||||
on the user's <a class="xref" href="Discord.IUser.html#Discord_IUser_DiscriminatorValue">DiscriminatorValue</a> (<code>discriminator % 5</code>).</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_WebSocket_SocketUser_GetOrCreateDMChannelAsync_Discord_RequestOptions_.md&value=---%0Auid%3A%20Discord.WebSocket.SocketUser.GetOrCreateDMChannelAsync(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>
|
||||
|
|
@ -581,7 +617,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketUser_GetOrCreateDMChannelAsync_" data-uid="Discord.WebSocket.SocketUser.GetOrCreateDMChannelAsync*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketUser_GetOrCreateDMChannelAsync_Discord_RequestOptions_" data-uid="Discord.WebSocket.SocketUser.GetOrCreateDMChannelAsync(Discord.RequestOptions)">GetOrCreateDMChannelAsync(RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the direct message channel of this user, or create one if it does not already exist.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -600,7 +637,8 @@
|
|||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -615,10 +653,22 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span><<a class="xref" href="Discord.IDMChannel.html">IDMChannel</a>></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous operation for getting or creating a DM channel. The task result
|
||||
contains the DM channel associated with this user.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 id="Discord_WebSocket_SocketUser_GetOrCreateDMChannelAsync_Discord_RequestOptions__remarks">Remarks</h5>
|
||||
<div class="markdown level1 remarks"><p>This method is used to obtain or create a channel used to send a direct message.</p>
|
||||
<div class="WARNING"><h5>warning</h5><p>
|
||||
In event that the current user cannot send a message to the target user, a channel can and will
|
||||
still be created by Discord. However, attempting to send a message will yield a
|
||||
<span class="xref">Discord.Net.HttpException</span> with a 403 as its
|
||||
<span class="xref">Discord.Net.HttpException.HttpCode</span>. There are currently no official workarounds by
|
||||
Discord.
|
||||
</p></div>
|
||||
</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_WebSocket_SocketUser_ToString.md&value=---%0Auid%3A%20Discord.WebSocket.SocketUser.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>
|
||||
|
|
|
|||
|
|
@ -207,7 +207,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketUserMessage_Attachments_" data-uid="Discord.WebSocket.SocketUserMessage.Attachments*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketUserMessage_Attachments" data-uid="Discord.WebSocket.SocketUserMessage.Attachments">Attachments</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Returns all attachments included in this message.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -224,7 +225,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Collections.Generic.IReadOnlyCollection</span><<a class="xref" href="Discord.Attachment.html">Attachment</a>></td>
|
||||
<td></td>
|
||||
<td><p>Collection of attachments.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -239,7 +241,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketUserMessage_EditedTimestamp_" data-uid="Discord.WebSocket.SocketUserMessage.EditedTimestamp*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketUserMessage_EditedTimestamp" data-uid="Discord.WebSocket.SocketUserMessage.EditedTimestamp">EditedTimestamp</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<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">
|
||||
|
|
@ -256,7 +259,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Nullable</span><<span class="xref">System.DateTimeOffset</span>></td>
|
||||
<td></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>
|
||||
|
|
@ -271,7 +275,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketUserMessage_Embeds_" data-uid="Discord.WebSocket.SocketUserMessage.Embeds*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketUserMessage_Embeds" data-uid="Discord.WebSocket.SocketUserMessage.Embeds">Embeds</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Returns all embeds included in this message.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -288,7 +293,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Collections.Generic.IReadOnlyCollection</span><<a class="xref" href="Discord.Embed.html">Embed</a>></td>
|
||||
<td></td>
|
||||
<td><p>Collection of embed objects.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -303,7 +309,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketUserMessage_IsPinned_" data-uid="Discord.WebSocket.SocketUserMessage.IsPinned*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketUserMessage_IsPinned" data-uid="Discord.WebSocket.SocketUserMessage.IsPinned">IsPinned</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<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">
|
||||
|
|
@ -320,7 +327,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td></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>
|
||||
|
|
@ -335,7 +343,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketUserMessage_IsSuppressed_" data-uid="Discord.WebSocket.SocketUserMessage.IsSuppressed*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketUserMessage_IsSuppressed" data-uid="Discord.WebSocket.SocketUserMessage.IsSuppressed">IsSuppressed</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<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">
|
||||
|
|
@ -352,7 +361,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td></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>
|
||||
|
|
@ -367,7 +377,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketUserMessage_IsTTS_" data-uid="Discord.WebSocket.SocketUserMessage.IsTTS*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketUserMessage_IsTTS" data-uid="Discord.WebSocket.SocketUserMessage.IsTTS">IsTTS</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<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">
|
||||
|
|
@ -384,7 +395,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td></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>
|
||||
|
|
@ -399,7 +411,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketUserMessage_MentionedChannels_" data-uid="Discord.WebSocket.SocketUserMessage.MentionedChannels*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketUserMessage_MentionedChannels" data-uid="Discord.WebSocket.SocketUserMessage.MentionedChannels">MentionedChannels</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Returns the channels mentioned in this message.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -416,7 +429,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Collections.Generic.IReadOnlyCollection</span><<a class="xref" href="Discord.WebSocket.SocketGuildChannel.html">SocketGuildChannel</a>></td>
|
||||
<td></td>
|
||||
<td><p>Collection of WebSocket-based guild channels.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -431,7 +445,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketUserMessage_MentionedRoles_" data-uid="Discord.WebSocket.SocketUserMessage.MentionedRoles*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketUserMessage_MentionedRoles" data-uid="Discord.WebSocket.SocketUserMessage.MentionedRoles">MentionedRoles</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Returns the roles mentioned in this message.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -448,7 +463,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Collections.Generic.IReadOnlyCollection</span><<a class="xref" href="Discord.WebSocket.SocketRole.html">SocketRole</a>></td>
|
||||
<td></td>
|
||||
<td><p>Collection of WebSocket-based roles.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -463,7 +479,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketUserMessage_MentionedUsers_" data-uid="Discord.WebSocket.SocketUserMessage.MentionedUsers*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketUserMessage_MentionedUsers" data-uid="Discord.WebSocket.SocketUserMessage.MentionedUsers">MentionedUsers</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Returns the users mentioned in this message.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -480,7 +497,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Collections.Generic.IReadOnlyCollection</span><<a class="xref" href="Discord.WebSocket.SocketUser.html">SocketUser</a>></td>
|
||||
<td></td>
|
||||
<td><p>Collection of WebSocket-based users.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -495,7 +513,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketUserMessage_Tags_" data-uid="Discord.WebSocket.SocketUserMessage.Tags*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketUserMessage_Tags" data-uid="Discord.WebSocket.SocketUserMessage.Tags">Tags</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<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">
|
||||
|
|
@ -529,7 +548,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketUserMessage_ModifyAsync_" data-uid="Discord.WebSocket.SocketUserMessage.ModifyAsync*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketUserMessage_ModifyAsync_System_Action_Discord_MessageProperties__Discord_RequestOptions_" data-uid="Discord.WebSocket.SocketUserMessage.ModifyAsync(System.Action{Discord.MessageProperties},Discord.RequestOptions)">ModifyAsync(Action<MessageProperties>, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<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">
|
||||
|
|
@ -548,12 +568,14 @@
|
|||
<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></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></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -568,10 +590,15 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous modification operation.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 id="Discord_WebSocket_SocketUserMessage_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>
|
||||
<h5 class="exceptions">Exceptions</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
|
|
@ -602,7 +629,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketUserMessage_ModifySuppressionAsync_" data-uid="Discord.WebSocket.SocketUserMessage.ModifySuppressionAsync*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketUserMessage_ModifySuppressionAsync_System_Boolean_Discord_RequestOptions_" data-uid="Discord.WebSocket.SocketUserMessage.ModifySuppressionAsync(System.Boolean,Discord.RequestOptions)">ModifySuppressionAsync(Boolean, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<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">
|
||||
|
|
@ -621,12 +649,14 @@
|
|||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td><span class="parametername">suppressEmbeds</span></td>
|
||||
<td></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></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -641,10 +671,14 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous modification operation.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 id="Discord_WebSocket_SocketUserMessage_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_WebSocket_SocketUserMessage_PinAsync_Discord_RequestOptions_.md&value=---%0Auid%3A%20Discord.WebSocket.SocketUserMessage.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>
|
||||
|
|
@ -654,7 +688,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketUserMessage_PinAsync_" data-uid="Discord.WebSocket.SocketUserMessage.PinAsync*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketUserMessage_PinAsync_Discord_RequestOptions_" data-uid="Discord.WebSocket.SocketUserMessage.PinAsync(Discord.RequestOptions)">PinAsync(RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<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">
|
||||
|
|
@ -673,7 +708,8 @@
|
|||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -688,7 +724,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous operation for pinning this message.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -701,7 +738,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketUserMessage_Resolve_" data-uid="Discord.WebSocket.SocketUserMessage.Resolve*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketUserMessage_Resolve_Discord_TagHandling_Discord_TagHandling_Discord_TagHandling_Discord_TagHandling_Discord_TagHandling_" data-uid="Discord.WebSocket.SocketUserMessage.Resolve(Discord.TagHandling,Discord.TagHandling,Discord.TagHandling,Discord.TagHandling,Discord.TagHandling)">Resolve(TagHandling, TagHandling, TagHandling, TagHandling, TagHandling)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<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">
|
||||
|
|
@ -720,27 +758,32 @@
|
|||
<tr>
|
||||
<td><a class="xref" href="Discord.TagHandling.html">TagHandling</a></td>
|
||||
<td><span class="parametername">userHandling</span></td>
|
||||
<td></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></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></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></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></td>
|
||||
<td><p>Determines how the emoji tag should be handled.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -840,7 +883,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketUserMessage_UnpinAsync_" data-uid="Discord.WebSocket.SocketUserMessage.UnpinAsync*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketUserMessage_UnpinAsync_Discord_RequestOptions_" data-uid="Discord.WebSocket.SocketUserMessage.UnpinAsync(Discord.RequestOptions)">UnpinAsync(RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<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">
|
||||
|
|
@ -859,7 +903,8 @@
|
|||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -874,7 +919,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous operation for unpinning this message.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
|
|||
|
|
@ -209,7 +209,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketVoiceChannel_Bitrate_" data-uid="Discord.WebSocket.SocketVoiceChannel.Bitrate*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketVoiceChannel_Bitrate" data-uid="Discord.WebSocket.SocketVoiceChannel.Bitrate">Bitrate</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the bit-rate that the clients in this voice channel are requested to use.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -226,7 +227,9 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Int32</span></td>
|
||||
<td></td>
|
||||
<td><p>An <span class="xref">System.Int32</span> representing the bit-rate (bps) that this voice channel defines and requests the
|
||||
client(s) to use.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -271,7 +274,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketVoiceChannel_CategoryId_" data-uid="Discord.WebSocket.SocketVoiceChannel.CategoryId*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketVoiceChannel_CategoryId" data-uid="Discord.WebSocket.SocketVoiceChannel.CategoryId">CategoryId</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the parent (category) ID of this channel in the guild's channel list.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -288,7 +292,9 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Nullable</span><<span class="xref">System.UInt64</span>></td>
|
||||
<td></td>
|
||||
<td><p>A <span class="xref">System.UInt64</span> representing the snowflake identifier of the parent of this channel;
|
||||
<code>null</code> if none is set.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -301,7 +307,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketVoiceChannel_UserLimit_" data-uid="Discord.WebSocket.SocketVoiceChannel.UserLimit*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketVoiceChannel_UserLimit" data-uid="Discord.WebSocket.SocketVoiceChannel.UserLimit">UserLimit</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the max number of users allowed to be connected to this channel at once.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -318,7 +325,9 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Nullable</span><<span class="xref">System.Int32</span>></td>
|
||||
<td></td>
|
||||
<td><p>An <span class="xref">System.Int32</span> representing the maximum number of users that are allowed to be connected to this
|
||||
channel at once; <code>null</code> if a limit is not set.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -331,7 +340,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketVoiceChannel_Users_" data-uid="Discord.WebSocket.SocketVoiceChannel.Users*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketVoiceChannel_Users" data-uid="Discord.WebSocket.SocketVoiceChannel.Users">Users</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a collection of users that are able to view the channel.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -348,7 +358,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Collections.Generic.IReadOnlyCollection</span><<a class="xref" href="Discord.WebSocket.SocketGuildUser.html">SocketGuildUser</a>></td>
|
||||
<td></td>
|
||||
<td><p>A read-only collection of users that can access the channel (i.e. the users seen in the user list).</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -365,7 +376,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketVoiceChannel_ConnectAsync_" data-uid="Discord.WebSocket.SocketVoiceChannel.ConnectAsync*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketVoiceChannel_ConnectAsync_System_Boolean_System_Boolean_System_Boolean_" data-uid="Discord.WebSocket.SocketVoiceChannel.ConnectAsync(System.Boolean,System.Boolean,System.Boolean)">ConnectAsync(Boolean, Boolean, Boolean)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Connects to this audio channel.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -384,17 +396,20 @@
|
|||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td><span class="parametername">selfDeaf</span></td>
|
||||
<td></td>
|
||||
<td><p>Determines whether the client should deaf itself upon connection.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td><span class="parametername">selfMute</span></td>
|
||||
<td></td>
|
||||
<td><p>Determines whether the client should mute itself upon connection.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td><span class="parametername">external</span></td>
|
||||
<td></td>
|
||||
<td><p>Determines whether the audio client is an external one or not.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -409,7 +424,9 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span><<a class="xref" href="Discord.Audio.IAudioClient.html">IAudioClient</a>></td>
|
||||
<td></td>
|
||||
<td><p>A task representing the asynchronous connection operation. The task result contains the
|
||||
<a class="xref" href="Discord.Audio.IAudioClient.html">IAudioClient</a> responsible for the connection.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -422,7 +439,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketVoiceChannel_CreateInviteAsync_" data-uid="Discord.WebSocket.SocketVoiceChannel.CreateInviteAsync*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketVoiceChannel_CreateInviteAsync_System_Nullable_System_Int32__System_Nullable_System_Int32__System_Boolean_System_Boolean_Discord_RequestOptions_" data-uid="Discord.WebSocket.SocketVoiceChannel.CreateInviteAsync(System.Nullable{System.Int32},System.Nullable{System.Int32},System.Boolean,System.Boolean,Discord.RequestOptions)">CreateInviteAsync(Nullable<Int32>, Nullable<Int32>, Boolean, Boolean, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Creates a new invite to this channel.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -441,27 +459,32 @@
|
|||
<tr>
|
||||
<td><span class="xref">System.Nullable</span><<span class="xref">System.Int32</span>></td>
|
||||
<td><span class="parametername">maxAge</span></td>
|
||||
<td></td>
|
||||
<td><p>The time (in seconds) until the invite expires. Set to <code>null</code> to never expire.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.Nullable</span><<span class="xref">System.Int32</span>></td>
|
||||
<td><span class="parametername">maxUses</span></td>
|
||||
<td></td>
|
||||
<td><p>The max amount of times this invite may be used. Set to <code>null</code> to have unlimited uses.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td><span class="parametername">isTemporary</span></td>
|
||||
<td></td>
|
||||
<td><p>If <code>true</code>, the user accepting this invite will be kicked from the guild after closing their client.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td><span class="parametername">isUnique</span></td>
|
||||
<td></td>
|
||||
<td><p>If <code>true</code>, don't try to reuse a similar invite (useful for creating many unique one time use invites).</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -476,7 +499,9 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span><<a class="xref" href="Discord.IInviteMetadata.html">IInviteMetadata</a>></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous invite creation operation. The task result contains an invite
|
||||
metadata object containing information for the created invite.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -489,7 +514,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketVoiceChannel_DisconnectAsync_" data-uid="Discord.WebSocket.SocketVoiceChannel.DisconnectAsync*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketVoiceChannel_DisconnectAsync" data-uid="Discord.WebSocket.SocketVoiceChannel.DisconnectAsync">DisconnectAsync()</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Disconnects from this audio channel.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -506,7 +532,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
||||
<td></td>
|
||||
<td><p>A task representing the asynchronous operation for disconnecting from the audio channel.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -519,7 +546,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketVoiceChannel_GetInvitesAsync_" data-uid="Discord.WebSocket.SocketVoiceChannel.GetInvitesAsync*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketVoiceChannel_GetInvitesAsync_Discord_RequestOptions_" data-uid="Discord.WebSocket.SocketVoiceChannel.GetInvitesAsync(Discord.RequestOptions)">GetInvitesAsync(RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a collection of all invites to this channel.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -538,7 +566,8 @@
|
|||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -553,7 +582,9 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span><<span class="xref">System.Collections.Generic.IReadOnlyCollection</span><<a class="xref" href="Discord.IInviteMetadata.html">IInviteMetadata</a>>></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous get operation. The task result contains a read-only collection
|
||||
of invite metadata that are created for this channel.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -615,7 +646,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketVoiceChannel_ModifyAsync_" data-uid="Discord.WebSocket.SocketVoiceChannel.ModifyAsync*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketVoiceChannel_ModifyAsync_System_Action_Discord_VoiceChannelProperties__Discord_RequestOptions_" data-uid="Discord.WebSocket.SocketVoiceChannel.ModifyAsync(System.Action{Discord.VoiceChannelProperties},Discord.RequestOptions)">ModifyAsync(Action<VoiceChannelProperties>, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Modifies this voice channel.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -634,12 +666,14 @@
|
|||
<tr>
|
||||
<td><span class="xref">System.Action</span><<a class="xref" href="Discord.VoiceChannelProperties.html">VoiceChannelProperties</a>></td>
|
||||
<td><span class="parametername">func</span></td>
|
||||
<td></td>
|
||||
<td><p>The properties to modify the channel with.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -654,10 +688,15 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous modification operation.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 id="Discord_WebSocket_SocketVoiceChannel_ModifyAsync_System_Action_Discord_VoiceChannelProperties__Discord_RequestOptions__seealso">See Also</h5>
|
||||
<div class="seealso">
|
||||
<div><a class="xref" href="Discord.VoiceChannelProperties.html">VoiceChannelProperties</a></div>
|
||||
</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_WebSocket_SocketVoiceChannel_SyncPermissionsAsync_Discord_RequestOptions_.md&value=---%0Auid%3A%20Discord.WebSocket.SocketVoiceChannel.SyncPermissionsAsync(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>
|
||||
|
|
@ -667,7 +706,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketVoiceChannel_SyncPermissionsAsync_" data-uid="Discord.WebSocket.SocketVoiceChannel.SyncPermissionsAsync*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketVoiceChannel_SyncPermissionsAsync_Discord_RequestOptions_" data-uid="Discord.WebSocket.SocketVoiceChannel.SyncPermissionsAsync(Discord.RequestOptions)">SyncPermissionsAsync(RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Syncs the permissions of this nested channel with its parent's.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -686,7 +726,8 @@
|
|||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -701,7 +742,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous operation for syncing channel permissions with its parent's.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -716,7 +758,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketVoiceChannel_Discord_IGuildChannel_GetUserAsync_" data-uid="Discord.WebSocket.SocketVoiceChannel.Discord#IGuildChannel#GetUserAsync*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketVoiceChannel_Discord_IGuildChannel_GetUserAsync_System_UInt64_Discord_CacheMode_Discord_RequestOptions_" data-uid="Discord.WebSocket.SocketVoiceChannel.Discord#IGuildChannel#GetUserAsync(System.UInt64,Discord.CacheMode,Discord.RequestOptions)">IGuildChannel.GetUserAsync(UInt64, CacheMode, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a user in this channel.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -735,17 +778,20 @@
|
|||
<tr>
|
||||
<td><span class="xref">System.UInt64</span></td>
|
||||
<td><span class="parametername">id</span></td>
|
||||
<td></td>
|
||||
<td><p>The snowflake identifier of the user.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.CacheMode.html">CacheMode</a></td>
|
||||
<td><span class="parametername">mode</span></td>
|
||||
<td></td>
|
||||
<td><p>The <a class="xref" href="Discord.CacheMode.html">CacheMode</a> that determines whether the object should be fetched from cache.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -760,7 +806,9 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span><<a class="xref" href="Discord.IGuildUser.html">IGuildUser</a>></td>
|
||||
<td></td>
|
||||
<td><p>A task representing the asynchronous get operation. The task result contains a guild user object that
|
||||
represents the user; <code>null</code> if none is found.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -773,7 +821,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketVoiceChannel_Discord_INestedChannel_GetCategoryAsync_" data-uid="Discord.WebSocket.SocketVoiceChannel.Discord#INestedChannel#GetCategoryAsync*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketVoiceChannel_Discord_INestedChannel_GetCategoryAsync_Discord_CacheMode_Discord_RequestOptions_" data-uid="Discord.WebSocket.SocketVoiceChannel.Discord#INestedChannel#GetCategoryAsync(Discord.CacheMode,Discord.RequestOptions)">INestedChannel.GetCategoryAsync(CacheMode, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the parent (category) channel of this channel.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -792,12 +841,14 @@
|
|||
<tr>
|
||||
<td><a class="xref" href="Discord.CacheMode.html">CacheMode</a></td>
|
||||
<td><span class="parametername">mode</span></td>
|
||||
<td></td>
|
||||
<td><p>The <a class="xref" href="Discord.CacheMode.html">CacheMode</a> that determines whether the object should be fetched from cache.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -812,7 +863,9 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span><<a class="xref" href="Discord.ICategoryChannel.html">ICategoryChannel</a>></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous get operation. The task result contains the category channel
|
||||
representing the parent of this channel; <code>null</code> if none is set.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
|
|||
|
|
@ -147,7 +147,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketVoiceState_IsDeafened_" data-uid="Discord.WebSocket.SocketVoiceState.IsDeafened*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketVoiceState_IsDeafened" data-uid="Discord.WebSocket.SocketVoiceState.IsDeafened">IsDeafened</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a value that indicates whether this user is deafened by the guild.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -164,7 +165,9 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td></td>
|
||||
<td><p><code>true</code> if the user is deafened (i.e. not permitted to listen to or speak to others) by the guild;
|
||||
otherwise <code>false</code>.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -177,7 +180,9 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketVoiceState_IsMuted_" data-uid="Discord.WebSocket.SocketVoiceState.IsMuted*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketVoiceState_IsMuted" data-uid="Discord.WebSocket.SocketVoiceState.IsMuted">IsMuted</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a value that indicates whether this user is muted (i.e. not permitted to speak via voice) by the
|
||||
guild.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -194,7 +199,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td></td>
|
||||
<td><p><code>true</code> if this user is muted by the guild; otherwise <code>false</code>.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -207,7 +213,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketVoiceState_IsSelfDeafened_" data-uid="Discord.WebSocket.SocketVoiceState.IsSelfDeafened*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketVoiceState_IsSelfDeafened" data-uid="Discord.WebSocket.SocketVoiceState.IsSelfDeafened">IsSelfDeafened</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a value that indicates whether this user has marked themselves as deafened.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -224,7 +231,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td></td>
|
||||
<td><p><code>true</code> if this user has deafened themselves (i.e. not permitted to listen to or speak to others); otherwise <code>false</code>.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -237,7 +245,9 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketVoiceState_IsSelfMuted_" data-uid="Discord.WebSocket.SocketVoiceState.IsSelfMuted*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketVoiceState_IsSelfMuted" data-uid="Discord.WebSocket.SocketVoiceState.IsSelfMuted">IsSelfMuted</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a value that indicates whether this user has marked themselves as muted (i.e. not permitted to
|
||||
speak via voice).</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -254,7 +264,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td></td>
|
||||
<td><p><code>true</code> if this user has muted themselves; otherwise <code>false</code>.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -267,7 +278,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketVoiceState_IsStreaming_" data-uid="Discord.WebSocket.SocketVoiceState.IsStreaming*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketVoiceState_IsStreaming" data-uid="Discord.WebSocket.SocketVoiceState.IsStreaming">IsStreaming</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a value that indicates if this user is streaming in a voice channel.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -284,7 +296,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td></td>
|
||||
<td><p><code>true</code> if the user is streaming; otherwise <code>false</code>.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -297,7 +310,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketVoiceState_IsSuppressed_" data-uid="Discord.WebSocket.SocketVoiceState.IsSuppressed*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketVoiceState_IsSuppressed" data-uid="Discord.WebSocket.SocketVoiceState.IsSuppressed">IsSuppressed</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a value that indicates whether the user is muted by the current user.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -314,7 +328,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td></td>
|
||||
<td><p><code>true</code> if the guild is temporarily blocking audio to/from this user; otherwise <code>false</code>.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -358,7 +373,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketVoiceState_VoiceSessionId_" data-uid="Discord.WebSocket.SocketVoiceState.VoiceSessionId*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketVoiceState_VoiceSessionId" data-uid="Discord.WebSocket.SocketVoiceState.VoiceSessionId">VoiceSessionId</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the unique identifier for this user's voice session.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -426,7 +442,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketVoiceState_Discord_IVoiceState_VoiceChannel_" data-uid="Discord.WebSocket.SocketVoiceState.Discord#IVoiceState#VoiceChannel*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketVoiceState_Discord_IVoiceState_VoiceChannel" data-uid="Discord.WebSocket.SocketVoiceState.Discord#IVoiceState#VoiceChannel">IVoiceState.VoiceChannel</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the voice channel this user is currently in.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -443,7 +460,9 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.IVoiceChannel.html">IVoiceChannel</a></td>
|
||||
<td></td>
|
||||
<td><p>A generic voice channel object representing the voice channel that the user is currently in; <code>null</code>
|
||||
if none.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
|
|||
|
|
@ -168,7 +168,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketWebhookUser_AvatarId_" data-uid="Discord.WebSocket.SocketWebhookUser.AvatarId*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketWebhookUser_AvatarId" data-uid="Discord.WebSocket.SocketWebhookUser.AvatarId">AvatarId</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the identifier of this user's avatar.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -200,7 +201,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketWebhookUser_DiscriminatorValue_" data-uid="Discord.WebSocket.SocketWebhookUser.DiscriminatorValue*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketWebhookUser_DiscriminatorValue" data-uid="Discord.WebSocket.SocketWebhookUser.DiscriminatorValue">DiscriminatorValue</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the per-username unique ID for this user.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -263,7 +265,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketWebhookUser_IsBot_" data-uid="Discord.WebSocket.SocketWebhookUser.IsBot*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketWebhookUser_IsBot" data-uid="Discord.WebSocket.SocketWebhookUser.IsBot">IsBot</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a value that indicates whether this user is identified as a bot.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -280,12 +283,17 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td></td>
|
||||
<td><p><code>true</code> if the user is a bot application; otherwise <code>false</code>.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 class="overrides">Overrides</h5>
|
||||
<div><a class="xref" href="Discord.WebSocket.SocketUser.html#Discord_WebSocket_SocketUser_IsBot">SocketUser.IsBot</a></div>
|
||||
<h5 id="Discord_WebSocket_SocketWebhookUser_IsBot_remarks">Remarks</h5>
|
||||
<div class="markdown level1 remarks"><p>This property retrieves a value that indicates whether this user is a registered bot application
|
||||
(indicated by the blue BOT tag within the official chat client).</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_WebSocket_SocketWebhookUser_IsWebhook.md&value=---%0Auid%3A%20Discord.WebSocket.SocketWebhookUser.IsWebhook%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>
|
||||
|
|
@ -295,7 +303,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketWebhookUser_IsWebhook_" data-uid="Discord.WebSocket.SocketWebhookUser.IsWebhook*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketWebhookUser_IsWebhook" data-uid="Discord.WebSocket.SocketWebhookUser.IsWebhook">IsWebhook</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a value that indicates whether this user is a webhook user.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -312,7 +321,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td></td>
|
||||
<td><p><code>true</code> if the user is a webhook; otherwise <code>false</code>.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -327,7 +337,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketWebhookUser_Username_" data-uid="Discord.WebSocket.SocketWebhookUser.Username*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketWebhookUser_Username" data-uid="Discord.WebSocket.SocketWebhookUser.Username">Username</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the username for this user.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -359,7 +370,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketWebhookUser_WebhookId_" data-uid="Discord.WebSocket.SocketWebhookUser.WebhookId*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketWebhookUser_WebhookId" data-uid="Discord.WebSocket.SocketWebhookUser.WebhookId">WebhookId</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the ID of a webhook.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -391,7 +403,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketWebhookUser_Discord_IGuildUser_AddRoleAsync_" data-uid="Discord.WebSocket.SocketWebhookUser.Discord#IGuildUser#AddRoleAsync*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketWebhookUser_Discord_IGuildUser_AddRoleAsync_Discord_IRole_Discord_RequestOptions_" data-uid="Discord.WebSocket.SocketWebhookUser.Discord#IGuildUser#AddRoleAsync(Discord.IRole,Discord.RequestOptions)">IGuildUser.AddRoleAsync(IRole, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Adds the specified role to this user in the guild.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -410,12 +423,14 @@
|
|||
<tr>
|
||||
<td><a class="xref" href="Discord.IRole.html">IRole</a></td>
|
||||
<td><span class="parametername">role</span></td>
|
||||
<td></td>
|
||||
<td><p>The role to be added to the user.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -430,7 +445,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous role addition operation.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -459,7 +475,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketWebhookUser_Discord_IGuildUser_AddRolesAsync_" data-uid="Discord.WebSocket.SocketWebhookUser.Discord#IGuildUser#AddRolesAsync*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketWebhookUser_Discord_IGuildUser_AddRolesAsync_System_Collections_Generic_IEnumerable_Discord_IRole__Discord_RequestOptions_" data-uid="Discord.WebSocket.SocketWebhookUser.Discord#IGuildUser#AddRolesAsync(System.Collections.Generic.IEnumerable{Discord.IRole},Discord.RequestOptions)">IGuildUser.AddRolesAsync(IEnumerable<IRole>, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Adds the specified <code data-dev-comment-type="paramref" class="paramref">roles</code> to this user in the guild.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -478,12 +495,14 @@
|
|||
<tr>
|
||||
<td><span class="xref">System.Collections.Generic.IEnumerable</span><<a class="xref" href="Discord.IRole.html">IRole</a>></td>
|
||||
<td><span class="parametername">roles</span></td>
|
||||
<td></td>
|
||||
<td><p>The roles to be added to the user.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -498,7 +517,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous role addition operation.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -527,7 +547,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketWebhookUser_Discord_IGuildUser_GetPermissions_" data-uid="Discord.WebSocket.SocketWebhookUser.Discord#IGuildUser#GetPermissions*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketWebhookUser_Discord_IGuildUser_GetPermissions_Discord_IGuildChannel_" data-uid="Discord.WebSocket.SocketWebhookUser.Discord#IGuildUser#GetPermissions(Discord.IGuildChannel)">IGuildUser.GetPermissions(IGuildChannel)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the level permissions granted to this user to a given channel.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -546,7 +567,8 @@
|
|||
<tr>
|
||||
<td><a class="xref" href="Discord.IGuildChannel.html">IGuildChannel</a></td>
|
||||
<td><span class="parametername">channel</span></td>
|
||||
<td></td>
|
||||
<td><p>The channel to get the permission from.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -561,7 +583,9 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.ChannelPermissions.html">ChannelPermissions</a></td>
|
||||
<td></td>
|
||||
<td><p>A <a class="xref" href="Discord.ChannelPermissions.html">ChannelPermissions</a> structure representing the permissions that a user has in the
|
||||
specified channel.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -574,7 +598,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketWebhookUser_Discord_IGuildUser_Guild_" data-uid="Discord.WebSocket.SocketWebhookUser.Discord#IGuildUser#Guild*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketWebhookUser_Discord_IGuildUser_Guild" data-uid="Discord.WebSocket.SocketWebhookUser.Discord#IGuildUser#Guild">IGuildUser.Guild</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the guild for this user.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -591,7 +616,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.IGuild.html">IGuild</a></td>
|
||||
<td></td>
|
||||
<td><p>A guild object that this user belongs to.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -604,7 +630,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketWebhookUser_Discord_IGuildUser_GuildId_" data-uid="Discord.WebSocket.SocketWebhookUser.Discord#IGuildUser#GuildId*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketWebhookUser_Discord_IGuildUser_GuildId" data-uid="Discord.WebSocket.SocketWebhookUser.Discord#IGuildUser#GuildId">IGuildUser.GuildId</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the ID of the guild for this user.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -621,7 +648,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.UInt64</span></td>
|
||||
<td></td>
|
||||
<td><p>An <span class="xref">System.UInt64</span> representing the snowflake identifier of the guild that this user belongs to.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -634,7 +662,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketWebhookUser_Discord_IGuildUser_GuildPermissions_" data-uid="Discord.WebSocket.SocketWebhookUser.Discord#IGuildUser#GuildPermissions*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketWebhookUser_Discord_IGuildUser_GuildPermissions" data-uid="Discord.WebSocket.SocketWebhookUser.Discord#IGuildUser#GuildPermissions">IGuildUser.GuildPermissions</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the guild-level permissions for this user.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -651,7 +680,9 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.GuildPermissions.html">GuildPermissions</a></td>
|
||||
<td></td>
|
||||
<td><p>A <a class="xref" href="Discord.GuildPermissions.html">GuildPermissions</a> structure for this user, representing what
|
||||
permissions this user has in the guild.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -664,7 +695,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketWebhookUser_Discord_IGuildUser_JoinedAt_" data-uid="Discord.WebSocket.SocketWebhookUser.Discord#IGuildUser#JoinedAt*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketWebhookUser_Discord_IGuildUser_JoinedAt" data-uid="Discord.WebSocket.SocketWebhookUser.Discord#IGuildUser#JoinedAt">IGuildUser.JoinedAt</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets when this user joined the guild.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -681,7 +713,9 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Nullable</span><<span class="xref">System.DateTimeOffset</span>></td>
|
||||
<td></td>
|
||||
<td><p>A <span class="xref">System.DateTimeOffset</span> representing the time of which the user has joined the guild;
|
||||
<code>null</code> when it cannot be obtained.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -694,7 +728,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketWebhookUser_Discord_IGuildUser_KickAsync_" data-uid="Discord.WebSocket.SocketWebhookUser.Discord#IGuildUser#KickAsync*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketWebhookUser_Discord_IGuildUser_KickAsync_System_String_Discord_RequestOptions_" data-uid="Discord.WebSocket.SocketWebhookUser.Discord#IGuildUser#KickAsync(System.String,Discord.RequestOptions)">IGuildUser.KickAsync(String, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Kicks this user from this guild.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -713,12 +748,14 @@
|
|||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td><span class="parametername">reason</span></td>
|
||||
<td></td>
|
||||
<td><p>The reason for the kick which will be recorded in the audit log.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -733,7 +770,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous kick operation.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -762,7 +800,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketWebhookUser_Discord_IGuildUser_ModifyAsync_" data-uid="Discord.WebSocket.SocketWebhookUser.Discord#IGuildUser#ModifyAsync*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketWebhookUser_Discord_IGuildUser_ModifyAsync_System_Action_Discord_GuildUserProperties__Discord_RequestOptions_" data-uid="Discord.WebSocket.SocketWebhookUser.Discord#IGuildUser#ModifyAsync(System.Action{Discord.GuildUserProperties},Discord.RequestOptions)">IGuildUser.ModifyAsync(Action<GuildUserProperties>, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Modifies this user's properties in this guild.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -781,12 +820,14 @@
|
|||
<tr>
|
||||
<td><span class="xref">System.Action</span><<a class="xref" href="Discord.GuildUserProperties.html">GuildUserProperties</a>></td>
|
||||
<td><span class="parametername">func</span></td>
|
||||
<td></td>
|
||||
<td><p>The delegate containing the properties to modify the user with.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -801,10 +842,15 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous modification operation.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 id="Discord_WebSocket_SocketWebhookUser_Discord_IGuildUser_ModifyAsync_System_Action_Discord_GuildUserProperties__Discord_RequestOptions__remarks">Remarks</h5>
|
||||
<div class="markdown level1 remarks"><p>This method modifies the current guild user with the specified properties. To see an example of this
|
||||
method and what properties are available, please refer to <a class="xref" href="Discord.GuildUserProperties.html">GuildUserProperties</a>.</p>
|
||||
</div>
|
||||
<h5 class="exceptions">Exceptions</h5>
|
||||
<table class="table table-bordered table-striped table-condensed">
|
||||
<thead>
|
||||
|
|
@ -830,7 +876,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketWebhookUser_Discord_IGuildUser_Nickname_" data-uid="Discord.WebSocket.SocketWebhookUser.Discord#IGuildUser#Nickname*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketWebhookUser_Discord_IGuildUser_Nickname" data-uid="Discord.WebSocket.SocketWebhookUser.Discord#IGuildUser#Nickname">IGuildUser.Nickname</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the nickname for this user.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -847,7 +894,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td></td>
|
||||
<td><p>A string representing the nickname of the user; <code>null</code> if none is set.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -860,7 +908,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketWebhookUser_Discord_IGuildUser_PremiumSince_" data-uid="Discord.WebSocket.SocketWebhookUser.Discord#IGuildUser#PremiumSince*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketWebhookUser_Discord_IGuildUser_PremiumSince" data-uid="Discord.WebSocket.SocketWebhookUser.Discord#IGuildUser#PremiumSince">IGuildUser.PremiumSince</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the date and time for when this user's guild boost began.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -877,7 +926,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Nullable</span><<span class="xref">System.DateTimeOffset</span>></td>
|
||||
<td></td>
|
||||
<td><p>A <span class="xref">System.DateTimeOffset</span> for when the user began boosting this guild; <code>null</code> if they are not boosting the guild.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -890,7 +940,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketWebhookUser_Discord_IGuildUser_RemoveRoleAsync_" data-uid="Discord.WebSocket.SocketWebhookUser.Discord#IGuildUser#RemoveRoleAsync*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketWebhookUser_Discord_IGuildUser_RemoveRoleAsync_Discord_IRole_Discord_RequestOptions_" data-uid="Discord.WebSocket.SocketWebhookUser.Discord#IGuildUser#RemoveRoleAsync(Discord.IRole,Discord.RequestOptions)">IGuildUser.RemoveRoleAsync(IRole, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Removes the specified <code data-dev-comment-type="paramref" class="paramref">role</code> from this user in the guild.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -909,12 +960,14 @@
|
|||
<tr>
|
||||
<td><a class="xref" href="Discord.IRole.html">IRole</a></td>
|
||||
<td><span class="parametername">role</span></td>
|
||||
<td></td>
|
||||
<td><p>The role to be removed from the user.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -929,7 +982,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous role removal operation.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -958,7 +1012,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketWebhookUser_Discord_IGuildUser_RemoveRolesAsync_" data-uid="Discord.WebSocket.SocketWebhookUser.Discord#IGuildUser#RemoveRolesAsync*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketWebhookUser_Discord_IGuildUser_RemoveRolesAsync_System_Collections_Generic_IEnumerable_Discord_IRole__Discord_RequestOptions_" data-uid="Discord.WebSocket.SocketWebhookUser.Discord#IGuildUser#RemoveRolesAsync(System.Collections.Generic.IEnumerable{Discord.IRole},Discord.RequestOptions)">IGuildUser.RemoveRolesAsync(IEnumerable<IRole>, RequestOptions)</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Removes the specified <code data-dev-comment-type="paramref" class="paramref">roles</code> from this user in the guild.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -977,12 +1032,14 @@
|
|||
<tr>
|
||||
<td><span class="xref">System.Collections.Generic.IEnumerable</span><<a class="xref" href="Discord.IRole.html">IRole</a>></td>
|
||||
<td><span class="parametername">roles</span></td>
|
||||
<td></td>
|
||||
<td><p>The roles to be removed from the user.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.RequestOptions.html">RequestOptions</a></td>
|
||||
<td><span class="parametername">options</span></td>
|
||||
<td></td>
|
||||
<td><p>The options to be used when sending the request.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -997,7 +1054,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Threading.Tasks.Task</span></td>
|
||||
<td></td>
|
||||
<td><p>A task that represents the asynchronous role removal operation.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1026,7 +1084,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketWebhookUser_Discord_IGuildUser_RoleIds_" data-uid="Discord.WebSocket.SocketWebhookUser.Discord#IGuildUser#RoleIds*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketWebhookUser_Discord_IGuildUser_RoleIds" data-uid="Discord.WebSocket.SocketWebhookUser.Discord#IGuildUser#RoleIds">IGuildUser.RoleIds</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a collection of IDs for the roles that this user currently possesses in the guild.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1043,10 +1102,17 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Collections.Generic.IReadOnlyCollection</span><<span class="xref">System.UInt64</span>></td>
|
||||
<td></td>
|
||||
<td><p>A read-only collection of <span class="xref">System.UInt64</span>, each representing a snowflake identifier for a role that
|
||||
this user possesses.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h5 id="Discord_WebSocket_SocketWebhookUser_Discord_IGuildUser_RoleIds_remarks">Remarks</h5>
|
||||
<div class="markdown level1 remarks"><p>This property returns a read-only collection of the identifiers of the roles that this user possesses.
|
||||
For WebSocket users, a Roles property can be found in place of this property. Due to the REST
|
||||
implementation, only a collection of identifiers can be retrieved instead of the full role objects.</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_WebSocket_SocketWebhookUser_Discord_IVoiceState_IsDeafened.md&value=---%0Auid%3A%20Discord.WebSocket.SocketWebhookUser.Discord%23IVoiceState%23IsDeafened%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>
|
||||
|
|
@ -1056,7 +1122,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketWebhookUser_Discord_IVoiceState_IsDeafened_" data-uid="Discord.WebSocket.SocketWebhookUser.Discord#IVoiceState#IsDeafened*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketWebhookUser_Discord_IVoiceState_IsDeafened" data-uid="Discord.WebSocket.SocketWebhookUser.Discord#IVoiceState#IsDeafened">IVoiceState.IsDeafened</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a value that indicates whether this user is deafened by the guild.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1073,7 +1140,9 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td></td>
|
||||
<td><p><code>true</code> if the user is deafened (i.e. not permitted to listen to or speak to others) by the guild;
|
||||
otherwise <code>false</code>.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1086,7 +1155,9 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketWebhookUser_Discord_IVoiceState_IsMuted_" data-uid="Discord.WebSocket.SocketWebhookUser.Discord#IVoiceState#IsMuted*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketWebhookUser_Discord_IVoiceState_IsMuted" data-uid="Discord.WebSocket.SocketWebhookUser.Discord#IVoiceState#IsMuted">IVoiceState.IsMuted</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a value that indicates whether this user is muted (i.e. not permitted to speak via voice) by the
|
||||
guild.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1103,7 +1174,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td></td>
|
||||
<td><p><code>true</code> if this user is muted by the guild; otherwise <code>false</code>.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1116,7 +1188,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketWebhookUser_Discord_IVoiceState_IsSelfDeafened_" data-uid="Discord.WebSocket.SocketWebhookUser.Discord#IVoiceState#IsSelfDeafened*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketWebhookUser_Discord_IVoiceState_IsSelfDeafened" data-uid="Discord.WebSocket.SocketWebhookUser.Discord#IVoiceState#IsSelfDeafened">IVoiceState.IsSelfDeafened</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a value that indicates whether this user has marked themselves as deafened.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1133,7 +1206,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td></td>
|
||||
<td><p><code>true</code> if this user has deafened themselves (i.e. not permitted to listen to or speak to others); otherwise <code>false</code>.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1146,7 +1220,9 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketWebhookUser_Discord_IVoiceState_IsSelfMuted_" data-uid="Discord.WebSocket.SocketWebhookUser.Discord#IVoiceState#IsSelfMuted*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketWebhookUser_Discord_IVoiceState_IsSelfMuted" data-uid="Discord.WebSocket.SocketWebhookUser.Discord#IVoiceState#IsSelfMuted">IVoiceState.IsSelfMuted</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a value that indicates whether this user has marked themselves as muted (i.e. not permitted to
|
||||
speak via voice).</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1163,7 +1239,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td></td>
|
||||
<td><p><code>true</code> if this user has muted themselves; otherwise <code>false</code>.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1176,7 +1253,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketWebhookUser_Discord_IVoiceState_IsStreaming_" data-uid="Discord.WebSocket.SocketWebhookUser.Discord#IVoiceState#IsStreaming*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketWebhookUser_Discord_IVoiceState_IsStreaming" data-uid="Discord.WebSocket.SocketWebhookUser.Discord#IVoiceState#IsStreaming">IVoiceState.IsStreaming</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a value that indicates if this user is streaming in a voice channel.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1193,7 +1271,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td></td>
|
||||
<td><p><code>true</code> if the user is streaming; otherwise <code>false</code>.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1206,7 +1285,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketWebhookUser_Discord_IVoiceState_IsSuppressed_" data-uid="Discord.WebSocket.SocketWebhookUser.Discord#IVoiceState#IsSuppressed*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketWebhookUser_Discord_IVoiceState_IsSuppressed" data-uid="Discord.WebSocket.SocketWebhookUser.Discord#IVoiceState#IsSuppressed">IVoiceState.IsSuppressed</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets a value that indicates whether the user is muted by the current user.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1223,7 +1303,8 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><span class="xref">System.Boolean</span></td>
|
||||
<td></td>
|
||||
<td><p><code>true</code> if the guild is temporarily blocking audio to/from this user; otherwise <code>false</code>.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1236,7 +1317,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketWebhookUser_Discord_IVoiceState_VoiceChannel_" data-uid="Discord.WebSocket.SocketWebhookUser.Discord#IVoiceState#VoiceChannel*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketWebhookUser_Discord_IVoiceState_VoiceChannel" data-uid="Discord.WebSocket.SocketWebhookUser.Discord#IVoiceState#VoiceChannel">IVoiceState.VoiceChannel</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the voice channel this user is currently in.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
@ -1253,7 +1335,9 @@
|
|||
<tbody>
|
||||
<tr>
|
||||
<td><a class="xref" href="Discord.IVoiceChannel.html">IVoiceChannel</a></td>
|
||||
<td></td>
|
||||
<td><p>A generic voice channel object representing the voice channel that the user is currently in; <code>null</code>
|
||||
if none.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
|
@ -1266,7 +1350,8 @@
|
|||
</span>
|
||||
<a id="Discord_WebSocket_SocketWebhookUser_Discord_IVoiceState_VoiceSessionId_" data-uid="Discord.WebSocket.SocketWebhookUser.Discord#IVoiceState#VoiceSessionId*"></a>
|
||||
<h4 id="Discord_WebSocket_SocketWebhookUser_Discord_IVoiceState_VoiceSessionId" data-uid="Discord.WebSocket.SocketWebhookUser.Discord#IVoiceState#VoiceSessionId">IVoiceState.VoiceSessionId</h4>
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 summary"><p>Gets the unique identifier for this user's voice session.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
|
|
|
|||
|
|
@ -84,7 +84,8 @@
|
|||
<section><p>An extension class for squashing <span class="xref">System.Collections.Generic.IAsyncEnumerable<T></span>.</p>
|
||||
</section>
|
||||
<h4><a class="xref" href="Discord.Attachment.html">Attachment</a></h4>
|
||||
<section></section>
|
||||
<section><p>Represents a message attachment found in a <a class="xref" href="Discord.IUserMessage.html">IUserMessage</a>.</p>
|
||||
</section>
|
||||
<h4><a class="xref" href="Discord.AttachmentExtensions.html">AttachmentExtensions</a></h4>
|
||||
<section></section>
|
||||
<h4><a class="xref" href="Discord.CDN.html">CDN</a></h4>
|
||||
|
|
|
|||
|
|
@ -101,7 +101,6 @@
|
|||
<h5 id="ImGuiNET_RangeAccessor_1_syntax">Syntax</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public struct RangeAccessor<T>
|
||||
|
||||
where T : struct</code></pre>
|
||||
</div>
|
||||
<h5 class="typeParameters">Type Parameters</h5>
|
||||
|
|
|
|||
|
|
@ -101,7 +101,6 @@
|
|||
<h5 id="ImGuiNET_RangePtrAccessor_1_syntax">Syntax</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public struct RangePtrAccessor<T>
|
||||
|
||||
where T : struct</code></pre>
|
||||
</div>
|
||||
<h5 class="typeParameters">Type Parameters</h5>
|
||||
|
|
|
|||
|
|
@ -175,6 +175,12 @@
|
|||
<li>
|
||||
<a href="Dalamud.Game.ClientState.ClientState.html" name="" title="ClientState">ClientState</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="Dalamud.Game.ClientState.Condition.html" name="" title="Condition">Condition</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="Dalamud.Game.ClientState.ConditionFlag.html" name="" title="ConditionFlag">ConditionFlag</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="Dalamud.Game.ClientState.JobGauges.html" name="" title="JobGauges">JobGauges</a>
|
||||
</li>
|
||||
|
|
|
|||
File diff suppressed because it is too large
Load diff
607
docs/xrefmap.yml
607
docs/xrefmap.yml
|
|
@ -5873,6 +5873,19 @@ references:
|
|||
isSpec: "True"
|
||||
fullName: Dalamud.Game.ClientState.Actors.Types.Actor.Rotation
|
||||
nameWithType: Actor.Rotation
|
||||
- uid: Dalamud.Game.ClientState.Actors.Types.Actor.TargetActorID
|
||||
name: TargetActorID
|
||||
href: api/Dalamud.Game.ClientState.Actors.Types.Actor.html#Dalamud_Game_ClientState_Actors_Types_Actor_TargetActorID
|
||||
commentId: P:Dalamud.Game.ClientState.Actors.Types.Actor.TargetActorID
|
||||
fullName: Dalamud.Game.ClientState.Actors.Types.Actor.TargetActorID
|
||||
nameWithType: Actor.TargetActorID
|
||||
- uid: Dalamud.Game.ClientState.Actors.Types.Actor.TargetActorID*
|
||||
name: TargetActorID
|
||||
href: api/Dalamud.Game.ClientState.Actors.Types.Actor.html#Dalamud_Game_ClientState_Actors_Types_Actor_TargetActorID_
|
||||
commentId: Overload:Dalamud.Game.ClientState.Actors.Types.Actor.TargetActorID
|
||||
isSpec: "True"
|
||||
fullName: Dalamud.Game.ClientState.Actors.Types.Actor.TargetActorID
|
||||
nameWithType: Actor.TargetActorID
|
||||
- uid: Dalamud.Game.ClientState.Actors.Types.Actor.YalmDistanceX
|
||||
name: YalmDistanceX
|
||||
href: api/Dalamud.Game.ClientState.Actors.Types.Actor.html#Dalamud_Game_ClientState_Actors_Types_Actor_YalmDistanceX
|
||||
|
|
@ -6060,6 +6073,19 @@ references:
|
|||
isSpec: "True"
|
||||
fullName: Dalamud.Game.ClientState.Actors.Types.NonPlayer.BattleNpc.OwnerId
|
||||
nameWithType: BattleNpc.OwnerId
|
||||
- uid: Dalamud.Game.ClientState.Actors.Types.NonPlayer.BattleNpc.TargetActorID
|
||||
name: TargetActorID
|
||||
href: api/Dalamud.Game.ClientState.Actors.Types.NonPlayer.BattleNpc.html#Dalamud_Game_ClientState_Actors_Types_NonPlayer_BattleNpc_TargetActorID
|
||||
commentId: P:Dalamud.Game.ClientState.Actors.Types.NonPlayer.BattleNpc.TargetActorID
|
||||
fullName: Dalamud.Game.ClientState.Actors.Types.NonPlayer.BattleNpc.TargetActorID
|
||||
nameWithType: BattleNpc.TargetActorID
|
||||
- uid: Dalamud.Game.ClientState.Actors.Types.NonPlayer.BattleNpc.TargetActorID*
|
||||
name: TargetActorID
|
||||
href: api/Dalamud.Game.ClientState.Actors.Types.NonPlayer.BattleNpc.html#Dalamud_Game_ClientState_Actors_Types_NonPlayer_BattleNpc_TargetActorID_
|
||||
commentId: Overload:Dalamud.Game.ClientState.Actors.Types.NonPlayer.BattleNpc.TargetActorID
|
||||
isSpec: "True"
|
||||
fullName: Dalamud.Game.ClientState.Actors.Types.NonPlayer.BattleNpc.TargetActorID
|
||||
nameWithType: BattleNpc.TargetActorID
|
||||
- uid: Dalamud.Game.ClientState.Actors.Types.NonPlayer.BattleNpcSubKind
|
||||
name: BattleNpcSubKind
|
||||
href: api/Dalamud.Game.ClientState.Actors.Types.NonPlayer.BattleNpcSubKind.html
|
||||
|
|
@ -6230,6 +6256,19 @@ references:
|
|||
isSpec: "True"
|
||||
fullName: Dalamud.Game.ClientState.Actors.Types.PlayerCharacter.HomeWorld
|
||||
nameWithType: PlayerCharacter.HomeWorld
|
||||
- uid: Dalamud.Game.ClientState.Actors.Types.PlayerCharacter.TargetActorID
|
||||
name: TargetActorID
|
||||
href: api/Dalamud.Game.ClientState.Actors.Types.PlayerCharacter.html#Dalamud_Game_ClientState_Actors_Types_PlayerCharacter_TargetActorID
|
||||
commentId: P:Dalamud.Game.ClientState.Actors.Types.PlayerCharacter.TargetActorID
|
||||
fullName: Dalamud.Game.ClientState.Actors.Types.PlayerCharacter.TargetActorID
|
||||
nameWithType: PlayerCharacter.TargetActorID
|
||||
- uid: Dalamud.Game.ClientState.Actors.Types.PlayerCharacter.TargetActorID*
|
||||
name: TargetActorID
|
||||
href: api/Dalamud.Game.ClientState.Actors.Types.PlayerCharacter.html#Dalamud_Game_ClientState_Actors_Types_PlayerCharacter_TargetActorID_
|
||||
commentId: Overload:Dalamud.Game.ClientState.Actors.Types.PlayerCharacter.TargetActorID
|
||||
isSpec: "True"
|
||||
fullName: Dalamud.Game.ClientState.Actors.Types.PlayerCharacter.TargetActorID
|
||||
nameWithType: PlayerCharacter.TargetActorID
|
||||
- uid: Dalamud.Game.ClientState.ClientState
|
||||
name: ClientState
|
||||
href: api/Dalamud.Game.ClientState.ClientState.html
|
||||
|
|
@ -6261,6 +6300,12 @@ references:
|
|||
commentId: F:Dalamud.Game.ClientState.ClientState.ClientLanguage
|
||||
fullName: Dalamud.Game.ClientState.ClientState.ClientLanguage
|
||||
nameWithType: ClientState.ClientLanguage
|
||||
- uid: Dalamud.Game.ClientState.ClientState.Condition
|
||||
name: Condition
|
||||
href: api/Dalamud.Game.ClientState.ClientState.html#Dalamud_Game_ClientState_ClientState_Condition
|
||||
commentId: F:Dalamud.Game.ClientState.ClientState.Condition
|
||||
fullName: Dalamud.Game.ClientState.ClientState.Condition
|
||||
nameWithType: ClientState.Condition
|
||||
- uid: Dalamud.Game.ClientState.ClientState.Dispose
|
||||
name: Dispose()
|
||||
href: api/Dalamud.Game.ClientState.ClientState.html#Dalamud_Game_ClientState_ClientState_Dispose
|
||||
|
|
@ -6349,6 +6394,550 @@ references:
|
|||
commentId: F:Dalamud.Game.ClientState.ClientState.TerritoryType
|
||||
fullName: Dalamud.Game.ClientState.ClientState.TerritoryType
|
||||
nameWithType: ClientState.TerritoryType
|
||||
- uid: Dalamud.Game.ClientState.Condition
|
||||
name: Condition
|
||||
href: api/Dalamud.Game.ClientState.Condition.html
|
||||
commentId: T:Dalamud.Game.ClientState.Condition
|
||||
fullName: Dalamud.Game.ClientState.Condition
|
||||
nameWithType: Condition
|
||||
- uid: Dalamud.Game.ClientState.Condition.Item(Dalamud.Game.ClientState.ConditionFlag)
|
||||
name: Item[ConditionFlag]
|
||||
href: api/Dalamud.Game.ClientState.Condition.html#Dalamud_Game_ClientState_Condition_Item_Dalamud_Game_ClientState_ConditionFlag_
|
||||
commentId: P:Dalamud.Game.ClientState.Condition.Item(Dalamud.Game.ClientState.ConditionFlag)
|
||||
name.vb: Item(ConditionFlag)
|
||||
fullName: Dalamud.Game.ClientState.Condition.Item[Dalamud.Game.ClientState.ConditionFlag]
|
||||
fullName.vb: Dalamud.Game.ClientState.Condition.Item(Dalamud.Game.ClientState.ConditionFlag)
|
||||
nameWithType: Condition.Item[ConditionFlag]
|
||||
nameWithType.vb: Condition.Item(ConditionFlag)
|
||||
- uid: Dalamud.Game.ClientState.Condition.Item*
|
||||
name: Item
|
||||
href: api/Dalamud.Game.ClientState.Condition.html#Dalamud_Game_ClientState_Condition_Item_
|
||||
commentId: Overload:Dalamud.Game.ClientState.Condition.Item
|
||||
isSpec: "True"
|
||||
fullName: Dalamud.Game.ClientState.Condition.Item
|
||||
nameWithType: Condition.Item
|
||||
- uid: Dalamud.Game.ClientState.Condition.MaxConditionEntries
|
||||
name: MaxConditionEntries
|
||||
href: api/Dalamud.Game.ClientState.Condition.html#Dalamud_Game_ClientState_Condition_MaxConditionEntries
|
||||
commentId: F:Dalamud.Game.ClientState.Condition.MaxConditionEntries
|
||||
fullName: Dalamud.Game.ClientState.Condition.MaxConditionEntries
|
||||
nameWithType: Condition.MaxConditionEntries
|
||||
- uid: Dalamud.Game.ClientState.ConditionFlag
|
||||
name: ConditionFlag
|
||||
href: api/Dalamud.Game.ClientState.ConditionFlag.html
|
||||
commentId: T:Dalamud.Game.ClientState.ConditionFlag
|
||||
fullName: Dalamud.Game.ClientState.ConditionFlag
|
||||
nameWithType: ConditionFlag
|
||||
- uid: Dalamud.Game.ClientState.ConditionFlag.AutorunActive
|
||||
name: AutorunActive
|
||||
href: api/Dalamud.Game.ClientState.ConditionFlag.html#Dalamud_Game_ClientState_ConditionFlag_AutorunActive
|
||||
commentId: F:Dalamud.Game.ClientState.ConditionFlag.AutorunActive
|
||||
fullName: Dalamud.Game.ClientState.ConditionFlag.AutorunActive
|
||||
nameWithType: ConditionFlag.AutorunActive
|
||||
- uid: Dalamud.Game.ClientState.ConditionFlag.BeingMoved
|
||||
name: BeingMoved
|
||||
href: api/Dalamud.Game.ClientState.ConditionFlag.html#Dalamud_Game_ClientState_ConditionFlag_BeingMoved
|
||||
commentId: F:Dalamud.Game.ClientState.ConditionFlag.BeingMoved
|
||||
fullName: Dalamud.Game.ClientState.ConditionFlag.BeingMoved
|
||||
nameWithType: ConditionFlag.BeingMoved
|
||||
- uid: Dalamud.Game.ClientState.ConditionFlag.BetweenAreas
|
||||
name: BetweenAreas
|
||||
href: api/Dalamud.Game.ClientState.ConditionFlag.html#Dalamud_Game_ClientState_ConditionFlag_BetweenAreas
|
||||
commentId: F:Dalamud.Game.ClientState.ConditionFlag.BetweenAreas
|
||||
fullName: Dalamud.Game.ClientState.ConditionFlag.BetweenAreas
|
||||
nameWithType: ConditionFlag.BetweenAreas
|
||||
- uid: Dalamud.Game.ClientState.ConditionFlag.BetweenAreas51
|
||||
name: BetweenAreas51
|
||||
href: api/Dalamud.Game.ClientState.ConditionFlag.html#Dalamud_Game_ClientState_ConditionFlag_BetweenAreas51
|
||||
commentId: F:Dalamud.Game.ClientState.ConditionFlag.BetweenAreas51
|
||||
fullName: Dalamud.Game.ClientState.ConditionFlag.BetweenAreas51
|
||||
nameWithType: ConditionFlag.BetweenAreas51
|
||||
- uid: Dalamud.Game.ClientState.ConditionFlag.BoundByDuty
|
||||
name: BoundByDuty
|
||||
href: api/Dalamud.Game.ClientState.ConditionFlag.html#Dalamud_Game_ClientState_ConditionFlag_BoundByDuty
|
||||
commentId: F:Dalamud.Game.ClientState.ConditionFlag.BoundByDuty
|
||||
fullName: Dalamud.Game.ClientState.ConditionFlag.BoundByDuty
|
||||
nameWithType: ConditionFlag.BoundByDuty
|
||||
- uid: Dalamud.Game.ClientState.ConditionFlag.BoundByDuty56
|
||||
name: BoundByDuty56
|
||||
href: api/Dalamud.Game.ClientState.ConditionFlag.html#Dalamud_Game_ClientState_ConditionFlag_BoundByDuty56
|
||||
commentId: F:Dalamud.Game.ClientState.ConditionFlag.BoundByDuty56
|
||||
fullName: Dalamud.Game.ClientState.ConditionFlag.BoundByDuty56
|
||||
nameWithType: ConditionFlag.BoundByDuty56
|
||||
- uid: Dalamud.Game.ClientState.ConditionFlag.BoundByDuty95
|
||||
name: BoundByDuty95
|
||||
href: api/Dalamud.Game.ClientState.ConditionFlag.html#Dalamud_Game_ClientState_ConditionFlag_BoundByDuty95
|
||||
commentId: F:Dalamud.Game.ClientState.ConditionFlag.BoundByDuty95
|
||||
fullName: Dalamud.Game.ClientState.ConditionFlag.BoundByDuty95
|
||||
nameWithType: ConditionFlag.BoundByDuty95
|
||||
- uid: Dalamud.Game.ClientState.ConditionFlag.BoundToDuty97
|
||||
name: BoundToDuty97
|
||||
href: api/Dalamud.Game.ClientState.ConditionFlag.html#Dalamud_Game_ClientState_ConditionFlag_BoundToDuty97
|
||||
commentId: F:Dalamud.Game.ClientState.ConditionFlag.BoundToDuty97
|
||||
fullName: Dalamud.Game.ClientState.ConditionFlag.BoundToDuty97
|
||||
nameWithType: ConditionFlag.BoundToDuty97
|
||||
- uid: Dalamud.Game.ClientState.ConditionFlag.CarryingItem
|
||||
name: CarryingItem
|
||||
href: api/Dalamud.Game.ClientState.ConditionFlag.html#Dalamud_Game_ClientState_ConditionFlag_CarryingItem
|
||||
commentId: F:Dalamud.Game.ClientState.ConditionFlag.CarryingItem
|
||||
fullName: Dalamud.Game.ClientState.ConditionFlag.CarryingItem
|
||||
nameWithType: ConditionFlag.CarryingItem
|
||||
- uid: Dalamud.Game.ClientState.ConditionFlag.CarryingObject
|
||||
name: CarryingObject
|
||||
href: api/Dalamud.Game.ClientState.ConditionFlag.html#Dalamud_Game_ClientState_ConditionFlag_CarryingObject
|
||||
commentId: F:Dalamud.Game.ClientState.ConditionFlag.CarryingObject
|
||||
fullName: Dalamud.Game.ClientState.ConditionFlag.CarryingObject
|
||||
nameWithType: ConditionFlag.CarryingObject
|
||||
- uid: Dalamud.Game.ClientState.ConditionFlag.Casting
|
||||
name: Casting
|
||||
href: api/Dalamud.Game.ClientState.ConditionFlag.html#Dalamud_Game_ClientState_ConditionFlag_Casting
|
||||
commentId: F:Dalamud.Game.ClientState.ConditionFlag.Casting
|
||||
fullName: Dalamud.Game.ClientState.ConditionFlag.Casting
|
||||
nameWithType: ConditionFlag.Casting
|
||||
- uid: Dalamud.Game.ClientState.ConditionFlag.Casting87
|
||||
name: Casting87
|
||||
href: api/Dalamud.Game.ClientState.ConditionFlag.html#Dalamud_Game_ClientState_ConditionFlag_Casting87
|
||||
commentId: F:Dalamud.Game.ClientState.ConditionFlag.Casting87
|
||||
fullName: Dalamud.Game.ClientState.ConditionFlag.Casting87
|
||||
nameWithType: ConditionFlag.Casting87
|
||||
- uid: Dalamud.Game.ClientState.ConditionFlag.ChocoboRacing
|
||||
name: ChocoboRacing
|
||||
href: api/Dalamud.Game.ClientState.ConditionFlag.html#Dalamud_Game_ClientState_ConditionFlag_ChocoboRacing
|
||||
commentId: F:Dalamud.Game.ClientState.ConditionFlag.ChocoboRacing
|
||||
fullName: Dalamud.Game.ClientState.ConditionFlag.ChocoboRacing
|
||||
nameWithType: ConditionFlag.ChocoboRacing
|
||||
- uid: Dalamud.Game.ClientState.ConditionFlag.ConditionLocation
|
||||
name: ConditionLocation
|
||||
href: api/Dalamud.Game.ClientState.ConditionFlag.html#Dalamud_Game_ClientState_ConditionFlag_ConditionLocation
|
||||
commentId: F:Dalamud.Game.ClientState.ConditionFlag.ConditionLocation
|
||||
fullName: Dalamud.Game.ClientState.ConditionFlag.ConditionLocation
|
||||
nameWithType: ConditionFlag.ConditionLocation
|
||||
- uid: Dalamud.Game.ClientState.ConditionFlag.Crafting
|
||||
name: Crafting
|
||||
href: api/Dalamud.Game.ClientState.ConditionFlag.html#Dalamud_Game_ClientState_ConditionFlag_Crafting
|
||||
commentId: F:Dalamud.Game.ClientState.ConditionFlag.Crafting
|
||||
fullName: Dalamud.Game.ClientState.ConditionFlag.Crafting
|
||||
nameWithType: ConditionFlag.Crafting
|
||||
- uid: Dalamud.Game.ClientState.ConditionFlag.Crafting40
|
||||
name: Crafting40
|
||||
href: api/Dalamud.Game.ClientState.ConditionFlag.html#Dalamud_Game_ClientState_ConditionFlag_Crafting40
|
||||
commentId: F:Dalamud.Game.ClientState.ConditionFlag.Crafting40
|
||||
fullName: Dalamud.Game.ClientState.ConditionFlag.Crafting40
|
||||
nameWithType: ConditionFlag.Crafting40
|
||||
- uid: Dalamud.Game.ClientState.ConditionFlag.CreatingCharacter
|
||||
name: CreatingCharacter
|
||||
href: api/Dalamud.Game.ClientState.ConditionFlag.html#Dalamud_Game_ClientState_ConditionFlag_CreatingCharacter
|
||||
commentId: F:Dalamud.Game.ClientState.ConditionFlag.CreatingCharacter
|
||||
fullName: Dalamud.Game.ClientState.ConditionFlag.CreatingCharacter
|
||||
nameWithType: ConditionFlag.CreatingCharacter
|
||||
- uid: Dalamud.Game.ClientState.ConditionFlag.Diving
|
||||
name: Diving
|
||||
href: api/Dalamud.Game.ClientState.ConditionFlag.html#Dalamud_Game_ClientState_ConditionFlag_Diving
|
||||
commentId: F:Dalamud.Game.ClientState.ConditionFlag.Diving
|
||||
fullName: Dalamud.Game.ClientState.ConditionFlag.Diving
|
||||
nameWithType: ConditionFlag.Diving
|
||||
- uid: Dalamud.Game.ClientState.ConditionFlag.DutyRecorderPlayback
|
||||
name: DutyRecorderPlayback
|
||||
href: api/Dalamud.Game.ClientState.ConditionFlag.html#Dalamud_Game_ClientState_ConditionFlag_DutyRecorderPlayback
|
||||
commentId: F:Dalamud.Game.ClientState.ConditionFlag.DutyRecorderPlayback
|
||||
fullName: Dalamud.Game.ClientState.ConditionFlag.DutyRecorderPlayback
|
||||
nameWithType: ConditionFlag.DutyRecorderPlayback
|
||||
- uid: Dalamud.Game.ClientState.ConditionFlag.Emoting
|
||||
name: Emoting
|
||||
href: api/Dalamud.Game.ClientState.ConditionFlag.html#Dalamud_Game_ClientState_ConditionFlag_Emoting
|
||||
commentId: F:Dalamud.Game.ClientState.ConditionFlag.Emoting
|
||||
fullName: Dalamud.Game.ClientState.ConditionFlag.Emoting
|
||||
nameWithType: ConditionFlag.Emoting
|
||||
- uid: Dalamud.Game.ClientState.ConditionFlag.Fishing
|
||||
name: Fishing
|
||||
href: api/Dalamud.Game.ClientState.ConditionFlag.html#Dalamud_Game_ClientState_ConditionFlag_Fishing
|
||||
commentId: F:Dalamud.Game.ClientState.ConditionFlag.Fishing
|
||||
fullName: Dalamud.Game.ClientState.ConditionFlag.Fishing
|
||||
nameWithType: ConditionFlag.Fishing
|
||||
- uid: Dalamud.Game.ClientState.ConditionFlag.Gathering
|
||||
name: Gathering
|
||||
href: api/Dalamud.Game.ClientState.ConditionFlag.html#Dalamud_Game_ClientState_ConditionFlag_Gathering
|
||||
commentId: F:Dalamud.Game.ClientState.ConditionFlag.Gathering
|
||||
fullName: Dalamud.Game.ClientState.ConditionFlag.Gathering
|
||||
nameWithType: ConditionFlag.Gathering
|
||||
- uid: Dalamud.Game.ClientState.ConditionFlag.Gathering42
|
||||
name: Gathering42
|
||||
href: api/Dalamud.Game.ClientState.ConditionFlag.html#Dalamud_Game_ClientState_ConditionFlag_Gathering42
|
||||
commentId: F:Dalamud.Game.ClientState.ConditionFlag.Gathering42
|
||||
fullName: Dalamud.Game.ClientState.ConditionFlag.Gathering42
|
||||
nameWithType: ConditionFlag.Gathering42
|
||||
- uid: Dalamud.Game.ClientState.ConditionFlag.InCombat
|
||||
name: InCombat
|
||||
href: api/Dalamud.Game.ClientState.ConditionFlag.html#Dalamud_Game_ClientState_ConditionFlag_InCombat
|
||||
commentId: F:Dalamud.Game.ClientState.ConditionFlag.InCombat
|
||||
fullName: Dalamud.Game.ClientState.ConditionFlag.InCombat
|
||||
nameWithType: ConditionFlag.InCombat
|
||||
- uid: Dalamud.Game.ClientState.ConditionFlag.InDeepDungeon
|
||||
name: InDeepDungeon
|
||||
href: api/Dalamud.Game.ClientState.ConditionFlag.html#Dalamud_Game_ClientState_ConditionFlag_InDeepDungeon
|
||||
commentId: F:Dalamud.Game.ClientState.ConditionFlag.InDeepDungeon
|
||||
fullName: Dalamud.Game.ClientState.ConditionFlag.InDeepDungeon
|
||||
nameWithType: ConditionFlag.InDeepDungeon
|
||||
- uid: Dalamud.Game.ClientState.ConditionFlag.InDuelingArea
|
||||
name: InDuelingArea
|
||||
href: api/Dalamud.Game.ClientState.ConditionFlag.html#Dalamud_Game_ClientState_ConditionFlag_InDuelingArea
|
||||
commentId: F:Dalamud.Game.ClientState.ConditionFlag.InDuelingArea
|
||||
fullName: Dalamud.Game.ClientState.ConditionFlag.InDuelingArea
|
||||
nameWithType: ConditionFlag.InDuelingArea
|
||||
- uid: Dalamud.Game.ClientState.ConditionFlag.InFlight
|
||||
name: InFlight
|
||||
href: api/Dalamud.Game.ClientState.ConditionFlag.html#Dalamud_Game_ClientState_ConditionFlag_InFlight
|
||||
commentId: F:Dalamud.Game.ClientState.ConditionFlag.InFlight
|
||||
fullName: Dalamud.Game.ClientState.ConditionFlag.InFlight
|
||||
nameWithType: ConditionFlag.InFlight
|
||||
- uid: Dalamud.Game.ClientState.ConditionFlag.InThatPosition
|
||||
name: InThatPosition
|
||||
href: api/Dalamud.Game.ClientState.ConditionFlag.html#Dalamud_Game_ClientState_ConditionFlag_InThatPosition
|
||||
commentId: F:Dalamud.Game.ClientState.ConditionFlag.InThatPosition
|
||||
fullName: Dalamud.Game.ClientState.ConditionFlag.InThatPosition
|
||||
nameWithType: ConditionFlag.InThatPosition
|
||||
- uid: Dalamud.Game.ClientState.ConditionFlag.InThisState88
|
||||
name: InThisState88
|
||||
href: api/Dalamud.Game.ClientState.ConditionFlag.html#Dalamud_Game_ClientState_ConditionFlag_InThisState88
|
||||
commentId: F:Dalamud.Game.ClientState.ConditionFlag.InThisState88
|
||||
fullName: Dalamud.Game.ClientState.ConditionFlag.InThisState88
|
||||
nameWithType: ConditionFlag.InThisState88
|
||||
- uid: Dalamud.Game.ClientState.ConditionFlag.InThisState89
|
||||
name: InThisState89
|
||||
href: api/Dalamud.Game.ClientState.ConditionFlag.html#Dalamud_Game_ClientState_ConditionFlag_InThisState89
|
||||
commentId: F:Dalamud.Game.ClientState.ConditionFlag.InThisState89
|
||||
fullName: Dalamud.Game.ClientState.ConditionFlag.InThisState89
|
||||
nameWithType: ConditionFlag.InThisState89
|
||||
- uid: Dalamud.Game.ClientState.ConditionFlag.Jumping
|
||||
name: Jumping
|
||||
href: api/Dalamud.Game.ClientState.ConditionFlag.html#Dalamud_Game_ClientState_ConditionFlag_Jumping
|
||||
commentId: F:Dalamud.Game.ClientState.ConditionFlag.Jumping
|
||||
fullName: Dalamud.Game.ClientState.ConditionFlag.Jumping
|
||||
nameWithType: ConditionFlag.Jumping
|
||||
- uid: Dalamud.Game.ClientState.ConditionFlag.Jumping61
|
||||
name: Jumping61
|
||||
href: api/Dalamud.Game.ClientState.ConditionFlag.html#Dalamud_Game_ClientState_ConditionFlag_Jumping61
|
||||
commentId: F:Dalamud.Game.ClientState.ConditionFlag.Jumping61
|
||||
fullName: Dalamud.Game.ClientState.ConditionFlag.Jumping61
|
||||
nameWithType: ConditionFlag.Jumping61
|
||||
- uid: Dalamud.Game.ClientState.ConditionFlag.LoggingOut
|
||||
name: LoggingOut
|
||||
href: api/Dalamud.Game.ClientState.ConditionFlag.html#Dalamud_Game_ClientState_ConditionFlag_LoggingOut
|
||||
commentId: F:Dalamud.Game.ClientState.ConditionFlag.LoggingOut
|
||||
fullName: Dalamud.Game.ClientState.ConditionFlag.LoggingOut
|
||||
nameWithType: ConditionFlag.LoggingOut
|
||||
- uid: Dalamud.Game.ClientState.ConditionFlag.MeldingMateria
|
||||
name: MeldingMateria
|
||||
href: api/Dalamud.Game.ClientState.ConditionFlag.html#Dalamud_Game_ClientState_ConditionFlag_MeldingMateria
|
||||
commentId: F:Dalamud.Game.ClientState.ConditionFlag.MeldingMateria
|
||||
fullName: Dalamud.Game.ClientState.ConditionFlag.MeldingMateria
|
||||
nameWithType: ConditionFlag.MeldingMateria
|
||||
- uid: Dalamud.Game.ClientState.ConditionFlag.Mounted
|
||||
name: Mounted
|
||||
href: api/Dalamud.Game.ClientState.ConditionFlag.html#Dalamud_Game_ClientState_ConditionFlag_Mounted
|
||||
commentId: F:Dalamud.Game.ClientState.ConditionFlag.Mounted
|
||||
fullName: Dalamud.Game.ClientState.ConditionFlag.Mounted
|
||||
nameWithType: ConditionFlag.Mounted
|
||||
- uid: Dalamud.Game.ClientState.ConditionFlag.Mounted2
|
||||
name: Mounted2
|
||||
href: api/Dalamud.Game.ClientState.ConditionFlag.html#Dalamud_Game_ClientState_ConditionFlag_Mounted2
|
||||
commentId: F:Dalamud.Game.ClientState.ConditionFlag.Mounted2
|
||||
fullName: Dalamud.Game.ClientState.ConditionFlag.Mounted2
|
||||
nameWithType: ConditionFlag.Mounted2
|
||||
- uid: Dalamud.Game.ClientState.ConditionFlag.Mounting
|
||||
name: Mounting
|
||||
href: api/Dalamud.Game.ClientState.ConditionFlag.html#Dalamud_Game_ClientState_ConditionFlag_Mounting
|
||||
commentId: F:Dalamud.Game.ClientState.ConditionFlag.Mounting
|
||||
fullName: Dalamud.Game.ClientState.ConditionFlag.Mounting
|
||||
nameWithType: ConditionFlag.Mounting
|
||||
- uid: Dalamud.Game.ClientState.ConditionFlag.Mounting71
|
||||
name: Mounting71
|
||||
href: api/Dalamud.Game.ClientState.ConditionFlag.html#Dalamud_Game_ClientState_ConditionFlag_Mounting71
|
||||
commentId: F:Dalamud.Game.ClientState.ConditionFlag.Mounting71
|
||||
fullName: Dalamud.Game.ClientState.ConditionFlag.Mounting71
|
||||
nameWithType: ConditionFlag.Mounting71
|
||||
- uid: Dalamud.Game.ClientState.ConditionFlag.None
|
||||
name: None
|
||||
href: api/Dalamud.Game.ClientState.ConditionFlag.html#Dalamud_Game_ClientState_ConditionFlag_None
|
||||
commentId: F:Dalamud.Game.ClientState.ConditionFlag.None
|
||||
fullName: Dalamud.Game.ClientState.ConditionFlag.None
|
||||
nameWithType: ConditionFlag.None
|
||||
- uid: Dalamud.Game.ClientState.ConditionFlag.NormalConditions
|
||||
name: NormalConditions
|
||||
href: api/Dalamud.Game.ClientState.ConditionFlag.html#Dalamud_Game_ClientState_ConditionFlag_NormalConditions
|
||||
commentId: F:Dalamud.Game.ClientState.ConditionFlag.NormalConditions
|
||||
fullName: Dalamud.Game.ClientState.ConditionFlag.NormalConditions
|
||||
nameWithType: ConditionFlag.NormalConditions
|
||||
- uid: Dalamud.Game.ClientState.ConditionFlag.Occupied
|
||||
name: Occupied
|
||||
href: api/Dalamud.Game.ClientState.ConditionFlag.html#Dalamud_Game_ClientState_ConditionFlag_Occupied
|
||||
commentId: F:Dalamud.Game.ClientState.ConditionFlag.Occupied
|
||||
fullName: Dalamud.Game.ClientState.ConditionFlag.Occupied
|
||||
nameWithType: ConditionFlag.Occupied
|
||||
- uid: Dalamud.Game.ClientState.ConditionFlag.Occupied30
|
||||
name: Occupied30
|
||||
href: api/Dalamud.Game.ClientState.ConditionFlag.html#Dalamud_Game_ClientState_ConditionFlag_Occupied30
|
||||
commentId: F:Dalamud.Game.ClientState.ConditionFlag.Occupied30
|
||||
fullName: Dalamud.Game.ClientState.ConditionFlag.Occupied30
|
||||
nameWithType: ConditionFlag.Occupied30
|
||||
- uid: Dalamud.Game.ClientState.ConditionFlag.Occupied33
|
||||
name: Occupied33
|
||||
href: api/Dalamud.Game.ClientState.ConditionFlag.html#Dalamud_Game_ClientState_ConditionFlag_Occupied33
|
||||
commentId: F:Dalamud.Game.ClientState.ConditionFlag.Occupied33
|
||||
fullName: Dalamud.Game.ClientState.ConditionFlag.Occupied33
|
||||
nameWithType: ConditionFlag.Occupied33
|
||||
- uid: Dalamud.Game.ClientState.ConditionFlag.Occupied38
|
||||
name: Occupied38
|
||||
href: api/Dalamud.Game.ClientState.ConditionFlag.html#Dalamud_Game_ClientState_ConditionFlag_Occupied38
|
||||
commentId: F:Dalamud.Game.ClientState.ConditionFlag.Occupied38
|
||||
fullName: Dalamud.Game.ClientState.ConditionFlag.Occupied38
|
||||
nameWithType: ConditionFlag.Occupied38
|
||||
- uid: Dalamud.Game.ClientState.ConditionFlag.Occupied39
|
||||
name: Occupied39
|
||||
href: api/Dalamud.Game.ClientState.ConditionFlag.html#Dalamud_Game_ClientState_ConditionFlag_Occupied39
|
||||
commentId: F:Dalamud.Game.ClientState.ConditionFlag.Occupied39
|
||||
fullName: Dalamud.Game.ClientState.ConditionFlag.Occupied39
|
||||
nameWithType: ConditionFlag.Occupied39
|
||||
- uid: Dalamud.Game.ClientState.ConditionFlag.OccupiedInCutSceneEvent
|
||||
name: OccupiedInCutSceneEvent
|
||||
href: api/Dalamud.Game.ClientState.ConditionFlag.html#Dalamud_Game_ClientState_ConditionFlag_OccupiedInCutSceneEvent
|
||||
commentId: F:Dalamud.Game.ClientState.ConditionFlag.OccupiedInCutSceneEvent
|
||||
fullName: Dalamud.Game.ClientState.ConditionFlag.OccupiedInCutSceneEvent
|
||||
nameWithType: ConditionFlag.OccupiedInCutSceneEvent
|
||||
- uid: Dalamud.Game.ClientState.ConditionFlag.OccupiedInEvent
|
||||
name: OccupiedInEvent
|
||||
href: api/Dalamud.Game.ClientState.ConditionFlag.html#Dalamud_Game_ClientState_ConditionFlag_OccupiedInEvent
|
||||
commentId: F:Dalamud.Game.ClientState.ConditionFlag.OccupiedInEvent
|
||||
fullName: Dalamud.Game.ClientState.ConditionFlag.OccupiedInEvent
|
||||
nameWithType: ConditionFlag.OccupiedInEvent
|
||||
- uid: Dalamud.Game.ClientState.ConditionFlag.OccupiedInQuestEvent
|
||||
name: OccupiedInQuestEvent
|
||||
href: api/Dalamud.Game.ClientState.ConditionFlag.html#Dalamud_Game_ClientState_ConditionFlag_OccupiedInQuestEvent
|
||||
commentId: F:Dalamud.Game.ClientState.ConditionFlag.OccupiedInQuestEvent
|
||||
fullName: Dalamud.Game.ClientState.ConditionFlag.OccupiedInQuestEvent
|
||||
nameWithType: ConditionFlag.OccupiedInQuestEvent
|
||||
- uid: Dalamud.Game.ClientState.ConditionFlag.OccupiedSummoningBell
|
||||
name: OccupiedSummoningBell
|
||||
href: api/Dalamud.Game.ClientState.ConditionFlag.html#Dalamud_Game_ClientState_ConditionFlag_OccupiedSummoningBell
|
||||
commentId: F:Dalamud.Game.ClientState.ConditionFlag.OccupiedSummoningBell
|
||||
fullName: Dalamud.Game.ClientState.ConditionFlag.OccupiedSummoningBell
|
||||
nameWithType: ConditionFlag.OccupiedSummoningBell
|
||||
- uid: Dalamud.Game.ClientState.ConditionFlag.OnFreeTrial
|
||||
name: OnFreeTrial
|
||||
href: api/Dalamud.Game.ClientState.ConditionFlag.html#Dalamud_Game_ClientState_ConditionFlag_OnFreeTrial
|
||||
commentId: F:Dalamud.Game.ClientState.ConditionFlag.OnFreeTrial
|
||||
fullName: Dalamud.Game.ClientState.ConditionFlag.OnFreeTrial
|
||||
nameWithType: ConditionFlag.OnFreeTrial
|
||||
- uid: Dalamud.Game.ClientState.ConditionFlag.OperatingSiegeMachine
|
||||
name: OperatingSiegeMachine
|
||||
href: api/Dalamud.Game.ClientState.ConditionFlag.html#Dalamud_Game_ClientState_ConditionFlag_OperatingSiegeMachine
|
||||
commentId: F:Dalamud.Game.ClientState.ConditionFlag.OperatingSiegeMachine
|
||||
fullName: Dalamud.Game.ClientState.ConditionFlag.OperatingSiegeMachine
|
||||
nameWithType: ConditionFlag.OperatingSiegeMachine
|
||||
- uid: Dalamud.Game.ClientState.ConditionFlag.ParticipatingInCrossWorldPartyOrAlliance
|
||||
name: ParticipatingInCrossWorldPartyOrAlliance
|
||||
href: api/Dalamud.Game.ClientState.ConditionFlag.html#Dalamud_Game_ClientState_ConditionFlag_ParticipatingInCrossWorldPartyOrAlliance
|
||||
commentId: F:Dalamud.Game.ClientState.ConditionFlag.ParticipatingInCrossWorldPartyOrAlliance
|
||||
fullName: Dalamud.Game.ClientState.ConditionFlag.ParticipatingInCrossWorldPartyOrAlliance
|
||||
nameWithType: ConditionFlag.ParticipatingInCrossWorldPartyOrAlliance
|
||||
- uid: Dalamud.Game.ClientState.ConditionFlag.ParticipatingInCustomMatch
|
||||
name: ParticipatingInCustomMatch
|
||||
href: api/Dalamud.Game.ClientState.ConditionFlag.html#Dalamud_Game_ClientState_ConditionFlag_ParticipatingInCustomMatch
|
||||
commentId: F:Dalamud.Game.ClientState.ConditionFlag.ParticipatingInCustomMatch
|
||||
fullName: Dalamud.Game.ClientState.ConditionFlag.ParticipatingInCustomMatch
|
||||
nameWithType: ConditionFlag.ParticipatingInCustomMatch
|
||||
- uid: Dalamud.Game.ClientState.ConditionFlag.Performing
|
||||
name: Performing
|
||||
href: api/Dalamud.Game.ClientState.ConditionFlag.html#Dalamud_Game_ClientState_ConditionFlag_Performing
|
||||
commentId: F:Dalamud.Game.ClientState.ConditionFlag.Performing
|
||||
fullName: Dalamud.Game.ClientState.ConditionFlag.Performing
|
||||
nameWithType: ConditionFlag.Performing
|
||||
- uid: Dalamud.Game.ClientState.ConditionFlag.PlayingLordOfVerminion
|
||||
name: PlayingLordOfVerminion
|
||||
href: api/Dalamud.Game.ClientState.ConditionFlag.html#Dalamud_Game_ClientState_ConditionFlag_PlayingLordOfVerminion
|
||||
commentId: F:Dalamud.Game.ClientState.ConditionFlag.PlayingLordOfVerminion
|
||||
fullName: Dalamud.Game.ClientState.ConditionFlag.PlayingLordOfVerminion
|
||||
nameWithType: ConditionFlag.PlayingLordOfVerminion
|
||||
- uid: Dalamud.Game.ClientState.ConditionFlag.PlayingMiniGame
|
||||
name: PlayingMiniGame
|
||||
href: api/Dalamud.Game.ClientState.ConditionFlag.html#Dalamud_Game_ClientState_ConditionFlag_PlayingMiniGame
|
||||
commentId: F:Dalamud.Game.ClientState.ConditionFlag.PlayingMiniGame
|
||||
fullName: Dalamud.Game.ClientState.ConditionFlag.PlayingMiniGame
|
||||
nameWithType: ConditionFlag.PlayingMiniGame
|
||||
- uid: Dalamud.Game.ClientState.ConditionFlag.PreparingToCraft
|
||||
name: PreparingToCraft
|
||||
href: api/Dalamud.Game.ClientState.ConditionFlag.html#Dalamud_Game_ClientState_ConditionFlag_PreparingToCraft
|
||||
commentId: F:Dalamud.Game.ClientState.ConditionFlag.PreparingToCraft
|
||||
fullName: Dalamud.Game.ClientState.ConditionFlag.PreparingToCraft
|
||||
nameWithType: ConditionFlag.PreparingToCraft
|
||||
- uid: Dalamud.Game.ClientState.ConditionFlag.PvPDisplayActive
|
||||
name: PvPDisplayActive
|
||||
href: api/Dalamud.Game.ClientState.ConditionFlag.html#Dalamud_Game_ClientState_ConditionFlag_PvPDisplayActive
|
||||
commentId: F:Dalamud.Game.ClientState.ConditionFlag.PvPDisplayActive
|
||||
fullName: Dalamud.Game.ClientState.ConditionFlag.PvPDisplayActive
|
||||
nameWithType: ConditionFlag.PvPDisplayActive
|
||||
- uid: Dalamud.Game.ClientState.ConditionFlag.ReadyingVisitOtherWorld
|
||||
name: ReadyingVisitOtherWorld
|
||||
href: api/Dalamud.Game.ClientState.ConditionFlag.html#Dalamud_Game_ClientState_ConditionFlag_ReadyingVisitOtherWorld
|
||||
commentId: F:Dalamud.Game.ClientState.ConditionFlag.ReadyingVisitOtherWorld
|
||||
fullName: Dalamud.Game.ClientState.ConditionFlag.ReadyingVisitOtherWorld
|
||||
nameWithType: ConditionFlag.ReadyingVisitOtherWorld
|
||||
- uid: Dalamud.Game.ClientState.ConditionFlag.RegisteringForRaceOrMatch
|
||||
name: RegisteringForRaceOrMatch
|
||||
href: api/Dalamud.Game.ClientState.ConditionFlag.html#Dalamud_Game_ClientState_ConditionFlag_RegisteringForRaceOrMatch
|
||||
commentId: F:Dalamud.Game.ClientState.ConditionFlag.RegisteringForRaceOrMatch
|
||||
fullName: Dalamud.Game.ClientState.ConditionFlag.RegisteringForRaceOrMatch
|
||||
nameWithType: ConditionFlag.RegisteringForRaceOrMatch
|
||||
- uid: Dalamud.Game.ClientState.ConditionFlag.RegisteringForTripleTriadMatch
|
||||
name: RegisteringForTripleTriadMatch
|
||||
href: api/Dalamud.Game.ClientState.ConditionFlag.html#Dalamud_Game_ClientState_ConditionFlag_RegisteringForTripleTriadMatch
|
||||
commentId: F:Dalamud.Game.ClientState.ConditionFlag.RegisteringForTripleTriadMatch
|
||||
fullName: Dalamud.Game.ClientState.ConditionFlag.RegisteringForTripleTriadMatch
|
||||
nameWithType: ConditionFlag.RegisteringForTripleTriadMatch
|
||||
- uid: Dalamud.Game.ClientState.ConditionFlag.RolePlaying
|
||||
name: RolePlaying
|
||||
href: api/Dalamud.Game.ClientState.ConditionFlag.html#Dalamud_Game_ClientState_ConditionFlag_RolePlaying
|
||||
commentId: F:Dalamud.Game.ClientState.ConditionFlag.RolePlaying
|
||||
fullName: Dalamud.Game.ClientState.ConditionFlag.RolePlaying
|
||||
nameWithType: ConditionFlag.RolePlaying
|
||||
- uid: Dalamud.Game.ClientState.ConditionFlag.Stealthed
|
||||
name: Stealthed
|
||||
href: api/Dalamud.Game.ClientState.ConditionFlag.html#Dalamud_Game_ClientState_ConditionFlag_Stealthed
|
||||
commentId: F:Dalamud.Game.ClientState.ConditionFlag.Stealthed
|
||||
fullName: Dalamud.Game.ClientState.ConditionFlag.Stealthed
|
||||
nameWithType: ConditionFlag.Stealthed
|
||||
- uid: Dalamud.Game.ClientState.ConditionFlag.SufferingStatusAffliction
|
||||
name: SufferingStatusAffliction
|
||||
href: api/Dalamud.Game.ClientState.ConditionFlag.html#Dalamud_Game_ClientState_ConditionFlag_SufferingStatusAffliction
|
||||
commentId: F:Dalamud.Game.ClientState.ConditionFlag.SufferingStatusAffliction
|
||||
fullName: Dalamud.Game.ClientState.ConditionFlag.SufferingStatusAffliction
|
||||
nameWithType: ConditionFlag.SufferingStatusAffliction
|
||||
- uid: Dalamud.Game.ClientState.ConditionFlag.SufferingStatusAffliction2
|
||||
name: SufferingStatusAffliction2
|
||||
href: api/Dalamud.Game.ClientState.ConditionFlag.html#Dalamud_Game_ClientState_ConditionFlag_SufferingStatusAffliction2
|
||||
commentId: F:Dalamud.Game.ClientState.ConditionFlag.SufferingStatusAffliction2
|
||||
fullName: Dalamud.Game.ClientState.ConditionFlag.SufferingStatusAffliction2
|
||||
nameWithType: ConditionFlag.SufferingStatusAffliction2
|
||||
- uid: Dalamud.Game.ClientState.ConditionFlag.SufferingStatusAffliction63
|
||||
name: SufferingStatusAffliction63
|
||||
href: api/Dalamud.Game.ClientState.ConditionFlag.html#Dalamud_Game_ClientState_ConditionFlag_SufferingStatusAffliction63
|
||||
commentId: F:Dalamud.Game.ClientState.ConditionFlag.SufferingStatusAffliction63
|
||||
fullName: Dalamud.Game.ClientState.ConditionFlag.SufferingStatusAffliction63
|
||||
nameWithType: ConditionFlag.SufferingStatusAffliction63
|
||||
- uid: Dalamud.Game.ClientState.ConditionFlag.SufferingStatusAffliction72
|
||||
name: SufferingStatusAffliction72
|
||||
href: api/Dalamud.Game.ClientState.ConditionFlag.html#Dalamud_Game_ClientState_ConditionFlag_SufferingStatusAffliction72
|
||||
commentId: F:Dalamud.Game.ClientState.ConditionFlag.SufferingStatusAffliction72
|
||||
fullName: Dalamud.Game.ClientState.ConditionFlag.SufferingStatusAffliction72
|
||||
nameWithType: ConditionFlag.SufferingStatusAffliction72
|
||||
- uid: Dalamud.Game.ClientState.ConditionFlag.SufferingStatusAffliction73
|
||||
name: SufferingStatusAffliction73
|
||||
href: api/Dalamud.Game.ClientState.ConditionFlag.html#Dalamud_Game_ClientState_ConditionFlag_SufferingStatusAffliction73
|
||||
commentId: F:Dalamud.Game.ClientState.ConditionFlag.SufferingStatusAffliction73
|
||||
fullName: Dalamud.Game.ClientState.ConditionFlag.SufferingStatusAffliction73
|
||||
nameWithType: ConditionFlag.SufferingStatusAffliction73
|
||||
- uid: Dalamud.Game.ClientState.ConditionFlag.Swimming
|
||||
name: Swimming
|
||||
href: api/Dalamud.Game.ClientState.ConditionFlag.html#Dalamud_Game_ClientState_ConditionFlag_Swimming
|
||||
commentId: F:Dalamud.Game.ClientState.ConditionFlag.Swimming
|
||||
fullName: Dalamud.Game.ClientState.ConditionFlag.Swimming
|
||||
nameWithType: ConditionFlag.Swimming
|
||||
- uid: Dalamud.Game.ClientState.ConditionFlag.SystemError
|
||||
name: SystemError
|
||||
href: api/Dalamud.Game.ClientState.ConditionFlag.html#Dalamud_Game_ClientState_ConditionFlag_SystemError
|
||||
commentId: F:Dalamud.Game.ClientState.ConditionFlag.SystemError
|
||||
fullName: Dalamud.Game.ClientState.ConditionFlag.SystemError
|
||||
nameWithType: ConditionFlag.SystemError
|
||||
- uid: Dalamud.Game.ClientState.ConditionFlag.TradeOpen
|
||||
name: TradeOpen
|
||||
href: api/Dalamud.Game.ClientState.ConditionFlag.html#Dalamud_Game_ClientState_ConditionFlag_TradeOpen
|
||||
commentId: F:Dalamud.Game.ClientState.ConditionFlag.TradeOpen
|
||||
fullName: Dalamud.Game.ClientState.ConditionFlag.TradeOpen
|
||||
nameWithType: ConditionFlag.TradeOpen
|
||||
- uid: Dalamud.Game.ClientState.ConditionFlag.Transformed
|
||||
name: Transformed
|
||||
href: api/Dalamud.Game.ClientState.ConditionFlag.html#Dalamud_Game_ClientState_ConditionFlag_Transformed
|
||||
commentId: F:Dalamud.Game.ClientState.ConditionFlag.Transformed
|
||||
fullName: Dalamud.Game.ClientState.ConditionFlag.Transformed
|
||||
nameWithType: ConditionFlag.Transformed
|
||||
- uid: Dalamud.Game.ClientState.ConditionFlag.Unconscious
|
||||
name: Unconscious
|
||||
href: api/Dalamud.Game.ClientState.ConditionFlag.html#Dalamud_Game_ClientState_ConditionFlag_Unconscious
|
||||
commentId: F:Dalamud.Game.ClientState.ConditionFlag.Unconscious
|
||||
fullName: Dalamud.Game.ClientState.ConditionFlag.Unconscious
|
||||
nameWithType: ConditionFlag.Unconscious
|
||||
- uid: Dalamud.Game.ClientState.ConditionFlag.Unknown57
|
||||
name: Unknown57
|
||||
href: api/Dalamud.Game.ClientState.ConditionFlag.html#Dalamud_Game_ClientState_ConditionFlag_Unknown57
|
||||
commentId: F:Dalamud.Game.ClientState.ConditionFlag.Unknown57
|
||||
fullName: Dalamud.Game.ClientState.ConditionFlag.Unknown57
|
||||
nameWithType: ConditionFlag.Unknown57
|
||||
- uid: Dalamud.Game.ClientState.ConditionFlag.UsingHousingFunctions
|
||||
name: UsingHousingFunctions
|
||||
href: api/Dalamud.Game.ClientState.ConditionFlag.html#Dalamud_Game_ClientState_ConditionFlag_UsingHousingFunctions
|
||||
commentId: F:Dalamud.Game.ClientState.ConditionFlag.UsingHousingFunctions
|
||||
fullName: Dalamud.Game.ClientState.ConditionFlag.UsingHousingFunctions
|
||||
nameWithType: ConditionFlag.UsingHousingFunctions
|
||||
- uid: Dalamud.Game.ClientState.ConditionFlag.UsingParasol
|
||||
name: UsingParasol
|
||||
href: api/Dalamud.Game.ClientState.ConditionFlag.html#Dalamud_Game_ClientState_ConditionFlag_UsingParasol
|
||||
commentId: F:Dalamud.Game.ClientState.ConditionFlag.UsingParasol
|
||||
fullName: Dalamud.Game.ClientState.ConditionFlag.UsingParasol
|
||||
nameWithType: ConditionFlag.UsingParasol
|
||||
- uid: Dalamud.Game.ClientState.ConditionFlag.UsingPartyFinder
|
||||
name: UsingPartyFinder
|
||||
href: api/Dalamud.Game.ClientState.ConditionFlag.html#Dalamud_Game_ClientState_ConditionFlag_UsingPartyFinder
|
||||
commentId: F:Dalamud.Game.ClientState.ConditionFlag.UsingPartyFinder
|
||||
fullName: Dalamud.Game.ClientState.ConditionFlag.UsingPartyFinder
|
||||
nameWithType: ConditionFlag.UsingPartyFinder
|
||||
- uid: Dalamud.Game.ClientState.ConditionFlag.WaitingForDuty
|
||||
name: WaitingForDuty
|
||||
href: api/Dalamud.Game.ClientState.ConditionFlag.html#Dalamud_Game_ClientState_ConditionFlag_WaitingForDuty
|
||||
commentId: F:Dalamud.Game.ClientState.ConditionFlag.WaitingForDuty
|
||||
fullName: Dalamud.Game.ClientState.ConditionFlag.WaitingForDuty
|
||||
nameWithType: ConditionFlag.WaitingForDuty
|
||||
- uid: Dalamud.Game.ClientState.ConditionFlag.WaitingForDutyFinder
|
||||
name: WaitingForDutyFinder
|
||||
href: api/Dalamud.Game.ClientState.ConditionFlag.html#Dalamud_Game_ClientState_ConditionFlag_WaitingForDutyFinder
|
||||
commentId: F:Dalamud.Game.ClientState.ConditionFlag.WaitingForDutyFinder
|
||||
fullName: Dalamud.Game.ClientState.ConditionFlag.WaitingForDutyFinder
|
||||
nameWithType: ConditionFlag.WaitingForDutyFinder
|
||||
- uid: Dalamud.Game.ClientState.ConditionFlag.WaitingForRaceOrMatch
|
||||
name: WaitingForRaceOrMatch
|
||||
href: api/Dalamud.Game.ClientState.ConditionFlag.html#Dalamud_Game_ClientState_ConditionFlag_WaitingForRaceOrMatch
|
||||
commentId: F:Dalamud.Game.ClientState.ConditionFlag.WaitingForRaceOrMatch
|
||||
fullName: Dalamud.Game.ClientState.ConditionFlag.WaitingForRaceOrMatch
|
||||
nameWithType: ConditionFlag.WaitingForRaceOrMatch
|
||||
- uid: Dalamud.Game.ClientState.ConditionFlag.WaitingForTripleTriadMatch
|
||||
name: WaitingForTripleTriadMatch
|
||||
href: api/Dalamud.Game.ClientState.ConditionFlag.html#Dalamud_Game_ClientState_ConditionFlag_WaitingForTripleTriadMatch
|
||||
commentId: F:Dalamud.Game.ClientState.ConditionFlag.WaitingForTripleTriadMatch
|
||||
fullName: Dalamud.Game.ClientState.ConditionFlag.WaitingForTripleTriadMatch
|
||||
nameWithType: ConditionFlag.WaitingForTripleTriadMatch
|
||||
- uid: Dalamud.Game.ClientState.ConditionFlag.WaitingForTripleTriadMatch83
|
||||
name: WaitingForTripleTriadMatch83
|
||||
href: api/Dalamud.Game.ClientState.ConditionFlag.html#Dalamud_Game_ClientState_ConditionFlag_WaitingForTripleTriadMatch83
|
||||
commentId: F:Dalamud.Game.ClientState.ConditionFlag.WaitingForTripleTriadMatch83
|
||||
fullName: Dalamud.Game.ClientState.ConditionFlag.WaitingForTripleTriadMatch83
|
||||
nameWithType: ConditionFlag.WaitingForTripleTriadMatch83
|
||||
- uid: Dalamud.Game.ClientState.ConditionFlag.WaitingToVisitOtherWorld
|
||||
name: WaitingToVisitOtherWorld
|
||||
href: api/Dalamud.Game.ClientState.ConditionFlag.html#Dalamud_Game_ClientState_ConditionFlag_WaitingToVisitOtherWorld
|
||||
commentId: F:Dalamud.Game.ClientState.ConditionFlag.WaitingToVisitOtherWorld
|
||||
fullName: Dalamud.Game.ClientState.ConditionFlag.WaitingToVisitOtherWorld
|
||||
nameWithType: ConditionFlag.WaitingToVisitOtherWorld
|
||||
- uid: Dalamud.Game.ClientState.ConditionFlag.WatchingCutscene
|
||||
name: WatchingCutscene
|
||||
href: api/Dalamud.Game.ClientState.ConditionFlag.html#Dalamud_Game_ClientState_ConditionFlag_WatchingCutscene
|
||||
commentId: F:Dalamud.Game.ClientState.ConditionFlag.WatchingCutscene
|
||||
fullName: Dalamud.Game.ClientState.ConditionFlag.WatchingCutscene
|
||||
nameWithType: ConditionFlag.WatchingCutscene
|
||||
- uid: Dalamud.Game.ClientState.ConditionFlag.WatchingCutscene78
|
||||
name: WatchingCutscene78
|
||||
href: api/Dalamud.Game.ClientState.ConditionFlag.html#Dalamud_Game_ClientState_ConditionFlag_WatchingCutscene78
|
||||
commentId: F:Dalamud.Game.ClientState.ConditionFlag.WatchingCutscene78
|
||||
fullName: Dalamud.Game.ClientState.ConditionFlag.WatchingCutscene78
|
||||
nameWithType: ConditionFlag.WatchingCutscene78
|
||||
- uid: Dalamud.Game.ClientState.JobGauges
|
||||
name: JobGauges
|
||||
href: api/Dalamud.Game.ClientState.JobGauges.html
|
||||
|
|
@ -6623,6 +7212,12 @@ references:
|
|||
commentId: F:Dalamud.Game.ClientState.Structs.Actor.ActorId
|
||||
fullName: Dalamud.Game.ClientState.Structs.Actor.ActorId
|
||||
nameWithType: Actor.ActorId
|
||||
- uid: Dalamud.Game.ClientState.Structs.Actor.BattleNpcTargetActorId
|
||||
name: BattleNpcTargetActorId
|
||||
href: api/Dalamud.Game.ClientState.Structs.Actor.html#Dalamud_Game_ClientState_Structs_Actor_BattleNpcTargetActorId
|
||||
commentId: F:Dalamud.Game.ClientState.Structs.Actor.BattleNpcTargetActorId
|
||||
fullName: Dalamud.Game.ClientState.Structs.Actor.BattleNpcTargetActorId
|
||||
nameWithType: Actor.BattleNpcTargetActorId
|
||||
- uid: Dalamud.Game.ClientState.Structs.Actor.ClassJob
|
||||
name: ClassJob
|
||||
href: api/Dalamud.Game.ClientState.Structs.Actor.html#Dalamud_Game_ClientState_Structs_Actor_ClassJob
|
||||
|
|
@ -6719,6 +7314,12 @@ references:
|
|||
commentId: F:Dalamud.Game.ClientState.Structs.Actor.OwnerId
|
||||
fullName: Dalamud.Game.ClientState.Structs.Actor.OwnerId
|
||||
nameWithType: Actor.OwnerId
|
||||
- uid: Dalamud.Game.ClientState.Structs.Actor.PlayerCharacterTargetActorId
|
||||
name: PlayerCharacterTargetActorId
|
||||
href: api/Dalamud.Game.ClientState.Structs.Actor.html#Dalamud_Game_ClientState_Structs_Actor_PlayerCharacterTargetActorId
|
||||
commentId: F:Dalamud.Game.ClientState.Structs.Actor.PlayerCharacterTargetActorId
|
||||
fullName: Dalamud.Game.ClientState.Structs.Actor.PlayerCharacterTargetActorId
|
||||
nameWithType: Actor.PlayerCharacterTargetActorId
|
||||
- uid: Dalamud.Game.ClientState.Structs.Actor.PlayerTargetStatus
|
||||
name: PlayerTargetStatus
|
||||
href: api/Dalamud.Game.ClientState.Structs.Actor.html#Dalamud_Game_ClientState_Structs_Actor_PlayerTargetStatus
|
||||
|
|
@ -6743,12 +7344,6 @@ references:
|
|||
commentId: F:Dalamud.Game.ClientState.Structs.Actor.SubKind
|
||||
fullName: Dalamud.Game.ClientState.Structs.Actor.SubKind
|
||||
nameWithType: Actor.SubKind
|
||||
- uid: Dalamud.Game.ClientState.Structs.Actor.TargetActorId
|
||||
name: TargetActorId
|
||||
href: api/Dalamud.Game.ClientState.Structs.Actor.html#Dalamud_Game_ClientState_Structs_Actor_TargetActorId
|
||||
commentId: F:Dalamud.Game.ClientState.Structs.Actor.TargetActorId
|
||||
fullName: Dalamud.Game.ClientState.Structs.Actor.TargetActorId
|
||||
nameWithType: Actor.TargetActorId
|
||||
- uid: Dalamud.Game.ClientState.Structs.Actor.UIStatusEffects
|
||||
name: UIStatusEffects
|
||||
href: api/Dalamud.Game.ClientState.Structs.Actor.html#Dalamud_Game_ClientState_Structs_Actor_UIStatusEffects
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue