SaaS CMS has officially launched! Learn more now.

AI OnAI Off

Class DojoConfig

Configuration settings used when initiating the Dojo Toolkit on the client.

Inheritance
System.Object
DojoConfig
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: EPiServer.Shell.UI
Assembly: EPiServer.Shell.dll
Version: 7.19.2
Syntax
public class DojoConfig
Remarks

These settings will be serialized to JSON.

Constructors

DojoConfig()

Initializes a new instance of the DojoConfig class.

Declaration
public DojoConfig()

Properties

Aliases

Gets a collection of aliases

Declaration
public IList<IEnumerable<string>> Aliases { get; }
Property Value
Type Description
System.Collections.Generic.IList<System.Collections.Generic.IEnumerable<System.String>>

Async

Gets or sets whether the config should be async.

Declaration
public bool Async { get; set; }
Property Value
Type Description
System.Boolean

DeferredInstrumentation

Gets if dojo should instrument the deferreds

Declaration
public bool DeferredInstrumentation { get; }
Property Value
Type Description
System.Boolean

Has

Gets the has configuration options.

Declaration
public IDictionary<string, object> Has { get; }
Property Value
Type Description
System.Collections.Generic.IDictionary<System.String, System.Object>

IoPublish

Gets or sets whether to publish IO.

Declaration
public bool IoPublish { get; set; }
Property Value
Type Description
System.Boolean

IsDebug

Gets or sets whether we are in debug mode.

Declaration
public bool IsDebug { get; set; }
Property Value
Type Description
System.Boolean

Locale

Gets or sets the localization to use.

Declaration
public string Locale { get; set; }
Property Value
Type Description
System.String

Packages

Gets a collection of packages

Declaration
public IList<object> Packages { get; }
Property Value
Type Description
System.Collections.Generic.IList<System.Object>

ParseOnLoad

Gets or sets whether the config should be parsed on load.

Declaration
public bool ParseOnLoad { get; set; }
Property Value
Type Description
System.Boolean

Paths

Gets or sets a collection of modules and their paths.

Declaration
public IDictionary<string, string> Paths { get; }
Property Value
Type Description
System.Collections.Generic.IDictionary<System.String, System.String>

ServerTime

Gets current datetime of server

Declaration
public DateTime ServerTime { get; }
Property Value
Type Description
System.DateTime

UseDeferredInstrumentation

If DeferredInstrumtation is true report unhandled rejections

Declaration
public string UseDeferredInstrumentation { get; }
Property Value
Type Description
System.String

Methods

Serialize()

Serializes this configuration to a JSON formatted string.

Declaration
public string Serialize()
Returns
Type Description
System.String

A JSON formatted string of the Dojo configuration.

Events

Serializing

Exposes the BeforeSerializing event which is raised before the DojoConfig instance is serialized.

Declaration
public static event EventHandler Serializing
Event Type
Type Description
System.EventHandler

Extension Methods