DeviceDto Class

Interface for a device, whether it be a phone, beacon, tracker or a smart fridge.

Definition

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

C#Request Example

public sealed class DeviceDto : ICloneable<DeviceDto>, 
	IEquatable<DeviceDto>, ICompanyComponent, IHasEnvironment, IIdLabel, 
	IHasCompany, IIsLocked, IIsFourEyes, IIsFourEyesDelete, IIsFourEyesLock, 
	IIsFourEyesRevertDelete, IIsFourEyesUnlock, IIsFourEyesEdit, IHasVersion, IModifiedStats, 
	ICreatedStats, IIsActive, IFreeFields, IHasAccount, IHasGeofences, 
	IHasImageReference, IHasPhoneNumber, IIsSoftDeletable, IHasMapMarkers, IHasLocation, 
	IHasTimeZone

Inheritance: Object DeviceDto

Constructors

DeviceDto

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

Properties

AccountId	AccountDto that is attached to the item.
AllowGps	Whether to allow the device to use the GPS.
AlternateConnectionString	Connection string if Imei and MacAddress aren't suitable for this device.
AuthorizedNumbers	Numbers authorized to call this device.
AuthorizedOnly	Whether the device should allow only authorized numbers to call it.
AutomaticScreenTurnOff	Set the time, in seconds, to automatically turn the screen off.
BatteryAlarmOnFullCharge	Whether the device should sound an alarm when the battery is fully charged.
BatteryAlarmThreshold	The battery alarm threshold of the device, measured in percentages of the battery of the device.
BatteryLevel	Battery level of this Device (if applicable)
CallAutomaticAnswer	Whether the device should automatically answer calls.
CallMode	The call mode of the device.
CallVolume	Call audio volume of the device.
CollisionAlarmThreshold	The collision alarm threshold of the device, measured in meters distance from the device.
CompanyId	Represents the CompanyDto owning this object.
ConfiguredPort	Configured Port (for TCP communications to the device; optional)
ContinuousTracking	Whether Continuous Tracking is enabled on the device.
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)
DeviceEndPoint	The endpoint to call.
DeviceOrientation	The screen orientation of the device.
DeviceTemperature	Some devices have a temperature sensor; this is the current temperature of the device, measured in Celsius.
EnvironmentId	EnvironmentDto reference for an object. For example, the environment where a DeviceDto is located.
FallDownThreshold	Threshold for the device to detect a fall down.
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.
FourEyesRebuildRequestedBy	The user that requested a rebuild of the device. (Deleting, then re-adding the device to the system)
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.
GprsOn	Whether GPRS is turned on.
GpsOn	Whether GPS is turned on.
HeartBeatInterval	The heart beat interval (in seconds) of the device.
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
Imei	The unique Imei code of this device
InDisallowedLocation	Only applies to devices that transmit their location; This value is set by the Alert Monitor systems if the device is outside its allocated geofence(s). (or inside a geofence it is not allowed to be in)
InEmergencyState	Whether the device is in an emergency state (e.g. from pressing an SOS button, or an activated sensor). Only the Alert Monitor system can set this value.
IsActive	Is the object active
IsCharging	if the device is charging its battery.
IsConnectedToPowerOutlet	If the device is connected to a power outlet.
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
LastStatusCodeChange	Denotes the last time the status code was changed.
LicenseCode	The License code of this device
LicenseExpirationDate	When the License code of this will expire
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.
LoggingMode	The logging mode of the device.
MacAddress	The MAC Address of this device (optional)
MapMarkers	The ListT of MapMarkers associated with the object, or if none are associated.
OverSpeedAlarmThreshold	The over-speed alarm threshold of the device, measured in kilometers per hour.
Password	The password of the device. If set, we will store the password in the IAzureKeyVault. The string is only there during form submission; it must be set to Empty after the device has picked it up!
PhoneNumber	Represents a phone number of a user.
PukCode	PUK Code of this device's SIM Card (if applicable)
SimCardNumber	SIM Card number of this device's SIM Card(if applicable)
StatusCode	Status of the device (range 0-1000)
TimeZone	The timezone of the device.
UsePhoneOnCriticalAlarm	Whether to call the AuthorizedNumbers on a critical alarm.
UserName	The username the device can use for logging-in purposes.
UseVoiceMailRecognition	Whether the device should use voice mail recognition.
VersionNumber	Version number of the item. This number can only be increased, never decreased.

Methods

Clone	Clones the current instance of the object.
Equals(DeviceDto)	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)
IsDeviceValid	Checks whether the Environment object is properly filled in. (Defined by ModelValidatorsExtensions)
IsFourEyesRequested	Check if four-eyes is requested for a resource. (Defined by ModelFourEyesExtensions)
IsHasAccountValid	Checks if the account field is properly filled in. (Defined by ModelValidatorsExtensions)
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)
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)