Property AdditionalSourceProperties

AdditionalSourceProperties

Gets a set of key-value pairs providing additional meta-data and properties about the source of this Location.

Declaration

public IReadOnlyDictionary<string, object?> AdditionalSourceProperties { get; }

Property Value

Type	Description
IReadOnlyDictionary<String, System.Nullable<System.Object>>	A set of key-value pairs providing additional meta-data and properties about the source of this Location.

Remarks

A Location object can be created manually or by a variety of LocationDataSource types for example from the default platform data source or external GPS. When user code receives a new Location, it can be important to determine how the information was obtained.

In addition, mobile devices may provide different details about their in-built location services. For example, Android systems can provide data on the number of satellites used to find a position, whereas on iOS this information is not available. When a given property is not available to the data source the entry should be omitted from the AdditionalSourceProperties dictionary.

The AdditionalSourceProperties property provides a means for the creator of a Location object to record flexible information such as:

• The confidence level associated with the location.
• The method used to obtain the location.
• The provenance of the location.

Information is provided as a set of key-value pairs, where the Location key describes the type of data held in the value. Values must be basic data types such as string, numeric, boolean or date. The creator of the Location can use any string for the key - but the Runtime SDK recognizes a number of well known keys which should be used if available. See LocationSourcePropertyKeys:

• floor (an integer value). The floor number of the Location when in a building. Use Floor to reference this key.
• satelliteCount (an integer value). The number of satellites used to fix the Location. Use SatelliteCount to reference this key.
• positionSource (a string value). This key can be used to indicate the position source: GNSS, AppleIPS, BLE, WIFI, CELL, IP. GNSS indicates global navigation satellite system and AppleIPS is Apple’s indoor positioning technology. It is possible to have multiple position sources. In that case positionSource is a list with comma-separated values. Use PositionSource to reference this key.

Keys are case-sensitive.

This collection is read-only and can only be assigned via the constructor.

Applies to

Platforms and versions

Target	Versions
.NET Standard 2.0	100.10 - 100.15
.NET 6.0	100.13 - 100.15
.NET 6.0 Windows	100.13 - 100.15
.NET Framework	100.10 - 100.15
.NET 5	100.10 - 100.12
.NET Core 3.1	100.10 - 100.12
Xamarin.Android	100.10 - 100.15
Xamarin.iOS	100.10 - 100.15
UWP	100.10 - 100.15