Early 1.0 REST Preview

This commit is contained in:
RogueException
2016-04-04 20:15:16 -03:00
parent b888ea23dc
commit 5bdd6a7ff3
470 changed files with 6804 additions and 14042 deletions

View File

@@ -2,12 +2,12 @@ Logging
=======
Discord.Net will log all of its events/exceptions using a built-in LogManager.
This LogManager can be accessed through ``DiscordClient.Log``
This LogManager can be accessed through DiscordClient.Log
Usage
-----
To handle Log Messages through Discord.Net's Logger, you must hook into the ``Log.Message<LogMessageEventArgs>`` Event.
To handle Log Messages through Discord.Net's Logger, you must hook into the Log.Message<LogMessageEventArgs> Event.
The LogManager does not provide a string-based result for the message, you must put your own message format together using the data provided through LogMessageEventArgs
See the Example for a snippet of logging.
@@ -17,25 +17,19 @@ Logging Your Own Data
The LogManager included in Discord.Net can also be used to log your own messages.
You can use ``DiscordClient.Log.Log(LogSeverity, Source, Message, [Exception])``, or one of the shortcut helpers, to log data.
You can use DiscordClient.Log.Log(LogSeverity, Source, Message, Exception), or one of the shortcut helpers, to log data.
Example:
.. code-block:: csharp6
.. code-block:: c#
_client.MessageReceived += async (s, e) {
// Log a new Message with Severity Info, Sourced from 'MessageReceived', with the Message Contents.
_client.Log.Info("MessageReceived", e.Message.Text, null);
};
.. warning::
Starting in Discord.Net 1.0, you will not be able to log your own messages. You will need to create your own Logging manager, or use a pre-existing one.
Example
-------
.. literalinclude:: /samples/logging.cs
:language: csharp6
:language: c#
:tab-width: 2