EnvironmentDto Class

Describes an EnvironmentDto in MobileTrack: this can be a whole CompanyDto, or a location within a CompanyDto, or a department within that EnvironmentDto, etc.

Definition

Namespace: MobileTrack.Common.Models
Assembly: MobileTrack.Common (in MobileTrack.Common.dll) Version: 0.7+8b83d1d6d87116feed238ffdf489e0585a4f62d1
public sealed class EnvironmentDto : ICloneable<EnvironmentDto>, 
	ICompanyComponent, IHasEnvironment, IIdLabel, IHasCompany, IIsLocked, 
	IIsFourEyes, IIsFourEyesDelete, IIsFourEyesLock, IIsFourEyesRevertDelete, IIsFourEyesUnlock, 
	IIsFourEyesEdit, IHasVersion, IFreeFields, IModifiedStats, ICreatedStats, 
	IIsSoftDeletable, IHasMapMarkers, IHasGeofences, IHasLocation
Inheritance
Object    EnvironmentDto
Implements
ICloneableEnvironmentDto, ICompanyComponent, ICreatedStats, IFreeFields, IHasCompany, IHasEnvironment, IHasGeofences, IHasLocation, IHasMapMarkers, IHasVersion, IIdLabel, IIsFourEyes, IIsFourEyesDelete, IIsFourEyesEdit, IIsFourEyesLock, IIsFourEyesRevertDelete, IIsFourEyesUnlock, IIsLocked, IIsSoftDeletable, IModifiedStats

Constructors

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

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)
EnvironmentIdEnvironmentDto reference for an object. For example, the environment where a DeviceDto is located.
FourEyesDeleteRequestedBy The Id of the user who requested the review.
FourEyesEditConfirmedBy The User's id who confirmed the review.
FourEyesEditRequestedBy The User's id who requested the review.
FourEyesLockRequestedBy The Id of the user who requested the review.
FourEyesRevertDeleteRequestedBy The Id of the user who requested the review.
FourEyesUnlockRequestedBy The Id of the user who requested the review.
FreeBooleanFieldOne Free Boolean field (for custom work or extra information)
FreeBooleanFieldThree Free Boolean field (for custom work or extra information)
FreeBooleanFieldTwo Free Boolean field (for custom work or extra information)
FreeDateTimeFieldOne Free DateTime number field (for custom work or extra information)
FreeDateTimeFieldThree Free DateTime number field (for custom work or extra information)
FreeDateTimeFieldTwo Free DateTime number field (for custom work or extra information)
FreeNumberFieldOne Free Double number field (for custom work or extra information)
FreeNumberFieldThree Free Double number field (for custom work or extra information)
FreeNumberFieldTwo Free Double number field (for custom work or extra information)
FreeTextFieldOne Free String text field (for custom work or extra information)
FreeTextFieldThree Free String text field (for custom work or extra information)
FreeTextFieldTwo Free String text field (for custom work or extra information)
Geofences The list of geofences associated with this object.
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.
IsFourEyesDeleteRequested Is the deleting object requested to be reviewed by a second person?
IsFourEyesEditConfirmed Is the editing object request confirmed by a second person?
IsFourEyesEditRequested Is the editing object requested to be reviewed by a second person?
IsFourEyesLockRequested Is the locking object requested to be reviewed by a second person?
IsFourEyesRevertDeleteRequested Is the revert-deleting object requested to be reviewed by a second person?
IsFourEyesUnlockRequested Is the unlocking object requested to be reviewed by a second person?
IsImplicitLock Has the object been locked implicitly?
IsLocked Has the object been locked?
Label The label representing the object to the user. Empty or are not valid values for this property!
LastLocationFix When the last known Gps Fix was made to this device (if applicable)
LastModifiedAt When this object was last modified
LastModifiedBy The AccountDto user that last modified this business object
Location The last known Gps fix of this item (if applicable)
LockedBy Represents an AccountDto object.
LockedWhen The date and time when the object was locked.
MapMarkers The ListT of MapMarkers associated with the object, or if none are associated.
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

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)
IsEnvironmentValid Checks whether the EnvironmentDto object is properly filled in.
(Defined by ModelValidatorsExtensions)
IsFourEyesRequested Check if four-eyes is requested for a resource.
(Defined by ModelFourEyesExtensions)
IsIdAndLabelValid Checks whether the Id and Label have been properly entered.
(Defined by ModelValidatorsExtensions)
IsItemLocked return True if the item is locked.
(Defined by ModelGenericExtensions)
IsItemLockedByAnotherUser return True if user can unlock resource.
(Defined by ModelGenericExtensions)
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)
PolishFreeFields Polishes extra fields of an object.
(Defined by ModelPolishExtensions)
RemoveFourEyesProperties Removes four-eyes properties from an ICompanyComponent resource.
(Defined by ModelFourEyesExtensions)
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)
SetLockedNow Set item as locked
(Defined by ModelGenericModifiers)
SetModifiedNow Change modified by stats to DateTime.UtcNow
(Defined by ModelGenericModifiers)
SetUnlocked Set item as unlocked
(Defined by ModelGenericModifiers)
TrimLabel Trim the label of IIdLabel object.
(Defined by ModelGenericModifiers)

See Also