IDialogService.cs

using System;
using System.Threading.Tasks;
using GitHub.Models;

namespace GitHub.Services
{
    /// <summary>
    /// Services for showing dialogs.
    /// </summary>
    public interface IDialogService
    {
        /// <summary>
        /// Shows the Clone dialog.
        /// </summary>
        /// <param name="connection">
        /// The connection to use. If null, the URL tab will be used.
        /// </param>
        /// <returns>
        /// A task that returns an instance of <see cref="CloneDialogResult"/> on success,
        /// or null if the dialog was cancelled.
        /// </returns>
        Task<CloneDialogResult> ShowCloneDialog(IConnection connection);

        /// <summary>
        /// Shows the re-clone dialog.
        /// </summary>
        /// <param name="repository">The repository to clone.</param>
        /// <returns>
        /// A task that returns the base path for the clone on success, or null if the dialog was
        /// cancelled.
        /// </returns>
        /// <remarks>
        /// The re-clone dialog is shown from the VS2017+ start page when the user wants to check
        /// out a repository that was previously checked out on another machine.
        /// </remarks>
        Task<string> ShowReCloneDialog(IRepositoryModel repository);

        /// <summary>
        /// Shows the Create Gist dialog.
        /// </summary>
        /// <param name="connection">
        /// The connection to use. If null, the first connection will be used, or the user promted
        /// to log in if there are no connections.
        /// </param>
        Task ShowCreateGist(IConnection connection);

        /// <summary>
        /// Shows the Create Repository dialog.
        /// </summary>
        /// <param name="connection">
        /// The connection to use. May not be null.
        /// </param>
        Task ShowCreateRepositoryDialog(IConnection connection);

        /// <summary>
        /// Shows the Login dialog.
        /// </summary>
        /// <returns>
        /// The <see cref="IConnection"/> created by the login, or null if the login was
        /// unsuccessful.
        /// </returns>
        Task<IConnection> ShowLoginDialog();

        /// <summary>
        /// Shows the Fork Repository dialog.
        /// </summary>
        /// <param name="repository">The repository to fork.</param>
        /// <param name="connection">The connection to use. May not be null.</param>
        Task ShowForkDialog(ILocalRepositoryModel repository, IConnection connection);
    }
}