Class OptionalModule

A module whose install task can be missing from the pipeline profile, or can fail, without halting the boot — so every service it publishes may be absent while the game runs, and each consumer of those services needs a defined behaviour for that case.

Inheritance

object

OptionalModule

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

Namespace: Serenity.Global.Application.Services

Assembly: Serenity.Global.Application.dll

Syntax

public sealed class OptionalModule

Remarks

Carries only names, never the module's types: the catalog of these (OptionalModules) lives in the global assembly, which every module references and none of them is referenced by.

Constructors

OptionalModule(string, string)

Describes one optional module.

Declaration

public OptionalModule(string displayName, string installTaskName)

Parameters

Type	Name	Description
string	displayName	The module's name as the author reads it in the tools.
string	installTaskName	The Initialization Pipeline task that installs the module.

Properties

DisplayName

The module's name as the author reads it in the tools.

Declaration

public string DisplayName { get; }

Property Value

Type	Description
string

InstallTaskName

The Initialization Pipeline task that installs the module.

Declaration

public string InstallTaskName { get; }

Property Value

Type	Description
string