FISLib/Vinno.vCloud.Common.FIS/IvCloudTerminal.cs

using System;
using System.Collections.Generic;

namespace Vinno.vCloud.Common.FIS
{
    public enum RegisterType
    {
        Success,
        Error,
        Failed
    }

    public interface IvCloudTerminal : IDisposable
    {
        /// <summary>
        /// Get device code.
        /// </summary>
        string DeviceCode { get; }

        string Url { get; }

        /// <summary>
        /// The uniqueId create when terminal created, used to add terminal for client user.
        /// </summary>
        string UniqueId { get; }

        /// <summary>
        /// Gets the status of the Terminal
        /// </summary>
        TerminalStatus Status { get; }

        /// <summary>
        /// Raised when the status is changed.
        /// </summary>
        event EventHandler StatusChanged;

        /// <summary>
        /// Get the feature instance by feature enum.
        /// </summary>
        /// <typeparam name="T">The interface of the feature</typeparam>
        /// <param name="featureType">The feature type</param>
        /// <returns>The instance of the feature</returns>
        /// <remarks>
        /// If the feature doesn't exist, this method will return null.
        /// </remarks>
        T GetFeature<T>(TerminalFeatureType featureType) where T : IFeature;

        IEnumerable<string> GetOrganizations(string keyWord);

        /// <summary>
        /// Disconnect to server.
        /// </summary>
        void Disconnect();

        /// <summary>
        /// Status == TerminalStatus.OrganizationMissing;
        /// </summary>
        /// <returns></returns>
        bool IsTerminalOrganizationMissging();

        /// <summary>
        /// update terminal account organization name to server
        /// </summary>
        /// <param name="organizationName"></param>
        /// <param name="createNewOrganization"></param>
        /// <returns> update success or yfailed</returns>
        bool UpdatelTerminalOrganizationName(string organizationName, bool createNewOrganization);

        /// <summary>
        ///  get terminal Organization name after this must login successed
        /// </summary>
        /// <returns></returns>
        string GetOrganizationName();

        /// <summary>
        /// Update enabled feature types.
        /// </summary>
        /// <param name="enabledFeatureTypes">The enabled feature types.</param>
        void UpdateFeatures(IEnumerable<TerminalFeatureType> enabledFeatureTypes);
    }
}