From 31af5d8d77cb6a9dfc0b72dc5154fa20413f11c1 Mon Sep 17 00:00:00 2001 From: goat <16760685+goaaats@users.noreply.github.com> Date: Fri, 5 Jun 2020 16:12:48 +0200 Subject: [PATCH] docs: regenerate --- ...ud.Game.ClientState.Actors.ActorTable.html | 16 +- ...d.Game.ClientState.Actors.Types.Actor.html | 31 + ...d.Game.ClientState.Actors.Types.Chara.html | 3 + ...tate.Actors.Types.NonPlayer.BattleNpc.html | 33 + ...lientState.Actors.Types.NonPlayer.Npc.html | 3 + ...entState.Actors.Types.PlayerCharacter.html | 33 + .../Dalamud.Game.ClientState.ClientState.html | 36 +- .../Dalamud.Game.ClientState.Condition.html | 238 +++++ ...alamud.Game.ClientState.ConditionFlag.html | 569 +++++++++++ .../Dalamud.Game.ClientState.PartyList.html | 14 +- ...alamud.Game.ClientState.Structs.Actor.html | 109 +- docs/api/Dalamud.Game.ClientState.html | 10 + .../Dalamud.Game.Internal.Gui.ChatGui.html | 4 +- docs/api/Dalamud.Game.SigScanner.html | 2 +- .../Dalamud.Interface.MySinkExtensions.html | 4 +- .../Dalamud.Interface.SerilogEventSink.html | 14 +- docs/api/Dalamud.Interface.UiBuilder.html | 16 +- docs/api/Discord.Attachment.html | 45 +- docs/api/Discord.Cacheable-2.html | 1 - ...iscord.Commands.ShardedCommandContext.html | 3 +- ...Discord.Commands.SocketCommandContext.html | 15 +- docs/api/Discord.Embed.html | 79 +- docs/api/Discord.Emoji.html | 6 +- docs/api/Discord.Emote.html | 12 +- docs/api/Discord.Game.html | 27 +- docs/api/Discord.IEntity-1.html | 1 - docs/api/Discord.Optional.html | 1 - docs/api/Discord.Rest.BaseDiscordClient.html | 271 +++-- docs/api/Discord.Rest.DiscordRestClient.html | 205 +++- docs/api/Discord.Rest.RestApplication.html | 21 +- docs/api/Discord.Rest.RestAuditLogEntry.html | 30 +- docs/api/Discord.Rest.RestBan.html | 12 +- .../api/Discord.Rest.RestCategoryChannel.html | 40 +- docs/api/Discord.Rest.RestChannel.html | 55 +- docs/api/Discord.Rest.RestConnection.html | 31 +- docs/api/Discord.Rest.RestDMChannel.html | 514 +++++++--- docs/api/Discord.Rest.RestGroupChannel.html | 248 +++-- docs/api/Discord.Rest.RestGroupUser.html | 49 +- docs/api/Discord.Rest.RestGuild.html | 876 +++++++++++----- docs/api/Discord.Rest.RestGuildChannel.html | 202 ++-- .../Discord.Rest.RestGuildIntegration.html | 43 +- docs/api/Discord.Rest.RestGuildUser.html | 188 ++-- docs/api/Discord.Rest.RestInvite.html | 71 +- docs/api/Discord.Rest.RestInviteMetadata.html | 45 +- docs/api/Discord.Rest.RestMessage.html | 207 ++-- docs/api/Discord.Rest.RestReaction.html | 3 +- docs/api/Discord.Rest.RestRole.html | 82 +- docs/api/Discord.Rest.RestSelfUser.html | 46 +- docs/api/Discord.Rest.RestSystemMessage.html | 3 +- docs/api/Discord.Rest.RestTextChannel.html | 690 +++++++++---- docs/api/Discord.Rest.RestUser.html | 101 +- docs/api/Discord.Rest.RestUserGuild.html | 24 +- docs/api/Discord.Rest.RestUserMessage.html | 115 ++- docs/api/Discord.Rest.RestVoiceChannel.html | 139 ++- docs/api/Discord.Rest.RestVoiceRegion.html | 30 +- docs/api/Discord.Rest.RestWebhook.html | 45 +- docs/api/Discord.Rest.RestWebhookUser.html | 194 ++-- .../Discord.WebSocket.BaseSocketClient.html | 199 ++-- ...iscord.WebSocket.DiscordShardedClient.html | 389 ++++++-- ...Discord.WebSocket.DiscordSocketClient.html | 448 ++++++--- ...scord.WebSocket.SocketCategoryChannel.html | 38 +- docs/api/Discord.WebSocket.SocketChannel.html | 22 +- .../Discord.WebSocket.SocketDMChannel.html | 404 ++++++-- .../Discord.WebSocket.SocketGroupChannel.html | 414 ++++++-- .../Discord.WebSocket.SocketGroupUser.html | 74 +- docs/api/Discord.WebSocket.SocketGuild.html | 934 +++++++++++++----- .../Discord.WebSocket.SocketGuildChannel.html | 159 ++- .../Discord.WebSocket.SocketGuildUser.html | 210 ++-- docs/api/Discord.WebSocket.SocketMessage.html | 193 ++-- .../Discord.WebSocket.SocketNewsChannel.html | 7 +- .../api/Discord.WebSocket.SocketPresence.html | 9 +- .../api/Discord.WebSocket.SocketReaction.html | 3 +- docs/api/Discord.WebSocket.SocketRole.html | 82 +- .../api/Discord.WebSocket.SocketSelfUser.html | 68 +- ...Discord.WebSocket.SocketSystemMessage.html | 3 +- .../Discord.WebSocket.SocketTextChannel.html | 560 ++++++++--- .../Discord.WebSocket.SocketUnknownUser.html | 25 +- docs/api/Discord.WebSocket.SocketUser.html | 98 +- .../Discord.WebSocket.SocketUserMessage.html | 124 ++- .../Discord.WebSocket.SocketVoiceChannel.html | 135 ++- .../Discord.WebSocket.SocketVoiceState.html | 49 +- .../Discord.WebSocket.SocketWebhookUser.html | 213 ++-- docs/api/Discord.html | 3 +- docs/api/ImGuiNET.RangeAccessor-1.html | 1 - docs/api/ImGuiNET.RangePtrAccessor-1.html | 1 - docs/api/toc.html | 6 + docs/manifest.json | 834 ++++++++-------- docs/xrefmap.yml | 607 +++++++++++- 88 files changed, 9028 insertions(+), 3189 deletions(-) create mode 100644 docs/api/Dalamud.Game.ClientState.Condition.html create mode 100644 docs/api/Dalamud.Game.ClientState.ConditionFlag.html diff --git a/docs/api/Dalamud.Game.ClientState.Actors.ActorTable.html b/docs/api/Dalamud.Game.ClientState.Actors.ActorTable.html index c3207b723..fe1bc83de 100644 --- a/docs/api/Dalamud.Game.ClientState.Actors.ActorTable.html +++ b/docs/api/Dalamud.Game.ClientState.Actors.ActorTable.html @@ -217,7 +217,7 @@ public Actor this[int index] { get; } Improve this Doc - View Source + View Source

Length

@@ -250,7 +250,7 @@ public Actor this[int index] { get; } Improve this Doc - View Source + View Source

GetEnumerator()

@@ -282,7 +282,7 @@ public Actor this[int index] { get; } Improve this Doc - View Source + View Source

IReadOnlyCollection<Actor>.Count

@@ -312,7 +312,7 @@ public Actor this[int index] { get; } Improve this Doc - View Source + View Source

ICollection.CopyTo(Array, Int32)

@@ -349,7 +349,7 @@ public Actor this[int index] { get; } Improve this Doc - View Source + View Source

ICollection.Count

@@ -379,7 +379,7 @@ public Actor this[int index] { get; } Improve this Doc - View Source + View Source

ICollection.IsSynchronized

@@ -409,7 +409,7 @@ public Actor this[int index] { get; } Improve this Doc - View Source + View Source

ICollection.SyncRoot

@@ -439,7 +439,7 @@ public Actor this[int index] { get; } Improve this Doc - View Source + View Source

IEnumerable.GetEnumerator()

diff --git a/docs/api/Dalamud.Game.ClientState.Actors.Types.Actor.html b/docs/api/Dalamud.Game.ClientState.Actors.Types.Actor.html index 41d756570..c669031d2 100644 --- a/docs/api/Dalamud.Game.ClientState.Actors.Types.Actor.html +++ b/docs/api/Dalamud.Game.ClientState.Actors.Types.Actor.html @@ -410,6 +410,37 @@ This ranges from -pi to pi radians.

+ + | + Improve this Doc + + + View Source + + +

TargetActorID

+

The target of the actor

+
+
+
Declaration
+
+ 
public virtual int TargetActorID { get; }
+
+
Property Value
+ + + + + + + + + + + + + +
TypeDescription
System.Int32
| Improve this Doc diff --git a/docs/api/Dalamud.Game.ClientState.Actors.Types.Chara.html b/docs/api/Dalamud.Game.ClientState.Actors.Types.Chara.html index 872373563..f8178634a 100644 --- a/docs/api/Dalamud.Game.ClientState.Actors.Types.Chara.html +++ b/docs/api/Dalamud.Game.ClientState.Actors.Types.Chara.html @@ -116,6 +116,9 @@
Actor.YalmDistanceY
+
+ Actor.TargetActorID +
System.Object.ToString()
diff --git a/docs/api/Dalamud.Game.ClientState.Actors.Types.NonPlayer.BattleNpc.html b/docs/api/Dalamud.Game.ClientState.Actors.Types.NonPlayer.BattleNpc.html index 54687bd21..ff249b1b0 100644 --- a/docs/api/Dalamud.Game.ClientState.Actors.Types.NonPlayer.BattleNpc.html +++ b/docs/api/Dalamud.Game.ClientState.Actors.Types.NonPlayer.BattleNpc.html @@ -283,6 +283,39 @@ + + | + Improve this Doc + + + View Source + + +

TargetActorID

+

Target of the Battle NPC

+
+
+
Declaration
+
+ 
public override int TargetActorID { get; }
+
+
Property Value
+ + + + + + + + + + + + + +
TypeDescription
System.Int32
+
Overrides
+
Actor.TargetActorID
diff --git a/docs/api/Dalamud.Game.ClientState.Actors.Types.NonPlayer.Npc.html b/docs/api/Dalamud.Game.ClientState.Actors.Types.NonPlayer.Npc.html index e3dd23a22..b5735fb00 100644 --- a/docs/api/Dalamud.Game.ClientState.Actors.Types.NonPlayer.Npc.html +++ b/docs/api/Dalamud.Game.ClientState.Actors.Types.NonPlayer.Npc.html @@ -137,6 +137,9 @@
Actor.YalmDistanceY
+
+ Actor.TargetActorID +
System.Object.ToString()
diff --git a/docs/api/Dalamud.Game.ClientState.Actors.Types.PlayerCharacter.html b/docs/api/Dalamud.Game.ClientState.Actors.Types.PlayerCharacter.html index f0a648332..2de98eb5c 100644 --- a/docs/api/Dalamud.Game.ClientState.Actors.Types.PlayerCharacter.html +++ b/docs/api/Dalamud.Game.ClientState.Actors.Types.PlayerCharacter.html @@ -307,6 +307,39 @@ + + | + Improve this Doc + + + View Source + + +

TargetActorID

+

Target of the PlayerCharacter

+
+
+
Declaration
+
+ 
public override int TargetActorID { get; }
+
+
Property Value
+ + + + + + + + + + + + + +
TypeDescription
System.Int32
+
Overrides
+
Actor.TargetActorID
diff --git a/docs/api/Dalamud.Game.ClientState.ClientState.html b/docs/api/Dalamud.Game.ClientState.ClientState.html index 60b42db2e..168e9e651 100644 --- a/docs/api/Dalamud.Game.ClientState.ClientState.html +++ b/docs/api/Dalamud.Game.ClientState.ClientState.html @@ -123,7 +123,7 @@ Improve this Doc - View Source + View Source

ClientState(Dalamud, DalamudStartInfo, SigScanner)

@@ -225,6 +225,36 @@ + + | + Improve this Doc + + + View Source + +

Condition

+

Provides access to client conditions/player state. Allows you to check if a player is in a duty, mounted, etc.

+
+
+
Declaration
+
+ 
public Condition Condition
+
+
Field Value
+ + + + + + + + + + + + + +
TypeDescription
Condition
| Improve this Doc @@ -447,7 +477,7 @@ public PlayerCharacter LocalPlayer { get; } Improve this Doc - View Source + View Source

Dispose()

@@ -462,7 +492,7 @@ public PlayerCharacter LocalPlayer { get; } Improve this Doc - View Source + View Source

Enable()

diff --git a/docs/api/Dalamud.Game.ClientState.Condition.html b/docs/api/Dalamud.Game.ClientState.Condition.html new file mode 100644 index 000000000..62fa8c87b --- /dev/null +++ b/docs/api/Dalamud.Game.ClientState.Condition.html @@ -0,0 +1,238 @@ + + + + + + + + Class Condition + + + + + + + + + + + + + + + + +
+
+ + + +
+ +
+
+
+ +
+ +
+
+
+
+
+
+
+ + +

Class Condition +

+

Provides access to conditions (generally player state). You can check whether a player is in combat, mounted, etc.

+
+
+
+
Inheritance
+
System.Object
+
Condition
+
+
+
Inherited Members
+
+ System.Object.ToString() +
+
+ System.Object.Equals(System.Object) +
+
+ System.Object.Equals(System.Object, System.Object) +
+
+ System.Object.ReferenceEquals(System.Object, System.Object) +
+
+ System.Object.GetHashCode() +
+
+ System.Object.GetType() +
+
+ System.Object.MemberwiseClone() +
+
+
Namespace: Dalamud.Game.ClientState
+
Assembly: Dalamud.dll
+
Syntax
+
+ 
public class Condition
+
+

Fields +

+ + | + Improve this Doc + + + View Source + +

MaxConditionEntries

+

The current max number of conditions. You can get this just by looking at the condition sheet and how many rows it has.

+
+
+
Declaration
+
+ 
public const int MaxConditionEntries = 100
+
+
Field Value
+ + + + + + + + + + + + + +
TypeDescription
System.Int32
+

Properties +

+ + | + Improve this Doc + + + View Source + + +

Item[ConditionFlag]

+

Check the value of a specific condition/state flag.

+
+
+
Declaration
+
+ 
public bool this[ConditionFlag flag] { get; }
+
+
Parameters
+ + + + + + + + + + + + + + + +
TypeNameDescription
ConditionFlagflag

The condition flag to check

+
+
Property Value
+ + + + + + + + + + + + + +
TypeDescription
System.Boolean
+
+
+ + +
+
+ + +
+ + + + + + diff --git a/docs/api/Dalamud.Game.ClientState.ConditionFlag.html b/docs/api/Dalamud.Game.ClientState.ConditionFlag.html new file mode 100644 index 000000000..103aa764a --- /dev/null +++ b/docs/api/Dalamud.Game.ClientState.ConditionFlag.html @@ -0,0 +1,569 @@ + + + + + + + + Enum ConditionFlag + + + + + + + + + + + + + + + + +
+
+ + + +
+ +
+
+
+ +
+ +
+
+
+
+
+
+
+ + +

Enum ConditionFlag +

+

Possible state flags (or conditions as they're called internally) that can be set on the local client.

+

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.

+
+
+
Namespace: Dalamud.Game.ClientState
+
Assembly: Dalamud.dll
+
Syntax
+
+ 
public enum ConditionFlag
+
+

Fields +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescription
AutorunActive

Unable to execute command while auto-run is active.

+
BeingMoved

Unable to execute command while being moved.

+
BetweenAreas

Unable to execute command while between areas.

+
BetweenAreas51

Unable to execute command while between areas.

+
BoundByDuty

Unable to execute command while bound by duty.

+
BoundByDuty56

Unable to execute command while bound by duty.

+
BoundByDuty95

Unable to execute command while bound by duty.

+
BoundToDuty97

Unable to execute command while bound by duty.

+
CarryingItem

Unable to execute command while carrying an item.

+
CarryingObject

Unable to execute command while carrying an object.

+
Casting

Unable to execute command while casting.

+
Casting87

Unable to execute command while casting.

+
ChocoboRacing

Unable to execute command while chocobo racing.

+
ConditionLocation

Unable to execute command at this location.

+
Crafting

Unable to execute command while crafting.

+
Crafting40

Unable to execute command while crafting.

+
CreatingCharacter

Unable to execute command while creating a character.

+
Diving

Unable to execute command while diving.

+
DutyRecorderPlayback

Unable to execute command while playing duty record.

+
Emoting

Unable to execute command during an emote.

+
Fishing

Unable to execute command while fishing.

+
Gathering

Unable to execute command while gathering.

+
Gathering42

Unable to execute command while gathering.

+
InCombat

Unable to execute command during combat.

+
InDeepDungeon

Unable to execute command while delving into a deep dungeon.

+
InDuelingArea

Unable to execute command while in a dueling area.

+
InFlight

Unable to execute command while in flight.

+
InThatPosition

Unable to execute command while in that position.

+
InThisState88

Unable to execute command in this state.

+
InThisState89

Unable to execute command in this state.

+
Jumping

Unable to execute command while jumping.

+
Jumping61

Unable to execute command while jumping.

+
LoggingOut

Unable to execute command while logging out.

+
MeldingMateria

Unable to execute command while melding materia.

+
Mounted

Unable to execute command while mounted.

+
Mounted2

Unable to execute command while mounted.

+
Mounting

Unable to execute command while mounting.

+
Mounting71

Unable to execute command while mounting.

+
None

Unused.

+
NormalConditions

Unable to execute command under normal conditions.

+
Occupied

Unable to execute command while occupied.

+
Occupied30

Unable to execute command while occupied.

+
Occupied33

Unable to execute command while occupied.

+
Occupied38

Unable to execute command while occupied.

+
Occupied39

Unable to execute command while occupied.

+
OccupiedInCutSceneEvent

Unable to execute command while occupied.

+
OccupiedInEvent

Unable to execute command while occupied.

+
OccupiedInQuestEvent

Unable to execute command while occupied.

+
OccupiedSummoningBell

Unable to execute command while occupied.

+
OnFreeTrial

Unable to execute command while on the free trial.

+
OperatingSiegeMachine

Unable to execute command while operating a siege machine.

+
ParticipatingInCrossWorldPartyOrAlliance

Unable to execute command while participating in a cross-world party or alliance.

+
ParticipatingInCustomMatch

Unable to execute command while participating in a custom match.

+
Performing

Unable to execute command while performing.

+
PlayingLordOfVerminion

Unable to execute command while playing Lord of Verminion.

+
PlayingMiniGame

Unable to execute command while playing a mini-game.

+
PreparingToCraft

Unable to execute command while preparing to craft.

+
PvPDisplayActive

Unable to execute command while the PvP display is active.

+
ReadyingVisitOtherWorld

Unable to execute command while readying to visit another World.

+
RegisteringForRaceOrMatch

Unable to execute command while registering for a race or match.

+
RegisteringForTripleTriadMatch

Unable to execute command while registering for a Triple Triad match.

+
RolePlaying

Unable to execute command while role-playing.

+
Stealthed

Unable to execute command while stealthed.

+
SufferingStatusAffliction

Unable to execute command while suffering status affliction.

+
SufferingStatusAffliction2

Unable to execute command while suffering status affliction.

+
SufferingStatusAffliction63

Unable to execute command while suffering status affliction.

+
SufferingStatusAffliction72

Unable to execute command while suffering status affliction.

+
SufferingStatusAffliction73

Unable to execute command while suffering status affliction.

+
Swimming

Unable to execute command while swimming.

+
SystemError

Unable to execute command due to system error.

+
TradeOpen

Unable to execute command while a trade is open.

+
Transformed

Unable to execute command while transformed.

+
Unconscious

Unable to execute command while unconscious.

+
Unknown57

Unable to execute command at this time.

+
UsingHousingFunctions

Unable to execute command while using housing functions.

+
UsingParasol

Unable to execute command while using a parasol.

+
UsingPartyFinder

Unable to execute command while using the Party Finder.

+
WaitingForDuty

Unable to execute command while waiting for duty.

+
WaitingForDutyFinder

Unable to execute command while waiting for Duty Finder.

+
WaitingForRaceOrMatch

Unable to execute command while waiting for a race or match.

+
WaitingForTripleTriadMatch

Unable to execute command while waiting for a Triple Triad match.

+
WaitingForTripleTriadMatch83

Unable to execute command while waiting for a Triple Triad match.

+
WaitingToVisitOtherWorld

Unable to execute command while waiting to visit another World.

+
WatchingCutscene

Unable to execute command while watching a cutscene.

+
WatchingCutscene78

Unable to execute command while watching a cutscene.

+
+

Extension Methods

+ +
+
+ + +
+
+ + +
+ + + + + + diff --git a/docs/api/Dalamud.Game.ClientState.PartyList.html b/docs/api/Dalamud.Game.ClientState.PartyList.html index 423ca41aa..748f4b2bb 100644 --- a/docs/api/Dalamud.Game.ClientState.PartyList.html +++ b/docs/api/Dalamud.Game.ClientState.PartyList.html @@ -164,7 +164,7 @@ Improve this Doc - View Source + View Source

Count

@@ -194,7 +194,7 @@ Improve this Doc - View Source + View Source

IsSynchronized

@@ -271,7 +271,7 @@ Improve this Doc - View Source + View Source

Length

@@ -301,7 +301,7 @@ Improve this Doc - View Source + View Source

SyncRoot

@@ -400,7 +400,7 @@ Improve this Doc - View Source + View Source

GetEnumerator()

@@ -432,7 +432,7 @@ Improve this Doc - View Source + View Source

IReadOnlyCollection<PartyMember>.Count

@@ -462,7 +462,7 @@ Improve this Doc - View Source + View Source

IEnumerable.GetEnumerator()

diff --git a/docs/api/Dalamud.Game.ClientState.Structs.Actor.html b/docs/api/Dalamud.Game.ClientState.Structs.Actor.html index 369427f1e..08f69bfa4 100644 --- a/docs/api/Dalamud.Game.ClientState.Structs.Actor.html +++ b/docs/api/Dalamud.Game.ClientState.Structs.Actor.html @@ -134,12 +134,41 @@ + + | + Improve this Doc + + + View Source + +

BattleNpcTargetActorId

+
+
+
Declaration
+
+ 
public int BattleNpcTargetActorId
+
+
Field Value
+ + + + + + + + + + + + + +
TypeDescription
System.Int32
| Improve this Doc - View Source + View Source

ClassJob

@@ -168,7 +197,7 @@ Improve this Doc - View Source + View Source

CompanyTag

@@ -197,7 +226,7 @@ Improve this Doc - View Source + View Source

CurrentHp

@@ -226,7 +255,7 @@ Improve this Doc - View Source + View Source

CurrentMp

@@ -255,7 +284,7 @@ Improve this Doc - View Source + View Source

CurrentWorld

@@ -342,7 +371,7 @@ Improve this Doc - View Source + View Source

HomeWorld

@@ -400,7 +429,7 @@ Improve this Doc - View Source + View Source

Level

@@ -429,7 +458,7 @@ Improve this Doc - View Source + View Source

MaxHp

@@ -458,7 +487,7 @@ Improve this Doc - View Source + View Source

MaxMp

@@ -516,7 +545,7 @@ Improve this Doc - View Source + View Source

NameId

@@ -598,6 +627,35 @@ + + | + Improve this Doc + + + View Source + +

PlayerCharacterTargetActorId

+
+
+
Declaration
+
+ 
public int PlayerCharacterTargetActorId
+
+
Field Value
+ + + + + + + + + + + + + +
TypeDescription
System.Int32
| Improve this Doc @@ -714,41 +772,12 @@ - - | - Improve this Doc - - - View Source - -

TargetActorId

-
-
-
Declaration
-
- 
public int TargetActorId
-
-
Field Value
- - - - - - - - - - - - - -
TypeDescription
System.Int32
| Improve this Doc - View Source + View Source

UIStatusEffects

diff --git a/docs/api/Dalamud.Game.ClientState.html b/docs/api/Dalamud.Game.ClientState.html index 86d916897..b94817bc2 100644 --- a/docs/api/Dalamud.Game.ClientState.html +++ b/docs/api/Dalamud.Game.ClientState.html @@ -79,6 +79,9 @@

ClientState

This class represents the state of the game client at the time of access.

+
+

Condition

+

Provides access to conditions (generally player state). You can check whether a player is in combat, mounted, etc.

JobGauges

@@ -88,6 +91,13 @@ all keyboard keys, indexed by virtual vkCode

PartyList

+

Enums +

+

ConditionFlag

+

Possible state flags (or conditions as they're called internally) that can be set on the local client.

+

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.

+
diff --git a/docs/api/Dalamud.Game.Internal.Gui.ChatGui.html b/docs/api/Dalamud.Game.Internal.Gui.ChatGui.html index d8b25c814..8c18fe070 100644 --- a/docs/api/Dalamud.Game.Internal.Gui.ChatGui.html +++ b/docs/api/Dalamud.Game.Internal.Gui.ChatGui.html @@ -324,7 +324,7 @@ later to be processed when UpdateQueue() is called.

Improve this Doc - View Source + View Source

PrintError(String)

@@ -356,7 +356,7 @@ later to be processed when UpdateQueue() is called.

Improve this Doc - View Source + View Source

UpdateQueue(Framework)

diff --git a/docs/api/Dalamud.Game.SigScanner.html b/docs/api/Dalamud.Game.SigScanner.html index 78c39f09d..08320f454 100644 --- a/docs/api/Dalamud.Game.SigScanner.html +++ b/docs/api/Dalamud.Game.SigScanner.html @@ -503,7 +503,7 @@ Place your cursor on the line calling a static address, and create and IDA sig.<
Declaration
- 
public IntPtr GetStaticAddressFromSig(string signature, int offset)
+ 
public IntPtr GetStaticAddressFromSig(string signature, int offset = 0)
Parameters
diff --git a/docs/api/Dalamud.Interface.MySinkExtensions.html b/docs/api/Dalamud.Interface.MySinkExtensions.html index 7bda34575..d23f96258 100644 --- a/docs/api/Dalamud.Interface.MySinkExtensions.html +++ b/docs/api/Dalamud.Interface.MySinkExtensions.html @@ -117,7 +117,7 @@ Improve this Doc - View Source + View Source

EventSink(LoggerSinkConfiguration, IFormatProvider)

@@ -175,7 +175,7 @@ Improve this Doc
  • - View Source + View Source
    • diff --git a/docs/api/Dalamud.Interface.SerilogEventSink.html b/docs/api/Dalamud.Interface.SerilogEventSink.html index e4d3dfe03..f386011ae 100644 --- a/docs/api/Dalamud.Interface.SerilogEventSink.html +++ b/docs/api/Dalamud.Interface.SerilogEventSink.html @@ -121,7 +121,7 @@ Improve this Doc - View Source + View Source

    SerilogEventSink(IFormatProvider)

    @@ -155,7 +155,7 @@ Improve this Doc - View Source + View Source

    Instance

    @@ -186,7 +186,7 @@ Improve this Doc - View Source + View Source

    Emit(LogEvent)

    @@ -220,14 +220,14 @@ Improve this Doc - View Source + View Source

    OnLogLine

    Declaration
    - 
    public event EventHandler<string> OnLogLine
    + 
    public event EventHandler<(string line, LogEventLevel level)> OnLogLine
    Event Type
    @@ -239,7 +239,7 @@ - + @@ -259,7 +259,7 @@ Improve this Doc
  • - View Source + View Source
    • diff --git a/docs/api/Dalamud.Interface.UiBuilder.html b/docs/api/Dalamud.Interface.UiBuilder.html index d5ab88dc9..b030800e0 100644 --- a/docs/api/Dalamud.Interface.UiBuilder.html +++ b/docs/api/Dalamud.Interface.UiBuilder.html @@ -123,7 +123,7 @@ It can be used to draw custom windows and overlays.

    Improve this Doc - View Source + View Source

    UiBuilder(InterfaceManager, String)

    @@ -165,7 +165,7 @@ It can be used to draw custom windows and overlays.

    Improve this Doc - View Source + View Source

    OnOpenConfigUi

    Event that is fired when the plugin should open its configuration interface.

    @@ -259,7 +259,7 @@ It can be used to draw custom windows and overlays.

    Improve this Doc - View Source + View Source

    OnBuildFonts

    @@ -296,7 +296,7 @@ pointers inside this handler.
    Improve this Doc - View Source + View Source

    Dispose()

    @@ -312,7 +312,7 @@ pointers inside this handler.
    Improve this Doc - View Source + View Source

    LoadImage(Byte[])

    @@ -362,7 +362,7 @@ pointers inside this handler.
    Improve this Doc - View Source + View Source

    LoadImage(String)

    @@ -412,7 +412,7 @@ pointers inside this handler.
    Improve this Doc - View Source + View Source

    LoadImageRaw(Byte[], Int32, Int32, Int32)

    @@ -480,7 +480,7 @@ pointers inside this handler.
    Improve this Doc - View Source + View Source

    RebuildFonts()

    diff --git a/docs/api/Discord.Attachment.html b/docs/api/Discord.Attachment.html index 6a3168b86..a236a0b34 100644 --- a/docs/api/Discord.Attachment.html +++ b/docs/api/Discord.Attachment.html @@ -73,7 +73,8 @@

    Class Attachment

    -
    +

    Represents a message attachment found in a IUserMessage.

    +
    Inheritance
    @@ -122,7 +123,8 @@

    Filename

    -
    +

    Gets the filename of this attachment.

    +
    Declaration
    @@ -139,7 +141,8 @@
    - +
    System.EventHandler<System.String>System.EventHandler<System.ValueTuple<System.String, Serilog.Events.LogEventLevel>>
    System.String

    A string containing the full filename of this attachment (e.g. textFile.txt).

    +
    @@ -152,7 +155,8 @@

    Height

    -
    +

    Gets the height of this attachment.

    +
    Declaration
    @@ -169,7 +173,8 @@ System.Nullable<System.Int32> - +

    The height of this attachment if it is a picture; otherwise null.

    + @@ -182,7 +187,8 @@

    Id

    -
    +

    Gets the ID of this attachment.

    +
    Declaration
    @@ -199,7 +205,8 @@ System.UInt64 - +

    A snowflake ID associated with this attachment.

    + @@ -212,7 +219,8 @@

    ProxyUrl

    -
    +

    Gets a proxied URL of this attachment.

    +
    Declaration
    @@ -229,7 +237,8 @@ System.String - +

    A string containing the proxied URL of this attachment.

    + @@ -242,7 +251,8 @@

    Size

    -
    +

    Gets the file size of this attachment.

    +
    Declaration
    @@ -259,7 +269,8 @@ System.Int32 - +

    The size of this attachment in bytes.

    + @@ -272,7 +283,8 @@

    Url

    -
    +

    Gets the URL of this attachment.

    +
    Declaration
    @@ -289,7 +301,8 @@ System.String - +

    A string containing the URL of this attachment.

    + @@ -302,7 +315,8 @@

    Width

    -
    +

    Gets the width of this attachment.

    +
    Declaration
    @@ -319,7 +333,8 @@ System.Nullable<System.Int32> - +

    The width of this attachment if it is a picture; otherwise null.

    + diff --git a/docs/api/Discord.Cacheable-2.html b/docs/api/Discord.Cacheable-2.html index 50c963297..7adf24f0d 100644 --- a/docs/api/Discord.Cacheable-2.html +++ b/docs/api/Discord.Cacheable-2.html @@ -102,7 +102,6 @@
    Syntax
    public struct Cacheable<TEntity, TId>
-
     where TEntity : IEntity<TId> where TId : IEquatable<TId>
    Type Parameters
    diff --git a/docs/api/Discord.Commands.ShardedCommandContext.html b/docs/api/Discord.Commands.ShardedCommandContext.html index 404149a34..745a7e11b 100644 --- a/docs/api/Discord.Commands.ShardedCommandContext.html +++ b/docs/api/Discord.Commands.ShardedCommandContext.html @@ -226,7 +226,8 @@

    ICommandContext.Client

    -
    +

    Gets the IDiscordClient that the command is executed with.

    +
    Declaration
    diff --git a/docs/api/Discord.Commands.SocketCommandContext.html b/docs/api/Discord.Commands.SocketCommandContext.html index e87d1352c..3e1e6b933 100644 --- a/docs/api/Discord.Commands.SocketCommandContext.html +++ b/docs/api/Discord.Commands.SocketCommandContext.html @@ -357,7 +357,8 @@

    ICommandContext.Channel

    -
    +

    Gets the IMessageChannel that the command is executed in.

    +
    Declaration
    @@ -387,7 +388,8 @@

    ICommandContext.Client

    -
    +

    Gets the IDiscordClient that the command is executed with.

    +
    Declaration
    @@ -417,7 +419,8 @@

    ICommandContext.Guild

    -
    +

    Gets the IGuild that the command is executed in.

    +
    Declaration
    @@ -447,7 +450,8 @@

    ICommandContext.Message

    -
    +

    Gets the IUserMessage that the command is interpreted from.

    +
    Declaration
    @@ -477,7 +481,8 @@

    ICommandContext.User

    -
    +

    Gets the IUser who executed the command.

    +
    Declaration
    diff --git a/docs/api/Discord.Embed.html b/docs/api/Discord.Embed.html index a1868da85..e5b77304e 100644 --- a/docs/api/Discord.Embed.html +++ b/docs/api/Discord.Embed.html @@ -123,7 +123,8 @@

    Author

    -
    +

    Gets the author field of this embed.

    +
    Declaration
    @@ -140,7 +141,8 @@ System.Nullable<EmbedAuthor> - +

    The author field of the embed, or null if none is set.

    + @@ -153,7 +155,8 @@

    Color

    -
    +

    Gets the color of this embed.

    +
    Declaration
    @@ -170,7 +173,8 @@ System.Nullable<Color> - +

    The color of the embed present on the side of the embed, or null if none is set.

    + @@ -183,7 +187,8 @@

    Description

    -
    +

    Gets the description of this embed.

    +
    Declaration
    @@ -200,7 +205,8 @@ System.String - +

    The description field of the embed.

    + @@ -213,7 +219,8 @@

    Fields

    -
    +

    Gets the fields of the embed.

    +
    Declaration
    @@ -230,7 +237,8 @@ System.Collections.Immutable.ImmutableArray<EmbedField> - +

    An array of the fields of the embed.

    + @@ -243,7 +251,8 @@ -
    +

    Gets the footer field of this embed.

    +
    Declaration
    @@ -260,7 +269,8 @@ System.Nullable<EmbedFooter> - +

    The author field of the embed, or null if none is set.

    + @@ -273,7 +283,8 @@

    Image

    -
    +

    Gets the image of this embed.

    +
    Declaration
    @@ -290,7 +301,8 @@ System.Nullable<EmbedImage> - +

    The image of the embed, or null if none is set.

    + @@ -334,7 +346,8 @@

    Provider

    -
    +

    Gets the provider of this embed.

    +
    Declaration
    @@ -351,7 +364,8 @@ System.Nullable<EmbedProvider> - +

    The source of the embed, or null if none is set.

    + @@ -364,7 +378,8 @@

    Thumbnail

    -
    +

    Gets the thumbnail featured in this embed.

    +
    Declaration
    @@ -381,7 +396,8 @@ System.Nullable<EmbedThumbnail> - +

    The thumbnail featured in the embed, or null if none is set.

    + @@ -394,7 +410,8 @@

    Timestamp

    -
    +

    Gets the timestamp of this embed.

    +
    Declaration
    @@ -411,7 +428,9 @@ System.Nullable<System.DateTimeOffset> - +

    A System.DateTimeOffset based on the timestamp present at the bottom left of the embed, or +null if none is set.

    + @@ -424,7 +443,8 @@

    Title

    -
    +

    Gets the title of this embed.

    +
    Declaration
    @@ -441,7 +461,8 @@ System.String - +

    The title of the embed.

    + @@ -454,7 +475,8 @@

    Type

    -
    +

    Gets the type of this embed.

    +
    Declaration
    @@ -471,7 +493,8 @@ EmbedType - +

    The type of the embed.

    + @@ -484,7 +507,8 @@

    Url

    -
    +

    Gets the title URL of this embed.

    +
    Declaration
    @@ -501,7 +525,8 @@ System.String - +

    A string containing the URL set in a title of the embed.

    + @@ -514,7 +539,8 @@

    Video

    -
    +

    Gets the video of this embed.

    +
    Declaration
    @@ -531,7 +557,8 @@ System.Nullable<EmbedVideo> - +

    The video of the embed, or null if none is set.

    + diff --git a/docs/api/Discord.Emoji.html b/docs/api/Discord.Emoji.html index 6e7f8bfff..adf39e695 100644 --- a/docs/api/Discord.Emoji.html +++ b/docs/api/Discord.Emoji.html @@ -153,7 +153,8 @@

    Name

    -
    +

    Gets the display name or Unicode representation of this emote.

    +
    Declaration
    @@ -170,7 +171,8 @@ System.String - +

    A string representing the display name or the Unicode representation (e.g. 🤔) of this emote.

    + diff --git a/docs/api/Discord.Emote.html b/docs/api/Discord.Emote.html index bdbc4e2b7..a67114e0f 100644 --- a/docs/api/Discord.Emote.html +++ b/docs/api/Discord.Emote.html @@ -152,7 +152,8 @@

    CreatedAt

    -
    +

    Gets when the snowflake was created.

    +
    Declaration
    @@ -169,7 +170,8 @@ System.DateTimeOffset - +

    A System.DateTimeOffset representing when the entity was first created.

    + @@ -212,7 +214,8 @@

    Name

    -
    +

    Gets the display name or Unicode representation of this emote.

    +
    Declaration
    @@ -229,7 +232,8 @@ System.String - +

    A string representing the display name or the Unicode representation (e.g. 🤔) of this emote.

    + diff --git a/docs/api/Discord.Game.html b/docs/api/Discord.Game.html index 8d84ffcc9..98dde3dcd 100644 --- a/docs/api/Discord.Game.html +++ b/docs/api/Discord.Game.html @@ -179,7 +179,8 @@

    Details

    -
    +

    Gets the details on what the player is currently doing.

    +
    Declaration
    @@ -196,7 +197,8 @@ System.String - +

    A string describing what the player is doing.

    + @@ -209,7 +211,8 @@

    Flags

    -
    +

    Gets the flags that are relevant to this activity.

    +
    Declaration
    @@ -226,10 +229,14 @@ ActivityProperties - +

    The value of flags for this activity.

    + +
    Remarks
    +

    This value is determined by bitwise OR-ing ActivityProperties values together.

    +
    | Improve this Doc @@ -239,7 +246,8 @@

    Name

    -
    +

    Gets the name of the activity.

    +
    Declaration
    @@ -256,7 +264,8 @@ System.String - +

    A string containing the name of the activity that the user is doing.

    + @@ -269,7 +278,8 @@

    Type

    -
    +

    Gets the type of the activity.

    +
    Declaration
    @@ -286,7 +296,8 @@ ActivityType - +

    The type of activity.

    + diff --git a/docs/api/Discord.IEntity-1.html b/docs/api/Discord.IEntity-1.html index b81d5f329..68aebf63b 100644 --- a/docs/api/Discord.IEntity-1.html +++ b/docs/api/Discord.IEntity-1.html @@ -80,7 +80,6 @@
    Syntax
    public interface IEntity<TId>
-
     where TId : IEquatable<TId>
    Type Parameters
    diff --git a/docs/api/Discord.Optional.html b/docs/api/Discord.Optional.html index cce2b49d4..0c83b27f4 100644 --- a/docs/api/Discord.Optional.html +++ b/docs/api/Discord.Optional.html @@ -233,7 +233,6 @@
    Declaration
    public static T? ToNullable<T>(this Optional<T> val)
-
     where T : struct
    Parameters
    diff --git a/docs/api/Discord.Rest.BaseDiscordClient.html b/docs/api/Discord.Rest.BaseDiscordClient.html index 916f506a6..e223f7c91 100644 --- a/docs/api/Discord.Rest.BaseDiscordClient.html +++ b/docs/api/Discord.Rest.BaseDiscordClient.html @@ -190,7 +190,8 @@

    TokenType

    -
    +

    Gets the token type of the logged-in user.

    +
    Declaration
    @@ -237,7 +238,8 @@

    GetRecommendedShardCountAsync(RequestOptions)

    -
    +

    Gets the recommended shard count as suggested by Discord.

    +
    Declaration
    @@ -256,7 +258,8 @@ RequestOptions options - +

    The options to be used when sending the request.

    + @@ -271,7 +274,9 @@ System.Threading.Tasks.Task<System.Int32> - +

    A task that represents the asynchronous get operation. The task result contains an System.Int32 +that represents the number of shards that should be used with this account.

    + @@ -462,7 +467,8 @@

    IDiscordClient.ConnectionState

    -
    +

    Gets the current state of connection.

    +
    Declaration
    @@ -492,7 +498,8 @@

    IDiscordClient.CreateGuildAsync(String, IVoiceRegion, Stream, RequestOptions)

    -
    +

    Creates a guild for the logged-in user who is in less than 10 active guilds.

    +
    Declaration
    @@ -511,22 +518,26 @@ System.String name - +

    The name of the new guild.

    + IVoiceRegion region - +

    The voice region to create the guild with.

    + System.IO.Stream jpegIcon - +

    The icon of the guild.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -541,10 +552,17 @@ System.Threading.Tasks.Task<IGuild> - +

    A task that represents the asynchronous creation operation. The task result contains the created guild.

    + +
    Remarks
    +

    This method creates a new guild on behalf of the logged-in user.

    +
    warning

    + Due to Discord's limitation, this method will only work for users that are in less than 10 guilds. +

    +
    Exceptions
    @@ -570,7 +588,8 @@

    IDiscordClient.CurrentUser

    -
    +

    Gets the currently logged-in user.

    +
    Declaration
    @@ -600,7 +619,8 @@

    IDiscordClient.GetApplicationInfoAsync(RequestOptions)

    -
    +

    Gets a Discord application information for the logged-in user.

    +
    Declaration
    @@ -619,7 +639,8 @@
    - +
    RequestOptions options

    The options to be used when sending the request.

    +
    @@ -634,10 +655,16 @@ System.Threading.Tasks.Task<IApplication> - +

    A task that represents the asynchronous get operation. The task result contains the application +information.

    + +
    Remarks
    +

    This method reflects your application information you submitted when creating a Discord application via +the Developer Portal.

    +
    | Improve this Doc @@ -647,7 +674,8 @@

    IDiscordClient.GetChannelAsync(UInt64, CacheMode, RequestOptions)

    -
    +

    Gets a generic channel.

    +
    Declaration
    @@ -666,17 +694,20 @@ System.UInt64 id - +

    The snowflake identifier of the channel (e.g. 381889909113225237).

    + CacheMode mode - +

    The CacheMode that determines whether the object should be fetched from cache.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -691,7 +722,9 @@ System.Threading.Tasks.Task<IChannel> - +

    A task that represents the asynchronous get operation. The task result contains the channel associated +with the snowflake identifier; null when the channel cannot be found.

    + @@ -704,7 +737,8 @@

    IDiscordClient.GetConnectionsAsync(RequestOptions)

    -
    +

    Gets the connections that the user has set up.

    +
    Declaration
    @@ -723,7 +757,8 @@ RequestOptions options - +

    The options to be used when sending the request.

    + @@ -738,7 +773,8 @@ System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyCollection<IConnection>> - +

    A task that represents the asynchronous get operation. The task result contains a read-only collection of connections.

    + @@ -751,7 +787,8 @@

    IDiscordClient.GetDMChannelsAsync(CacheMode, RequestOptions)

    -
    +

    Gets a collection of direct message channels opened in this session.

    +
    Declaration
    @@ -770,12 +807,14 @@ CacheMode mode - +

    The CacheMode that determines whether the object should be fetched from cache.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -790,10 +829,19 @@ System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyCollection<IDMChannel>> - +

    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.

    + +
    Remarks
    +

    This method returns a collection of currently opened direct message channels.

    +
    warning

    + 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. +

    +
    | Improve this Doc @@ -803,7 +851,8 @@

    IDiscordClient.GetGroupChannelsAsync(CacheMode, RequestOptions)

    -
    +

    Gets a collection of group channels opened in this session.

    +
    Declaration
    @@ -822,12 +871,14 @@ CacheMode mode - +

    The CacheMode that determines whether the object should be fetched from cache.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -842,10 +893,19 @@ System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyCollection<IGroupChannel>> - +

    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.

    + +
    Remarks
    +

    This method returns a collection of currently opened group channels.

    +
    warning

    + 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. +

    +
    | Improve this Doc @@ -855,7 +915,8 @@

    IDiscordClient.GetGuildAsync(UInt64, CacheMode, RequestOptions)

    -
    +

    Gets a guild.

    +
    Declaration
    @@ -874,17 +935,20 @@ System.UInt64 id - +

    The guild snowflake identifier.

    + CacheMode mode - +

    The CacheMode that determines whether the object should be fetched from cache.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -899,7 +963,9 @@ System.Threading.Tasks.Task<IGuild> - +

    A task that represents the asynchronous get operation. The task result contains the guild associated +with the snowflake identifier; null when the guild cannot be found.

    + @@ -912,7 +978,8 @@

    IDiscordClient.GetGuildsAsync(CacheMode, RequestOptions)

    -
    +

    Gets a collection of guilds that the user is currently in.

    +
    Declaration
    @@ -931,12 +998,14 @@ CacheMode mode - +

    The CacheMode that determines whether the object should be fetched from cache.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -951,7 +1020,9 @@ System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyCollection<IGuild>> - +

    A task that represents the asynchronous get operation. The task result contains a read-only collection +of guilds that the current user is in.

    + @@ -964,7 +1035,8 @@

    IDiscordClient.GetInviteAsync(String, RequestOptions)

    -
    +

    Gets an invite.

    +
    Declaration
    @@ -983,12 +1055,14 @@ System.String inviteId - +

    The invitation identifier.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -1003,7 +1077,8 @@ System.Threading.Tasks.Task<IInvite> - +

    A task that represents the asynchronous get operation. The task result contains the invite information.

    + @@ -1016,7 +1091,8 @@

    IDiscordClient.GetPrivateChannelsAsync(CacheMode, RequestOptions)

    -
    +

    Gets a collection of private channels opened in this session.

    +
    Declaration
    @@ -1035,12 +1111,14 @@ CacheMode mode - +

    The CacheMode that determines whether the object should be fetched from cache.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -1055,10 +1133,20 @@ System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyCollection<IPrivateChannel>> - +

    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.

    + +
    Remarks
    +

    This method will retrieve all private channels (including direct-message, group channel and such) that +are currently opened in this session.

    +
    warning

    + 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. +

    +
    | Improve this Doc @@ -1068,7 +1156,8 @@

    IDiscordClient.GetUserAsync(String, String, RequestOptions)

    -
    +

    Gets a user.

    +
    Declaration
    @@ -1087,17 +1176,20 @@ System.String username - +

    The name of the user (e.g. Still).

    + System.String discriminator - +

    The discriminator value of the user (e.g. 2876).

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -1112,7 +1204,9 @@ System.Threading.Tasks.Task<IUser> - +

    A task that represents the asynchronous get operation. The task result contains the user associated with +the name and the discriminator; null if the user is not found.

    + @@ -1125,7 +1219,8 @@

    IDiscordClient.GetUserAsync(UInt64, CacheMode, RequestOptions)

    -
    +

    Gets a user.

    +
    Declaration
    @@ -1144,17 +1239,20 @@ System.UInt64 id - +

    The snowflake identifier of the user (e.g. 168693960628371456).

    + CacheMode mode - +

    The CacheMode that determines whether the object should be fetched from cache.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -1169,7 +1267,9 @@ System.Threading.Tasks.Task<IUser> - +

    A task that represents the asynchronous get operation. The task result contains the user associated with +the snowflake identifier; null if the user is not found.

    + @@ -1182,7 +1282,8 @@

    IDiscordClient.GetVoiceRegionAsync(String, RequestOptions)

    -
    +

    Gets a voice region.

    +
    Declaration
    @@ -1201,12 +1302,14 @@ System.String id - +

    The identifier of the voice region (e.g. eu-central ).

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -1221,7 +1324,9 @@ System.Threading.Tasks.Task<IVoiceRegion> - +

    A task that represents the asynchronous get operation. The task result contains the voice region +associated with the identifier; null if the voice region is not found.

    + @@ -1234,7 +1339,8 @@

    IDiscordClient.GetVoiceRegionsAsync(RequestOptions)

    -
    +

    Gets a collection of the available voice regions.

    +
    Declaration
    @@ -1253,7 +1359,8 @@ RequestOptions options - +

    The options to be used when sending the request.

    + @@ -1268,7 +1375,9 @@ System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyCollection<IVoiceRegion>> - +

    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.

    + @@ -1281,7 +1390,8 @@

    IDiscordClient.GetWebhookAsync(UInt64, RequestOptions)

    -
    +

    Gets a webhook available.

    +
    Declaration
    @@ -1300,12 +1410,14 @@ System.UInt64 id - +

    The identifier of the webhook.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -1320,7 +1432,9 @@ System.Threading.Tasks.Task<IWebhook> - +

    A task that represents the asynchronous get operation. The task result contains a webhook associated +with the identifier; null if the webhook is not found.

    + @@ -1333,7 +1447,8 @@

    IDiscordClient.StartAsync()

    -
    +

    Starts the connection between Discord and the client..

    +
    Declaration
    @@ -1350,10 +1465,18 @@ System.Threading.Tasks.Task - +

    A task that represents the asynchronous start operation.

    + +
    Remarks
    +

    This method will initialize the connection between the client and Discord.

    +
    important

    + This method will immediately return after it is called, as it will initialize the connection on + another thread. +

    +
    | Improve this Doc @@ -1363,7 +1486,8 @@

    IDiscordClient.StopAsync()

    -
    +

    Stops the connection between Discord and the client.

    +
    Declaration
    @@ -1380,7 +1504,8 @@ System.Threading.Tasks.Task - +

    A task that represents the asynchronous stop operation.

    + diff --git a/docs/api/Discord.Rest.DiscordRestClient.html b/docs/api/Discord.Rest.DiscordRestClient.html index e8255ae03..f0c309342 100644 --- a/docs/api/Discord.Rest.DiscordRestClient.html +++ b/docs/api/Discord.Rest.DiscordRestClient.html @@ -1173,7 +1173,8 @@

    IDiscordClient.CreateGuildAsync(String, IVoiceRegion, Stream, RequestOptions)

    -
    +

    Creates a guild for the logged-in user who is in less than 10 active guilds.

    +
    Declaration
    @@ -1192,22 +1193,26 @@ System.String name - +

    The name of the new guild.

    + IVoiceRegion region - +

    The voice region to create the guild with.

    + System.IO.Stream jpegIcon - +

    The icon of the guild.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -1222,10 +1227,17 @@ System.Threading.Tasks.Task<IGuild> - +

    A task that represents the asynchronous creation operation. The task result contains the created guild.

    + +
    Remarks
    +

    This method creates a new guild on behalf of the logged-in user.

    +
    warning

    + Due to Discord's limitation, this method will only work for users that are in less than 10 guilds. +

    +
    | Improve this Doc @@ -1235,7 +1247,8 @@

    IDiscordClient.GetApplicationInfoAsync(RequestOptions)

    -
    +

    Gets a Discord application information for the logged-in user.

    +
    Declaration
    @@ -1254,7 +1267,8 @@ RequestOptions options - +

    The options to be used when sending the request.

    + @@ -1269,10 +1283,16 @@ System.Threading.Tasks.Task<IApplication> - +

    A task that represents the asynchronous get operation. The task result contains the application +information.

    + +
    Remarks
    +

    This method reflects your application information you submitted when creating a Discord application via +the Developer Portal.

    +
    | Improve this Doc @@ -1282,7 +1302,8 @@

    IDiscordClient.GetChannelAsync(UInt64, CacheMode, RequestOptions)

    -
    +

    Gets a generic channel.

    +
    Declaration
    @@ -1301,17 +1322,20 @@ System.UInt64 id - +

    The snowflake identifier of the channel (e.g. 381889909113225237).

    + CacheMode mode - +

    The CacheMode that determines whether the object should be fetched from cache.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -1326,7 +1350,9 @@ System.Threading.Tasks.Task<IChannel> - +

    A task that represents the asynchronous get operation. The task result contains the channel associated +with the snowflake identifier; null when the channel cannot be found.

    + @@ -1339,7 +1365,8 @@

    IDiscordClient.GetConnectionsAsync(RequestOptions)

    -
    +

    Gets the connections that the user has set up.

    +
    Declaration
    @@ -1358,7 +1385,8 @@ RequestOptions options - +

    The options to be used when sending the request.

    + @@ -1373,7 +1401,8 @@ System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyCollection<IConnection>> - +

    A task that represents the asynchronous get operation. The task result contains a read-only collection of connections.

    + @@ -1386,7 +1415,8 @@

    IDiscordClient.GetDMChannelsAsync(CacheMode, RequestOptions)

    -
    +

    Gets a collection of direct message channels opened in this session.

    +
    Declaration
    @@ -1405,12 +1435,14 @@ CacheMode mode - +

    The CacheMode that determines whether the object should be fetched from cache.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -1425,10 +1457,19 @@ System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyCollection<IDMChannel>> - +

    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.

    + +
    Remarks
    +

    This method returns a collection of currently opened direct message channels.

    +
    warning

    + 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. +

    +
    | Improve this Doc @@ -1438,7 +1479,8 @@

    IDiscordClient.GetGroupChannelsAsync(CacheMode, RequestOptions)

    -
    +

    Gets a collection of group channels opened in this session.

    +
    Declaration
    @@ -1457,12 +1499,14 @@ CacheMode mode - +

    The CacheMode that determines whether the object should be fetched from cache.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -1477,10 +1521,19 @@ System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyCollection<IGroupChannel>> - +

    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.

    + +
    Remarks
    +

    This method returns a collection of currently opened group channels.

    +
    warning

    + 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. +

    +
    | Improve this Doc @@ -1490,7 +1543,8 @@

    IDiscordClient.GetGuildAsync(UInt64, CacheMode, RequestOptions)

    -
    +

    Gets a guild.

    +
    Declaration
    @@ -1509,17 +1563,20 @@ System.UInt64 id - +

    The guild snowflake identifier.

    + CacheMode mode - +

    The CacheMode that determines whether the object should be fetched from cache.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -1534,7 +1591,9 @@ System.Threading.Tasks.Task<IGuild> - +

    A task that represents the asynchronous get operation. The task result contains the guild associated +with the snowflake identifier; null when the guild cannot be found.

    + @@ -1547,7 +1606,8 @@

    IDiscordClient.GetGuildsAsync(CacheMode, RequestOptions)

    -
    +

    Gets a collection of guilds that the user is currently in.

    +
    Declaration
    @@ -1566,12 +1626,14 @@ CacheMode mode - +

    The CacheMode that determines whether the object should be fetched from cache.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -1586,7 +1648,9 @@ System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyCollection<IGuild>> - +

    A task that represents the asynchronous get operation. The task result contains a read-only collection +of guilds that the current user is in.

    + @@ -1651,7 +1715,8 @@

    IDiscordClient.GetPrivateChannelsAsync(CacheMode, RequestOptions)

    -
    +

    Gets a collection of private channels opened in this session.

    +
    Declaration
    @@ -1670,12 +1735,14 @@ CacheMode mode - +

    The CacheMode that determines whether the object should be fetched from cache.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -1690,10 +1757,20 @@ System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyCollection<IPrivateChannel>> - +

    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.

    + +
    Remarks
    +

    This method will retrieve all private channels (including direct-message, group channel and such) that +are currently opened in this session.

    +
    warning

    + 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. +

    +
    | Improve this Doc @@ -1703,7 +1780,8 @@

    IDiscordClient.GetUserAsync(UInt64, CacheMode, RequestOptions)

    -
    +

    Gets a user.

    +
    Declaration
    @@ -1722,17 +1800,20 @@ System.UInt64 id - +

    The snowflake identifier of the user (e.g. 168693960628371456).

    + CacheMode mode - +

    The CacheMode that determines whether the object should be fetched from cache.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -1747,7 +1828,9 @@ System.Threading.Tasks.Task<IUser> - +

    A task that represents the asynchronous get operation. The task result contains the user associated with +the snowflake identifier; null if the user is not found.

    + @@ -1760,7 +1843,8 @@

    IDiscordClient.GetVoiceRegionAsync(String, RequestOptions)

    -
    +

    Gets a voice region.

    +
    Declaration
    @@ -1779,12 +1863,14 @@ System.String id - +

    The identifier of the voice region (e.g. eu-central ).

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -1799,7 +1885,9 @@ System.Threading.Tasks.Task<IVoiceRegion> - +

    A task that represents the asynchronous get operation. The task result contains the voice region +associated with the identifier; null if the voice region is not found.

    + @@ -1812,7 +1900,8 @@

    IDiscordClient.GetVoiceRegionsAsync(RequestOptions)

    -
    +

    Gets a collection of the available voice regions.

    +
    Declaration
    @@ -1831,7 +1920,8 @@ RequestOptions options - +

    The options to be used when sending the request.

    + @@ -1846,7 +1936,9 @@ System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyCollection<IVoiceRegion>> - +

    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.

    + @@ -1859,7 +1951,8 @@

    IDiscordClient.GetWebhookAsync(UInt64, RequestOptions)

    -
    +

    Gets a webhook available.

    +
    Declaration
    @@ -1878,12 +1971,14 @@ System.UInt64 id - +

    The identifier of the webhook.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -1898,7 +1993,9 @@ System.Threading.Tasks.Task<IWebhook> - +

    A task that represents the asynchronous get operation. The task result contains a webhook associated +with the identifier; null if the webhook is not found.

    + diff --git a/docs/api/Discord.Rest.RestApplication.html b/docs/api/Discord.Rest.RestApplication.html index a003a6ab0..e8f2dfa4a 100644 --- a/docs/api/Discord.Rest.RestApplication.html +++ b/docs/api/Discord.Rest.RestApplication.html @@ -160,7 +160,8 @@

    CreatedAt

    -
    +

    Gets when the snowflake was created.

    +
    Declaration
    @@ -177,7 +178,8 @@ System.DateTimeOffset - +

    A System.DateTimeOffset representing when the entity was first created.

    + @@ -190,7 +192,8 @@

    Description

    -
    +

    Gets the description of the application.

    +
    Declaration
    @@ -250,7 +253,8 @@

    IconUrl

    -
    +

    Gets the icon URL of the application.

    +
    Declaration
    @@ -280,7 +284,8 @@

    Name

    -
    +

    Gets the name of the application.

    +
    Declaration
    @@ -310,7 +315,8 @@

    Owner

    -
    +

    Gets the partial user object containing info on the owner of the application.

    +
    Declaration
    @@ -340,7 +346,8 @@

    RPCOrigins

    -
    +

    Gets the RPC origins of the application.

    +
    Declaration
    diff --git a/docs/api/Discord.Rest.RestAuditLogEntry.html b/docs/api/Discord.Rest.RestAuditLogEntry.html index d474c8d31..dbd529c3e 100644 --- a/docs/api/Discord.Rest.RestAuditLogEntry.html +++ b/docs/api/Discord.Rest.RestAuditLogEntry.html @@ -132,7 +132,8 @@

    Action

    -
    +

    Gets the action which occurred to create this entry.

    +
    Declaration
    @@ -149,7 +150,8 @@ ActionType - +

    The type of action for this audit log entry.

    + @@ -162,7 +164,8 @@

    CreatedAt

    -
    +

    Gets when the snowflake was created.

    +
    Declaration
    @@ -179,7 +182,8 @@ System.DateTimeOffset - +

    A System.DateTimeOffset representing when the entity was first created.

    + @@ -192,7 +196,8 @@

    Data

    -
    +

    Gets the data for this entry.

    +
    Declaration
    @@ -209,7 +214,8 @@ IAuditLogData - +

    An IAuditLogData for this audit log entry; null if no data is available.

    + @@ -222,7 +228,8 @@

    Reason

    -
    +

    Gets the reason behind the change.

    +
    Declaration
    @@ -239,7 +246,8 @@ System.String - +

    A string containing the reason for the change; null if none is provided.

    + @@ -252,7 +260,8 @@

    User

    -
    +

    Gets the user responsible for causing the changes.

    +
    Declaration
    @@ -269,7 +278,8 @@ IUser - +

    A user object.

    + diff --git a/docs/api/Discord.Rest.RestBan.html b/docs/api/Discord.Rest.RestBan.html index 23792d1d5..f385cfa8d 100644 --- a/docs/api/Discord.Rest.RestBan.html +++ b/docs/api/Discord.Rest.RestBan.html @@ -123,7 +123,8 @@

    Reason

    -
    +

    Gets the reason why the user is banned if specified.

    +
    Declaration
    @@ -140,7 +141,8 @@ System.String - +

    A string containing the reason behind the ban; null if none is specified.

    + @@ -223,7 +225,8 @@

    IBan.User

    -
    +

    Gets the banned user.

    +
    Declaration
    @@ -240,7 +243,8 @@ IUser - +

    A user that was banned.

    + diff --git a/docs/api/Discord.Rest.RestCategoryChannel.html b/docs/api/Discord.Rest.RestCategoryChannel.html index 4cfc5e1a4..058755829 100644 --- a/docs/api/Discord.Rest.RestCategoryChannel.html +++ b/docs/api/Discord.Rest.RestCategoryChannel.html @@ -210,7 +210,8 @@

    IChannel.GetUserAsync(UInt64, CacheMode, RequestOptions)

    -
    +

    Gets a user in this channel.

    +
    Declaration
    @@ -229,17 +230,20 @@ System.UInt64 id - +

    The snowflake identifier of the user (e.g. 168693960628371456).

    + CacheMode mode - +

    The CacheMode that determines whether the object should be fetched from cache.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -254,7 +258,9 @@ System.Threading.Tasks.Task<IUser> - +

    A task that represents the asynchronous get operation. The task result contains a user object that +represents the found user; null if none is found.

    + @@ -283,7 +289,8 @@

    IChannel.GetUsersAsync(CacheMode, RequestOptions)

    -
    +

    Gets a collection of users that are able to view the channel or are currently in this channel.

    +
    Declaration
    @@ -302,12 +309,14 @@ CacheMode mode - +

    The CacheMode that determines whether the object should be fetched from cache.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -322,10 +331,23 @@ System.Collections.Generic.IAsyncEnumerable<System.Collections.Generic.IReadOnlyCollection<IUser>> - +

    Paged collection of users.

    + +
    Remarks
    +
    important

    + The returned collection is an asynchronous enumerable object; one must call +FlattenAsync<T>(IAsyncEnumerable<IEnumerable<T>>) to access the individual messages as a +collection. +

    +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 MaxUsersPerBatch. +In other words, if there are 3000 users, and the MaxUsersPerBatch constant +is 1000, the request will be split into 3 individual requests; thus returning 53individual asynchronous +responses, hence the need of flattening. +
    Exceptions
    diff --git a/docs/api/Discord.Rest.RestChannel.html b/docs/api/Discord.Rest.RestChannel.html index f32b1c574..57d5f9b75 100644 --- a/docs/api/Discord.Rest.RestChannel.html +++ b/docs/api/Discord.Rest.RestChannel.html @@ -136,7 +136,8 @@

    CreatedAt

    -
    +

    Gets when the snowflake was created.

    +
    Declaration
    @@ -153,7 +154,8 @@
    - +
    System.DateTimeOffset

    A System.DateTimeOffset representing when the entity was first created.

    +
    @@ -168,7 +170,8 @@

    UpdateAsync(RequestOptions)

    -
    +

    Updates this object's properties with its current state.

    +
    Declaration
    @@ -217,7 +220,8 @@

    IChannel.GetUserAsync(UInt64, CacheMode, RequestOptions)

    -
    +

    Gets a user in this channel.

    +
    Declaration
    @@ -236,17 +240,20 @@ System.UInt64 id - +

    The snowflake identifier of the user (e.g. 168693960628371456).

    + CacheMode mode - +

    The CacheMode that determines whether the object should be fetched from cache.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -261,7 +268,9 @@ System.Threading.Tasks.Task<IUser> - +

    A task that represents the asynchronous get operation. The task result contains a user object that +represents the found user; null if none is found.

    + @@ -274,7 +283,8 @@

    IChannel.GetUsersAsync(CacheMode, RequestOptions)

    -
    +

    Gets a collection of users that are able to view the channel or are currently in this channel.

    +
    Declaration
    @@ -293,12 +303,14 @@ CacheMode mode - +

    The CacheMode that determines whether the object should be fetched from cache.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -313,10 +325,23 @@ System.Collections.Generic.IAsyncEnumerable<System.Collections.Generic.IReadOnlyCollection<IUser>> - +

    Paged collection of users.

    + +
    Remarks
    +
    important

    + The returned collection is an asynchronous enumerable object; one must call +FlattenAsync<T>(IAsyncEnumerable<IEnumerable<T>>) to access the individual messages as a +collection. +

    +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 MaxUsersPerBatch. +In other words, if there are 3000 users, and the MaxUsersPerBatch constant +is 1000, the request will be split into 3 individual requests; thus returning 53individual asynchronous +responses, hence the need of flattening. +
    | Improve this Doc @@ -326,7 +351,8 @@

    IChannel.Name

    -
    +

    Gets the name of this channel.

    +
    Declaration
    @@ -343,7 +369,8 @@ System.String - +

    A string containing the name of this channel.

    + diff --git a/docs/api/Discord.Rest.RestConnection.html b/docs/api/Discord.Rest.RestConnection.html index a12fecbbb..b31586a07 100644 --- a/docs/api/Discord.Rest.RestConnection.html +++ b/docs/api/Discord.Rest.RestConnection.html @@ -122,7 +122,8 @@

    Id

    -
    +

    Gets the ID of the connection account.

    +
    Declaration
    @@ -139,7 +140,8 @@ System.String - +

    A System.String representing the unique identifier value of this connection.

    + @@ -152,7 +154,8 @@

    IntegrationIds

    -
    +

    Gets a System.Collections.Generic.IReadOnlyCollection<T> of integration IDs.

    +
    Declaration
    @@ -169,7 +172,9 @@ System.Collections.Generic.IReadOnlyCollection<System.UInt64> - +

    An System.Collections.Generic.IReadOnlyCollection<T> containing System.UInt64 +representations of unique identifier values of integrations.

    + @@ -182,7 +187,8 @@

    IsRevoked

    -
    +

    Gets whether the connection is revoked.

    +
    Declaration
    @@ -199,7 +205,8 @@ System.Boolean - +

    A value which if true indicates that this connection has been revoked, otherwise false.

    + @@ -212,7 +219,8 @@

    Name

    -
    +

    Gets the username of the connection account.

    +
    Declaration
    @@ -229,7 +237,8 @@ System.String - +

    A string containing the name of this connection.

    + @@ -242,7 +251,8 @@

    Type

    -
    +

    Gets the service of the connection (twitch, youtube).

    +
    Declaration
    @@ -259,7 +269,8 @@ System.String - +

    A string containing the name of this type of connection.

    + diff --git a/docs/api/Discord.Rest.RestDMChannel.html b/docs/api/Discord.Rest.RestDMChannel.html index 4b1112509..dde9bc7cd 100644 --- a/docs/api/Discord.Rest.RestDMChannel.html +++ b/docs/api/Discord.Rest.RestDMChannel.html @@ -234,7 +234,8 @@

    CloseAsync(RequestOptions)

    -
    +

    Closes this private channel, removing it from your channel list.

    +
    Declaration
    @@ -253,7 +254,8 @@ RequestOptions options - +

    The options to be used when sending the request.

    + @@ -268,7 +270,8 @@ System.Threading.Tasks.Task - +

    A task that represents the asynchronous close operation.

    + @@ -281,7 +284,8 @@

    DeleteMessageAsync(IMessage, RequestOptions)

    -
    +

    Deletes a message based on the provided message in this channel.

    +
    Declaration
    @@ -300,12 +304,14 @@ IMessage message - +

    The message that would be removed.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -320,7 +326,8 @@ System.Threading.Tasks.Task - +

    A task that represents the asynchronous removal operation.

    + @@ -333,7 +340,8 @@

    DeleteMessageAsync(UInt64, RequestOptions)

    -
    +

    Deletes a message.

    +
    Declaration
    @@ -352,12 +360,14 @@ System.UInt64 messageId - +

    The snowflake identifier of the message that would be removed.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -372,7 +382,8 @@ System.Threading.Tasks.Task - +

    A task that represents the asynchronous removal operation.

    + @@ -385,7 +396,9 @@

    EnterTypingState(RequestOptions)

    -
    +

    Continuously broadcasts the "user is typing" message to all users in this channel until the returned +object is disposed.

    +
    Declaration
    @@ -404,7 +417,8 @@ RequestOptions options - +

    The options to be used when sending the request.

    + @@ -419,7 +433,9 @@ System.IDisposable - +

    A disposable object that, upon its disposal, will stop the client from broadcasting its typing state in +this channel.

    + @@ -432,7 +448,8 @@

    GetMessageAsync(UInt64, RequestOptions)

    -
    +

    Gets a message from this message channel.

    +
    Declaration
    @@ -451,12 +468,14 @@ System.UInt64 id - +

    The snowflake identifier of the message.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -471,10 +490,16 @@ System.Threading.Tasks.Task<RestMessage> - +

    A task that represents an asynchronous get operation for retrieving the message. The task result contains +the retrieved message; null if no message is found with the specified identifier.

    + +
    Remarks
    +

    This method follows the same behavior as described in GetMessageAsync(UInt64, CacheMode, RequestOptions). +Please visit its documentation for more details on this method.

    +
    | Improve this Doc @@ -484,7 +509,8 @@

    GetMessagesAsync(IMessage, Direction, Int32, RequestOptions)

    -
    +

    Gets a collection of messages in this channel.

    +
    Declaration
    @@ -503,22 +529,26 @@ IMessage fromMessage - +

    The starting message to get the messages from.

    + Direction dir - +

    The direction of the messages to be gotten from.

    + System.Int32 limit - +

    The numbers of message to be gotten from.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -533,10 +563,15 @@ System.Collections.Generic.IAsyncEnumerable<System.Collections.Generic.IReadOnlyCollection<RestMessage>> - +

    Paged collection of messages.

    + +
    Remarks
    +

    This method follows the same behavior as described in GetMessagesAsync(IMessage, Direction, Int32, CacheMode, RequestOptions). +Please visit its documentation for more details on this method.

    +
    | Improve this Doc @@ -546,7 +581,8 @@

    GetMessagesAsync(Int32, RequestOptions)

    -
    +

    Gets the last N messages from this message channel.

    +
    Declaration
    @@ -565,12 +601,14 @@ System.Int32 limit - +

    The numbers of message to be gotten from.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -585,10 +623,15 @@ System.Collections.Generic.IAsyncEnumerable<System.Collections.Generic.IReadOnlyCollection<RestMessage>> - +

    Paged collection of messages.

    + +
    Remarks
    +

    This method follows the same behavior as described in GetMessagesAsync(Int32, CacheMode, RequestOptions). +Please visit its documentation for more details on this method.

    +
    | Improve this Doc @@ -598,7 +641,8 @@

    GetMessagesAsync(UInt64, Direction, Int32, RequestOptions)

    -
    +

    Gets a collection of messages in this channel.

    +
    Declaration
    @@ -617,22 +661,26 @@ System.UInt64 fromMessageId - +

    The ID of the starting message to get the messages from.

    + Direction dir - +

    The direction of the messages to be gotten from.

    + System.Int32 limit - +

    The numbers of message to be gotten from.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -647,10 +695,15 @@ System.Collections.Generic.IAsyncEnumerable<System.Collections.Generic.IReadOnlyCollection<RestMessage>> - +

    Paged collection of messages.

    + +
    Remarks
    +

    This method follows the same behavior as described in GetMessagesAsync(UInt64, Direction, Int32, CacheMode, RequestOptions). +Please visit its documentation for more details on this method.

    +
    | Improve this Doc @@ -660,7 +713,8 @@

    GetPinnedMessagesAsync(RequestOptions)

    -
    +

    Gets a collection of pinned messages in this channel.

    +
    Declaration
    @@ -679,7 +733,8 @@ RequestOptions options - +

    The options to be used when sending the request.

    + @@ -694,10 +749,16 @@ System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyCollection<RestMessage>> - +

    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.

    + +
    Remarks
    +

    This method follows the same behavior as described in GetPinnedMessagesAsync(RequestOptions). +Please visit its documentation for more details on this method.

    +
    | Improve this Doc @@ -757,7 +818,8 @@

    SendFileAsync(Stream, String, String, Boolean, Embed, RequestOptions, Boolean)

    -
    +

    Sends a file to this message channel with an optional caption.

    +
    Declaration
    @@ -776,32 +838,38 @@ System.IO.Stream stream - +

    The System.IO.Stream of the file to be sent.

    + System.String filename - +

    The name of the attachment.

    + System.String text - +

    The message to be sent.

    + System.Boolean isTTS - +

    Whether the message should be read aloud by Discord or not.

    + Embed embed - +

    The Rich Embed to be sent.

    + RequestOptions options - +

    The options to be used when sending the request.

    + System.Boolean @@ -821,10 +889,16 @@ System.Threading.Tasks.Task<RestUserMessage> - +

    A task that represents an asynchronous send operation for delivering the message. The task result +contains the sent message.

    + +
    Remarks
    +

    This method follows the same behavior as described in SendFileAsync(Stream, String, String, Boolean, Embed, RequestOptions, Boolean). +Please visit its documentation for more details on this method.

    +
    Exceptions
    @@ -850,7 +924,8 @@

    SendFileAsync(String, String, Boolean, Embed, RequestOptions, Boolean)

    -
    +

    Sends a file to this message channel with an optional caption.

    +
    Declaration
    @@ -869,27 +944,32 @@
    - + - + - + - + - + @@ -909,10 +989,17 @@ - +
    System.String filePath

    The file path of the file.

    +
    System.String text

    The message to be sent.

    +
    System.Boolean isTTS

    Whether the message should be read aloud by Discord or not.

    +
    Embed embed

    The Rich Embed to be sent.

    +
    RequestOptions options

    The options to be used when sending the request.

    +
    System.Boolean
    System.Threading.Tasks.Task<RestUserMessage>

    A task that represents an asynchronous send operation for delivering the message. The task result +contains the sent message.

    +
    +
    Remarks
    +

    This method follows the same behavior as described in +SendFileAsync(String, String, Boolean, Embed, RequestOptions, Boolean). Please visit +its documentation for more details on this method.

    +
    Exceptions
    @@ -981,7 +1068,8 @@ characters.

    SendMessageAsync(String, Boolean, Embed, RequestOptions)

    -
    +

    Sends a message to this message channel.

    +
    Declaration
    @@ -1000,22 +1088,26 @@ characters.

    - + - + - + - +
    System.String text

    The message to be sent.

    +
    System.Boolean isTTS

    Determines whether the message should be read aloud by Discord or not.

    +
    Embed embed

    The Rich Embed to be sent.

    +
    RequestOptions options

    The options to be used when sending the request.

    +
    @@ -1030,10 +1122,16 @@ characters.

    System.Threading.Tasks.Task<RestUserMessage> - +

    A task that represents an asynchronous send operation for delivering the message. The task result +contains the sent message.

    + +
    Remarks
    +

    This method follows the same behavior as described in SendMessageAsync(String, Boolean, Embed, RequestOptions). +Please visit its documentation for more details on this method.

    +
    Exceptions
    @@ -1093,7 +1191,8 @@ characters.

    TriggerTypingAsync(RequestOptions)

    -
    +

    Broadcasts the "user is typing" message to all users in this channel, lasting 10 seconds.

    +
    Declaration
    @@ -1112,7 +1211,8 @@ characters.

    - +
    RequestOptions options

    The options to be used when sending the request.

    +
    @@ -1127,7 +1227,8 @@ characters.

    System.Threading.Tasks.Task - +

    A task that represents the asynchronous operation that triggers the broadcast.

    + @@ -1140,7 +1241,8 @@ characters.

    UpdateAsync(RequestOptions)

    -
    +

    Updates this object's properties with its current state.

    +
    Declaration
    @@ -1191,7 +1293,8 @@ characters.

    IChannel.GetUserAsync(UInt64, CacheMode, RequestOptions)

    -
    +

    Gets a user in this channel.

    +
    Declaration
    @@ -1210,17 +1313,20 @@ characters.

    System.UInt64 id - +

    The snowflake identifier of the user (e.g. 168693960628371456).

    + CacheMode mode - +

    The CacheMode that determines whether the object should be fetched from cache.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -1235,7 +1341,9 @@ characters.

    System.Threading.Tasks.Task<IUser> - +

    A task that represents the asynchronous get operation. The task result contains a user object that +represents the found user; null if none is found.

    + @@ -1248,7 +1356,8 @@ characters.

    IChannel.GetUsersAsync(CacheMode, RequestOptions)

    -
    +

    Gets a collection of users that are able to view the channel or are currently in this channel.

    +
    Declaration
    @@ -1267,12 +1376,14 @@ characters.

    CacheMode mode - +

    The CacheMode that determines whether the object should be fetched from cache.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -1287,10 +1398,23 @@ characters.

    System.Collections.Generic.IAsyncEnumerable<System.Collections.Generic.IReadOnlyCollection<IUser>> - +

    Paged collection of users.

    + +
    Remarks
    +
    important

    + The returned collection is an asynchronous enumerable object; one must call +FlattenAsync<T>(IAsyncEnumerable<IEnumerable<T>>) to access the individual messages as a +collection. +

    +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 MaxUsersPerBatch. +In other words, if there are 3000 users, and the MaxUsersPerBatch constant +is 1000, the request will be split into 3 individual requests; thus returning 53individual asynchronous +responses, hence the need of flattening. +
    | Improve this Doc @@ -1300,7 +1424,8 @@ characters.

    IChannel.Name

    -
    +

    Gets the name of this channel.

    +
    Declaration
    @@ -1317,7 +1442,8 @@ characters.

    System.String - +

    A string containing the name of this channel.

    + @@ -1330,7 +1456,8 @@ characters.

    IDMChannel.Recipient

    -
    +

    Gets the recipient of all messages in this channel.

    +
    Declaration
    @@ -1347,7 +1474,8 @@ characters.

    IUser - +

    A user object that represents the other user in this channel.

    + @@ -1360,7 +1488,8 @@ characters.

    IMessageChannel.GetMessageAsync(UInt64, CacheMode, RequestOptions)

    -
    +

    Gets a message from this message channel.

    +
    Declaration
    @@ -1379,17 +1508,20 @@ characters.

    System.UInt64 id - +

    The snowflake identifier of the message.

    + CacheMode mode - +

    The CacheMode that determines whether the object should be fetched from cache.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -1404,7 +1536,9 @@ characters.

    System.Threading.Tasks.Task<IMessage> - +

    A task that represents an asynchronous get operation for retrieving the message. The task result contains +the retrieved message; null if no message is found with the specified identifier.

    + @@ -1417,7 +1551,8 @@ characters.

    IMessageChannel.GetMessagesAsync(IMessage, Direction, Int32, CacheMode, RequestOptions)

    -
    +

    Gets a collection of messages in this channel.

    +
    Declaration
    @@ -1436,27 +1571,33 @@ characters.

    IMessage fromMessage - +

    The starting message to get the messages from.

    + Direction dir - +

    The direction of the messages to be gotten from.

    + System.Int32 limit - +

    The numbers of message to be gotten from.

    + CacheMode mode - +

    The CacheMode that determines whether the object should be fetched from +cache.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -1471,10 +1612,29 @@ characters.

    System.Collections.Generic.IAsyncEnumerable<System.Collections.Generic.IReadOnlyCollection<IMessage>> - +

    Paged collection of messages.

    + +
    Remarks
    +
    important

    + The returned collection is an asynchronous enumerable object; one must call +FlattenAsync<T>(IAsyncEnumerable<IEnumerable<T>>) to access the individual messages as a +collection. +

    +
    warning

    + Do not fetch too many messages at once! This may cause unwanted preemptive rate limit or even actual + rate limit, causing your bot to freeze! +

    +This method will attempt to fetch the number of messages specified under limit around +the message fromMessage depending on the dir. The library will +attempt to split up the requests according to your limit and +MaxMessagesPerBatch. In other words, should the user request 500 messages, +and the MaxMessagesPerBatch constant is 100, the request will +be split into 5 individual requests; thus returning 5 individual asynchronous responses, hence the need +of flattening. +
    | Improve this Doc @@ -1484,7 +1644,8 @@ characters.

    IMessageChannel.GetMessagesAsync(Int32, CacheMode, RequestOptions)

    -
    +

    Gets the last N messages from this message channel.

    +
    Declaration
    @@ -1503,17 +1664,21 @@ characters.

    System.Int32 limit - +

    The numbers of message to be gotten from.

    + CacheMode mode - +

    The CacheMode that determines whether the object should be fetched from +cache.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -1528,10 +1693,28 @@ characters.

    System.Collections.Generic.IAsyncEnumerable<System.Collections.Generic.IReadOnlyCollection<IMessage>> - +

    Paged collection of messages.

    + +
    Remarks
    +
    important

    + The returned collection is an asynchronous enumerable object; one must call +FlattenAsync<T>(IAsyncEnumerable<IEnumerable<T>>) to access the individual messages as a +collection. +

    +
    warning

    + Do not fetch too many messages at once! This may cause unwanted preemptive rate limit or even actual + rate limit, causing your bot to freeze! +

    +This method will attempt to fetch the number of messages specified under limit. The +library will attempt to split up the requests according to your limit and +MaxMessagesPerBatch. In other words, should the user request 500 messages, +and the MaxMessagesPerBatch constant is 100, the request will +be split into 5 individual requests; thus returning 5 individual asynchronous responses, hence the need +of flattening. +
    | Improve this Doc @@ -1541,7 +1724,8 @@ characters.

    IMessageChannel.GetMessagesAsync(UInt64, Direction, Int32, CacheMode, RequestOptions)

    -
    +

    Gets a collection of messages in this channel.

    +
    Declaration
    @@ -1560,27 +1744,33 @@ characters.

    System.UInt64 fromMessageId - +

    The ID of the starting message to get the messages from.

    + Direction dir - +

    The direction of the messages to be gotten from.

    + System.Int32 limit - +

    The numbers of message to be gotten from.

    + CacheMode mode - +

    The CacheMode that determines whether the object should be fetched from +cache.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -1595,10 +1785,29 @@ characters.

    System.Collections.Generic.IAsyncEnumerable<System.Collections.Generic.IReadOnlyCollection<IMessage>> - +

    Paged collection of messages.

    + +
    Remarks
    +
    important

    + The returned collection is an asynchronous enumerable object; one must call +FlattenAsync<T>(IAsyncEnumerable<IEnumerable<T>>) to access the individual messages as a +collection. +

    +
    warning

    + Do not fetch too many messages at once! This may cause unwanted preemptive rate limit or even actual + rate limit, causing your bot to freeze! +

    +This method will attempt to fetch the number of messages specified under limit around +the message fromMessageId depending on the dir. The library will +attempt to split up the requests according to your limit and +MaxMessagesPerBatch. In other words, should the user request 500 messages, +and the MaxMessagesPerBatch constant is 100, the request will +be split into 5 individual requests; thus returning 5 individual asynchronous responses, hence the need +of flattening. +
    | Improve this Doc @@ -1608,7 +1817,8 @@ characters.

    IMessageChannel.GetPinnedMessagesAsync(RequestOptions)

    -
    +

    Gets a collection of pinned messages in this channel.

    +
    Declaration
    @@ -1627,7 +1837,8 @@ characters.

    RequestOptions options - +

    The options to be used when sending the request.

    + @@ -1642,7 +1853,9 @@ characters.

    System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyCollection<IMessage>> - +

    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.

    + @@ -1655,7 +1868,8 @@ characters.

    IMessageChannel.SendFileAsync(Stream, String, String, Boolean, Embed, RequestOptions, Boolean)

    -
    +

    Sends a file to this message channel with an optional caption.

    +
    Declaration
    @@ -1674,37 +1888,44 @@ characters.

    System.IO.Stream stream - +

    The System.IO.Stream of the file to be sent.

    + System.String filename - +

    The name of the attachment.

    + System.String text - +

    The message to be sent.

    + System.Boolean isTTS - +

    Whether the message should be read aloud by Discord or not.

    + Embed embed - +

    The Rich Embed to be sent.

    + RequestOptions options - +

    The options to be used when sending the request.

    + System.Boolean isSpoiler - +

    Whether the message attachment should be hidden as a spoiler.

    + @@ -1719,10 +1940,20 @@ characters.

    System.Threading.Tasks.Task<IUserMessage> - +

    A task that represents an asynchronous send operation for delivering the message. The task result +contains the sent message.

    + +
    Remarks
    +

    This method sends a file as if you are uploading an attachment directly from your Discord client.

    +
    note

    + If you wish to upload an image and have it embedded in a Rich embed, + you may upload the file and refer to the file with "attachment://filename.ext" in the +ImageUrl. See the example section for its usage. +

    +
    | Improve this Doc @@ -1732,7 +1963,8 @@ characters.

    IMessageChannel.SendFileAsync(String, String, Boolean, Embed, RequestOptions, Boolean)

    -
    +

    Sends a file to this message channel with an optional caption.

    +
    Declaration
    @@ -1751,32 +1983,38 @@ characters.

    System.String filePath - +

    The file path of the file.

    + System.String text - +

    The message to be sent.

    + System.Boolean isTTS - +

    Whether the message should be read aloud by Discord or not.

    + Embed embed - +

    The Rich Embed to be sent.

    + RequestOptions options - +

    The options to be used when sending the request.

    + System.Boolean isSpoiler - +

    Whether the message attachment should be hidden as a spoiler.

    + @@ -1791,10 +2029,20 @@ characters.

    System.Threading.Tasks.Task<IUserMessage> - +

    A task that represents an asynchronous send operation for delivering the message. The task result +contains the sent message.

    + +
    Remarks
    +

    This method sends a file as if you are uploading an attachment directly from your Discord client.

    +
    note

    + If you wish to upload an image and have it embedded in a Rich embed, + you may upload the file and refer to the file with "attachment://filename.ext" in the +ImageUrl. See the example section for its usage. +

    +
    | Improve this Doc @@ -1804,7 +2052,8 @@ characters.

    IMessageChannel.SendMessageAsync(String, Boolean, Embed, RequestOptions)

    -
    +

    Sends a message to this message channel.

    +
    Declaration
    @@ -1823,22 +2072,26 @@ characters.

    System.String text - +

    The message to be sent.

    + System.Boolean isTTS - +

    Determines whether the message should be read aloud by Discord or not.

    + Embed embed - +

    The Rich Embed to be sent.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -1853,7 +2106,9 @@ characters.

    System.Threading.Tasks.Task<IUserMessage> - +

    A task that represents an asynchronous send operation for delivering the message. The task result +contains the sent message.

    + @@ -1866,7 +2121,8 @@ characters.

    IPrivateChannel.Recipients

    -
    +

    Gets the users that can access this channel.

    +
    Declaration
    @@ -1883,7 +2139,8 @@ characters.

    System.Collections.Generic.IReadOnlyCollection<IUser> - +

    A read-only collection of users that can access this channel.

    + @@ -1896,7 +2153,8 @@ characters.

    IRestPrivateChannel.Recipients

    -
    +

    Users that can access this channel.

    +
    Declaration
    diff --git a/docs/api/Discord.Rest.RestGroupChannel.html b/docs/api/Discord.Rest.RestGroupChannel.html index 61cbba79c..83d99e7fd 100644 --- a/docs/api/Discord.Rest.RestGroupChannel.html +++ b/docs/api/Discord.Rest.RestGroupChannel.html @@ -144,7 +144,8 @@

    Name

    -
    +

    Gets the name of this channel.

    +
    Declaration
    @@ -161,7 +162,8 @@ System.String - +

    A string containing the name of this channel.

    + @@ -236,7 +238,8 @@

    DeleteMessageAsync(IMessage, RequestOptions)

    -
    +

    Deletes a message based on the provided message in this channel.

    +
    Declaration
    @@ -255,12 +258,14 @@ IMessage message - +

    The message that would be removed.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -275,7 +280,8 @@ System.Threading.Tasks.Task - +

    A task that represents the asynchronous removal operation.

    + @@ -288,7 +294,8 @@

    DeleteMessageAsync(UInt64, RequestOptions)

    -
    +

    Deletes a message.

    +
    Declaration
    @@ -307,12 +314,14 @@ System.UInt64 messageId - +

    The snowflake identifier of the message that would be removed.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -327,7 +336,8 @@ System.Threading.Tasks.Task - +

    A task that represents the asynchronous removal operation.

    + @@ -340,7 +350,9 @@

    EnterTypingState(RequestOptions)

    -
    +

    Continuously broadcasts the "user is typing" message to all users in this channel until the returned +object is disposed.

    +
    Declaration
    @@ -359,7 +371,8 @@ RequestOptions options - +

    The options to be used when sending the request.

    + @@ -374,7 +387,9 @@ System.IDisposable - +

    A disposable object that, upon its disposal, will stop the client from broadcasting its typing state in +this channel.

    + @@ -387,7 +402,8 @@

    GetMessageAsync(UInt64, RequestOptions)

    -
    +

    Gets a message from this message channel.

    +
    Declaration
    @@ -406,12 +422,14 @@ System.UInt64 id - +

    The snowflake identifier of the message.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -426,10 +444,16 @@ System.Threading.Tasks.Task<RestMessage> - +

    A task that represents an asynchronous get operation for retrieving the message. The task result contains +the retrieved message; null if no message is found with the specified identifier.

    + +
    Remarks
    +

    This method follows the same behavior as described in GetMessageAsync(UInt64, CacheMode, RequestOptions). +Please visit its documentation for more details on this method.

    +
    | Improve this Doc @@ -439,7 +463,8 @@

    GetMessagesAsync(IMessage, Direction, Int32, RequestOptions)

    -
    +

    Gets a collection of messages in this channel.

    +
    Declaration
    @@ -458,22 +483,26 @@ IMessage fromMessage - +

    The starting message to get the messages from.

    + Direction dir - +

    The direction of the messages to be gotten from.

    + System.Int32 limit - +

    The numbers of message to be gotten from.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -488,10 +517,15 @@ System.Collections.Generic.IAsyncEnumerable<System.Collections.Generic.IReadOnlyCollection<RestMessage>> - +

    Paged collection of messages.

    + +
    Remarks
    +

    This method follows the same behavior as described in GetMessagesAsync(IMessage, Direction, Int32, CacheMode, RequestOptions). +Please visit its documentation for more details on this method.

    +
    | Improve this Doc @@ -501,7 +535,8 @@

    GetMessagesAsync(Int32, RequestOptions)

    -
    +

    Gets the last N messages from this message channel.

    +
    Declaration
    @@ -520,12 +555,14 @@ System.Int32 limit - +

    The numbers of message to be gotten from.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -540,10 +577,15 @@ System.Collections.Generic.IAsyncEnumerable<System.Collections.Generic.IReadOnlyCollection<RestMessage>> - +

    Paged collection of messages.

    + +
    Remarks
    +

    This method follows the same behavior as described in GetMessagesAsync(Int32, CacheMode, RequestOptions). +Please visit its documentation for more details on this method.

    +
    | Improve this Doc @@ -553,7 +595,8 @@

    GetMessagesAsync(UInt64, Direction, Int32, RequestOptions)

    -
    +

    Gets a collection of messages in this channel.

    +
    Declaration
    @@ -572,22 +615,26 @@ System.UInt64 fromMessageId - +

    The ID of the starting message to get the messages from.

    + Direction dir - +

    The direction of the messages to be gotten from.

    + System.Int32 limit - +

    The numbers of message to be gotten from.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -602,10 +649,15 @@ System.Collections.Generic.IAsyncEnumerable<System.Collections.Generic.IReadOnlyCollection<RestMessage>> - +

    Paged collection of messages.

    + +
    Remarks
    +

    This method follows the same behavior as described in GetMessagesAsync(UInt64, Direction, Int32, CacheMode, RequestOptions). +Please visit its documentation for more details on this method.

    +
    | Improve this Doc @@ -615,7 +667,8 @@

    GetPinnedMessagesAsync(RequestOptions)

    -
    +

    Gets a collection of pinned messages in this channel.

    +
    Declaration
    @@ -634,7 +687,8 @@ RequestOptions options - +

    The options to be used when sending the request.

    + @@ -649,10 +703,16 @@ System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyCollection<RestMessage>> - +

    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.

    + +
    Remarks
    +

    This method follows the same behavior as described in GetPinnedMessagesAsync(RequestOptions). +Please visit its documentation for more details on this method.

    +
    | Improve this Doc @@ -709,7 +769,8 @@

    LeaveAsync(RequestOptions)

    -
    +

    Leaves this group.

    +
    Declaration
    @@ -728,7 +789,8 @@ RequestOptions options - +

    The options to be used when sending the request.

    + @@ -743,7 +805,8 @@ System.Threading.Tasks.Task - +

    A task that represents the asynchronous leave operation.

    + @@ -756,7 +819,8 @@

    SendFileAsync(Stream, String, String, Boolean, Embed, RequestOptions, Boolean)

    -
    +

    Sends a file to this message channel with an optional caption.

    +
    Declaration
    @@ -775,32 +839,38 @@ System.IO.Stream stream - +

    The System.IO.Stream of the file to be sent.

    + System.String filename - +

    The name of the attachment.

    + System.String text - +

    The message to be sent.

    + System.Boolean isTTS - +

    Whether the message should be read aloud by Discord or not.

    + Embed embed - +

    The Rich Embed to be sent.

    + RequestOptions options - +

    The options to be used when sending the request.

    + System.Boolean @@ -820,10 +890,16 @@ System.Threading.Tasks.Task<RestUserMessage> - +

    A task that represents an asynchronous send operation for delivering the message. The task result +contains the sent message.

    + +
    Remarks
    +

    This method follows the same behavior as described in SendFileAsync(Stream, String, String, Boolean, Embed, RequestOptions, Boolean). +Please visit its documentation for more details on this method.

    +
    Exceptions
    @@ -849,7 +925,8 @@

    SendFileAsync(String, String, Boolean, Embed, RequestOptions, Boolean)

    -
    +

    Sends a file to this message channel with an optional caption.

    +
    Declaration
    @@ -868,27 +945,32 @@
    - + - + - + - + - + @@ -908,10 +990,17 @@ - +
    System.String filePath

    The file path of the file.

    +
    System.String text

    The message to be sent.

    +
    System.Boolean isTTS

    Whether the message should be read aloud by Discord or not.

    +
    Embed embed

    The Rich Embed to be sent.

    +
    RequestOptions options

    The options to be used when sending the request.

    +
    System.Boolean
    System.Threading.Tasks.Task<RestUserMessage>

    A task that represents an asynchronous send operation for delivering the message. The task result +contains the sent message.

    +
    +
    Remarks
    +

    This method follows the same behavior as described in +SendFileAsync(String, String, Boolean, Embed, RequestOptions, Boolean). Please visit +its documentation for more details on this method.

    +
    Exceptions
    @@ -980,7 +1069,8 @@ characters.

    SendMessageAsync(String, Boolean, Embed, RequestOptions)

    -
    +

    Sends a message to this message channel.

    +
    Declaration
    @@ -999,22 +1089,26 @@ characters.

    - + - + - + - +
    System.String text

    The message to be sent.

    +
    System.Boolean isTTS

    Determines whether the message should be read aloud by Discord or not.

    +
    Embed embed

    The Rich Embed to be sent.

    +
    RequestOptions options

    The options to be used when sending the request.

    +
    @@ -1029,10 +1123,16 @@ characters.

    System.Threading.Tasks.Task<RestUserMessage> - +

    A task that represents an asynchronous send operation for delivering the message. The task result +contains the sent message.

    + +
    Remarks
    +

    This method follows the same behavior as described in SendMessageAsync(String, Boolean, Embed, RequestOptions). +Please visit its documentation for more details on this method.

    +
    Exceptions
    @@ -1090,7 +1190,8 @@ characters.

    TriggerTypingAsync(RequestOptions)

    -
    +

    Broadcasts the "user is typing" message to all users in this channel, lasting 10 seconds.

    +
    Declaration
    @@ -1109,7 +1210,8 @@ characters.

    - +
    RequestOptions options

    The options to be used when sending the request.

    +
    @@ -1124,7 +1226,8 @@ characters.

    System.Threading.Tasks.Task - +

    A task that represents the asynchronous operation that triggers the broadcast.

    + @@ -1137,7 +1240,8 @@ characters.

    UpdateAsync(RequestOptions)

    -
    +

    Updates this object's properties with its current state.

    +
    Declaration
    @@ -1188,7 +1292,8 @@ characters.

    IAudioChannel.ConnectAsync(Boolean, Boolean, Boolean)

    -
    +

    Connects to this audio channel.

    +
    Declaration
    @@ -1207,17 +1312,20 @@ characters.

    System.Boolean selfDeaf - +

    Determines whether the client should deaf itself upon connection.

    + System.Boolean selfMute - +

    Determines whether the client should mute itself upon connection.

    + System.Boolean external - +

    Determines whether the audio client is an external one or not.

    + @@ -1232,7 +1340,9 @@ characters.

    System.Threading.Tasks.Task<IAudioClient> - +

    A task representing the asynchronous connection operation. The task result contains the +IAudioClient responsible for the connection.

    + diff --git a/docs/api/Discord.Rest.RestGroupUser.html b/docs/api/Discord.Rest.RestGroupUser.html index 59b21a333..8f38a4938 100644 --- a/docs/api/Discord.Rest.RestGroupUser.html +++ b/docs/api/Discord.Rest.RestGroupUser.html @@ -186,7 +186,8 @@

    IVoiceState.IsDeafened

    -
    +

    Gets a value that indicates whether this user is deafened by the guild.

    +
    Declaration
    @@ -203,7 +204,9 @@ System.Boolean - +

    true if the user is deafened (i.e. not permitted to listen to or speak to others) by the guild; +otherwise false.

    + @@ -216,7 +219,9 @@

    IVoiceState.IsMuted

    -
    +

    Gets a value that indicates whether this user is muted (i.e. not permitted to speak via voice) by the +guild.

    +
    Declaration
    @@ -233,7 +238,8 @@ System.Boolean - +

    true if this user is muted by the guild; otherwise false.

    + @@ -246,7 +252,8 @@

    IVoiceState.IsSelfDeafened

    -
    +

    Gets a value that indicates whether this user has marked themselves as deafened.

    +
    Declaration
    @@ -263,7 +270,8 @@ System.Boolean - +

    true if this user has deafened themselves (i.e. not permitted to listen to or speak to others); otherwise false.

    + @@ -276,7 +284,9 @@

    IVoiceState.IsSelfMuted

    -
    +

    Gets a value that indicates whether this user has marked themselves as muted (i.e. not permitted to +speak via voice).

    +
    Declaration
    @@ -293,7 +303,8 @@ System.Boolean - +

    true if this user has muted themselves; otherwise false.

    + @@ -306,7 +317,8 @@

    IVoiceState.IsStreaming

    -
    +

    Gets a value that indicates if this user is streaming in a voice channel.

    +
    Declaration
    @@ -323,7 +335,8 @@ System.Boolean - +

    true if the user is streaming; otherwise false.

    + @@ -336,7 +349,8 @@

    IVoiceState.IsSuppressed

    -
    +

    Gets a value that indicates whether the user is muted by the current user.

    +
    Declaration
    @@ -353,7 +367,8 @@ System.Boolean - +

    true if the guild is temporarily blocking audio to/from this user; otherwise false.

    + @@ -366,7 +381,8 @@

    IVoiceState.VoiceChannel

    -
    +

    Gets the voice channel this user is currently in.

    +
    Declaration
    @@ -383,7 +399,9 @@ IVoiceChannel - +

    A generic voice channel object representing the voice channel that the user is currently in; null +if none.

    + @@ -396,7 +414,8 @@

    IVoiceState.VoiceSessionId

    -
    +

    Gets the unique identifier for this user's voice session.

    +
    Declaration
    diff --git a/docs/api/Discord.Rest.RestGuild.html b/docs/api/Discord.Rest.RestGuild.html index 804e60d4a..b30bbf271 100644 --- a/docs/api/Discord.Rest.RestGuild.html +++ b/docs/api/Discord.Rest.RestGuild.html @@ -131,7 +131,8 @@

    AFKChannelId

    -
    +

    Gets the ID of the AFK voice channel for this guild.

    +
    Declaration
    @@ -148,7 +149,9 @@ System.Nullable<System.UInt64> - +

    A System.UInt64 representing the snowflake identifier of the AFK voice channel; null if +none is set.

    + @@ -161,7 +164,9 @@

    AFKTimeout

    -
    +

    Gets the amount of time (in seconds) a user must be inactive in a voice channel for until they are +automatically moved to the AFK voice channel.

    +
    Declaration
    @@ -178,7 +183,9 @@ System.Int32 - +

    An System.Int32 representing the amount of time in seconds for a user to be marked as inactive +and moved into the AFK voice channel.

    + @@ -191,7 +198,8 @@

    ApplicationId

    -
    +

    Gets the application ID of the guild creator if it is bot-created.

    +
    Declaration
    @@ -208,7 +216,8 @@ System.Nullable<System.UInt64> - +

    A System.UInt64 representing the snowflake identifier of the application ID that created this guild, or null if it was not bot-created.

    + @@ -221,7 +230,8 @@

    BannerId

    -
    +

    Gets the identifier for this guilds banner image.

    +
    Declaration
    @@ -238,7 +248,8 @@ System.String - +

    An identifier for the banner image; null if none is set.

    + @@ -251,7 +262,8 @@

    BannerUrl

    -
    +

    Gets the URL of this guild's banner image.

    +
    Declaration
    @@ -268,7 +280,8 @@ System.String - +

    A URL pointing to the guild's banner image; null if none is set.

    + @@ -281,7 +294,8 @@

    CreatedAt

    -
    +

    Gets when the snowflake was created.

    +
    Declaration
    @@ -298,7 +312,8 @@ System.DateTimeOffset - +

    A System.DateTimeOffset representing when the entity was first created.

    + @@ -342,7 +357,8 @@ public ulong DefaultChannelId { get; }

    DefaultMessageNotifications

    -
    +

    Gets the default message notifications for users who haven't explicitly set their notification settings.

    +
    Declaration
    @@ -372,7 +388,8 @@ public ulong DefaultChannelId { get; }

    Description

    -
    +

    Gets the description for the guild.

    +
    Declaration
    @@ -389,7 +406,8 @@ public ulong DefaultChannelId { get; } System.String - +

    The description for the guild; null if none is set.

    + @@ -402,7 +420,8 @@ public ulong DefaultChannelId { get; }

    EmbedChannelId

    -
    +

    Gets the ID of the widget embed channel of this guild.

    +
    Declaration
    @@ -419,7 +438,9 @@ public ulong DefaultChannelId { get; } System.Nullable<System.UInt64> - +

    A System.UInt64 representing the snowflake identifier of the embedded channel found within the +widget settings of this guild; null if none is set.

    + @@ -432,7 +453,8 @@ public ulong DefaultChannelId { get; }

    Emotes

    -
    +

    Gets a collection of all custom emotes for this guild.

    +
    Declaration
    @@ -449,7 +471,8 @@ public ulong DefaultChannelId { get; } System.Collections.Generic.IReadOnlyCollection<GuildEmote> - +

    A read-only collection of all custom emotes for this guild.

    + @@ -493,7 +516,8 @@ public ulong DefaultChannelId { get; }

    ExplicitContentFilter

    -
    +

    Gets the level of content filtering applied to user's content in a Guild.

    +
    Declaration
    @@ -510,7 +534,8 @@ public ulong DefaultChannelId { get; } ExplicitContentFilterLevel - +

    The level of explicit content filtering.

    + @@ -523,7 +548,8 @@ public ulong DefaultChannelId { get; }

    Features

    -
    +

    Gets a collection of all extra features added to this guild.

    +
    Declaration
    @@ -540,7 +566,8 @@ public ulong DefaultChannelId { get; } System.Collections.Generic.IReadOnlyCollection<System.String> - +

    A read-only collection of enabled features in this guild.

    + @@ -553,7 +580,8 @@ public ulong DefaultChannelId { get; }

    IconId

    -
    +

    Gets the ID of this guild's icon.

    +
    Declaration
    @@ -570,7 +598,8 @@ public ulong DefaultChannelId { get; } System.String - +

    An identifier for the splash image; null if none is set.

    + @@ -583,7 +612,8 @@ public ulong DefaultChannelId { get; }

    IconUrl

    -
    +

    Gets the URL of this guild's icon.

    +
    Declaration
    @@ -600,7 +630,8 @@ public ulong DefaultChannelId { get; } System.String - +

    A URL pointing to the guild's icon; null if none is set.

    + @@ -613,7 +644,8 @@ public ulong DefaultChannelId { get; }

    IsEmbeddable

    -
    +

    Gets a value that indicates whether this guild is embeddable (i.e. can use widget).

    +
    Declaration
    @@ -630,7 +662,8 @@ public ulong DefaultChannelId { get; } System.Boolean - +

    true if this guild can be embedded via widgets; otherwise false.

    + @@ -643,7 +676,9 @@ public ulong DefaultChannelId { get; }

    MfaLevel

    -
    +

    Gets the level of Multi-Factor Authentication requirements a user must fulfill before being allowed to +perform administrative actions in this guild.

    +
    Declaration
    @@ -660,7 +695,8 @@ public ulong DefaultChannelId { get; } MfaLevel - +

    The level of MFA requirement.

    + @@ -673,7 +709,8 @@ public ulong DefaultChannelId { get; }

    Name

    -
    +

    Gets the name of this guild.

    +
    Declaration
    @@ -690,7 +727,8 @@ public ulong DefaultChannelId { get; } System.String - +

    A string containing the name of this guild.

    + @@ -703,7 +741,8 @@ public ulong DefaultChannelId { get; }

    OwnerId

    -
    +

    Gets the ID of the user that owns this guild.

    +
    Declaration
    @@ -720,7 +759,8 @@ public ulong DefaultChannelId { get; } System.UInt64 - +

    A System.UInt64 representing the snowflake identifier of the user that owns this guild.

    + @@ -733,7 +773,8 @@ public ulong DefaultChannelId { get; }

    PreferredCulture

    -
    +

    Gets the preferred culture of this guild.

    +
    Declaration
    @@ -750,7 +791,8 @@ public ulong DefaultChannelId { get; } System.Globalization.CultureInfo - +

    The preferred culture information of this guild.

    + @@ -763,7 +805,9 @@ public ulong DefaultChannelId { get; }

    PreferredLocale

    -
    +

    Gets the preferred locale of this guild in IETF BCP 47 +language tag format.

    +
    Declaration
    @@ -780,7 +824,9 @@ public ulong DefaultChannelId { get; } System.String - +

    The preferred locale of the guild in IETF BCP 47 +language tag format.

    + @@ -793,7 +839,8 @@ public ulong DefaultChannelId { get; }

    PremiumSubscriptionCount

    -
    +

    Gets the number of premium subscribers of this guild.

    +
    Declaration
    @@ -810,10 +857,14 @@ public ulong DefaultChannelId { get; } System.Int32 - +

    The number of premium subscribers of this guild.

    + +
    Remarks
    +

    This is the number of users who have boosted this guild.

    +
    | Improve this Doc @@ -823,7 +874,8 @@ public ulong DefaultChannelId { get; }

    PremiumTier

    -
    +

    Gets the tier of guild boosting in this guild.

    +
    Declaration
    @@ -840,7 +892,8 @@ public ulong DefaultChannelId { get; } PremiumTier - +

    The tier of guild boosting in this guild.

    + @@ -884,7 +937,8 @@ public ulong DefaultChannelId { get; }

    SplashId

    -
    +

    Gets the ID of this guild's splash image.

    +
    Declaration
    @@ -901,7 +955,8 @@ public ulong DefaultChannelId { get; } System.String - +

    An identifier for the splash image; null if none is set.

    + @@ -914,7 +969,8 @@ public ulong DefaultChannelId { get; }

    SplashUrl

    -
    +

    Gets the URL of this guild's splash image.

    +
    Declaration
    @@ -931,7 +987,8 @@ public ulong DefaultChannelId { get; } System.String - +

    A URL pointing to the guild's splash image; null if none is set.

    + @@ -944,7 +1001,8 @@ public ulong DefaultChannelId { get; }

    SystemChannelFlags

    -
    +

    Gets the flags for the types of system channel messages that are disabled.

    +
    Declaration
    @@ -961,7 +1019,8 @@ public ulong DefaultChannelId { get; } SystemChannelMessageDeny - +

    The flags for the types of system channel messages that are disabled.

    + @@ -974,7 +1033,8 @@ public ulong DefaultChannelId { get; }

    SystemChannelId

    -
    +

    Gets the ID of the channel where randomized welcome messages are sent.

    +
    Declaration
    @@ -991,7 +1051,9 @@ public ulong DefaultChannelId { get; } System.Nullable<System.UInt64> - +

    A System.UInt64 representing the snowflake identifier of the system channel where randomized +welcome messages are sent; null if none is set.

    + @@ -1004,7 +1066,8 @@ public ulong DefaultChannelId { get; }

    VanityURLCode

    -
    +

    Gets the code for this guild's vanity invite URL.

    +
    Declaration
    @@ -1021,7 +1084,8 @@ public ulong DefaultChannelId { get; } System.String - +

    A string containing the vanity invite code for this guild; null if none is set.

    + @@ -1034,7 +1098,8 @@ public ulong DefaultChannelId { get; }

    VerificationLevel

    -
    +

    Gets the level of requirements a user must fulfill before being allowed to post messages in this guild.

    +
    Declaration
    @@ -1051,7 +1116,8 @@ public ulong DefaultChannelId { get; } VerificationLevel - +

    The level of requirements.

    + @@ -1064,7 +1130,8 @@ public ulong DefaultChannelId { get; }

    VoiceRegionId

    -
    +

    Gets the ID of the region hosting this guild's voice channels.

    +
    Declaration
    @@ -1081,7 +1148,8 @@ public ulong DefaultChannelId { get; } System.String - +

    A string containing the identifier for the voice region that this guild uses (e.g. eu-central).

    + @@ -1096,7 +1164,8 @@ public ulong DefaultChannelId { get; }

    AddBanAsync(IUser, Int32, String, RequestOptions)

    -
    +

    Bans the user from this guild and optionally prunes their recent messages.

    +
    Declaration
    @@ -1115,22 +1184,26 @@ public ulong DefaultChannelId { get; } IUser user - +

    The user to ban.

    + System.Int32 pruneDays - +

    The number of days to remove messages from this user for, and this number must be between [0, 7].

    + System.String reason - +

    The reason of the ban to be written in the audit log.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -1145,7 +1218,24 @@ public ulong DefaultChannelId { get; } System.Threading.Tasks.Task - +

    A task that represents the asynchronous add operation for the ban.

    + + + + +
    Exceptions
    + + + + + + + + + + +
    TypeCondition
    System.ArgumentException

    pruneDays is not between 0 to 7.

    +
    @@ -1158,7 +1248,8 @@ public ulong DefaultChannelId { get; }

    AddBanAsync(UInt64, Int32, String, RequestOptions)

    -
    +

    Bans the user from this guild and optionally prunes their recent messages.

    +
    Declaration
    @@ -1177,22 +1268,26 @@ public ulong DefaultChannelId { get; } System.UInt64 userId - +

    The snowflake ID of the user to ban.

    + System.Int32 pruneDays - +

    The number of days to remove messages from this user for, and this number must be between [0, 7].

    + System.String reason - +

    The reason of the ban to be written in the audit log.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -1207,7 +1302,24 @@ public ulong DefaultChannelId { get; } System.Threading.Tasks.Task - +

    A task that represents the asynchronous add operation for the ban.

    + + + + +
    Exceptions
    + + + + + + + + + + +
    TypeCondition
    System.ArgumentException

    pruneDays is not between 0 to 7.

    +
    @@ -1360,7 +1472,8 @@ public ulong DefaultChannelId { get; }

    CreateEmoteAsync(String, Image, Optional<IEnumerable<IRole>>, RequestOptions)

    -
    +

    Creates a new GuildEmote in this guild.

    +
    Declaration
    @@ -1379,22 +1492,26 @@ public ulong DefaultChannelId { get; } System.String name - +

    The name of the guild emote.

    + Image image - +

    The image of the new emote.

    + Optional<System.Collections.Generic.IEnumerable<IRole>> roles - +

    The roles to limit the emote usage to.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -1409,7 +1526,8 @@ public ulong DefaultChannelId { get; } System.Threading.Tasks.Task<GuildEmote> - +

    A task that represents the asynchronous creation operation. The task result contains the created emote.

    + @@ -1779,7 +1897,8 @@ await Context.Guild.CreateTextChannelAsync(name, x =>

    DeleteAsync(RequestOptions)

    -
    +

    Deletes this object and all its children.

    +
    Declaration
    @@ -1798,7 +1917,8 @@ await Context.Guild.CreateTextChannelAsync(name, x => RequestOptions options - +

    The options to be used when sending the request.

    + @@ -1826,7 +1946,8 @@ await Context.Guild.CreateTextChannelAsync(name, x =>

    DeleteEmoteAsync(GuildEmote, RequestOptions)

    -
    +

    Deletes an existing GuildEmote from this guild.

    +
    Declaration
    @@ -1845,12 +1966,14 @@ await Context.Guild.CreateTextChannelAsync(name, x => GuildEmote emote - +

    The emote to delete.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -1865,7 +1988,8 @@ await Context.Guild.CreateTextChannelAsync(name, x => System.Threading.Tasks.Task - +

    A task that represents the asynchronous removal operation.

    + @@ -2482,7 +2606,8 @@ within the server's widget settings; null if none is set.

    GetEmoteAsync(UInt64, RequestOptions)

    -
    +

    Gets a specific emote from this guild.

    +
    Declaration
    @@ -2501,12 +2626,14 @@ within the server's widget settings; null if none is set.

    System.UInt64 id - +

    The snowflake identifier for the guild emote.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -2521,7 +2648,9 @@ within the server's widget settings; null if none is set.

    System.Threading.Tasks.Task<GuildEmote> - +

    A task that represents the asynchronous get operation. The task result contains the emote found with the +specified id; null if none is found.

    + @@ -3322,7 +3451,8 @@ of webhooks found within the guild.

    LeaveAsync(RequestOptions)

    -
    +

    Leaves this guild.

    +
    Declaration
    @@ -3341,7 +3471,8 @@ of webhooks found within the guild.

    RequestOptions options - +

    The options to be used when sending the request.

    + @@ -3356,10 +3487,17 @@ of webhooks found within the guild.

    System.Threading.Tasks.Task - +

    A task that represents the asynchronous leave operation.

    + +
    Remarks
    +

    This method will make the currently logged-in user leave the guild.

    +
    note

    + If the user is the owner of this guild, use DeleteAsync(RequestOptions) instead. +

    +
    | Improve this Doc @@ -3369,7 +3507,8 @@ of webhooks found within the guild.

    ModifyAsync(Action<GuildProperties>, RequestOptions)

    -
    +

    Modifies this guild.

    +
    Declaration
    @@ -3388,12 +3527,14 @@ of webhooks found within the guild.

    System.Action<GuildProperties> func - +

    The delegate containing the properties to modify the guild with.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -3408,7 +3549,8 @@ of webhooks found within the guild.

    System.Threading.Tasks.Task - +

    A task that represents the asynchronous modification operation.

    + @@ -3437,7 +3579,8 @@ of webhooks found within the guild.

    ModifyEmbedAsync(Action<GuildEmbedProperties>, RequestOptions)

    -
    +

    Modifies this guild's embed channel.

    +
    Declaration
    @@ -3456,12 +3599,14 @@ of webhooks found within the guild.

    System.Action<GuildEmbedProperties> func - +

    The delegate containing the properties to modify the guild widget with.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -3476,7 +3621,8 @@ of webhooks found within the guild.

    System.Threading.Tasks.Task - +

    A task that represents the asynchronous modification operation.

    + @@ -3505,7 +3651,8 @@ of webhooks found within the guild.

    ModifyEmoteAsync(GuildEmote, Action<EmoteProperties>, RequestOptions)

    -
    +

    Modifies an existing GuildEmote in this guild.

    +
    Declaration
    @@ -3524,17 +3671,20 @@ of webhooks found within the guild.

    GuildEmote emote - +

    The emote to be modified.

    + System.Action<EmoteProperties> func - +

    The delegate containing the properties to modify the emote with.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -3549,7 +3699,9 @@ of webhooks found within the guild.

    System.Threading.Tasks.Task<GuildEmote> - +

    A task that represents the asynchronous modification operation. The task result contains the modified +emote.

    + @@ -3650,7 +3802,8 @@ be or has been removed from this guild.

    RemoveBanAsync(IUser, RequestOptions)

    -
    +

    Unbans the user if they are currently banned.

    +
    Declaration
    @@ -3669,12 +3822,14 @@ be or has been removed from this guild.

    IUser user - +

    The user to be unbanned.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -3689,7 +3844,8 @@ be or has been removed from this guild.

    System.Threading.Tasks.Task - +

    A task that represents the asynchronous removal operation for the ban.

    + @@ -3702,7 +3858,8 @@ be or has been removed from this guild.

    RemoveBanAsync(UInt64, RequestOptions)

    -
    +

    Unbans the user if they are currently banned.

    +
    Declaration
    @@ -3721,12 +3878,14 @@ be or has been removed from this guild.

    System.UInt64 userId - +

    The snowflake identifier of the user to be unbanned.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -3741,7 +3900,8 @@ be or has been removed from this guild.

    System.Threading.Tasks.Task - +

    A task that represents the asynchronous removal operation for the ban.

    + @@ -3754,7 +3914,8 @@ be or has been removed from this guild.

    ReorderChannelsAsync(IEnumerable<ReorderChannelProperties>, RequestOptions)

    -
    +

    Bulk-modifies the order of channels in this guild.

    +
    Declaration
    @@ -3773,12 +3934,14 @@ be or has been removed from this guild.

    System.Collections.Generic.IEnumerable<ReorderChannelProperties> args - +

    The properties used to modify the channel positions with.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -3793,7 +3956,8 @@ be or has been removed from this guild.

    System.Threading.Tasks.Task - +

    A task that represents the asynchronous reorder operation.

    + @@ -3822,7 +3986,8 @@ be or has been removed from this guild.

    ReorderRolesAsync(IEnumerable<ReorderRoleProperties>, RequestOptions)

    -
    +

    Bulk-modifies the order of roles in this guild.

    +
    Declaration
    @@ -3841,12 +4006,14 @@ be or has been removed from this guild.

    System.Collections.Generic.IEnumerable<ReorderRoleProperties> args - +

    The properties used to modify the role positions with.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -3861,7 +4028,8 @@ be or has been removed from this guild.

    System.Threading.Tasks.Task - +

    A task that represents the asynchronous reorder operation.

    + @@ -3908,7 +4076,8 @@ be or has been removed from this guild.

    UpdateAsync(RequestOptions)

    -
    +

    Updates this object's properties with its current state.

    +
    Declaration
    @@ -3957,7 +4126,8 @@ be or has been removed from this guild.

    IGuild.AddGuildUserAsync(UInt64, String, Action<AddGuildUserProperties>, RequestOptions)

    -
    +

    Adds a user to this guild.

    +
    Declaration
    @@ -3976,22 +4146,26 @@ be or has been removed from this guild.

    System.UInt64 userId - +

    The snowflake identifier of the user.

    + System.String accessToken - +

    The OAuth2 access token for the user, requested with the guilds.join scope.

    + System.Action<AddGuildUserProperties> func - +

    The delegate containing the properties to be applied to the user upon being added to the guild.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -4006,10 +4180,14 @@ be or has been removed from this guild.

    System.Threading.Tasks.Task<IGuildUser> - +

    A guild user associated with the specified userId; null if the user is already in the guild.

    + +
    Remarks
    +

    This method requires you have an OAuth2 access token for the user, requested with the guilds.join scope, and that the bot have the MANAGE_INVITES permission in the guild.

    +
    | Improve this Doc @@ -4019,7 +4197,8 @@ be or has been removed from this guild.

    IGuild.AudioClient

    -
    +

    Gets the IAudioClient currently associated with this guild.

    +
    Declaration
    @@ -4036,7 +4215,8 @@ be or has been removed from this guild.

    IAudioClient - +

    An IAudioClient currently associated with this guild.

    + @@ -4049,7 +4229,8 @@ be or has been removed from this guild.

    IGuild.Available

    -
    +

    Determines if this guild is currently connected and ready to be used.

    +
    Declaration
    @@ -4066,10 +4247,17 @@ be or has been removed from this guild.

    System.Boolean - +

    true if this guild is currently connected and ready to be used; otherwise false.

    + +
    Remarks
    +
    note

    + This property only applies to a WebSocket-based client. +

    +This boolean is used to determine if the guild is currently connected to the WebSocket and is ready to be used/accessed. +
    | Improve this Doc @@ -4079,7 +4267,8 @@ be or has been removed from this guild.

    IGuild.CreateCategoryAsync(String, Action<GuildChannelProperties>, RequestOptions)

    -
    +

    Creates a new channel category in this guild.

    +
    Declaration
    @@ -4098,17 +4287,20 @@ be or has been removed from this guild.

    System.String name - +

    The new name for the category.

    + System.Action<GuildChannelProperties> func - +

    The delegate containing the properties to be applied to the channel upon its creation.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -4123,7 +4315,9 @@ be or has been removed from this guild.

    System.Threading.Tasks.Task<ICategoryChannel> - +

    A task that represents the asynchronous creation operation. The task result contains the newly created +category channel.

    + @@ -4193,7 +4387,8 @@ be or has been removed from this guild.

    IGuild.CreateRoleAsync(String, Nullable<GuildPermissions>, Nullable<Color>, Boolean, RequestOptions)

    -
    +

    Creates a new role with the provided name.

    +
    Declaration
    @@ -4212,27 +4407,32 @@ be or has been removed from this guild.

    System.String name - +

    The new name for the role.

    + System.Nullable<GuildPermissions> permissions - +

    The guild permission that the role should possess.

    + System.Nullable<Color> color - +

    The color of the role.

    + System.Boolean isHoisted - +

    Whether the role is separated from others on the sidebar.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -4247,7 +4447,9 @@ be or has been removed from this guild.

    System.Threading.Tasks.Task<IRole> - +

    A task that represents the asynchronous creation operation. The task result contains the newly created +role.

    + @@ -4260,7 +4462,8 @@ be or has been removed from this guild.

    IGuild.CreateRoleAsync(String, Nullable<GuildPermissions>, Nullable<Color>, Boolean, Boolean, RequestOptions)

    -
    +

    Creates a new role with the provided name.

    +
    Declaration
    @@ -4279,32 +4482,38 @@ be or has been removed from this guild.

    System.String name - +

    The new name for the role.

    + System.Nullable<GuildPermissions> permissions - +

    The guild permission that the role should possess.

    + System.Nullable<Color> color - +

    The color of the role.

    + System.Boolean isHoisted - +

    Whether the role is separated from others on the sidebar.

    + System.Boolean isMentionable - +

    Whether the role can be mentioned.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -4319,7 +4528,9 @@ be or has been removed from this guild.

    System.Threading.Tasks.Task<IRole> - +

    A task that represents the asynchronous creation operation. The task result contains the newly created +role.

    + @@ -4332,7 +4543,8 @@ be or has been removed from this guild.

    IGuild.CreateTextChannelAsync(String, Action<TextChannelProperties>, RequestOptions)

    -
    +

    Creates a new text channel in this guild.

    +
    Declaration
    @@ -4351,17 +4563,20 @@ be or has been removed from this guild.

    System.String name - +

    The new name for the text channel.

    + System.Action<TextChannelProperties> func - +

    The delegate containing the properties to be applied to the channel upon its creation.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -4376,7 +4591,9 @@ be or has been removed from this guild.

    System.Threading.Tasks.Task<ITextChannel> - +

    A task that represents the asynchronous creation operation. The task result contains the newly created +text channel.

    + @@ -4389,7 +4606,8 @@ be or has been removed from this guild.

    IGuild.CreateVoiceChannelAsync(String, Action<VoiceChannelProperties>, RequestOptions)

    -
    +

    Creates a new voice channel in this guild.

    +
    Declaration
    @@ -4408,17 +4626,20 @@ be or has been removed from this guild.

    System.String name - +

    The new name for the voice channel.

    + System.Action<VoiceChannelProperties> func - +

    The delegate containing the properties to be applied to the channel upon its creation.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -4433,7 +4654,9 @@ be or has been removed from this guild.

    System.Threading.Tasks.Task<IVoiceChannel> - +

    A task that represents the asynchronous creation operation. The task result contains the newly created +voice channel.

    + @@ -4446,7 +4669,8 @@ be or has been removed from this guild.

    IGuild.DownloadUsersAsync()

    -
    +

    Downloads all users for this guild if the current list is incomplete.

    +
    Declaration
    @@ -4463,7 +4687,8 @@ be or has been removed from this guild.

    System.Threading.Tasks.Task - +

    A task that represents the asynchronous download operation.

    + @@ -4492,7 +4717,8 @@ be or has been removed from this guild.

    IGuild.EveryoneRole

    -
    +

    Gets the built-in role containing all users in this guild.

    +
    Declaration
    @@ -4509,7 +4735,8 @@ be or has been removed from this guild.

    IRole - +

    A role object that represents an @everyone role in this guild.

    + @@ -4522,7 +4749,8 @@ be or has been removed from this guild.

    IGuild.GetAFKChannelAsync(CacheMode, RequestOptions)

    -
    +

    Gets the AFK voice channel in this guild.

    +
    Declaration
    @@ -4541,12 +4769,14 @@ be or has been removed from this guild.

    CacheMode mode - +

    The CacheMode that determines whether the object should be fetched from cache.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -4561,7 +4791,9 @@ be or has been removed from this guild.

    System.Threading.Tasks.Task<IVoiceChannel> - +

    A task that represents the asynchronous get operation. The task result contains the voice channel that the +AFK users will be moved to after they have idled for too long; null if none is set.

    + @@ -4646,7 +4878,8 @@ be or has been removed from this guild.

    IGuild.GetBanAsync(IUser, RequestOptions)

    -
    +

    Gets a ban object for a banned user.

    +
    Declaration
    @@ -4665,12 +4898,14 @@ be or has been removed from this guild.

    IUser user - +

    The banned user.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -4685,7 +4920,9 @@ be or has been removed from this guild.

    System.Threading.Tasks.Task<IBan> - +

    A task that represents the asynchronous get operation. The task result contains a ban object, which +contains the user information and the reason for the ban; null if the ban entry cannot be found.

    + @@ -4698,7 +4935,8 @@ be or has been removed from this guild.

    IGuild.GetBanAsync(UInt64, RequestOptions)

    -
    +

    Gets a ban object for a banned user.

    +
    Declaration
    @@ -4717,12 +4955,14 @@ be or has been removed from this guild.

    System.UInt64 userId - +

    The snowflake identifier for the banned user.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -4737,7 +4977,9 @@ be or has been removed from this guild.

    System.Threading.Tasks.Task<IBan> - +

    A task that represents the asynchronous get operation. The task result contains a ban object, which +contains the user information and the reason for the ban; null if the ban entry cannot be found.

    + @@ -4750,7 +4992,8 @@ be or has been removed from this guild.

    IGuild.GetBansAsync(RequestOptions)

    -
    +

    Gets a collection of all users banned in this guild.

    +
    Declaration
    @@ -4769,7 +5012,8 @@ be or has been removed from this guild.

    RequestOptions options - +

    The options to be used when sending the request.

    + @@ -4784,7 +5028,10 @@ be or has been removed from this guild.

    System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyCollection<IBan>> - +

    A task that represents the asynchronous get operation. The task result contains a read-only collection of +ban objects that this guild currently possesses, with each object containing the user banned and reason +behind the ban.

    + @@ -4797,7 +5044,8 @@ be or has been removed from this guild.

    IGuild.GetCategoriesAsync(CacheMode, RequestOptions)

    -
    +

    Gets a collection of all category channels in this guild.

    +
    Declaration
    @@ -4816,12 +5064,14 @@ be or has been removed from this guild.

    CacheMode mode - +

    The CacheMode that determines whether the object should be fetched from cache.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -4836,7 +5086,9 @@ be or has been removed from this guild.

    System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyCollection<ICategoryChannel>> - +

    A task that represents the asynchronous get operation. The task result contains a read-only collection of +category channels found within this guild.

    + @@ -4849,7 +5101,8 @@ be or has been removed from this guild.

    IGuild.GetChannelAsync(UInt64, CacheMode, RequestOptions)

    -
    +

    Gets a channel in this guild.

    +
    Declaration
    @@ -4868,17 +5121,20 @@ be or has been removed from this guild.

    System.UInt64 id - +

    The snowflake identifier for the channel.

    + CacheMode mode - +

    The CacheMode that determines whether the object should be fetched from cache.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -4893,7 +5149,9 @@ be or has been removed from this guild.

    System.Threading.Tasks.Task<IGuildChannel> - +

    A task that represents the asynchronous get operation. The task result contains the generic channel +associated with the specified id; null if none is found.

    + @@ -4906,7 +5164,8 @@ be or has been removed from this guild.

    IGuild.GetChannelsAsync(CacheMode, RequestOptions)

    -
    +

    Gets a collection of all channels in this guild.

    +
    Declaration
    @@ -4925,12 +5184,14 @@ be or has been removed from this guild.

    CacheMode mode - +

    The CacheMode that determines whether the object should be fetched from cache.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -4945,7 +5206,9 @@ be or has been removed from this guild.

    System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyCollection<IGuildChannel>> - +

    A task that represents the asynchronous get operation. The task result contains a read-only collection of +generic channels found within this guild.

    + @@ -4958,7 +5221,8 @@ be or has been removed from this guild.

    IGuild.GetCurrentUserAsync(CacheMode, RequestOptions)

    -
    +

    Gets the current user for this guild.

    +
    Declaration
    @@ -4977,12 +5241,14 @@ be or has been removed from this guild.

    CacheMode mode - +

    The CacheMode that determines whether the object should be fetched from cache.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -4997,7 +5263,9 @@ be or has been removed from this guild.

    System.Threading.Tasks.Task<IGuildUser> - +

    A task that represents the asynchronous get operation. The task result contains the currently logged-in +user within this guild.

    + @@ -5010,7 +5278,8 @@ be or has been removed from this guild.

    IGuild.GetDefaultChannelAsync(CacheMode, RequestOptions)

    -
    +

    Gets the first viewable text channel in this guild.

    +
    Declaration
    @@ -5029,12 +5298,14 @@ be or has been removed from this guild.

    CacheMode mode - +

    The CacheMode that determines whether the object should be fetched from cache.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -5049,7 +5320,9 @@ be or has been removed from this guild.

    System.Threading.Tasks.Task<ITextChannel> - +

    A task that represents the asynchronous get operation. The task result contains the first viewable text +channel in this guild; null if none is found.

    + @@ -5062,7 +5335,8 @@ be or has been removed from this guild.

    IGuild.GetEmbedChannelAsync(CacheMode, RequestOptions)

    -
    +

    Gets the embed channel (i.e. the channel set in the guild's widget settings) in this guild.

    +
    Declaration
    @@ -5081,12 +5355,14 @@ be or has been removed from this guild.

    CacheMode mode - +

    The CacheMode that determines whether the object should be fetched from cache.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -5101,7 +5377,9 @@ be or has been removed from this guild.

    System.Threading.Tasks.Task<IGuildChannel> - +

    A task that represents the asynchronous get operation. The task result contains the embed channel set +within the server's widget settings; null if none is set.

    + @@ -5161,7 +5439,8 @@ be or has been removed from this guild.

    IGuild.GetInvitesAsync(RequestOptions)

    -
    +

    Gets a collection of all invites in this guild.

    +
    Declaration
    @@ -5180,7 +5459,8 @@ be or has been removed from this guild.

    RequestOptions options - +

    The options to be used when sending the request.

    + @@ -5195,7 +5475,9 @@ be or has been removed from this guild.

    System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyCollection<IInviteMetadata>> - +

    A task that represents the asynchronous get operation. The task result contains a read-only collection of +invite metadata, each representing information for an invite found within this guild.

    + @@ -5208,7 +5490,8 @@ be or has been removed from this guild.

    IGuild.GetOwnerAsync(CacheMode, RequestOptions)

    -
    +

    Gets the owner of this guild.

    +
    Declaration
    @@ -5227,12 +5510,14 @@ be or has been removed from this guild.

    CacheMode mode - +

    The CacheMode that determines whether the object should be fetched from cache.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -5247,7 +5532,8 @@ be or has been removed from this guild.

    System.Threading.Tasks.Task<IGuildUser> - +

    A task that represents the asynchronous get operation. The task result contains the owner of this guild.

    + @@ -5260,7 +5546,8 @@ be or has been removed from this guild.

    IGuild.GetRole(UInt64)

    -
    +

    Gets a role in this guild.

    +
    Declaration
    @@ -5279,7 +5566,8 @@ be or has been removed from this guild.

    System.UInt64 id - +

    The snowflake identifier for the role.

    + @@ -5294,7 +5582,8 @@ be or has been removed from this guild.

    IRole - +

    A role that is associated with the specified id; null if none is found.

    + @@ -5307,7 +5596,8 @@ be or has been removed from this guild.

    IGuild.GetSystemChannelAsync(CacheMode, RequestOptions)

    -
    +

    Gets the system channel where randomized welcome messages are sent in this guild.

    +
    Declaration
    @@ -5326,12 +5616,14 @@ be or has been removed from this guild.

    CacheMode mode - +

    The CacheMode that determines whether the object should be fetched from cache.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -5346,7 +5638,9 @@ be or has been removed from this guild.

    System.Threading.Tasks.Task<ITextChannel> - +

    A task that represents the asynchronous get operation. The task result contains the text channel where +randomized welcome messages will be sent to; null if none is set.

    + @@ -5359,7 +5653,8 @@ be or has been removed from this guild.

    IGuild.GetTextChannelAsync(UInt64, CacheMode, RequestOptions)

    -
    +

    Gets a text channel in this guild.

    +
    Declaration
    @@ -5378,17 +5673,20 @@ be or has been removed from this guild.

    System.UInt64 id - +

    The snowflake identifier for the text channel.

    + CacheMode mode - +

    The CacheMode that determines whether the object should be fetched from cache.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -5403,7 +5701,9 @@ be or has been removed from this guild.

    System.Threading.Tasks.Task<ITextChannel> - +

    A task that represents the asynchronous get operation. The task result contains the text channel +associated with the specified id; null if none is found.

    + @@ -5416,7 +5716,8 @@ be or has been removed from this guild.

    IGuild.GetTextChannelsAsync(CacheMode, RequestOptions)

    -
    +

    Gets a collection of all text channels in this guild.

    +
    Declaration
    @@ -5435,12 +5736,14 @@ be or has been removed from this guild.

    CacheMode mode - +

    The CacheMode that determines whether the object should be fetched from cache.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -5455,7 +5758,9 @@ be or has been removed from this guild.

    System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyCollection<ITextChannel>> - +

    A task that represents the asynchronous get operation. The task result contains a read-only collection of +message channels found within this guild.

    + @@ -5468,7 +5773,8 @@ be or has been removed from this guild.

    IGuild.GetUserAsync(UInt64, CacheMode, RequestOptions)

    -
    +

    Gets a user from this guild.

    +
    Declaration
    @@ -5487,17 +5793,20 @@ be or has been removed from this guild.

    System.UInt64 id - +

    The snowflake identifier of the user.

    + CacheMode mode - +

    The CacheMode that determines whether the object should be fetched from cache.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -5512,10 +5821,19 @@ be or has been removed from this guild.

    System.Threading.Tasks.Task<IGuildUser> - +

    A task that represents the asynchronous get operation. The task result contains the guild user +associated with the specified id; null if none is found.

    + +
    Remarks
    +

    This method retrieves a user found within this guild.

    +
    note

    + This may return null in the WebSocket implementation due to incomplete user collection in + large guilds. +

    +
    | Improve this Doc @@ -5525,7 +5843,8 @@ be or has been removed from this guild.

    IGuild.GetUsersAsync(CacheMode, RequestOptions)

    -
    +

    Gets a collection of all users in this guild.

    +
    Declaration
    @@ -5544,12 +5863,14 @@ be or has been removed from this guild.

    CacheMode mode - +

    The CacheMode that determines whether the object should be fetched from cache.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -5564,10 +5885,19 @@ be or has been removed from this guild.

    System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyCollection<IGuildUser>> - +

    A task that represents the asynchronous get operation. The task result contains a collection of guild +users found within this guild.

    + +
    Remarks
    +

    This method retrieves all users found within this guild.

    +
    note

    + This may return an incomplete collection in the WebSocket implementation due to how Discord does not + send a complete user list for large guilds. +

    +
    | Improve this Doc @@ -5577,7 +5907,8 @@ be or has been removed from this guild.

    IGuild.GetVanityInviteAsync(RequestOptions)

    -
    +

    Gets the vanity invite URL of this guild.

    +
    Declaration
    @@ -5596,7 +5927,8 @@ be or has been removed from this guild.

    RequestOptions options - +

    The options to be used when sending the request.

    + @@ -5611,7 +5943,9 @@ be or has been removed from this guild.

    System.Threading.Tasks.Task<IInviteMetadata> - +

    A task that represents the asynchronous get operation. The task result contains the partial metadata of +the vanity invite found within this guild; null if none is found.

    + @@ -5624,7 +5958,8 @@ be or has been removed from this guild.

    IGuild.GetVoiceChannelAsync(UInt64, CacheMode, RequestOptions)

    -
    +

    Gets a voice channel in this guild.

    +
    Declaration
    @@ -5643,17 +5978,20 @@ be or has been removed from this guild.

    System.UInt64 id - +

    The snowflake identifier for the voice channel.

    + CacheMode mode - +

    The CacheMode that determines whether the object should be fetched from cache.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -5668,7 +6006,9 @@ be or has been removed from this guild.

    System.Threading.Tasks.Task<IVoiceChannel> - +

    A task that represents the asynchronous get operation. The task result contains the voice channel associated +with the specified id; null if none is found.

    + @@ -5681,7 +6021,8 @@ be or has been removed from this guild.

    IGuild.GetVoiceChannelsAsync(CacheMode, RequestOptions)

    -
    +

    Gets a collection of all voice channels in this guild.

    +
    Declaration
    @@ -5700,12 +6041,14 @@ be or has been removed from this guild.

    CacheMode mode - +

    The CacheMode that determines whether the object should be fetched from cache.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -5720,7 +6063,9 @@ be or has been removed from this guild.

    System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyCollection<IVoiceChannel>> - +

    A task that represents the asynchronous get operation. The task result contains a read-only collection of +voice channels found within this guild.

    + @@ -5733,7 +6078,8 @@ be or has been removed from this guild.

    IGuild.GetVoiceRegionsAsync(RequestOptions)

    -
    +

    Gets a collection of all the voice regions this guild can access.

    +
    Declaration
    @@ -5752,7 +6098,8 @@ be or has been removed from this guild.

    RequestOptions options - +

    The options to be used when sending the request.

    + @@ -5767,7 +6114,9 @@ be or has been removed from this guild.

    System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyCollection<IVoiceRegion>> - +

    A task that represents the asynchronous get operation. The task result contains a read-only collection of +voice regions the guild can access.

    + @@ -5780,7 +6129,8 @@ be or has been removed from this guild.

    IGuild.GetWebhookAsync(UInt64, RequestOptions)

    -
    +

    Gets a webhook found within this guild.

    +
    Declaration
    @@ -5799,12 +6149,14 @@ be or has been removed from this guild.

    System.UInt64 id - +

    The identifier for the webhook.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -5819,7 +6171,9 @@ be or has been removed from this guild.

    System.Threading.Tasks.Task<IWebhook> - +

    A task that represents the asynchronous get operation. The task result contains the webhook with the +specified id; null if none is found.

    + @@ -5832,7 +6186,8 @@ be or has been removed from this guild.

    IGuild.GetWebhooksAsync(RequestOptions)

    -
    +

    Gets a collection of all webhook from this guild.

    +
    Declaration
    @@ -5851,7 +6206,8 @@ be or has been removed from this guild.

    RequestOptions options - +

    The options to be used when sending the request.

    + @@ -5866,7 +6222,9 @@ be or has been removed from this guild.

    System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyCollection<IWebhook>> - +

    A task that represents the asynchronous get operation. The task result contains a read-only collection +of webhooks found within the guild.

    + @@ -5879,7 +6237,8 @@ be or has been removed from this guild.

    IGuild.Roles

    -
    +

    Gets a collection of all roles in this guild.

    +
    Declaration
    @@ -5896,7 +6255,8 @@ be or has been removed from this guild.

    System.Collections.Generic.IReadOnlyCollection<IRole> - +

    A read-only collection of roles found within this guild.

    + diff --git a/docs/api/Discord.Rest.RestGuildChannel.html b/docs/api/Discord.Rest.RestGuildChannel.html index 8780e0e73..42a982338 100644 --- a/docs/api/Discord.Rest.RestGuildChannel.html +++ b/docs/api/Discord.Rest.RestGuildChannel.html @@ -142,7 +142,8 @@

    GuildId

    -
    +

    Gets the guild ID associated with this channel.

    +
    Declaration
    @@ -159,7 +160,9 @@ System.UInt64 - +

    An System.UInt64 representing the guild snowflake identifier for the guild that this channel +belongs to.

    + @@ -172,7 +175,8 @@

    Name

    -
    +

    Gets the name of this channel.

    +
    Declaration
    @@ -189,7 +193,8 @@ System.String - +

    A string containing the name of this channel.

    + @@ -202,7 +207,8 @@

    PermissionOverwrites

    -
    +

    Gets a collection of permission overwrites for this channel.

    +
    Declaration
    @@ -219,7 +225,8 @@ System.Collections.Generic.IReadOnlyCollection<Overwrite> - +

    A collection of overwrites associated with this channel.

    + @@ -232,7 +239,8 @@

    Position

    -
    +

    Gets the position of this channel.

    +
    Declaration
    @@ -249,7 +257,9 @@ System.Int32 - +

    An System.Int32 representing the position of this channel in the guild's channel list relative to +others of the same type.

    + @@ -388,7 +398,8 @@

    DeleteAsync(RequestOptions)

    -
    +

    Deletes this object and all its children.

    +
    Declaration
    @@ -407,7 +418,8 @@ RequestOptions options - +

    The options to be used when sending the request.

    + @@ -535,7 +547,8 @@

    ModifyAsync(Action<GuildChannelProperties>, RequestOptions)

    -
    +

    Modifies this guild channel.

    +
    Declaration
    @@ -554,12 +567,14 @@ System.Action<GuildChannelProperties> func - +

    The delegate containing the properties to modify the channel with.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -574,10 +589,15 @@ System.Threading.Tasks.Task - +

    A task that represents the asynchronous modification operation.

    + +
    Remarks
    +

    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 GuildChannelProperties.

    +
    | Improve this Doc @@ -733,7 +753,8 @@

    UpdateAsync(RequestOptions)

    -
    +

    Updates this object's properties with its current state.

    +
    Declaration
    @@ -784,7 +805,8 @@

    IChannel.GetUserAsync(UInt64, CacheMode, RequestOptions)

    -
    +

    Gets a user in this channel.

    +
    Declaration
    @@ -803,17 +825,20 @@ System.UInt64 id - +

    The snowflake identifier of the user (e.g. 168693960628371456).

    + CacheMode mode - +

    The CacheMode that determines whether the object should be fetched from cache.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -828,7 +853,9 @@ System.Threading.Tasks.Task<IUser> - +

    A task that represents the asynchronous get operation. The task result contains a user object that +represents the found user; null if none is found.

    + @@ -841,7 +868,8 @@

    IChannel.GetUsersAsync(CacheMode, RequestOptions)

    -
    +

    Gets a collection of users that are able to view the channel or are currently in this channel.

    +
    Declaration
    @@ -860,12 +888,14 @@ CacheMode mode - +

    The CacheMode that determines whether the object should be fetched from cache.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -880,10 +910,23 @@ System.Collections.Generic.IAsyncEnumerable<System.Collections.Generic.IReadOnlyCollection<IUser>> - +

    Paged collection of users.

    + +
    Remarks
    +
    important

    + The returned collection is an asynchronous enumerable object; one must call +FlattenAsync<T>(IAsyncEnumerable<IEnumerable<T>>) to access the individual messages as a +collection. +

    +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 MaxUsersPerBatch. +In other words, if there are 3000 users, and the MaxUsersPerBatch constant +is 1000, the request will be split into 3 individual requests; thus returning 53individual asynchronous +responses, hence the need of flattening. +
    | Improve this Doc @@ -893,7 +936,8 @@

    IGuildChannel.AddPermissionOverwriteAsync(IRole, OverwritePermissions, RequestOptions)

    -
    +

    Adds or updates the permission overwrite for the given role.

    +
    Declaration
    @@ -912,17 +956,20 @@ IRole role - +

    The role to add the overwrite to.

    + OverwritePermissions permissions - +

    The overwrite to add to the role.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -937,7 +984,9 @@ System.Threading.Tasks.Task - +

    A task representing the asynchronous permission operation for adding the specified permissions to the +channel.

    + @@ -950,7 +999,8 @@

    IGuildChannel.AddPermissionOverwriteAsync(IUser, OverwritePermissions, RequestOptions)

    -
    +

    Adds or updates the permission overwrite for the given user.

    +
    Declaration
    @@ -969,17 +1019,20 @@ IUser user - +

    The user to add the overwrite to.

    + OverwritePermissions permissions - +

    The overwrite to add to the user.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -994,7 +1047,8 @@ System.Threading.Tasks.Task - +

    A task representing the asynchronous permission operation for adding the specified permissions to the channel.

    + @@ -1007,7 +1061,8 @@

    IGuildChannel.GetPermissionOverwrite(IRole)

    -
    +

    Gets the permission overwrite for a specific role.

    +
    Declaration
    @@ -1026,7 +1081,8 @@ IRole role - +

    The role to get the overwrite from.

    + @@ -1041,7 +1097,8 @@ System.Nullable<OverwritePermissions> - +

    An overwrite object for the targeted role; null if none is set.

    + @@ -1054,7 +1111,8 @@

    IGuildChannel.GetPermissionOverwrite(IUser)

    -
    +

    Gets the permission overwrite for a specific user.

    +
    Declaration
    @@ -1073,7 +1131,8 @@ IUser user - +

    The user to get the overwrite from.

    + @@ -1088,7 +1147,8 @@ System.Nullable<OverwritePermissions> - +

    An overwrite object for the targeted user; null if none is set.

    + @@ -1101,7 +1161,8 @@

    IGuildChannel.GetUserAsync(UInt64, CacheMode, RequestOptions)

    -
    +

    Gets a user in this channel.

    +
    Declaration
    @@ -1120,17 +1181,20 @@ System.UInt64 id - +

    The snowflake identifier of the user.

    + CacheMode mode - +

    The CacheMode that determines whether the object should be fetched from cache.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -1145,7 +1209,9 @@ System.Threading.Tasks.Task<IGuildUser> - +

    A task representing the asynchronous get operation. The task result contains a guild user object that +represents the user; null if none is found.

    + @@ -1158,7 +1224,8 @@

    IGuildChannel.GetUsersAsync(CacheMode, RequestOptions)

    -
    +

    Gets a collection of users that are able to view the channel or are currently in this channel.

    +
    Declaration
    @@ -1177,12 +1244,14 @@ CacheMode mode - +

    The CacheMode that determines whether the object should be fetched from cache.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -1197,10 +1266,15 @@ System.Collections.Generic.IAsyncEnumerable<System.Collections.Generic.IReadOnlyCollection<IGuildUser>> - +

    Paged collection of users.

    + +
    Remarks
    +

    This method follows the same behavior as described in GetUsersAsync(CacheMode, RequestOptions). +Please visit its documentation for more details on this method.

    +
    | Improve this Doc @@ -1210,7 +1284,8 @@

    IGuildChannel.Guild

    -
    +

    Gets the guild associated with this channel.

    +
    Declaration
    @@ -1227,7 +1302,8 @@ IGuild - +

    A guild object that this channel belongs to.

    + @@ -1240,7 +1316,8 @@

    IGuildChannel.RemovePermissionOverwriteAsync(IRole, RequestOptions)

    -
    +

    Removes the permission overwrite for the given role, if one exists.

    +
    Declaration
    @@ -1259,12 +1336,14 @@ IRole role - +

    The role to remove the overwrite from.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -1279,7 +1358,8 @@ System.Threading.Tasks.Task - +

    A task representing the asynchronous operation for removing the specified permissions from the channel.

    + @@ -1292,7 +1372,8 @@

    IGuildChannel.RemovePermissionOverwriteAsync(IUser, RequestOptions)

    -
    +

    Removes the permission overwrite for the given user, if one exists.

    +
    Declaration
    @@ -1311,12 +1392,14 @@ IUser user - +

    The user to remove the overwrite from.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -1331,7 +1414,8 @@ System.Threading.Tasks.Task - +

    A task representing the asynchronous operation for removing the specified permissions from the channel.

    + diff --git a/docs/api/Discord.Rest.RestGuildIntegration.html b/docs/api/Discord.Rest.RestGuildIntegration.html index 3c077a3bc..d05c17d63 100644 --- a/docs/api/Discord.Rest.RestGuildIntegration.html +++ b/docs/api/Discord.Rest.RestGuildIntegration.html @@ -127,7 +127,8 @@

    Account

    -
    +

    Gets integration account information.

    +
    Declaration
    @@ -157,7 +158,8 @@

    ExpireBehavior

    -
    +

    Gets the ID that this integration uses for "subscribers".

    +
    Declaration
    @@ -187,7 +189,8 @@

    ExpireGracePeriod

    -
    +

    Gets the grace period before expiring "subscribers".

    +
    Declaration
    @@ -247,7 +250,8 @@

    IsEnabled

    -
    +

    Gets a value that indicates whether this integration is enabled or not.

    +
    Declaration
    @@ -264,7 +268,8 @@ System.Boolean - +

    true if this integration is enabled; otherwise false.

    + @@ -277,7 +282,8 @@

    IsSyncing

    -
    +

    Gets a value that indicates whether this integration is syncing or not.

    +
    Declaration
    @@ -294,10 +300,15 @@ System.Boolean - +

    true if this integration is syncing; otherwise false.

    + +
    Remarks
    +

    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.

    +
    | Improve this Doc @@ -307,7 +318,8 @@

    Name

    -
    +

    Gets the integration name.

    +
    Declaration
    @@ -324,7 +336,8 @@ System.String - +

    A string containing the name of this integration.

    + @@ -367,7 +380,8 @@

    SyncedAt

    -
    +

    Gets when this integration was last synced.

    +
    Declaration
    @@ -384,7 +398,8 @@ System.DateTimeOffset - +

    A System.DateTimeOffset containing a date and time of day when the integration was last synced.

    + @@ -397,7 +412,8 @@

    Type

    -
    +

    Gets the integration type (Twitch, YouTube, etc).

    +
    Declaration
    @@ -414,7 +430,8 @@ System.String - +

    A string containing the name of the type of integration.

    + diff --git a/docs/api/Discord.Rest.RestGuildUser.html b/docs/api/Discord.Rest.RestGuildUser.html index eb0ca440b..2e86ac074 100644 --- a/docs/api/Discord.Rest.RestGuildUser.html +++ b/docs/api/Discord.Rest.RestGuildUser.html @@ -183,7 +183,8 @@

    GuildId

    -
    +

    Gets the ID of the guild for this user.

    +
    Declaration
    @@ -200,7 +201,8 @@ System.UInt64 - +

    An System.UInt64 representing the snowflake identifier of the guild that this user belongs to.

    + @@ -213,7 +215,8 @@

    GuildPermissions

    -
    +

    Gets the guild-level permissions for this user.

    +
    Declaration
    @@ -230,7 +233,9 @@ GuildPermissions - +

    A GuildPermissions structure for this user, representing what +permissions this user has in the guild.

    + @@ -259,7 +264,8 @@

    IsDeafened

    -
    +

    Gets a value that indicates whether this user is deafened by the guild.

    +
    Declaration
    @@ -276,7 +282,9 @@ System.Boolean - +

    true if the user is deafened (i.e. not permitted to listen to or speak to others) by the guild; +otherwise false.

    + @@ -289,7 +297,9 @@

    IsMuted

    -
    +

    Gets a value that indicates whether this user is muted (i.e. not permitted to speak via voice) by the +guild.

    +
    Declaration
    @@ -306,7 +316,8 @@ System.Boolean - +

    true if this user is muted by the guild; otherwise false.

    + @@ -319,7 +330,8 @@

    JoinedAt

    -
    +

    Gets when this user joined the guild.

    +
    Declaration
    @@ -336,7 +348,9 @@ System.Nullable<System.DateTimeOffset> - +

    A System.DateTimeOffset representing the time of which the user has joined the guild; +null when it cannot be obtained.

    + @@ -349,7 +363,8 @@

    Nickname

    -
    +

    Gets the nickname for this user.

    +
    Declaration
    @@ -366,7 +381,8 @@ System.String - +

    A string representing the nickname of the user; null if none is set.

    + @@ -379,7 +395,8 @@

    PremiumSince

    -
    +

    Gets the date and time for when this user's guild boost began.

    +
    Declaration
    @@ -396,7 +413,8 @@ System.Nullable<System.DateTimeOffset> - +

    A System.DateTimeOffset for when the user began boosting this guild; null if they are not boosting the guild.

    + @@ -409,7 +427,8 @@

    RoleIds

    -
    +

    Gets a collection of IDs for the roles that this user currently possesses in the guild.

    +
    Declaration
    @@ -426,10 +445,17 @@ System.Collections.Generic.IReadOnlyCollection<System.UInt64> - +

    A read-only collection of System.UInt64, each representing a snowflake identifier for a role that +this user possesses.

    + +
    Remarks
    +

    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.

    +

    Methods

    @@ -441,7 +467,8 @@

    AddRoleAsync(IRole, RequestOptions)

    -
    +

    Adds the specified role to this user in the guild.

    +
    Declaration
    @@ -460,12 +487,14 @@ IRole role - +

    The role to be added to the user.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -480,7 +509,8 @@ System.Threading.Tasks.Task - +

    A task that represents the asynchronous role addition operation.

    + @@ -493,7 +523,8 @@

    AddRolesAsync(IEnumerable<IRole>, RequestOptions)

    -
    +

    Adds the specified roles to this user in the guild.

    +
    Declaration
    @@ -512,12 +543,14 @@ System.Collections.Generic.IEnumerable<IRole> roles - +

    The roles to be added to the user.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -532,7 +565,8 @@ System.Threading.Tasks.Task - +

    A task that represents the asynchronous role addition operation.

    + @@ -545,7 +579,8 @@

    GetPermissions(IGuildChannel)

    -
    +

    Gets the level permissions granted to this user to a given channel.

    +
    Declaration
    @@ -564,7 +599,8 @@ IGuildChannel channel - +

    The channel to get the permission from.

    + @@ -579,7 +615,9 @@ ChannelPermissions - +

    A ChannelPermissions structure representing the permissions that a user has in the +specified channel.

    + @@ -608,7 +646,8 @@

    KickAsync(String, RequestOptions)

    -
    +

    Kicks this user from this guild.

    +
    Declaration
    @@ -627,12 +666,14 @@ System.String reason - +

    The reason for the kick which will be recorded in the audit log.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -647,7 +688,8 @@ System.Threading.Tasks.Task - +

    A task that represents the asynchronous kick operation.

    + @@ -660,7 +702,8 @@

    ModifyAsync(Action<GuildUserProperties>, RequestOptions)

    -
    +

    Modifies this user's properties in this guild.

    +
    Declaration
    @@ -679,12 +722,14 @@ System.Action<GuildUserProperties> func - +

    The delegate containing the properties to modify the user with.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -699,10 +744,15 @@ System.Threading.Tasks.Task - +

    A task that represents the asynchronous modification operation.

    + +
    Remarks
    +

    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 GuildUserProperties.

    +
    | Improve this Doc @@ -712,7 +762,8 @@

    RemoveRoleAsync(IRole, RequestOptions)

    -
    +

    Removes the specified role from this user in the guild.

    +
    Declaration
    @@ -731,12 +782,14 @@ IRole role - +

    The role to be removed from the user.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -751,7 +804,8 @@ System.Threading.Tasks.Task - +

    A task that represents the asynchronous role removal operation.

    + @@ -764,7 +818,8 @@

    RemoveRolesAsync(IEnumerable<IRole>, RequestOptions)

    -
    +

    Removes the specified roles from this user in the guild.

    +
    Declaration
    @@ -783,12 +838,14 @@ System.Collections.Generic.IEnumerable<IRole> roles - +

    The roles to be removed from the user.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -803,7 +860,8 @@ System.Threading.Tasks.Task - +

    A task that represents the asynchronous role removal operation.

    + @@ -816,7 +874,8 @@

    UpdateAsync(RequestOptions)

    -
    +

    Updates this object's properties with its current state.

    +
    Declaration
    @@ -867,7 +926,8 @@

    IGuildUser.Guild

    -
    +

    Gets the guild for this user.

    +
    Declaration
    @@ -884,7 +944,8 @@ IGuild - +

    A guild object that this user belongs to.

    + @@ -897,7 +958,8 @@

    IVoiceState.IsSelfDeafened

    -
    +

    Gets a value that indicates whether this user has marked themselves as deafened.

    +
    Declaration
    @@ -914,7 +976,8 @@ System.Boolean - +

    true if this user has deafened themselves (i.e. not permitted to listen to or speak to others); otherwise false.

    + @@ -927,7 +990,9 @@

    IVoiceState.IsSelfMuted

    -
    +

    Gets a value that indicates whether this user has marked themselves as muted (i.e. not permitted to +speak via voice).

    +
    Declaration
    @@ -944,7 +1009,8 @@ System.Boolean - +

    true if this user has muted themselves; otherwise false.

    + @@ -957,7 +1023,8 @@

    IVoiceState.IsStreaming

    -
    +

    Gets a value that indicates if this user is streaming in a voice channel.

    +
    Declaration
    @@ -974,7 +1041,8 @@ System.Boolean - +

    true if the user is streaming; otherwise false.

    + @@ -987,7 +1055,8 @@

    IVoiceState.IsSuppressed

    -
    +

    Gets a value that indicates whether the user is muted by the current user.

    +
    Declaration
    @@ -1004,7 +1073,8 @@ System.Boolean - +

    true if the guild is temporarily blocking audio to/from this user; otherwise false.

    + @@ -1017,7 +1087,8 @@

    IVoiceState.VoiceChannel

    -
    +

    Gets the voice channel this user is currently in.

    +
    Declaration
    @@ -1034,7 +1105,9 @@ IVoiceChannel - +

    A generic voice channel object representing the voice channel that the user is currently in; null +if none.

    + @@ -1047,7 +1120,8 @@

    IVoiceState.VoiceSessionId

    -
    +

    Gets the unique identifier for this user's voice session.

    +
    Declaration
    diff --git a/docs/api/Discord.Rest.RestInvite.html b/docs/api/Discord.Rest.RestInvite.html index fc77ce671..1cf693003 100644 --- a/docs/api/Discord.Rest.RestInvite.html +++ b/docs/api/Discord.Rest.RestInvite.html @@ -130,7 +130,8 @@

    ChannelId

    -
    +

    Gets the ID of the channel this invite is linked to.

    +
    Declaration
    @@ -147,7 +148,8 @@ System.UInt64 - +

    An System.UInt64 representing the channel snowflake identifier that the invite points to.

    + @@ -160,7 +162,8 @@

    ChannelName

    -
    +

    Gets the name of the channel this invite is linked to.

    +
    Declaration
    @@ -177,7 +180,8 @@ System.String - +

    A string containing the name of the channel that the invite points to.

    + @@ -220,7 +224,8 @@

    Code

    -
    +

    Gets the unique identifier for this invite.

    +
    Declaration
    @@ -237,7 +242,8 @@ System.String - +

    A string containing the invite code (e.g. FTqNnyS).

    + @@ -250,7 +256,8 @@

    GuildId

    -
    +

    Gets the ID of the guild this invite is linked to.

    +
    Declaration
    @@ -267,7 +274,8 @@ System.Nullable<System.UInt64> - +

    An System.UInt64 representing the guild snowflake identifier that the invite points to.

    + @@ -280,7 +288,8 @@

    GuildName

    -
    +

    Gets the name of the guild this invite is linked to.

    +
    Declaration
    @@ -297,7 +306,8 @@ System.String - +

    A string containing the name of the guild that the invite points to.

    + @@ -310,7 +320,8 @@

    MemberCount

    -
    +

    Gets the approximated count of total members in the guild.

    +
    Declaration
    @@ -327,7 +338,9 @@ System.Nullable<System.Int32> - +

    An System.Int32 representing the approximated total member count of the guild that the +invite points to; null if one cannot be obtained.

    + @@ -340,7 +353,8 @@

    PresenceCount

    -
    +

    Gets the approximated count of online members in the guild.

    +
    Declaration
    @@ -357,7 +371,9 @@ System.Nullable<System.Int32> - +

    An System.Int32 representing the approximated online member count of the guild that the +invite points to; null if one cannot be obtained.

    + @@ -370,7 +386,8 @@

    Url

    -
    +

    Gets the URL used to accept this invite using Code.

    +
    Declaration
    @@ -387,7 +404,8 @@ System.String - +

    A string containing the full invite URL (e.g. https://discord.gg/FTqNnyS).

    + @@ -402,7 +420,8 @@

    DeleteAsync(RequestOptions)

    -
    +

    Deletes this object and all its children.

    +
    Declaration
    @@ -421,7 +440,8 @@ RequestOptions options - +

    The options to be used when sending the request.

    + @@ -483,7 +503,8 @@

    UpdateAsync(RequestOptions)

    -
    +

    Updates this object's properties with its current state.

    +
    Declaration
    @@ -532,7 +553,8 @@

    IInvite.Channel

    -
    +

    Gets the channel this invite is linked to.

    +
    Declaration
    @@ -549,7 +571,8 @@ IChannel - +

    A generic channel that the invite points to.

    + @@ -562,7 +585,8 @@

    IInvite.Guild

    -
    +

    Gets the guild this invite is linked to.

    +
    Declaration
    @@ -579,7 +603,8 @@ IGuild - +

    A guild object representing the guild that the invite points to.

    + diff --git a/docs/api/Discord.Rest.RestInviteMetadata.html b/docs/api/Discord.Rest.RestInviteMetadata.html index 59714d5a2..e77f00364 100644 --- a/docs/api/Discord.Rest.RestInviteMetadata.html +++ b/docs/api/Discord.Rest.RestInviteMetadata.html @@ -174,7 +174,8 @@

    CreatedAt

    -
    +

    Gets when this invite was created.

    +
    Declaration
    @@ -191,7 +192,8 @@ System.Nullable<System.DateTimeOffset> - +

    A System.DateTimeOffset representing the time of which the invite was first created.

    + @@ -235,7 +237,8 @@

    IsRevoked

    -
    +

    Gets a value that indicates whether the invite has been revoked.

    +
    Declaration
    @@ -252,7 +255,8 @@ System.Boolean - +

    true if this invite was revoked; otherwise false.

    + @@ -265,7 +269,8 @@

    IsTemporary

    -
    +

    Gets a value that indicates whether the invite is a temporary one.

    +
    Declaration
    @@ -282,7 +287,9 @@ System.Boolean - +

    true if users accepting this invite will be removed from the guild when they log off; otherwise +false.

    + @@ -295,7 +302,8 @@

    MaxAge

    -
    +

    Gets the time (in seconds) until the invite expires.

    +
    Declaration
    @@ -312,7 +320,9 @@ System.Nullable<System.Int32> - +

    An System.Int32 representing the time in seconds until this invite expires; null if this +invite never expires.

    + @@ -325,7 +335,8 @@

    MaxUses

    -
    +

    Gets the max number of uses this invite may have.

    +
    Declaration
    @@ -342,7 +353,9 @@ System.Nullable<System.Int32> - +

    An System.Int32 representing the number of uses this invite may be accepted until it is removed +from the guild; null if none is set.

    + @@ -355,7 +368,8 @@

    Uses

    -
    +

    Gets the number of times this invite has been used.

    +
    Declaration
    @@ -372,7 +386,8 @@ System.Nullable<System.Int32> - +

    An System.Int32 representing the number of times this invite has been used.

    + @@ -387,7 +402,8 @@

    IInviteMetadata.Inviter

    -
    +

    Gets the user that created this invite.

    +
    Declaration
    @@ -404,7 +420,8 @@ IUser - +

    A user that created this invite.

    + diff --git a/docs/api/Discord.Rest.RestMessage.html b/docs/api/Discord.Rest.RestMessage.html index f1600070e..b83eb1a67 100644 --- a/docs/api/Discord.Rest.RestMessage.html +++ b/docs/api/Discord.Rest.RestMessage.html @@ -133,7 +133,8 @@

    Activity

    -
    +

    Gets the activity associated with a message.

    +
    Declaration
    @@ -150,10 +151,15 @@ MessageActivity - +

    A message's activity, if any is associated.

    + +
    Remarks
    +

    Sent with Rich Presence-related chat embeds. This often refers to activity that requires end-user's +interaction, such as a Spotify Invite activity.

    +
    | Improve this Doc @@ -163,7 +169,8 @@

    Application

    -
    +

    Gets the application associated with a message.

    +
    Declaration
    @@ -180,10 +187,14 @@ MessageApplication - +

    A message's application, if any is associated.

    + +
    Remarks
    +

    Sent with Rich-Presence-related chat embeds.

    +
    | Improve this Doc @@ -255,7 +266,8 @@

    Channel

    -
    +

    Gets the source channel of the message.

    +
    Declaration
    @@ -285,7 +297,8 @@

    Content

    -
    +

    Gets the content for this message.

    +
    Declaration
    @@ -302,7 +315,8 @@ System.String - +

    A string that contains the body of the message; note that this field may be empty if there is an embed.

    + @@ -315,7 +329,8 @@

    CreatedAt

    -
    +

    Gets when the snowflake was created.

    +
    Declaration
    @@ -332,7 +347,8 @@ System.DateTimeOffset - +

    A System.DateTimeOffset representing when the entity was first created.

    + @@ -345,7 +361,8 @@

    EditedTimestamp

    -
    +

    Gets the time of this message's last edit.

    +
    Declaration
    @@ -362,7 +379,8 @@ System.Nullable<System.DateTimeOffset> - +

    Time of when the message was last edited; null if the message is never edited.

    + @@ -406,7 +424,8 @@

    IsPinned

    -
    +

    Gets the value that indicates whether this message is pinned.

    +
    Declaration
    @@ -423,7 +442,8 @@ System.Boolean - +

    true if this message was added to its channel's pinned messages; otherwise false.

    + @@ -436,7 +456,8 @@

    IsSuppressed

    -
    +

    Gets the value that indicates whether or not this message's embeds are suppressed.

    +
    Declaration
    @@ -453,7 +474,8 @@ System.Boolean - +

    true if the embeds in this message have been suppressed (made invisible); otherwise false.

    + @@ -466,7 +488,8 @@

    IsTTS

    -
    +

    Gets the value that indicates whether this message was meant to be read-aloud by Discord.

    +
    Declaration
    @@ -483,7 +506,8 @@ System.Boolean - +

    true if this message was sent as a text-to-speech message; otherwise false.

    + @@ -496,7 +520,8 @@

    MentionedChannelIds

    -
    +

    Gets the IDs of channels mentioned in this message.

    +
    Declaration
    @@ -513,7 +538,8 @@ System.Collections.Generic.IReadOnlyCollection<System.UInt64> - +

    A read-only collection of channel IDs.

    + @@ -526,7 +552,8 @@

    MentionedRoleIds

    -
    +

    Gets the IDs of roles mentioned in this message.

    +
    Declaration
    @@ -543,7 +570,8 @@ System.Collections.Generic.IReadOnlyCollection<System.UInt64> - +

    A read-only collection of role IDs.

    + @@ -587,7 +615,8 @@

    Reactions

    -
    +

    Gets all reactions included in this message.

    +
    Declaration
    @@ -617,7 +646,8 @@

    Reference

    -
    +

    Gets the reference to the original message if it was crossposted.

    +
    Declaration
    @@ -634,10 +664,15 @@ MessageReference - +

    A message's reference, if any is associated.

    + +
    Remarks
    +

    Sent with Cross-posted messages, meaning they were published from news channels +and received by subscriber channels.

    +
    | Improve this Doc @@ -647,7 +682,8 @@

    Source

    -
    +

    Gets the source type of this message.

    +
    Declaration
    @@ -677,7 +713,8 @@

    Tags

    -
    +

    Gets all tags included in this message's content.

    +
    Declaration
    @@ -707,7 +744,8 @@

    Timestamp

    -
    +

    Gets the time this message was sent.

    +
    Declaration
    @@ -724,7 +762,8 @@ System.DateTimeOffset - +

    Time of when the message was sent.

    + @@ -739,7 +778,8 @@

    AddReactionAsync(IEmote, RequestOptions)

    -
    +

    Adds a reaction to this message.

    +
    Declaration
    @@ -758,12 +798,14 @@ IEmote emote - +

    The emoji used to react to this message.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -778,10 +820,15 @@ System.Threading.Tasks.Task - +

    A task that represents the asynchronous operation for adding a reaction to this message.

    + +
    See Also
    +
    + +
    | Improve this Doc @@ -791,7 +838,8 @@

    DeleteAsync(RequestOptions)

    -
    +

    Deletes this object and all its children.

    +
    Declaration
    @@ -810,7 +858,8 @@ RequestOptions options - +

    The options to be used when sending the request.

    + @@ -838,7 +887,8 @@

    GetReactionUsersAsync(IEmote, Int32, RequestOptions)

    -
    +

    Gets all users that reacted to a message with a given emote.

    +
    Declaration
    @@ -862,12 +912,14 @@ System.Int32 limit - +

    The number of users to request.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -882,7 +934,10 @@ System.Collections.Generic.IAsyncEnumerable<System.Collections.Generic.IReadOnlyCollection<IUser>> - +

    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 +FlattenAsync<T>(IAsyncEnumerable<IEnumerable<T>>) is required if you wish to access the users.

    + @@ -895,7 +950,8 @@

    RemoveAllReactionsAsync(RequestOptions)

    -
    +

    Removes all reactions from this message.

    +
    Declaration
    @@ -914,7 +970,8 @@ RequestOptions options - +

    The options to be used when sending the request.

    + @@ -929,7 +986,8 @@ System.Threading.Tasks.Task - +

    A task that represents the asynchronous removal operation.

    + @@ -942,7 +1000,8 @@

    RemoveReactionAsync(IEmote, IUser, RequestOptions)

    -
    +

    Removes a reaction from message.

    +
    Declaration
    @@ -961,17 +1020,20 @@ IEmote emote - +

    The emoji used to react to this message.

    + IUser user - +

    The user that added the emoji.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -986,10 +1048,15 @@ System.Threading.Tasks.Task - +

    A task that represents the asynchronous operation for removing a reaction to this message.

    + +
    See Also
    +
    + +
    | Improve this Doc @@ -999,7 +1066,8 @@

    RemoveReactionAsync(IEmote, UInt64, RequestOptions)

    -
    +

    Removes a reaction from message.

    +
    Declaration
    @@ -1018,17 +1086,20 @@ IEmote emote - +

    The emoji used to react to this message.

    + System.UInt64 userId - +

    The ID of the user that added the emoji.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -1043,10 +1114,15 @@ System.Threading.Tasks.Task - +

    A task that represents the asynchronous operation for removing a reaction to this message.

    + +
    See Also
    +
    + +
    | Improve this Doc @@ -1090,7 +1166,8 @@

    UpdateAsync(RequestOptions)

    -
    +

    Updates this object's properties with its current state.

    +
    Declaration
    @@ -1139,7 +1216,8 @@

    IMessage.Attachments

    -
    +

    Gets all attachments included in this message.

    +
    Declaration
    @@ -1156,10 +1234,16 @@ System.Collections.Generic.IReadOnlyCollection<IAttachment> - +

    A read-only collection of attachments.

    + +
    Remarks
    +

    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.

    +
    | Improve this Doc @@ -1199,7 +1283,8 @@

    IMessage.Embeds

    -
    +

    Gets all embeds included in this message.

    +
    Declaration
    @@ -1216,7 +1301,8 @@ System.Collections.Generic.IReadOnlyCollection<IEmbed> - +

    A read-only collection of embed objects.

    + @@ -1229,7 +1315,8 @@

    IMessage.MentionedUserIds

    -
    +

    Gets the IDs of users mentioned in this message.

    +
    Declaration
    @@ -1246,7 +1333,8 @@ System.Collections.Generic.IReadOnlyCollection<System.UInt64> - +

    A read-only collection of user IDs.

    + @@ -1259,7 +1347,8 @@

    IMessage.Type

    -
    +

    Gets the type of this system message.

    +
    Declaration
    diff --git a/docs/api/Discord.Rest.RestReaction.html b/docs/api/Discord.Rest.RestReaction.html index 89ec1694e..025cbdede 100644 --- a/docs/api/Discord.Rest.RestReaction.html +++ b/docs/api/Discord.Rest.RestReaction.html @@ -157,7 +157,8 @@

    Emote

    -
    +

    The IEmote used in the reaction.

    +
    Declaration
    diff --git a/docs/api/Discord.Rest.RestRole.html b/docs/api/Discord.Rest.RestRole.html index 0fdfafddf..3dfe1e66b 100644 --- a/docs/api/Discord.Rest.RestRole.html +++ b/docs/api/Discord.Rest.RestRole.html @@ -132,7 +132,8 @@

    Color

    -
    +

    Gets the color given to users of this role.

    +
    Declaration
    @@ -149,7 +150,8 @@ Color - +

    A Color struct representing the color of this role.

    + @@ -162,7 +164,8 @@

    CreatedAt

    -
    +

    Gets when the snowflake was created.

    +
    Declaration
    @@ -179,7 +182,8 @@ System.DateTimeOffset - +

    A System.DateTimeOffset representing when the entity was first created.

    + @@ -223,7 +227,8 @@

    IsHoisted

    -
    +

    Gets a value that indicates whether the role can be separated in the user list.

    +
    Declaration
    @@ -240,7 +245,8 @@ System.Boolean - +

    true if users of this role are separated in the user list; otherwise false.

    + @@ -253,7 +259,8 @@

    IsManaged

    -
    +

    Gets a value that indicates whether the role is managed by Discord.

    +
    Declaration
    @@ -270,7 +277,8 @@ System.Boolean - +

    true if this role is automatically managed by Discord; otherwise false.

    + @@ -283,7 +291,8 @@

    IsMentionable

    -
    +

    Gets a value that indicates whether the role is mentionable.

    +
    Declaration
    @@ -300,7 +309,8 @@ System.Boolean - +

    true if this role may be mentioned in messages; otherwise false.

    + @@ -313,7 +323,8 @@

    Mention

    -
    +

    Returns a special string used to mention this object.

    +
    Declaration
    @@ -330,7 +341,8 @@ System.String - +

    A string that is recognized by Discord as a mention (e.g. <@168693960628371456>).

    + @@ -343,7 +355,8 @@

    Name

    -
    +

    Gets the name of this role.

    +
    Declaration
    @@ -360,7 +373,8 @@ System.String - +

    A string containing the name of this role.

    + @@ -373,7 +387,8 @@

    Permissions

    -
    +

    Gets the permissions granted to members of this role.

    +
    Declaration
    @@ -390,7 +405,8 @@ GuildPermissions - +

    A GuildPermissions struct that this role possesses.

    + @@ -403,7 +419,8 @@

    Position

    -
    +

    Gets this role's position relative to other roles in the same guild.

    +
    Declaration
    @@ -420,7 +437,8 @@ System.Int32 - +

    An System.Int32 representing the position of the role in the role list of the guild.

    + @@ -482,7 +500,8 @@

    DeleteAsync(RequestOptions)

    -
    +

    Deletes this object and all its children.

    +
    Declaration
    @@ -501,7 +520,8 @@ RequestOptions options - +

    The options to be used when sending the request.

    + @@ -529,7 +549,8 @@

    ModifyAsync(Action<RoleProperties>, RequestOptions)

    -
    +

    Modifies this role.

    +
    Declaration
    @@ -548,12 +569,14 @@ System.Action<RoleProperties> func - +

    A delegate containing the properties to modify the role with.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -568,10 +591,15 @@ System.Threading.Tasks.Task - +

    A task that represents the asynchronous modification operation.

    + +
    Remarks
    +

    This method modifies this role with the specified properties. To see an example of this +method and what properties are available, please refer to RoleProperties.

    +
    | Improve this Doc @@ -617,7 +645,8 @@

    IRole.Guild

    -
    +

    Gets the guild that owns this role.

    +
    Declaration
    @@ -634,7 +663,8 @@ IGuild - +

    A guild representing the parent guild of this role.

    + diff --git a/docs/api/Discord.Rest.RestSelfUser.html b/docs/api/Discord.Rest.RestSelfUser.html index fb2662758..a02a17721 100644 --- a/docs/api/Discord.Rest.RestSelfUser.html +++ b/docs/api/Discord.Rest.RestSelfUser.html @@ -182,7 +182,8 @@

    Email

    -
    +

    Gets the email associated with this user.

    +
    Declaration
    @@ -212,7 +213,8 @@

    Flags

    -
    +

    Gets the flags that are applied to a user's account.

    +
    Declaration
    @@ -229,10 +231,14 @@ UserProperties - +

    The value of flags for this user.

    + +
    Remarks
    +

    This value is determined by bitwise OR-ing UserProperties values together.

    +
    | Improve this Doc @@ -242,7 +248,8 @@

    IsMfaEnabled

    -
    +

    Indicates whether or not this user has MFA enabled on their account.

    +
    Declaration
    @@ -259,7 +266,8 @@ System.Boolean - +

    true if this user has enabled multi-factor authentication on their account; false if not.

    + @@ -272,7 +280,8 @@

    IsVerified

    -
    +

    Indicates whether or not this user has their email verified.

    +
    Declaration
    @@ -289,7 +298,8 @@ System.Boolean - +

    true if this user's email has been verified; false if not.

    + @@ -302,7 +312,8 @@

    Locale

    -
    +

    Gets the user's chosen language option.

    +
    Declaration
    @@ -319,7 +330,9 @@ System.String - +

    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.

    + @@ -332,7 +345,8 @@

    PremiumType

    -
    +

    Gets the type of Nitro subscription that is active on this user's account.

    +
    Declaration
    @@ -349,10 +363,14 @@ PremiumType - +

    The type of Nitro subscription the user subscribes to, if any.

    + +
    Remarks
    +

    This information may only be available with the identify OAuth scope.

    +

    Methods

    @@ -364,7 +382,8 @@

    ModifyAsync(Action<SelfUserProperties>, RequestOptions)

    -
    +

    Modifies the user's properties.

    +
    Declaration
    @@ -432,7 +451,8 @@

    UpdateAsync(RequestOptions)

    -
    +

    Updates this object's properties with its current state.

    +
    Declaration
    diff --git a/docs/api/Discord.Rest.RestSystemMessage.html b/docs/api/Discord.Rest.RestSystemMessage.html index b27e7f215..09ef94449 100644 --- a/docs/api/Discord.Rest.RestSystemMessage.html +++ b/docs/api/Discord.Rest.RestSystemMessage.html @@ -232,7 +232,8 @@

    Type

    -
    +

    Gets the type of this system message.

    +
    Declaration
    diff --git a/docs/api/Discord.Rest.RestTextChannel.html b/docs/api/Discord.Rest.RestTextChannel.html index cbeb5d444..77f249da3 100644 --- a/docs/api/Discord.Rest.RestTextChannel.html +++ b/docs/api/Discord.Rest.RestTextChannel.html @@ -209,7 +209,8 @@

    CategoryId

    -
    +

    Gets the parent (category) ID of this channel in the guild's channel list.

    +
    Declaration
    @@ -226,7 +227,9 @@ System.Nullable<System.UInt64> - +

    A System.UInt64 representing the snowflake identifier of the parent of this channel; +null if none is set.

    + @@ -239,7 +242,8 @@

    IsNsfw

    -
    +

    Gets a value that indicates whether the channel is NSFW.

    +
    Declaration
    @@ -256,7 +260,8 @@ System.Boolean - +

    true if the channel has the NSFW flag enabled; otherwise false.

    + @@ -269,7 +274,8 @@

    Mention

    -
    +

    Returns a special string used to mention this object.

    +
    Declaration
    @@ -286,7 +292,8 @@ System.String - +

    A string that is recognized by Discord as a mention (e.g. <@168693960628371456>).

    + @@ -299,7 +306,8 @@

    SlowModeInterval

    -
    +

    Gets the current slow-mode delay for this channel.

    +
    Declaration
    @@ -316,7 +324,9 @@ System.Int32 - +

    An System.Int32 representing the time in seconds required before the user can send another +message; 0 if disabled.

    + @@ -329,7 +339,8 @@

    Topic

    -
    +

    Gets the current topic for this text channel.

    +
    Declaration
    @@ -346,7 +357,8 @@ System.String - +

    A string representing the topic set in the channel; null if none is set.

    + @@ -361,7 +373,8 @@

    CreateInviteAsync(Nullable<Int32>, Nullable<Int32>, Boolean, Boolean, RequestOptions)

    -
    +

    Creates a new invite to this channel.

    +
    Declaration
    @@ -380,27 +393,32 @@ System.Nullable<System.Int32> maxAge - +

    The time (in seconds) until the invite expires. Set to null to never expire.

    + System.Nullable<System.Int32> maxUses - +

    The max amount of times this invite may be used. Set to null to have unlimited uses.

    + System.Boolean isTemporary - +

    If true, the user accepting this invite will be kicked from the guild after closing their client.

    + System.Boolean isUnique - +

    If true, don't try to reuse a similar invite (useful for creating many unique one time use invites).

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -415,7 +433,9 @@ System.Threading.Tasks.Task<IInviteMetadata> - +

    A task that represents the asynchronous invite creation operation. The task result contains an invite +metadata object containing information for the created invite.

    + @@ -491,7 +511,8 @@ webhook.

    DeleteMessageAsync(IMessage, RequestOptions)

    -
    +

    Deletes a message based on the provided message in this channel.

    +
    Declaration
    @@ -510,12 +531,14 @@ webhook.

    IMessage message - +

    The message that would be removed.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -530,7 +553,8 @@ webhook.

    System.Threading.Tasks.Task - +

    A task that represents the asynchronous removal operation.

    + @@ -543,7 +567,8 @@ webhook.

    DeleteMessageAsync(UInt64, RequestOptions)

    -
    +

    Deletes a message.

    +
    Declaration
    @@ -562,12 +587,14 @@ webhook.

    System.UInt64 messageId - +

    The snowflake identifier of the message that would be removed.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -582,7 +609,8 @@ webhook.

    System.Threading.Tasks.Task - +

    A task that represents the asynchronous removal operation.

    + @@ -595,7 +623,8 @@ webhook.

    DeleteMessagesAsync(IEnumerable<IMessage>, RequestOptions)

    -
    +

    Bulk-deletes multiple messages.

    +
    Declaration
    @@ -614,12 +643,14 @@ webhook.

    System.Collections.Generic.IEnumerable<IMessage> messages - +

    The messages to be bulk-deleted.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -634,10 +665,17 @@ webhook.

    System.Threading.Tasks.Task - +

    A task that represents the asynchronous bulk-removal operation.

    + +
    Remarks
    +

    This method attempts to remove the messages specified in bulk.

    +
    important

    + Due to the limitation set by Discord, this method can only remove messages that are posted within 14 days! +

    +
    | Improve this Doc @@ -647,7 +685,8 @@ webhook.

    DeleteMessagesAsync(IEnumerable<UInt64>, RequestOptions)

    -
    +

    Bulk-deletes multiple messages.

    +
    Declaration
    @@ -666,12 +705,14 @@ webhook.

    System.Collections.Generic.IEnumerable<System.UInt64> messageIds - +

    The snowflake identifier of the messages to be bulk-deleted.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -686,10 +727,17 @@ webhook.

    System.Threading.Tasks.Task - +

    A task that represents the asynchronous bulk-removal operation.

    + +
    Remarks
    +

    This method attempts to remove the messages specified in bulk.

    +
    important

    + Due to the limitation set by Discord, this method can only remove messages that are posted within 14 days! +

    +
    | Improve this Doc @@ -699,7 +747,9 @@ webhook.

    EnterTypingState(RequestOptions)

    -
    +

    Continuously broadcasts the "user is typing" message to all users in this channel until the returned +object is disposed.

    +
    Declaration
    @@ -718,7 +768,8 @@ webhook.

    RequestOptions options - +

    The options to be used when sending the request.

    + @@ -733,7 +784,9 @@ webhook.

    System.IDisposable - +

    A disposable object that, upon its disposal, will stop the client from broadcasting its typing state in +this channel.

    + @@ -797,7 +850,8 @@ representing the parent of this channel; null if none is set.

    GetInvitesAsync(RequestOptions)

    -
    +

    Gets a collection of all invites to this channel.

    +
    Declaration
    @@ -816,7 +870,8 @@ representing the parent of this channel; null if none is set.

    RequestOptions options - +

    The options to be used when sending the request.

    + @@ -831,7 +886,9 @@ representing the parent of this channel; null if none is set.

    System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyCollection<IInviteMetadata>> - +

    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.

    + @@ -844,7 +901,8 @@ representing the parent of this channel; null if none is set.

    GetMessageAsync(UInt64, RequestOptions)

    -
    +

    Gets a message from this message channel.

    +
    Declaration
    @@ -863,12 +921,14 @@ representing the parent of this channel; null if none is set.

    System.UInt64 id - +

    The snowflake identifier of the message.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -883,10 +943,16 @@ representing the parent of this channel; null if none is set.

    System.Threading.Tasks.Task<RestMessage> - +

    A task that represents an asynchronous get operation for retrieving the message. The task result contains +the retrieved message; null if no message is found with the specified identifier.

    + +
    Remarks
    +

    This method follows the same behavior as described in GetMessageAsync(UInt64, CacheMode, RequestOptions). +Please visit its documentation for more details on this method.

    +
    | Improve this Doc @@ -896,7 +962,8 @@ representing the parent of this channel; null if none is set.

    GetMessagesAsync(IMessage, Direction, Int32, RequestOptions)

    -
    +

    Gets a collection of messages in this channel.

    +
    Declaration
    @@ -915,22 +982,26 @@ representing the parent of this channel; null if none is set.

    IMessage fromMessage - +

    The starting message to get the messages from.

    + Direction dir - +

    The direction of the messages to be gotten from.

    + System.Int32 limit - +

    The numbers of message to be gotten from.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -945,10 +1016,15 @@ representing the parent of this channel; null if none is set.

    System.Collections.Generic.IAsyncEnumerable<System.Collections.Generic.IReadOnlyCollection<RestMessage>> - +

    Paged collection of messages.

    + +
    Remarks
    +

    This method follows the same behavior as described in GetMessagesAsync(IMessage, Direction, Int32, CacheMode, RequestOptions). +Please visit its documentation for more details on this method.

    +
    | Improve this Doc @@ -958,7 +1034,8 @@ representing the parent of this channel; null if none is set.

    GetMessagesAsync(Int32, RequestOptions)

    -
    +

    Gets the last N messages from this message channel.

    +
    Declaration
    @@ -977,12 +1054,14 @@ representing the parent of this channel; null if none is set.

    System.Int32 limit - +

    The numbers of message to be gotten from.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -997,10 +1076,15 @@ representing the parent of this channel; null if none is set.

    System.Collections.Generic.IAsyncEnumerable<System.Collections.Generic.IReadOnlyCollection<RestMessage>> - +

    Paged collection of messages.

    + +
    Remarks
    +

    This method follows the same behavior as described in GetMessagesAsync(Int32, CacheMode, RequestOptions). +Please visit its documentation for more details on this method.

    +
    | Improve this Doc @@ -1010,7 +1094,8 @@ representing the parent of this channel; null if none is set.

    GetMessagesAsync(UInt64, Direction, Int32, RequestOptions)

    -
    +

    Gets a collection of messages in this channel.

    +
    Declaration
    @@ -1029,22 +1114,26 @@ representing the parent of this channel; null if none is set.

    System.UInt64 fromMessageId - +

    The ID of the starting message to get the messages from.

    + Direction dir - +

    The direction of the messages to be gotten from.

    + System.Int32 limit - +

    The numbers of message to be gotten from.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -1059,10 +1148,15 @@ representing the parent of this channel; null if none is set.

    System.Collections.Generic.IAsyncEnumerable<System.Collections.Generic.IReadOnlyCollection<RestMessage>> - +

    Paged collection of messages.

    + +
    Remarks
    +

    This method follows the same behavior as described in GetMessagesAsync(UInt64, Direction, Int32, CacheMode, RequestOptions). +Please visit its documentation for more details on this method.

    +
    | Improve this Doc @@ -1072,7 +1166,8 @@ representing the parent of this channel; null if none is set.

    GetPinnedMessagesAsync(RequestOptions)

    -
    +

    Gets a collection of pinned messages in this channel.

    +
    Declaration
    @@ -1091,7 +1186,8 @@ representing the parent of this channel; null if none is set.

    RequestOptions options - +

    The options to be used when sending the request.

    + @@ -1106,10 +1202,16 @@ representing the parent of this channel; null if none is set.

    System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyCollection<RestMessage>> - +

    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.

    + +
    Remarks
    +

    This method follows the same behavior as described in GetPinnedMessagesAsync(RequestOptions). +Please visit its documentation for more details on this method.

    +
    | Improve this Doc @@ -1368,7 +1470,8 @@ of webhooks that is available in this channel.

    ModifyAsync(Action<TextChannelProperties>, RequestOptions)

    -
    +

    Modifies this text channel.

    +
    Declaration
    @@ -1387,12 +1490,14 @@ of webhooks that is available in this channel.

    System.Action<TextChannelProperties> func - +

    The delegate containing the properties to modify the channel with.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -1407,10 +1512,15 @@ of webhooks that is available in this channel.

    System.Threading.Tasks.Task - +

    A task that represents the asynchronous modification operation.

    + +
    See Also
    +
    + +
    | Improve this Doc @@ -1420,7 +1530,8 @@ of webhooks that is available in this channel.

    SendFileAsync(Stream, String, String, Boolean, Embed, RequestOptions, Boolean)

    -
    +

    Sends a file to this message channel with an optional caption.

    +
    Declaration
    @@ -1439,32 +1550,38 @@ of webhooks that is available in this channel.

    System.IO.Stream stream - +

    The System.IO.Stream of the file to be sent.

    + System.String filename - +

    The name of the attachment.

    + System.String text - +

    The message to be sent.

    + System.Boolean isTTS - +

    Whether the message should be read aloud by Discord or not.

    + Embed embed - +

    The Rich Embed to be sent.

    + RequestOptions options - +

    The options to be used when sending the request.

    + System.Boolean @@ -1484,10 +1601,16 @@ of webhooks that is available in this channel.

    System.Threading.Tasks.Task<RestUserMessage> - +

    A task that represents an asynchronous send operation for delivering the message. The task result +contains the sent message.

    + +
    Remarks
    +

    This method follows the same behavior as described in SendFileAsync(Stream, String, String, Boolean, Embed, RequestOptions, Boolean). +Please visit its documentation for more details on this method.

    +
    Exceptions
    @@ -1513,7 +1636,8 @@ of webhooks that is available in this channel.

    SendFileAsync(String, String, Boolean, Embed, RequestOptions, Boolean)

    -
    +

    Sends a file to this message channel with an optional caption.

    +
    Declaration
    @@ -1532,27 +1656,32 @@ of webhooks that is available in this channel.

    - + - + - + - + - + @@ -1572,10 +1701,17 @@ of webhooks that is available in this channel.

    - +
    System.String filePath

    The file path of the file.

    +
    System.String text

    The message to be sent.

    +
    System.Boolean isTTS

    Whether the message should be read aloud by Discord or not.

    +
    Embed embed

    The Rich Embed to be sent.

    +
    RequestOptions options

    The options to be used when sending the request.

    +
    System.Boolean
    System.Threading.Tasks.Task<RestUserMessage>

    A task that represents an asynchronous send operation for delivering the message. The task result +contains the sent message.

    +
    +
    Remarks
    +

    This method follows the same behavior as described in +SendFileAsync(String, String, Boolean, Embed, RequestOptions, Boolean). Please visit +its documentation for more details on this method.

    +
    Exceptions
    @@ -1644,7 +1780,8 @@ characters.

    SendMessageAsync(String, Boolean, Embed, RequestOptions)

    -
    +

    Sends a message to this message channel.

    +
    Declaration
    @@ -1663,22 +1800,26 @@ characters.

    - + - + - + - +
    System.String text

    The message to be sent.

    +
    System.Boolean isTTS

    Determines whether the message should be read aloud by Discord or not.

    +
    Embed embed

    The Rich Embed to be sent.

    +
    RequestOptions options

    The options to be used when sending the request.

    +
    @@ -1693,10 +1834,16 @@ characters.

    System.Threading.Tasks.Task<RestUserMessage> - +

    A task that represents an asynchronous send operation for delivering the message. The task result +contains the sent message.

    + +
    Remarks
    +

    This method follows the same behavior as described in SendMessageAsync(String, Boolean, Embed, RequestOptions). +Please visit its documentation for more details on this method.

    +
    Exceptions
    @@ -1722,7 +1869,8 @@ characters.

    SyncPermissionsAsync(RequestOptions)

    -
    +

    Syncs the permissions of this nested channel with its parent's.

    +
    Declaration
    @@ -1741,7 +1889,8 @@ characters.

    - +
    RequestOptions options

    The options to be used when sending the request.

    +
    @@ -1756,7 +1905,8 @@ characters.

    System.Threading.Tasks.Task - +

    A task that represents the asynchronous operation for syncing channel permissions with its parent's.

    + @@ -1769,7 +1919,8 @@ characters.

    TriggerTypingAsync(RequestOptions)

    -
    +

    Broadcasts the "user is typing" message to all users in this channel, lasting 10 seconds.

    +
    Declaration
    @@ -1788,7 +1939,8 @@ characters.

    RequestOptions options - +

    The options to be used when sending the request.

    + @@ -1803,7 +1955,8 @@ characters.

    System.Threading.Tasks.Task - +

    A task that represents the asynchronous operation that triggers the broadcast.

    + @@ -1818,7 +1971,8 @@ characters.

    IChannel.GetUserAsync(UInt64, CacheMode, RequestOptions)

    -
    +

    Gets a user in this channel.

    +
    Declaration
    @@ -1837,17 +1991,20 @@ characters.

    System.UInt64 id - +

    The snowflake identifier of the user (e.g. 168693960628371456).

    + CacheMode mode - +

    The CacheMode that determines whether the object should be fetched from cache.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -1862,7 +2019,9 @@ characters.

    System.Threading.Tasks.Task<IUser> - +

    A task that represents the asynchronous get operation. The task result contains a user object that +represents the found user; null if none is found.

    + @@ -1875,7 +2034,8 @@ characters.

    IChannel.GetUsersAsync(CacheMode, RequestOptions)

    -
    +

    Gets a collection of users that are able to view the channel or are currently in this channel.

    +
    Declaration
    @@ -1894,12 +2054,14 @@ characters.

    CacheMode mode - +

    The CacheMode that determines whether the object should be fetched from cache.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -1914,10 +2076,23 @@ characters.

    System.Collections.Generic.IAsyncEnumerable<System.Collections.Generic.IReadOnlyCollection<IUser>> - +

    Paged collection of users.

    + +
    Remarks
    +
    important

    + The returned collection is an asynchronous enumerable object; one must call +FlattenAsync<T>(IAsyncEnumerable<IEnumerable<T>>) to access the individual messages as a +collection. +

    +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 MaxUsersPerBatch. +In other words, if there are 3000 users, and the MaxUsersPerBatch constant +is 1000, the request will be split into 3 individual requests; thus returning 53individual asynchronous +responses, hence the need of flattening. +
    | Improve this Doc @@ -1927,7 +2102,8 @@ characters.

    IGuildChannel.GetUserAsync(UInt64, CacheMode, RequestOptions)

    -
    +

    Gets a user in this channel.

    +
    Declaration
    @@ -1946,17 +2122,20 @@ characters.

    System.UInt64 id - +

    The snowflake identifier of the user.

    + CacheMode mode - +

    The CacheMode that determines whether the object should be fetched from cache.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -1971,7 +2150,9 @@ characters.

    System.Threading.Tasks.Task<IGuildUser> - +

    A task representing the asynchronous get operation. The task result contains a guild user object that +represents the user; null if none is found.

    + @@ -1984,7 +2165,8 @@ characters.

    IGuildChannel.GetUsersAsync(CacheMode, RequestOptions)

    -
    +

    Gets a collection of users that are able to view the channel or are currently in this channel.

    +
    Declaration
    @@ -2003,12 +2185,14 @@ characters.

    CacheMode mode - +

    The CacheMode that determines whether the object should be fetched from cache.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -2023,10 +2207,15 @@ characters.

    System.Collections.Generic.IAsyncEnumerable<System.Collections.Generic.IReadOnlyCollection<IGuildUser>> - +

    Paged collection of users.

    + +
    Remarks
    +

    This method follows the same behavior as described in GetUsersAsync(CacheMode, RequestOptions). +Please visit its documentation for more details on this method.

    +
    | Improve this Doc @@ -2036,7 +2225,8 @@ characters.

    IMessageChannel.GetMessageAsync(UInt64, CacheMode, RequestOptions)

    -
    +

    Gets a message from this message channel.

    +
    Declaration
    @@ -2055,17 +2245,20 @@ characters.

    System.UInt64 id - +

    The snowflake identifier of the message.

    + CacheMode mode - +

    The CacheMode that determines whether the object should be fetched from cache.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -2080,7 +2273,9 @@ characters.

    System.Threading.Tasks.Task<IMessage> - +

    A task that represents an asynchronous get operation for retrieving the message. The task result contains +the retrieved message; null if no message is found with the specified identifier.

    + @@ -2093,7 +2288,8 @@ characters.

    IMessageChannel.GetMessagesAsync(IMessage, Direction, Int32, CacheMode, RequestOptions)

    -
    +

    Gets a collection of messages in this channel.

    +
    Declaration
    @@ -2112,27 +2308,33 @@ characters.

    IMessage fromMessage - +

    The starting message to get the messages from.

    + Direction dir - +

    The direction of the messages to be gotten from.

    + System.Int32 limit - +

    The numbers of message to be gotten from.

    + CacheMode mode - +

    The CacheMode that determines whether the object should be fetched from +cache.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -2147,10 +2349,29 @@ characters.

    System.Collections.Generic.IAsyncEnumerable<System.Collections.Generic.IReadOnlyCollection<IMessage>> - +

    Paged collection of messages.

    + +
    Remarks
    +
    important

    + The returned collection is an asynchronous enumerable object; one must call +FlattenAsync<T>(IAsyncEnumerable<IEnumerable<T>>) to access the individual messages as a +collection. +

    +
    warning

    + Do not fetch too many messages at once! This may cause unwanted preemptive rate limit or even actual + rate limit, causing your bot to freeze! +

    +This method will attempt to fetch the number of messages specified under limit around +the message fromMessage depending on the dir. The library will +attempt to split up the requests according to your limit and +MaxMessagesPerBatch. In other words, should the user request 500 messages, +and the MaxMessagesPerBatch constant is 100, the request will +be split into 5 individual requests; thus returning 5 individual asynchronous responses, hence the need +of flattening. +
    | Improve this Doc @@ -2160,7 +2381,8 @@ characters.

    IMessageChannel.GetMessagesAsync(Int32, CacheMode, RequestOptions)

    -
    +

    Gets the last N messages from this message channel.

    +
    Declaration
    @@ -2179,17 +2401,21 @@ characters.

    System.Int32 limit - +

    The numbers of message to be gotten from.

    + CacheMode mode - +

    The CacheMode that determines whether the object should be fetched from +cache.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -2204,10 +2430,28 @@ characters.

    System.Collections.Generic.IAsyncEnumerable<System.Collections.Generic.IReadOnlyCollection<IMessage>> - +

    Paged collection of messages.

    + +
    Remarks
    +
    important

    + The returned collection is an asynchronous enumerable object; one must call +FlattenAsync<T>(IAsyncEnumerable<IEnumerable<T>>) to access the individual messages as a +collection. +

    +
    warning

    + Do not fetch too many messages at once! This may cause unwanted preemptive rate limit or even actual + rate limit, causing your bot to freeze! +

    +This method will attempt to fetch the number of messages specified under limit. The +library will attempt to split up the requests according to your limit and +MaxMessagesPerBatch. In other words, should the user request 500 messages, +and the MaxMessagesPerBatch constant is 100, the request will +be split into 5 individual requests; thus returning 5 individual asynchronous responses, hence the need +of flattening. +
    | Improve this Doc @@ -2217,7 +2461,8 @@ characters.

    IMessageChannel.GetMessagesAsync(UInt64, Direction, Int32, CacheMode, RequestOptions)

    -
    +

    Gets a collection of messages in this channel.

    +
    Declaration
    @@ -2236,27 +2481,33 @@ characters.

    System.UInt64 fromMessageId - +

    The ID of the starting message to get the messages from.

    + Direction dir - +

    The direction of the messages to be gotten from.

    + System.Int32 limit - +

    The numbers of message to be gotten from.

    + CacheMode mode - +

    The CacheMode that determines whether the object should be fetched from +cache.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -2271,10 +2522,29 @@ characters.

    System.Collections.Generic.IAsyncEnumerable<System.Collections.Generic.IReadOnlyCollection<IMessage>> - +

    Paged collection of messages.

    + +
    Remarks
    +
    important

    + The returned collection is an asynchronous enumerable object; one must call +FlattenAsync<T>(IAsyncEnumerable<IEnumerable<T>>) to access the individual messages as a +collection. +

    +
    warning

    + Do not fetch too many messages at once! This may cause unwanted preemptive rate limit or even actual + rate limit, causing your bot to freeze! +

    +This method will attempt to fetch the number of messages specified under limit around +the message fromMessageId depending on the dir. The library will +attempt to split up the requests according to your limit and +MaxMessagesPerBatch. In other words, should the user request 500 messages, +and the MaxMessagesPerBatch constant is 100, the request will +be split into 5 individual requests; thus returning 5 individual asynchronous responses, hence the need +of flattening. +
    | Improve this Doc @@ -2284,7 +2554,8 @@ characters.

    IMessageChannel.GetPinnedMessagesAsync(RequestOptions)

    -
    +

    Gets a collection of pinned messages in this channel.

    +
    Declaration
    @@ -2303,7 +2574,8 @@ characters.

    RequestOptions options - +

    The options to be used when sending the request.

    + @@ -2318,7 +2590,9 @@ characters.

    System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyCollection<IMessage>> - +

    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.

    + @@ -2331,7 +2605,8 @@ characters.

    IMessageChannel.SendFileAsync(Stream, String, String, Boolean, Embed, RequestOptions, Boolean)

    -
    +

    Sends a file to this message channel with an optional caption.

    +
    Declaration
    @@ -2350,37 +2625,44 @@ characters.

    System.IO.Stream stream - +

    The System.IO.Stream of the file to be sent.

    + System.String filename - +

    The name of the attachment.

    + System.String text - +

    The message to be sent.

    + System.Boolean isTTS - +

    Whether the message should be read aloud by Discord or not.

    + Embed embed - +

    The Rich Embed to be sent.

    + RequestOptions options - +

    The options to be used when sending the request.

    + System.Boolean isSpoiler - +

    Whether the message attachment should be hidden as a spoiler.

    + @@ -2395,10 +2677,20 @@ characters.

    System.Threading.Tasks.Task<IUserMessage> - +

    A task that represents an asynchronous send operation for delivering the message. The task result +contains the sent message.

    + +
    Remarks
    +

    This method sends a file as if you are uploading an attachment directly from your Discord client.

    +
    note

    + If you wish to upload an image and have it embedded in a Rich embed, + you may upload the file and refer to the file with "attachment://filename.ext" in the +ImageUrl. See the example section for its usage. +

    +
    | Improve this Doc @@ -2408,7 +2700,8 @@ characters.

    IMessageChannel.SendFileAsync(String, String, Boolean, Embed, RequestOptions, Boolean)

    -
    +

    Sends a file to this message channel with an optional caption.

    +
    Declaration
    @@ -2427,32 +2720,38 @@ characters.

    System.String filePath - +

    The file path of the file.

    + System.String text - +

    The message to be sent.

    + System.Boolean isTTS - +

    Whether the message should be read aloud by Discord or not.

    + Embed embed - +

    The Rich Embed to be sent.

    + RequestOptions options - +

    The options to be used when sending the request.

    + System.Boolean isSpoiler - +

    Whether the message attachment should be hidden as a spoiler.

    + @@ -2467,10 +2766,20 @@ characters.

    System.Threading.Tasks.Task<IUserMessage> - +

    A task that represents an asynchronous send operation for delivering the message. The task result +contains the sent message.

    + +
    Remarks
    +

    This method sends a file as if you are uploading an attachment directly from your Discord client.

    +
    note

    + If you wish to upload an image and have it embedded in a Rich embed, + you may upload the file and refer to the file with "attachment://filename.ext" in the +ImageUrl. See the example section for its usage. +

    +
    | Improve this Doc @@ -2480,7 +2789,8 @@ characters.

    IMessageChannel.SendMessageAsync(String, Boolean, Embed, RequestOptions)

    -
    +

    Sends a message to this message channel.

    +
    Declaration
    @@ -2499,22 +2809,26 @@ characters.

    System.String text - +

    The message to be sent.

    + System.Boolean isTTS - +

    Determines whether the message should be read aloud by Discord or not.

    + Embed embed - +

    The Rich Embed to be sent.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -2529,7 +2843,9 @@ characters.

    System.Threading.Tasks.Task<IUserMessage> - +

    A task that represents an asynchronous send operation for delivering the message. The task result +contains the sent message.

    + @@ -2542,7 +2858,8 @@ characters.

    INestedChannel.GetCategoryAsync(CacheMode, RequestOptions)

    -
    +

    Gets the parent (category) channel of this channel.

    +
    Declaration
    @@ -2561,12 +2878,14 @@ characters.

    CacheMode mode - +

    The CacheMode that determines whether the object should be fetched from cache.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -2581,7 +2900,9 @@ characters.

    System.Threading.Tasks.Task<ICategoryChannel> - +

    A task that represents the asynchronous get operation. The task result contains the category channel +representing the parent of this channel; null if none is set.

    + @@ -2594,7 +2915,8 @@ characters.

    ITextChannel.CreateWebhookAsync(String, Stream, RequestOptions)

    -
    +

    Creates a webhook in this text channel.

    +
    Declaration
    @@ -2613,17 +2935,20 @@ characters.

    System.String name - +

    The name of the webhook.

    + System.IO.Stream avatar - +

    The avatar of the webhook.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -2638,7 +2963,9 @@ characters.

    System.Threading.Tasks.Task<IWebhook> - +

    A task that represents the asynchronous creation operation. The task result contains the newly created +webhook.

    + @@ -2651,7 +2978,8 @@ characters.

    ITextChannel.GetWebhookAsync(UInt64, RequestOptions)

    -
    +

    Gets a webhook available in this text channel.

    +
    Declaration
    @@ -2670,12 +2998,14 @@ characters.

    System.UInt64 id - +

    The identifier of the webhook.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -2690,7 +3020,9 @@ characters.

    System.Threading.Tasks.Task<IWebhook> - +

    A task that represents the asynchronous get operation. The task result contains a webhook associated +with the identifier; null if the webhook is not found.

    + @@ -2703,7 +3035,8 @@ characters.

    ITextChannel.GetWebhooksAsync(RequestOptions)

    -
    +

    Gets the webhooks available in this text channel.

    +
    Declaration
    @@ -2722,7 +3055,8 @@ characters.

    RequestOptions options - +

    The options to be used when sending the request.

    + @@ -2737,7 +3071,9 @@ characters.

    System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyCollection<IWebhook>> - +

    A task that represents the asynchronous get operation. The task result contains a read-only collection +of webhooks that is available in this channel.

    + diff --git a/docs/api/Discord.Rest.RestUser.html b/docs/api/Discord.Rest.RestUser.html index f223ee7b5..c0d3b06b9 100644 --- a/docs/api/Discord.Rest.RestUser.html +++ b/docs/api/Discord.Rest.RestUser.html @@ -136,7 +136,8 @@

    ActiveClients

    -
    +

    Gets the set of clients where this user is currently active.

    +
    Declaration
    @@ -166,7 +167,8 @@

    Activity

    -
    +

    Gets the activity this user is currently doing.

    +
    Declaration
    @@ -196,7 +198,8 @@

    AvatarId

    -
    +

    Gets the identifier of this user's avatar.

    +
    Declaration
    @@ -226,7 +229,8 @@

    CreatedAt

    -
    +

    Gets when the snowflake was created.

    +
    Declaration
    @@ -243,7 +247,8 @@ System.DateTimeOffset - +

    A System.DateTimeOffset representing when the entity was first created.

    + @@ -256,7 +261,8 @@

    Discriminator

    -
    +

    Gets the per-username unique ID for this user.

    +
    Declaration
    @@ -286,7 +292,8 @@

    DiscriminatorValue

    -
    +

    Gets the per-username unique ID for this user.

    +
    Declaration
    @@ -316,7 +323,8 @@

    IsBot

    -
    +

    Gets a value that indicates whether this user is identified as a bot.

    +
    Declaration
    @@ -333,10 +341,15 @@ System.Boolean - +

    true if the user is a bot application; otherwise false.

    + +
    Remarks
    +

    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).

    +
    | Improve this Doc @@ -346,7 +359,8 @@

    IsWebhook

    -
    +

    Gets a value that indicates whether this user is a webhook user.

    +
    Declaration
    @@ -363,7 +377,8 @@ System.Boolean - +

    true if the user is a webhook; otherwise false.

    + @@ -376,7 +391,8 @@

    Mention

    -
    +

    Returns a special string used to mention this object.

    +
    Declaration
    @@ -393,7 +409,8 @@ System.String - +

    A string that is recognized by Discord as a mention (e.g. <@168693960628371456>).

    + @@ -406,7 +423,8 @@

    Status

    -
    +

    Gets the current status of this user.

    +
    Declaration
    @@ -436,7 +454,8 @@

    Username

    -
    +

    Gets the username for this user.

    +
    Declaration
    @@ -468,7 +487,8 @@

    GetAvatarUrl(ImageFormat, UInt16)

    -
    +

    Gets the avatar URL for this user.

    +
    Declaration
    @@ -487,12 +507,14 @@ ImageFormat format - +

    The format to return.

    + System.UInt16 size - +

    The size of the image to return in. This can be any power of two between 16 and 2048.

    + @@ -507,10 +529,17 @@ System.String - +

    A string representing the user's avatar URL; null if the user does not have an avatar in place.

    + +
    Remarks
    +

    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 null. If you wish to +retrieve the default avatar for this user, consider using GetDefaultAvatarUrl() (see +example).

    +
    | Improve this Doc @@ -520,7 +549,8 @@

    GetDefaultAvatarUrl()

    -
    +

    Gets the default avatar URL for this user.

    +
    Declaration
    @@ -537,10 +567,16 @@ System.String - +

    A string representing the user's avatar URL.

    + +
    Remarks
    +

    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 DiscriminatorValue (discriminator % 5).

    +
    | Improve this Doc @@ -634,7 +670,8 @@

    UpdateAsync(RequestOptions)

    -
    +

    Updates this object's properties with its current state.

    +
    Declaration
    @@ -683,7 +720,8 @@

    IUser.GetOrCreateDMChannelAsync(RequestOptions)

    -
    +

    Gets the direct message channel of this user, or create one if it does not already exist.

    +
    Declaration
    @@ -702,7 +740,8 @@ RequestOptions options - +

    The options to be used when sending the request.

    + @@ -717,10 +756,22 @@ System.Threading.Tasks.Task<IDMChannel> - +

    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.

    + +
    Remarks
    +

    This method is used to obtain or create a channel used to send a direct message.

    +
    warning

    + 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 +Discord.Net.HttpException with a 403 as its +Discord.Net.HttpException.HttpCode. There are currently no official workarounds by +Discord. +

    +

    Implements

    IUser diff --git a/docs/api/Discord.Rest.RestUserGuild.html b/docs/api/Discord.Rest.RestUserGuild.html index 2c5730df2..b9c8015d1 100644 --- a/docs/api/Discord.Rest.RestUserGuild.html +++ b/docs/api/Discord.Rest.RestUserGuild.html @@ -129,7 +129,8 @@

    CreatedAt

    -
    +

    Gets when the snowflake was created.

    +
    Declaration
    @@ -146,7 +147,8 @@ System.DateTimeOffset - +

    A System.DateTimeOffset representing when the entity was first created.

    + @@ -159,7 +161,8 @@

    IconUrl

    -
    +

    Gets the icon URL associated with this guild, or null if one is not set.

    +
    Declaration
    @@ -189,7 +192,8 @@

    IsOwner

    -
    +

    Returns true if the current user owns this guild.

    +
    Declaration
    @@ -219,7 +223,8 @@

    Name

    -
    +

    Gets the name of this guild.

    +
    Declaration
    @@ -249,7 +254,8 @@

    Permissions

    -
    +

    Returns the current user's permissions for this guild.

    +
    Declaration
    @@ -281,7 +287,8 @@

    DeleteAsync(RequestOptions)

    -
    +

    Deletes this object and all its children.

    +
    Declaration
    @@ -300,7 +307,8 @@ RequestOptions options - +

    The options to be used when sending the request.

    + diff --git a/docs/api/Discord.Rest.RestUserMessage.html b/docs/api/Discord.Rest.RestUserMessage.html index 1303ce8bc..5aa0258f0 100644 --- a/docs/api/Discord.Rest.RestUserMessage.html +++ b/docs/api/Discord.Rest.RestUserMessage.html @@ -202,7 +202,8 @@

    Attachments

    -
    +

    Gets a collection of the Attachment's on the message.

    +
    Declaration
    @@ -234,7 +235,8 @@

    EditedTimestamp

    -
    +

    Gets the time of this message's last edit.

    +
    Declaration
    @@ -251,7 +253,8 @@ System.Nullable<System.DateTimeOffset> - +

    Time of when the message was last edited; null if the message is never edited.

    + @@ -266,7 +269,8 @@

    Embeds

    -
    +

    Gets a collection of the Embed's on the message.

    +
    Declaration
    @@ -298,7 +302,8 @@

    IsPinned

    -
    +

    Gets the value that indicates whether this message is pinned.

    +
    Declaration
    @@ -315,7 +320,8 @@ System.Boolean - +

    true if this message was added to its channel's pinned messages; otherwise false.

    + @@ -330,7 +336,8 @@

    IsSuppressed

    -
    +

    Gets the value that indicates whether or not this message's embeds are suppressed.

    +
    Declaration
    @@ -347,7 +354,8 @@ System.Boolean - +

    true if the embeds in this message have been suppressed (made invisible); otherwise false.

    + @@ -362,7 +370,8 @@

    IsTTS

    -
    +

    Gets the value that indicates whether this message was meant to be read-aloud by Discord.

    +
    Declaration
    @@ -379,7 +388,8 @@ System.Boolean - +

    true if this message was sent as a text-to-speech message; otherwise false.

    + @@ -394,7 +404,8 @@

    MentionedChannelIds

    -
    +

    Gets the IDs of channels mentioned in this message.

    +
    Declaration
    @@ -411,7 +422,8 @@ System.Collections.Generic.IReadOnlyCollection<System.UInt64> - +

    A read-only collection of channel IDs.

    + @@ -426,7 +438,8 @@

    MentionedRoleIds

    -
    +

    Gets the IDs of roles mentioned in this message.

    +
    Declaration
    @@ -443,7 +456,8 @@ System.Collections.Generic.IReadOnlyCollection<System.UInt64> - +

    A read-only collection of role IDs.

    + @@ -458,7 +472,8 @@

    MentionedUsers

    -
    +

    Gets a collection of the mentioned users in the message.

    +
    Declaration
    @@ -490,7 +505,8 @@

    Tags

    -
    +

    Gets all tags included in this message's content.

    +
    Declaration
    @@ -524,7 +540,8 @@

    ModifyAsync(Action<MessageProperties>, RequestOptions)

    -
    +

    Modifies this message.

    +
    Declaration
    @@ -543,12 +560,14 @@ System.Action<MessageProperties> func - +

    A delegate containing the properties to modify the message with.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -563,10 +582,15 @@ System.Threading.Tasks.Task - +

    A task that represents the asynchronous modification operation.

    + +
    Remarks
    +

    This method modifies this message with the specified properties. To see an example of this +method and what properties are available, please refer to MessageProperties.

    +
    | Improve this Doc @@ -576,7 +600,8 @@

    ModifySuppressionAsync(Boolean, RequestOptions)

    -
    +

    Modifies the suppression of this message.

    +
    Declaration
    @@ -595,12 +620,14 @@ System.Boolean suppressEmbeds - +

    Whether or not embeds in this message should be suppressed.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -615,10 +642,14 @@ System.Threading.Tasks.Task - +

    A task that represents the asynchronous modification operation.

    + +
    Remarks
    +

    This method modifies whether or not embeds in this message are suppressed (hidden).

    +
    | Improve this Doc @@ -628,7 +659,8 @@

    PinAsync(RequestOptions)

    -
    +

    Adds this message to its channel's pinned messages.

    +
    Declaration
    @@ -647,7 +679,8 @@ RequestOptions options - +

    The options to be used when sending the request.

    + @@ -662,7 +695,8 @@ System.Threading.Tasks.Task - +

    A task that represents the asynchronous operation for pinning this message.

    + @@ -675,7 +709,8 @@

    Resolve(TagHandling, TagHandling, TagHandling, TagHandling, TagHandling)

    -
    +

    Transforms this message's text into a human-readable form by resolving its tags.

    +
    Declaration
    @@ -694,27 +729,32 @@ TagHandling userHandling - +

    Determines how the user tag should be handled.

    + TagHandling channelHandling - +

    Determines how the channel tag should be handled.

    + TagHandling roleHandling - +

    Determines how the role tag should be handled.

    + TagHandling everyoneHandling - +

    Determines how the @everyone tag should be handled.

    + TagHandling emojiHandling - +

    Determines how the emoji tag should be handled.

    + @@ -814,7 +854,8 @@

    UnpinAsync(RequestOptions)

    -
    +

    Removes this message from its channel's pinned messages.

    +
    Declaration
    @@ -833,7 +874,8 @@ RequestOptions options - +

    The options to be used when sending the request.

    + @@ -848,7 +890,8 @@ System.Threading.Tasks.Task - +

    A task that represents the asynchronous operation for unpinning this message.

    + diff --git a/docs/api/Discord.Rest.RestVoiceChannel.html b/docs/api/Discord.Rest.RestVoiceChannel.html index 9b25810f9..4578c1140 100644 --- a/docs/api/Discord.Rest.RestVoiceChannel.html +++ b/docs/api/Discord.Rest.RestVoiceChannel.html @@ -213,7 +213,8 @@

    Bitrate

    -
    +

    Gets the bit-rate that the clients in this voice channel are requested to use.

    +
    Declaration
    @@ -230,7 +231,9 @@ System.Int32 - +

    An System.Int32 representing the bit-rate (bps) that this voice channel defines and requests the +client(s) to use.

    + @@ -243,7 +246,8 @@

    CategoryId

    -
    +

    Gets the parent (category) ID of this channel in the guild's channel list.

    +
    Declaration
    @@ -260,7 +264,9 @@ System.Nullable<System.UInt64> - +

    A System.UInt64 representing the snowflake identifier of the parent of this channel; +null if none is set.

    + @@ -273,7 +279,8 @@

    UserLimit

    -
    +

    Gets the max number of users allowed to be connected to this channel at once.

    +
    Declaration
    @@ -290,7 +297,9 @@ System.Nullable<System.Int32> - +

    An System.Int32 representing the maximum number of users that are allowed to be connected to this +channel at once; null if a limit is not set.

    + @@ -305,7 +314,8 @@

    CreateInviteAsync(Nullable<Int32>, Nullable<Int32>, Boolean, Boolean, RequestOptions)

    -
    +

    Creates a new invite to this channel.

    +
    Declaration
    @@ -324,27 +334,32 @@ System.Nullable<System.Int32> maxAge - +

    The time (in seconds) until the invite expires. Set to null to never expire.

    + System.Nullable<System.Int32> maxUses - +

    The max amount of times this invite may be used. Set to null to have unlimited uses.

    + System.Boolean isTemporary - +

    If true, the user accepting this invite will be kicked from the guild after closing their client.

    + System.Boolean isUnique - +

    If true, don't try to reuse a similar invite (useful for creating many unique one time use invites).

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -359,7 +374,9 @@ System.Threading.Tasks.Task<IInviteMetadata> - +

    A task that represents the asynchronous invite creation operation. The task result contains an invite +metadata object containing information for the created invite.

    + @@ -423,7 +440,8 @@ representing the parent of this channel; null if none is set.

    GetInvitesAsync(RequestOptions)

    -
    +

    Gets a collection of all invites to this channel.

    +
    Declaration
    @@ -442,7 +460,8 @@ representing the parent of this channel; null if none is set.

    RequestOptions options - +

    The options to be used when sending the request.

    + @@ -457,7 +476,9 @@ representing the parent of this channel; null if none is set.

    System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyCollection<IInviteMetadata>> - +

    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.

    + @@ -470,7 +491,8 @@ representing the parent of this channel; null if none is set.

    ModifyAsync(Action<VoiceChannelProperties>, RequestOptions)

    -
    +

    Modifies this voice channel.

    +
    Declaration
    @@ -489,12 +511,14 @@ representing the parent of this channel; null if none is set.

    System.Action<VoiceChannelProperties> func - +

    The properties to modify the channel with.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -509,10 +533,15 @@ representing the parent of this channel; null if none is set.

    System.Threading.Tasks.Task - +

    A task that represents the asynchronous modification operation.

    + +
    See Also
    +
    + +
    | Improve this Doc @@ -522,7 +551,8 @@ representing the parent of this channel; null if none is set.

    SyncPermissionsAsync(RequestOptions)

    -
    +

    Syncs the permissions of this nested channel with its parent's.

    +
    Declaration
    @@ -541,7 +571,8 @@ representing the parent of this channel; null if none is set.

    RequestOptions options - +

    The options to be used when sending the request.

    + @@ -556,7 +587,8 @@ representing the parent of this channel; null if none is set.

    System.Threading.Tasks.Task - +

    A task that represents the asynchronous operation for syncing channel permissions with its parent's.

    + @@ -571,7 +603,8 @@ representing the parent of this channel; null if none is set.

    IAudioChannel.ConnectAsync(Boolean, Boolean, Boolean)

    -
    +

    Connects to this audio channel.

    +
    Declaration
    @@ -590,17 +623,20 @@ representing the parent of this channel; null if none is set.

    System.Boolean selfDeaf - +

    Determines whether the client should deaf itself upon connection.

    + System.Boolean selfMute - +

    Determines whether the client should mute itself upon connection.

    + System.Boolean external - +

    Determines whether the audio client is an external one or not.

    + @@ -615,7 +651,9 @@ representing the parent of this channel; null if none is set.

    System.Threading.Tasks.Task<IAudioClient> - +

    A task representing the asynchronous connection operation. The task result contains the +IAudioClient responsible for the connection.

    + @@ -674,7 +712,8 @@ representing the parent of this channel; null if none is set.

    IGuildChannel.GetUserAsync(UInt64, CacheMode, RequestOptions)

    -
    +

    Gets a user in this channel.

    +
    Declaration
    @@ -693,17 +732,20 @@ representing the parent of this channel; null if none is set.

    System.UInt64 id - +

    The snowflake identifier of the user.

    + CacheMode mode - +

    The CacheMode that determines whether the object should be fetched from cache.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -718,7 +760,9 @@ representing the parent of this channel; null if none is set.

    System.Threading.Tasks.Task<IGuildUser> - +

    A task representing the asynchronous get operation. The task result contains a guild user object that +represents the user; null if none is found.

    + @@ -731,7 +775,8 @@ representing the parent of this channel; null if none is set.

    IGuildChannel.GetUsersAsync(CacheMode, RequestOptions)

    -
    +

    Gets a collection of users that are able to view the channel or are currently in this channel.

    +
    Declaration
    @@ -750,12 +795,14 @@ representing the parent of this channel; null if none is set.

    CacheMode mode - +

    The CacheMode that determines whether the object should be fetched from cache.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -770,10 +817,15 @@ representing the parent of this channel; null if none is set.

    System.Collections.Generic.IAsyncEnumerable<System.Collections.Generic.IReadOnlyCollection<IGuildUser>> - +

    Paged collection of users.

    + +
    Remarks
    +

    This method follows the same behavior as described in GetUsersAsync(CacheMode, RequestOptions). +Please visit its documentation for more details on this method.

    +
    | Improve this Doc @@ -783,7 +835,8 @@ representing the parent of this channel; null if none is set.

    INestedChannel.GetCategoryAsync(CacheMode, RequestOptions)

    -
    +

    Gets the parent (category) channel of this channel.

    +
    Declaration
    @@ -802,12 +855,14 @@ representing the parent of this channel; null if none is set.

    CacheMode mode - +

    The CacheMode that determines whether the object should be fetched from cache.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -822,7 +877,9 @@ representing the parent of this channel; null if none is set.

    System.Threading.Tasks.Task<ICategoryChannel> - +

    A task that represents the asynchronous get operation. The task result contains the category channel +representing the parent of this channel; null if none is set.

    + diff --git a/docs/api/Discord.Rest.RestVoiceRegion.html b/docs/api/Discord.Rest.RestVoiceRegion.html index 28c3b266a..6523e8ccc 100644 --- a/docs/api/Discord.Rest.RestVoiceRegion.html +++ b/docs/api/Discord.Rest.RestVoiceRegion.html @@ -128,7 +128,8 @@

    IsCustom

    -
    +

    Gets a value that indicates whether this voice region is custom-made for events.

    +
    Declaration
    @@ -145,7 +146,8 @@ System.Boolean - +

    true if this is a custom voice region (used for events/etc); otherwise false/

    + @@ -158,7 +160,8 @@

    IsDeprecated

    -
    +

    Gets a value that indicates whether this voice region is no longer being maintained.

    +
    Declaration
    @@ -175,7 +178,8 @@ System.Boolean - +

    true if this is a deprecated voice region; otherwise false.

    + @@ -188,7 +192,8 @@

    IsOptimal

    -
    +

    Gets a value that indicates whether this voice region is optimal for your client in terms of latency.

    +
    Declaration
    @@ -205,7 +210,8 @@ System.Boolean - +

    true if this voice region is the closest to your machine; otherwise false .

    + @@ -218,7 +224,8 @@

    IsVip

    -
    +

    Gets a value that indicates whether or not this voice region is exclusive to partnered servers.

    +
    Declaration
    @@ -235,7 +242,8 @@ System.Boolean - +

    true if this voice region is exclusive to VIP accounts; otherwise false.

    + @@ -248,7 +256,8 @@

    Name

    -
    +

    Gets the name of this voice region.

    +
    Declaration
    @@ -265,7 +274,8 @@ System.String - +

    A string that represents the human-readable name of this voice region (e.g. Central Europe).

    + diff --git a/docs/api/Discord.Rest.RestWebhook.html b/docs/api/Discord.Rest.RestWebhook.html index 5fb8558c0..690fc98fb 100644 --- a/docs/api/Discord.Rest.RestWebhook.html +++ b/docs/api/Discord.Rest.RestWebhook.html @@ -130,7 +130,8 @@

    AvatarId

    -
    +

    Gets the ID of this webhook's default avatar.

    +
    Declaration
    @@ -160,7 +161,8 @@

    ChannelId

    -
    +

    Gets the ID of the channel for this webhook.

    +
    Declaration
    @@ -190,7 +192,8 @@

    CreatedAt

    -
    +

    Gets when the snowflake was created.

    +
    Declaration
    @@ -207,7 +210,8 @@ System.DateTimeOffset - +

    A System.DateTimeOffset representing when the entity was first created.

    + @@ -220,7 +224,8 @@

    Creator

    -
    +

    Gets the user that created this webhook.

    +
    Declaration
    @@ -250,7 +255,8 @@

    GuildId

    -
    +

    Gets the ID of the guild owning this webhook.

    +
    Declaration
    @@ -280,7 +286,8 @@

    Name

    -
    +

    Gets the default name of this webhook.

    +
    Declaration
    @@ -310,7 +317,8 @@

    Token

    -
    +

    Gets the token of this webhook.

    +
    Declaration
    @@ -342,7 +350,8 @@

    DeleteAsync(RequestOptions)

    -
    +

    Deletes this object and all its children.

    +
    Declaration
    @@ -361,7 +370,8 @@ RequestOptions options - +

    The options to be used when sending the request.

    + @@ -389,7 +399,8 @@

    GetAvatarUrl(ImageFormat, UInt16)

    -
    +

    Gets the URL to this webhook's default avatar.

    +
    Declaration
    @@ -525,7 +536,8 @@

    UpdateAsync(RequestOptions)

    -
    +

    Updates this object's properties with its current state.

    +
    Declaration
    @@ -574,7 +586,8 @@

    IWebhook.Channel

    -
    +

    Gets the channel for this webhook.

    +
    Declaration
    @@ -604,7 +617,8 @@

    IWebhook.Guild

    -
    +

    Gets the guild owning this webhook.

    +
    Declaration
    @@ -634,7 +648,8 @@

    IWebhook.ModifyAsync(Action<WebhookProperties>, RequestOptions)

    -
    +

    Modifies this webhook.

    +
    Declaration
    diff --git a/docs/api/Discord.Rest.RestWebhookUser.html b/docs/api/Discord.Rest.RestWebhookUser.html index 2d259e2e2..d70b582f7 100644 --- a/docs/api/Discord.Rest.RestWebhookUser.html +++ b/docs/api/Discord.Rest.RestWebhookUser.html @@ -183,7 +183,8 @@

    GuildId

    -
    +

    Gets the ID of the guild for this user.

    +
    Declaration
    @@ -200,7 +201,8 @@ System.UInt64 - +

    An System.UInt64 representing the snowflake identifier of the guild that this user belongs to.

    + @@ -213,7 +215,8 @@

    IsWebhook

    -
    +

    Gets a value that indicates whether this user is a webhook user.

    +
    Declaration
    @@ -230,7 +233,8 @@ System.Boolean - +

    true if the user is a webhook; otherwise false.

    + @@ -245,7 +249,8 @@

    PremiumSince

    -
    +

    Gets the date and time for when this user's guild boost began.

    +
    Declaration
    @@ -262,7 +267,8 @@ System.Nullable<System.DateTimeOffset> - +

    A System.DateTimeOffset for when the user began boosting this guild; null if they are not boosting the guild.

    + @@ -275,7 +281,8 @@

    WebhookId

    -
    +

    Gets the ID of a webhook.

    +
    Declaration
    @@ -307,7 +314,8 @@

    IGuildUser.AddRoleAsync(IRole, RequestOptions)

    -
    +

    Adds the specified role to this user in the guild.

    +
    Declaration
    @@ -326,12 +334,14 @@ IRole role - +

    The role to be added to the user.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -346,7 +356,8 @@ System.Threading.Tasks.Task - +

    A task that represents the asynchronous role addition operation.

    + @@ -359,7 +370,8 @@

    IGuildUser.AddRolesAsync(IEnumerable<IRole>, RequestOptions)

    -
    +

    Adds the specified roles to this user in the guild.

    +
    Declaration
    @@ -378,12 +390,14 @@ System.Collections.Generic.IEnumerable<IRole> roles - +

    The roles to be added to the user.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -398,7 +412,8 @@ System.Threading.Tasks.Task - +

    A task that represents the asynchronous role addition operation.

    + @@ -411,7 +426,8 @@

    IGuildUser.GetPermissions(IGuildChannel)

    -
    +

    Gets the level permissions granted to this user to a given channel.

    +
    Declaration
    @@ -430,7 +446,8 @@ IGuildChannel channel - +

    The channel to get the permission from.

    + @@ -445,7 +462,9 @@ ChannelPermissions - +

    A ChannelPermissions structure representing the permissions that a user has in the +specified channel.

    + @@ -458,7 +477,8 @@

    IGuildUser.Guild

    -
    +

    Gets the guild for this user.

    +
    Declaration
    @@ -475,7 +495,8 @@ IGuild - +

    A guild object that this user belongs to.

    + @@ -488,7 +509,8 @@

    IGuildUser.GuildPermissions

    -
    +

    Gets the guild-level permissions for this user.

    +
    Declaration
    @@ -505,7 +527,9 @@ GuildPermissions - +

    A GuildPermissions structure for this user, representing what +permissions this user has in the guild.

    + @@ -518,7 +542,8 @@

    IGuildUser.JoinedAt

    -
    +

    Gets when this user joined the guild.

    +
    Declaration
    @@ -535,7 +560,9 @@ System.Nullable<System.DateTimeOffset> - +

    A System.DateTimeOffset representing the time of which the user has joined the guild; +null when it cannot be obtained.

    + @@ -548,7 +575,8 @@

    IGuildUser.KickAsync(String, RequestOptions)

    -
    +

    Kicks this user from this guild.

    +
    Declaration
    @@ -567,12 +595,14 @@ System.String reason - +

    The reason for the kick which will be recorded in the audit log.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -587,7 +617,8 @@ System.Threading.Tasks.Task - +

    A task that represents the asynchronous kick operation.

    + @@ -600,7 +631,8 @@

    IGuildUser.ModifyAsync(Action<GuildUserProperties>, RequestOptions)

    -
    +

    Modifies this user's properties in this guild.

    +
    Declaration
    @@ -619,12 +651,14 @@ System.Action<GuildUserProperties> func - +

    The delegate containing the properties to modify the user with.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -639,10 +673,15 @@ System.Threading.Tasks.Task - +

    A task that represents the asynchronous modification operation.

    + +
    Remarks
    +

    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 GuildUserProperties.

    +
    | Improve this Doc @@ -652,7 +691,8 @@

    IGuildUser.Nickname

    -
    +

    Gets the nickname for this user.

    +
    Declaration
    @@ -669,7 +709,8 @@ System.String - +

    A string representing the nickname of the user; null if none is set.

    + @@ -682,7 +723,8 @@

    IGuildUser.RemoveRoleAsync(IRole, RequestOptions)

    -
    +

    Removes the specified role from this user in the guild.

    +
    Declaration
    @@ -701,12 +743,14 @@ IRole role - +

    The role to be removed from the user.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -721,7 +765,8 @@ System.Threading.Tasks.Task - +

    A task that represents the asynchronous role removal operation.

    + @@ -734,7 +779,8 @@

    IGuildUser.RemoveRolesAsync(IEnumerable<IRole>, RequestOptions)

    -
    +

    Removes the specified roles from this user in the guild.

    +
    Declaration
    @@ -753,12 +799,14 @@ System.Collections.Generic.IEnumerable<IRole> roles - +

    The roles to be removed from the user.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -773,7 +821,8 @@ System.Threading.Tasks.Task - +

    A task that represents the asynchronous role removal operation.

    + @@ -786,7 +835,8 @@

    IGuildUser.RoleIds

    -
    +

    Gets a collection of IDs for the roles that this user currently possesses in the guild.

    +
    Declaration
    @@ -803,10 +853,17 @@ System.Collections.Generic.IReadOnlyCollection<System.UInt64> - +

    A read-only collection of System.UInt64, each representing a snowflake identifier for a role that +this user possesses.

    + +
    Remarks
    +

    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.

    +
    | Improve this Doc @@ -816,7 +873,8 @@

    IVoiceState.IsDeafened

    -
    +

    Gets a value that indicates whether this user is deafened by the guild.

    +
    Declaration
    @@ -833,7 +891,9 @@ System.Boolean - +

    true if the user is deafened (i.e. not permitted to listen to or speak to others) by the guild; +otherwise false.

    + @@ -846,7 +906,9 @@

    IVoiceState.IsMuted

    -
    +

    Gets a value that indicates whether this user is muted (i.e. not permitted to speak via voice) by the +guild.

    +
    Declaration
    @@ -863,7 +925,8 @@ System.Boolean - +

    true if this user is muted by the guild; otherwise false.

    + @@ -876,7 +939,8 @@

    IVoiceState.IsSelfDeafened

    -
    +

    Gets a value that indicates whether this user has marked themselves as deafened.

    +
    Declaration
    @@ -893,7 +957,8 @@ System.Boolean - +

    true if this user has deafened themselves (i.e. not permitted to listen to or speak to others); otherwise false.

    + @@ -906,7 +971,9 @@

    IVoiceState.IsSelfMuted

    -
    +

    Gets a value that indicates whether this user has marked themselves as muted (i.e. not permitted to +speak via voice).

    +
    Declaration
    @@ -923,7 +990,8 @@ System.Boolean - +

    true if this user has muted themselves; otherwise false.

    + @@ -936,7 +1004,8 @@

    IVoiceState.IsStreaming

    -
    +

    Gets a value that indicates if this user is streaming in a voice channel.

    +
    Declaration
    @@ -953,7 +1022,8 @@ System.Boolean - +

    true if the user is streaming; otherwise false.

    + @@ -966,7 +1036,8 @@

    IVoiceState.IsSuppressed

    -
    +

    Gets a value that indicates whether the user is muted by the current user.

    +
    Declaration
    @@ -983,7 +1054,8 @@ System.Boolean - +

    true if the guild is temporarily blocking audio to/from this user; otherwise false.

    + @@ -996,7 +1068,8 @@

    IVoiceState.VoiceChannel

    -
    +

    Gets the voice channel this user is currently in.

    +
    Declaration
    @@ -1013,7 +1086,9 @@ IVoiceChannel - +

    A generic voice channel object representing the voice channel that the user is currently in; null +if none.

    + @@ -1026,7 +1101,8 @@

    IVoiceState.VoiceSessionId

    -
    +

    Gets the unique identifier for this user's voice session.

    +
    Declaration
    diff --git a/docs/api/Discord.WebSocket.BaseSocketClient.html b/docs/api/Discord.WebSocket.BaseSocketClient.html index f6471bfd4..1a8b3500d 100644 --- a/docs/api/Discord.WebSocket.BaseSocketClient.html +++ b/docs/api/Discord.WebSocket.BaseSocketClient.html @@ -1218,7 +1218,8 @@ found.

    StartAsync()

    -
    +

    Starts the connection between Discord and the client..

    +
    Declaration
    @@ -1235,10 +1236,18 @@ found.

    System.Threading.Tasks.Task - +

    A task that represents the asynchronous start operation.

    + +
    Remarks
    +

    This method will initialize the connection between the client and Discord.

    +
    important

    + This method will immediately return after it is called, as it will initialize the connection on + another thread. +

    +
    | Improve this Doc @@ -1248,7 +1257,8 @@ found.

    StopAsync()

    -
    +

    Stops the connection between Discord and the client.

    +
    Declaration
    @@ -1265,7 +1275,8 @@ found.

    System.Threading.Tasks.Task - +

    A task that represents the asynchronous stop operation.

    + @@ -2436,7 +2447,8 @@ public async Task HandleReactionAddedAsync(Cacheable<IUserMessage, ulong> cac

    IDiscordClient.CreateGuildAsync(String, IVoiceRegion, Stream, RequestOptions)

    -
    +

    Creates a guild for the logged-in user who is in less than 10 active guilds.

    +
    Declaration
    @@ -2455,22 +2467,26 @@ public async Task HandleReactionAddedAsync(Cacheable<IUserMessage, ulong> cac System.String name - +

    The name of the new guild.

    + IVoiceRegion region - +

    The voice region to create the guild with.

    + System.IO.Stream jpegIcon - +

    The icon of the guild.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -2485,10 +2501,17 @@ public async Task HandleReactionAddedAsync(Cacheable<IUserMessage, ulong> cac System.Threading.Tasks.Task<IGuild> - +

    A task that represents the asynchronous creation operation. The task result contains the created guild.

    + +
    Remarks
    +

    This method creates a new guild on behalf of the logged-in user.

    +
    warning

    + Due to Discord's limitation, this method will only work for users that are in less than 10 guilds. +

    +
    | Improve this Doc @@ -2498,7 +2521,8 @@ public async Task HandleReactionAddedAsync(Cacheable<IUserMessage, ulong> cac

    IDiscordClient.GetApplicationInfoAsync(RequestOptions)

    -
    +

    Gets a Discord application information for the logged-in user.

    +
    Declaration
    @@ -2517,7 +2541,8 @@ public async Task HandleReactionAddedAsync(Cacheable<IUserMessage, ulong> cac RequestOptions options - +

    The options to be used when sending the request.

    + @@ -2532,10 +2557,16 @@ public async Task HandleReactionAddedAsync(Cacheable<IUserMessage, ulong> cac System.Threading.Tasks.Task<IApplication> - +

    A task that represents the asynchronous get operation. The task result contains the application +information.

    + +
    Remarks
    +

    This method reflects your application information you submitted when creating a Discord application via +the Developer Portal.

    +
    | Improve this Doc @@ -2545,7 +2576,8 @@ public async Task HandleReactionAddedAsync(Cacheable<IUserMessage, ulong> cac

    IDiscordClient.GetChannelAsync(UInt64, CacheMode, RequestOptions)

    -
    +

    Gets a generic channel.

    +
    Declaration
    @@ -2564,17 +2596,20 @@ public async Task HandleReactionAddedAsync(Cacheable<IUserMessage, ulong> cac System.UInt64 id - +

    The snowflake identifier of the channel (e.g. 381889909113225237).

    + CacheMode mode - +

    The CacheMode that determines whether the object should be fetched from cache.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -2589,7 +2624,9 @@ public async Task HandleReactionAddedAsync(Cacheable<IUserMessage, ulong> cac System.Threading.Tasks.Task<IChannel> - +

    A task that represents the asynchronous get operation. The task result contains the channel associated +with the snowflake identifier; null when the channel cannot be found.

    + @@ -2602,7 +2639,8 @@ public async Task HandleReactionAddedAsync(Cacheable<IUserMessage, ulong> cac

    IDiscordClient.GetConnectionsAsync(RequestOptions)

    -
    +

    Gets the connections that the user has set up.

    +
    Declaration
    @@ -2621,7 +2659,8 @@ public async Task HandleReactionAddedAsync(Cacheable<IUserMessage, ulong> cac RequestOptions options - +

    The options to be used when sending the request.

    + @@ -2636,7 +2675,8 @@ public async Task HandleReactionAddedAsync(Cacheable<IUserMessage, ulong> cac System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyCollection<IConnection>> - +

    A task that represents the asynchronous get operation. The task result contains a read-only collection of connections.

    + @@ -2649,7 +2689,8 @@ public async Task HandleReactionAddedAsync(Cacheable<IUserMessage, ulong> cac

    IDiscordClient.GetGuildAsync(UInt64, CacheMode, RequestOptions)

    -
    +

    Gets a guild.

    +
    Declaration
    @@ -2668,17 +2709,20 @@ public async Task HandleReactionAddedAsync(Cacheable<IUserMessage, ulong> cac System.UInt64 id - +

    The guild snowflake identifier.

    + CacheMode mode - +

    The CacheMode that determines whether the object should be fetched from cache.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -2693,7 +2737,9 @@ public async Task HandleReactionAddedAsync(Cacheable<IUserMessage, ulong> cac System.Threading.Tasks.Task<IGuild> - +

    A task that represents the asynchronous get operation. The task result contains the guild associated +with the snowflake identifier; null when the guild cannot be found.

    + @@ -2706,7 +2752,8 @@ public async Task HandleReactionAddedAsync(Cacheable<IUserMessage, ulong> cac

    IDiscordClient.GetGuildsAsync(CacheMode, RequestOptions)

    -
    +

    Gets a collection of guilds that the user is currently in.

    +
    Declaration
    @@ -2725,12 +2772,14 @@ public async Task HandleReactionAddedAsync(Cacheable<IUserMessage, ulong> cac CacheMode mode - +

    The CacheMode that determines whether the object should be fetched from cache.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -2745,7 +2794,9 @@ public async Task HandleReactionAddedAsync(Cacheable<IUserMessage, ulong> cac System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyCollection<IGuild>> - +

    A task that represents the asynchronous get operation. The task result contains a read-only collection +of guilds that the current user is in.

    + @@ -2758,7 +2809,8 @@ public async Task HandleReactionAddedAsync(Cacheable<IUserMessage, ulong> cac

    IDiscordClient.GetInviteAsync(String, RequestOptions)

    -
    +

    Gets an invite.

    +
    Declaration
    @@ -2777,12 +2829,14 @@ public async Task HandleReactionAddedAsync(Cacheable<IUserMessage, ulong> cac System.String inviteId - +

    The invitation identifier.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -2797,7 +2851,8 @@ public async Task HandleReactionAddedAsync(Cacheable<IUserMessage, ulong> cac System.Threading.Tasks.Task<IInvite> - +

    A task that represents the asynchronous get operation. The task result contains the invite information.

    + @@ -2810,7 +2865,8 @@ public async Task HandleReactionAddedAsync(Cacheable<IUserMessage, ulong> cac

    IDiscordClient.GetPrivateChannelsAsync(CacheMode, RequestOptions)

    -
    +

    Gets a collection of private channels opened in this session.

    +
    Declaration
    @@ -2829,12 +2885,14 @@ public async Task HandleReactionAddedAsync(Cacheable<IUserMessage, ulong> cac CacheMode mode - +

    The CacheMode that determines whether the object should be fetched from cache.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -2849,10 +2907,20 @@ public async Task HandleReactionAddedAsync(Cacheable<IUserMessage, ulong> cac System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyCollection<IPrivateChannel>> - +

    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.

    + +
    Remarks
    +

    This method will retrieve all private channels (including direct-message, group channel and such) that +are currently opened in this session.

    +
    warning

    + 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. +

    +
    | Improve this Doc @@ -2862,7 +2930,8 @@ public async Task HandleReactionAddedAsync(Cacheable<IUserMessage, ulong> cac

    IDiscordClient.GetUserAsync(String, String, RequestOptions)

    -
    +

    Gets a user.

    +
    Declaration
    @@ -2881,17 +2950,20 @@ public async Task HandleReactionAddedAsync(Cacheable<IUserMessage, ulong> cac System.String username - +

    The name of the user (e.g. Still).

    + System.String discriminator - +

    The discriminator value of the user (e.g. 2876).

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -2906,7 +2978,9 @@ public async Task HandleReactionAddedAsync(Cacheable<IUserMessage, ulong> cac System.Threading.Tasks.Task<IUser> - +

    A task that represents the asynchronous get operation. The task result contains the user associated with +the name and the discriminator; null if the user is not found.

    + @@ -2919,7 +2993,8 @@ public async Task HandleReactionAddedAsync(Cacheable<IUserMessage, ulong> cac

    IDiscordClient.GetUserAsync(UInt64, CacheMode, RequestOptions)

    -
    +

    Gets a user.

    +
    Declaration
    @@ -2938,17 +3013,20 @@ public async Task HandleReactionAddedAsync(Cacheable<IUserMessage, ulong> cac System.UInt64 id - +

    The snowflake identifier of the user (e.g. 168693960628371456).

    + CacheMode mode - +

    The CacheMode that determines whether the object should be fetched from cache.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -2963,7 +3041,9 @@ public async Task HandleReactionAddedAsync(Cacheable<IUserMessage, ulong> cac System.Threading.Tasks.Task<IUser> - +

    A task that represents the asynchronous get operation. The task result contains the user associated with +the snowflake identifier; null if the user is not found.

    + @@ -2976,7 +3056,8 @@ public async Task HandleReactionAddedAsync(Cacheable<IUserMessage, ulong> cac

    IDiscordClient.GetVoiceRegionAsync(String, RequestOptions)

    -
    +

    Gets a voice region.

    +
    Declaration
    @@ -2995,12 +3076,14 @@ public async Task HandleReactionAddedAsync(Cacheable<IUserMessage, ulong> cac System.String id - +

    The identifier of the voice region (e.g. eu-central ).

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -3015,7 +3098,9 @@ public async Task HandleReactionAddedAsync(Cacheable<IUserMessage, ulong> cac System.Threading.Tasks.Task<IVoiceRegion> - +

    A task that represents the asynchronous get operation. The task result contains the voice region +associated with the identifier; null if the voice region is not found.

    + @@ -3028,7 +3113,8 @@ public async Task HandleReactionAddedAsync(Cacheable<IUserMessage, ulong> cac

    IDiscordClient.GetVoiceRegionsAsync(RequestOptions)

    -
    +

    Gets a collection of the available voice regions.

    +
    Declaration
    @@ -3047,7 +3133,8 @@ public async Task HandleReactionAddedAsync(Cacheable<IUserMessage, ulong> cac RequestOptions options - +

    The options to be used when sending the request.

    + @@ -3062,7 +3149,9 @@ public async Task HandleReactionAddedAsync(Cacheable<IUserMessage, ulong> cac System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyCollection<IVoiceRegion>> - +

    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.

    + diff --git a/docs/api/Discord.WebSocket.DiscordShardedClient.html b/docs/api/Discord.WebSocket.DiscordShardedClient.html index d8288626a..ce8c47807 100644 --- a/docs/api/Discord.WebSocket.DiscordShardedClient.html +++ b/docs/api/Discord.WebSocket.DiscordShardedClient.html @@ -406,7 +406,8 @@

    Activity

    -
    +

    Gets the activity for the logged-in user.

    +
    Declaration
    @@ -423,7 +424,8 @@ IActivity - +

    An activity object that represents the user's current activity.

    + @@ -438,7 +440,8 @@

    Guilds

    -
    +

    Gets a collection of guilds that the user is currently in.

    +
    Declaration
    @@ -455,7 +458,8 @@ System.Collections.Generic.IReadOnlyCollection<SocketGuild> - +

    A read-only collection of guilds that the current user is in.

    + @@ -470,7 +474,8 @@

    Latency

    -
    +

    Gets the estimated round-trip latency, in milliseconds, to the gateway server.

    +
    Declaration
    @@ -487,7 +492,9 @@ System.Int32 - +

    An System.Int32 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.

    + @@ -502,7 +509,8 @@

    PrivateChannels

    -
    +

    Gets a collection of private channels opened in this session.

    +
    Declaration
    @@ -519,12 +527,21 @@ System.Collections.Generic.IReadOnlyCollection<ISocketPrivateChannel> - +

    A read-only collection of private channels that the user currently partakes in.

    +
    Overrides
    +
    Remarks
    +

    This method will retrieve all private channels (including direct-message, group channel and such) that +are currently opened in this session.

    +
    warning

    + 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. +

    +
    | Improve this Doc @@ -597,7 +614,8 @@

    Status

    -
    +

    Gets the status for the logged-in user.

    +
    Declaration
    @@ -614,7 +632,8 @@ UserStatus - +

    A status object that represents the user's online presence status.

    + @@ -629,7 +648,8 @@

    VoiceRegions

    -
    +

    Gets a collection of available voice regions.

    +
    Declaration
    @@ -646,7 +666,8 @@ System.Collections.Generic.IReadOnlyCollection<RestVoiceRegion> - +

    A read-only collection of voice regions that the user has access to.

    + @@ -663,7 +684,8 @@

    DownloadUsersAsync(IEnumerable<IGuild>)

    -
    +

    Attempts to download users into the user cache for the selected guilds.

    +
    Declaration
    @@ -682,7 +704,8 @@ System.Collections.Generic.IEnumerable<IGuild> guilds - +

    The guilds to download the members from.

    + @@ -697,7 +720,8 @@ System.Threading.Tasks.Task - +

    A task that represents the asynchronous download operation.

    + @@ -728,7 +752,8 @@

    GetApplicationInfoAsync(RequestOptions)

    -
    +

    Gets a Discord application information for the logged-in user.

    +
    Declaration
    @@ -747,7 +772,8 @@ RequestOptions options - +

    The options to be used when sending the request.

    + @@ -762,12 +788,18 @@ System.Threading.Tasks.Task<RestApplication> - +

    A task that represents the asynchronous get operation. The task result contains the application +information.

    +
    Overrides
    +
    Remarks
    +

    This method reflects your application information you submitted when creating a Discord application via +the Developer Portal.

    +
    | Improve this Doc @@ -777,7 +809,8 @@

    GetChannel(UInt64)

    -
    +

    Gets a channel.

    +
    Declaration
    @@ -796,7 +829,8 @@ System.UInt64 id - +

    The snowflake identifier of the channel (e.g. 381889909113225237).

    + @@ -811,7 +845,9 @@ SocketChannel - +

    A generic WebSocket-based channel object (voice, text, category, etc.) associated with the identifier; +null when the channel cannot be found.

    + @@ -826,7 +862,8 @@

    GetGuild(UInt64)

    -
    +

    Gets a guild.

    +
    Declaration
    @@ -845,7 +882,8 @@ System.UInt64 id - +

    The guild snowflake identifier.

    + @@ -860,7 +898,9 @@ SocketGuild - +

    A WebSocket-based guild associated with the snowflake identifier; null when the guild cannot be +found.

    + @@ -1016,7 +1056,8 @@

    GetUser(String, String)

    -
    +

    Gets a user.

    +
    Declaration
    @@ -1035,12 +1076,14 @@ System.String username - +

    The name of the user.

    + System.String discriminator - +

    The discriminator value of the user.

    + @@ -1055,12 +1098,27 @@ SocketUser - +

    A generic WebSocket-based user; null when the user cannot be found.

    +
    Overrides
    +
    Remarks
    +

    This method gets the user present in the WebSocket cache with the given condition.

    +
    warning

    + Sometimes a user may return null 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 AlwaysDownloadUsers. +

    +
    note

    + 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 +GetUserAsync(UInt64, RequestOptions). +

    +
    | Improve this Doc @@ -1070,7 +1128,8 @@

    GetUser(UInt64)

    -
    +

    Gets a generic user.

    +
    Declaration
    @@ -1089,7 +1148,8 @@ System.UInt64 id - +

    The user snowflake ID.

    + @@ -1104,12 +1164,27 @@ SocketUser - +

    A generic WebSocket-based user; null when the user cannot be found.

    +
    Overrides
    +
    Remarks
    +

    This method gets the user present in the WebSocket cache with the given condition.

    +
    warning

    + Sometimes a user may return null 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 AlwaysDownloadUsers. +

    +
    note

    + 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 +GetUserAsync(UInt64, RequestOptions). +

    +
    | Improve this Doc @@ -1119,7 +1194,8 @@

    GetVoiceRegion(String)

    -
    +

    Gets a voice region.

    +
    Declaration
    @@ -1138,7 +1214,8 @@ System.String id - +

    The identifier of the voice region (e.g. eu-central ).

    + @@ -1153,7 +1230,9 @@ RestVoiceRegion - +

    A REST-based voice region associated with the identifier; null if the voice region is not +found.

    + @@ -1168,7 +1247,8 @@

    SetActivityAsync(IActivity)

    -
    +

    Sets the activity of the logged-in user.

    +
    Declaration
    @@ -1187,7 +1267,8 @@ IActivity activity - +

    The activity to be set.

    + @@ -1202,12 +1283,23 @@ System.Threading.Tasks.Task - +

    A task that represents the asynchronous set operation.

    +
    Overrides
    +
    Remarks
    +

    This method sets the activity of the user.

    +
    note

    + Discord will only accept setting of name and the type of activity. +

    +
    warning

    + Rich Presence cannot be set via this method or client. Rich Presence is strictly limited to RPC + clients only. +

    +
    | Improve this Doc @@ -1217,7 +1309,8 @@

    SetGameAsync(String, String, ActivityType)

    -
    +

    Sets the game of the user.

    +
    Declaration
    @@ -1236,17 +1329,20 @@ System.String name - +

    The name of the game.

    + System.String streamUrl - +

    If streaming, the URL of the stream. Must be a valid Twitch URL.

    + ActivityType type - +

    The type of the game.

    + @@ -1261,7 +1357,8 @@ System.Threading.Tasks.Task - +

    A task that represents the asynchronous set operation.

    + @@ -1276,7 +1373,8 @@

    SetStatusAsync(UserStatus)

    -
    +

    Sets the current status of the user (e.g. Online, Do not Disturb).

    +
    Declaration
    @@ -1295,7 +1393,8 @@ UserStatus status - +

    The new status to be set.

    + @@ -1310,7 +1409,8 @@ System.Threading.Tasks.Task - +

    A task that represents the asynchronous set operation.

    + @@ -1325,7 +1425,8 @@

    StartAsync()

    -
    +

    Starts the connection between Discord and the client..

    +
    Declaration
    @@ -1342,12 +1443,20 @@ System.Threading.Tasks.Task - +

    A task that represents the asynchronous start operation.

    +
    Overrides
    +
    Remarks
    +

    This method will initialize the connection between the client and Discord.

    +
    important

    + This method will immediately return after it is called, as it will initialize the connection on + another thread. +

    +
    | Improve this Doc @@ -1357,7 +1466,8 @@

    StopAsync()

    -
    +

    Stops the connection between Discord and the client.

    +
    Declaration
    @@ -1374,7 +1484,8 @@ System.Threading.Tasks.Task - +

    A task that represents the asynchronous stop operation.

    + @@ -1513,7 +1624,8 @@

    IDiscordClient.CreateGuildAsync(String, IVoiceRegion, Stream, RequestOptions)

    -
    +

    Creates a guild for the logged-in user who is in less than 10 active guilds.

    +
    Declaration
    @@ -1532,22 +1644,26 @@ System.String name - +

    The name of the new guild.

    + IVoiceRegion region - +

    The voice region to create the guild with.

    + System.IO.Stream jpegIcon - +

    The icon of the guild.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -1562,10 +1678,17 @@ System.Threading.Tasks.Task<IGuild> - +

    A task that represents the asynchronous creation operation. The task result contains the created guild.

    + +
    Remarks
    +

    This method creates a new guild on behalf of the logged-in user.

    +
    warning

    + Due to Discord's limitation, this method will only work for users that are in less than 10 guilds. +

    +
    | Improve this Doc @@ -1575,7 +1698,8 @@

    IDiscordClient.GetApplicationInfoAsync(RequestOptions)

    -
    +

    Gets a Discord application information for the logged-in user.

    +
    Declaration
    @@ -1594,7 +1718,8 @@ RequestOptions options - +

    The options to be used when sending the request.

    + @@ -1609,10 +1734,16 @@ System.Threading.Tasks.Task<IApplication> - +

    A task that represents the asynchronous get operation. The task result contains the application +information.

    + +
    Remarks
    +

    This method reflects your application information you submitted when creating a Discord application via +the Developer Portal.

    +
    | Improve this Doc @@ -1622,7 +1753,8 @@

    IDiscordClient.GetChannelAsync(UInt64, CacheMode, RequestOptions)

    -
    +

    Gets a generic channel.

    +
    Declaration
    @@ -1641,17 +1773,20 @@ System.UInt64 id - +

    The snowflake identifier of the channel (e.g. 381889909113225237).

    + CacheMode mode - +

    The CacheMode that determines whether the object should be fetched from cache.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -1666,7 +1801,9 @@ System.Threading.Tasks.Task<IChannel> - +

    A task that represents the asynchronous get operation. The task result contains the channel associated +with the snowflake identifier; null when the channel cannot be found.

    + @@ -1679,7 +1816,8 @@

    IDiscordClient.GetConnectionsAsync(RequestOptions)

    -
    +

    Gets the connections that the user has set up.

    +
    Declaration
    @@ -1698,7 +1836,8 @@ RequestOptions options - +

    The options to be used when sending the request.

    + @@ -1713,7 +1852,8 @@ System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyCollection<IConnection>> - +

    A task that represents the asynchronous get operation. The task result contains a read-only collection of connections.

    + @@ -1726,7 +1866,8 @@

    IDiscordClient.GetGuildAsync(UInt64, CacheMode, RequestOptions)

    -
    +

    Gets a guild.

    +
    Declaration
    @@ -1745,17 +1886,20 @@ System.UInt64 id - +

    The guild snowflake identifier.

    + CacheMode mode - +

    The CacheMode that determines whether the object should be fetched from cache.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -1770,7 +1914,9 @@ System.Threading.Tasks.Task<IGuild> - +

    A task that represents the asynchronous get operation. The task result contains the guild associated +with the snowflake identifier; null when the guild cannot be found.

    + @@ -1783,7 +1929,8 @@

    IDiscordClient.GetGuildsAsync(CacheMode, RequestOptions)

    -
    +

    Gets a collection of guilds that the user is currently in.

    +
    Declaration
    @@ -1802,12 +1949,14 @@ CacheMode mode - +

    The CacheMode that determines whether the object should be fetched from cache.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -1822,7 +1971,9 @@ System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyCollection<IGuild>> - +

    A task that represents the asynchronous get operation. The task result contains a read-only collection +of guilds that the current user is in.

    + @@ -1835,7 +1986,8 @@

    IDiscordClient.GetInviteAsync(String, RequestOptions)

    -
    +

    Gets an invite.

    +
    Declaration
    @@ -1854,12 +2006,14 @@ System.String inviteId - +

    The invitation identifier.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -1874,7 +2028,8 @@ System.Threading.Tasks.Task<IInvite> - +

    A task that represents the asynchronous get operation. The task result contains the invite information.

    + @@ -1887,7 +2042,8 @@

    IDiscordClient.GetPrivateChannelsAsync(CacheMode, RequestOptions)

    -
    +

    Gets a collection of private channels opened in this session.

    +
    Declaration
    @@ -1906,12 +2062,14 @@ CacheMode mode - +

    The CacheMode that determines whether the object should be fetched from cache.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -1926,10 +2084,20 @@ System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyCollection<IPrivateChannel>> - +

    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.

    + +
    Remarks
    +

    This method will retrieve all private channels (including direct-message, group channel and such) that +are currently opened in this session.

    +
    warning

    + 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. +

    +
    | Improve this Doc @@ -1939,7 +2107,8 @@

    IDiscordClient.GetUserAsync(String, String, RequestOptions)

    -
    +

    Gets a user.

    +
    Declaration
    @@ -1958,17 +2127,20 @@ System.String username - +

    The name of the user (e.g. Still).

    + System.String discriminator - +

    The discriminator value of the user (e.g. 2876).

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -1983,7 +2155,9 @@ System.Threading.Tasks.Task<IUser> - +

    A task that represents the asynchronous get operation. The task result contains the user associated with +the name and the discriminator; null if the user is not found.

    + @@ -1996,7 +2170,8 @@

    IDiscordClient.GetUserAsync(UInt64, CacheMode, RequestOptions)

    -
    +

    Gets a user.

    +
    Declaration
    @@ -2015,17 +2190,20 @@ System.UInt64 id - +

    The snowflake identifier of the user (e.g. 168693960628371456).

    + CacheMode mode - +

    The CacheMode that determines whether the object should be fetched from cache.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -2040,7 +2218,9 @@ System.Threading.Tasks.Task<IUser> - +

    A task that represents the asynchronous get operation. The task result contains the user associated with +the snowflake identifier; null if the user is not found.

    + @@ -2053,7 +2233,8 @@

    IDiscordClient.GetVoiceRegionAsync(String, RequestOptions)

    -
    +

    Gets a voice region.

    +
    Declaration
    @@ -2072,12 +2253,14 @@ System.String id - +

    The identifier of the voice region (e.g. eu-central ).

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -2092,7 +2275,9 @@ System.Threading.Tasks.Task<IVoiceRegion> - +

    A task that represents the asynchronous get operation. The task result contains the voice region +associated with the identifier; null if the voice region is not found.

    + @@ -2105,7 +2290,8 @@

    IDiscordClient.GetVoiceRegionsAsync(RequestOptions)

    -
    +

    Gets a collection of the available voice regions.

    +
    Declaration
    @@ -2124,7 +2310,8 @@ RequestOptions options - +

    The options to be used when sending the request.

    + @@ -2139,7 +2326,9 @@ System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyCollection<IVoiceRegion>> - +

    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.

    + diff --git a/docs/api/Discord.WebSocket.DiscordSocketClient.html b/docs/api/Discord.WebSocket.DiscordSocketClient.html index 1a6ddd4d6..68abbe26f 100644 --- a/docs/api/Discord.WebSocket.DiscordSocketClient.html +++ b/docs/api/Discord.WebSocket.DiscordSocketClient.html @@ -325,7 +325,8 @@

    Activity

    -
    +

    Gets the activity for the logged-in user.

    +
    Declaration
    @@ -342,7 +343,8 @@ IActivity - +

    An activity object that represents the user's current activity.

    + @@ -466,7 +468,8 @@

    Guilds

    -
    +

    Gets a collection of guilds that the user is currently in.

    +
    Declaration
    @@ -483,7 +486,8 @@ System.Collections.Generic.IReadOnlyCollection<SocketGuild> - +

    A read-only collection of guilds that the current user is in.

    + @@ -498,7 +502,8 @@

    Latency

    -
    +

    Gets the estimated round-trip latency, in milliseconds, to the gateway server.

    +
    Declaration
    @@ -515,7 +520,9 @@ System.Int32 - +

    An System.Int32 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.

    + @@ -530,7 +537,8 @@

    PrivateChannels

    -
    +

    Gets a collection of private channels opened in this session.

    +
    Declaration
    @@ -547,12 +555,21 @@ System.Collections.Generic.IReadOnlyCollection<ISocketPrivateChannel> - +

    A read-only collection of private channels that the user currently partakes in.

    +
    Overrides
    +
    Remarks
    +

    This method will retrieve all private channels (including direct-message, group channel and such) that +are currently opened in this session.

    +
    warning

    + 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. +

    +
    | Improve this Doc @@ -626,7 +643,8 @@

    Status

    -
    +

    Gets the status for the logged-in user.

    +
    Declaration
    @@ -643,7 +661,8 @@ UserStatus - +

    A status object that represents the user's online presence status.

    + @@ -658,7 +677,8 @@

    VoiceRegions

    -
    +

    Gets a collection of available voice regions.

    +
    Declaration
    @@ -675,7 +695,8 @@ System.Collections.Generic.IReadOnlyCollection<RestVoiceRegion> - +

    A read-only collection of voice regions that the user has access to.

    + @@ -692,7 +713,8 @@

    DownloadUsersAsync(IEnumerable<IGuild>)

    -
    +

    Attempts to download users into the user cache for the selected guilds.

    +
    Declaration
    @@ -711,7 +733,8 @@ System.Collections.Generic.IEnumerable<IGuild> guilds - +

    The guilds to download the members from.

    + @@ -726,7 +749,8 @@ System.Threading.Tasks.Task - +

    A task that represents the asynchronous download operation.

    + @@ -741,7 +765,8 @@

    GetApplicationInfoAsync(RequestOptions)

    -
    +

    Gets a Discord application information for the logged-in user.

    +
    Declaration
    @@ -760,7 +785,8 @@ RequestOptions options - +

    The options to be used when sending the request.

    + @@ -775,12 +801,18 @@ System.Threading.Tasks.Task<RestApplication> - +

    A task that represents the asynchronous get operation. The task result contains the application +information.

    +
    Overrides
    +
    Remarks
    +

    This method reflects your application information you submitted when creating a Discord application via +the Developer Portal.

    +
    | Improve this Doc @@ -790,7 +822,8 @@

    GetChannel(UInt64)

    -
    +

    Gets a channel.

    +
    Declaration
    @@ -809,7 +842,8 @@ System.UInt64 id - +

    The snowflake identifier of the channel (e.g. 381889909113225237).

    + @@ -824,7 +858,9 @@ SocketChannel - +

    A generic WebSocket-based channel object (voice, text, category, etc.) associated with the identifier; +null when the channel cannot be found.

    + @@ -839,7 +875,8 @@

    GetGuild(UInt64)

    -
    +

    Gets a guild.

    +
    Declaration
    @@ -858,7 +895,8 @@ System.UInt64 id - +

    The guild snowflake identifier.

    + @@ -873,7 +911,9 @@ SocketGuild - +

    A WebSocket-based guild associated with the snowflake identifier; null when the guild cannot be +found.

    + @@ -888,7 +928,8 @@

    GetUser(String, String)

    -
    +

    Gets a user.

    +
    Declaration
    @@ -907,12 +948,14 @@ System.String username - +

    The name of the user.

    + System.String discriminator - +

    The discriminator value of the user.

    + @@ -927,12 +970,27 @@ SocketUser - +

    A generic WebSocket-based user; null when the user cannot be found.

    +
    Overrides
    +
    Remarks
    +

    This method gets the user present in the WebSocket cache with the given condition.

    +
    warning

    + Sometimes a user may return null 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 AlwaysDownloadUsers. +

    +
    note

    + 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 +GetUserAsync(UInt64, RequestOptions). +

    +
    | Improve this Doc @@ -942,7 +1000,8 @@

    GetUser(UInt64)

    -
    +

    Gets a generic user.

    +
    Declaration
    @@ -961,7 +1020,8 @@ System.UInt64 id - +

    The user snowflake ID.

    + @@ -976,12 +1036,27 @@ SocketUser - +

    A generic WebSocket-based user; null when the user cannot be found.

    +
    Overrides
    +
    Remarks
    +

    This method gets the user present in the WebSocket cache with the given condition.

    +
    warning

    + Sometimes a user may return null 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 AlwaysDownloadUsers. +

    +
    note

    + 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 +GetUserAsync(UInt64, RequestOptions). +

    +
    | Improve this Doc @@ -991,7 +1066,8 @@

    GetVoiceRegion(String)

    -
    +

    Gets a voice region.

    +
    Declaration
    @@ -1010,7 +1086,8 @@ System.String id - +

    The identifier of the voice region (e.g. eu-central ).

    + @@ -1025,7 +1102,9 @@ RestVoiceRegion - +

    A REST-based voice region associated with the identifier; null if the voice region is not +found.

    + @@ -1040,7 +1119,8 @@

    SetActivityAsync(IActivity)

    -
    +

    Sets the activity of the logged-in user.

    +
    Declaration
    @@ -1059,7 +1139,8 @@ IActivity activity - +

    The activity to be set.

    + @@ -1074,12 +1155,23 @@ System.Threading.Tasks.Task - +

    A task that represents the asynchronous set operation.

    +
    Overrides
    +
    Remarks
    +

    This method sets the activity of the user.

    +
    note

    + Discord will only accept setting of name and the type of activity. +

    +
    warning

    + Rich Presence cannot be set via this method or client. Rich Presence is strictly limited to RPC + clients only. +

    +
    | Improve this Doc @@ -1089,7 +1181,8 @@

    SetGameAsync(String, String, ActivityType)

    -
    +

    Sets the game of the user.

    +
    Declaration
    @@ -1108,17 +1201,20 @@ System.String name - +

    The name of the game.

    + System.String streamUrl - +

    If streaming, the URL of the stream. Must be a valid Twitch URL.

    + ActivityType type - +

    The type of the game.

    + @@ -1133,7 +1229,8 @@ System.Threading.Tasks.Task - +

    A task that represents the asynchronous set operation.

    + @@ -1158,7 +1255,8 @@

    SetStatusAsync(UserStatus)

    -
    +

    Sets the current status of the user (e.g. Online, Do not Disturb).

    +
    Declaration
    @@ -1177,7 +1275,8 @@ UserStatus status - +

    The new status to be set.

    + @@ -1192,7 +1291,8 @@ System.Threading.Tasks.Task - +

    A task that represents the asynchronous set operation.

    + @@ -1211,7 +1311,8 @@

    StartAsync()

    -
    +

    Starts the connection between Discord and the client..

    +
    Declaration
    @@ -1228,12 +1329,20 @@ System.Threading.Tasks.Task - +

    A task that represents the asynchronous start operation.

    +
    Overrides
    +
    Remarks
    +

    This method will initialize the connection between the client and Discord.

    +
    important

    + This method will immediately return after it is called, as it will initialize the connection on + another thread. +

    +
    | Improve this Doc @@ -1243,7 +1352,8 @@

    StopAsync()

    -
    +

    Stops the connection between Discord and the client.

    +
    Declaration
    @@ -1260,7 +1370,8 @@ System.Threading.Tasks.Task - +

    A task that represents the asynchronous stop operation.

    + @@ -1399,7 +1510,8 @@

    IDiscordClient.CreateGuildAsync(String, IVoiceRegion, Stream, RequestOptions)

    -
    +

    Creates a guild for the logged-in user who is in less than 10 active guilds.

    +
    Declaration
    @@ -1418,22 +1530,26 @@ System.String name - +

    The name of the new guild.

    + IVoiceRegion region - +

    The voice region to create the guild with.

    + System.IO.Stream jpegIcon - +

    The icon of the guild.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -1448,10 +1564,17 @@ System.Threading.Tasks.Task<IGuild> - +

    A task that represents the asynchronous creation operation. The task result contains the created guild.

    + +
    Remarks
    +

    This method creates a new guild on behalf of the logged-in user.

    +
    warning

    + Due to Discord's limitation, this method will only work for users that are in less than 10 guilds. +

    +
    | Improve this Doc @@ -1461,7 +1584,8 @@

    IDiscordClient.GetApplicationInfoAsync(RequestOptions)

    -
    +

    Gets a Discord application information for the logged-in user.

    +
    Declaration
    @@ -1480,7 +1604,8 @@ RequestOptions options - +

    The options to be used when sending the request.

    + @@ -1495,10 +1620,16 @@ System.Threading.Tasks.Task<IApplication> - +

    A task that represents the asynchronous get operation. The task result contains the application +information.

    + +
    Remarks
    +

    This method reflects your application information you submitted when creating a Discord application via +the Developer Portal.

    +
    | Improve this Doc @@ -1508,7 +1639,8 @@

    IDiscordClient.GetChannelAsync(UInt64, CacheMode, RequestOptions)

    -
    +

    Gets a generic channel.

    +
    Declaration
    @@ -1527,17 +1659,20 @@ System.UInt64 id - +

    The snowflake identifier of the channel (e.g. 381889909113225237).

    + CacheMode mode - +

    The CacheMode that determines whether the object should be fetched from cache.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -1552,7 +1687,9 @@ System.Threading.Tasks.Task<IChannel> - +

    A task that represents the asynchronous get operation. The task result contains the channel associated +with the snowflake identifier; null when the channel cannot be found.

    + @@ -1565,7 +1702,8 @@

    IDiscordClient.GetConnectionsAsync(RequestOptions)

    -
    +

    Gets the connections that the user has set up.

    +
    Declaration
    @@ -1584,7 +1722,8 @@ RequestOptions options - +

    The options to be used when sending the request.

    + @@ -1599,7 +1738,8 @@ System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyCollection<IConnection>> - +

    A task that represents the asynchronous get operation. The task result contains a read-only collection of connections.

    + @@ -1612,7 +1752,8 @@

    IDiscordClient.GetDMChannelsAsync(CacheMode, RequestOptions)

    -
    +

    Gets a collection of direct message channels opened in this session.

    +
    Declaration
    @@ -1631,12 +1772,14 @@ CacheMode mode - +

    The CacheMode that determines whether the object should be fetched from cache.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -1651,10 +1794,19 @@ System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyCollection<IDMChannel>> - +

    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.

    + +
    Remarks
    +

    This method returns a collection of currently opened direct message channels.

    +
    warning

    + 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. +

    +
    | Improve this Doc @@ -1664,7 +1816,8 @@

    IDiscordClient.GetGroupChannelsAsync(CacheMode, RequestOptions)

    -
    +

    Gets a collection of group channels opened in this session.

    +
    Declaration
    @@ -1683,12 +1836,14 @@ CacheMode mode - +

    The CacheMode that determines whether the object should be fetched from cache.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -1703,10 +1858,19 @@ System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyCollection<IGroupChannel>> - +

    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.

    + +
    Remarks
    +

    This method returns a collection of currently opened group channels.

    +
    warning

    + 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. +

    +
    | Improve this Doc @@ -1716,7 +1880,8 @@

    IDiscordClient.GetGuildAsync(UInt64, CacheMode, RequestOptions)

    -
    +

    Gets a guild.

    +
    Declaration
    @@ -1735,17 +1900,20 @@ System.UInt64 id - +

    The guild snowflake identifier.

    + CacheMode mode - +

    The CacheMode that determines whether the object should be fetched from cache.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -1760,7 +1928,9 @@ System.Threading.Tasks.Task<IGuild> - +

    A task that represents the asynchronous get operation. The task result contains the guild associated +with the snowflake identifier; null when the guild cannot be found.

    + @@ -1773,7 +1943,8 @@

    IDiscordClient.GetGuildsAsync(CacheMode, RequestOptions)

    -
    +

    Gets a collection of guilds that the user is currently in.

    +
    Declaration
    @@ -1792,12 +1963,14 @@ CacheMode mode - +

    The CacheMode that determines whether the object should be fetched from cache.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -1812,7 +1985,9 @@ System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyCollection<IGuild>> - +

    A task that represents the asynchronous get operation. The task result contains a read-only collection +of guilds that the current user is in.

    + @@ -1825,7 +2000,8 @@

    IDiscordClient.GetInviteAsync(String, RequestOptions)

    -
    +

    Gets an invite.

    +
    Declaration
    @@ -1844,12 +2020,14 @@ System.String inviteId - +

    The invitation identifier.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -1864,7 +2042,8 @@ System.Threading.Tasks.Task<IInvite> - +

    A task that represents the asynchronous get operation. The task result contains the invite information.

    + @@ -1877,7 +2056,8 @@

    IDiscordClient.GetPrivateChannelsAsync(CacheMode, RequestOptions)

    -
    +

    Gets a collection of private channels opened in this session.

    +
    Declaration
    @@ -1896,12 +2076,14 @@ CacheMode mode - +

    The CacheMode that determines whether the object should be fetched from cache.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -1916,10 +2098,20 @@ System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyCollection<IPrivateChannel>> - +

    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.

    + +
    Remarks
    +

    This method will retrieve all private channels (including direct-message, group channel and such) that +are currently opened in this session.

    +
    warning

    + 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. +

    +
    | Improve this Doc @@ -1929,7 +2121,8 @@

    IDiscordClient.GetUserAsync(String, String, RequestOptions)

    -
    +

    Gets a user.

    +
    Declaration
    @@ -1948,17 +2141,20 @@ System.String username - +

    The name of the user (e.g. Still).

    + System.String discriminator - +

    The discriminator value of the user (e.g. 2876).

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -1973,7 +2169,9 @@ System.Threading.Tasks.Task<IUser> - +

    A task that represents the asynchronous get operation. The task result contains the user associated with +the name and the discriminator; null if the user is not found.

    + @@ -1986,7 +2184,8 @@

    IDiscordClient.GetUserAsync(UInt64, CacheMode, RequestOptions)

    -
    +

    Gets a user.

    +
    Declaration
    @@ -2005,17 +2204,20 @@ System.UInt64 id - +

    The snowflake identifier of the user (e.g. 168693960628371456).

    + CacheMode mode - +

    The CacheMode that determines whether the object should be fetched from cache.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -2030,7 +2232,9 @@ System.Threading.Tasks.Task<IUser> - +

    A task that represents the asynchronous get operation. The task result contains the user associated with +the snowflake identifier; null if the user is not found.

    + @@ -2043,7 +2247,8 @@

    IDiscordClient.GetVoiceRegionAsync(String, RequestOptions)

    -
    +

    Gets a voice region.

    +
    Declaration
    @@ -2062,12 +2267,14 @@ System.String id - +

    The identifier of the voice region (e.g. eu-central ).

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -2082,7 +2289,9 @@ System.Threading.Tasks.Task<IVoiceRegion> - +

    A task that represents the asynchronous get operation. The task result contains the voice region +associated with the identifier; null if the voice region is not found.

    + @@ -2095,7 +2304,8 @@

    IDiscordClient.GetVoiceRegionsAsync(RequestOptions)

    -
    +

    Gets a collection of the available voice regions.

    +
    Declaration
    @@ -2114,7 +2324,8 @@ RequestOptions options - +

    The options to be used when sending the request.

    + @@ -2129,7 +2340,9 @@ System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyCollection<IVoiceRegion>> - +

    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.

    + @@ -2142,7 +2355,8 @@

    IDiscordClient.StartAsync()

    -
    +

    Starts the connection between Discord and the client..

    +
    Declaration
    @@ -2159,10 +2373,18 @@ System.Threading.Tasks.Task - +

    A task that represents the asynchronous start operation.

    + +
    Remarks
    +

    This method will initialize the connection between the client and Discord.

    +
    important

    + This method will immediately return after it is called, as it will initialize the connection on + another thread. +

    +
    | Improve this Doc @@ -2172,7 +2394,8 @@

    IDiscordClient.StopAsync()

    -
    +

    Stops the connection between Discord and the client.

    +
    Declaration
    @@ -2189,7 +2412,8 @@ System.Threading.Tasks.Task - +

    A task that represents the asynchronous stop operation.

    + diff --git a/docs/api/Discord.WebSocket.SocketCategoryChannel.html b/docs/api/Discord.WebSocket.SocketCategoryChannel.html index 53511cb8f..a051b8888 100644 --- a/docs/api/Discord.WebSocket.SocketCategoryChannel.html +++ b/docs/api/Discord.WebSocket.SocketCategoryChannel.html @@ -237,7 +237,8 @@ channel.

    Users

    -
    +

    Gets a collection of users that are able to view the channel.

    +
    Declaration
    @@ -254,7 +255,8 @@ channel.

    System.Collections.Generic.IReadOnlyCollection<SocketGuildUser> - +

    A read-only collection of users that can access the channel (i.e. the users seen in the user list).

    + @@ -322,7 +324,8 @@ channel.

    IChannel.GetUserAsync(UInt64, CacheMode, RequestOptions)

    -
    +

    Gets a user in this channel.

    +
    Declaration
    @@ -341,17 +344,20 @@ channel.

    System.UInt64 id - +

    The snowflake identifier of the user (e.g. 168693960628371456).

    + CacheMode mode - +

    The CacheMode that determines whether the object should be fetched from cache.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -366,7 +372,9 @@ channel.

    System.Threading.Tasks.Task<IUser> - +

    A task that represents the asynchronous get operation. The task result contains a user object that +represents the found user; null if none is found.

    + @@ -379,7 +387,8 @@ channel.

    IGuildChannel.GetUserAsync(UInt64, CacheMode, RequestOptions)

    -
    +

    Gets a user in this channel.

    +
    Declaration
    @@ -398,17 +407,20 @@ channel.

    System.UInt64 id - +

    The snowflake identifier of the user.

    + CacheMode mode - +

    The CacheMode that determines whether the object should be fetched from cache.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -423,7 +435,9 @@ channel.

    System.Threading.Tasks.Task<IGuildUser> - +

    A task representing the asynchronous get operation. The task result contains a guild user object that +represents the user; null if none is found.

    + diff --git a/docs/api/Discord.WebSocket.SocketChannel.html b/docs/api/Discord.WebSocket.SocketChannel.html index c3f172b3a..a0b95fceb 100644 --- a/docs/api/Discord.WebSocket.SocketChannel.html +++ b/docs/api/Discord.WebSocket.SocketChannel.html @@ -251,7 +251,8 @@

    IChannel.GetUserAsync(UInt64, CacheMode, RequestOptions)

    -
    +

    Gets a user in this channel.

    +
    Declaration
    @@ -270,17 +271,20 @@ System.UInt64 id - +

    The snowflake identifier of the user (e.g. 168693960628371456).

    + CacheMode mode - +

    The CacheMode that determines whether the object should be fetched from cache.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -295,7 +299,9 @@ System.Threading.Tasks.Task<IUser> - +

    A task that represents the asynchronous get operation. The task result contains a user object that +represents the found user; null if none is found.

    + @@ -308,7 +314,8 @@

    IChannel.Name

    -
    +

    Gets the name of this channel.

    +
    Declaration
    @@ -325,7 +332,8 @@ System.String - +

    A string containing the name of this channel.

    + diff --git a/docs/api/Discord.WebSocket.SocketDMChannel.html b/docs/api/Discord.WebSocket.SocketDMChannel.html index f6bfa6712..468d8c04b 100644 --- a/docs/api/Discord.WebSocket.SocketDMChannel.html +++ b/docs/api/Discord.WebSocket.SocketDMChannel.html @@ -138,7 +138,8 @@

    CachedMessages

    -
    +

    Gets all messages in this channel's cache.

    +
    Declaration
    @@ -155,7 +156,8 @@ System.Collections.Generic.IReadOnlyCollection<SocketMessage> - +

    A read-only collection of WebSocket-based messages.

    + @@ -232,7 +234,8 @@

    CloseAsync(RequestOptions)

    -
    +

    Closes this private channel, removing it from your channel list.

    +
    Declaration
    @@ -251,7 +254,8 @@ RequestOptions options - +

    The options to be used when sending the request.

    + @@ -266,7 +270,8 @@ System.Threading.Tasks.Task - +

    A task that represents the asynchronous close operation.

    + @@ -279,7 +284,8 @@

    DeleteMessageAsync(IMessage, RequestOptions)

    -
    +

    Deletes a message based on the provided message in this channel.

    +
    Declaration
    @@ -298,12 +304,14 @@ IMessage message - +

    The message that would be removed.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -318,7 +326,8 @@ System.Threading.Tasks.Task - +

    A task that represents the asynchronous removal operation.

    + @@ -331,7 +340,8 @@

    DeleteMessageAsync(UInt64, RequestOptions)

    -
    +

    Deletes a message.

    +
    Declaration
    @@ -350,12 +360,14 @@ System.UInt64 messageId - +

    The snowflake identifier of the message that would be removed.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -370,7 +382,8 @@ System.Threading.Tasks.Task - +

    A task that represents the asynchronous removal operation.

    + @@ -383,7 +396,9 @@

    EnterTypingState(RequestOptions)

    -
    +

    Continuously broadcasts the "user is typing" message to all users in this channel until the returned +object is disposed.

    +
    Declaration
    @@ -402,7 +417,8 @@ RequestOptions options - +

    The options to be used when sending the request.

    + @@ -417,7 +433,9 @@ System.IDisposable - +

    A disposable object that, upon its disposal, will stop the client from broadcasting its typing state in +this channel.

    + @@ -430,7 +448,8 @@

    GetCachedMessage(UInt64)

    -
    +

    Gets a cached message from this channel.

    +
    Declaration
    @@ -449,7 +468,8 @@ System.UInt64 id - +

    The snowflake identifier of the message.

    + @@ -464,10 +484,23 @@ SocketMessage - +

    A WebSocket-based message object; null if it does not exist in the cache or if caching is not +enabled.

    + +
    Remarks
    +
    warning

    + This method requires the use of cache, which is not enabled by default; if caching is not enabled, + this method will always return null. Please refer to +MessageCacheSize for more details. +

    +

    + 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. +

    +
    | Improve this Doc @@ -477,7 +510,8 @@

    GetCachedMessages(IMessage, Direction, Int32)

    -
    +

    Gets the last N cached messages starting from a certain message in this message channel.

    +
    Declaration
    @@ -496,17 +530,20 @@ IMessage fromMessage - +

    The message to start the fetching from.

    + Direction dir - +

    The direction of which the message should be gotten from.

    + System.Int32 limit - +

    The number of messages to get.

    + @@ -521,10 +558,24 @@ System.Collections.Generic.IReadOnlyCollection<SocketMessage> - +

    A read-only collection of WebSocket-based messages.

    + +
    Remarks
    +
    warning

    + 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 +MessageCacheSize for more details. +

    +

    + 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 +MessageCacheSize set. +

    +
    | Improve this Doc @@ -534,7 +585,8 @@

    GetCachedMessages(Int32)

    -
    +

    Gets the last N cached messages from this message channel.

    +
    Declaration
    @@ -553,7 +605,8 @@ System.Int32 limit - +

    The number of messages to get.

    + @@ -568,10 +621,24 @@ System.Collections.Generic.IReadOnlyCollection<SocketMessage> - +

    A read-only collection of WebSocket-based messages.

    + +
    Remarks
    +
    warning

    + 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 +MessageCacheSize for more details. +

    +

    + 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 +MessageCacheSize set. +

    +
    | Improve this Doc @@ -581,7 +648,8 @@

    GetCachedMessages(UInt64, Direction, Int32)

    -
    +

    Gets the last N cached messages starting from a certain message in this message channel.

    +
    Declaration
    @@ -600,17 +668,20 @@ System.UInt64 fromMessageId - +

    The message ID to start the fetching from.

    + Direction dir - +

    The direction of which the message should be gotten from.

    + System.Int32 limit - +

    The number of messages to get.

    + @@ -625,10 +696,24 @@ System.Collections.Generic.IReadOnlyCollection<SocketMessage> - +

    A read-only collection of WebSocket-based messages.

    + +
    Remarks
    +
    warning

    + 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 +MessageCacheSize for more details. +

    +

    + 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 +MessageCacheSize set. +

    +
    | Improve this Doc @@ -898,7 +983,8 @@ Please visit its documentation for more details on this method.

    GetPinnedMessagesAsync(RequestOptions)

    -
    +

    Gets a read-only collection of pinned messages in this channel.

    +
    Declaration
    @@ -917,7 +1003,8 @@ Please visit its documentation for more details on this method.

    RequestOptions options - +

    The options to be used when sending the request.

    + @@ -932,10 +1019,16 @@ Please visit its documentation for more details on this method.

    System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyCollection<RestMessage>> - +

    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.

    + +
    Remarks
    +

    This method follows the same behavior as described in GetPinnedMessagesAsync(RequestOptions). +Please visit its documentation for more details on this method.

    +
    | Improve this Doc @@ -995,7 +1088,8 @@ Please visit its documentation for more details on this method.

    SendFileAsync(Stream, String, String, Boolean, Embed, RequestOptions, Boolean)

    -
    +

    Sends a file to this message channel with an optional caption.

    +
    Declaration
    @@ -1014,37 +1108,44 @@ Please visit its documentation for more details on this method.

    System.IO.Stream stream - +

    The System.IO.Stream of the file to be sent.

    + System.String filename - +

    The name of the attachment.

    + System.String text - +

    The message to be sent.

    + System.Boolean isTTS - +

    Whether the message should be read aloud by Discord or not.

    + Embed embed - +

    The Rich Embed to be sent.

    + RequestOptions options - +

    The options to be used when sending the request.

    + System.Boolean isSpoiler - +

    Whether the message attachment should be hidden as a spoiler.

    + @@ -1059,10 +1160,16 @@ Please visit its documentation for more details on this method.

    System.Threading.Tasks.Task<RestUserMessage> - +

    A task that represents an asynchronous send operation for delivering the message. The task result +contains the sent message.

    + +
    Remarks
    +

    This method follows the same behavior as described in SendFileAsync(Stream, String, String, Boolean, Embed, RequestOptions, Boolean). +Please visit its documentation for more details on this method.

    +
    Exceptions
    @@ -1088,7 +1195,8 @@ Please visit its documentation for more details on this method.

    SendFileAsync(String, String, Boolean, Embed, RequestOptions, Boolean)

    -
    +

    Sends a file to this message channel with an optional caption.

    +
    Declaration
    @@ -1107,32 +1215,38 @@ Please visit its documentation for more details on this method.

    - + - + - + - + - + - +
    System.String filePath

    The file path of the file.

    +
    System.String text

    The message to be sent.

    +
    System.Boolean isTTS

    Whether the message should be read aloud by Discord or not.

    +
    Embed embed

    The Rich Embed to be sent.

    +
    RequestOptions options

    The options to be used when sending the request.

    +
    System.Boolean isSpoiler

    Whether the message attachment should be hidden as a spoiler.

    +
    @@ -1147,10 +1261,16 @@ Please visit its documentation for more details on this method.

    System.Threading.Tasks.Task<RestUserMessage> - +

    A task that represents an asynchronous send operation for delivering the message. The task result +contains the sent message.

    + +
    Remarks
    +

    This method follows the same behavior as described in SendFileAsync(String, String, Boolean, Embed, RequestOptions, Boolean). +Please visit its documentation for more details on this method.

    +
    | Improve this Doc @@ -1160,7 +1280,8 @@ Please visit its documentation for more details on this method.

    SendMessageAsync(String, Boolean, Embed, RequestOptions)

    -
    +

    Sends a message to this message channel.

    +
    Declaration
    @@ -1179,22 +1300,26 @@ Please visit its documentation for more details on this method.

    System.String text - +

    The message to be sent.

    + System.Boolean isTTS - +

    Determines whether the message should be read aloud by Discord or not.

    + Embed embed - +

    The Rich Embed to be sent.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -1209,10 +1334,16 @@ Please visit its documentation for more details on this method.

    System.Threading.Tasks.Task<RestUserMessage> - +

    A task that represents an asynchronous send operation for delivering the message. The task result +contains the sent message.

    + +
    Remarks
    +

    This method follows the same behavior as described in SendMessageAsync(String, Boolean, Embed, RequestOptions). +Please visit its documentation for more details on this method.

    +
    Exceptions
    @@ -1271,7 +1402,8 @@ Please visit its documentation for more details on this method.

    TriggerTypingAsync(RequestOptions)

    -
    +

    Broadcasts the "user is typing" message to all users in this channel, lasting 10 seconds.

    +
    Declaration
    @@ -1290,7 +1422,8 @@ Please visit its documentation for more details on this method.

    - +
    RequestOptions options

    The options to be used when sending the request.

    +
    @@ -1305,7 +1438,8 @@ Please visit its documentation for more details on this method.

    System.Threading.Tasks.Task - +

    A task that represents the asynchronous operation that triggers the broadcast.

    + @@ -1320,7 +1454,8 @@ Please visit its documentation for more details on this method.

    IChannel.GetUserAsync(UInt64, CacheMode, RequestOptions)

    -
    +

    Gets a user in this channel.

    +
    Declaration
    @@ -1339,17 +1474,20 @@ Please visit its documentation for more details on this method.

    System.UInt64 id - +

    The snowflake identifier of the user (e.g. 168693960628371456).

    + CacheMode mode - +

    The CacheMode that determines whether the object should be fetched from cache.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -1364,7 +1502,9 @@ Please visit its documentation for more details on this method.

    System.Threading.Tasks.Task<IUser> - +

    A task that represents the asynchronous get operation. The task result contains a user object that +represents the found user; null if none is found.

    + @@ -1377,7 +1517,8 @@ Please visit its documentation for more details on this method.

    IChannel.Name

    -
    +

    Gets the name of this channel.

    +
    Declaration
    @@ -1394,7 +1535,8 @@ Please visit its documentation for more details on this method.

    System.String - +

    A string containing the name of this channel.

    + @@ -1407,7 +1549,8 @@ Please visit its documentation for more details on this method.

    IDMChannel.Recipient

    -
    +

    Gets the recipient of all messages in this channel.

    +
    Declaration
    @@ -1424,7 +1567,8 @@ Please visit its documentation for more details on this method.

    IUser - +

    A user object that represents the other user in this channel.

    + @@ -1437,7 +1581,8 @@ Please visit its documentation for more details on this method.

    IMessageChannel.GetMessageAsync(UInt64, CacheMode, RequestOptions)

    -
    +

    Gets a message from this message channel.

    +
    Declaration
    @@ -1456,17 +1601,20 @@ Please visit its documentation for more details on this method.

    System.UInt64 id - +

    The snowflake identifier of the message.

    + CacheMode mode - +

    The CacheMode that determines whether the object should be fetched from cache.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -1481,7 +1629,9 @@ Please visit its documentation for more details on this method.

    System.Threading.Tasks.Task<IMessage> - +

    A task that represents an asynchronous get operation for retrieving the message. The task result contains +the retrieved message; null if no message is found with the specified identifier.

    + @@ -1494,7 +1644,8 @@ Please visit its documentation for more details on this method.

    IMessageChannel.GetPinnedMessagesAsync(RequestOptions)

    -
    +

    Gets a collection of pinned messages in this channel.

    +
    Declaration
    @@ -1513,7 +1664,8 @@ Please visit its documentation for more details on this method.

    RequestOptions options - +

    The options to be used when sending the request.

    + @@ -1528,7 +1680,9 @@ Please visit its documentation for more details on this method.

    System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyCollection<IMessage>> - +

    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.

    + @@ -1541,7 +1695,8 @@ Please visit its documentation for more details on this method.

    IMessageChannel.SendFileAsync(Stream, String, String, Boolean, Embed, RequestOptions, Boolean)

    -
    +

    Sends a file to this message channel with an optional caption.

    +
    Declaration
    @@ -1560,37 +1715,44 @@ Please visit its documentation for more details on this method.

    System.IO.Stream stream - +

    The System.IO.Stream of the file to be sent.

    + System.String filename - +

    The name of the attachment.

    + System.String text - +

    The message to be sent.

    + System.Boolean isTTS - +

    Whether the message should be read aloud by Discord or not.

    + Embed embed - +

    The Rich Embed to be sent.

    + RequestOptions options - +

    The options to be used when sending the request.

    + System.Boolean isSpoiler - +

    Whether the message attachment should be hidden as a spoiler.

    + @@ -1605,10 +1767,20 @@ Please visit its documentation for more details on this method.

    System.Threading.Tasks.Task<IUserMessage> - +

    A task that represents an asynchronous send operation for delivering the message. The task result +contains the sent message.

    + +
    Remarks
    +

    This method sends a file as if you are uploading an attachment directly from your Discord client.

    +
    note

    + If you wish to upload an image and have it embedded in a Rich embed, + you may upload the file and refer to the file with "attachment://filename.ext" in the +ImageUrl. See the example section for its usage. +

    +
    | Improve this Doc @@ -1618,7 +1790,8 @@ Please visit its documentation for more details on this method.

    IMessageChannel.SendFileAsync(String, String, Boolean, Embed, RequestOptions, Boolean)

    -
    +

    Sends a file to this message channel with an optional caption.

    +
    Declaration
    @@ -1637,32 +1810,38 @@ Please visit its documentation for more details on this method.

    System.String filePath - +

    The file path of the file.

    + System.String text - +

    The message to be sent.

    + System.Boolean isTTS - +

    Whether the message should be read aloud by Discord or not.

    + Embed embed - +

    The Rich Embed to be sent.

    + RequestOptions options - +

    The options to be used when sending the request.

    + System.Boolean isSpoiler - +

    Whether the message attachment should be hidden as a spoiler.

    + @@ -1677,10 +1856,20 @@ Please visit its documentation for more details on this method.

    System.Threading.Tasks.Task<IUserMessage> - +

    A task that represents an asynchronous send operation for delivering the message. The task result +contains the sent message.

    + +
    Remarks
    +

    This method sends a file as if you are uploading an attachment directly from your Discord client.

    +
    note

    + If you wish to upload an image and have it embedded in a Rich embed, + you may upload the file and refer to the file with "attachment://filename.ext" in the +ImageUrl. See the example section for its usage. +

    +
    | Improve this Doc @@ -1690,7 +1879,8 @@ Please visit its documentation for more details on this method.

    IMessageChannel.SendMessageAsync(String, Boolean, Embed, RequestOptions)

    -
    +

    Sends a message to this message channel.

    +
    Declaration
    @@ -1709,22 +1899,26 @@ Please visit its documentation for more details on this method.

    System.String text - +

    The message to be sent.

    + System.Boolean isTTS - +

    Determines whether the message should be read aloud by Discord or not.

    + Embed embed - +

    The Rich Embed to be sent.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -1739,7 +1933,9 @@ Please visit its documentation for more details on this method.

    System.Threading.Tasks.Task<IUserMessage> - +

    A task that represents an asynchronous send operation for delivering the message. The task result +contains the sent message.

    + @@ -1752,7 +1948,8 @@ Please visit its documentation for more details on this method.

    IPrivateChannel.Recipients

    -
    +

    Gets the users that can access this channel.

    +
    Declaration
    @@ -1769,7 +1966,8 @@ Please visit its documentation for more details on this method.

    System.Collections.Generic.IReadOnlyCollection<IUser> - +

    A read-only collection of users that can access this channel.

    + diff --git a/docs/api/Discord.WebSocket.SocketGroupChannel.html b/docs/api/Discord.WebSocket.SocketGroupChannel.html index 52b790cc0..496148ec5 100644 --- a/docs/api/Discord.WebSocket.SocketGroupChannel.html +++ b/docs/api/Discord.WebSocket.SocketGroupChannel.html @@ -143,7 +143,8 @@

    CachedMessages

    -
    +

    Gets all messages in this channel's cache.

    +
    Declaration
    @@ -160,7 +161,8 @@ System.Collections.Generic.IReadOnlyCollection<SocketMessage> - +

    A read-only collection of WebSocket-based messages.

    + @@ -173,7 +175,8 @@

    Name

    -
    +

    Gets the name of this channel.

    +
    Declaration
    @@ -190,7 +193,8 @@ System.String - +

    A string containing the name of this channel.

    + @@ -311,7 +315,8 @@

    DeleteMessageAsync(IMessage, RequestOptions)

    -
    +

    Deletes a message based on the provided message in this channel.

    +
    Declaration
    @@ -330,12 +335,14 @@ IMessage message - +

    The message that would be removed.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -350,7 +357,8 @@ System.Threading.Tasks.Task - +

    A task that represents the asynchronous removal operation.

    + @@ -363,7 +371,8 @@

    DeleteMessageAsync(UInt64, RequestOptions)

    -
    +

    Deletes a message.

    +
    Declaration
    @@ -382,12 +391,14 @@ System.UInt64 messageId - +

    The snowflake identifier of the message that would be removed.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -402,7 +413,8 @@ System.Threading.Tasks.Task - +

    A task that represents the asynchronous removal operation.

    + @@ -415,7 +427,9 @@

    EnterTypingState(RequestOptions)

    -
    +

    Continuously broadcasts the "user is typing" message to all users in this channel until the returned +object is disposed.

    +
    Declaration
    @@ -434,7 +448,8 @@ RequestOptions options - +

    The options to be used when sending the request.

    + @@ -449,7 +464,9 @@ System.IDisposable - +

    A disposable object that, upon its disposal, will stop the client from broadcasting its typing state in +this channel.

    + @@ -462,7 +479,8 @@

    GetCachedMessage(UInt64)

    -
    +

    Gets a cached message from this channel.

    +
    Declaration
    @@ -481,7 +499,8 @@ System.UInt64 id - +

    The snowflake identifier of the message.

    + @@ -496,10 +515,23 @@ SocketMessage - +

    A WebSocket-based message object; null if it does not exist in the cache or if caching is not +enabled.

    + +
    Remarks
    +
    warning

    + This method requires the use of cache, which is not enabled by default; if caching is not enabled, + this method will always return null. Please refer to +MessageCacheSize for more details. +

    +

    + 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. +

    +
    | Improve this Doc @@ -509,7 +541,8 @@

    GetCachedMessages(IMessage, Direction, Int32)

    -
    +

    Gets the last N cached messages starting from a certain message in this message channel.

    +
    Declaration
    @@ -528,17 +561,20 @@ IMessage fromMessage - +

    The message to start the fetching from.

    + Direction dir - +

    The direction of which the message should be gotten from.

    + System.Int32 limit - +

    The number of messages to get.

    + @@ -553,10 +589,24 @@ System.Collections.Generic.IReadOnlyCollection<SocketMessage> - +

    A read-only collection of WebSocket-based messages.

    + +
    Remarks
    +
    warning

    + 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 +MessageCacheSize for more details. +

    +

    + 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 +MessageCacheSize set. +

    +
    | Improve this Doc @@ -566,7 +616,8 @@

    GetCachedMessages(Int32)

    -
    +

    Gets the last N cached messages from this message channel.

    +
    Declaration
    @@ -585,7 +636,8 @@ System.Int32 limit - +

    The number of messages to get.

    + @@ -600,10 +652,24 @@ System.Collections.Generic.IReadOnlyCollection<SocketMessage> - +

    A read-only collection of WebSocket-based messages.

    + +
    Remarks
    +
    warning

    + 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 +MessageCacheSize for more details. +

    +

    + 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 +MessageCacheSize set. +

    +
    | Improve this Doc @@ -613,7 +679,8 @@

    GetCachedMessages(UInt64, Direction, Int32)

    -
    +

    Gets the last N cached messages starting from a certain message in this message channel.

    +
    Declaration
    @@ -632,17 +699,20 @@ System.UInt64 fromMessageId - +

    The message ID to start the fetching from.

    + Direction dir - +

    The direction of which the message should be gotten from.

    + System.Int32 limit - +

    The number of messages to get.

    + @@ -657,10 +727,24 @@ System.Collections.Generic.IReadOnlyCollection<SocketMessage> - +

    A read-only collection of WebSocket-based messages.

    + +
    Remarks
    +
    warning

    + 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 +MessageCacheSize for more details. +

    +

    + 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 +MessageCacheSize set. +

    +
    | Improve this Doc @@ -935,7 +1019,8 @@ Please visit its documentation for more details on this method.

    GetPinnedMessagesAsync(RequestOptions)

    -
    +

    Gets a read-only collection of pinned messages in this channel.

    +
    Declaration
    @@ -954,7 +1039,8 @@ Please visit its documentation for more details on this method.

    RequestOptions options - +

    The options to be used when sending the request.

    + @@ -969,10 +1055,16 @@ Please visit its documentation for more details on this method.

    System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyCollection<RestMessage>> - +

    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.

    + +
    Remarks
    +

    This method follows the same behavior as described in GetPinnedMessagesAsync(RequestOptions). +Please visit its documentation for more details on this method.

    +
    | Improve this Doc @@ -1032,7 +1124,8 @@ Please visit its documentation for more details on this method.

    LeaveAsync(RequestOptions)

    -
    +

    Leaves this group.

    +
    Declaration
    @@ -1051,7 +1144,8 @@ Please visit its documentation for more details on this method.

    RequestOptions options - +

    The options to be used when sending the request.

    + @@ -1066,7 +1160,8 @@ Please visit its documentation for more details on this method.

    System.Threading.Tasks.Task - +

    A task that represents the asynchronous leave operation.

    + @@ -1079,7 +1174,8 @@ Please visit its documentation for more details on this method.

    SendFileAsync(Stream, String, String, Boolean, Embed, RequestOptions, Boolean)

    -
    +

    Sends a file to this message channel with an optional caption.

    +
    Declaration
    @@ -1098,37 +1194,44 @@ Please visit its documentation for more details on this method.

    System.IO.Stream stream - +

    The System.IO.Stream of the file to be sent.

    + System.String filename - +

    The name of the attachment.

    + System.String text - +

    The message to be sent.

    + System.Boolean isTTS - +

    Whether the message should be read aloud by Discord or not.

    + Embed embed - +

    The Rich Embed to be sent.

    + RequestOptions options - +

    The options to be used when sending the request.

    + System.Boolean isSpoiler - +

    Whether the message attachment should be hidden as a spoiler.

    + @@ -1143,10 +1246,16 @@ Please visit its documentation for more details on this method.

    System.Threading.Tasks.Task<RestUserMessage> - +

    A task that represents an asynchronous send operation for delivering the message. The task result +contains the sent message.

    + +
    Remarks
    +

    This method follows the same behavior as described in SendFileAsync(Stream, String, String, Boolean, Embed, RequestOptions, Boolean). +Please visit its documentation for more details on this method.

    +
    | Improve this Doc @@ -1156,7 +1265,8 @@ Please visit its documentation for more details on this method.

    SendFileAsync(String, String, Boolean, Embed, RequestOptions, Boolean)

    -
    +

    Sends a file to this message channel with an optional caption.

    +
    Declaration
    @@ -1175,32 +1285,38 @@ Please visit its documentation for more details on this method.

    System.String filePath - +

    The file path of the file.

    + System.String text - +

    The message to be sent.

    + System.Boolean isTTS - +

    Whether the message should be read aloud by Discord or not.

    + Embed embed - +

    The Rich Embed to be sent.

    + RequestOptions options - +

    The options to be used when sending the request.

    + System.Boolean isSpoiler - +

    Whether the message attachment should be hidden as a spoiler.

    + @@ -1215,10 +1331,16 @@ Please visit its documentation for more details on this method.

    System.Threading.Tasks.Task<RestUserMessage> - +

    A task that represents an asynchronous send operation for delivering the message. The task result +contains the sent message.

    + +
    Remarks
    +

    This method follows the same behavior as described in SendFileAsync(String, String, Boolean, Embed, RequestOptions, Boolean). +Please visit its documentation for more details on this method.

    +
    | Improve this Doc @@ -1228,7 +1350,8 @@ Please visit its documentation for more details on this method.

    SendMessageAsync(String, Boolean, Embed, RequestOptions)

    -
    +

    Sends a message to this message channel.

    +
    Declaration
    @@ -1247,22 +1370,26 @@ Please visit its documentation for more details on this method.

    System.String text - +

    The message to be sent.

    + System.Boolean isTTS - +

    Determines whether the message should be read aloud by Discord or not.

    + Embed embed - +

    The Rich Embed to be sent.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -1277,10 +1404,16 @@ Please visit its documentation for more details on this method.

    System.Threading.Tasks.Task<RestUserMessage> - +

    A task that represents an asynchronous send operation for delivering the message. The task result +contains the sent message.

    + +
    Remarks
    +

    This method follows the same behavior as described in SendMessageAsync(String, Boolean, Embed, RequestOptions). +Please visit its documentation for more details on this method.

    +
    Exceptions
    @@ -1339,7 +1472,8 @@ Please visit its documentation for more details on this method.

    TriggerTypingAsync(RequestOptions)

    -
    +

    Broadcasts the "user is typing" message to all users in this channel, lasting 10 seconds.

    +
    Declaration
    @@ -1358,7 +1492,8 @@ Please visit its documentation for more details on this method.

    - +
    RequestOptions options

    The options to be used when sending the request.

    +
    @@ -1373,7 +1508,8 @@ Please visit its documentation for more details on this method.

    System.Threading.Tasks.Task - +

    A task that represents the asynchronous operation that triggers the broadcast.

    + @@ -1388,7 +1524,8 @@ Please visit its documentation for more details on this method.

    IAudioChannel.ConnectAsync(Boolean, Boolean, Boolean)

    -
    +

    Connects to this audio channel.

    +
    Declaration
    @@ -1407,17 +1544,20 @@ Please visit its documentation for more details on this method.

    System.Boolean selfDeaf - +

    Determines whether the client should deaf itself upon connection.

    + System.Boolean selfMute - +

    Determines whether the client should mute itself upon connection.

    + System.Boolean external - +

    Determines whether the audio client is an external one or not.

    + @@ -1432,7 +1572,9 @@ Please visit its documentation for more details on this method.

    System.Threading.Tasks.Task<IAudioClient> - +

    A task representing the asynchronous connection operation. The task result contains the +IAudioClient responsible for the connection.

    + @@ -1491,7 +1633,8 @@ Please visit its documentation for more details on this method.

    IChannel.GetUserAsync(UInt64, CacheMode, RequestOptions)

    -
    +

    Gets a user in this channel.

    +
    Declaration
    @@ -1510,17 +1653,20 @@ Please visit its documentation for more details on this method.

    System.UInt64 id - +

    The snowflake identifier of the user (e.g. 168693960628371456).

    + CacheMode mode - +

    The CacheMode that determines whether the object should be fetched from cache.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -1535,7 +1681,9 @@ Please visit its documentation for more details on this method.

    System.Threading.Tasks.Task<IUser> - +

    A task that represents the asynchronous get operation. The task result contains a user object that +represents the found user; null if none is found.

    + @@ -1548,7 +1696,8 @@ Please visit its documentation for more details on this method.

    IMessageChannel.GetMessageAsync(UInt64, CacheMode, RequestOptions)

    -
    +

    Gets a message from this message channel.

    +
    Declaration
    @@ -1567,17 +1716,20 @@ Please visit its documentation for more details on this method.

    System.UInt64 id - +

    The snowflake identifier of the message.

    + CacheMode mode - +

    The CacheMode that determines whether the object should be fetched from cache.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -1592,7 +1744,9 @@ Please visit its documentation for more details on this method.

    System.Threading.Tasks.Task<IMessage> - +

    A task that represents an asynchronous get operation for retrieving the message. The task result contains +the retrieved message; null if no message is found with the specified identifier.

    + @@ -1605,7 +1759,8 @@ Please visit its documentation for more details on this method.

    IMessageChannel.GetPinnedMessagesAsync(RequestOptions)

    -
    +

    Gets a collection of pinned messages in this channel.

    +
    Declaration
    @@ -1624,7 +1779,8 @@ Please visit its documentation for more details on this method.

    RequestOptions options - +

    The options to be used when sending the request.

    + @@ -1639,7 +1795,9 @@ Please visit its documentation for more details on this method.

    System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyCollection<IMessage>> - +

    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.

    + @@ -1652,7 +1810,8 @@ Please visit its documentation for more details on this method.

    IMessageChannel.SendFileAsync(Stream, String, String, Boolean, Embed, RequestOptions, Boolean)

    -
    +

    Sends a file to this message channel with an optional caption.

    +
    Declaration
    @@ -1671,37 +1830,44 @@ Please visit its documentation for more details on this method.

    System.IO.Stream stream - +

    The System.IO.Stream of the file to be sent.

    + System.String filename - +

    The name of the attachment.

    + System.String text - +

    The message to be sent.

    + System.Boolean isTTS - +

    Whether the message should be read aloud by Discord or not.

    + Embed embed - +

    The Rich Embed to be sent.

    + RequestOptions options - +

    The options to be used when sending the request.

    + System.Boolean isSpoiler - +

    Whether the message attachment should be hidden as a spoiler.

    + @@ -1716,10 +1882,20 @@ Please visit its documentation for more details on this method.

    System.Threading.Tasks.Task<IUserMessage> - +

    A task that represents an asynchronous send operation for delivering the message. The task result +contains the sent message.

    + +
    Remarks
    +

    This method sends a file as if you are uploading an attachment directly from your Discord client.

    +
    note

    + If you wish to upload an image and have it embedded in a Rich embed, + you may upload the file and refer to the file with "attachment://filename.ext" in the +ImageUrl. See the example section for its usage. +

    +
    | Improve this Doc @@ -1729,7 +1905,8 @@ Please visit its documentation for more details on this method.

    IMessageChannel.SendFileAsync(String, String, Boolean, Embed, RequestOptions, Boolean)

    -
    +

    Sends a file to this message channel with an optional caption.

    +
    Declaration
    @@ -1748,32 +1925,38 @@ Please visit its documentation for more details on this method.

    System.String filePath - +

    The file path of the file.

    + System.String text - +

    The message to be sent.

    + System.Boolean isTTS - +

    Whether the message should be read aloud by Discord or not.

    + Embed embed - +

    The Rich Embed to be sent.

    + RequestOptions options - +

    The options to be used when sending the request.

    + System.Boolean isSpoiler - +

    Whether the message attachment should be hidden as a spoiler.

    + @@ -1788,10 +1971,20 @@ Please visit its documentation for more details on this method.

    System.Threading.Tasks.Task<IUserMessage> - +

    A task that represents an asynchronous send operation for delivering the message. The task result +contains the sent message.

    + +
    Remarks
    +

    This method sends a file as if you are uploading an attachment directly from your Discord client.

    +
    note

    + If you wish to upload an image and have it embedded in a Rich embed, + you may upload the file and refer to the file with "attachment://filename.ext" in the +ImageUrl. See the example section for its usage. +

    +
    | Improve this Doc @@ -1801,7 +1994,8 @@ Please visit its documentation for more details on this method.

    IMessageChannel.SendMessageAsync(String, Boolean, Embed, RequestOptions)

    -
    +

    Sends a message to this message channel.

    +
    Declaration
    @@ -1820,22 +2014,26 @@ Please visit its documentation for more details on this method.

    System.String text - +

    The message to be sent.

    + System.Boolean isTTS - +

    Determines whether the message should be read aloud by Discord or not.

    + Embed embed - +

    The Rich Embed to be sent.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -1850,7 +2048,9 @@ Please visit its documentation for more details on this method.

    System.Threading.Tasks.Task<IUserMessage> - +

    A task that represents an asynchronous send operation for delivering the message. The task result +contains the sent message.

    + @@ -1863,7 +2063,8 @@ Please visit its documentation for more details on this method.

    IPrivateChannel.Recipients

    -
    +

    Gets the users that can access this channel.

    +
    Declaration
    @@ -1880,7 +2081,8 @@ Please visit its documentation for more details on this method.

    System.Collections.Generic.IReadOnlyCollection<IUser> - +

    A read-only collection of users that can access this channel.

    + diff --git a/docs/api/Discord.WebSocket.SocketGroupUser.html b/docs/api/Discord.WebSocket.SocketGroupUser.html index 9214737df..34d2bcea3 100644 --- a/docs/api/Discord.WebSocket.SocketGroupUser.html +++ b/docs/api/Discord.WebSocket.SocketGroupUser.html @@ -166,7 +166,8 @@

    AvatarId

    -
    +

    Gets the identifier of this user's avatar.

    +
    Declaration
    @@ -230,7 +231,8 @@

    DiscriminatorValue

    -
    +

    Gets the per-username unique ID for this user.

    +
    Declaration
    @@ -262,7 +264,8 @@

    IsBot

    -
    +

    Gets a value that indicates whether this user is identified as a bot.

    +
    Declaration
    @@ -279,12 +282,17 @@ System.Boolean - +

    true if the user is a bot application; otherwise false.

    +
    Overrides
    +
    Remarks
    +

    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).

    +
    | Improve this Doc @@ -294,7 +302,8 @@

    IsWebhook

    -
    +

    Gets a value that indicates whether this user is a webhook user.

    +
    Declaration
    @@ -311,7 +320,8 @@ System.Boolean - +

    true if the user is a webhook; otherwise false.

    + @@ -326,7 +336,8 @@

    Username

    -
    +

    Gets the username for this user.

    +
    Declaration
    @@ -360,7 +371,8 @@

    IVoiceState.IsDeafened

    -
    +

    Gets a value that indicates whether this user is deafened by the guild.

    +
    Declaration
    @@ -377,7 +389,9 @@ System.Boolean - +

    true if the user is deafened (i.e. not permitted to listen to or speak to others) by the guild; +otherwise false.

    + @@ -390,7 +404,9 @@

    IVoiceState.IsMuted

    -
    +

    Gets a value that indicates whether this user is muted (i.e. not permitted to speak via voice) by the +guild.

    +
    Declaration
    @@ -407,7 +423,8 @@ System.Boolean - +

    true if this user is muted by the guild; otherwise false.

    + @@ -420,7 +437,8 @@

    IVoiceState.IsSelfDeafened

    -
    +

    Gets a value that indicates whether this user has marked themselves as deafened.

    +
    Declaration
    @@ -437,7 +455,8 @@ System.Boolean - +

    true if this user has deafened themselves (i.e. not permitted to listen to or speak to others); otherwise false.

    + @@ -450,7 +469,9 @@

    IVoiceState.IsSelfMuted

    -
    +

    Gets a value that indicates whether this user has marked themselves as muted (i.e. not permitted to +speak via voice).

    +
    Declaration
    @@ -467,7 +488,8 @@ System.Boolean - +

    true if this user has muted themselves; otherwise false.

    + @@ -480,7 +502,8 @@

    IVoiceState.IsStreaming

    -
    +

    Gets a value that indicates if this user is streaming in a voice channel.

    +
    Declaration
    @@ -497,7 +520,8 @@ System.Boolean - +

    true if the user is streaming; otherwise false.

    + @@ -510,7 +534,8 @@

    IVoiceState.IsSuppressed

    -
    +

    Gets a value that indicates whether the user is muted by the current user.

    +
    Declaration
    @@ -527,7 +552,8 @@ System.Boolean - +

    true if the guild is temporarily blocking audio to/from this user; otherwise false.

    + @@ -540,7 +566,8 @@

    IVoiceState.VoiceChannel

    -
    +

    Gets the voice channel this user is currently in.

    +
    Declaration
    @@ -557,7 +584,9 @@ IVoiceChannel - +

    A generic voice channel object representing the voice channel that the user is currently in; null +if none.

    + @@ -570,7 +599,8 @@

    IVoiceState.VoiceSessionId

    -
    +

    Gets the unique identifier for this user's voice session.

    +
    Declaration
    diff --git a/docs/api/Discord.WebSocket.SocketGuild.html b/docs/api/Discord.WebSocket.SocketGuild.html index 9ae6205e5..745037966 100644 --- a/docs/api/Discord.WebSocket.SocketGuild.html +++ b/docs/api/Discord.WebSocket.SocketGuild.html @@ -164,7 +164,9 @@ long; null if none is set.

    AFKTimeout

    -
    +

    Gets the amount of time (in seconds) a user must be inactive in a voice channel for until they are +automatically moved to the AFK voice channel.

    +
    Declaration
    @@ -181,7 +183,9 @@ long; null if none is set.

    System.Int32 - +

    An System.Int32 representing the amount of time in seconds for a user to be marked as inactive +and moved into the AFK voice channel.

    + @@ -194,7 +198,8 @@ long; null if none is set.

    ApplicationId

    -
    +

    Gets the application ID of the guild creator if it is bot-created.

    +
    Declaration
    @@ -211,7 +216,8 @@ long; null if none is set.

    System.Nullable<System.UInt64> - +

    A System.UInt64 representing the snowflake identifier of the application ID that created this guild, or null if it was not bot-created.

    + @@ -255,7 +261,8 @@ long; null if none is set.

    BannerId

    -
    +

    Gets the identifier for this guilds banner image.

    +
    Declaration
    @@ -272,7 +279,8 @@ long; null if none is set.

    System.String - +

    An identifier for the banner image; null if none is set.

    + @@ -285,7 +293,8 @@ long; null if none is set.

    BannerUrl

    -
    +

    Gets the URL of this guild's banner image.

    +
    Declaration
    @@ -302,7 +311,8 @@ long; null if none is set.

    System.String - +

    A URL pointing to the guild's banner image; null if none is set.

    + @@ -379,7 +389,8 @@ long; null if none is set.

    CreatedAt

    -
    +

    Gets when the snowflake was created.

    +
    Declaration
    @@ -396,7 +407,8 @@ long; null if none is set.

    System.DateTimeOffset - +

    A System.DateTimeOffset representing when the entity was first created.

    + @@ -479,7 +491,8 @@ long; null if none is set.

    DefaultMessageNotifications

    -
    +

    Gets the default message notifications for users who haven't explicitly set their notification settings.

    +
    Declaration
    @@ -509,7 +522,8 @@ long; null if none is set.

    Description

    -
    +

    Gets the description for the guild.

    +
    Declaration
    @@ -526,7 +540,8 @@ long; null if none is set.

    System.String - +

    The description for the guild; null if none is set.

    + @@ -632,7 +647,8 @@ long; null if none is set.

    Emotes

    -
    +

    Gets a collection of all custom emotes for this guild.

    +
    Declaration
    @@ -649,7 +665,8 @@ long; null if none is set.

    System.Collections.Generic.IReadOnlyCollection<GuildEmote> - +

    A read-only collection of all custom emotes for this guild.

    + @@ -694,7 +711,8 @@ long; null if none is set.

    ExplicitContentFilter

    -
    +

    Gets the level of content filtering applied to user's content in a Guild.

    +
    Declaration
    @@ -711,7 +729,8 @@ long; null if none is set.

    ExplicitContentFilterLevel - +

    The level of explicit content filtering.

    + @@ -724,7 +743,8 @@ long; null if none is set.

    Features

    -
    +

    Gets a collection of all extra features added to this guild.

    +
    Declaration
    @@ -741,7 +761,8 @@ long; null if none is set.

    System.Collections.Generic.IReadOnlyCollection<System.String> - +

    A read-only collection of enabled features in this guild.

    + @@ -785,7 +806,8 @@ long; null if none is set.

    IconId

    -
    +

    Gets the ID of this guild's icon.

    +
    Declaration
    @@ -802,7 +824,8 @@ long; null if none is set.

    System.String - +

    An identifier for the splash image; null if none is set.

    + @@ -815,7 +838,8 @@ long; null if none is set.

    IconUrl

    -
    +

    Gets the URL of this guild's icon.

    +
    Declaration
    @@ -832,7 +856,8 @@ long; null if none is set.

    System.String - +

    A URL pointing to the guild's icon; null if none is set.

    + @@ -876,7 +901,8 @@ long; null if none is set.

    IsEmbeddable

    -
    +

    Gets a value that indicates whether this guild is embeddable (i.e. can use widget).

    +
    Declaration
    @@ -893,7 +919,8 @@ long; null if none is set.

    System.Boolean - +

    true if this guild can be embedded via widgets; otherwise false.

    + @@ -982,7 +1009,9 @@ between that and this property.

    MfaLevel

    -
    +

    Gets the level of Multi-Factor Authentication requirements a user must fulfill before being allowed to +perform administrative actions in this guild.

    +
    Declaration
    @@ -999,7 +1028,8 @@ between that and this property. MfaLevel - +

    The level of MFA requirement.

    + @@ -1012,7 +1042,8 @@ between that and this property.

    Name

    -
    +

    Gets the name of this guild.

    +
    Declaration
    @@ -1029,7 +1060,8 @@ between that and this property. System.String - +

    A string containing the name of this guild.

    + @@ -1073,7 +1105,8 @@ between that and this property.

    OwnerId

    -
    +

    Gets the ID of the user that owns this guild.

    +
    Declaration
    @@ -1090,7 +1123,8 @@ between that and this property. System.UInt64 - +

    A System.UInt64 representing the snowflake identifier of the user that owns this guild.

    + @@ -1103,7 +1137,8 @@ between that and this property.

    PreferredCulture

    -
    +

    Gets the preferred culture of this guild.

    +
    Declaration
    @@ -1120,7 +1155,8 @@ between that and this property. System.Globalization.CultureInfo - +

    The preferred culture information of this guild.

    + @@ -1133,7 +1169,9 @@ between that and this property.

    PreferredLocale

    -
    +

    Gets the preferred locale of this guild in IETF BCP 47 +language tag format.

    +
    Declaration
    @@ -1150,7 +1188,9 @@ between that and this property. System.String - +

    The preferred locale of the guild in IETF BCP 47 +language tag format.

    + @@ -1163,7 +1203,8 @@ between that and this property.

    PremiumSubscriptionCount

    -
    +

    Gets the number of premium subscribers of this guild.

    +
    Declaration
    @@ -1180,10 +1221,14 @@ between that and this property. System.Int32 - +

    The number of premium subscribers of this guild.

    + +
    Remarks
    +

    This is the number of users who have boosted this guild.

    +
    | Improve this Doc @@ -1193,7 +1238,8 @@ between that and this property.

    PremiumTier

    -
    +

    Gets the tier of guild boosting in this guild.

    +
    Declaration
    @@ -1210,7 +1256,8 @@ between that and this property. PremiumTier - +

    The tier of guild boosting in this guild.

    + @@ -1255,7 +1302,8 @@ between that and this property.

    SplashId

    -
    +

    Gets the ID of this guild's splash image.

    +
    Declaration
    @@ -1272,7 +1320,8 @@ between that and this property. System.String - +

    An identifier for the splash image; null if none is set.

    + @@ -1285,7 +1334,8 @@ between that and this property.

    SplashUrl

    -
    +

    Gets the URL of this guild's splash image.

    +
    Declaration
    @@ -1302,7 +1352,8 @@ between that and this property. System.String - +

    A URL pointing to the guild's splash image; null if none is set.

    + @@ -1377,7 +1428,8 @@ between that and this property.

    SystemChannelFlags

    -
    +

    Gets the flags for the types of system channel messages that are disabled.

    +
    Declaration
    @@ -1394,7 +1446,8 @@ between that and this property. SystemChannelMessageDeny - +

    The flags for the types of system channel messages that are disabled.

    + @@ -1486,7 +1539,8 @@ between that and this property.

    VanityURLCode

    -
    +

    Gets the code for this guild's vanity invite URL.

    +
    Declaration
    @@ -1503,7 +1557,8 @@ between that and this property. System.String - +

    A string containing the vanity invite code for this guild; null if none is set.

    + @@ -1516,7 +1571,8 @@ between that and this property.

    VerificationLevel

    -
    +

    Gets the level of requirements a user must fulfill before being allowed to post messages in this guild.

    +
    Declaration
    @@ -1533,7 +1589,8 @@ between that and this property. VerificationLevel - +

    The level of requirements.

    + @@ -1578,7 +1635,8 @@ between that and this property.

    VoiceRegionId

    -
    +

    Gets the ID of the region hosting this guild's voice channels.

    +
    Declaration
    @@ -1595,7 +1653,8 @@ between that and this property. System.String - +

    A string containing the identifier for the voice region that this guild uses (e.g. eu-central).

    + @@ -1610,7 +1669,8 @@ between that and this property.

    AddBanAsync(IUser, Int32, String, RequestOptions)

    -
    +

    Bans the user from this guild and optionally prunes their recent messages.

    +
    Declaration
    @@ -1629,22 +1689,26 @@ between that and this property. IUser user - +

    The user to ban.

    + System.Int32 pruneDays - +

    The number of days to remove messages from this user for, and this number must be between [0, 7].

    + System.String reason - +

    The reason of the ban to be written in the audit log.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -1659,7 +1723,24 @@ between that and this property. System.Threading.Tasks.Task - +

    A task that represents the asynchronous add operation for the ban.

    + + + + +
    Exceptions
    + + + + + + + + + + +
    TypeCondition
    System.ArgumentException

    pruneDays is not between 0 to 7.

    +
    @@ -1672,7 +1753,8 @@ between that and this property.

    AddBanAsync(UInt64, Int32, String, RequestOptions)

    -
    +

    Bans the user from this guild and optionally prunes their recent messages.

    +
    Declaration
    @@ -1691,22 +1773,26 @@ between that and this property. System.UInt64 userId - +

    The snowflake ID of the user to ban.

    + System.Int32 pruneDays - +

    The number of days to remove messages from this user for, and this number must be between [0, 7].

    + System.String reason - +

    The reason of the ban to be written in the audit log.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -1721,7 +1807,24 @@ between that and this property. System.Threading.Tasks.Task - +

    A task that represents the asynchronous add operation for the ban.

    + + + + +
    Exceptions
    + + + + + + + + + + +
    TypeCondition
    System.ArgumentException

    pruneDays is not between 0 to 7.

    +
    @@ -1875,7 +1978,8 @@ category channel.

    CreateEmoteAsync(String, Image, Optional<IEnumerable<IRole>>, RequestOptions)

    -
    +

    Creates a new GuildEmote in this guild.

    +
    Declaration
    @@ -1894,22 +1998,26 @@ category channel.

    System.String name - +

    The name of the guild emote.

    + Image image - +

    The image of the new emote.

    + Optional<System.Collections.Generic.IEnumerable<IRole>> roles - +

    The roles to limit the emote usage to.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -1924,7 +2032,8 @@ category channel.

    System.Threading.Tasks.Task<GuildEmote> - +

    A task that represents the asynchronous creation operation. The task result contains the created emote.

    + @@ -2311,7 +2420,8 @@ voice channel.

    DeleteAsync(RequestOptions)

    -
    +

    Deletes this object and all its children.

    +
    Declaration
    @@ -2330,7 +2440,8 @@ voice channel.

    RequestOptions options - +

    The options to be used when sending the request.

    + @@ -2358,7 +2469,8 @@ voice channel.

    DeleteEmoteAsync(GuildEmote, RequestOptions)

    -
    +

    Deletes an existing GuildEmote from this guild.

    +
    Declaration
    @@ -2377,12 +2489,14 @@ voice channel.

    GuildEmote emote - +

    The emote to delete.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -2397,7 +2511,8 @@ voice channel.

    System.Threading.Tasks.Task - +

    A task that represents the asynchronous removal operation.

    + @@ -2410,7 +2525,8 @@ voice channel.

    DownloadUsersAsync()

    -
    +

    Downloads all users for this guild if the current list is incomplete.

    +
    Declaration
    @@ -2427,7 +2543,8 @@ voice channel.

    System.Threading.Tasks.Task - +

    A task that represents the asynchronous download operation.

    + @@ -2781,7 +2898,8 @@ behind the ban.

    GetEmoteAsync(UInt64, RequestOptions)

    -
    +

    Gets a specific emote from this guild.

    +
    Declaration
    @@ -2800,12 +2918,14 @@ behind the ban.

    System.UInt64 id - +

    The snowflake identifier for the guild emote.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -2820,7 +2940,9 @@ behind the ban.

    System.Threading.Tasks.Task<GuildEmote> - +

    A task that represents the asynchronous get operation. The task result contains the emote found with the +specified id; null if none is found.

    + @@ -3348,7 +3470,8 @@ of webhooks found within the guild.

    LeaveAsync(RequestOptions)

    -
    +

    Leaves this guild.

    +
    Declaration
    @@ -3367,7 +3490,8 @@ of webhooks found within the guild.

    RequestOptions options - +

    The options to be used when sending the request.

    + @@ -3382,10 +3506,17 @@ of webhooks found within the guild.

    System.Threading.Tasks.Task - +

    A task that represents the asynchronous leave operation.

    + +
    Remarks
    +

    This method will make the currently logged-in user leave the guild.

    +
    note

    + If the user is the owner of this guild, use DeleteAsync(RequestOptions) instead. +

    +
    | Improve this Doc @@ -3395,7 +3526,8 @@ of webhooks found within the guild.

    ModifyAsync(Action<GuildProperties>, RequestOptions)

    -
    +

    Modifies this guild.

    +
    Declaration
    @@ -3414,12 +3546,14 @@ of webhooks found within the guild.

    System.Action<GuildProperties> func - +

    The delegate containing the properties to modify the guild with.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -3434,7 +3568,8 @@ of webhooks found within the guild.

    System.Threading.Tasks.Task - +

    A task that represents the asynchronous modification operation.

    + @@ -3463,7 +3598,8 @@ of webhooks found within the guild.

    ModifyEmbedAsync(Action<GuildEmbedProperties>, RequestOptions)

    -
    +

    Modifies this guild's embed channel.

    +
    Declaration
    @@ -3482,12 +3618,14 @@ of webhooks found within the guild.

    System.Action<GuildEmbedProperties> func - +

    The delegate containing the properties to modify the guild widget with.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -3502,7 +3640,8 @@ of webhooks found within the guild.

    System.Threading.Tasks.Task - +

    A task that represents the asynchronous modification operation.

    + @@ -3531,7 +3670,8 @@ of webhooks found within the guild.

    ModifyEmoteAsync(GuildEmote, Action<EmoteProperties>, RequestOptions)

    -
    +

    Modifies an existing GuildEmote in this guild.

    +
    Declaration
    @@ -3550,17 +3690,20 @@ of webhooks found within the guild.

    GuildEmote emote - +

    The emote to be modified.

    + System.Action<EmoteProperties> func - +

    The delegate containing the properties to modify the emote with.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -3575,7 +3718,9 @@ of webhooks found within the guild.

    System.Threading.Tasks.Task<GuildEmote> - +

    A task that represents the asynchronous modification operation. The task result contains the modified +emote.

    + @@ -3604,7 +3749,8 @@ of webhooks found within the guild.

    PruneUsersAsync(Int32, Boolean, RequestOptions)

    -
    +

    Prunes inactive users.

    +
    Declaration
    @@ -3623,17 +3769,20 @@ of webhooks found within the guild.

    System.Int32 days - +

    The number of days required for the users to be kicked.

    + System.Boolean simulate - +

    Whether this prune action is a simulation.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -3648,10 +3797,21 @@ of webhooks found within the guild.

    System.Threading.Tasks.Task<System.Int32> - +

    A task that represents the asynchronous prune operation. The task result contains the number of users to +be or has been removed from this guild.

    + +
    Remarks
    +

    + This method removes all users that have not logged on in the provided number of days. +

    +

    + If simulate is true, this method will only return the number of users that + would be removed without kicking the users. +

    +
    | Improve this Doc @@ -3661,7 +3821,8 @@ of webhooks found within the guild.

    RemoveBanAsync(IUser, RequestOptions)

    -
    +

    Unbans the user if they are currently banned.

    +
    Declaration
    @@ -3680,12 +3841,14 @@ of webhooks found within the guild.

    IUser user - +

    The user to be unbanned.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -3700,7 +3863,8 @@ of webhooks found within the guild.

    System.Threading.Tasks.Task - +

    A task that represents the asynchronous removal operation for the ban.

    + @@ -3713,7 +3877,8 @@ of webhooks found within the guild.

    RemoveBanAsync(UInt64, RequestOptions)

    -
    +

    Unbans the user if they are currently banned.

    +
    Declaration
    @@ -3732,12 +3897,14 @@ of webhooks found within the guild.

    System.UInt64 userId - +

    The snowflake identifier of the user to be unbanned.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -3752,7 +3919,8 @@ of webhooks found within the guild.

    System.Threading.Tasks.Task - +

    A task that represents the asynchronous removal operation for the ban.

    + @@ -3765,7 +3933,8 @@ of webhooks found within the guild.

    ReorderChannelsAsync(IEnumerable<ReorderChannelProperties>, RequestOptions)

    -
    +

    Bulk-modifies the order of channels in this guild.

    +
    Declaration
    @@ -3784,12 +3953,14 @@ of webhooks found within the guild.

    System.Collections.Generic.IEnumerable<ReorderChannelProperties> args - +

    The properties used to modify the channel positions with.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -3804,7 +3975,8 @@ of webhooks found within the guild.

    System.Threading.Tasks.Task - +

    A task that represents the asynchronous reorder operation.

    + @@ -3817,7 +3989,8 @@ of webhooks found within the guild.

    ReorderRolesAsync(IEnumerable<ReorderRoleProperties>, RequestOptions)

    -
    +

    Bulk-modifies the order of roles in this guild.

    +
    Declaration
    @@ -3836,12 +4009,14 @@ of webhooks found within the guild.

    System.Collections.Generic.IEnumerable<ReorderRoleProperties> args - +

    The properties used to modify the role positions with.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -3856,7 +4031,8 @@ of webhooks found within the guild.

    System.Threading.Tasks.Task - +

    A task that represents the asynchronous reorder operation.

    + @@ -3905,7 +4081,8 @@ of webhooks found within the guild.

    IGuild.AddGuildUserAsync(UInt64, String, Action<AddGuildUserProperties>, RequestOptions)

    -
    +

    Adds a user to this guild.

    +
    Declaration
    @@ -3924,22 +4101,26 @@ of webhooks found within the guild.

    System.UInt64 userId - +

    The snowflake identifier of the user.

    + System.String accessToken - +

    The OAuth2 access token for the user, requested with the guilds.join scope.

    + System.Action<AddGuildUserProperties> func - +

    The delegate containing the properties to be applied to the user upon being added to the guild.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -3954,10 +4135,14 @@ of webhooks found within the guild.

    System.Threading.Tasks.Task<IGuildUser> - +

    A guild user associated with the specified userId; null if the user is already in the guild.

    + +
    Remarks
    +

    This method requires you have an OAuth2 access token for the user, requested with the guilds.join scope, and that the bot have the MANAGE_INVITES permission in the guild.

    +
    | Improve this Doc @@ -3967,7 +4152,8 @@ of webhooks found within the guild.

    IGuild.AFKChannelId

    -
    +

    Gets the ID of the AFK voice channel for this guild.

    +
    Declaration
    @@ -3984,7 +4170,9 @@ of webhooks found within the guild.

    System.Nullable<System.UInt64> - +

    A System.UInt64 representing the snowflake identifier of the AFK voice channel; null if +none is set.

    + @@ -3997,7 +4185,8 @@ of webhooks found within the guild.

    IGuild.AudioClient

    -
    +

    Gets the IAudioClient currently associated with this guild.

    +
    Declaration
    @@ -4014,7 +4203,8 @@ of webhooks found within the guild.

    IAudioClient - +

    An IAudioClient currently associated with this guild.

    + @@ -4027,7 +4217,8 @@ of webhooks found within the guild.

    IGuild.Available

    -
    +

    Determines if this guild is currently connected and ready to be used.

    +
    Declaration
    @@ -4044,10 +4235,17 @@ of webhooks found within the guild.

    System.Boolean - +

    true if this guild is currently connected and ready to be used; otherwise false.

    + +
    Remarks
    +
    note

    + This property only applies to a WebSocket-based client. +

    +This boolean is used to determine if the guild is currently connected to the WebSocket and is ready to be used/accessed. +
    | Improve this Doc @@ -4057,7 +4255,8 @@ of webhooks found within the guild.

    IGuild.CreateCategoryAsync(String, Action<GuildChannelProperties>, RequestOptions)

    -
    +

    Creates a new channel category in this guild.

    +
    Declaration
    @@ -4076,17 +4275,20 @@ of webhooks found within the guild.

    System.String name - +

    The new name for the category.

    + System.Action<GuildChannelProperties> func - +

    The delegate containing the properties to be applied to the channel upon its creation.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -4101,7 +4303,9 @@ of webhooks found within the guild.

    System.Threading.Tasks.Task<ICategoryChannel> - +

    A task that represents the asynchronous creation operation. The task result contains the newly created +category channel.

    + @@ -4171,7 +4375,8 @@ of webhooks found within the guild.

    IGuild.CreateRoleAsync(String, Nullable<GuildPermissions>, Nullable<Color>, Boolean, RequestOptions)

    -
    +

    Creates a new role with the provided name.

    +
    Declaration
    @@ -4190,27 +4395,32 @@ of webhooks found within the guild.

    System.String name - +

    The new name for the role.

    + System.Nullable<GuildPermissions> permissions - +

    The guild permission that the role should possess.

    + System.Nullable<Color> color - +

    The color of the role.

    + System.Boolean isHoisted - +

    Whether the role is separated from others on the sidebar.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -4225,7 +4435,9 @@ of webhooks found within the guild.

    System.Threading.Tasks.Task<IRole> - +

    A task that represents the asynchronous creation operation. The task result contains the newly created +role.

    + @@ -4238,7 +4450,8 @@ of webhooks found within the guild.

    IGuild.CreateRoleAsync(String, Nullable<GuildPermissions>, Nullable<Color>, Boolean, Boolean, RequestOptions)

    -
    +

    Creates a new role with the provided name.

    +
    Declaration
    @@ -4257,32 +4470,38 @@ of webhooks found within the guild.

    System.String name - +

    The new name for the role.

    + System.Nullable<GuildPermissions> permissions - +

    The guild permission that the role should possess.

    + System.Nullable<Color> color - +

    The color of the role.

    + System.Boolean isHoisted - +

    Whether the role is separated from others on the sidebar.

    + System.Boolean isMentionable - +

    Whether the role can be mentioned.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -4297,7 +4516,9 @@ of webhooks found within the guild.

    System.Threading.Tasks.Task<IRole> - +

    A task that represents the asynchronous creation operation. The task result contains the newly created +role.

    + @@ -4310,7 +4531,8 @@ of webhooks found within the guild.

    IGuild.CreateTextChannelAsync(String, Action<TextChannelProperties>, RequestOptions)

    -
    +

    Creates a new text channel in this guild.

    +
    Declaration
    @@ -4329,17 +4551,20 @@ of webhooks found within the guild.

    System.String name - +

    The new name for the text channel.

    + System.Action<TextChannelProperties> func - +

    The delegate containing the properties to be applied to the channel upon its creation.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -4354,7 +4579,9 @@ of webhooks found within the guild.

    System.Threading.Tasks.Task<ITextChannel> - +

    A task that represents the asynchronous creation operation. The task result contains the newly created +text channel.

    + @@ -4367,7 +4594,8 @@ of webhooks found within the guild.

    IGuild.CreateVoiceChannelAsync(String, Action<VoiceChannelProperties>, RequestOptions)

    -
    +

    Creates a new voice channel in this guild.

    +
    Declaration
    @@ -4386,17 +4614,20 @@ of webhooks found within the guild.

    System.String name - +

    The new name for the voice channel.

    + System.Action<VoiceChannelProperties> func - +

    The delegate containing the properties to be applied to the channel upon its creation.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -4411,7 +4642,9 @@ of webhooks found within the guild.

    System.Threading.Tasks.Task<IVoiceChannel> - +

    A task that represents the asynchronous creation operation. The task result contains the newly created +voice channel.

    + @@ -4424,7 +4657,8 @@ of webhooks found within the guild.

    IGuild.DefaultChannelId

    -
    +

    Gets the ID of the default channel for this guild.

    +
    Declaration
    @@ -4441,10 +4675,19 @@ of webhooks found within the guild.

    System.UInt64 - +

    A System.UInt64 representing the snowflake identifier of the default text channel; 0 if +none can be found.

    + +
    Remarks
    +

    This property retrieves the snowflake identifier of the first viewable text channel for this guild.

    +
    warning

    + This channel does not guarantee the user can send message to it, as it only looks for the first viewable + text channel. +

    +
    | Improve this Doc @@ -4454,7 +4697,8 @@ of webhooks found within the guild.

    IGuild.EmbedChannelId

    -
    +

    Gets the ID of the widget embed channel of this guild.

    +
    Declaration
    @@ -4471,7 +4715,9 @@ of webhooks found within the guild.

    System.Nullable<System.UInt64> - +

    A System.UInt64 representing the snowflake identifier of the embedded channel found within the +widget settings of this guild; null if none is set.

    + @@ -4484,7 +4730,8 @@ of webhooks found within the guild.

    IGuild.EveryoneRole

    -
    +

    Gets the built-in role containing all users in this guild.

    +
    Declaration
    @@ -4501,7 +4748,8 @@ of webhooks found within the guild.

    IRole - +

    A role object that represents an @everyone role in this guild.

    + @@ -4514,7 +4762,8 @@ of webhooks found within the guild.

    IGuild.GetAFKChannelAsync(CacheMode, RequestOptions)

    -
    +

    Gets the AFK voice channel in this guild.

    +
    Declaration
    @@ -4533,12 +4782,14 @@ of webhooks found within the guild.

    CacheMode mode - +

    The CacheMode that determines whether the object should be fetched from cache.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -4553,7 +4804,9 @@ of webhooks found within the guild.

    System.Threading.Tasks.Task<IVoiceChannel> - +

    A task that represents the asynchronous get operation. The task result contains the voice channel that the +AFK users will be moved to after they have idled for too long; null if none is set.

    + @@ -4566,7 +4819,8 @@ of webhooks found within the guild.

    IGuild.GetAuditLogsAsync(Int32, CacheMode, RequestOptions, Nullable<UInt64>, Nullable<UInt64>, Nullable<ActionType>)

    -
    +

    Gets the specified number of audit log entries for this guild.

    +
    Declaration
    @@ -4585,7 +4839,8 @@ of webhooks found within the guild.

    System.Int32 limit - +

    The number of audit log entries to fetch.

    + CacheMode @@ -4595,22 +4850,26 @@ of webhooks found within the guild.

    RequestOptions options - +

    The options to be used when sending the request.

    + System.Nullable<System.UInt64> beforeId - +

    The audit log entry ID to get entries before.

    + System.Nullable<System.UInt64> userId - +

    The user ID to filter entries for.

    + System.Nullable<ActionType> actionType - +

    The type of actions to filter.

    + @@ -4625,7 +4884,9 @@ of webhooks found within the guild.

    System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyCollection<IAuditLogEntry>> - +

    A task that represents the asynchronous get operation. The task result contains a read-only collection +of the requested audit log entries.

    + @@ -4638,7 +4899,8 @@ of webhooks found within the guild.

    IGuild.GetBanAsync(IUser, RequestOptions)

    -
    +

    Gets a ban object for a banned user.

    +
    Declaration
    @@ -4657,12 +4919,14 @@ of webhooks found within the guild.

    IUser user - +

    The banned user.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -4677,7 +4941,9 @@ of webhooks found within the guild.

    System.Threading.Tasks.Task<IBan> - +

    A task that represents the asynchronous get operation. The task result contains a ban object, which +contains the user information and the reason for the ban; null if the ban entry cannot be found.

    + @@ -4690,7 +4956,8 @@ of webhooks found within the guild.

    IGuild.GetBanAsync(UInt64, RequestOptions)

    -
    +

    Gets a ban object for a banned user.

    +
    Declaration
    @@ -4709,12 +4976,14 @@ of webhooks found within the guild.

    System.UInt64 userId - +

    The snowflake identifier for the banned user.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -4729,7 +4998,9 @@ of webhooks found within the guild.

    System.Threading.Tasks.Task<IBan> - +

    A task that represents the asynchronous get operation. The task result contains a ban object, which +contains the user information and the reason for the ban; null if the ban entry cannot be found.

    + @@ -4742,7 +5013,8 @@ of webhooks found within the guild.

    IGuild.GetBansAsync(RequestOptions)

    -
    +

    Gets a collection of all users banned in this guild.

    +
    Declaration
    @@ -4761,7 +5033,8 @@ of webhooks found within the guild.

    RequestOptions options - +

    The options to be used when sending the request.

    + @@ -4776,7 +5049,10 @@ of webhooks found within the guild.

    System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyCollection<IBan>> - +

    A task that represents the asynchronous get operation. The task result contains a read-only collection of +ban objects that this guild currently possesses, with each object containing the user banned and reason +behind the ban.

    + @@ -4789,7 +5065,8 @@ of webhooks found within the guild.

    IGuild.GetCategoriesAsync(CacheMode, RequestOptions)

    -
    +

    Gets a collection of all category channels in this guild.

    +
    Declaration
    @@ -4808,12 +5085,14 @@ of webhooks found within the guild.

    CacheMode mode - +

    The CacheMode that determines whether the object should be fetched from cache.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -4828,7 +5107,9 @@ of webhooks found within the guild.

    System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyCollection<ICategoryChannel>> - +

    A task that represents the asynchronous get operation. The task result contains a read-only collection of +category channels found within this guild.

    + @@ -4841,7 +5122,8 @@ of webhooks found within the guild.

    IGuild.GetChannelAsync(UInt64, CacheMode, RequestOptions)

    -
    +

    Gets a channel in this guild.

    +
    Declaration
    @@ -4860,17 +5142,20 @@ of webhooks found within the guild.

    System.UInt64 id - +

    The snowflake identifier for the channel.

    + CacheMode mode - +

    The CacheMode that determines whether the object should be fetched from cache.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -4885,7 +5170,9 @@ of webhooks found within the guild.

    System.Threading.Tasks.Task<IGuildChannel> - +

    A task that represents the asynchronous get operation. The task result contains the generic channel +associated with the specified id; null if none is found.

    + @@ -4898,7 +5185,8 @@ of webhooks found within the guild.

    IGuild.GetChannelsAsync(CacheMode, RequestOptions)

    -
    +

    Gets a collection of all channels in this guild.

    +
    Declaration
    @@ -4917,12 +5205,14 @@ of webhooks found within the guild.

    CacheMode mode - +

    The CacheMode that determines whether the object should be fetched from cache.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -4937,7 +5227,9 @@ of webhooks found within the guild.

    System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyCollection<IGuildChannel>> - +

    A task that represents the asynchronous get operation. The task result contains a read-only collection of +generic channels found within this guild.

    + @@ -4950,7 +5242,8 @@ of webhooks found within the guild.

    IGuild.GetCurrentUserAsync(CacheMode, RequestOptions)

    -
    +

    Gets the current user for this guild.

    +
    Declaration
    @@ -4969,12 +5262,14 @@ of webhooks found within the guild.

    CacheMode mode - +

    The CacheMode that determines whether the object should be fetched from cache.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -4989,7 +5284,9 @@ of webhooks found within the guild.

    System.Threading.Tasks.Task<IGuildUser> - +

    A task that represents the asynchronous get operation. The task result contains the currently logged-in +user within this guild.

    + @@ -5002,7 +5299,8 @@ of webhooks found within the guild.

    IGuild.GetDefaultChannelAsync(CacheMode, RequestOptions)

    -
    +

    Gets the first viewable text channel in this guild.

    +
    Declaration
    @@ -5021,12 +5319,14 @@ of webhooks found within the guild.

    CacheMode mode - +

    The CacheMode that determines whether the object should be fetched from cache.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -5041,7 +5341,9 @@ of webhooks found within the guild.

    System.Threading.Tasks.Task<ITextChannel> - +

    A task that represents the asynchronous get operation. The task result contains the first viewable text +channel in this guild; null if none is found.

    + @@ -5054,7 +5356,8 @@ of webhooks found within the guild.

    IGuild.GetEmbedChannelAsync(CacheMode, RequestOptions)

    -
    +

    Gets the embed channel (i.e. the channel set in the guild's widget settings) in this guild.

    +
    Declaration
    @@ -5073,12 +5376,14 @@ of webhooks found within the guild.

    CacheMode mode - +

    The CacheMode that determines whether the object should be fetched from cache.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -5093,7 +5398,9 @@ of webhooks found within the guild.

    System.Threading.Tasks.Task<IGuildChannel> - +

    A task that represents the asynchronous get operation. The task result contains the embed channel set +within the server's widget settings; null if none is set.

    + @@ -5153,7 +5460,8 @@ of webhooks found within the guild.

    IGuild.GetInvitesAsync(RequestOptions)

    -
    +

    Gets a collection of all invites in this guild.

    +
    Declaration
    @@ -5172,7 +5480,8 @@ of webhooks found within the guild.

    RequestOptions options - +

    The options to be used when sending the request.

    + @@ -5187,7 +5496,9 @@ of webhooks found within the guild.

    System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyCollection<IInviteMetadata>> - +

    A task that represents the asynchronous get operation. The task result contains a read-only collection of +invite metadata, each representing information for an invite found within this guild.

    + @@ -5200,7 +5511,8 @@ of webhooks found within the guild.

    IGuild.GetOwnerAsync(CacheMode, RequestOptions)

    -
    +

    Gets the owner of this guild.

    +
    Declaration
    @@ -5219,12 +5531,14 @@ of webhooks found within the guild.

    CacheMode mode - +

    The CacheMode that determines whether the object should be fetched from cache.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -5239,7 +5553,8 @@ of webhooks found within the guild.

    System.Threading.Tasks.Task<IGuildUser> - +

    A task that represents the asynchronous get operation. The task result contains the owner of this guild.

    + @@ -5252,7 +5567,8 @@ of webhooks found within the guild.

    IGuild.GetRole(UInt64)

    -
    +

    Gets a role in this guild.

    +
    Declaration
    @@ -5271,7 +5587,8 @@ of webhooks found within the guild.

    System.UInt64 id - +

    The snowflake identifier for the role.

    + @@ -5286,7 +5603,8 @@ of webhooks found within the guild.

    IRole - +

    A role that is associated with the specified id; null if none is found.

    + @@ -5299,7 +5617,8 @@ of webhooks found within the guild.

    IGuild.GetSystemChannelAsync(CacheMode, RequestOptions)

    -
    +

    Gets the system channel where randomized welcome messages are sent in this guild.

    +
    Declaration
    @@ -5318,12 +5637,14 @@ of webhooks found within the guild.

    CacheMode mode - +

    The CacheMode that determines whether the object should be fetched from cache.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -5338,7 +5659,9 @@ of webhooks found within the guild.

    System.Threading.Tasks.Task<ITextChannel> - +

    A task that represents the asynchronous get operation. The task result contains the text channel where +randomized welcome messages will be sent to; null if none is set.

    + @@ -5351,7 +5674,8 @@ of webhooks found within the guild.

    IGuild.GetTextChannelAsync(UInt64, CacheMode, RequestOptions)

    -
    +

    Gets a text channel in this guild.

    +
    Declaration
    @@ -5370,17 +5694,20 @@ of webhooks found within the guild.

    System.UInt64 id - +

    The snowflake identifier for the text channel.

    + CacheMode mode - +

    The CacheMode that determines whether the object should be fetched from cache.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -5395,7 +5722,9 @@ of webhooks found within the guild.

    System.Threading.Tasks.Task<ITextChannel> - +

    A task that represents the asynchronous get operation. The task result contains the text channel +associated with the specified id; null if none is found.

    + @@ -5408,7 +5737,8 @@ of webhooks found within the guild.

    IGuild.GetTextChannelsAsync(CacheMode, RequestOptions)

    -
    +

    Gets a collection of all text channels in this guild.

    +
    Declaration
    @@ -5427,12 +5757,14 @@ of webhooks found within the guild.

    CacheMode mode - +

    The CacheMode that determines whether the object should be fetched from cache.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -5447,7 +5779,9 @@ of webhooks found within the guild.

    System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyCollection<ITextChannel>> - +

    A task that represents the asynchronous get operation. The task result contains a read-only collection of +message channels found within this guild.

    + @@ -5460,7 +5794,8 @@ of webhooks found within the guild.

    IGuild.GetUserAsync(UInt64, CacheMode, RequestOptions)

    -
    +

    Gets a user from this guild.

    +
    Declaration
    @@ -5479,17 +5814,20 @@ of webhooks found within the guild.

    System.UInt64 id - +

    The snowflake identifier of the user.

    + CacheMode mode - +

    The CacheMode that determines whether the object should be fetched from cache.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -5504,10 +5842,19 @@ of webhooks found within the guild.

    System.Threading.Tasks.Task<IGuildUser> - +

    A task that represents the asynchronous get operation. The task result contains the guild user +associated with the specified id; null if none is found.

    + +
    Remarks
    +

    This method retrieves a user found within this guild.

    +
    note

    + This may return null in the WebSocket implementation due to incomplete user collection in + large guilds. +

    +
    | Improve this Doc @@ -5517,7 +5864,8 @@ of webhooks found within the guild.

    IGuild.GetUsersAsync(CacheMode, RequestOptions)

    -
    +

    Gets a collection of all users in this guild.

    +
    Declaration
    @@ -5536,12 +5884,14 @@ of webhooks found within the guild.

    CacheMode mode - +

    The CacheMode that determines whether the object should be fetched from cache.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -5556,10 +5906,19 @@ of webhooks found within the guild.

    System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyCollection<IGuildUser>> - +

    A task that represents the asynchronous get operation. The task result contains a collection of guild +users found within this guild.

    + +
    Remarks
    +

    This method retrieves all users found within this guild.

    +
    note

    + This may return an incomplete collection in the WebSocket implementation due to how Discord does not + send a complete user list for large guilds. +

    +
    | Improve this Doc @@ -5569,7 +5928,8 @@ of webhooks found within the guild.

    IGuild.GetVanityInviteAsync(RequestOptions)

    -
    +

    Gets the vanity invite URL of this guild.

    +
    Declaration
    @@ -5588,7 +5948,8 @@ of webhooks found within the guild.

    RequestOptions options - +

    The options to be used when sending the request.

    + @@ -5603,7 +5964,9 @@ of webhooks found within the guild.

    System.Threading.Tasks.Task<IInviteMetadata> - +

    A task that represents the asynchronous get operation. The task result contains the partial metadata of +the vanity invite found within this guild; null if none is found.

    + @@ -5616,7 +5979,8 @@ of webhooks found within the guild.

    IGuild.GetVoiceChannelAsync(UInt64, CacheMode, RequestOptions)

    -
    +

    Gets a voice channel in this guild.

    +
    Declaration
    @@ -5635,17 +5999,20 @@ of webhooks found within the guild.

    System.UInt64 id - +

    The snowflake identifier for the voice channel.

    + CacheMode mode - +

    The CacheMode that determines whether the object should be fetched from cache.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -5660,7 +6027,9 @@ of webhooks found within the guild.

    System.Threading.Tasks.Task<IVoiceChannel> - +

    A task that represents the asynchronous get operation. The task result contains the voice channel associated +with the specified id; null if none is found.

    + @@ -5673,7 +6042,8 @@ of webhooks found within the guild.

    IGuild.GetVoiceChannelsAsync(CacheMode, RequestOptions)

    -
    +

    Gets a collection of all voice channels in this guild.

    +
    Declaration
    @@ -5692,12 +6062,14 @@ of webhooks found within the guild.

    CacheMode mode - +

    The CacheMode that determines whether the object should be fetched from cache.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -5712,7 +6084,9 @@ of webhooks found within the guild.

    System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyCollection<IVoiceChannel>> - +

    A task that represents the asynchronous get operation. The task result contains a read-only collection of +voice channels found within this guild.

    + @@ -5725,7 +6099,8 @@ of webhooks found within the guild.

    IGuild.GetVoiceRegionsAsync(RequestOptions)

    -
    +

    Gets a collection of all the voice regions this guild can access.

    +
    Declaration
    @@ -5744,7 +6119,8 @@ of webhooks found within the guild.

    RequestOptions options - +

    The options to be used when sending the request.

    + @@ -5759,7 +6135,9 @@ of webhooks found within the guild.

    System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyCollection<IVoiceRegion>> - +

    A task that represents the asynchronous get operation. The task result contains a read-only collection of +voice regions the guild can access.

    + @@ -5772,7 +6150,8 @@ of webhooks found within the guild.

    IGuild.GetWebhookAsync(UInt64, RequestOptions)

    -
    +

    Gets a webhook found within this guild.

    +
    Declaration
    @@ -5791,12 +6170,14 @@ of webhooks found within the guild.

    System.UInt64 id - +

    The identifier for the webhook.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -5811,7 +6192,9 @@ of webhooks found within the guild.

    System.Threading.Tasks.Task<IWebhook> - +

    A task that represents the asynchronous get operation. The task result contains the webhook with the +specified id; null if none is found.

    + @@ -5824,7 +6207,8 @@ of webhooks found within the guild.

    IGuild.GetWebhooksAsync(RequestOptions)

    -
    +

    Gets a collection of all webhook from this guild.

    +
    Declaration
    @@ -5843,7 +6227,8 @@ of webhooks found within the guild.

    RequestOptions options - +

    The options to be used when sending the request.

    + @@ -5858,7 +6243,9 @@ of webhooks found within the guild.

    System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyCollection<IWebhook>> - +

    A task that represents the asynchronous get operation. The task result contains a read-only collection +of webhooks found within the guild.

    + @@ -5871,7 +6258,8 @@ of webhooks found within the guild.

    IGuild.Roles

    -
    +

    Gets a collection of all roles in this guild.

    +
    Declaration
    @@ -5888,7 +6276,8 @@ of webhooks found within the guild.

    System.Collections.Generic.IReadOnlyCollection<IRole> - +

    A read-only collection of roles found within this guild.

    + @@ -5901,7 +6290,8 @@ of webhooks found within the guild.

    IGuild.SystemChannelId

    -
    +

    Gets the ID of the channel where randomized welcome messages are sent.

    +
    Declaration
    @@ -5918,7 +6308,9 @@ of webhooks found within the guild.

    System.Nullable<System.UInt64> - +

    A System.UInt64 representing the snowflake identifier of the system channel where randomized +welcome messages are sent; null if none is set.

    + diff --git a/docs/api/Discord.WebSocket.SocketGuildChannel.html b/docs/api/Discord.WebSocket.SocketGuildChannel.html index d1963d4ce..1bdf4a8a4 100644 --- a/docs/api/Discord.WebSocket.SocketGuildChannel.html +++ b/docs/api/Discord.WebSocket.SocketGuildChannel.html @@ -173,7 +173,8 @@

    Name

    -
    +

    Gets the name of this channel.

    +
    Declaration
    @@ -190,7 +191,8 @@ System.String - +

    A string containing the name of this channel.

    + @@ -203,7 +205,8 @@

    PermissionOverwrites

    -
    +

    Gets a collection of permission overwrites for this channel.

    +
    Declaration
    @@ -220,7 +223,8 @@ System.Collections.Generic.IReadOnlyCollection<Overwrite> - +

    A collection of overwrites associated with this channel.

    + @@ -233,7 +237,8 @@

    Position

    -
    +

    Gets the position of this channel.

    +
    Declaration
    @@ -250,7 +255,9 @@ System.Int32 - +

    An System.Int32 representing the position of this channel in the guild's channel list relative to +others of the same type.

    + @@ -421,7 +428,8 @@

    DeleteAsync(RequestOptions)

    -
    +

    Deletes this object and all its children.

    +
    Declaration
    @@ -440,7 +448,8 @@ RequestOptions options - +

    The options to be used when sending the request.

    + @@ -615,7 +624,8 @@

    ModifyAsync(Action<GuildChannelProperties>, RequestOptions)

    -
    +

    Modifies this guild channel.

    +
    Declaration
    @@ -634,12 +644,14 @@ System.Action<GuildChannelProperties> func - +

    The delegate containing the properties to modify the channel with.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -654,10 +666,15 @@ System.Threading.Tasks.Task - +

    A task that represents the asynchronous modification operation.

    + +
    Remarks
    +

    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 GuildChannelProperties.

    +
    | Improve this Doc @@ -815,7 +832,8 @@

    IChannel.GetUserAsync(UInt64, CacheMode, RequestOptions)

    -
    +

    Gets a user in this channel.

    +
    Declaration
    @@ -834,17 +852,20 @@ System.UInt64 id - +

    The snowflake identifier of the user (e.g. 168693960628371456).

    + CacheMode mode - +

    The CacheMode that determines whether the object should be fetched from cache.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -859,7 +880,9 @@ System.Threading.Tasks.Task<IUser> - +

    A task that represents the asynchronous get operation. The task result contains a user object that +represents the found user; null if none is found.

    + @@ -872,7 +895,8 @@

    IGuildChannel.AddPermissionOverwriteAsync(IRole, OverwritePermissions, RequestOptions)

    -
    +

    Adds or updates the permission overwrite for the given role.

    +
    Declaration
    @@ -891,17 +915,20 @@ IRole role - +

    The role to add the overwrite to.

    + OverwritePermissions permissions - +

    The overwrite to add to the role.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -916,7 +943,9 @@ System.Threading.Tasks.Task - +

    A task representing the asynchronous permission operation for adding the specified permissions to the +channel.

    + @@ -929,7 +958,8 @@

    IGuildChannel.AddPermissionOverwriteAsync(IUser, OverwritePermissions, RequestOptions)

    -
    +

    Adds or updates the permission overwrite for the given user.

    +
    Declaration
    @@ -948,17 +978,20 @@ IUser user - +

    The user to add the overwrite to.

    + OverwritePermissions permissions - +

    The overwrite to add to the user.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -973,7 +1006,8 @@ System.Threading.Tasks.Task - +

    A task representing the asynchronous permission operation for adding the specified permissions to the channel.

    + @@ -986,7 +1020,8 @@

    IGuildChannel.GetPermissionOverwrite(IRole)

    -
    +

    Gets the permission overwrite for a specific role.

    +
    Declaration
    @@ -1005,7 +1040,8 @@ IRole role - +

    The role to get the overwrite from.

    + @@ -1020,7 +1056,8 @@ System.Nullable<OverwritePermissions> - +

    An overwrite object for the targeted role; null if none is set.

    + @@ -1033,7 +1070,8 @@

    IGuildChannel.GetPermissionOverwrite(IUser)

    -
    +

    Gets the permission overwrite for a specific user.

    +
    Declaration
    @@ -1052,7 +1090,8 @@ IUser user - +

    The user to get the overwrite from.

    + @@ -1067,7 +1106,8 @@ System.Nullable<OverwritePermissions> - +

    An overwrite object for the targeted user; null if none is set.

    + @@ -1080,7 +1120,8 @@

    IGuildChannel.GetUserAsync(UInt64, CacheMode, RequestOptions)

    -
    +

    Gets a user in this channel.

    +
    Declaration
    @@ -1099,17 +1140,20 @@ System.UInt64 id - +

    The snowflake identifier of the user.

    + CacheMode mode - +

    The CacheMode that determines whether the object should be fetched from cache.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -1124,7 +1168,9 @@ System.Threading.Tasks.Task<IGuildUser> - +

    A task representing the asynchronous get operation. The task result contains a guild user object that +represents the user; null if none is found.

    + @@ -1137,7 +1183,8 @@

    IGuildChannel.Guild

    -
    +

    Gets the guild associated with this channel.

    +
    Declaration
    @@ -1154,7 +1201,8 @@ IGuild - +

    A guild object that this channel belongs to.

    + @@ -1167,7 +1215,8 @@

    IGuildChannel.GuildId

    -
    +

    Gets the guild ID associated with this channel.

    +
    Declaration
    @@ -1184,7 +1233,9 @@ System.UInt64 - +

    An System.UInt64 representing the guild snowflake identifier for the guild that this channel +belongs to.

    + @@ -1197,7 +1248,8 @@

    IGuildChannel.RemovePermissionOverwriteAsync(IRole, RequestOptions)

    -
    +

    Removes the permission overwrite for the given role, if one exists.

    +
    Declaration
    @@ -1216,12 +1268,14 @@ IRole role - +

    The role to remove the overwrite from.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -1236,7 +1290,8 @@ System.Threading.Tasks.Task - +

    A task representing the asynchronous operation for removing the specified permissions from the channel.

    + @@ -1249,7 +1304,8 @@

    IGuildChannel.RemovePermissionOverwriteAsync(IUser, RequestOptions)

    -
    +

    Removes the permission overwrite for the given user, if one exists.

    +
    Declaration
    @@ -1268,12 +1324,14 @@ IUser user - +

    The user to remove the overwrite from.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -1288,7 +1346,8 @@ System.Threading.Tasks.Task - +

    A task representing the asynchronous operation for removing the specified permissions from the channel.

    + diff --git a/docs/api/Discord.WebSocket.SocketGuildUser.html b/docs/api/Discord.WebSocket.SocketGuildUser.html index b85b1f7d6..c206b2acf 100644 --- a/docs/api/Discord.WebSocket.SocketGuildUser.html +++ b/docs/api/Discord.WebSocket.SocketGuildUser.html @@ -197,7 +197,8 @@

    AvatarId

    -
    +

    Gets the identifier of this user's avatar.

    +
    Declaration
    @@ -229,7 +230,8 @@

    DiscriminatorValue

    -
    +

    Gets the per-username unique ID for this user.

    +
    Declaration
    @@ -292,7 +294,8 @@

    GuildPermissions

    -
    +

    Gets the guild-level permissions for this user.

    +
    Declaration
    @@ -309,7 +312,9 @@ GuildPermissions - +

    A GuildPermissions structure for this user, representing what +permissions this user has in the guild.

    + @@ -357,7 +362,8 @@

    IsBot

    -
    +

    Gets a value that indicates whether this user is identified as a bot.

    +
    Declaration
    @@ -374,12 +380,17 @@ System.Boolean - +

    true if the user is a bot application; otherwise false.

    +
    Overrides
    +
    Remarks
    +

    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).

    +
    | Improve this Doc @@ -389,7 +400,8 @@

    IsDeafened

    -
    +

    Gets a value that indicates whether this user is deafened by the guild.

    +
    Declaration
    @@ -406,7 +418,9 @@ System.Boolean - +

    true if the user is deafened (i.e. not permitted to listen to or speak to others) by the guild; +otherwise false.

    + @@ -419,7 +433,9 @@

    IsMuted

    -
    +

    Gets a value that indicates whether this user is muted (i.e. not permitted to speak via voice) by the +guild.

    +
    Declaration
    @@ -436,7 +452,8 @@ System.Boolean - +

    true if this user is muted by the guild; otherwise false.

    + @@ -449,7 +466,8 @@

    IsSelfDeafened

    -
    +

    Gets a value that indicates whether this user has marked themselves as deafened.

    +
    Declaration
    @@ -466,7 +484,8 @@ System.Boolean - +

    true if this user has deafened themselves (i.e. not permitted to listen to or speak to others); otherwise false.

    + @@ -479,7 +498,9 @@

    IsSelfMuted

    -
    +

    Gets a value that indicates whether this user has marked themselves as muted (i.e. not permitted to +speak via voice).

    +
    Declaration
    @@ -496,7 +517,8 @@ System.Boolean - +

    true if this user has muted themselves; otherwise false.

    + @@ -509,7 +531,8 @@

    IsStreaming

    -
    +

    Gets a value that indicates if this user is streaming in a voice channel.

    +
    Declaration
    @@ -526,7 +549,8 @@ System.Boolean - +

    true if the user is streaming; otherwise false.

    + @@ -539,7 +563,8 @@

    IsSuppressed

    -
    +

    Gets a value that indicates whether the user is muted by the current user.

    +
    Declaration
    @@ -556,7 +581,8 @@ System.Boolean - +

    true if the guild is temporarily blocking audio to/from this user; otherwise false.

    + @@ -569,7 +595,8 @@

    IsWebhook

    -
    +

    Gets a value that indicates whether this user is a webhook user.

    +
    Declaration
    @@ -586,7 +613,8 @@ System.Boolean - +

    true if the user is a webhook; otherwise false.

    + @@ -601,7 +629,8 @@

    JoinedAt

    -
    +

    Gets when this user joined the guild.

    +
    Declaration
    @@ -618,7 +647,9 @@ System.Nullable<System.DateTimeOffset> - +

    A System.DateTimeOffset representing the time of which the user has joined the guild; +null when it cannot be obtained.

    + @@ -631,7 +662,8 @@

    Nickname

    -
    +

    Gets the nickname for this user.

    +
    Declaration
    @@ -648,7 +680,8 @@ System.String - +

    A string representing the nickname of the user; null if none is set.

    + @@ -661,7 +694,8 @@

    PremiumSince

    -
    +

    Gets the date and time for when this user's guild boost began.

    +
    Declaration
    @@ -678,7 +712,8 @@ System.Nullable<System.DateTimeOffset> - +

    A System.DateTimeOffset for when the user began boosting this guild; null if they are not boosting the guild.

    + @@ -722,7 +757,8 @@

    Username

    -
    +

    Gets the username for this user.

    +
    Declaration
    @@ -785,7 +821,8 @@

    VoiceSessionId

    -
    +

    Gets the unique identifier for this user's voice session.

    +
    Declaration
    @@ -850,7 +887,8 @@ connected to a voice channel.

    AddRoleAsync(IRole, RequestOptions)

    -
    +

    Adds the specified role to this user in the guild.

    +
    Declaration
    @@ -869,12 +907,14 @@ connected to a voice channel.

    IRole role - +

    The role to be added to the user.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -889,7 +929,8 @@ connected to a voice channel.

    System.Threading.Tasks.Task - +

    A task that represents the asynchronous role addition operation.

    + @@ -902,7 +943,8 @@ connected to a voice channel.

    AddRolesAsync(IEnumerable<IRole>, RequestOptions)

    -
    +

    Adds the specified roles to this user in the guild.

    +
    Declaration
    @@ -921,12 +963,14 @@ connected to a voice channel.

    System.Collections.Generic.IEnumerable<IRole> roles - +

    The roles to be added to the user.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -941,7 +985,8 @@ connected to a voice channel.

    System.Threading.Tasks.Task - +

    A task that represents the asynchronous role addition operation.

    + @@ -954,7 +999,8 @@ connected to a voice channel.

    GetPermissions(IGuildChannel)

    -
    +

    Gets the level permissions granted to this user to a given channel.

    +
    Declaration
    @@ -973,7 +1019,8 @@ connected to a voice channel.

    IGuildChannel channel - +

    The channel to get the permission from.

    + @@ -988,7 +1035,9 @@ connected to a voice channel.

    ChannelPermissions - +

    A ChannelPermissions structure representing the permissions that a user has in the +specified channel.

    + @@ -1001,7 +1050,8 @@ connected to a voice channel.

    KickAsync(String, RequestOptions)

    -
    +

    Kicks this user from this guild.

    +
    Declaration
    @@ -1020,12 +1070,14 @@ connected to a voice channel.

    System.String reason - +

    The reason for the kick which will be recorded in the audit log.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -1040,7 +1092,8 @@ connected to a voice channel.

    System.Threading.Tasks.Task - +

    A task that represents the asynchronous kick operation.

    + @@ -1053,7 +1106,8 @@ connected to a voice channel.

    ModifyAsync(Action<GuildUserProperties>, RequestOptions)

    -
    +

    Modifies this user's properties in this guild.

    +
    Declaration
    @@ -1072,12 +1126,14 @@ connected to a voice channel.

    System.Action<GuildUserProperties> func - +

    The delegate containing the properties to modify the user with.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -1092,10 +1148,15 @@ connected to a voice channel.

    System.Threading.Tasks.Task - +

    A task that represents the asynchronous modification operation.

    + +
    Remarks
    +

    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 GuildUserProperties.

    +
    | Improve this Doc @@ -1105,7 +1166,8 @@ connected to a voice channel.

    RemoveRoleAsync(IRole, RequestOptions)

    -
    +

    Removes the specified role from this user in the guild.

    +
    Declaration
    @@ -1124,12 +1186,14 @@ connected to a voice channel.

    IRole role - +

    The role to be removed from the user.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -1144,7 +1208,8 @@ connected to a voice channel.

    System.Threading.Tasks.Task - +

    A task that represents the asynchronous role removal operation.

    + @@ -1157,7 +1222,8 @@ connected to a voice channel.

    RemoveRolesAsync(IEnumerable<IRole>, RequestOptions)

    -
    +

    Removes the specified roles from this user in the guild.

    +
    Declaration
    @@ -1176,12 +1242,14 @@ connected to a voice channel.

    System.Collections.Generic.IEnumerable<IRole> roles - +

    The roles to be removed from the user.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -1196,7 +1264,8 @@ connected to a voice channel.

    System.Threading.Tasks.Task - +

    A task that represents the asynchronous role removal operation.

    + @@ -1211,7 +1280,8 @@ connected to a voice channel.

    IGuildUser.Guild

    -
    +

    Gets the guild for this user.

    +
    Declaration
    @@ -1228,7 +1298,8 @@ connected to a voice channel.

    IGuild - +

    A guild object that this user belongs to.

    + @@ -1241,7 +1312,8 @@ connected to a voice channel.

    IGuildUser.GuildId

    -
    +

    Gets the ID of the guild for this user.

    +
    Declaration
    @@ -1258,7 +1330,8 @@ connected to a voice channel.

    System.UInt64 - +

    An System.UInt64 representing the snowflake identifier of the guild that this user belongs to.

    + @@ -1271,7 +1344,8 @@ connected to a voice channel.

    IGuildUser.RoleIds

    -
    +

    Gets a collection of IDs for the roles that this user currently possesses in the guild.

    +
    Declaration
    @@ -1288,10 +1362,17 @@ connected to a voice channel.

    System.Collections.Generic.IReadOnlyCollection<System.UInt64> - +

    A read-only collection of System.UInt64, each representing a snowflake identifier for a role that +this user possesses.

    + +
    Remarks
    +

    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.

    +
    | Improve this Doc @@ -1301,7 +1382,8 @@ connected to a voice channel.

    IVoiceState.VoiceChannel

    -
    +

    Gets the voice channel this user is currently in.

    +
    Declaration
    @@ -1318,7 +1400,9 @@ connected to a voice channel.

    IVoiceChannel - +

    A generic voice channel object representing the voice channel that the user is currently in; null +if none.

    + diff --git a/docs/api/Discord.WebSocket.SocketMessage.html b/docs/api/Discord.WebSocket.SocketMessage.html index 771a89c33..d827405c5 100644 --- a/docs/api/Discord.WebSocket.SocketMessage.html +++ b/docs/api/Discord.WebSocket.SocketMessage.html @@ -132,7 +132,8 @@

    Activity

    -
    +

    Gets the activity associated with a message.

    +
    Declaration
    @@ -149,10 +150,15 @@ MessageActivity - +

    A message's activity, if any is associated.

    + +
    Remarks
    +

    Sent with Rich Presence-related chat embeds. This often refers to activity that requires end-user's +interaction, such as a Spotify Invite activity.

    +
    | Improve this Doc @@ -162,7 +168,8 @@

    Application

    -
    +

    Gets the application associated with a message.

    +
    Declaration
    @@ -179,10 +186,14 @@ MessageApplication - +

    A message's application, if any is associated.

    + +
    Remarks
    +

    Sent with Rich-Presence-related chat embeds.

    +
    | Improve this Doc @@ -288,7 +299,8 @@

    Content

    -
    +

    Gets the content for this message.

    +
    Declaration
    @@ -305,7 +317,8 @@ System.String - +

    A string that contains the body of the message; note that this field may be empty if there is an embed.

    + @@ -318,7 +331,8 @@

    CreatedAt

    -
    +

    Gets when the snowflake was created.

    +
    Declaration
    @@ -335,7 +349,8 @@ System.DateTimeOffset - +

    A System.DateTimeOffset representing when the entity was first created.

    + @@ -348,7 +363,8 @@

    EditedTimestamp

    -
    +

    Gets the time of this message's last edit.

    +
    Declaration
    @@ -365,7 +381,8 @@ System.Nullable<System.DateTimeOffset> - +

    Time of when the message was last edited; null if the message is never edited.

    + @@ -410,7 +427,8 @@

    IsPinned

    -
    +

    Gets the value that indicates whether this message is pinned.

    +
    Declaration
    @@ -427,7 +445,8 @@ System.Boolean - +

    true if this message was added to its channel's pinned messages; otherwise false.

    + @@ -440,7 +459,8 @@

    IsSuppressed

    -
    +

    Gets the value that indicates whether or not this message's embeds are suppressed.

    +
    Declaration
    @@ -457,7 +477,8 @@ System.Boolean - +

    true if the embeds in this message have been suppressed (made invisible); otherwise false.

    + @@ -470,7 +491,8 @@

    IsTTS

    -
    +

    Gets the value that indicates whether this message was meant to be read-aloud by Discord.

    +
    Declaration
    @@ -487,7 +509,8 @@ System.Boolean - +

    true if this message was sent as a text-to-speech message; otherwise false.

    + @@ -596,7 +619,8 @@

    Reactions

    -
    +

    Gets all reactions included in this message.

    +
    Declaration
    @@ -626,7 +650,8 @@

    Reference

    -
    +

    Gets the reference to the original message if it was crossposted.

    +
    Declaration
    @@ -643,10 +668,15 @@ MessageReference - +

    A message's reference, if any is associated.

    + +
    Remarks
    +

    Sent with Cross-posted messages, meaning they were published from news channels +and received by subscriber channels.

    +
    | Improve this Doc @@ -656,7 +686,8 @@

    Source

    -
    +

    Gets the source type of this message.

    +
    Declaration
    @@ -686,7 +717,8 @@

    Tags

    -
    +

    Gets all tags included in this message's content.

    +
    Declaration
    @@ -716,7 +748,8 @@

    Timestamp

    -
    +

    Gets the time this message was sent.

    +
    Declaration
    @@ -733,7 +766,8 @@ System.DateTimeOffset - +

    Time of when the message was sent.

    + @@ -748,7 +782,8 @@

    AddReactionAsync(IEmote, RequestOptions)

    -
    +

    Adds a reaction to this message.

    +
    Declaration
    @@ -767,12 +802,14 @@ IEmote emote - +

    The emoji used to react to this message.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -787,10 +824,15 @@ System.Threading.Tasks.Task - +

    A task that represents the asynchronous operation for adding a reaction to this message.

    + +
    See Also
    +
    + +
    | Improve this Doc @@ -800,7 +842,8 @@

    DeleteAsync(RequestOptions)

    -
    +

    Deletes this object and all its children.

    +
    Declaration
    @@ -819,7 +862,8 @@ RequestOptions options - +

    The options to be used when sending the request.

    + @@ -904,7 +948,8 @@

    RemoveAllReactionsAsync(RequestOptions)

    -
    +

    Removes all reactions from this message.

    +
    Declaration
    @@ -923,7 +968,8 @@ RequestOptions options - +

    The options to be used when sending the request.

    + @@ -938,7 +984,8 @@ System.Threading.Tasks.Task - +

    A task that represents the asynchronous removal operation.

    + @@ -951,7 +998,8 @@

    RemoveReactionAsync(IEmote, IUser, RequestOptions)

    -
    +

    Removes a reaction from message.

    +
    Declaration
    @@ -970,17 +1018,20 @@ IEmote emote - +

    The emoji used to react to this message.

    + IUser user - +

    The user that added the emoji.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -995,10 +1046,15 @@ System.Threading.Tasks.Task - +

    A task that represents the asynchronous operation for removing a reaction to this message.

    + +
    See Also
    +
    + +
    | Improve this Doc @@ -1008,7 +1064,8 @@

    RemoveReactionAsync(IEmote, UInt64, RequestOptions)

    -
    +

    Removes a reaction from message.

    +
    Declaration
    @@ -1027,17 +1084,20 @@ IEmote emote - +

    The emoji used to react to this message.

    + System.UInt64 userId - +

    The ID of the user that added the emoji.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -1052,10 +1112,15 @@ System.Threading.Tasks.Task - +

    A task that represents the asynchronous operation for removing a reaction to this message.

    + +
    See Also
    +
    + +
    | Improve this Doc @@ -1101,7 +1166,8 @@

    IMessage.Attachments

    -
    +

    Gets all attachments included in this message.

    +
    Declaration
    @@ -1118,10 +1184,16 @@ System.Collections.Generic.IReadOnlyCollection<IAttachment> - +

    A read-only collection of attachments.

    + +
    Remarks
    +

    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.

    +
    | Improve this Doc @@ -1131,7 +1203,8 @@

    IMessage.Author

    -
    +

    Gets the author of this message.

    +
    Declaration
    @@ -1161,7 +1234,8 @@

    IMessage.Channel

    -
    +

    Gets the source channel of the message.

    +
    Declaration
    @@ -1191,7 +1265,8 @@

    IMessage.Embeds

    -
    +

    Gets all embeds included in this message.

    +
    Declaration
    @@ -1208,7 +1283,8 @@ System.Collections.Generic.IReadOnlyCollection<IEmbed> - +

    A read-only collection of embed objects.

    + @@ -1221,7 +1297,8 @@

    IMessage.MentionedChannelIds

    -
    +

    Gets the IDs of channels mentioned in this message.

    +
    Declaration
    @@ -1238,7 +1315,8 @@ System.Collections.Generic.IReadOnlyCollection<System.UInt64> - +

    A read-only collection of channel IDs.

    + @@ -1251,7 +1329,8 @@

    IMessage.MentionedRoleIds

    -
    +

    Gets the IDs of roles mentioned in this message.

    +
    Declaration
    @@ -1268,7 +1347,8 @@ System.Collections.Generic.IReadOnlyCollection<System.UInt64> - +

    A read-only collection of role IDs.

    + @@ -1281,7 +1361,8 @@

    IMessage.MentionedUserIds

    -
    +

    Gets the IDs of users mentioned in this message.

    +
    Declaration
    @@ -1298,7 +1379,8 @@ System.Collections.Generic.IReadOnlyCollection<System.UInt64> - +

    A read-only collection of user IDs.

    + @@ -1311,7 +1393,8 @@

    IMessage.Type

    -
    +

    Gets the type of this system message.

    +
    Declaration
    diff --git a/docs/api/Discord.WebSocket.SocketNewsChannel.html b/docs/api/Discord.WebSocket.SocketNewsChannel.html index 2bb5d561a..56a74f820 100644 --- a/docs/api/Discord.WebSocket.SocketNewsChannel.html +++ b/docs/api/Discord.WebSocket.SocketNewsChannel.html @@ -345,7 +345,8 @@

    SlowModeInterval

    -
    +

    Gets the current slow-mode delay for this channel.

    +
    Declaration
    @@ -362,7 +363,9 @@ System.Int32 - +

    An System.Int32 representing the time in seconds required before the user can send another +message; 0 if disabled.

    + diff --git a/docs/api/Discord.WebSocket.SocketPresence.html b/docs/api/Discord.WebSocket.SocketPresence.html index 37c3e14fa..37b9ef2dd 100644 --- a/docs/api/Discord.WebSocket.SocketPresence.html +++ b/docs/api/Discord.WebSocket.SocketPresence.html @@ -115,7 +115,8 @@

    ActiveClients

    -
    +

    Gets the set of clients where this user is currently active.

    +
    Declaration
    @@ -145,7 +146,8 @@

    Activity

    -
    +

    Gets the activity this user is currently doing.

    +
    Declaration
    @@ -175,7 +177,8 @@

    Status

    -
    +

    Gets the current status of this user.

    +
    Declaration
    diff --git a/docs/api/Discord.WebSocket.SocketReaction.html b/docs/api/Discord.WebSocket.SocketReaction.html index 6565b0886..897803825 100644 --- a/docs/api/Discord.WebSocket.SocketReaction.html +++ b/docs/api/Discord.WebSocket.SocketReaction.html @@ -152,7 +152,8 @@

    Emote

    -
    +

    The IEmote used in the reaction.

    +
    Declaration
    diff --git a/docs/api/Discord.WebSocket.SocketRole.html b/docs/api/Discord.WebSocket.SocketRole.html index 3c7d61921..bfba724f4 100644 --- a/docs/api/Discord.WebSocket.SocketRole.html +++ b/docs/api/Discord.WebSocket.SocketRole.html @@ -132,7 +132,8 @@

    Color

    -
    +

    Gets the color given to users of this role.

    +
    Declaration
    @@ -149,7 +150,8 @@ Color - +

    A Color struct representing the color of this role.

    + @@ -162,7 +164,8 @@

    CreatedAt

    -
    +

    Gets when the snowflake was created.

    +
    Declaration
    @@ -179,7 +182,8 @@ System.DateTimeOffset - +

    A System.DateTimeOffset representing when the entity was first created.

    + @@ -256,7 +260,8 @@

    IsHoisted

    -
    +

    Gets a value that indicates whether the role can be separated in the user list.

    +
    Declaration
    @@ -273,7 +278,8 @@ System.Boolean - +

    true if users of this role are separated in the user list; otherwise false.

    + @@ -286,7 +292,8 @@

    IsManaged

    -
    +

    Gets a value that indicates whether the role is managed by Discord.

    +
    Declaration
    @@ -303,7 +310,8 @@ System.Boolean - +

    true if this role is automatically managed by Discord; otherwise false.

    + @@ -316,7 +324,8 @@

    IsMentionable

    -
    +

    Gets a value that indicates whether the role is mentionable.

    +
    Declaration
    @@ -333,7 +342,8 @@ System.Boolean - +

    true if this role may be mentioned in messages; otherwise false.

    + @@ -376,7 +386,8 @@

    Mention

    -
    +

    Returns a special string used to mention this object.

    +
    Declaration
    @@ -393,7 +404,8 @@ System.String - +

    A string that is recognized by Discord as a mention (e.g. <@168693960628371456>).

    + @@ -406,7 +418,8 @@

    Name

    -
    +

    Gets the name of this role.

    +
    Declaration
    @@ -423,7 +436,8 @@ System.String - +

    A string containing the name of this role.

    + @@ -436,7 +450,8 @@

    Permissions

    -
    +

    Gets the permissions granted to members of this role.

    +
    Declaration
    @@ -453,7 +468,8 @@ GuildPermissions - +

    A GuildPermissions struct that this role possesses.

    + @@ -466,7 +482,8 @@

    Position

    -
    +

    Gets this role's position relative to other roles in the same guild.

    +
    Declaration
    @@ -483,7 +500,8 @@ System.Int32 - +

    An System.Int32 representing the position of the role in the role list of the guild.

    + @@ -545,7 +563,8 @@

    DeleteAsync(RequestOptions)

    -
    +

    Deletes this object and all its children.

    +
    Declaration
    @@ -564,7 +583,8 @@ RequestOptions options - +

    The options to be used when sending the request.

    + @@ -592,7 +612,8 @@

    ModifyAsync(Action<RoleProperties>, RequestOptions)

    -
    +

    Modifies this role.

    +
    Declaration
    @@ -611,12 +632,14 @@ System.Action<RoleProperties> func - +

    A delegate containing the properties to modify the role with.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -631,10 +654,15 @@ System.Threading.Tasks.Task - +

    A task that represents the asynchronous modification operation.

    + +
    Remarks
    +

    This method modifies this role with the specified properties. To see an example of this +method and what properties are available, please refer to RoleProperties.

    +
    | Improve this Doc @@ -680,7 +708,8 @@

    IRole.Guild

    -
    +

    Gets the guild that owns this role.

    +
    Declaration
    @@ -697,7 +726,8 @@ IGuild - +

    A guild representing the parent guild of this role.

    + diff --git a/docs/api/Discord.WebSocket.SocketSelfUser.html b/docs/api/Discord.WebSocket.SocketSelfUser.html index 17f3ea7e1..7303f5a34 100644 --- a/docs/api/Discord.WebSocket.SocketSelfUser.html +++ b/docs/api/Discord.WebSocket.SocketSelfUser.html @@ -166,7 +166,8 @@

    AvatarId

    -
    +

    Gets the identifier of this user's avatar.

    +
    Declaration
    @@ -198,7 +199,8 @@

    DiscriminatorValue

    -
    +

    Gets the per-username unique ID for this user.

    +
    Declaration
    @@ -230,7 +232,8 @@

    Email

    -
    +

    Gets the email associated with this user.

    +
    Declaration
    @@ -260,7 +263,8 @@

    Flags

    -
    +

    Gets the flags that are applied to a user's account.

    +
    Declaration
    @@ -277,10 +281,14 @@ UserProperties - +

    The value of flags for this user.

    + +
    Remarks
    +

    This value is determined by bitwise OR-ing UserProperties values together.

    +
    | Improve this Doc @@ -290,7 +298,8 @@

    IsBot

    -
    +

    Gets a value that indicates whether this user is identified as a bot.

    +
    Declaration
    @@ -307,12 +316,17 @@ System.Boolean - +

    true if the user is a bot application; otherwise false.

    +
    Overrides
    +
    Remarks
    +

    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).

    +
    | Improve this Doc @@ -322,7 +336,8 @@

    IsMfaEnabled

    -
    +

    Indicates whether or not this user has MFA enabled on their account.

    +
    Declaration
    @@ -339,7 +354,8 @@ System.Boolean - +

    true if this user has enabled multi-factor authentication on their account; false if not.

    + @@ -352,7 +368,8 @@

    IsVerified

    -
    +

    Indicates whether or not this user has their email verified.

    +
    Declaration
    @@ -369,7 +386,8 @@ System.Boolean - +

    true if this user's email has been verified; false if not.

    + @@ -382,7 +400,8 @@

    IsWebhook

    -
    +

    Gets a value that indicates whether this user is a webhook user.

    +
    Declaration
    @@ -399,7 +418,8 @@ System.Boolean - +

    true if the user is a webhook; otherwise false.

    + @@ -414,7 +434,8 @@

    Locale

    -
    +

    Gets the user's chosen language option.

    +
    Declaration
    @@ -431,7 +452,9 @@ System.String - +

    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.

    + @@ -444,7 +467,8 @@

    PremiumType

    -
    +

    Gets the type of Nitro subscription that is active on this user's account.

    +
    Declaration
    @@ -461,10 +485,14 @@ PremiumType - +

    The type of Nitro subscription the user subscribes to, if any.

    + +
    Remarks
    +

    This information may only be available with the identify OAuth scope.

    +
    | Improve this Doc @@ -474,7 +502,8 @@

    Username

    -
    +

    Gets the username for this user.

    +
    Declaration
    @@ -508,7 +537,8 @@

    ModifyAsync(Action<SelfUserProperties>, RequestOptions)

    -
    +

    Modifies the user's properties.

    +
    Declaration
    diff --git a/docs/api/Discord.WebSocket.SocketSystemMessage.html b/docs/api/Discord.WebSocket.SocketSystemMessage.html index a6bdf979b..dc844a0cd 100644 --- a/docs/api/Discord.WebSocket.SocketSystemMessage.html +++ b/docs/api/Discord.WebSocket.SocketSystemMessage.html @@ -237,7 +237,8 @@

    Type

    -
    +

    Gets the type of this system message.

    +
    Declaration
    diff --git a/docs/api/Discord.WebSocket.SocketTextChannel.html b/docs/api/Discord.WebSocket.SocketTextChannel.html index 2bfbaa7ad..1c46931da 100644 --- a/docs/api/Discord.WebSocket.SocketTextChannel.html +++ b/docs/api/Discord.WebSocket.SocketTextChannel.html @@ -211,7 +211,8 @@

    CachedMessages

    -
    +

    Gets all messages in this channel's cache.

    +
    Declaration
    @@ -228,7 +229,8 @@ System.Collections.Generic.IReadOnlyCollection<SocketMessage> - +

    A read-only collection of WebSocket-based messages.

    + @@ -273,7 +275,8 @@

    CategoryId

    -
    +

    Gets the parent (category) ID of this channel in the guild's channel list.

    +
    Declaration
    @@ -290,7 +293,9 @@ System.Nullable<System.UInt64> - +

    A System.UInt64 representing the snowflake identifier of the parent of this channel; +null if none is set.

    + @@ -303,7 +308,8 @@

    IsNsfw

    -
    +

    Gets a value that indicates whether the channel is NSFW.

    +
    Declaration
    @@ -320,7 +326,8 @@ System.Boolean - +

    true if the channel has the NSFW flag enabled; otherwise false.

    + @@ -333,7 +340,8 @@

    Mention

    -
    +

    Returns a special string used to mention this object.

    +
    Declaration
    @@ -350,7 +358,8 @@ System.String - +

    A string that is recognized by Discord as a mention (e.g. <@168693960628371456>).

    + @@ -363,7 +372,8 @@

    SlowModeInterval

    -
    +

    Gets the current slow-mode delay for this channel.

    +
    Declaration
    @@ -380,7 +390,9 @@ System.Int32 - +

    An System.Int32 representing the time in seconds required before the user can send another +message; 0 if disabled.

    + @@ -393,7 +405,8 @@

    Topic

    -
    +

    Gets the current topic for this text channel.

    +
    Declaration
    @@ -410,7 +423,8 @@ System.String - +

    A string representing the topic set in the channel; null if none is set.

    + @@ -423,7 +437,8 @@

    Users

    -
    +

    Gets a collection of users that are able to view the channel.

    +
    Declaration
    @@ -440,7 +455,8 @@ System.Collections.Generic.IReadOnlyCollection<SocketGuildUser> - +

    A read-only collection of users that can access the channel (i.e. the users seen in the user list).

    + @@ -457,7 +473,8 @@

    CreateInviteAsync(Nullable<Int32>, Nullable<Int32>, Boolean, Boolean, RequestOptions)

    -
    +

    Creates a new invite to this channel.

    +
    Declaration
    @@ -476,27 +493,32 @@ System.Nullable<System.Int32> maxAge - +

    The time (in seconds) until the invite expires. Set to null to never expire.

    + System.Nullable<System.Int32> maxUses - +

    The max amount of times this invite may be used. Set to null to have unlimited uses.

    + System.Boolean isTemporary - +

    If true, the user accepting this invite will be kicked from the guild after closing their client.

    + System.Boolean isUnique - +

    If true, don't try to reuse a similar invite (useful for creating many unique one time use invites).

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -511,7 +533,9 @@ System.Threading.Tasks.Task<IInviteMetadata> - +

    A task that represents the asynchronous invite creation operation. The task result contains an invite +metadata object containing information for the created invite.

    + @@ -587,7 +611,8 @@ webhook.

    DeleteMessageAsync(IMessage, RequestOptions)

    -
    +

    Deletes a message based on the provided message in this channel.

    +
    Declaration
    @@ -606,12 +631,14 @@ webhook.

    IMessage message - +

    The message that would be removed.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -626,7 +653,8 @@ webhook.

    System.Threading.Tasks.Task - +

    A task that represents the asynchronous removal operation.

    + @@ -639,7 +667,8 @@ webhook.

    DeleteMessageAsync(UInt64, RequestOptions)

    -
    +

    Deletes a message.

    +
    Declaration
    @@ -658,12 +687,14 @@ webhook.

    System.UInt64 messageId - +

    The snowflake identifier of the message that would be removed.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -678,7 +709,8 @@ webhook.

    System.Threading.Tasks.Task - +

    A task that represents the asynchronous removal operation.

    + @@ -691,7 +723,8 @@ webhook.

    DeleteMessagesAsync(IEnumerable<IMessage>, RequestOptions)

    -
    +

    Bulk-deletes multiple messages.

    +
    Declaration
    @@ -710,12 +743,14 @@ webhook.

    System.Collections.Generic.IEnumerable<IMessage> messages - +

    The messages to be bulk-deleted.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -730,10 +765,17 @@ webhook.

    System.Threading.Tasks.Task - +

    A task that represents the asynchronous bulk-removal operation.

    + +
    Remarks
    +

    This method attempts to remove the messages specified in bulk.

    +
    important

    + Due to the limitation set by Discord, this method can only remove messages that are posted within 14 days! +

    +
    | Improve this Doc @@ -743,7 +785,8 @@ webhook.

    DeleteMessagesAsync(IEnumerable<UInt64>, RequestOptions)

    -
    +

    Bulk-deletes multiple messages.

    +
    Declaration
    @@ -762,12 +805,14 @@ webhook.

    System.Collections.Generic.IEnumerable<System.UInt64> messageIds - +

    The snowflake identifier of the messages to be bulk-deleted.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -782,10 +827,17 @@ webhook.

    System.Threading.Tasks.Task - +

    A task that represents the asynchronous bulk-removal operation.

    + +
    Remarks
    +

    This method attempts to remove the messages specified in bulk.

    +
    important

    + Due to the limitation set by Discord, this method can only remove messages that are posted within 14 days! +

    +
    | Improve this Doc @@ -795,7 +847,9 @@ webhook.

    EnterTypingState(RequestOptions)

    -
    +

    Continuously broadcasts the "user is typing" message to all users in this channel until the returned +object is disposed.

    +
    Declaration
    @@ -814,7 +868,8 @@ webhook.

    RequestOptions options - +

    The options to be used when sending the request.

    + @@ -829,7 +884,9 @@ webhook.

    System.IDisposable - +

    A disposable object that, upon its disposal, will stop the client from broadcasting its typing state in +this channel.

    + @@ -842,7 +899,8 @@ webhook.

    GetCachedMessage(UInt64)

    -
    +

    Gets a cached message from this channel.

    +
    Declaration
    @@ -861,7 +919,8 @@ webhook.

    System.UInt64 id - +

    The snowflake identifier of the message.

    + @@ -876,10 +935,23 @@ webhook.

    SocketMessage - +

    A WebSocket-based message object; null if it does not exist in the cache or if caching is not +enabled.

    + +
    Remarks
    +
    warning

    + This method requires the use of cache, which is not enabled by default; if caching is not enabled, + this method will always return null. Please refer to +MessageCacheSize for more details. +

    +

    + 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. +

    +
    | Improve this Doc @@ -889,7 +961,8 @@ webhook.

    GetCachedMessages(IMessage, Direction, Int32)

    -
    +

    Gets the last N cached messages starting from a certain message in this message channel.

    +
    Declaration
    @@ -908,17 +981,20 @@ webhook.

    IMessage fromMessage - +

    The message to start the fetching from.

    + Direction dir - +

    The direction of which the message should be gotten from.

    + System.Int32 limit - +

    The number of messages to get.

    + @@ -933,10 +1009,24 @@ webhook.

    System.Collections.Generic.IReadOnlyCollection<SocketMessage> - +

    A read-only collection of WebSocket-based messages.

    + +
    Remarks
    +
    warning

    + 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 +MessageCacheSize for more details. +

    +

    + 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 +MessageCacheSize set. +

    +
    | Improve this Doc @@ -946,7 +1036,8 @@ webhook.

    GetCachedMessages(Int32)

    -
    +

    Gets the last N cached messages from this message channel.

    +
    Declaration
    @@ -965,7 +1056,8 @@ webhook.

    System.Int32 limit - +

    The number of messages to get.

    + @@ -980,10 +1072,24 @@ webhook.

    System.Collections.Generic.IReadOnlyCollection<SocketMessage> - +

    A read-only collection of WebSocket-based messages.

    + +
    Remarks
    +
    warning

    + 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 +MessageCacheSize for more details. +

    +

    + 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 +MessageCacheSize set. +

    +
    | Improve this Doc @@ -993,7 +1099,8 @@ webhook.

    GetCachedMessages(UInt64, Direction, Int32)

    -
    +

    Gets the last N cached messages starting from a certain message in this message channel.

    +
    Declaration
    @@ -1012,17 +1119,20 @@ webhook.

    System.UInt64 fromMessageId - +

    The message ID to start the fetching from.

    + Direction dir - +

    The direction of which the message should be gotten from.

    + System.Int32 limit - +

    The number of messages to get.

    + @@ -1037,10 +1147,24 @@ webhook.

    System.Collections.Generic.IReadOnlyCollection<SocketMessage> - +

    A read-only collection of WebSocket-based messages.

    + +
    Remarks
    +
    warning

    + 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 +MessageCacheSize for more details. +

    +

    + 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 +MessageCacheSize set. +

    +
    | Improve this Doc @@ -1050,7 +1174,8 @@ webhook.

    GetInvitesAsync(RequestOptions)

    -
    +

    Gets a collection of all invites to this channel.

    +
    Declaration
    @@ -1069,7 +1194,8 @@ webhook.

    RequestOptions options - +

    The options to be used when sending the request.

    + @@ -1084,7 +1210,9 @@ webhook.

    System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyCollection<IInviteMetadata>> - +

    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.

    + @@ -1362,7 +1490,8 @@ Please visit its documentation for more details on this method.

    GetPinnedMessagesAsync(RequestOptions)

    -
    +

    Gets a read-only collection of pinned messages in this channel.

    +
    Declaration
    @@ -1381,7 +1510,8 @@ Please visit its documentation for more details on this method.

    RequestOptions options - +

    The options to be used when sending the request.

    + @@ -1396,10 +1526,16 @@ Please visit its documentation for more details on this method.

    System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyCollection<RestMessage>> - +

    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.

    + +
    Remarks
    +

    This method follows the same behavior as described in GetPinnedMessagesAsync(RequestOptions). +Please visit its documentation for more details on this method.

    +
    | Improve this Doc @@ -1566,7 +1702,8 @@ of webhooks that is available in this channel.

    ModifyAsync(Action<TextChannelProperties>, RequestOptions)

    -
    +

    Modifies this text channel.

    +
    Declaration
    @@ -1585,12 +1722,14 @@ of webhooks that is available in this channel.

    System.Action<TextChannelProperties> func - +

    The delegate containing the properties to modify the channel with.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -1605,10 +1744,15 @@ of webhooks that is available in this channel.

    System.Threading.Tasks.Task - +

    A task that represents the asynchronous modification operation.

    + +
    See Also
    +
    + +
    | Improve this Doc @@ -1618,7 +1762,8 @@ of webhooks that is available in this channel.

    SendFileAsync(Stream, String, String, Boolean, Embed, RequestOptions, Boolean)

    -
    +

    Sends a file to this message channel with an optional caption.

    +
    Declaration
    @@ -1637,37 +1782,44 @@ of webhooks that is available in this channel.

    System.IO.Stream stream - +

    The System.IO.Stream of the file to be sent.

    + System.String filename - +

    The name of the attachment.

    + System.String text - +

    The message to be sent.

    + System.Boolean isTTS - +

    Whether the message should be read aloud by Discord or not.

    + Embed embed - +

    The Rich Embed to be sent.

    + RequestOptions options - +

    The options to be used when sending the request.

    + System.Boolean isSpoiler - +

    Whether the message attachment should be hidden as a spoiler.

    + @@ -1682,10 +1834,16 @@ of webhooks that is available in this channel.

    System.Threading.Tasks.Task<RestUserMessage> - +

    A task that represents an asynchronous send operation for delivering the message. The task result +contains the sent message.

    + +
    Remarks
    +

    This method follows the same behavior as described in SendFileAsync(Stream, String, String, Boolean, Embed, RequestOptions, Boolean). +Please visit its documentation for more details on this method.

    +
    Exceptions
    @@ -1711,7 +1869,8 @@ of webhooks that is available in this channel.

    SendFileAsync(String, String, Boolean, Embed, RequestOptions, Boolean)

    -
    +

    Sends a file to this message channel with an optional caption.

    +
    Declaration
    @@ -1730,32 +1889,38 @@ of webhooks that is available in this channel.

    - + - + - + - + - + - +
    System.String filePath

    The file path of the file.

    +
    System.String text

    The message to be sent.

    +
    System.Boolean isTTS

    Whether the message should be read aloud by Discord or not.

    +
    Embed embed

    The Rich Embed to be sent.

    +
    RequestOptions options

    The options to be used when sending the request.

    +
    System.Boolean isSpoiler

    Whether the message attachment should be hidden as a spoiler.

    +
    @@ -1770,10 +1935,16 @@ of webhooks that is available in this channel.

    System.Threading.Tasks.Task<RestUserMessage> - +

    A task that represents an asynchronous send operation for delivering the message. The task result +contains the sent message.

    + +
    Remarks
    +

    This method follows the same behavior as described in SendFileAsync(String, String, Boolean, Embed, RequestOptions, Boolean). +Please visit its documentation for more details on this method.

    +
    | Improve this Doc @@ -1783,7 +1954,8 @@ of webhooks that is available in this channel.

    SendMessageAsync(String, Boolean, Embed, RequestOptions)

    -
    +

    Sends a message to this message channel.

    +
    Declaration
    @@ -1802,22 +1974,26 @@ of webhooks that is available in this channel.

    System.String text - +

    The message to be sent.

    + System.Boolean isTTS - +

    Determines whether the message should be read aloud by Discord or not.

    + Embed embed - +

    The Rich Embed to be sent.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -1832,10 +2008,16 @@ of webhooks that is available in this channel.

    System.Threading.Tasks.Task<RestUserMessage> - +

    A task that represents an asynchronous send operation for delivering the message. The task result +contains the sent message.

    + +
    Remarks
    +

    This method follows the same behavior as described in SendMessageAsync(String, Boolean, Embed, RequestOptions). +Please visit its documentation for more details on this method.

    +
    Exceptions
    @@ -1861,7 +2043,8 @@ of webhooks that is available in this channel.

    SyncPermissionsAsync(RequestOptions)

    -
    +

    Syncs the permissions of this nested channel with its parent's.

    +
    Declaration
    @@ -1880,7 +2063,8 @@ of webhooks that is available in this channel.

    - +
    RequestOptions options

    The options to be used when sending the request.

    +
    @@ -1895,7 +2079,8 @@ of webhooks that is available in this channel.

    System.Threading.Tasks.Task - +

    A task that represents the asynchronous operation for syncing channel permissions with its parent's.

    + @@ -1908,7 +2093,8 @@ of webhooks that is available in this channel.

    TriggerTypingAsync(RequestOptions)

    -
    +

    Broadcasts the "user is typing" message to all users in this channel, lasting 10 seconds.

    +
    Declaration
    @@ -1927,7 +2113,8 @@ of webhooks that is available in this channel.

    RequestOptions options - +

    The options to be used when sending the request.

    + @@ -1942,7 +2129,8 @@ of webhooks that is available in this channel.

    System.Threading.Tasks.Task - +

    A task that represents the asynchronous operation that triggers the broadcast.

    + @@ -1957,7 +2145,8 @@ of webhooks that is available in this channel.

    IGuildChannel.GetUserAsync(UInt64, CacheMode, RequestOptions)

    -
    +

    Gets a user in this channel.

    +
    Declaration
    @@ -1976,17 +2165,20 @@ of webhooks that is available in this channel.

    System.UInt64 id - +

    The snowflake identifier of the user.

    + CacheMode mode - +

    The CacheMode that determines whether the object should be fetched from cache.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -2001,7 +2193,9 @@ of webhooks that is available in this channel.

    System.Threading.Tasks.Task<IGuildUser> - +

    A task representing the asynchronous get operation. The task result contains a guild user object that +represents the user; null if none is found.

    + @@ -2014,7 +2208,8 @@ of webhooks that is available in this channel.

    IMessageChannel.GetMessageAsync(UInt64, CacheMode, RequestOptions)

    -
    +

    Gets a message from this message channel.

    +
    Declaration
    @@ -2033,17 +2228,20 @@ of webhooks that is available in this channel.

    System.UInt64 id - +

    The snowflake identifier of the message.

    + CacheMode mode - +

    The CacheMode that determines whether the object should be fetched from cache.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -2058,7 +2256,9 @@ of webhooks that is available in this channel.

    System.Threading.Tasks.Task<IMessage> - +

    A task that represents an asynchronous get operation for retrieving the message. The task result contains +the retrieved message; null if no message is found with the specified identifier.

    + @@ -2071,7 +2271,8 @@ of webhooks that is available in this channel.

    IMessageChannel.GetPinnedMessagesAsync(RequestOptions)

    -
    +

    Gets a collection of pinned messages in this channel.

    +
    Declaration
    @@ -2090,7 +2291,8 @@ of webhooks that is available in this channel.

    RequestOptions options - +

    The options to be used when sending the request.

    + @@ -2105,7 +2307,9 @@ of webhooks that is available in this channel.

    System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyCollection<IMessage>> - +

    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.

    + @@ -2118,7 +2322,8 @@ of webhooks that is available in this channel.

    IMessageChannel.SendFileAsync(Stream, String, String, Boolean, Embed, RequestOptions, Boolean)

    -
    +

    Sends a file to this message channel with an optional caption.

    +
    Declaration
    @@ -2137,37 +2342,44 @@ of webhooks that is available in this channel.

    System.IO.Stream stream - +

    The System.IO.Stream of the file to be sent.

    + System.String filename - +

    The name of the attachment.

    + System.String text - +

    The message to be sent.

    + System.Boolean isTTS - +

    Whether the message should be read aloud by Discord or not.

    + Embed embed - +

    The Rich Embed to be sent.

    + RequestOptions options - +

    The options to be used when sending the request.

    + System.Boolean isSpoiler - +

    Whether the message attachment should be hidden as a spoiler.

    + @@ -2182,10 +2394,20 @@ of webhooks that is available in this channel.

    System.Threading.Tasks.Task<IUserMessage> - +

    A task that represents an asynchronous send operation for delivering the message. The task result +contains the sent message.

    + +
    Remarks
    +

    This method sends a file as if you are uploading an attachment directly from your Discord client.

    +
    note

    + If you wish to upload an image and have it embedded in a Rich embed, + you may upload the file and refer to the file with "attachment://filename.ext" in the +ImageUrl. See the example section for its usage. +

    +
    | Improve this Doc @@ -2195,7 +2417,8 @@ of webhooks that is available in this channel.

    IMessageChannel.SendFileAsync(String, String, Boolean, Embed, RequestOptions, Boolean)

    -
    +

    Sends a file to this message channel with an optional caption.

    +
    Declaration
    @@ -2214,32 +2437,38 @@ of webhooks that is available in this channel.

    System.String filePath - +

    The file path of the file.

    + System.String text - +

    The message to be sent.

    + System.Boolean isTTS - +

    Whether the message should be read aloud by Discord or not.

    + Embed embed - +

    The Rich Embed to be sent.

    + RequestOptions options - +

    The options to be used when sending the request.

    + System.Boolean isSpoiler - +

    Whether the message attachment should be hidden as a spoiler.

    + @@ -2254,10 +2483,20 @@ of webhooks that is available in this channel.

    System.Threading.Tasks.Task<IUserMessage> - +

    A task that represents an asynchronous send operation for delivering the message. The task result +contains the sent message.

    + +
    Remarks
    +

    This method sends a file as if you are uploading an attachment directly from your Discord client.

    +
    note

    + If you wish to upload an image and have it embedded in a Rich embed, + you may upload the file and refer to the file with "attachment://filename.ext" in the +ImageUrl. See the example section for its usage. +

    +
    | Improve this Doc @@ -2267,7 +2506,8 @@ of webhooks that is available in this channel.

    IMessageChannel.SendMessageAsync(String, Boolean, Embed, RequestOptions)

    -
    +

    Sends a message to this message channel.

    +
    Declaration
    @@ -2286,22 +2526,26 @@ of webhooks that is available in this channel.

    System.String text - +

    The message to be sent.

    + System.Boolean isTTS - +

    Determines whether the message should be read aloud by Discord or not.

    + Embed embed - +

    The Rich Embed to be sent.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -2316,7 +2560,9 @@ of webhooks that is available in this channel.

    System.Threading.Tasks.Task<IUserMessage> - +

    A task that represents an asynchronous send operation for delivering the message. The task result +contains the sent message.

    + @@ -2329,7 +2575,8 @@ of webhooks that is available in this channel.

    INestedChannel.GetCategoryAsync(CacheMode, RequestOptions)

    -
    +

    Gets the parent (category) channel of this channel.

    +
    Declaration
    @@ -2348,12 +2595,14 @@ of webhooks that is available in this channel.

    CacheMode mode - +

    The CacheMode that determines whether the object should be fetched from cache.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -2368,7 +2617,9 @@ of webhooks that is available in this channel.

    System.Threading.Tasks.Task<ICategoryChannel> - +

    A task that represents the asynchronous get operation. The task result contains the category channel +representing the parent of this channel; null if none is set.

    + @@ -2381,7 +2632,8 @@ of webhooks that is available in this channel.

    ITextChannel.CreateWebhookAsync(String, Stream, RequestOptions)

    -
    +

    Creates a webhook in this text channel.

    +
    Declaration
    @@ -2400,17 +2652,20 @@ of webhooks that is available in this channel.

    System.String name - +

    The name of the webhook.

    + System.IO.Stream avatar - +

    The avatar of the webhook.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -2425,7 +2680,9 @@ of webhooks that is available in this channel.

    System.Threading.Tasks.Task<IWebhook> - +

    A task that represents the asynchronous creation operation. The task result contains the newly created +webhook.

    + @@ -2438,7 +2695,8 @@ of webhooks that is available in this channel.

    ITextChannel.GetWebhookAsync(UInt64, RequestOptions)

    -
    +

    Gets a webhook available in this text channel.

    +
    Declaration
    @@ -2457,12 +2715,14 @@ of webhooks that is available in this channel.

    System.UInt64 id - +

    The identifier of the webhook.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -2477,7 +2737,9 @@ of webhooks that is available in this channel.

    System.Threading.Tasks.Task<IWebhook> - +

    A task that represents the asynchronous get operation. The task result contains a webhook associated +with the identifier; null if the webhook is not found.

    + @@ -2490,7 +2752,8 @@ of webhooks that is available in this channel.

    ITextChannel.GetWebhooksAsync(RequestOptions)

    -
    +

    Gets the webhooks available in this text channel.

    +
    Declaration
    @@ -2509,7 +2772,8 @@ of webhooks that is available in this channel.

    RequestOptions options - +

    The options to be used when sending the request.

    + @@ -2524,7 +2788,9 @@ of webhooks that is available in this channel.

    System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyCollection<IWebhook>> - +

    A task that represents the asynchronous get operation. The task result contains a read-only collection +of webhooks that is available in this channel.

    + diff --git a/docs/api/Discord.WebSocket.SocketUnknownUser.html b/docs/api/Discord.WebSocket.SocketUnknownUser.html index 71545dd97..98d3f9e03 100644 --- a/docs/api/Discord.WebSocket.SocketUnknownUser.html +++ b/docs/api/Discord.WebSocket.SocketUnknownUser.html @@ -168,7 +168,8 @@

    AvatarId

    -
    +

    Gets the identifier of this user's avatar.

    +
    Declaration
    @@ -200,7 +201,8 @@

    DiscriminatorValue

    -
    +

    Gets the per-username unique ID for this user.

    +
    Declaration
    @@ -232,7 +234,8 @@

    IsBot

    -
    +

    Gets a value that indicates whether this user is identified as a bot.

    +
    Declaration
    @@ -249,12 +252,17 @@ System.Boolean - +

    true if the user is a bot application; otherwise false.

    +
    Overrides
    +
    Remarks
    +

    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).

    +
    | Improve this Doc @@ -264,7 +272,8 @@

    IsWebhook

    -
    +

    Gets a value that indicates whether this user is a webhook user.

    +
    Declaration
    @@ -281,7 +290,8 @@ System.Boolean - +

    true if the user is a webhook; otherwise false.

    + @@ -296,7 +306,8 @@

    Username

    -
    +

    Gets the username for this user.

    +
    Declaration
    diff --git a/docs/api/Discord.WebSocket.SocketUser.html b/docs/api/Discord.WebSocket.SocketUser.html index 0047683ad..74e3eecdc 100644 --- a/docs/api/Discord.WebSocket.SocketUser.html +++ b/docs/api/Discord.WebSocket.SocketUser.html @@ -136,7 +136,8 @@

    ActiveClients

    -
    +

    Gets the set of clients where this user is currently active.

    +
    Declaration
    @@ -166,7 +167,8 @@

    Activity

    -
    +

    Gets the activity this user is currently doing.

    +
    Declaration
    @@ -196,7 +198,8 @@

    AvatarId

    -
    +

    Gets the identifier of this user's avatar.

    +
    Declaration
    @@ -226,7 +229,8 @@

    CreatedAt

    -
    +

    Gets when the snowflake was created.

    +
    Declaration
    @@ -243,7 +247,8 @@ System.DateTimeOffset - +

    A System.DateTimeOffset representing when the entity was first created.

    + @@ -256,7 +261,8 @@

    Discriminator

    -
    +

    Gets the per-username unique ID for this user.

    +
    Declaration
    @@ -286,7 +292,8 @@

    DiscriminatorValue

    -
    +

    Gets the per-username unique ID for this user.

    +
    Declaration
    @@ -316,7 +323,8 @@

    IsBot

    -
    +

    Gets a value that indicates whether this user is identified as a bot.

    +
    Declaration
    @@ -333,10 +341,15 @@ System.Boolean - +

    true if the user is a bot application; otherwise false.

    + +
    Remarks
    +

    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).

    +
    | Improve this Doc @@ -346,7 +359,8 @@

    IsWebhook

    -
    +

    Gets a value that indicates whether this user is a webhook user.

    +
    Declaration
    @@ -363,7 +377,8 @@ System.Boolean - +

    true if the user is a webhook; otherwise false.

    + @@ -376,7 +391,8 @@

    Mention

    -
    +

    Returns a special string used to mention this object.

    +
    Declaration
    @@ -393,7 +409,8 @@ System.String - +

    A string that is recognized by Discord as a mention (e.g. <@168693960628371456>).

    + @@ -437,7 +454,8 @@

    Status

    -
    +

    Gets the current status of this user.

    +
    Declaration
    @@ -467,7 +485,8 @@

    Username

    -
    +

    Gets the username for this user.

    +
    Declaration
    @@ -499,7 +518,8 @@

    GetAvatarUrl(ImageFormat, UInt16)

    -
    +

    Gets the avatar URL for this user.

    +
    Declaration
    @@ -518,12 +538,14 @@ ImageFormat format - +

    The format to return.

    + System.UInt16 size - +

    The size of the image to return in. This can be any power of two between 16 and 2048.

    + @@ -538,10 +560,17 @@ System.String - +

    A string representing the user's avatar URL; null if the user does not have an avatar in place.

    + +
    Remarks
    +

    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 null. If you wish to +retrieve the default avatar for this user, consider using GetDefaultAvatarUrl() (see +example).

    +
    | Improve this Doc @@ -551,7 +580,8 @@

    GetDefaultAvatarUrl()

    -
    +

    Gets the default avatar URL for this user.

    +
    Declaration
    @@ -568,10 +598,16 @@ System.String - +

    A string representing the user's avatar URL.

    + +
    Remarks
    +

    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 DiscriminatorValue (discriminator % 5).

    +
    | Improve this Doc @@ -581,7 +617,8 @@

    GetOrCreateDMChannelAsync(RequestOptions)

    -
    +

    Gets the direct message channel of this user, or create one if it does not already exist.

    +
    Declaration
    @@ -600,7 +637,8 @@ RequestOptions options - +

    The options to be used when sending the request.

    + @@ -615,10 +653,22 @@ System.Threading.Tasks.Task<IDMChannel> - +

    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.

    + +
    Remarks
    +

    This method is used to obtain or create a channel used to send a direct message.

    +
    warning

    + 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 +Discord.Net.HttpException with a 403 as its +Discord.Net.HttpException.HttpCode. There are currently no official workarounds by +Discord. +

    +
    | Improve this Doc diff --git a/docs/api/Discord.WebSocket.SocketUserMessage.html b/docs/api/Discord.WebSocket.SocketUserMessage.html index a236c78b0..2370e8990 100644 --- a/docs/api/Discord.WebSocket.SocketUserMessage.html +++ b/docs/api/Discord.WebSocket.SocketUserMessage.html @@ -207,7 +207,8 @@

    Attachments

    -
    +

    Returns all attachments included in this message.

    +
    Declaration
    @@ -224,7 +225,8 @@ System.Collections.Generic.IReadOnlyCollection<Attachment> - +

    Collection of attachments.

    + @@ -239,7 +241,8 @@

    EditedTimestamp

    -
    +

    Gets the time of this message's last edit.

    +
    Declaration
    @@ -256,7 +259,8 @@ System.Nullable<System.DateTimeOffset> - +

    Time of when the message was last edited; null if the message is never edited.

    + @@ -271,7 +275,8 @@

    Embeds

    -
    +

    Returns all embeds included in this message.

    +
    Declaration
    @@ -288,7 +293,8 @@ System.Collections.Generic.IReadOnlyCollection<Embed> - +

    Collection of embed objects.

    + @@ -303,7 +309,8 @@

    IsPinned

    -
    +

    Gets the value that indicates whether this message is pinned.

    +
    Declaration
    @@ -320,7 +327,8 @@ System.Boolean - +

    true if this message was added to its channel's pinned messages; otherwise false.

    + @@ -335,7 +343,8 @@

    IsSuppressed

    -
    +

    Gets the value that indicates whether or not this message's embeds are suppressed.

    +
    Declaration
    @@ -352,7 +361,8 @@ System.Boolean - +

    true if the embeds in this message have been suppressed (made invisible); otherwise false.

    + @@ -367,7 +377,8 @@

    IsTTS

    -
    +

    Gets the value that indicates whether this message was meant to be read-aloud by Discord.

    +
    Declaration
    @@ -384,7 +395,8 @@ System.Boolean - +

    true if this message was sent as a text-to-speech message; otherwise false.

    + @@ -399,7 +411,8 @@

    MentionedChannels

    -
    +

    Returns the channels mentioned in this message.

    +
    Declaration
    @@ -416,7 +429,8 @@ System.Collections.Generic.IReadOnlyCollection<SocketGuildChannel> - +

    Collection of WebSocket-based guild channels.

    + @@ -431,7 +445,8 @@

    MentionedRoles

    -
    +

    Returns the roles mentioned in this message.

    +
    Declaration
    @@ -448,7 +463,8 @@ System.Collections.Generic.IReadOnlyCollection<SocketRole> - +

    Collection of WebSocket-based roles.

    + @@ -463,7 +479,8 @@

    MentionedUsers

    -
    +

    Returns the users mentioned in this message.

    +
    Declaration
    @@ -480,7 +497,8 @@ System.Collections.Generic.IReadOnlyCollection<SocketUser> - +

    Collection of WebSocket-based users.

    + @@ -495,7 +513,8 @@

    Tags

    -
    +

    Gets all tags included in this message's content.

    +
    Declaration
    @@ -529,7 +548,8 @@

    ModifyAsync(Action<MessageProperties>, RequestOptions)

    -
    +

    Modifies this message.

    +
    Declaration
    @@ -548,12 +568,14 @@ System.Action<MessageProperties> func - +

    A delegate containing the properties to modify the message with.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -568,10 +590,15 @@ System.Threading.Tasks.Task - +

    A task that represents the asynchronous modification operation.

    + +
    Remarks
    +

    This method modifies this message with the specified properties. To see an example of this +method and what properties are available, please refer to MessageProperties.

    +
    Exceptions
    @@ -602,7 +629,8 @@

    ModifySuppressionAsync(Boolean, RequestOptions)

    -
    +

    Modifies the suppression of this message.

    +
    Declaration
    @@ -621,12 +649,14 @@
    - + - +
    System.Boolean suppressEmbeds

    Whether or not embeds in this message should be suppressed.

    +
    RequestOptions options

    The options to be used when sending the request.

    +
    @@ -641,10 +671,14 @@ System.Threading.Tasks.Task - +

    A task that represents the asynchronous modification operation.

    + +
    Remarks
    +

    This method modifies whether or not embeds in this message are suppressed (hidden).

    +
    | Improve this Doc @@ -654,7 +688,8 @@

    PinAsync(RequestOptions)

    -
    +

    Adds this message to its channel's pinned messages.

    +
    Declaration
    @@ -673,7 +708,8 @@ RequestOptions options - +

    The options to be used when sending the request.

    + @@ -688,7 +724,8 @@ System.Threading.Tasks.Task - +

    A task that represents the asynchronous operation for pinning this message.

    + @@ -701,7 +738,8 @@

    Resolve(TagHandling, TagHandling, TagHandling, TagHandling, TagHandling)

    -
    +

    Transforms this message's text into a human-readable form by resolving its tags.

    +
    Declaration
    @@ -720,27 +758,32 @@ TagHandling userHandling - +

    Determines how the user tag should be handled.

    + TagHandling channelHandling - +

    Determines how the channel tag should be handled.

    + TagHandling roleHandling - +

    Determines how the role tag should be handled.

    + TagHandling everyoneHandling - +

    Determines how the @everyone tag should be handled.

    + TagHandling emojiHandling - +

    Determines how the emoji tag should be handled.

    + @@ -840,7 +883,8 @@

    UnpinAsync(RequestOptions)

    -
    +

    Removes this message from its channel's pinned messages.

    +
    Declaration
    @@ -859,7 +903,8 @@ RequestOptions options - +

    The options to be used when sending the request.

    + @@ -874,7 +919,8 @@ System.Threading.Tasks.Task - +

    A task that represents the asynchronous operation for unpinning this message.

    + diff --git a/docs/api/Discord.WebSocket.SocketVoiceChannel.html b/docs/api/Discord.WebSocket.SocketVoiceChannel.html index 8dee74ec8..647960c45 100644 --- a/docs/api/Discord.WebSocket.SocketVoiceChannel.html +++ b/docs/api/Discord.WebSocket.SocketVoiceChannel.html @@ -209,7 +209,8 @@

    Bitrate

    -
    +

    Gets the bit-rate that the clients in this voice channel are requested to use.

    +
    Declaration
    @@ -226,7 +227,9 @@ System.Int32 - +

    An System.Int32 representing the bit-rate (bps) that this voice channel defines and requests the +client(s) to use.

    + @@ -271,7 +274,8 @@

    CategoryId

    -
    +

    Gets the parent (category) ID of this channel in the guild's channel list.

    +
    Declaration
    @@ -288,7 +292,9 @@ System.Nullable<System.UInt64> - +

    A System.UInt64 representing the snowflake identifier of the parent of this channel; +null if none is set.

    + @@ -301,7 +307,8 @@

    UserLimit

    -
    +

    Gets the max number of users allowed to be connected to this channel at once.

    +
    Declaration
    @@ -318,7 +325,9 @@ System.Nullable<System.Int32> - +

    An System.Int32 representing the maximum number of users that are allowed to be connected to this +channel at once; null if a limit is not set.

    + @@ -331,7 +340,8 @@

    Users

    -
    +

    Gets a collection of users that are able to view the channel.

    +
    Declaration
    @@ -348,7 +358,8 @@ System.Collections.Generic.IReadOnlyCollection<SocketGuildUser> - +

    A read-only collection of users that can access the channel (i.e. the users seen in the user list).

    + @@ -365,7 +376,8 @@

    ConnectAsync(Boolean, Boolean, Boolean)

    -
    +

    Connects to this audio channel.

    +
    Declaration
    @@ -384,17 +396,20 @@ System.Boolean selfDeaf - +

    Determines whether the client should deaf itself upon connection.

    + System.Boolean selfMute - +

    Determines whether the client should mute itself upon connection.

    + System.Boolean external - +

    Determines whether the audio client is an external one or not.

    + @@ -409,7 +424,9 @@ System.Threading.Tasks.Task<IAudioClient> - +

    A task representing the asynchronous connection operation. The task result contains the +IAudioClient responsible for the connection.

    + @@ -422,7 +439,8 @@

    CreateInviteAsync(Nullable<Int32>, Nullable<Int32>, Boolean, Boolean, RequestOptions)

    -
    +

    Creates a new invite to this channel.

    +
    Declaration
    @@ -441,27 +459,32 @@ System.Nullable<System.Int32> maxAge - +

    The time (in seconds) until the invite expires. Set to null to never expire.

    + System.Nullable<System.Int32> maxUses - +

    The max amount of times this invite may be used. Set to null to have unlimited uses.

    + System.Boolean isTemporary - +

    If true, the user accepting this invite will be kicked from the guild after closing their client.

    + System.Boolean isUnique - +

    If true, don't try to reuse a similar invite (useful for creating many unique one time use invites).

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -476,7 +499,9 @@ System.Threading.Tasks.Task<IInviteMetadata> - +

    A task that represents the asynchronous invite creation operation. The task result contains an invite +metadata object containing information for the created invite.

    + @@ -489,7 +514,8 @@

    DisconnectAsync()

    -
    +

    Disconnects from this audio channel.

    +
    Declaration
    @@ -506,7 +532,8 @@ System.Threading.Tasks.Task - +

    A task representing the asynchronous operation for disconnecting from the audio channel.

    + @@ -519,7 +546,8 @@

    GetInvitesAsync(RequestOptions)

    -
    +

    Gets a collection of all invites to this channel.

    +
    Declaration
    @@ -538,7 +566,8 @@ RequestOptions options - +

    The options to be used when sending the request.

    + @@ -553,7 +582,9 @@ System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyCollection<IInviteMetadata>> - +

    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.

    + @@ -615,7 +646,8 @@

    ModifyAsync(Action<VoiceChannelProperties>, RequestOptions)

    -
    +

    Modifies this voice channel.

    +
    Declaration
    @@ -634,12 +666,14 @@ System.Action<VoiceChannelProperties> func - +

    The properties to modify the channel with.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -654,10 +688,15 @@ System.Threading.Tasks.Task - +

    A task that represents the asynchronous modification operation.

    + +
    See Also
    +
    + +
    | Improve this Doc @@ -667,7 +706,8 @@

    SyncPermissionsAsync(RequestOptions)

    -
    +

    Syncs the permissions of this nested channel with its parent's.

    +
    Declaration
    @@ -686,7 +726,8 @@ RequestOptions options - +

    The options to be used when sending the request.

    + @@ -701,7 +742,8 @@ System.Threading.Tasks.Task - +

    A task that represents the asynchronous operation for syncing channel permissions with its parent's.

    + @@ -716,7 +758,8 @@

    IGuildChannel.GetUserAsync(UInt64, CacheMode, RequestOptions)

    -
    +

    Gets a user in this channel.

    +
    Declaration
    @@ -735,17 +778,20 @@ System.UInt64 id - +

    The snowflake identifier of the user.

    + CacheMode mode - +

    The CacheMode that determines whether the object should be fetched from cache.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -760,7 +806,9 @@ System.Threading.Tasks.Task<IGuildUser> - +

    A task representing the asynchronous get operation. The task result contains a guild user object that +represents the user; null if none is found.

    + @@ -773,7 +821,8 @@

    INestedChannel.GetCategoryAsync(CacheMode, RequestOptions)

    -
    +

    Gets the parent (category) channel of this channel.

    +
    Declaration
    @@ -792,12 +841,14 @@ CacheMode mode - +

    The CacheMode that determines whether the object should be fetched from cache.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -812,7 +863,9 @@ System.Threading.Tasks.Task<ICategoryChannel> - +

    A task that represents the asynchronous get operation. The task result contains the category channel +representing the parent of this channel; null if none is set.

    + diff --git a/docs/api/Discord.WebSocket.SocketVoiceState.html b/docs/api/Discord.WebSocket.SocketVoiceState.html index 8de78781a..5171c9c9a 100644 --- a/docs/api/Discord.WebSocket.SocketVoiceState.html +++ b/docs/api/Discord.WebSocket.SocketVoiceState.html @@ -147,7 +147,8 @@

    IsDeafened

    -
    +

    Gets a value that indicates whether this user is deafened by the guild.

    +
    Declaration
    @@ -164,7 +165,9 @@ System.Boolean - +

    true if the user is deafened (i.e. not permitted to listen to or speak to others) by the guild; +otherwise false.

    + @@ -177,7 +180,9 @@

    IsMuted

    -
    +

    Gets a value that indicates whether this user is muted (i.e. not permitted to speak via voice) by the +guild.

    +
    Declaration
    @@ -194,7 +199,8 @@ System.Boolean - +

    true if this user is muted by the guild; otherwise false.

    + @@ -207,7 +213,8 @@

    IsSelfDeafened

    -
    +

    Gets a value that indicates whether this user has marked themselves as deafened.

    +
    Declaration
    @@ -224,7 +231,8 @@ System.Boolean - +

    true if this user has deafened themselves (i.e. not permitted to listen to or speak to others); otherwise false.

    + @@ -237,7 +245,9 @@

    IsSelfMuted

    -
    +

    Gets a value that indicates whether this user has marked themselves as muted (i.e. not permitted to +speak via voice).

    +
    Declaration
    @@ -254,7 +264,8 @@ System.Boolean - +

    true if this user has muted themselves; otherwise false.

    + @@ -267,7 +278,8 @@

    IsStreaming

    -
    +

    Gets a value that indicates if this user is streaming in a voice channel.

    +
    Declaration
    @@ -284,7 +296,8 @@ System.Boolean - +

    true if the user is streaming; otherwise false.

    + @@ -297,7 +310,8 @@

    IsSuppressed

    -
    +

    Gets a value that indicates whether the user is muted by the current user.

    +
    Declaration
    @@ -314,7 +328,8 @@ System.Boolean - +

    true if the guild is temporarily blocking audio to/from this user; otherwise false.

    + @@ -358,7 +373,8 @@

    VoiceSessionId

    -
    +

    Gets the unique identifier for this user's voice session.

    +
    Declaration
    @@ -426,7 +442,8 @@

    IVoiceState.VoiceChannel

    -
    +

    Gets the voice channel this user is currently in.

    +
    Declaration
    @@ -443,7 +460,9 @@ IVoiceChannel - +

    A generic voice channel object representing the voice channel that the user is currently in; null +if none.

    + diff --git a/docs/api/Discord.WebSocket.SocketWebhookUser.html b/docs/api/Discord.WebSocket.SocketWebhookUser.html index 865fb8076..8a0c9efdc 100644 --- a/docs/api/Discord.WebSocket.SocketWebhookUser.html +++ b/docs/api/Discord.WebSocket.SocketWebhookUser.html @@ -168,7 +168,8 @@

    AvatarId

    -
    +

    Gets the identifier of this user's avatar.

    +
    Declaration
    @@ -200,7 +201,8 @@

    DiscriminatorValue

    -
    +

    Gets the per-username unique ID for this user.

    +
    Declaration
    @@ -263,7 +265,8 @@

    IsBot

    -
    +

    Gets a value that indicates whether this user is identified as a bot.

    +
    Declaration
    @@ -280,12 +283,17 @@ System.Boolean - +

    true if the user is a bot application; otherwise false.

    +
    Overrides
    +
    Remarks
    +

    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).

    +
    | Improve this Doc @@ -295,7 +303,8 @@

    IsWebhook

    -
    +

    Gets a value that indicates whether this user is a webhook user.

    +
    Declaration
    @@ -312,7 +321,8 @@ System.Boolean - +

    true if the user is a webhook; otherwise false.

    + @@ -327,7 +337,8 @@

    Username

    -
    +

    Gets the username for this user.

    +
    Declaration
    @@ -359,7 +370,8 @@

    WebhookId

    -
    +

    Gets the ID of a webhook.

    +
    Declaration
    @@ -391,7 +403,8 @@

    IGuildUser.AddRoleAsync(IRole, RequestOptions)

    -
    +

    Adds the specified role to this user in the guild.

    +
    Declaration
    @@ -410,12 +423,14 @@ IRole role - +

    The role to be added to the user.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -430,7 +445,8 @@ System.Threading.Tasks.Task - +

    A task that represents the asynchronous role addition operation.

    + @@ -459,7 +475,8 @@

    IGuildUser.AddRolesAsync(IEnumerable<IRole>, RequestOptions)

    -
    +

    Adds the specified roles to this user in the guild.

    +
    Declaration
    @@ -478,12 +495,14 @@ System.Collections.Generic.IEnumerable<IRole> roles - +

    The roles to be added to the user.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -498,7 +517,8 @@ System.Threading.Tasks.Task - +

    A task that represents the asynchronous role addition operation.

    + @@ -527,7 +547,8 @@

    IGuildUser.GetPermissions(IGuildChannel)

    -
    +

    Gets the level permissions granted to this user to a given channel.

    +
    Declaration
    @@ -546,7 +567,8 @@ IGuildChannel channel - +

    The channel to get the permission from.

    + @@ -561,7 +583,9 @@ ChannelPermissions - +

    A ChannelPermissions structure representing the permissions that a user has in the +specified channel.

    + @@ -574,7 +598,8 @@

    IGuildUser.Guild

    -
    +

    Gets the guild for this user.

    +
    Declaration
    @@ -591,7 +616,8 @@ IGuild - +

    A guild object that this user belongs to.

    + @@ -604,7 +630,8 @@

    IGuildUser.GuildId

    -
    +

    Gets the ID of the guild for this user.

    +
    Declaration
    @@ -621,7 +648,8 @@ System.UInt64 - +

    An System.UInt64 representing the snowflake identifier of the guild that this user belongs to.

    + @@ -634,7 +662,8 @@

    IGuildUser.GuildPermissions

    -
    +

    Gets the guild-level permissions for this user.

    +
    Declaration
    @@ -651,7 +680,9 @@ GuildPermissions - +

    A GuildPermissions structure for this user, representing what +permissions this user has in the guild.

    + @@ -664,7 +695,8 @@

    IGuildUser.JoinedAt

    -
    +

    Gets when this user joined the guild.

    +
    Declaration
    @@ -681,7 +713,9 @@ System.Nullable<System.DateTimeOffset> - +

    A System.DateTimeOffset representing the time of which the user has joined the guild; +null when it cannot be obtained.

    + @@ -694,7 +728,8 @@

    IGuildUser.KickAsync(String, RequestOptions)

    -
    +

    Kicks this user from this guild.

    +
    Declaration
    @@ -713,12 +748,14 @@ System.String reason - +

    The reason for the kick which will be recorded in the audit log.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -733,7 +770,8 @@ System.Threading.Tasks.Task - +

    A task that represents the asynchronous kick operation.

    + @@ -762,7 +800,8 @@

    IGuildUser.ModifyAsync(Action<GuildUserProperties>, RequestOptions)

    -
    +

    Modifies this user's properties in this guild.

    +
    Declaration
    @@ -781,12 +820,14 @@ System.Action<GuildUserProperties> func - +

    The delegate containing the properties to modify the user with.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -801,10 +842,15 @@ System.Threading.Tasks.Task - +

    A task that represents the asynchronous modification operation.

    + +
    Remarks
    +

    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 GuildUserProperties.

    +
    Exceptions
    @@ -830,7 +876,8 @@

    IGuildUser.Nickname

    -
    +

    Gets the nickname for this user.

    +
    Declaration
    @@ -847,7 +894,8 @@
    - +
    System.String

    A string representing the nickname of the user; null if none is set.

    +
    @@ -860,7 +908,8 @@

    IGuildUser.PremiumSince

    -
    +

    Gets the date and time for when this user's guild boost began.

    +
    Declaration
    @@ -877,7 +926,8 @@ System.Nullable<System.DateTimeOffset> - +

    A System.DateTimeOffset for when the user began boosting this guild; null if they are not boosting the guild.

    + @@ -890,7 +940,8 @@

    IGuildUser.RemoveRoleAsync(IRole, RequestOptions)

    -
    +

    Removes the specified role from this user in the guild.

    +
    Declaration
    @@ -909,12 +960,14 @@ IRole role - +

    The role to be removed from the user.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -929,7 +982,8 @@ System.Threading.Tasks.Task - +

    A task that represents the asynchronous role removal operation.

    + @@ -958,7 +1012,8 @@

    IGuildUser.RemoveRolesAsync(IEnumerable<IRole>, RequestOptions)

    -
    +

    Removes the specified roles from this user in the guild.

    +
    Declaration
    @@ -977,12 +1032,14 @@ System.Collections.Generic.IEnumerable<IRole> roles - +

    The roles to be removed from the user.

    + RequestOptions options - +

    The options to be used when sending the request.

    + @@ -997,7 +1054,8 @@ System.Threading.Tasks.Task - +

    A task that represents the asynchronous role removal operation.

    + @@ -1026,7 +1084,8 @@

    IGuildUser.RoleIds

    -
    +

    Gets a collection of IDs for the roles that this user currently possesses in the guild.

    +
    Declaration
    @@ -1043,10 +1102,17 @@ System.Collections.Generic.IReadOnlyCollection<System.UInt64> - +

    A read-only collection of System.UInt64, each representing a snowflake identifier for a role that +this user possesses.

    + +
    Remarks
    +

    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.

    +
    | Improve this Doc @@ -1056,7 +1122,8 @@

    IVoiceState.IsDeafened

    -
    +

    Gets a value that indicates whether this user is deafened by the guild.

    +
    Declaration
    @@ -1073,7 +1140,9 @@ System.Boolean - +

    true if the user is deafened (i.e. not permitted to listen to or speak to others) by the guild; +otherwise false.

    + @@ -1086,7 +1155,9 @@

    IVoiceState.IsMuted

    -
    +

    Gets a value that indicates whether this user is muted (i.e. not permitted to speak via voice) by the +guild.

    +
    Declaration
    @@ -1103,7 +1174,8 @@ System.Boolean - +

    true if this user is muted by the guild; otherwise false.

    + @@ -1116,7 +1188,8 @@

    IVoiceState.IsSelfDeafened

    -
    +

    Gets a value that indicates whether this user has marked themselves as deafened.

    +
    Declaration
    @@ -1133,7 +1206,8 @@ System.Boolean - +

    true if this user has deafened themselves (i.e. not permitted to listen to or speak to others); otherwise false.

    + @@ -1146,7 +1220,9 @@

    IVoiceState.IsSelfMuted

    -
    +

    Gets a value that indicates whether this user has marked themselves as muted (i.e. not permitted to +speak via voice).

    +
    Declaration
    @@ -1163,7 +1239,8 @@ System.Boolean - +

    true if this user has muted themselves; otherwise false.

    + @@ -1176,7 +1253,8 @@

    IVoiceState.IsStreaming

    -
    +

    Gets a value that indicates if this user is streaming in a voice channel.

    +
    Declaration
    @@ -1193,7 +1271,8 @@ System.Boolean - +

    true if the user is streaming; otherwise false.

    + @@ -1206,7 +1285,8 @@

    IVoiceState.IsSuppressed

    -
    +

    Gets a value that indicates whether the user is muted by the current user.

    +
    Declaration
    @@ -1223,7 +1303,8 @@ System.Boolean - +

    true if the guild is temporarily blocking audio to/from this user; otherwise false.

    + @@ -1236,7 +1317,8 @@

    IVoiceState.VoiceChannel

    -
    +

    Gets the voice channel this user is currently in.

    +
    Declaration
    @@ -1253,7 +1335,9 @@ IVoiceChannel - +

    A generic voice channel object representing the voice channel that the user is currently in; null +if none.

    + @@ -1266,7 +1350,8 @@

    IVoiceState.VoiceSessionId

    -
    +

    Gets the unique identifier for this user's voice session.

    +
    Declaration
    diff --git a/docs/api/Discord.html b/docs/api/Discord.html index 50ad9a3e1..0fa789fa4 100644 --- a/docs/api/Discord.html +++ b/docs/api/Discord.html @@ -84,7 +84,8 @@

    An extension class for squashing System.Collections.Generic.IAsyncEnumerable<T>.

    Attachment

    -
    +

    Represents a message attachment found in a IUserMessage.

    +

    AttachmentExtensions

    CDN

    diff --git a/docs/api/ImGuiNET.RangeAccessor-1.html b/docs/api/ImGuiNET.RangeAccessor-1.html index f38c70165..3bad91f9c 100644 --- a/docs/api/ImGuiNET.RangeAccessor-1.html +++ b/docs/api/ImGuiNET.RangeAccessor-1.html @@ -101,7 +101,6 @@
    Syntax
    public struct RangeAccessor<T>
-
     where T : struct
    Type Parameters
    diff --git a/docs/api/ImGuiNET.RangePtrAccessor-1.html b/docs/api/ImGuiNET.RangePtrAccessor-1.html index 99645455e..bfcac7e52 100644 --- a/docs/api/ImGuiNET.RangePtrAccessor-1.html +++ b/docs/api/ImGuiNET.RangePtrAccessor-1.html @@ -101,7 +101,6 @@
    Syntax
    public struct RangePtrAccessor<T>
-
     where T : struct
    Type Parameters
    diff --git a/docs/api/toc.html b/docs/api/toc.html index 2ab6497cd..a91fd30f8 100644 --- a/docs/api/toc.html +++ b/docs/api/toc.html @@ -175,6 +175,12 @@
  • ClientState
    • +
  • + Condition +
    • +
  • + ConditionFlag +
  • JobGauges
    • diff --git a/docs/manifest.json b/docs/manifest.json index 021847bcf..ba7d3ebd8 100644 --- a/docs/manifest.json +++ b/docs/manifest.json @@ -1,6 +1,6 @@ { "homepages": [], - "source_base_path": "", + "source_base_path": "C:/Users/jonas/Documents/repos/Dalamud", "xrefmap": "xrefmap.yml", "files": [ { @@ -489,7 +489,7 @@ "output": { ".html": { "relative_path": "api/Dalamud.Game.ClientState.Actors.ActorTable.html", - "hash": "1wHmo4hokQcmfbAJQaTk5Q==" + "hash": "upcYL0k6SAwcy6HHwT2TFQ==" } }, "is_incremental": false, @@ -585,7 +585,7 @@ "output": { ".html": { "relative_path": "api/Dalamud.Game.ClientState.Actors.Types.Actor.html", - "hash": "VtuCC3wwIzuak9mzonsLkQ==" + "hash": "P+/E6KdNn5nMekDC5wcIQA==" } }, "is_incremental": false, @@ -597,7 +597,7 @@ "output": { ".html": { "relative_path": "api/Dalamud.Game.ClientState.Actors.Types.Chara.html", - "hash": "IDy9j1MLGbuMPXY8mh6ntw==" + "hash": "McKyUH4S/+aPVSgfhsY1CA==" } }, "is_incremental": false, @@ -609,7 +609,7 @@ "output": { ".html": { "relative_path": "api/Dalamud.Game.ClientState.Actors.Types.NonPlayer.BattleNpc.html", - "hash": "qLHLHJUys4jQHeZZDHPshA==" + "hash": "IgL4MUqQ80/o420uRKt1yQ==" } }, "is_incremental": false, @@ -633,7 +633,7 @@ "output": { ".html": { "relative_path": "api/Dalamud.Game.ClientState.Actors.Types.NonPlayer.Npc.html", - "hash": "RQD616Px0nkntQMzrcCctw==" + "hash": "4app0CmAqb0Hyst8QTxgHQ==" } }, "is_incremental": false, @@ -669,7 +669,7 @@ "output": { ".html": { "relative_path": "api/Dalamud.Game.ClientState.Actors.Types.PlayerCharacter.html", - "hash": "LbdvyetpPRpiQJl+zI035w==" + "hash": "f7OCFIHiaX3bOFFTHFn2Kw==" } }, "is_incremental": false, @@ -705,7 +705,31 @@ "output": { ".html": { "relative_path": "api/Dalamud.Game.ClientState.ClientState.html", - "hash": "jXRXK53yx5saFaRgkXSzfg==" + "hash": "lhPN7BzW4/KEWw5ic0aRLA==" + } + }, + "is_incremental": false, + "version": "" + }, + { + "type": "ManagedReference", + "source_relative_path": "api/Dalamud.Game.ClientState.Condition.yml", + "output": { + ".html": { + "relative_path": "api/Dalamud.Game.ClientState.Condition.html", + "hash": "yl4aDcqAkfn28FTqCtTQ/A==" + } + }, + "is_incremental": false, + "version": "" + }, + { + "type": "ManagedReference", + "source_relative_path": "api/Dalamud.Game.ClientState.ConditionFlag.yml", + "output": { + ".html": { + "relative_path": "api/Dalamud.Game.ClientState.ConditionFlag.html", + "hash": "bCwiKCJ/Xo6MnIilputc2A==" } }, "is_incremental": false, @@ -741,7 +765,7 @@ "output": { ".html": { "relative_path": "api/Dalamud.Game.ClientState.PartyList.html", - "hash": "6tL6k5KouR0X5JXycZMgnQ==" + "hash": "1mUOijSe8dv4x7KxJ8ZDcg==" } }, "is_incremental": false, @@ -753,7 +777,7 @@ "output": { ".html": { "relative_path": "api/Dalamud.Game.ClientState.Structs.Actor.html", - "hash": "VNGYlaaO9lW/A57XNbdjkg==" + "hash": "33gBEZ87feFUN3MbC0RlAA==" } }, "is_incremental": false, @@ -1125,7 +1149,7 @@ "output": { ".html": { "relative_path": "api/Dalamud.Game.ClientState.html", - "hash": "wPIegEM1wqG0gQnt+461QA==" + "hash": "ghwM1QLzWli7WBdSZBRxiQ==" } }, "is_incremental": false, @@ -1305,7 +1329,7 @@ "output": { ".html": { "relative_path": "api/Dalamud.Game.Internal.Gui.ChatGui.html", - "hash": "zrmt5RzIL5hYIs8AgO4fyg==" + "hash": "rhbx1Q5br2k+1lUEMYbqjw==" } }, "is_incremental": false, @@ -1593,7 +1617,7 @@ "output": { ".html": { "relative_path": "api/Dalamud.Game.SigScanner.html", - "hash": "Vl4sEXBOMPZ9fHg9wn+3mw==" + "hash": "B4ZvgYuCpaLIXmAtxnD56g==" } }, "is_incremental": false, @@ -1653,7 +1677,7 @@ "output": { ".html": { "relative_path": "api/Dalamud.Interface.MySinkExtensions.html", - "hash": "6CD6y0K9dDmYgJX5Z6A/sQ==" + "hash": "+LoU0CMtgyu9wbknLiKdtw==" } }, "is_incremental": false, @@ -1665,7 +1689,7 @@ "output": { ".html": { "relative_path": "api/Dalamud.Interface.SerilogEventSink.html", - "hash": "OR548wbEbLrskcVzRO0N4w==" + "hash": "AczZQD7hVDcVLTB+1pAKMQ==" } }, "is_incremental": false, @@ -1677,7 +1701,7 @@ "output": { ".html": { "relative_path": "api/Dalamud.Interface.UiBuilder.html", - "hash": "IwrausWlwAIZTIXiLrA6qQ==" + "hash": "ayRJt0bd/OIK5J+Zuv6ajg==" } }, "is_incremental": false, @@ -1788,7 +1812,7 @@ "hash": "Y1KVb7KI9HStMOy6/3RQpg==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -1800,7 +1824,7 @@ "hash": "5uNOiTG+Z+CjrkHiBdfezg==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -1812,7 +1836,7 @@ "hash": "eT9hMJrVlFBQMLFYJK0cHg==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -1824,7 +1848,7 @@ "hash": "j7ggk2fu0FYtckXnHe35zA==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -1848,7 +1872,7 @@ "hash": "4rK1Tt19zHr83jowXm81fA==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -1860,7 +1884,7 @@ "hash": "sxRrWQWD1yw6WBMUfoCW8Q==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -1884,7 +1908,7 @@ "hash": "ofgHiraVQDSdnioBEzzdMg==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -1893,7 +1917,7 @@ "output": { ".html": { "relative_path": "api/Discord.Attachment.html", - "hash": "xrOwXGij6XCmExqsbVhccQ==" + "hash": "LcM0SsJoXQk1QVaJvGzdzg==" } }, "is_incremental": false, @@ -1908,7 +1932,7 @@ "hash": "DXko/UAURnCoxS0FhuD5oA==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -1920,7 +1944,7 @@ "hash": "P4BZ7oTHkyAp3GG3PoWF6w==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -1980,7 +2004,7 @@ "hash": "XfRcCVxMcKMwTWlJgjSTLA==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -1992,7 +2016,7 @@ "hash": "QvGkOs0MDDbocRc/8VkrSg==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -2136,7 +2160,7 @@ "hash": "OYvEK/dcjcMdffZ/mD8dkw==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -2148,7 +2172,7 @@ "hash": "nV+qlGp/frQ5IuTH79W5iw==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -2157,7 +2181,7 @@ "output": { ".html": { "relative_path": "api/Discord.Cacheable-2.html", - "hash": "C/IMR3mygMghYgFp/HanOQ==" + "hash": "oRi9ycSfj2lRo0C+QoR+Ug==" } }, "is_incremental": false, @@ -2172,7 +2196,7 @@ "hash": "JCqlWQGKGystHBHnSyeYcg==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -2196,7 +2220,7 @@ "hash": "cv2kPhUmterY+MQxmNUXUA==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -2208,7 +2232,7 @@ "hash": "orrspc0BAkw7r2eTHzsaDA==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -2220,7 +2244,7 @@ "hash": "aqjlpRHCsI41y0PLPEeZMQ==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -2241,7 +2265,7 @@ "output": { ".html": { "relative_path": "api/Discord.Commands.ShardedCommandContext.html", - "hash": "Vln42ftRUk1n77/1CxnhFg==" + "hash": "NIltP1hlxk9NTSJSDYRhag==" } }, "is_incremental": false, @@ -2253,7 +2277,7 @@ "output": { ".html": { "relative_path": "api/Discord.Commands.SocketCommandContext.html", - "hash": "Fc7+8Z6n4Uhh5U6if0sflQ==" + "hash": "aMshjl7JkOF3ZDVY0wlZRg==" } }, "is_incremental": false, @@ -2280,7 +2304,7 @@ "hash": "+ayMHwU9oX7BBy1km5tlqg==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -2304,7 +2328,7 @@ "hash": "QPo87haaF5ZMi3pZV4EoJw==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -2340,7 +2364,7 @@ "hash": "+S1QsSo4/nHLY5r0XJl14Q==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -2361,7 +2385,7 @@ "output": { ".html": { "relative_path": "api/Discord.Embed.html", - "hash": "tThxpB91iq6N3aZ0lLCtqw==" + "hash": "YFoks4X9MmGbWLpIuNAskg==" } }, "is_incremental": false, @@ -2388,7 +2412,7 @@ "hash": "WmNnxxpRNjeFbOCwVWzr8A==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -2436,7 +2460,7 @@ "hash": "lLT3+nNchh91JqVLQCi3oA==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -2460,7 +2484,7 @@ "hash": "zg5ZWgbr8tra3PBGUx1Clw==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -2508,7 +2532,7 @@ "hash": "0eC5YQhs4Eo++7gaM9I1vQ==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -2529,7 +2553,7 @@ "output": { ".html": { "relative_path": "api/Discord.Emoji.html", - "hash": "eP1ub9YqxZ8SOLqtOjT9gA==" + "hash": "rGbSXbZacRWYCS65Q1QN9A==" } }, "is_incremental": false, @@ -2541,7 +2565,7 @@ "output": { ".html": { "relative_path": "api/Discord.Emote.html", - "hash": "qXP4pCHQa5CDRla0Q8tmdg==" + "hash": "/aaMQeHGe15BB3G27brh3g==" } }, "is_incremental": false, @@ -2568,7 +2592,7 @@ "hash": "KJaO/qTL3V4MCzsJe0ZNSw==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -2580,7 +2604,7 @@ "hash": "+5vljyoZmGH7AOeBHsN8nA==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -2589,7 +2613,7 @@ "output": { ".html": { "relative_path": "api/Discord.Game.html", - "hash": "DSqdbXRnvAnO/M6sTq3Oqw==" + "hash": "VjqwYt7h2/0l0oVJOXSdwA==" } }, "is_incremental": false, @@ -2700,7 +2724,7 @@ "hash": "O87DIRyaiiUHa+XUJkJuNw==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -2712,7 +2736,7 @@ "hash": "GoVeq8NUPJ7BWvaMO/GKAQ==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -2724,7 +2748,7 @@ "hash": "Nf8pIImvsv06jouL+IbWWA==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -2868,7 +2892,7 @@ "hash": "5DrozzP2EQesZ4/yA3LSrg==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -2892,7 +2916,7 @@ "hash": "RwGelkmRQZfMsjeZj/z3/w==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -2916,7 +2940,7 @@ "hash": "U8p6+02Z3j1BWY1DVe8Djg==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -2928,7 +2952,7 @@ "hash": "o78A043bGl7hBOMEO3LWyg==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -2937,7 +2961,7 @@ "output": { ".html": { "relative_path": "api/Discord.IEntity-1.html", - "hash": "DOPLoaU8+Vb3UJ4DlmhBog==" + "hash": "e0os1oIA/gBe6nl5Frb6qw==" } }, "is_incremental": false, @@ -3048,7 +3072,7 @@ "hash": "g1WG527fFphOEpoYkIc6ew==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -3096,7 +3120,7 @@ "hash": "iyNgIcBrTxj9gdUq5mhtwg==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -3120,7 +3144,7 @@ "hash": "e5kHUYOEyUOsbQ7KMD6XJg==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -3180,7 +3204,7 @@ "hash": "vNfca0CRUss+SqveR6O8WQ==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -3204,7 +3228,7 @@ "hash": "EVg0w3Ew62i+zT08eFPUJA==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -3264,7 +3288,7 @@ "hash": "VTJDZgI8ETnOHCez1W3KzQ==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -3324,7 +3348,7 @@ "hash": "mw+jeEXWMZS2cBt3jY/BWw==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -3336,7 +3360,7 @@ "hash": "07a5fyEAcwPMOOuB3OgTrA==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -3348,7 +3372,7 @@ "hash": "xzLYMkUuWmodggwZFvKSbg==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -3360,7 +3384,7 @@ "hash": "W+QyoRF4xTYd6d0rjRYoog==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -3372,7 +3396,7 @@ "hash": "9T9Ic+TWtnJp2LmG3UWyJA==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -3384,7 +3408,7 @@ "hash": "D7/24hrJRWH9dMTvQb/DgA==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -3396,7 +3420,7 @@ "hash": "iYNwmCnS7iVJbv/PlNKbNA==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -3408,7 +3432,7 @@ "hash": "NwgWDj/1SWUA/cIyazphoQ==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -3420,7 +3444,7 @@ "hash": "6RMWLvNPdc6hpKuayvoRDw==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -3456,7 +3480,7 @@ "hash": "htmW/Gvv0gwI8psH3JquoQ==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -3468,7 +3492,7 @@ "hash": "iibTnOVX3HEZwoOC27pYzw==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -3480,7 +3504,7 @@ "hash": "cpBUi8TxzfNHx6XF0PTmcw==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -3492,7 +3516,7 @@ "hash": "mWh27C4Dw6dl//LHGyFLpA==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -3504,7 +3528,7 @@ "hash": "XK8Pfr//Hv/Oj1yYkdcC1g==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -3513,7 +3537,7 @@ "output": { ".html": { "relative_path": "api/Discord.Optional.html", - "hash": "JYkiRtPvdvEZAMWV2YNZQg==" + "hash": "IyuqGAoJt7A16rHnt8iarw==" } }, "is_incremental": false, @@ -3528,7 +3552,7 @@ "hash": "fGtMJmTb2WSlUw3aF/gMMw==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -3552,7 +3576,7 @@ "hash": "1LjC4/qZgtALpobuPPlMMA==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -3564,7 +3588,7 @@ "hash": "p5Yh8Z4jsQx6UQV3yjme6w==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -3576,7 +3600,7 @@ "hash": "4NrGnr4fE3wOor0721yYLg==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -3588,7 +3612,7 @@ "hash": "pSXjTXa0qmWBGp8doBPdlg==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -3600,7 +3624,7 @@ "hash": "cnkfKy75zIDNd+UIYdJVfg==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -3612,7 +3636,7 @@ "hash": "T3FBCSQoWTEGur7Ddv8mqg==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -3648,7 +3672,7 @@ "hash": "6QLkXUYFXyLyliaqX606Cw==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -3669,7 +3693,7 @@ "output": { ".html": { "relative_path": "api/Discord.Rest.BaseDiscordClient.html", - "hash": "PuR8g6cYfFUdSfo64Vi5xQ==" + "hash": "/+Lj8iirVZ5Klo2MeHX4VA==" } }, "is_incremental": false, @@ -3708,7 +3732,7 @@ "hash": "oRTIH2aoOiFEO3IPGlPLcg==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -3741,7 +3765,7 @@ "output": { ".html": { "relative_path": "api/Discord.Rest.DiscordRestClient.html", - "hash": "xdoie+mGfXnYJSPfuCuuzg==" + "hash": "HfFYB6rvIb2mSL0TQfma6Q==" } }, "is_incremental": false, @@ -3888,7 +3912,7 @@ "hash": "mPZ0lLHqx14X35im4/m90w==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -3924,7 +3948,7 @@ "hash": "+8gfBVs5/Ddv6i+rsyXZ7Q==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -3948,7 +3972,7 @@ "hash": "1G0gUOMM+lV2PB16XyJrrw==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -4029,7 +4053,7 @@ "output": { ".html": { "relative_path": "api/Discord.Rest.RestApplication.html", - "hash": "b7EII7ioJk6AqpUJ4XDvpQ==" + "hash": "mB+Qns36fGAmdEgV8YvjtQ==" } }, "is_incremental": false, @@ -4041,7 +4065,7 @@ "output": { ".html": { "relative_path": "api/Discord.Rest.RestAuditLogEntry.html", - "hash": "cYaYToOi+a5DQjFETueJkw==" + "hash": "l7TNJe8mwM8aDVn0eu6nfg==" } }, "is_incremental": false, @@ -4053,7 +4077,7 @@ "output": { ".html": { "relative_path": "api/Discord.Rest.RestBan.html", - "hash": "g8MVksgc5hY9gLO6hdRCVA==" + "hash": "feDT0ij00XDa8Y/vNyoccA==" } }, "is_incremental": false, @@ -4065,7 +4089,7 @@ "output": { ".html": { "relative_path": "api/Discord.Rest.RestCategoryChannel.html", - "hash": "zrgzv8rTytxURgWxhi/ojA==" + "hash": "Vjm9+wLZUkMzMg3K30gpuw==" } }, "is_incremental": false, @@ -4077,7 +4101,7 @@ "output": { ".html": { "relative_path": "api/Discord.Rest.RestChannel.html", - "hash": "Y57Dj7sV8MOHB9YbODAwXQ==" + "hash": "RT0KFN3lj9TEIqXZyF9aGQ==" } }, "is_incremental": false, @@ -4089,7 +4113,7 @@ "output": { ".html": { "relative_path": "api/Discord.Rest.RestConnection.html", - "hash": "nU9AoAXrR/BT5I/iCCQOKg==" + "hash": "O51nYMAiYBDSr3ZCi9PwOg==" } }, "is_incremental": false, @@ -4101,7 +4125,7 @@ "output": { ".html": { "relative_path": "api/Discord.Rest.RestDMChannel.html", - "hash": "RytGZs0Y7wM1bY34agAogA==" + "hash": "bA8Kn6fsGL2x25zBapZdcQ==" } }, "is_incremental": false, @@ -4125,7 +4149,7 @@ "output": { ".html": { "relative_path": "api/Discord.Rest.RestGroupChannel.html", - "hash": "9x7NOBqixlKUBTniNc0fCg==" + "hash": "74UUl1JY0wrMdVi4jjmvVQ==" } }, "is_incremental": false, @@ -4137,7 +4161,7 @@ "output": { ".html": { "relative_path": "api/Discord.Rest.RestGroupUser.html", - "hash": "fjI2q4lWbJcXAZtf93tDaQ==" + "hash": "PD46t5pYpPHLIyD5dRH72w==" } }, "is_incremental": false, @@ -4149,7 +4173,7 @@ "output": { ".html": { "relative_path": "api/Discord.Rest.RestGuild.html", - "hash": "RdOZGz9x6pjNhCeBfrCf9A==" + "hash": "WRFLmvmqFvIvg7/QRxMIpw==" } }, "is_incremental": false, @@ -4161,7 +4185,7 @@ "output": { ".html": { "relative_path": "api/Discord.Rest.RestGuildChannel.html", - "hash": "iH8Tkp3u/WyjUsT3PHnG5Q==" + "hash": "VcwzpqwmC0YS8F7MzCdXXA==" } }, "is_incremental": false, @@ -4176,7 +4200,7 @@ "hash": "b224zDWUdn/ryLnyFdCjLw==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -4185,7 +4209,7 @@ "output": { ".html": { "relative_path": "api/Discord.Rest.RestGuildIntegration.html", - "hash": "eTEgjYFv8PGVdAI9rze6iA==" + "hash": "cbfT2ImdoA9KMA61ZJMEvw==" } }, "is_incremental": false, @@ -4197,7 +4221,7 @@ "output": { ".html": { "relative_path": "api/Discord.Rest.RestGuildUser.html", - "hash": "SD74AmqQYOOv7YJY/glPPg==" + "hash": "Hf1X5uBYv4GtHDrXWek/xg==" } }, "is_incremental": false, @@ -4209,7 +4233,7 @@ "output": { ".html": { "relative_path": "api/Discord.Rest.RestInvite.html", - "hash": "XqGYHiZzjVsZOj88VGJRdA==" + "hash": "4hZ3XlTLZlaZ3z4ilAZIng==" } }, "is_incremental": false, @@ -4221,7 +4245,7 @@ "output": { ".html": { "relative_path": "api/Discord.Rest.RestInviteMetadata.html", - "hash": "qaJgQUYUdGuEMAco1rGfMA==" + "hash": "jsVzHaDLKcJPmvZnS1yASQ==" } }, "is_incremental": false, @@ -4233,7 +4257,7 @@ "output": { ".html": { "relative_path": "api/Discord.Rest.RestMessage.html", - "hash": "YJjGqEdznb/AqLqaIu8OKg==" + "hash": "vbTnklC4R/pcypCzI8ypFw==" } }, "is_incremental": false, @@ -4257,7 +4281,7 @@ "output": { ".html": { "relative_path": "api/Discord.Rest.RestReaction.html", - "hash": "a4Flkb32fg5vDB7ZIbbj4A==" + "hash": "3FtdjGwFysL50lTgd0s6Zg==" } }, "is_incremental": false, @@ -4269,7 +4293,7 @@ "output": { ".html": { "relative_path": "api/Discord.Rest.RestRole.html", - "hash": "Xjs+agkElhi1v93xLPZbAw==" + "hash": "f34KdqeRvl4SZCgYVTgkOQ==" } }, "is_incremental": false, @@ -4281,7 +4305,7 @@ "output": { ".html": { "relative_path": "api/Discord.Rest.RestSelfUser.html", - "hash": "gqD2DkvtJ2HTqnLJTnbyXg==" + "hash": "dPCQzma4oS6ukE6qPOTG8w==" } }, "is_incremental": false, @@ -4293,7 +4317,7 @@ "output": { ".html": { "relative_path": "api/Discord.Rest.RestSystemMessage.html", - "hash": "EjhULJNCEkWsMVocHa9pNw==" + "hash": "ZEzAbNf6ep+yGPD4W/ogLQ==" } }, "is_incremental": false, @@ -4305,7 +4329,7 @@ "output": { ".html": { "relative_path": "api/Discord.Rest.RestTextChannel.html", - "hash": "LUcCwnF6moeySYBCnkDCLQ==" + "hash": "lZA7Eq0ecWlIeBS92GB/1Q==" } }, "is_incremental": false, @@ -4317,7 +4341,7 @@ "output": { ".html": { "relative_path": "api/Discord.Rest.RestUser.html", - "hash": "AoPPL2uBEwOgmkYNxX8x1Q==" + "hash": "qnATNFuL0VWS99M7jdoT7Q==" } }, "is_incremental": false, @@ -4329,7 +4353,7 @@ "output": { ".html": { "relative_path": "api/Discord.Rest.RestUserGuild.html", - "hash": "I0gwiqrTxTwA9ydL024cGg==" + "hash": "ujyxUj9gu9hlcwb3qv2qdw==" } }, "is_incremental": false, @@ -4341,7 +4365,7 @@ "output": { ".html": { "relative_path": "api/Discord.Rest.RestUserMessage.html", - "hash": "SEj6w+bPB2lrUYaWNtYPIw==" + "hash": "w1mcG5LzXzRbqnoajQKmWQ==" } }, "is_incremental": false, @@ -4353,7 +4377,7 @@ "output": { ".html": { "relative_path": "api/Discord.Rest.RestVoiceChannel.html", - "hash": "ZY0N1G0bqvUl9Z4NBZDeLA==" + "hash": "GZMDqY49Z/I/kJi+LCUHsA==" } }, "is_incremental": false, @@ -4365,7 +4389,7 @@ "output": { ".html": { "relative_path": "api/Discord.Rest.RestVoiceRegion.html", - "hash": "oMFBH4D/qQK7HOCxexWVGA==" + "hash": "WkkVVqg4Z+m+ivohoZehQA==" } }, "is_incremental": false, @@ -4377,7 +4401,7 @@ "output": { ".html": { "relative_path": "api/Discord.Rest.RestWebhook.html", - "hash": "2Aa6l9ZV2dl9ZBxMGHSFWw==" + "hash": "WrZYSriRopYOwt6B3Bd2wg==" } }, "is_incremental": false, @@ -4389,7 +4413,7 @@ "output": { ".html": { "relative_path": "api/Discord.Rest.RestWebhookUser.html", - "hash": "kxB4t6/sw7y+wwRJoWDOqQ==" + "hash": "Ui5nSBhyAviL5laGI1sg2g==" } }, "is_incremental": false, @@ -4428,7 +4452,7 @@ "hash": "ggBtab3L86MMD+smnHPEMA==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -4488,7 +4512,7 @@ "hash": "vQH6yybZNyUT9bUVn7g0Pw==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -4524,7 +4548,7 @@ "hash": "ADRqxIulETEd3nF0P4SezQ==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -4572,7 +4596,7 @@ "hash": "pRkMNZ5XnBbez6eGOLs7wg==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -4608,7 +4632,7 @@ "hash": "W9hXdT/TZUsDPzjoefLTHA==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -4644,7 +4668,7 @@ "hash": "5xKOpjGl46/U9OEcapgKfQ==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -4668,7 +4692,7 @@ "hash": "2Vzbm3kCB2l+mosuKgUpmg==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -4680,7 +4704,7 @@ "hash": "fdfp3w0zW2bbeLinQ8EoLg==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -4704,7 +4728,7 @@ "hash": "zpNzOek+44D+9PWz2o5Uww==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -4716,7 +4740,7 @@ "hash": "/mLka2rGUFGuKrHAiMQLFg==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -4728,7 +4752,7 @@ "hash": "r+vD1WhXI9llicAyx3ZUDA==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -4749,7 +4773,7 @@ "output": { ".html": { "relative_path": "api/Discord.WebSocket.BaseSocketClient.html", - "hash": "l788Bq23N+5S2z5xL1070w==" + "hash": "dU6QS/OZSapb93Ku1N12VA==" } }, "is_incremental": false, @@ -4761,7 +4785,7 @@ "output": { ".html": { "relative_path": "api/Discord.WebSocket.DiscordShardedClient.html", - "hash": "rT1ifdso1e+sNAUx11o/Bg==" + "hash": "dW/9kvmzGXubIK6aqLPyhQ==" } }, "is_incremental": false, @@ -4773,7 +4797,7 @@ "output": { ".html": { "relative_path": "api/Discord.WebSocket.DiscordSocketClient.html", - "hash": "ifm+C9PrQP/kphXzdAwCmw==" + "hash": "CXDLD2j/QABK4/9yi+zAfQ==" } }, "is_incremental": false, @@ -4845,7 +4869,7 @@ "output": { ".html": { "relative_path": "api/Discord.WebSocket.SocketCategoryChannel.html", - "hash": "us22AF2YO4i5Lw0MttZAEA==" + "hash": "7ogufBTymxnxgqC+CTbHWQ==" } }, "is_incremental": false, @@ -4857,7 +4881,7 @@ "output": { ".html": { "relative_path": "api/Discord.WebSocket.SocketChannel.html", - "hash": "+5j2TTs+0XIRDCJl8kFGZg==" + "hash": "Y+0V8ebZVRYztHWLX2We+A==" } }, "is_incremental": false, @@ -4869,7 +4893,7 @@ "output": { ".html": { "relative_path": "api/Discord.WebSocket.SocketDMChannel.html", - "hash": "P6lbLxEWKdYp0oKQQ22MTA==" + "hash": "k8tkAk7AwDeLj5iaj5tuZQ==" } }, "is_incremental": false, @@ -4893,7 +4917,7 @@ "output": { ".html": { "relative_path": "api/Discord.WebSocket.SocketGroupChannel.html", - "hash": "WpyEJIVo/mRignSxPJxuFw==" + "hash": "1rJTHBmRv4Tq4cmogZNjJQ==" } }, "is_incremental": false, @@ -4905,7 +4929,7 @@ "output": { ".html": { "relative_path": "api/Discord.WebSocket.SocketGroupUser.html", - "hash": "JfNaE73IBcVFEPAQcufJvA==" + "hash": "+bjc/1NQasf+UrESJ5OACA==" } }, "is_incremental": false, @@ -4917,7 +4941,7 @@ "output": { ".html": { "relative_path": "api/Discord.WebSocket.SocketGuild.html", - "hash": "wGBBRpyq+neH21IlBO+xwQ==" + "hash": "7Vqr95fg4gAn+tI8600cOA==" } }, "is_incremental": false, @@ -4929,7 +4953,7 @@ "output": { ".html": { "relative_path": "api/Discord.WebSocket.SocketGuildChannel.html", - "hash": "BO8P6TpOLgNDxACqc+0T+A==" + "hash": "EGeasL40bYHRs1Og+7J/QA==" } }, "is_incremental": false, @@ -4941,7 +4965,7 @@ "output": { ".html": { "relative_path": "api/Discord.WebSocket.SocketGuildUser.html", - "hash": "MFpmaQFcAiCdCG4VWa9Azw==" + "hash": "cVwkvv/yK5AGK15ALcuuWw==" } }, "is_incremental": false, @@ -4953,7 +4977,7 @@ "output": { ".html": { "relative_path": "api/Discord.WebSocket.SocketMessage.html", - "hash": "vJzqcSyJ4ssW2mwB6Ee0hg==" + "hash": "+YxVv9CTFpuclecYeWTZqA==" } }, "is_incremental": false, @@ -4965,7 +4989,7 @@ "output": { ".html": { "relative_path": "api/Discord.WebSocket.SocketNewsChannel.html", - "hash": "BlNLpy8iZZ0Yfn45qLjUiQ==" + "hash": "4siIK5I2tx9s78XOlm6UJQ==" } }, "is_incremental": false, @@ -4977,7 +5001,7 @@ "output": { ".html": { "relative_path": "api/Discord.WebSocket.SocketPresence.html", - "hash": "w/nWeMl9fgovkW0nOzWN0g==" + "hash": "H99ckDVEyaOH6LdGrW4emg==" } }, "is_incremental": false, @@ -4989,7 +5013,7 @@ "output": { ".html": { "relative_path": "api/Discord.WebSocket.SocketReaction.html", - "hash": "K7LtuQ0CrZrVSKwYCEf2vw==" + "hash": "uaecVDZs3ihMABPwfGroqA==" } }, "is_incremental": false, @@ -5001,7 +5025,7 @@ "output": { ".html": { "relative_path": "api/Discord.WebSocket.SocketRole.html", - "hash": "3aMjB/RGi/9NMYAg8ki44g==" + "hash": "+OimAcWmDImk6sfu0qT2CQ==" } }, "is_incremental": false, @@ -5013,7 +5037,7 @@ "output": { ".html": { "relative_path": "api/Discord.WebSocket.SocketSelfUser.html", - "hash": "E/ClTuGbvcZPhQLpzMnB6Q==" + "hash": "W2+34EmiOueKHCiNWPoJBg==" } }, "is_incremental": false, @@ -5025,7 +5049,7 @@ "output": { ".html": { "relative_path": "api/Discord.WebSocket.SocketSystemMessage.html", - "hash": "nuEOKm1vFRi2yoM2ZtX/9Q==" + "hash": "1t+5Xnmy5uytxuPnwA9FDg==" } }, "is_incremental": false, @@ -5037,7 +5061,7 @@ "output": { ".html": { "relative_path": "api/Discord.WebSocket.SocketTextChannel.html", - "hash": "VTpj+3URtnRiGfwA1Oyo4Q==" + "hash": "QhK6A9nPd7awQxUbPJUE/g==" } }, "is_incremental": false, @@ -5049,7 +5073,7 @@ "output": { ".html": { "relative_path": "api/Discord.WebSocket.SocketUnknownUser.html", - "hash": "mMkFuvVyAzlUVMCUDqlLTw==" + "hash": "gkVxdxYDR31uWLphZXnfBA==" } }, "is_incremental": false, @@ -5061,7 +5085,7 @@ "output": { ".html": { "relative_path": "api/Discord.WebSocket.SocketUser.html", - "hash": "ykMuTmESi4P3lTSjdG1c1g==" + "hash": "7pqP6vBs78NkutwVdkk1pQ==" } }, "is_incremental": false, @@ -5073,7 +5097,7 @@ "output": { ".html": { "relative_path": "api/Discord.WebSocket.SocketUserMessage.html", - "hash": "pFaGlfONnZy+Q4kcx1IYRQ==" + "hash": "9/yuaYR5CnAI4itCnV6NYQ==" } }, "is_incremental": false, @@ -5085,7 +5109,7 @@ "output": { ".html": { "relative_path": "api/Discord.WebSocket.SocketVoiceChannel.html", - "hash": "zOKCeJnG1BPuxiPTPffl/g==" + "hash": "5Lsfkmbo0ET0e++M1vZKZg==" } }, "is_incremental": false, @@ -5100,7 +5124,7 @@ "hash": "eRW82FJJyG8n86zoOs9EJA==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -5109,7 +5133,7 @@ "output": { ".html": { "relative_path": "api/Discord.WebSocket.SocketVoiceState.html", - "hash": "TIBURaIaigpwEK/1IxDHJg==" + "hash": "5ZyxPpuHEmgOdDOUKIhUtg==" } }, "is_incremental": false, @@ -5121,7 +5145,7 @@ "output": { ".html": { "relative_path": "api/Discord.WebSocket.SocketWebhookUser.html", - "hash": "JOmhdRNizHUOR4lRzJlc5Q==" + "hash": "/6EsDmfzmqHOVyJnC8w+sg==" } }, "is_incremental": false, @@ -5160,7 +5184,7 @@ "hash": "wSx8lxE01tvSM1vVTCBjGQ==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -5169,7 +5193,7 @@ "output": { ".html": { "relative_path": "api/Discord.html", - "hash": "/l0ov8eKwDk9ljO9U23esA==" + "hash": "UKWk/DPETpMfraZbrvYqrA==" } }, "is_incremental": false, @@ -5184,7 +5208,7 @@ "hash": "vvyVoWylSYpN1MDmm8yFgw==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -5196,7 +5220,7 @@ "hash": "y7terWsrrCF4okS7yM5Pew==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -5208,7 +5232,7 @@ "hash": "kBQjR2GcOi2ybZgID1GMmw==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -5220,7 +5244,7 @@ "hash": "MziE6EUXfB2Qbq4hBAS9XA==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -5232,7 +5256,7 @@ "hash": "MwmRpdFP/Y8HVppeMXbdAw==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -5244,7 +5268,7 @@ "hash": "C9U5m+wyzMFHX/87T/kP7w==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -5256,7 +5280,7 @@ "hash": "XGBQDoShtbGHyB0qRTrZoA==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -5268,7 +5292,7 @@ "hash": "apxMDOxxK57hhkRKPhYuWA==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -5280,7 +5304,7 @@ "hash": "Z6V1G7OhbmxJsYXcQKFiCw==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -5292,7 +5316,7 @@ "hash": "/9QbqWo7b7YO9TkORrGhPA==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -5304,7 +5328,7 @@ "hash": "W/YAEMgPZfc546eBTGvOFQ==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -5316,7 +5340,7 @@ "hash": "z+dONH/7eEE8UNuBZfVbvQ==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -5328,7 +5352,7 @@ "hash": "wCRopdVVpRHt3QJcUaXLmA==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -5340,7 +5364,7 @@ "hash": "SmubV8OW8yqXX2Ks2/giIA==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -5352,7 +5376,7 @@ "hash": "Lk544je82mi7iIFsXAN0Og==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -5364,7 +5388,7 @@ "hash": "5dfGrVKzu9gSVGCZcJN/fg==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -5376,7 +5400,7 @@ "hash": "TynF8LjAjrVTpXGyntnMlQ==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -5388,7 +5412,7 @@ "hash": "XkWUKmg/ejcoiD4bGsbIkQ==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -5400,7 +5424,7 @@ "hash": "+fyNL+ryZuFkdHbtxGU5RQ==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -5412,7 +5436,7 @@ "hash": "v/DXPkQktNaJZAPgzWm9gQ==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -5424,7 +5448,7 @@ "hash": "HTmjHrXoLTPEw7qXMh6oTg==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -5436,7 +5460,7 @@ "hash": "7K7U9OpCh97vugl/ZvGKTA==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -5448,7 +5472,7 @@ "hash": "rqQXK8QSTt5Y7PgJ3t8JtA==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -5460,7 +5484,7 @@ "hash": "oB2lINRjvWfj29L+Eegtag==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -5472,7 +5496,7 @@ "hash": "SRE5UngixKSROg2oQxnFAg==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -5484,7 +5508,7 @@ "hash": "sW0Tpevqc24s2i94h80uKA==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -5496,7 +5520,7 @@ "hash": "vX6Bqj6QcF76PoeWBQXxjA==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -5508,7 +5532,7 @@ "hash": "T2/NzIwqtY9wTzvxAehwwg==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -5520,7 +5544,7 @@ "hash": "xNtvhfiCphp70yVJsw9C0g==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -5532,7 +5556,7 @@ "hash": "HVDiVWbS8IlKpaGd0TEv2A==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -5544,7 +5568,7 @@ "hash": "+vvm1ww9jkJ4K1joiIZSoA==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -5556,7 +5580,7 @@ "hash": "mzC+g10l8xQq20JiI1NEHg==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -5568,7 +5592,7 @@ "hash": "EEC1r+0G1zGs8dLlRDTDng==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -5580,7 +5604,7 @@ "hash": "kQIZyrjfxr6bfWDZnb6mSg==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -5592,7 +5616,7 @@ "hash": "Erw7DY0u8dbsjCp3dY/P5w==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -5604,7 +5628,7 @@ "hash": "Nlad5KIj5m7feURLNgplzg==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -5616,7 +5640,7 @@ "hash": "1I6Llkb6zDNyS3Df9gbJ9A==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -5628,7 +5652,7 @@ "hash": "td85ur0r0z+UD5wjPyD+vg==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -5640,7 +5664,7 @@ "hash": "tzon9m5iA0fdXVI7LRBd7w==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -5652,7 +5676,7 @@ "hash": "A0Xf/zJy163miKA71aWhRw==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -5664,7 +5688,7 @@ "hash": "JMBUuiZC01gLg4i9jU+49A==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -5676,7 +5700,7 @@ "hash": "9s+BFD7L0OtBgjhkB9fZSA==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -5688,7 +5712,7 @@ "hash": "RV7pshGsH6EeVq90kuFxtw==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -5700,7 +5724,7 @@ "hash": "xPKDutJKTyADZN1ImO+/vA==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -5712,7 +5736,7 @@ "hash": "JeSptkwwFnXpgBOez0zSGA==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -5724,7 +5748,7 @@ "hash": "Keqpy4pny1ECK747eBbLAw==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -5736,7 +5760,7 @@ "hash": "6H9/akYjf8qB9imghlVBTQ==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -5748,7 +5772,7 @@ "hash": "3qGbFmmWOBAg2YllN93ycQ==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -5760,7 +5784,7 @@ "hash": "XaHNvFptZ4Y0kL1ZCcPUfA==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -5772,7 +5796,7 @@ "hash": "OMJ/K/qqCRv4/HWTEqLnDw==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -5784,7 +5808,7 @@ "hash": "q7wXxNWz4+erEOvEj1VAPw==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -5796,7 +5820,7 @@ "hash": "YQNhG4hp29wF+OIRTbV4NA==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -5808,7 +5832,7 @@ "hash": "Ihcqg2f55EEMJistKgpb8w==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -5820,7 +5844,7 @@ "hash": "U6/vMupgudj1P2Zw6NZTeg==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -5832,7 +5856,7 @@ "hash": "DUnZvJMHOh0OEjGRR9ysEw==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -5844,7 +5868,7 @@ "hash": "Im9GDJT5o1wnxfNCkHQJZw==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -5856,7 +5880,7 @@ "hash": "BIlqBUkdfHX6hYZW3FJDhQ==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -5868,7 +5892,7 @@ "hash": "GrinAeb/CKRZzvhDCCk54g==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -5880,7 +5904,7 @@ "hash": "nNENZTKuT8UfzUW+1x+Ncg==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -5892,7 +5916,7 @@ "hash": "a1HnEZT3DzPExXfMzv4uQA==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -5904,7 +5928,7 @@ "hash": "dbdKcxUht/MKI+0svynq8Q==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -5916,7 +5940,7 @@ "hash": "HXIIQCxSbiFcdIDvYjsqdw==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -5928,7 +5952,7 @@ "hash": "QqebX/9cn/Ku4ERa7WPHVw==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -5940,7 +5964,7 @@ "hash": "AqFqqrLqdWk/z1y/Mv4TmQ==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -5952,7 +5976,7 @@ "hash": "MLpoVeb8AlM4lbBk3+buGg==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -5964,7 +5988,7 @@ "hash": "evVntNDTgA01JFFwq3yLqg==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -5976,7 +6000,7 @@ "hash": "qPqvCMTROW2dSUM21UeZ+A==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -5988,7 +6012,7 @@ "hash": "EMBTfSyiUiy5xQLboiyLPw==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -6000,7 +6024,7 @@ "hash": "Ut+6kCyBZzAKYrWDxPJ2MQ==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -6012,7 +6036,7 @@ "hash": "nfkT24YVl/Hsnzma3MIbwQ==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -6024,7 +6048,7 @@ "hash": "KOMSd/TvDXHSG4z4XPKPOg==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -6036,7 +6060,7 @@ "hash": "QH/Zpylk68X3Q4edcnwfeA==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -6048,7 +6072,7 @@ "hash": "AMIShMPdd+7iv9+slgBA6Q==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -6060,7 +6084,7 @@ "hash": "/yqsFzW0bNqkesXb6o4RJA==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -6072,7 +6096,7 @@ "hash": "vGZskB6h7nbc3PyJbZwjnQ==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -6084,7 +6108,7 @@ "hash": "K/tZBE8K0PSP/T8mRKBn7Q==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -6096,7 +6120,7 @@ "hash": "coCEg6DAIKWCJWyRxXO4TQ==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -6108,7 +6132,7 @@ "hash": "Cozmcb3NsRCfcB+/+k1tsA==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -6120,7 +6144,7 @@ "hash": "EvgfWp2erUM6N0B1w8UMzQ==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -6132,7 +6156,7 @@ "hash": "vqF9NDHay6ImP3iyZ1lIAA==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -6144,7 +6168,7 @@ "hash": "5T1NxkmAofOG6LZjs5hZtA==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -6156,7 +6180,7 @@ "hash": "fsRwG6IIGqccAdUxwL6icQ==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -6165,10 +6189,10 @@ "output": { ".html": { "relative_path": "api/ImGuiNET.RangeAccessor-1.html", - "hash": "Kh0MYHMlyDYvkQtSlSll3Q==" + "hash": "31V1mUauG5peFRm+w9OiuA==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -6180,7 +6204,7 @@ "hash": "bmwq7ypm1rLGgFgzTF+fww==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -6189,10 +6213,10 @@ "output": { ".html": { "relative_path": "api/ImGuiNET.RangePtrAccessor-1.html", - "hash": "vTcVpOM+Bj+06V7IrpE0Kw==" + "hash": "8x4YQsZqkK/v4cZX0kKb+Q==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -6204,7 +6228,7 @@ "hash": "FiuEqqTlx0sinVYW0a1cPQ==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -6216,7 +6240,7 @@ "hash": "UUrAjBrcpudtscr5yjeI5Q==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -6228,7 +6252,7 @@ "hash": "qR92Hc24HE6h6FQELByT2Q==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -6240,7 +6264,7 @@ "hash": "3b6ep7TnLRACLamB0eA3yQ==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -6276,7 +6300,7 @@ "hash": "ppG1ALWbXRFaWx45YYBJsg==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -6348,7 +6372,7 @@ "hash": "YdeavpLlGdk3q+HNLTfPnQ==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -6360,7 +6384,7 @@ "hash": "pnj4y7J2ipz9mShypXBD4w==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -6372,7 +6396,7 @@ "hash": "kCrzzdu9kvuObw87ORybPQ==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -6396,7 +6420,7 @@ "hash": "Wz19MwFq0XoWIgJ7WBqgbg==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -6444,7 +6468,7 @@ "hash": "p6Z/qM59OaVF0gpiQdktHg==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -6480,7 +6504,7 @@ "hash": "mmXA+snJzxP660aTpfS3Bg==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -6516,7 +6540,7 @@ "hash": "RJXUKnrIxy3Ef9J+HepDUw==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -6552,7 +6576,7 @@ "hash": "mGWUn+2r4BbnG5Wc+QWDaA==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -6564,7 +6588,7 @@ "hash": "RqjOHdqVb6DTw5sSrQ//Bg==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -6576,7 +6600,7 @@ "hash": "JCtgRPpZj7yRqIrrlls4Bw==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -6588,7 +6612,7 @@ "hash": "ABOTpyrJ1ldug/Cf1mlQ5Q==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -6600,7 +6624,7 @@ "hash": "e5VtvUjY7j0NMelp8/LyEw==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -6612,7 +6636,7 @@ "hash": "/QNBzIaz5Nf8RUdKyhfytQ==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -6624,7 +6648,7 @@ "hash": "MNCyqTofT+0ltIwnex9T0Q==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -6636,7 +6660,7 @@ "hash": "5LBX9uVkaOOH2SS2SYn4hg==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -6648,7 +6672,7 @@ "hash": "oxRYTfRNPM7fmymK1ZZJBg==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -6660,7 +6684,7 @@ "hash": "l3hbakC0uTzxTa4n9e9wEA==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -6672,7 +6696,7 @@ "hash": "4bS/a6Ud0RYw2TlaKLDBgg==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -6684,7 +6708,7 @@ "hash": "ZJDC/Kzutx0pnG9UTI9f6w==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -6696,7 +6720,7 @@ "hash": "6kCX4Cl8itjJ4777cjwUZw==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -6708,7 +6732,7 @@ "hash": "lFY67OjooSxtjPkjs5NxMg==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -6720,7 +6744,7 @@ "hash": "J9eqT9zphZIW1U6iUYc/CA==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -6732,7 +6756,7 @@ "hash": "RJXCBhPLq10gqNx6I2+NsQ==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -6744,7 +6768,7 @@ "hash": "jVHAGXTEVML1czsrKPOEwA==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -6756,7 +6780,7 @@ "hash": "K+mm2lWUxAWG1xb1EUjQ8w==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -6768,7 +6792,7 @@ "hash": "hWXrWSmvX32hz1YqugvW6A==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -6780,7 +6804,7 @@ "hash": "V6pnYY+4ZMbML6R/mS2C9w==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -6792,7 +6816,7 @@ "hash": "uAwu3c8FIU60gKUT4LD46w==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -6804,7 +6828,7 @@ "hash": "ilV1CrQdiERGXt7d1Hc7Nw==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -6816,7 +6840,7 @@ "hash": "DmKu2o9qZUWqmK2RR4HhBA==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -6828,7 +6852,7 @@ "hash": "oEmtwisrVTNZ/QJ+cGrdvg==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -6840,7 +6864,7 @@ "hash": "kcWnT+sNoRcZSxqxTQYI1Q==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -6852,7 +6876,7 @@ "hash": "PDV2A482wR0e6weDzEa/mA==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -6864,7 +6888,7 @@ "hash": "TzZ+lHcmvuL6Ff+0BA4vBg==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -6876,7 +6900,7 @@ "hash": "ZpAX+N1sNTg7xSVsI6cWJQ==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -6888,7 +6912,7 @@ "hash": "U49/LEChjL7k2SN77O/KBA==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -6900,7 +6924,7 @@ "hash": "XH9wHogF3YP6gqcS0LgDcA==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -6912,7 +6936,7 @@ "hash": "FsBPedXNWhTaavE5I2f6Ug==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -6924,7 +6948,7 @@ "hash": "gbcn60HSO1t1ESvX6Lyckg==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -6936,7 +6960,7 @@ "hash": "OcC+TxH/7GIVi90yhZQHjw==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -6948,7 +6972,7 @@ "hash": "ymKsS296loGek7gXdjfVag==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -6960,7 +6984,7 @@ "hash": "oqC/9pyVFFf/dbc5xxpCwg==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -6972,7 +6996,7 @@ "hash": "Rbj5Mw/Uxw2eSDu5cOTSrQ==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -6984,7 +7008,7 @@ "hash": "tOUWmarYn6Ucy6tixNFtXw==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -6996,7 +7020,7 @@ "hash": "S2+CtyrbPNDZ6veMpHM67w==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -7008,7 +7032,7 @@ "hash": "m6dCGDV6DA2xo3oIKXr+GA==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -7020,7 +7044,7 @@ "hash": "peF5Nw2/mC/OfMxrYY01Ig==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -7032,7 +7056,7 @@ "hash": "7ePbxmtbrPGHJv3i2vadMQ==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -7044,7 +7068,7 @@ "hash": "T0Eg+Pou6uMx00VaALWKWQ==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -7056,7 +7080,7 @@ "hash": "TA6Jn0/8Hjd0RycIbm6LQg==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -7068,7 +7092,7 @@ "hash": "OCZv1KnnVeZ06St2zVHGbA==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -7080,7 +7104,7 @@ "hash": "5RQKrbD+26Fnc8kXObylbA==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -7092,7 +7116,7 @@ "hash": "PQ5c8H8hMcwWu4fEkFTaUg==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -7104,7 +7128,7 @@ "hash": "eq0YY9vJG+zsRW1nVThyug==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -7116,7 +7140,7 @@ "hash": "Zjd4PAsR5NcHW//v5ThKZA==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -7128,7 +7152,7 @@ "hash": "6tmul44jX7uK4wYQIx195g==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -7140,7 +7164,7 @@ "hash": "aJGiG3244L2UiEdb+AXo3g==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -7152,7 +7176,7 @@ "hash": "gvhms0W7YeG8xmE3V1b05A==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -7164,7 +7188,7 @@ "hash": "f1H+2DTEuNXJfcEIeNPbsQ==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -7176,7 +7200,7 @@ "hash": "dnqNmJ0rt5tM+YIGtHRzOg==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -7188,7 +7212,7 @@ "hash": "JPyYpvFWKZKBrNoj3komhQ==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -7200,7 +7224,7 @@ "hash": "r1W79yOwDaL9glOaLKOdxw==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -7212,7 +7236,7 @@ "hash": "lgTDhP6xWcbVgj34/LA5cg==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -7224,7 +7248,7 @@ "hash": "ZV4aogQDxAQL+1Bif/aLfA==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -7236,7 +7260,7 @@ "hash": "t48QPYcPGN6/xXHrXPPrkw==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -7248,7 +7272,7 @@ "hash": "ECcNGPlqgUZKpS44wYNF1w==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -7260,7 +7284,7 @@ "hash": "VBXjAthDVi0VFZLipweuog==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -7272,7 +7296,7 @@ "hash": "bbORiXtbMba0EvPK8q0uiA==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -7284,7 +7308,7 @@ "hash": "g2lS2kk9DxWrc31SeVwYlA==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -7296,7 +7320,7 @@ "hash": "ALq/A1MImZZjPC9BF9PNOw==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -7308,7 +7332,7 @@ "hash": "L93IfBdyqrGLYa8mktQt6A==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -7320,7 +7344,7 @@ "hash": "DdyNCZPcbmGgqyxEplkidQ==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -7332,7 +7356,7 @@ "hash": "UyQSj15eTsKzo4SBSIh9TQ==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -7344,7 +7368,7 @@ "hash": "6fbneTPB7T9Rg83BS+yLpg==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -7356,7 +7380,7 @@ "hash": "74+Zdh1ijL9n9p+Pjsp1+g==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -7368,7 +7392,7 @@ "hash": "Utk9+7FGSG6fczSh5jReGg==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -7380,7 +7404,7 @@ "hash": "160kgHxx10fcahCLdHnkzg==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -7392,7 +7416,7 @@ "hash": "B76AJMGrgFJJxObwLUOuzw==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -7404,7 +7428,7 @@ "hash": "8eQ5vT90xHgsVWEi6axgXA==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -7416,7 +7440,7 @@ "hash": "gIIGZxD5732TvK4tQ55tLg==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -7428,7 +7452,7 @@ "hash": "sGL86aE/ELVm6wN1hOrqqg==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -7440,7 +7464,7 @@ "hash": "qtu7v6UKuCIz0ITktYCZ7Q==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -7452,7 +7476,7 @@ "hash": "qumdOId0Y9QnRosaWCfKgg==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -7464,7 +7488,7 @@ "hash": "ETbqFgMXHhEJTV8oWTYRqw==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -7476,7 +7500,7 @@ "hash": "7Su9LgDdCYIr45HSu726PQ==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -7488,7 +7512,7 @@ "hash": "sVjlUtJ3hAb3d8lqkQeNfQ==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -7500,7 +7524,7 @@ "hash": "s5PPCQOvzHsS1vwEuN7lsA==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -7512,7 +7536,7 @@ "hash": "Q6zPzYGXeZRLbfM5vpJxzg==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -7524,7 +7548,7 @@ "hash": "HECEKBvWZoqxSJUUm9biCA==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -7536,7 +7560,7 @@ "hash": "XX/t16y8WTC9JUfQDImSvA==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -7548,7 +7572,7 @@ "hash": "fUXH2JgMU5LPG0f6eXGxag==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -7560,7 +7584,7 @@ "hash": "PMNDRL88Ufxj/O4qhmJrLQ==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -7572,7 +7596,7 @@ "hash": "VVZx4sijzuXv1P1vPE+sLg==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -7584,7 +7608,7 @@ "hash": "BLjFvc3s/sDIlYkr65fMFw==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -7596,7 +7620,7 @@ "hash": "LJ7JrPpNnfcJm+Deh6/iig==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -7608,7 +7632,7 @@ "hash": "/K68VEVGmakdQQ1GbeZYGQ==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -7620,7 +7644,7 @@ "hash": "ZNwkv5GyDueIBjbTPlQE9Q==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -7632,7 +7656,7 @@ "hash": "ho1HpY2vZNuE8bftghGwfw==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -7644,7 +7668,7 @@ "hash": "ruMEJwylXQHh+v1pyKR2Ew==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -7656,7 +7680,7 @@ "hash": "VKYu8WGNvTtDbHWUIcWMhw==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -7668,7 +7692,7 @@ "hash": "1JGDePa9pW4LLhfqJZP7UA==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -7680,7 +7704,7 @@ "hash": "5HXdjVNPoh7xx5gUNjrllQ==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -7692,7 +7716,7 @@ "hash": "vZIIKvmoAnl/njfKrs0dtA==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -7704,7 +7728,7 @@ "hash": "wQ4F4cTluo5+KIezThwdPw==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -7716,7 +7740,7 @@ "hash": "dNUyWrW+Dj7jU7kI3NVDRA==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -7728,7 +7752,7 @@ "hash": "KS8u3C+7zL+hNYtN+aREPQ==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -7740,7 +7764,7 @@ "hash": "XmRq1uMI8pb0iyFZs99D7g==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -7752,7 +7776,7 @@ "hash": "BkXUO+2inDoiq0S/4Wpe1Q==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -7764,7 +7788,7 @@ "hash": "Mmkgd4x4YExAoS9mgcYW0w==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -7776,7 +7800,7 @@ "hash": "L7tCquwzPc/y9FdYlzpCzw==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -7788,7 +7812,7 @@ "hash": "Id3jcLPiKuSECWWuwFv2hQ==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -7800,7 +7824,7 @@ "hash": "IbyPUL0pKRS+gvyTowXyIg==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -7812,7 +7836,7 @@ "hash": "xoybyD61Q7NI6BcUW0SeiA==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -7824,7 +7848,7 @@ "hash": "KhGPWgRxwSgNa3swsaxypQ==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -7836,7 +7860,7 @@ "hash": "3yTOHXzaks/VvFf+Yu1WjQ==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -7848,7 +7872,7 @@ "hash": "IFdNPGddhcteOqcZIuetSg==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -7860,7 +7884,7 @@ "hash": "8asYTJ0S/Da8KqiHJ/2I4w==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -7872,7 +7896,7 @@ "hash": "WBJbWvjMgDXWFcIEoCQa7Q==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -7884,7 +7908,7 @@ "hash": "OnFz4jaMN8yRF2SWvtNfgQ==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -7896,7 +7920,7 @@ "hash": "GPZfeYFpZ2Pgu0FzPOB9iw==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -7908,7 +7932,7 @@ "hash": "XNfjobq1TifQ3/dN5IU4fw==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -7920,7 +7944,7 @@ "hash": "RdGqUDDpt8dL43Gyj+AvBQ==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -7932,7 +7956,7 @@ "hash": "xd9jtWjjAuQOSoQaxQNUhA==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -7944,7 +7968,7 @@ "hash": "kgJvb4r0eMBQt3goe8V70g==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -7956,7 +7980,7 @@ "hash": "P12uwgxuxyBF293stqgbwQ==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -7968,7 +7992,7 @@ "hash": "EtMpp3rmFZJmuzNC1HIK2Q==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -7980,7 +8004,7 @@ "hash": "mQfoYalVvUdR57Jxmr9m7w==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -7992,7 +8016,7 @@ "hash": "MSj3AMUNPkvV3EpAvaDs3Q==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -8004,7 +8028,7 @@ "hash": "4E9gKXJOSyE0L2MLK3kP8w==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -8016,7 +8040,7 @@ "hash": "tjE6osszWTtqiz8iYOkGZQ==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -8028,7 +8052,7 @@ "hash": "5jQj5VktZWA2m/c9WPDrAw==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -8040,7 +8064,7 @@ "hash": "jmyVMoaOs2Nx3yN4MVPxPw==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -8052,7 +8076,7 @@ "hash": "GuJRZilncU9r+CbquDXIPQ==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -8064,7 +8088,7 @@ "hash": "6hq0yw8Y4cpdygivtHCebw==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -8076,7 +8100,7 @@ "hash": "ECNn4NzfrkDpHQkzVJvKSQ==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -8088,7 +8112,7 @@ "hash": "CtVmKJ0pNZuf0cJQYcxGgQ==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -8100,7 +8124,7 @@ "hash": "StYNa/p+ejDNnD3vUU4wxQ==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -8112,7 +8136,7 @@ "hash": "SuhsPyCgbaiZPtuhQ3D3yg==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -8124,7 +8148,7 @@ "hash": "4OA/buMbpEBACHiUYpCEag==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -8136,7 +8160,7 @@ "hash": "S85+M08X4gSYRPgqW21fAQ==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -8148,7 +8172,7 @@ "hash": "fNfvXqnUNXvWmqmPIW0fuA==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -8160,7 +8184,7 @@ "hash": "rbvqYn1oVKayxf1mEnGkMA==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -8172,7 +8196,7 @@ "hash": "ouKfDLMeUJdQEnF/p8uRPg==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -8184,7 +8208,7 @@ "hash": "Xa2TgjEQLGi7upSWkfCcoA==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -8196,7 +8220,7 @@ "hash": "Ttk1dQ7KE++yjQRTILCFfA==" } }, - "is_incremental": true, + "is_incremental": false, "version": "" }, { @@ -8217,7 +8241,7 @@ "output": { ".html": { "relative_path": "api/toc.html", - "hash": "mKCFQBc/CIevm+89yqfGfw==" + "hash": "meXK2B4dR8OJm9z4oRN6Pg==" } }, "is_incremental": false, @@ -8252,17 +8276,17 @@ "total_file_count": 0, "skipped_file_count": 0 }, + "ManagedReferenceDocumentProcessor": { + "can_incremental": true, + "incrementalPhase": "build", + "total_file_count": 684, + "skipped_file_count": 497 + }, "ConceptualDocumentProcessor": { "can_incremental": true, "incrementalPhase": "build", "total_file_count": 3, "skipped_file_count": 3 - }, - "ManagedReferenceDocumentProcessor": { - "can_incremental": true, - "incrementalPhase": "build", - "total_file_count": 682, - "skipped_file_count": 393 } } }, diff --git a/docs/xrefmap.yml b/docs/xrefmap.yml index 0b8cb8af8..ff01deec4 100644 --- a/docs/xrefmap.yml +++ b/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