Class Root

Namespace

The.Web.Composition

Assembly

Instagile.Web.Client.dll

public sealed class Root : IServices, IServices, IDisposable

Inheritance

object

Root

Implements

IServices

IServices

IDisposable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

Root(Root, IPreferenceStore, IPreferenceMirror, StartupRequirements?, IReminderStore, IReminderSource, Func<IServices, Task<IEnumerable<IReminder>>>?, IJSRuntime, NavigationManager, Options, IEnumerable<IPageSpec>, IEnumerable<ICommandSpec>, IEnumerable<IListSpec>, IEnumerable<IEditSpec>, IEnumerable<ICriteriaSpec>)

public Root(Root coreServices, IPreferenceStore preferenceStore, IPreferenceMirror preferenceMirror, StartupRequirements? startupRequirements, IReminderStore reminderStore, IReminderSource reminderSource, Func<IServices, Task<IEnumerable<IReminder>>>? personalReminders, IJSRuntime jsRuntime, NavigationManager navigationManager, Options options, IEnumerable<IPageSpec> pageOverrides, IEnumerable<ICommandSpec> commandOverrides, IEnumerable<IListSpec> listOverrides, IEnumerable<IEditSpec> editOverrides, IEnumerable<ICriteriaSpec> criteriaOverrides)

Parameters

coreServices Root

preferenceStore IPreferenceStore

preferenceMirror IPreferenceMirror

startupRequirements StartupRequirements

reminderStore IReminderStore

reminderSource IReminderSource

personalReminders Func<IServices, Task<IEnumerable<IReminder>>>

jsRuntime IJSRuntime

navigationManager NavigationManager

options Options

pageOverrides IEnumerable<IPageSpec>

commandOverrides IEnumerable<ICommandSpec>

listOverrides IEnumerable<IListSpec>

editOverrides IEnumerable<IEditSpec>

criteriaOverrides IEnumerable<ICriteriaSpec>

Properties

AppName

public string AppName { get; }

Property Value

string

AppVersion

public string AppVersion { get; }

Property Value

string

Components

Functions to access built-in entity types added by model features.

public ComponentService Components { get; }

Property Value

ComponentService

Documents

Functions to load and store files or images.

public DocumentService Documents { get; }

Property Value

DocumentService

Environment

public string Environment { get; }

Property Value

string

Export

public ExportService Export { get; }

Property Value

ExportService

Import

Functions for copying schema and data from external sources.

public ImportService Import { get; }

Property Value

ImportService

JS

public IJSRuntime JS { get; }

Property Value

IJSRuntime

Licensing

public LicenseService Licensing { get; }

Property Value

LicenseService

Logging

public LogService Logging { get; }

Property Value

LogService

Mail

Functions to send email.

public MailService Mail { get; }

Property Value

MailService

Metadata

public EntityMetadataDictionary Metadata { get; }

Property Value

EntityMetadataDictionary

Navigation

public NavigationManager Navigation { get; }

Property Value

NavigationManager

Pages

public PageService Pages { get; }

Property Value

PageService

Persistence

Functions to load and store entities.

public PersistenceService Persistence { get; }

Property Value

PersistenceService

Preferences

The current user's preferences, available synchronously: seeded from the local mirror (a cookie rewritten whenever preferences are loaded or saved), then refreshed from the store of truth in the background. Await GetUserPreferencesAsync() for the refreshed values. Rebuilt when the signed-in user changes, and the refresh rewrites the mirror, so a snapshot left by another user of the browser only survives until the current user's preferences load.

public PreferenceService Preferences { get; }

Property Value

PreferenceService

RPC

Functions to execute registered procedures, either locally or via a remote IEndpoint.

public RPCService RPC { get; }

Property Value

RPCService

Reminders

public ReminderService Reminders { get; }

Property Value

ReminderService

ReplaceSmartPunctuation

public bool ReplaceSmartPunctuation { get; }

Property Value

bool

Scaffolding

public ScaffoldService Scaffolding { get; }

Property Value

ScaffoldService

Security

public SecurityService Security { get; }

Property Value

SecurityService

Version

public string Version { get; }

Property Value

string

Methods

CreateContext()

public IEntityContext CreateContext()

Returns

IEntityContext

CreateContext(IPrincipal)

public IEntityContext CreateContext(IPrincipal principal)

Parameters

principal IPrincipal

Returns

IEntityContext

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

public void Dispose()

GetUserPreferencesAsync()

The current user's preferences, loaded from the store of truth.

public Task<PreferenceService> GetUserPreferencesAsync()

Returns

Task<PreferenceService>

Events

PreferencesChanged

Raised when the current user's preferences may have changed - the signed-in user changed, or preferences were saved - so preference-driven UI can re-read them.

public event Action? PreferencesChanged

Event Type

Action