Document models

This commit is contained in:
2021-12-30 22:11:20 -08:00
parent a0767fb566
commit 518191f5c6
3 changed files with 58 additions and 2 deletions

View File

@@ -2,8 +2,18 @@
namespace TwilioSMSReceiver.Common.Interfaces
{
/// <summary>
/// The main code where we send all SMS data and translate it accordingly
/// </summary>
public interface IMessageHandler
{
/// <summary>
/// The main relay SMS code
/// </summary>
/// <param name="model">Parsed model of the SMS Message</param>
/// <returns>True if it succeeded, false if it didn't relay successfully</returns>
/// <exception cref="NotImplementedException">Returned if the code is loaded, but not actually implemented</exception>
/// <exception cref="Exception">All generic exceptions are returned here</exception>
public Task<bool> RelaySms(SMSModel model);
}
}