Geofence class abstract

Available extensions

• GeofencePatterns

Annotations

• @freezed

Constructors

Geofence({required String id, required String name, @JsonKey.new(unknownEnumValue: GeofenceMode.radial) required GeofenceMode mode, String? description, @ColorOrNullConverter() Color? color, List<GeofencePoint>? path, double? radius, String? resourceId, List<Asset>? assetsInside, @JsonKey.new(unknownEnumValue: GeofenceCategory.none) @Default.new(GeofenceCategory.none) GeofenceCategory category, List<String>? childrenIds, List<Geofence>? children, List<Access>? access, List<CustomField>? customFields, String? ownerId, User? owner, List<MappitRoute>? mappitRoutes, List<String>? mappitRouteIds, String? assetId})

const

factory

Geofence.fromJson(Map<String, dynamic> json)

factory

Properties

access → List<Access>?

List of custom access permissions.

no setter, inherited

assetId → String?

assetId refers to the asset to which the geofence is linked.

no setter, inherited

assetsInside → List<Asset>?

List of assets inside the geofence.

no setter, inherited

category → GeofenceCategory

category refers to the type of geofence, by default is GeofenceCategory.none when is requested from the API.

no setter, inherited

children → List<Geofence>?

children refers to the list of children geofences.

no setter, inherited

childrenIds → List<String>?

childrenIds refers to the list of children geofences.

no setter, inherited

color → Color?

Color of the geofence in hexadecimal code.

no setter, inherited

copyWith → $GeofenceCopyWith<Geofence>

Create a copy of Geofence with the given fields replaced by the non-null parameter values.

no setter, inherited

customFields → List<CustomField>?

List of customFields linked to the geofence. Please read the documentation for CustomField for more details about the fields.

no setter, inherited

description → String?

Description of the geofence.

no setter, inherited

hashCode → int

The hash code for this object.

no setter, inherited

id → String

ID of the geofence entity. This ID is unique.

no setter, inherited

mappitRouteIds → List<String>?

mappitRouteIds refers to the list of routes that are linked to the geofence.

no setter, inherited

mappitRoutes → List<MappitRoute>?

mappitRoutes refers to the list of routes that are linked to the geofence.

no setter, inherited

mode → GeofenceMode

Mode of geofence, check the documentation of GeofenceMode for more information.

no setter, inherited

name → String

Name of the geofence.

no setter, inherited

owner → User?

owner refers to the owner of the geofence.

no setter, inherited

ownerId → String?

ownerId refers to the owner of the geofence.

no setter, inherited

path → List<GeofencePoint>?

Depending of the Geofence mode, this field may return one or N points. Please check the GeofenceMode definition

no setter, inherited

radius → double?

Radius of the geofence in meters. If mode is GeofenceMode.LINEAR, this field will be the weight of the geofence. For GeofenceMode.POLYGON, this field will be ignored.

no setter, inherited

resourceId → String?

External resource ID, only for external geofences.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

map<TResult extends Object?>(TResult $default(_Geofence value)) → TResult

Available on Geofence, provided by the GeofencePatterns extension

A switch-like method, using callbacks.

mapOrNull<TResult extends Object?>(TResult? $default(_Geofence value)?) → TResult?

Available on Geofence, provided by the GeofencePatterns extension

A variant of map that fallback to returning null.

maybeMap<TResult extends Object?>(TResult $default(_Geofence value)?, {required TResult orElse()}) → TResult

Available on Geofence, provided by the GeofencePatterns extension

A variant of map that fallback to returning orElse.

maybeWhen<TResult extends Object?>(TResult $default(String id, String name, GeofenceMode mode, String? description, Color? color, List<GeofencePoint>? path, double? radius, String? resourceId, List<Asset>? assetsInside, GeofenceCategory category, List<String>? childrenIds, List<Geofence>? children, List<Access>? access, List<CustomField>? customFields, String? ownerId, User? owner, List<MappitRoute>? mappitRoutes, List<String>? mappitRouteIds, String? assetId)?, {required TResult orElse()}) → TResult

Available on Geofence, provided by the GeofencePatterns extension

A variant of when that fallback to an orElse callback.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toJson() → Map<String, dynamic>

Serializes this Geofence to a JSON map.

inherited

toString() → String

A string representation of this object.

inherited

when<TResult extends Object?>(TResult $default(String id, String name, GeofenceMode mode, String? description, Color? color, List<GeofencePoint>? path, double? radius, String? resourceId, List<Asset>? assetsInside, GeofenceCategory category, List<String>? childrenIds, List<Geofence>? children, List<Access>? access, List<CustomField>? customFields, String? ownerId, User? owner, List<MappitRoute>? mappitRoutes, List<String>? mappitRouteIds, String? assetId)) → TResult

Available on Geofence, provided by the GeofencePatterns extension

A switch-like method, using callbacks.

whenOrNull<TResult extends Object?>(TResult? $default(String id, String name, GeofenceMode mode, String? description, Color? color, List<GeofencePoint>? path, double? radius, String? resourceId, List<Asset>? assetsInside, GeofenceCategory category, List<String>? childrenIds, List<Geofence>? children, List<Access>? access, List<CustomField>? customFields, String? ownerId, User? owner, List<MappitRoute>? mappitRoutes, List<String>? mappitRouteIds, String? assetId)?) → TResult?

Available on Geofence, provided by the GeofencePatterns extension

A variant of when that fallback to returning null

Operators

operator ==(Object other) → bool

The equality operator.

inherited