diff --git a/docs/docfx.json b/docs/docfx.json
index cb6a363607..663a49cdaf 100644
--- a/docs/docfx.json
+++ b/docs/docfx.json
@@ -43,7 +43,7 @@
"globalMetadata": {
"_appTitle": "Discord.Net Documentation",
"_appFooter": "Discord.Net (c) 2015-2018 2.0.0-beta",
- "_enableSearch": true,
+ "_enableSearch": true
},
"noLangKeyword": false,
"xrefService": [
diff --git a/src/Discord.Net.WebSocket/BaseSocketClient.Events.cs b/src/Discord.Net.WebSocket/BaseSocketClient.Events.cs
index c236b10458..9a94cbf235 100644
--- a/src/Discord.Net.WebSocket/BaseSocketClient.Events.cs
+++ b/src/Discord.Net.WebSocket/BaseSocketClient.Events.cs
@@ -7,6 +7,17 @@ public partial class BaseSocketClient
{
//Channels
/// Fired when a channel is created.
+ ///
+ ///
+ /// This event is fired when a generic channel has been created. The event handler must return a
+ /// .
+ ///
+ ///
+ /// The newly created channel is passed into the event handler parameter. The given channel type may
+ /// include, but not limited to, Private Channels (DM, Group), Guild Channels (Text, Voice, Category);
+ /// see the derived classes of for more details.
+ ///
+ ///
public event Func ChannelCreated
{
add { _channelCreatedEvent.Add(value); }
@@ -14,12 +25,35 @@ public event Func ChannelCreated
}
internal readonly AsyncEvent> _channelCreatedEvent = new AsyncEvent>();
/// Fired when a channel is destroyed.
+ ///
+ ///
+ /// This event is fired when a generic channel has been destroyed. The event handler must return a
+ /// .
+ ///
+ ///
+ /// The destroyed channel is passed into the event handler parameter. The given channel type may
+ /// include, but not limited to, Private Channels (DM, Group), Guild Channels (Text, Voice, Category);
+ /// see the derived classes of for more details.
+ ///
+ ///
public event Func ChannelDestroyed {
add { _channelDestroyedEvent.Add(value); }
remove { _channelDestroyedEvent.Remove(value); }
}
internal readonly AsyncEvent> _channelDestroyedEvent = new AsyncEvent>();
/// Fired when a channel is updated.
+ ///
+ ///
+ /// This event is fired when a generic channel has been destroyed. The event handler must return a
+ /// .
+ ///
+ ///
+ /// The original (prior to update) channel is passed into the first , while
+ /// the updated channel is passed into the second. The given channel type may include, but not limited
+ /// to, Private Channels (DM, Group), Guild Channels (Text, Voice, Category); see the derived classes of
+ /// for more details.
+ ///
+ ///
public event Func ChannelUpdated {
add { _channelUpdatedEvent.Add(value); }
remove { _channelUpdatedEvent.Remove(value); }
@@ -28,12 +62,46 @@ public event Func ChannelUpdated {
//Messages
/// Fired when a message is received.
+ ///
+ ///
+ /// This event is fired when a message is received. The event handler must return a
+ /// .
+ ///
+ ///
+ /// The message that is sent to the client is passed into the event handler parameter as
+ /// . This message may be a system message (i.e.
+ /// ) or a user message (i.e. . See
+ /// the derived clsases of for more details.
+ ///
+ ///
public event Func MessageReceived {
add { _messageReceivedEvent.Add(value); }
remove { _messageReceivedEvent.Remove(value); }
}
internal readonly AsyncEvent> _messageReceivedEvent = new AsyncEvent>();
/// Fired when a message is deleted.
+ ///
+ ///
+ /// This event is fired when a message is deleted. The event handler must return a
+ /// and accept a and
+ /// as its parameters.
+ ///
+ ///
+ ///
+ /// It is not possible to retrieve the message via
+ /// ; the message cannot be retrieved by Discord
+ /// after the message has been deleted.
+ ///
+ /// If caching is enabled via , the
+ /// entity will contain the deleted message; otherwise, in event
+ /// that the message cannot be retrieved, the snowflake ID of the message is preserved in the
+ /// .
+ ///
+ ///
+ /// The source channel of the removed message will be passed into the
+ /// parameter.
+ ///
+ ///
public event Func, ISocketMessageChannel, Task> MessageDeleted {
add { _messageDeletedEvent.Add(value); }
remove { _messageDeletedEvent.Remove(value); }