BotSharp/BotSharp.Platform.Abstraction/IAgentStorage.cs

using BotSharp.Platform.Models;
using System;
using System.Collections.Generic;
using System.Text;

namespace BotSharp.Platform.Abstraction
{
    /// <summary>
    /// Agent could be persisted in any kind of storage.
    /// Example: local file storage, cloud storage, relational database, key-value database or memory
    /// </summary>
    public interface IAgentStorage<TAgent>
    {
        /// <summary>
        /// Save agent instance
        /// </summary>
        /// <param name="agent"></param>
        /// <returns></returns>
        bool Persist(TAgent agent);

        /// <summary>
        /// Get agent by id
        /// </summary>
        /// <param name="agentId"></param>
        /// <returns></returns>
        TAgent FetchById(string agentId);

        /// <summary>
        /// Get agent by name
        /// </summary>
        /// <param name="agentName"></param>
        /// <returns></returns>
        TAgent FetchByName(string agentName);

        /// <summary>
        /// Query agents
        /// </summary>
        /// <returns></returns>
        List<TAgent> Query();

        /// <summary>
        /// Delete agents
        /// </summary>
        /// <returns></returns>
        int PurgeAllAgents();
    }
}