GeofenceDto Class

A virtual geographic boundary, defined by GPS or RFID technology, that enables software to trigger a response when a mobile device enters or exits the specified area.
For our use case, we apply these objects to DeviceDto and EnvironmentDto objects using the IHasGeofences interface.

Definition

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

C#Request Example

public sealed class GeofenceDto : IIdLabel

Inheritance: Object GeofenceDto

Implements: IIdLabel

Remarks

The geofence uses the position of the DeviceDto or EnvironmentDto as its orientation point if IsRelative is . Otherwise, the geofence is absolute.

Constructors

GeofenceDto

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

Properties

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.
IsRelative	If , the position of the geofence is relative to the DeviceDto or EnvironmentDto it is associated with.
Label	The label representing the object to the user. Empty or are not valid values for this property!
MapMarkerId	The MapMarkerDto this geofence retrieves its styling from. (Border, background color, etc.)
Points	Relevant if Type is LineStrip or Polygon, otherwise . Not allowed to be or empty (Length == 0) if relevant.
Radius	The size of the geofence, if the MapMarkerId it is associated with is a Point (Circle, star, etc.).
ZIndex	The depth of the geofence in the Z-axis. This is used to determine which geofence is on top of another. The lower the value, the more to the back the geofence is.

Extension Methods

GenerateCircleOptions	Generates a CircleOptions for a GeofenceDto based on the provided mapMarker and position. (Defined by MapsExtensions)
GenerateFourEyesRequestedMessage	Generates a toast message for a four-eyes request, letting the user know it had been submitted properly. (Defined by FourEyesExtensions)
GeneratePolygonOptions	Generates a PolygonOptions for a GeofenceDto based on the provided mapMarker and map. (Defined by MapsExtensions)
GeneratePolyLineOptions	Generates a PolylineOptions for a GeofenceDto based on the provided mapMarker and map. (Defined by MapsExtensions)
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)
IsGeofenceValid	Checks whether the GeofenceDto object is properly filled in. (Defined by ModelValidatorsExtensions)
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)
TrimLabel	Trim the label of IIdLabel object. (Defined by ModelGenericModifiers)