You can not select more than 25 topics Topics must start with a chinese character,a letter or number, can include dashes ('-') and can be up to 35 characters long.

events.rst 5.4 kB

9 years ago
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475
  1. |stub| Events
  2. =============
  3. Usage
  4. -----
  5. To take advantage of Events in Discord.Net, you need to hook into them.
  6. There are two ways of hooking into events. See the example for examples on using these events.
  7. Usable Events
  8. -------------
  9. +--------------------+--------------------+------------------------------------------+
  10. | Event Name | EventArgs | Description |
  11. +====================+====================+==========================================+
  12. | UserBanned | BanEventArgs | Called when a user is banned. |
  13. +--------------------+--------------------+------------------------------------------+
  14. | UserUnbanned | BanEventArgs | Called when a user is unbanned. |
  15. +--------------------+--------------------+------------------------------------------+
  16. | ChannelCreated | ChannelEventArgs | Called when a channel is created. |
  17. +--------------------+--------------------+------------------------------------------+
  18. | ChannelDestroyed | ChannelEventArgs | Called when a channel is destroyed. |
  19. +--------------------+--------------------+------------------------------------------+
  20. | ChannelUpdated | ChannelEventArgs | Called when a channel is updated. |
  21. +--------------------+--------------------+------------------------------------------+
  22. | MessageReceived | MessageEventArgs | Called when a message is received. |
  23. +--------------------+--------------------+------------------------------------------+
  24. | MessageSent | MessageEventArgs | Called when a message is sent. |
  25. +--------------------+--------------------+------------------------------------------+
  26. | MessageDeleted | MessageEventArgs | Called when a message is deleted. |
  27. +--------------------+--------------------+------------------------------------------+
  28. | MessageUpdated | MessageEventArgs | Called when a message is updated\\edited.|
  29. +--------------------+--------------------+------------------------------------------+
  30. | MessageReadRemotely| MessageEventArgs | Called when a message is read. |
  31. +--------------------+--------------------+------------------------------------------+
  32. | RoleCreated | RoleEventArgs | Called when a role is created. |
  33. +--------------------+--------------------+------------------------------------------+
  34. | RoleUpdated | RoleEventArgs | Called when a role is updated. |
  35. +--------------------+--------------------+------------------------------------------+
  36. | RoleDeleted | RoleEventArgs | Called when a role is deleted. |
  37. +--------------------+--------------------+------------------------------------------+
  38. | JoinedServer | ServerEventArgs | Called when a member joins a server. |
  39. +--------------------+--------------------+------------------------------------------+
  40. | LeftServer | ServerEventArgs | Called when a member leaves a server. |
  41. +--------------------+--------------------+------------------------------------------+
  42. | ServerUpdated | ServerEventArgs | Called when a server is updated. |
  43. +--------------------+--------------------+------------------------------------------+
  44. | ServerUnavailable | ServerEventArgs | Called when a Discord server goes down. |
  45. +--------------------+--------------------+------------------------------------------+
  46. | ServerAvailable | ServerEventArgs |Called when a Discord server goes back up.|
  47. +--------------------+--------------------+------------------------------------------+
  48. | UserJoined | UserEventArgs | Called when a user joins a Channel. |
  49. +--------------------+--------------------+------------------------------------------+
  50. | UserLeft | UserEventArgs | Called when a user leaves a Channel. |
  51. +--------------------+--------------------+------------------------------------------+
  52. | UserUpdated | UserEventArgs | --- |
  53. +--------------------+--------------------+------------------------------------------+
  54. | UserPresenceUpdated| UserEventArgs | Called when a user's presence changes. |
  55. | | | (Here\\Away) |
  56. +--------------------+--------------------+------------------------------------------+
  57. | UserVoiceState | UserEventArgs | Called when a user's voice state changes.|
  58. | Updated | | (Muted\\Unmuted) |
  59. +--------------------+--------------------+------------------------------------------+
  60. |UserIsTypingUpdated | UserEventArgs | Called when a user starts\\stops typing. |
  61. +--------------------+--------------------+------------------------------------------+
  62. | UserIsSpeaking | UserEventArgs | Called when a user's voice state changes.|
  63. | Updated | | (Speaking\\Not Speaking) |
  64. +--------------------+--------------------+------------------------------------------+
  65. | ProfileUpdated | N/A | Called when a user's profile changes. |
  66. +--------------------+--------------------+------------------------------------------+
  67. Example
  68. -------
  69. .. literalinclude:: /samples/events.cs
  70. :language: csharp6
  71. :tab-width: 2