From 28d4041a5aa6f34ea94caa15f35ef63a2bda6fd4 Mon Sep 17 00:00:00 2001 From: David Valachovic Date: Tue, 5 Jul 2016 14:26:21 -0500 Subject: [PATCH 1/2] Added XML Doc summaries to the Client Events to help users of the library decide which events to use. --- src/Discord.Net/DiscordClient.Events.cs | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) diff --git a/src/Discord.Net/DiscordClient.Events.cs b/src/Discord.Net/DiscordClient.Events.cs index 7ffb861f1..0b8a8e273 100644 --- a/src/Discord.Net/DiscordClient.Events.cs +++ b/src/Discord.Net/DiscordClient.Events.cs @@ -7,28 +7,59 @@ namespace Discord { public event EventHandler Ready = delegate { }; //public event EventHandler LoggedOut = delegate { }; + /// When a new channel is created, relevant to the current user. + /// Discord API Event name: CHANNEL_CREATE. public event EventHandler ChannelCreated = delegate { }; + /// When a channel relevant to the current user is deleted. + /// Discord API Event name: CHANNEL_DELETE. public event EventHandler ChannelDestroyed = delegate { }; + /// When a channel is updated. Discord API Event name: CHANNEL_UPDATE. public event EventHandler ChannelUpdated = delegate { }; + /// NOT IMPLEMENTED YET public event EventHandler MessageAcknowledged = delegate { }; + /// When a message is deleted. Discord API Event name: MESSAGE_DELETE. public event EventHandler MessageDeleted = delegate { }; + /// When a message is created. Discord API Event name: MESSAGE_CREATE. public event EventHandler MessageReceived = delegate { }; + /// NOT IMPLEMENTED YET public event EventHandler MessageSent = delegate { }; + /// When a message is updated. Discord API Event name: MESSAGE_UPDATE. public event EventHandler MessageUpdated = delegate { }; + /// When properties about the user change. Discord API Event name: USER_UPDATE. public event EventHandler ProfileUpdated = delegate { }; + /// When a server role is created. Discord API Event name: GUILD_ROLE_CREATE. public event EventHandler RoleCreated = delegate { }; + /// When a server role is updated. Discord API Event name: GUILD_ROLE_UPDATE. public event EventHandler RoleUpdated = delegate { }; + /// When a server role is deleted. Discord API Event name: GUILD_ROLE_DELETE. public event EventHandler RoleDeleted = delegate { }; + /// When the current user joins a new server. Discord API Event name: GUILD_CREATE. public event EventHandler JoinedServer = delegate { }; + /// When the user leaves or is removed from a server. + /// Discord API Event name: GUILD_DELETE. public event EventHandler LeftServer = delegate { }; + /// When a server becomes available (current user is initially connecting, + /// or a server becomes available again). + /// Discord API Event name: GUILD_CREATE or GUILD_MEMBERS_CHUNK. public event EventHandler ServerAvailable = delegate { }; + /// When a server is updated. Discord API Event name: GUILD_UPDATE. public event EventHandler ServerUpdated = delegate { }; + /// When a server becomes unavailable during a server outage. + /// Discord API Event name: GUILD_DELETE. public event EventHandler ServerUnavailable = delegate { }; + /// When a user is banned from a server. Discord API Event name: GUILD_BAN_ADD. public event EventHandler UserBanned = delegate { }; + /// When a user starts typing in a channel. Discord API Event name: TYPING_START. public event EventHandler UserIsTyping = delegate { }; + /// When a new user joins a server. Discord API Event name: GUILD_MEMBER_ADD. public event EventHandler UserJoined = delegate { }; + /// When a user is removed from a server (leave/kick/ban). + /// Discord API Event name: GUILD_MEMBER_REMOVE. public event EventHandler UserLeft = delegate { }; + /// When a server member is updated. + /// Discord API Event name: GUILD_MEMBER_UPDATE or PRESENCE_UPDATE or VOICE_STATE_UPDATE. public event EventHandler UserUpdated = delegate { }; + /// When a user is unbanned from a server. Discord API Event name: GUILD_BAN_REMOVE. public event EventHandler UserUnbanned = delegate { }; private void OnReady() From 5195e6b230df96b5feadbfd5bcd748ec2c5a8ba2 Mon Sep 17 00:00:00 2001 From: David Valachovic Date: Fri, 8 Jul 2016 21:44:53 -0500 Subject: [PATCH 2/2] Added [Obsolete] attrib to 2 events --- src/Discord.Net/DiscordClient.Events.cs | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/Discord.Net/DiscordClient.Events.cs b/src/Discord.Net/DiscordClient.Events.cs index 0b8a8e273..d413bd750 100644 --- a/src/Discord.Net/DiscordClient.Events.cs +++ b/src/Discord.Net/DiscordClient.Events.cs @@ -15,13 +15,13 @@ namespace Discord public event EventHandler ChannelDestroyed = delegate { }; /// When a channel is updated. Discord API Event name: CHANNEL_UPDATE. public event EventHandler ChannelUpdated = delegate { }; - /// NOT IMPLEMENTED YET + [Obsolete] public event EventHandler MessageAcknowledged = delegate { }; /// When a message is deleted. Discord API Event name: MESSAGE_DELETE. public event EventHandler MessageDeleted = delegate { }; /// When a message is created. Discord API Event name: MESSAGE_CREATE. public event EventHandler MessageReceived = delegate { }; - /// NOT IMPLEMENTED YET + [Obsolete] public event EventHandler MessageSent = delegate { }; /// When a message is updated. Discord API Event name: MESSAGE_UPDATE. public event EventHandler MessageUpdated = delegate { };