Wino-Mail/Wino.Core.Domain/Interfaces/IRequestBundle.cs

using System.Collections.Generic;
using Wino.Core.Domain.Entities;
using Wino.Core.Domain.Enums;

namespace Wino.Core.Domain.Interfaces
{
    /// <summary>
    /// Represents a group of requests.
    /// </summary>
    public interface IRequestBundle
    {
        string BundleId { get; set; }
        IRequestBase Request { get; }
    }

    /// <summary>
    /// Represents a group of requests with their native response types.
    /// </summary>
    /// <typeparam name="TRequest">Native request type from each synchronizer to store.</typeparam>
    public interface IRequestBundle<TRequest> : IRequestBundle
    {
        TRequest NativeRequest { get; }
    }

    public interface IRequestBase : IClientMessage
    {
        /// <summary>
        /// Synchronizer option to perform.
        /// </summary>
        MailSynchronizerOperation Operation { get; }

        /// <summary>
        /// UI changes to apply to the item before sending the request to the server.
        /// Changes here only affect the UI, not the item itself.
        /// Changes here are reverted if the request fails by calling <see cref="RevertUIChanges"/>.
        /// </summary>
        void ApplyUIChanges();

        /// <summary>
        /// Reverts the UI changes applied by <see cref="ApplyUIChanges"/> if the request fails.
        /// </summary>
        void RevertUIChanges();

        /// <summary>
        /// Whether synchronizations should be delayed after executing this request.
        /// Specially Outlook sometimes don't report changes back immidiately after sending the API request.
        /// This results following synchronization to miss the changes.
        /// We add small delay for the following synchronization after executing current requests to overcome this issue.
        /// Default is false.
        /// </summary>
        bool DelayExecution { get; }
    }

    public interface IRequest : IRequestBase
    {
        MailCopy Item { get; }
        IBatchChangeRequest CreateBatch(IEnumerable<IRequest> requests);
    }

    public interface IFolderRequest : IRequestBase
    {
        MailItemFolder Folder { get; }
    }

    public interface IBatchChangeRequest : IRequestBase
    {
        IEnumerable<IRequest> Items { get; }
    }
}