TemplateDto Class

Represents a template object consisting of a list of parameters and a list of localizations

Definition

Namespace: MobileTrack.Common.Models.Templates
Assembly: MobileTrack.Common (in MobileTrack.Common.dll) Version: 0.7+ce90b2cf6b782b8d7b7fd47b3c546987c652c00f
C#Request Example
public sealed class TemplateDto : ICloneable<TemplateDto>, 
	IIdLabel, IHasCompany, IModifiedStats, ICreatedStats, IHasVersion, 
	IIsSoftDeletable
Inheritance
Object    TemplateDto
Implements
ICloneableTemplateDto, ICreatedStats, IHasCompany, IHasVersion, IIdLabel, IIsSoftDeletable, IModifiedStats

Remarks

A template can be used for emails, SMS, XML, JSON or other strings that can be edited to fit the needs of the CompanyDto in question (or be company-agnostic).
They're localized so that the same template can be used for multiple languages.

Constructors

TemplateDto Internal constructor for serialization. Do not use; If you need to create a new instance of this class, use ModelFactory methods instead.

Properties

CompanyId Represents the CompanyDto owning this object.
CreatedAt When this object was created.
CreatedBy The AccountDto user who created this business object.
DeletedByAccountDto user that deleted the item. User can only be a member of the CompanyDto or MobileTrack support. If the item isn't deleted, the value must be , not Empty!
DeletionDate Date when the item was deleted (if applicable)
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.
IsDeleted If , the item has been soft deleted and only exists for logging purposes or to be reclaimed later. It also means DeletedBy must be set.
Label The label representing the object to the user. Empty or are not valid values for this property!
LastModifiedAt When this object was last modified
LastModifiedBy The AccountDto user that last modified this business object
Localizations List of localizations for the template
Parameters List of parameters for the template
Type The type of template
VersionNumber Version number of the item. This number can only be increased, never decreased.

Methods

Clone Clones the current instance of the object.

Extension Methods

FillInTemplate Fills in the template with the given parameters.
(Defined by ModelGenericExtensions)
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)
IsModifiedStatsValid Checks whether the model is properly filled in.
(Defined by ModelValidatorsExtensions)
IsSoftDeletePermanentExpired Gets the DateTime until a soft-deleted item is to be permanently deleted.
(Defined by ModelGenericExtensions)
IsTemplateValid Checks whether the Dashboard object is properly filled in.
(Defined by ModelValidatorsExtensions)
RevertDeletion Reverts the soft deletion of an item.
(Defined by ModelGenericModifiers)
SetDeletedNow Set item as soft deleted.
(Defined by ModelGenericModifiers)
SetDeletedNow Set item as soft deleted.
(Defined by ModelGenericModifiers)
SetModifiedNow Change modified by stats to DateTime.UtcNow
(Defined by ModelGenericModifiers)
TrimLabel Trim the label of IIdLabel object.
(Defined by ModelGenericModifiers)

See Also