mirror of
https://github.com/OrchardCMS/Orchard.git
synced 2025-10-15 19:54:57 +08:00
Adding some inline documentation to shell management API
This commit is contained in:
@@ -4,12 +4,26 @@ using Orchard.Environment.Extensions.Models;
|
||||
|
||||
namespace Orchard.MultiTenancy.Services {
|
||||
public interface ITenantService : IDependency {
|
||||
/// <summary>
|
||||
/// Retrieves all tenants' shell settings.
|
||||
/// </summary>
|
||||
/// <returns>All tenants' shell settings.</returns>
|
||||
IEnumerable<ShellSettings> GetTenants();
|
||||
|
||||
/// <summary>
|
||||
/// Creates a new tenant.
|
||||
/// </summary>
|
||||
/// <param name="settings">Shell settings of the tenant.</param>
|
||||
void CreateTenant(ShellSettings settings);
|
||||
|
||||
/// <summary>
|
||||
/// Updates the shell settings of a tenant.
|
||||
/// </summary>
|
||||
/// <param name="settings">Shell settings of the tenant.</param>
|
||||
void UpdateTenant(ShellSettings settings);
|
||||
|
||||
/// <summary>
|
||||
/// Returns a list of all installed themes
|
||||
/// Returns a list of all installed themes.
|
||||
/// </summary>
|
||||
IEnumerable<ExtensionDescriptor> GetInstalledThemes();
|
||||
}
|
||||
|
@@ -2,7 +2,16 @@ using System.Collections.Generic;
|
||||
|
||||
namespace Orchard.Environment.Configuration {
|
||||
public interface IShellSettingsManager {
|
||||
/// <summary>
|
||||
/// Retrieves all shell settings stored.
|
||||
/// </summary>
|
||||
/// <returns>All shell settings.</returns>
|
||||
IEnumerable<ShellSettings> LoadSettings();
|
||||
|
||||
/// <summary>
|
||||
/// Persists shell settings to the storage.
|
||||
/// </summary>
|
||||
/// <param name="settings">The shell settings to store.</param>
|
||||
void SaveSettings(ShellSettings settings);
|
||||
}
|
||||
}
|
Reference in New Issue
Block a user