MobileTrack Nexus Documentation
Account
Represents a human being who is a user on the portal. A user can sign-in and perform actions in the MobileTrack portal based on their permissions scope.
For more information, visit
.
The documentation website outlines what an account is, what it is allowed to do, what the valid states are and how state affects behavior.
The documentation website outlines what an account is, what it is allowed to do, what the valid states are and how state affects behavior.
Definition
Namespace: MobileTrack.Common.Models
Assembly: MobileTrack.Common (in MobileTrack.Common.dll) Version: 0.7+ce90b2cf6b782b8d7b7fd47b3c546987c652c00f
Assembly: MobileTrack.Common (in MobileTrack.Common.dll) Version: 0.7+ce90b2cf6b782b8d7b7fd47b3c546987c652c00f
C#
public sealed class AccountDto : ICloneable<AccountDto>,
IEquatable<AccountDto>, ICompanyComponent, IHasEnvironment, IIdLabel,
IHasCompany, IIsLocked, IIsFourEyes, IIsFourEyesDelete, IIsFourEyesLock,
IIsFourEyesRevertDelete, IIsFourEyesUnlock, IIsFourEyesEdit, IHasVersion, IHasEmailAddress,
IHasPhoneNumber, IIsActive, IFreeFields, IModifiedStats, ICreatedStats,
IHasImageReference, IHasLanguage, IHasRole, IIsActivated, IIsSoftDeletable,
IHasMapMarkers, IHasTimeZone, IHasDashboard- Inheritance
- Object AccountDto
- Implements
- ICloneableAccountDto, ICompanyComponent, ICreatedStats, IFreeFields, IHasCompany, IHasDashboard, IHasEmailAddress, IHasEnvironment, IHasImageReference, IHasLanguage, IHasMapMarkers, IHasPhoneNumber, IHasRole, IHasTimeZone, IHasVersion, IIdLabel, IIsActivated, IIsActive, IIsFourEyes, IIsFourEyesDelete, IIsFourEyesEdit, IIsFourEyesLock, IIsFourEyesRevertDelete, IIsFourEyesUnlock, IIsLocked, IIsSoftDeletable, IModifiedStats, IEquatableAccountDto
Constructors
| AccountDto | Constructor is only usable in the Common assembly; to instantiate a new account, use the GenerateNewAccount(CompanyDto, EnvironmentDto, AccountDto, IStringLocalizer) method. |
Properties
| CompanyId | Represents the CompanyDto owning this object. |
| CreatedAt | When this object was created. |
| CreatedBy | The AccountDto user who created this business object. |
| DashboardId | Represents the DashboardDto owning this object. Empty is not allowed. |
| DeletedBy | AccountDto 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) |
| EmailAddress | Email Address applied to this business object. |
| EnvironmentId | EnvironmentDto reference for an object. For example, the environment where a DeviceDto is located. |
| FirstName | First name of the user |
| 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) |
| FullName | Full name of the user (derived from FirstName and LastName. Cannot be edited and won't be serialized to JSON) |
| 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. |
| Image | Image that can be associated to the Item |
| IsActivated | Determines if the item has been activated for the first time, e.g. an AccountDto being activated by its user. |
| IsActive | Is the object active |
| 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. |
| IsEmailAddressConfirmed | Determines whether the EmailAddress for this AccountDto has been confirmed or not. |
| 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? |
| IsMobileTrackAccount | If , then this AccountDto isn't bound to a company but rather is for MobileTrack support. |
| 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. |
| LastModifiedAt | When this object was last modified |
| LastModifiedBy | The AccountDto user that last modified this business object |
| LastName | Last name of the user |
| 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. |
| MfaEnabled | if the user has two-factor authentication enabled. |
| PhoneNumber | Represents a phone number of a user. |
| RoleId | Reference to its RoleDto. |
| TimeZone | Assigned timezone of the object. If , the object will use the default timezone of the assigned owning CompanyDto. Failing that, UTC. |
| VersionNumber | Version number of the item. This number can only be increased, never decreased. |
Methods
| Clone | Clones the current instance of the object. |
| Equals(AccountDto) | Indicates whether the current object is equal to another object of the same type. |
| Equals(Object) | Determines whether the specified object is equal to the current object. (Overrides ObjectEquals(Object)) |
| GetHashCode | Serves as the default hash function. (Overrides ObjectGetHashCode) |
Extension Methods
| DateTimeOffsetNow |
Generates a DateTimeOffset based on the current time and the business object's timezone.
(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) |
| GeneratePrincipal |
Generates a ClaimsPrincipal with the proper ClaimsIdentity (and Claims) for a website based on a user sign-in
(Defined by WebExtensions) |
| 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) |
| GenerateUrlToHomePage |
Generates a URL to the home page the currentUser is a part of
(Defined by UrlChecker) |
| IdString |
renders ID as a string for frontend brevity.
(Defined by ModelGenericExtensions) |
| IsAccountValid |
Checks whether the Account 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) |
| IsPhoneNumberValid |
Checks whether the PhoneNumber property has been properly filled in.
(Defined by ModelValidatorsExtensions) |
| IsSoftDeletePermanentExpired |
Gets the DateTime until a soft-deleted item is to be permanently deleted.
(Defined by ModelGenericExtensions) |
| PolishEmailAddress |
Polish the EmailAddress property of an object.
If the input is of invalid value, then the polish-pass is skipped.
(Defined by ModelPolishExtensions) |
| 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) |