jellyfin/MediaBrowser.Controller/ClientEvent/IClientEventLogger.cs
2021-11-05 12:57:24 -06:00

32 lines
1.0 KiB
C#

using System.IO;
using System.Threading.Tasks;
using MediaBrowser.Controller.Net;
using MediaBrowser.Model.ClientLog;
namespace MediaBrowser.Controller.ClientEvent
{
/// <summary>
/// The client event logger.
/// </summary>
public interface IClientEventLogger
{
/// <summary>
/// Logs the event from the client.
/// </summary>
/// <param name="clientLogEvent">The client log event.</param>
void Log(ClientLogEvent clientLogEvent);
/// <summary>
/// Writes a file to the log directory.
/// </summary>
/// <param name="clientName">The client name writing the document.</param>
/// <param name="clientVersion">The client version writing the document.</param>
/// <param name="fileContents">The file contents to write.</param>
/// <returns>The created file name.</returns>
Task<string> WriteDocumentAsync(
string clientName,
string clientVersion,
Stream fileContents);
}
}