CompanyDto Class

Represents a customer of MobileTrack.

A company can be an organization, a business, or a private person. It can also be a business which has multiple B2B customers for whom they provide services. Those B2B customers are not represented as individual CompanyDto's, but can be organised as EnvironmentDto's within the company.

Definition

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

C#Request Example

public sealed class CompanyDto : ICloneable<CompanyDto>, 
	IEquatable<CompanyDto>, IIdLabel, IIsActive, IHasCountry, 
	IHasImageReference, IFreeFields, IModifiedStats, ICreatedStats, IIsSoftDeletable, 
	IHasLanguage, IIsLocked, IIsFourEyes, IIsFourEyesDelete, IIsFourEyesLock, 
	IIsFourEyesRevertDelete, IIsFourEyesUnlock, IIsFourEyesExpireLicense, IIsFourEyesActivateLicense, IIsLicenseExpired, 
	IHasTimeZone, IHasVersion

Inheritance: Object CompanyDto

Remarks

A company owns AccountDto's (users who can sign in and perform actions), EnvironmentDto's (logical groupings within the company, such as departments or locations), and DeviceDto's (physical devices that are used by the users within the company). A company can also have their own ActionFlowDefinitionDto's, MapMarkerDto's and other business objects specifically designated for the company.

Constructors

CompanyDto

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

Properties

AccountFreeFieldLabels	Represent free field labels the company can assign to AccountDtos, if UseExtraFields is
AllowDeleteFilledEnvironments	Allow the deletion of an EnvironmentDto if it isn't empty yet. (Except the MainEnvironment)
CountryCode	Alpha2 value of the Iso3166 code of the country.
CreatedAt	When this object was created.
CreatedBy	The AccountDto user who created this business object.
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)
DeviceFreeFieldLabels	Represent free field labels the company can assign to DeviceDtos, if UseExtraFields is
DisallowMobileTrackInsights	If set to , MobileTrack support isn't allowed to see the contents of the company. (Except the name, logo, icon and subscription status)
EnvironmentFreeFieldLabels	Represent free field labels the company can assign to EnvironmentDtos, if UseExtraFields is
FourEyesDeleteRequestedBy	The Id of the user who requested the review.
FourEyesLicenseActivateRequestedBy	The Id of the user who requested the activated property.
FourEyesLicenseExpiredRequestedBy	The Id of the user who requested the expired property.
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)
Icon	Icon (favicon) to be shown on the tab of the browser
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
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.
IsFourEyesDeleteRequested	Is the deleting object requested to be reviewed by a second person?
IsFourEyesLicenseActivatedRequested	Is the activated object requested to be reviewed by a second person?
IsFourEyesLicenseExpiredRequested	Is the expired 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?
IsLicenseExpired	Returns true if the company's license has expired
IsLocked	Has the object been locked?
ItemsCanBeImmediatelyDeleted	Whether items can be permanently deleted () or are soft-deleted (); See IIsSoftDeletable
ItemsDeletionThresholdInDays	If ItemsCanBeImmediatelyDeleted is , then this is the amount of days after which items are allowed to be permanently deleted from the trash bin.
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
LicenseExpiredBy	Represents an AccountDto object.
LicenseExpiredWhen	The date and time when the resource license was expired.
LockedBy	Represents an AccountDto object.
LockedWhen	The date and time when the object was locked.
LogRetentionInDays	The amount of days that logs are retained for this company.
MainEnvironment	represents the main EnvironmentDto of the company from which other sub-environments spawn
MainManagerAccount	Optional: AccountDto assigned as superuser of this company.
MfaExpireWhen	The expiration date and time for multifactor authentication (MFA).
RequireFourEyes	Whether heavy actions (deleting items, etc.) requires confirmation from others. If , this will apply to MobileTrack employees working with their data as well.
RequireMfa	Indicates if the company requires two-factor authentication for its users.
SasKeyExpiration	When generating SAS tokens for referral links, we make use of the Azure KeyVault. These settings determine how long a version of an encryption key can be used after it has been generated/rotated. It does not affect the lifetime of the SAS token itself,
SoftDeletedItemsDaysUntilPermanent	If SoftDeletedItemsHasCountDown is , this is the amount of days until that deletion is permanent.
SoftDeletedItemsHasCountDown	If ItemsCanBeImmediatelyDeleted is and if this boolean is , then soft-deleted items will be deleted after a period of time determined by SoftDeletedItemsDaysUntilPermanent
TimeZone	Assigned timezone of the object. If , the object will use the default timezone of the assigned owning CompanyDto. Failing that, UTC.
UseExtraFields	If enabled, the CompanyDto can use IFreeFields properties on AccountDto, DeviceDto, EnvironmentDto, etc.
VersionNumber	Version number of the item. This number can only be increased, never decreased.

Methods

Clone	Clones the current instance of the object.
Equals(CompanyDto)	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)
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)
IsCompanyValid	Checks whether the CompanyDto 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)
RemoveFourEyesCompanyProperties	Removes four-eyes properties from an CompanyDto 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)
SetLicenseActive	Set item's license as active (Defined by ModelGenericModifiers)
SetLicenseExpired	Set item's license as expired (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)