SettingsDto Class

A settings model that determines the look and feel of the portal for a particular CompanyDto, EnvironmentDto or AccountDto.
Note: the Id of this object is the object it is applied to.

Note: style sheet elements in this class references controls made in Figma

Definition

Namespace: MobileTrack.Common.Models
Assembly: MobileTrack.Common (in MobileTrack.Common.dll) Version: 0.7+ce90b2cf6b782b8d7b7fd47b3c546987c652c00f

C#Request Example

public sealed class SettingsDto : ICloneable<SettingsDto>, 
	IIdLabel, IHasLanguage

Inheritance: Object SettingsDto

Implements: ICloneableSettingsDto, IHasLanguage, IIdLabel

Constructors

SettingsDto

Constructor is only usable in the Common assembly; to instantiate new objects, use ModelFactory methods.

Properties

BackgroundColor	The color used for the footer in the portal.
DarkTheme	If the company/environment/user uses Dark theme as default
HeaderColor	The color used for the header in the portal.
Id	The unique ID representing the object. Empty is not valid! This ID is used when other objects are referring to this object, and as the main ID in the Azure Cosmos database.
Label	The label representing the object to the user. Empty or are not valid values for this property!
Language	The main localization culture of the company/environment/user. If none are selected, English is set as default.
ShowHints	Whether to show tooltip hints on item overlays. Useful for new users, not so much for experienced ones.
TextColor	The color used for text in the portal.

Methods

Clone

Clones the current instance of the object.

Extension Methods

GenerateFourEyesRequestedMessage	Generates a toast message for a four-eyes request, letting the user know it had been submitted properly. (Defined by FourEyesExtensions)
GenerateToastMessageForAction	Generates a toast message for the specified action. (Defined by WebExtensions)
GenerateToastMessageForFourEyesCancelled	Generates Toast message for when a four-eyes request has been denied (Defined by WebExtensions)
GenerateToastMessageForItemCreation	Generates Toast message for when an item has been successfully created. (Defined by WebExtensions)
GenerateToastMessageForItemDeletion	Generates Toast message for when an item has been successfully deleted. (Defined by WebExtensions)
GenerateToastMessageForItemLicenseActivated	Generates Toast message for when an item has been successfully activated. (Defined by WebExtensions)
GenerateToastMessageForItemLicenseExpired	Generates Toast message for when an item's license has been successfully expired. (Defined by WebExtensions)
GenerateToastMessageForItemLock	Generates Toast message for when an item has been successfully locked. (Defined by WebExtensions)
GenerateToastMessageForItemRequestConfirmed	Generates Toast message for when an item request has been successfully confirmed. (Defined by WebExtensions)
GenerateToastMessageForItemRevertDelete	Generates Toast message for when an item has been successfully reverted deletion. (Defined by WebExtensions)
GenerateToastMessageForItemUnlock	Generates Toast message for when an item has been successfully unlocked. (Defined by WebExtensions)
GenerateToastMessageForItemUpdated	Generates Toast message for when an item has been successfully updated. (Defined by WebExtensions)
IdString	renders ID as a string for frontend brevity. (Defined by ModelGenericExtensions)
IsIdAndLabelValid	Checks whether the Id and Label have been properly entered. (Defined by ModelValidatorsExtensions)
IsLabelValid	Checks whether the Label field has a valid value; not , not whitespace (or beginning or ending with whitespace) and not only comprised of special characters. (Defined by ModelValidatorsExtensions)
IsSettingsValid	Checks if a settings model is properly filled in. (Defined by ModelValidatorsExtensions)
TrimLabel	Trim the label of IIdLabel object. (Defined by ModelGenericModifiers)