IExtensionWrapper.cs

// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.

using System;
using System.Collections.Generic;
using System.Threading.Tasks;
using Microsoft.Windows.DevHome.SDK;
using Windows.ApplicationModel;

namespace DevHome.Common.Services;

public interface IExtensionWrapper
{
    /// <summary>
    /// Gets the DisplayName of the package as mentioned in the manifest
    /// </summary>
    string PackageDisplayName { get; }

    /// <summary>
    /// Gets DisplayName of the extension as mentioned in the manifest
    /// </summary>
    string ExtensionDisplayName { get; }

    /// <summary>
    /// Gets PackageFullName of the extension
    /// </summary>
    string PackageFullName { get; }

    /// <summary>
    /// Gets PackageFamilyName of the extension
    /// </summary>
    string PackageFamilyName { get; }

    /// <summary>
    /// Gets Publisher of the extension
    /// </summary>
    string Publisher { get; }

    /// <summary>
    /// Gets class id (GUID) of the extension class (which implements IExtension) as mentioned in the manifest
    /// </summary>
    string ExtensionClassId { get; }

    /// <summary>
    /// Gets the date on which the application package was installed or last updated.
    /// </summary>
    DateTimeOffset InstalledDate { get; }

    /// <summary>
    /// Gets the PackageVersion of the extension
    /// </summary>
    PackageVersion Version { get; }

    /// <summary>
    /// Gets the Unique Id for the extension
    /// </summary>
    public string ExtensionUniqueId { get; }

    /// <summary>
    /// Checks whether we have a reference to the extension process and we are able to call methods on the interface.
    /// </summary>
    /// <returns>Whether we have a reference to the extension process and we are able to call methods on the interface.</returns>
    bool IsRunning();

    /// <summary>
    /// Starts the extension if not running
    /// </summary>
    /// <returns>An awaitable task</returns>
    Task StartExtensionAsync();

    /// <summary>
    /// Signals the extension to dispose itself and removes the reference to the extension com object
    /// </summary>
    void SignalDispose();

    /// <summary>
    /// Gets the underlying instance of IExtension
    /// </summary>
    /// <returns>Instance of IExtension</returns>
    IExtension? GetExtensionObject();

    /// <summary>
    /// Tells the wrapper that the extension implements the given provider
    /// </summary>
    /// <param name="providerType">The type of provider to be added</param>
    void AddProviderType(ProviderType providerType);

    /// <summary>
    /// Checks whether the given provider was added through `AddProviderType` method
    /// </summary>
    /// <param name="providerType">The type of the provider to be checked for</param>
    /// <returns>Whether the given provider was added through `AddProviderType` method</returns>
    bool HasProviderType(ProviderType providerType);

    /// <summary>
    /// Starts the extension if not running and gets the provider from the underlying IExtension object
    /// Can be null if not found
    /// </summary>
    /// <typeparam name="T">The type of provider</typeparam>
    /// <returns>Nullable instance of the provider</returns>
    Task<T?> GetProviderAsync<T>()
        where T : class;

    /// <summary>
    /// Starts the extension if not running and gets a list of providers of type T from the underlying IExtension object.
    /// If no providers are found, returns an empty list.
    /// </summary>
    /// <typeparam name="T">The type of provider</typeparam>
    /// <returns>Nullable instance of the provider</returns>
    Task<IEnumerable<T>> GetListOfProvidersAsync<T>()
        where T : class;
}