-Prefix:4.0.0\r
-Suffix:preview1-00066\r
-Number:66\r
-VCS:c88bd33b98294e125f1e69237fedd9d2596c02a7\r
+Prefix:4.0.0
+Suffix:preview1-00071
+Number:71
+VCS:26e8e101de6555ba7992a418d977129964a3b88a
Name: csapi-tizenfx
Summary: Assemblies of Tizen .NET
-Version: 4.0.0.66
+Version: 4.0.0.71
Release: 1
Group: Development/Libraries
License: Apache-2.0
namespace Tizen.Location.Geofence
{
/// <summary>
- /// Geo-fence defines a virtual perimeter for a real-world geographic area.
- /// If you create a geofence, you can trigger some activities when a device enters(or exits) the geofences defined by you.
- /// You can create a geofence with the information of Geopoint, Wi-Fi, or BT.
+ /// Geofence defines a virtual perimeter for a real-world geographic area.
+ /// If you create a geofence, you can trigger some activities when a device enters (or exits) the geofences defined by you.
+ /// You can create a geofence with the information of the Geopoint, Wi-Fi, or BT.
/// <list>
- /// <item>Geopoint: Geofence is specified by coordinates (Latitude and Longitude) and Radius</item>
- /// <item>WIFI: Geofence is specified by BSSID of Wi-Fi access point</item>
- /// <item>BT: Geofence is specified by Bluetooth address</item>
+ /// <item>Geopoint: Geofence is specified by the coordinates (Latitude and Longitude) and radius.</item>
+ /// <item>WIFI: Geofence is specified by the BSSID of the Wi-Fi access point.</item>
+ /// <item>BT: Geofence is specified by the Bluetooth address.</item>
/// </list>
- /// Basic service set identification(BSSID) The BSSID is the MAC address of the wireless access point(WAP) generated by combining the 24 bit Organization Unique Identifier(the manufacturer's identity)
+ /// The Basic service set identifier (BSSID) is the MAC address of the wireless access point (WAP) generated by combining the 24-bit Organization Unique Identifier (the manufacturer's identity)
/// and the manufacturer's assigned 24-bit identifier for the radio chipset in the WAP.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public class Fence : IDisposable
{
private bool _disposed = false;
/// <summary>
/// Gets the type of geofence.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public FenceType Type
{
get
}
/// <summary>
- /// Gets the id of place.
+ /// Gets the ID of the place.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public int PlaceId
{
get
/// <summary>
/// Gets the longitude of geofence.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public double Longitude
{
get
/// <summary>
/// Gets the latitude of geofence.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public double Latitude
{
get
/// <summary>
/// Gets the radius of geofence.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public int Radius
{
get
/// <summary>
/// Gets the address of geofence.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public string Address
{
get
}
/// <summary>
- /// Gets the bssid of geofence.
+ /// Gets the BSSID of geofence.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public string Bssid
{
get
}
/// <summary>
- /// Gets the ssid of geofence.
+ /// Gets the SSID of geofence.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public string Ssid
{
get
}
/// <summary>
- /// Creates a geopoint type of new geofence.
+ /// Creates a geopoint type of the new geofence.
/// </summary>
- /// <since_tizen>3</since_tizen>
- /// <param name="placeId">The current place id.</param>
- /// <param name="latitude">Specifies the value of latitude of geofence [-90.0 ~ 90.0] (degrees).</param>
- /// <param name="longitude">Specifies the value of longitude of geofence [-180.0 ~ 180.0] (degrees).</param>
- /// <param name="radius">Specifies the value of radius of geofence [100 ~ 500](meter).</param>
- /// <param name="address">Specifies the value of address.</param>
- /// <returns>Newly created geofence instance.</returns>
- /// <exception cref="ArgumentException">Incase of Invalid parameter.</exception>
- /// <exception cref="InvalidOperationException">Incase of any System error.</exception>
- /// <exception cref="NotSupportedException">Incase of Geofence is not supported.</exception>
+ /// <since_tizen> 3 </since_tizen>
+ /// <param name="placeId">The current place ID.</param>
+ /// <param name="latitude">Specifies the value of latitude of the geofence [-90.0 ~ 90.0] (degrees).</param>
+ /// <param name="longitude">Specifies the value of longitude of the geofence [-180.0 ~ 180.0] (degrees).</param>
+ /// <param name="radius">Specifies the value of radius of the geofence [100 ~ 500](meter).</param>
+ /// <param name="address">Specifies the value of the address.</param>
+ /// <returns>The newly created geofence instance.</returns>
+ /// <exception cref="ArgumentException">In case of an invalid parameter.</exception>
+ /// <exception cref="InvalidOperationException">In case of any system error.</exception>
+ /// <exception cref="NotSupportedException">In case the geofence is not supported.</exception>
public static Fence CreateGPSFence(int placeId, int latitude, int longitude, int radius, string address)
{
IntPtr handle = IntPtr.Zero;
}
/// <summary>
- /// Creates a Wi-Fi type of new geofence.
+ /// Creates a Wi-Fi type of the new geofence.
/// </summary>
- /// <since_tizen>3</since_tizen>
- /// <param name="placeId">The current place id.</param>
- /// <param name="bssid">Specifies the value of BSSID of Wi-Fi MAC address.</param>
- /// <param name="ssid"> Specifies the value of SSID of Wi-Fi Device.</param>
- /// <returns>Newly created geofence instance.</returns>
- /// <exception cref="ArgumentException">Incase of Invalid parameter.</exception>
- /// <exception cref="InvalidOperationException">Incase of any System error.</exception>
- /// <exception cref="NotSupportedException">Incase of Geofence is not supported.</exception>
+ /// <since_tizen> 3 </since_tizen>
+ /// <param name="placeId">The current place ID.</param>
+ /// <param name="bssid">Specifies the value of BSSID of the Wi-Fi MAC address.</param>
+ /// <param name="ssid"> Specifies the value of SSID of the Wi-Fi device.</param>
+ /// <returns>The newly created geofence instance.</returns>
+ /// <exception cref="ArgumentException">In case of an invalid parameter.</exception>
+ /// <exception cref="InvalidOperationException">In case of any system error.</exception>
+ /// <exception cref="NotSupportedException">In case the geofence is not supported.</exception>
public static Fence CreateWifiFence(int placeId, string bssid, string ssid)
{
IntPtr handle = IntPtr.Zero;
}
/// <summary>
- /// Creates a bluetooth type of new geofence.
+ /// Creates a Bluetooth type of the new geofence.
/// </summary>
- /// <since_tizen>3</since_tizen>
- /// <param name="placeId">The current place id.</param>
+ /// <since_tizen> 3 </since_tizen>
+ /// <param name="placeId">The current place ID.</param>
/// <param name="bssid">Specifies the value of BSSID of BT MAC address.</param>
/// <param name="ssid"> Specifies the value of SSID of BT Device.</param>
- /// <returns>Newly created geofence instance.</returns>
- /// <exception cref="ArgumentException">Incase of Invalid parameter.</exception>
- /// <exception cref="InvalidOperationException">Incase of any System error.</exception>
- /// <exception cref="NotSupportedException">Incase of Geofence is not supported.</exception>
+ /// <returns>The newly created geofence instance.</returns>
+ /// <exception cref="ArgumentException">In case of an invalid parameter.</exception>
+ /// <exception cref="InvalidOperationException">In case of any system error.</exception>
+ /// <exception cref="NotSupportedException">In case the geofence is not supported.</exception>
public static Fence CreateBTFence(int placeId, string bssid, string ssid)
{
IntPtr handle = IntPtr.Zero;
}
/// <summary>
- /// Overloaded Dispose API for destroying the fence Handle.
+ /// The overloaded Dispose API for destroying the fence handle.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public void Dispose()
{
Dispose(true);
namespace Tizen.Location.Geofence
{
/// <summary>
- /// Represents the Geofence list Item data.
+ /// Represents the geofence list item data.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public class FenceData
{
internal FenceData(int fenceId, IntPtr handle, int index, int count)
Count = count;
}
/// <summary>
- /// Geofence instance.
+ /// The geofence instance.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public Fence Fence
{
get;
}
/// <summary>
- /// The geofence id.
+ /// The geofence ID.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public int GeofenceId
{
get;
}
/// <summary>
- /// The index number of the fences in the list.
+ /// The index number of fences in the list.
/// </summary>
- /// <since_tizen>3</since_tizen>
- /// <value>Index value starts from 1.</value>
+ /// <since_tizen> 3 </since_tizen>
+ /// <value>The index value starts from 1.</value>
public int Index
{
get;
/// <summary>
/// The total number of fences that exists for the requester.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public int Count
{
get;
};
/// <summary>
- /// Represents the Place list Item data.
+ /// Represents the place list item data.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public class PlaceData
{
internal PlaceData(int id, string name, int index, int count)
Count = count;
}
/// <summary>
- /// The current place id.
+ /// The current place ID.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public int PlaceId
{
get;
/// <summary>
/// The current place name.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public string Name
{
get;
}
/// <summary>
- /// The index number of the places in the list.
+ /// The index number of places in the list.
/// </summary>
- /// <since_tizen>3</since_tizen>
- /// <value>Index value starts from 1.</value>
+ /// <since_tizen> 3 </since_tizen>
+ /// <value>The index value starts from 1.</value>
public int Index
{
get;
/// <summary>
/// The total number of places that exists for the requester.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public int Count
{
get;
/// <summary>
/// The geofence status describes the current state and duration of a geofence.
/// <list>
- /// <item>State: State is specified by current state of fence</item>
- /// <item>Duration: Geofence is specified by duration of current state</item>
+ /// <item>State: The state is specified by the current state of the fence.</item>
+ /// <item>Duration: Geofence is specified by the duration of the current state.</item>
/// </list>
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public class FenceStatus : IDisposable
{
private bool _disposed = false;
/// <summary>
/// Creates a new geofence status.
/// </summary>
- /// <since_tizen>3</since_tizen>
- /// <exception cref="ArgumentException">Incase of Invalid parameter.</exception>
- /// <exception cref="NotSupportedException">Incase of Geofence is not supported.</exception>
+ /// <since_tizen> 3 </since_tizen>
+ /// <exception cref="ArgumentException">In case of an invalid parameter.</exception>
+ /// <exception cref="NotSupportedException">In case of geofence is not supported.</exception>
public FenceStatus(int fenceId)
{
IntPtr handle;
/// <summary>
/// Gets the state of geofence.
/// </summary>
- /// <since_tizen>3</since_tizen>
- /// <exception cref="NotSupportedException">Incase of Geofence is not supported.</exception>
+ /// <since_tizen> 3 </since_tizen>
+ /// <exception cref="NotSupportedException">In case the geofence is not supported.</exception>
public GeofenceState State
{
get
}
/// <summary>
- /// Gets the amount of seconds geofence is in the current state.
+ /// Gets the amount of seconds, the geofence is in the current state.
/// </summary>
- /// <since_tizen>3</since_tizen>
- /// <exception cref="NotSupportedException">Incase of Geofence is not supported.</exception>
+ /// <since_tizen> 3 </since_tizen>
+ /// <exception cref="NotSupportedException">In case the geofence is not supported.</exception>
public int Duration
{
get
}
/// <summary>
- /// Overloaded Dispose API for destroying the fence Handle.
+ /// The overloaded Dispose API for destroying the fence handle.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public void Dispose()
{
Dispose(true);
namespace Tizen.Location.Geofence
{
/// <summary>
- /// Enumeration for geofence type.
+ /// Enumeration for the geofence types.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public enum FenceType
{
/// <summary>
- /// Geofence is specified by geospatial coordinate.
+ /// Geofence is specified by the geospatial coordinate.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
GeoPoint = 1,
/// <summary>
- /// Geofence is specified by Wi-Fi access point.
+ /// Geofence is specified by the Wi-Fi access point.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
Wifi,
/// <summary>
- /// Geofence is specified by Bluetooth device.
+ /// Geofence is specified by the Bluetooth device.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
Bluetooth
};
/// <summary>
- /// Enumerations for the state of geofence.
+ /// Enumeration for the state of geofence.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public enum GeofenceState
{
/// <summary>
/// Uncertain state of geofence.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
Uncertain = 0,
/// <summary>
/// Geofence In state.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
In,
/// <summary>
/// Geofence Out state.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
Out
};
/// <summary>
- /// Enumerations for geofence management events.
+ /// Enumeration for the geofence management events.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public enum GeofenceEventType
{
/// <summary>
/// Geofence is added.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
FenceAdded = 0,
/// <summary>
/// Geofence is removed.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
FenceRemoved,
/// <summary>
/// Geofencing is started.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
FenceStarted,
/// <summary>
/// Geofencing is stopped.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
FenceStopped,
/// <summary>
/// Place is added.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
PlaceAdded = 0x10,
/// <summary>
/// Place is removed.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
PlaceRemoved,
/// <summary>
/// Place is updated.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
PlaceUpdated,
/// <summary>
/// Setting for geofencing is enabled.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
SettingEnabled = 0x20,
/// <summary>
/// Setting for geofencing is disabled.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
SettingDisabled
};
/// <summary>
/// Enumeration for the provider of proximity.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public enum ProximityProvider
{
/// <summary>
- /// Proximity is specified by geospatial coordinate.
+ /// Proximity is specified by the geospatial coordinate.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
Location = 0,
/// <summary>
- /// Proximity is specified by Wi-Fi access point.
+ /// Proximity is specified by the Wi-Fi access point.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
Wifi,
/// <summary>
- /// Proximity is specified by Bluetooth device.
+ /// Proximity is specified by the Bluetooth device.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
Bluetooth,
/// <summary>
- /// Proximity is specified by Bluetooth low energy device.
+ /// Proximity is specified by the Bluetooth low-energy device.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
BLE,
/// <summary>
- /// Proximity is specified by Sensor.
+ /// Proximity is specified by the sensor.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
Sensor
}
/// <summary>
/// Enumeration for the state of proximity.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public enum ProximityState
{
/// <summary>
/// Uncertain state of proximity.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
Uncertain = 0,
/// <summary>
/// Far state of proximity.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
Far,
/// <summary>
/// Far state of proximity.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
Near,
/// <summary>
/// Immediate state of proximity.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
Immediate
}
}
namespace Tizen.Location.Geofence
{
/// <summary>
- /// Enum to give the type of error occured, if any.
+ /// Enumeration for the types of error occured, if any.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public enum GeofenceError
{
/// <summary>
/// Successful.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
None = Tizen.Internals.Errors.ErrorCode.None,
/// <summary>
/// Out of memory.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
OutOfMemory = Tizen.Internals.Errors.ErrorCode.OutOfMemory,
/// <summary>
/// Invalid parameter.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
InvalidParameter = Tizen.Internals.Errors.ErrorCode.InvalidParameter,
/// <summary>
/// Permission denied.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
PermissionDenied = Tizen.Internals.Errors.ErrorCode.PermissionDenied,
/// <summary>
/// Not Supported.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
NotSupported = Tizen.Internals.Errors.ErrorCode.NotSupported,
/// <summary>
- /// Geofence Manager is not initialized.
+ /// Geofence manager is not initialized.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
NotInitialized = -0x02C00000 | 0x100 | 0x01,
/// <summary>
/// Invalid geofence ID.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
InvalidID = -0x02C00000 | 0x100 | 0x02,
/// <summary>
/// Exception occurs.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
Exception = -0x02C00000 | 0x100 | 0x03,
/// <summary>
/// Geofencing is already started.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
AlreadyStarted = -0x02C00000 | 0x100 | 0x04,
/// <summary>
/// Too many geofence.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
TooManyGeofence = -0x02C00000 | 0x100 | 0x05,
/// <summary>
/// Error in GPS, Wi-Fi, or BT.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
IPC = -0x02C00000 | 0x100 | 0x06,
/// <summary>
/// DB error in the server side.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
DBFailed = -0x02C00000 | 0x100 | 0x07,
/// <summary>
- /// Access to specified place is denied.
+ /// Access to the specified place is denied.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
PlaceAccessDenied = -0x02C00000 | 0x100 | 0x08,
/// <summary>
- /// Access to specified geofence is denied.
+ /// Access to the specified geofence is denied.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
GeofenceAccessDenied = -0x02C00000 | 0x100 | 0x09
};
namespace Tizen.Location.Geofence
{
/// <summary>
- /// Event arguments passed when Event is triggered to notify proximity state change.
+ /// Event arguments are passed when an event is triggered to notify the proximity state change.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public class ProximityStateEventArgs : EventArgs
{
/// <summary>
- /// Internal constructor.
+ /// The internal constructor.
/// </summary>
- /// <since_tizen>3</since_tizen>
- /// <param name="id">The geofence id.</param>
+ /// <since_tizen> 3 </since_tizen>
+ /// <param name="id">The geofence ID.</param>
/// <param name="state">The proximity state.</param>
/// <param name="provider">The proximity provider.</param>
internal ProximityStateEventArgs(int id, ProximityState state, ProximityProvider provider)
}
/// <summary>
- /// The geofence id.
+ /// The geofence ID.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public int GeofenceId
{
get;
/// <summary>
/// The proximity state.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public ProximityState State
{
get;
/// <summary>
/// The proximity provider.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public ProximityProvider Provider
{
get;
};
/// <summary>
- /// Event arguments passed when Event is triggered to notify Geofence state change.
+ /// Event arguments are passed when an event is triggered to notify the geofence state change.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public class GeofenceStateEventArgs : EventArgs
{
/// <summary>
- /// Internal constructor.
+ /// The internal constructor.
/// </summary>
- /// <since_tizen>3</since_tizen>
- /// <param name="fenceId">The specified geofence id.</param>
+ /// <since_tizen> 3 </since_tizen>
+ /// <param name="fenceId">The specified geofence ID.</param>
/// <param name="state">The geofence state.</param>
internal GeofenceStateEventArgs(int fenceId, GeofenceState state)
{
}
/// <summary>
- /// The specified geofence id.
+ /// The specified geofence ID.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public int GeofenceId
{
get;
/// <summary>
/// The geofence state.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public GeofenceState State
{
get;
}
/// <summary>
- /// Event arguments passed when Event occurs in geofence and place such as add, update, etc..
+ /// Event arguments are passed when an event occurs in geofence and the place, such as add, update, etc..
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public class GeofenceResponseEventArgs : EventArgs
{
/// <summary>
- /// Internal constructor.
+ /// The internal constructor.
/// </summary>
- /// <since_tizen>3</since_tizen>
- /// <param name="placeId">The place id.</param>
- /// <param name="fenceId">The specified geofence id.</param>
+ /// <since_tizen> 3 </since_tizen>
+ /// <param name="placeId">The place ID.</param>
+ /// <param name="fenceId">The specified geofence ID.</param>
/// <param name="error">The error code for the particular action.</param>
/// <param name="eventType">The result code for the particular place and geofence management.</param>
internal GeofenceResponseEventArgs(int placeId, int fenceId, GeofenceError error, GeofenceEventType eventType)
}
/// <summary>
- /// The place id.
+ /// The place ID.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public int PlaceId
{
get;
}
/// <summary>
- /// The specified geofence id.
+ /// The specified geofence ID.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public int FenceId
{
get;
/// <summary>
/// The error code for the particular action.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public GeofenceError ErrorCode
{
get;
/// <summary>
/// The result code for the particular place and geofence management.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public GeofenceEventType EventType
{
get;
namespace Tizen.Location.Geofence
{
/// <summary>
- /// This Geofence Manager API provides service related to geofence(geo-fence).
- /// A geofence is a virtual perimeter for a real-world geographic area.
- /// This API provides functions to set geofence with geopoint, MAC address of Wi-Fi and Bluetooth address.
- /// And, notifications on events like changing in service status are provided.
+ /// The Geofence Manager API provides service related to geofence (geo-fence).
+ /// Geofence is a virtual perimeter for a real-world geographic area.
+ /// This API provides functions to set geofence with a geopoint, MAC address of Wi-Fi, and Bluetooth address.
+ /// Also, notifications on events like changing in service status are provided.
/// There are two kinds of places and fences:
/// <list>
- /// <item>Public places and fences that are created by MyPlace app can be used by all apps.</item>
- /// <item>Private places and fences that are created by specified app can be used by the same app.</item>
+ /// <item>Public places and fences are created by the MyPlace application that can be used by all applications.</item>
+ /// <item>Private places and fences are created by the specified application that can be used by the same application.</item>
/// </list>
/// Notifications can be received about the following events:
/// <list>
- /// <item>Zone in when a device enters a specific area</item>
- /// <item>Zone out when a device exits a specific area</item>
- /// <item>Results and errors for each event requested to geofence module</item>
+ /// <item>Zone in when a device enters a specific area.</item>
+ /// <item>Zone out when a device exits a specific area.</item>
+ /// <item>Results and errors for each event requested to the geofence module.</item>
/// </list>
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public class GeofenceManager : IDisposable
{
private bool _disposed = false;
}
/// <summary>
- /// Creates a new geofence manager.
+ /// Creates a new Geofence manager.
/// </summary>
- /// <since_tizen>3</since_tizen>
- /// <exception cref="OutOfMemoryException">Incase of OutOfMemory condition.</exception>
- /// <exception cref="InvalidOperationException">Incase of any System error.</exception>
- /// <exception cref="NotSupportedException">Incase of Geofence is not supported.</exception>
+ /// <since_tizen> 3 </since_tizen>
+ /// <exception cref="OutOfMemoryException">In case of out of memory condition.</exception>
+ /// <exception cref="InvalidOperationException">In case of any system error.</exception>
+ /// <exception cref="NotSupportedException">In case the geofence is not supported.</exception>
public GeofenceManager()
{
IntPtr handle;
}
/// <summary>
- /// Checks whether the geofence manager is available or not.
+ /// Checks whether the Geofence manager is available or not.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public static bool IsSupported
{
get
/// <summary>
/// Starts the geofencing service.
/// </summary>
- /// <since_tizen>3</since_tizen>
- /// <param name="geofenceId">The specified geofence id.</param>
+ /// <since_tizen> 3 </since_tizen>
+ /// <param name="geofenceId">The specified geofence ID.</param>
/// <privilege>http://tizen.org/privilege/location</privilege>
/// <remarks>
/// When the location service is enabled, the StateChanged event is invoked and the service starts.
/// </remarks>
- /// <exception cref="ArgumentException">Incase of Invalid parameter.</exception>
- /// <exception cref="InvalidOperationException">Incase of any System error.</exception>
- /// <exception cref="UnauthorizedAccessException">Incase of Privileges are not defined.</exception>
- /// <exception cref="NotSupportedException">Incase of Geofence is not supported.</exception>
+ /// <exception cref="ArgumentException">In case of an invalid parameter.</exception>
+ /// <exception cref="InvalidOperationException">In case of any system error.</exception>
+ /// <exception cref="UnauthorizedAccessException">In case privileges are not defined.</exception>
+ /// <exception cref="NotSupportedException">In case the geofence is not supported.</exception>
public void Start(int geofenceId)
{
GeofenceError ret = (GeofenceError)Interop.GeofenceManager.Start(Handle, geofenceId);
/// <summary>
/// Stops the geofenceing service.
/// </summary>
- /// <since_tizen>3</since_tizen>
- /// <param name="geofenceId">The specified geofence id.</param>
+ /// <since_tizen> 3 </since_tizen>
+ /// <param name="geofenceId">The specified geofence ID.</param>
/// <privilege>http://tizen.org/privilege/location</privilege>
/// <remarks>
/// This function initiates the process of stopping the service.
- /// You can stop and start the geofence manager as needed.
+ /// You can stop and start the Geofence manager as needed.
/// </remarks>
- /// <exception cref="ArgumentException">Incase of Invalid parameter.</exception>
- /// <exception cref="InvalidOperationException">Incase of any System error.</exception>
- /// <exception cref="UnauthorizedAccessException">Incase of Privileges are not defined.</exception>
- /// <exception cref="NotSupportedException">Incase of Geofence is not supported.</exception>
+ /// <exception cref="ArgumentException">In case of an invalid parameter.</exception>
+ /// <exception cref="InvalidOperationException">In case of any system error.</exception>
+ /// <exception cref="UnauthorizedAccessException">In case privileges are not defined.</exception>
+ /// <exception cref="NotSupportedException">In case the geofence is not supported.</exception>
public void Stop(int geofenceId)
{
GeofenceError ret = (GeofenceError)Interop.GeofenceManager.Stop(Handle, geofenceId);
private static event EventHandler<GeofenceStateEventArgs> s_stateChanged = null;
/// <summary>
- /// Invokes when a device enters or exits the given geofence, If this event is registered.
+ /// Invokes when a device enters or exits the given geofence if this event is registered.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
/// <remarks>
/// Call to Start() will invoke this event.
/// </remarks>
- /// <exception cref="NotSupportedException">Incase of feature Not supported.</exception>
+ /// <exception cref="NotSupportedException">In case the feature is not supported.</exception>
public event EventHandler<GeofenceStateEventArgs> StateChanged
{
add
private static event EventHandler<ProximityStateEventArgs> s_proximityChanged;
/// <summary>
- /// Called when a proximity state of device is changed.
+ /// Called when the proximity state of a device is changed.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
/// <remarks>
/// Call to Start() will invoke this event.
/// </remarks>
- /// <exception cref="NotSupportedException">Incase of feature Not supported.</exception>
+ /// <exception cref="NotSupportedException">In case the feature is not supported.</exception>
public event EventHandler<ProximityStateEventArgs> ProximityChanged
{
add
private static event EventHandler<GeofenceResponseEventArgs> s_geofenceEventChanged;
/// <summary>
- /// Called when the some event occurs in geofence and place such as add, update, etc..
+ /// Called when some event occurs in the geofence and the place, such as add, update, etc..
/// The events of public geofence is also received if there are public geofences.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
/// <remarks>
/// Call to Start() will invoke this event.
- /// The value of place_id or geofence_id is -1 when the place id or geofence id is not assigned.
+ /// The value of place_id or geofence_id is -1 when the place ID or geofence ID is not assigned.
/// </remarks>
- /// <exception cref="NotSupportedException">Incase of feature Not supported.</exception>
+ /// <exception cref="NotSupportedException">In case the feature is not supported.</exception>
public event EventHandler<GeofenceResponseEventArgs> GeofenceEventChanged
{
add
}
/// <summary>
- /// Overloaded Dispose API for destroying the GeofenceManager Handle.
+ /// The overloaded Dispose API for destroying the GeofenceManager handle.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public void Dispose()
{
Dispose(true);
<remarks>
<h2>Overview</h2>
<para>
-This API provides functions to set geofence with geopoint, MAC address of Wi-Fi, and Bluetooth address.
-A
nd notifications on events like changing in service status are provided.<p>
+This API provides functions to set the gofence with a geopoint, MAC address of Wi-Fi, and Bluetooth address.
+A
lso, notifications on events like changing in service status are provided.<p>
There are two kinds of places and fences:<br/>
-- Public places and fences that are created by MyPlace app can be used by all apps.<br/>
-- Private places and fences that are created by
specified app can be used by the same app.<p>
+- Public places and fences that are created by the MyPlace application can be used by all applications.<br/>
+- Private places and fences that are created by
the specified application can be used by the same application.<p>
Notifications can be received about the following events:<br/>
-- Zone in when a device enters a specific area<br/>
-- Zone out when a device exits a specific area<br/>
-- Results and errors for each event requested to geofence module<p>
+- Zone in when a device enters a specific area.<br/>
+- Zone out when a device exits a specific area.<br/>
+- Results and errors for each event requested to geofence module
.<p>
The Geofence manager has the following properties:<br/>
-- geofence type<br/>
-- status<br/>
+- The geofence type.<br/>
+- The status.<br/>
- 'Service state change' callback
</para>
<h2>Related Features</h2>
-<para>To guarantee that the Geofence application runs on a device with Geofence profile feature,
+<para>To guarantee that the geofence application runs on a device with the geofence profile feature,
declare the following feature requirements in the config file:<br/>
http://tizen.org/feature/location<br/>
-http://tizen.org/feature/location.geofence<br/>
+http://tizen.org/feature/location.Geofence<br/>
http://tizen.org/feature/location.wps
</para>
</remarks>
namespace Tizen.Location.Geofence
{
/// <summary>
- /// Allows to create a virtual fence as Geofence using GeofenceManager instance.
- /// User can manage all the geofence/place related data and events.
+ /// Allows to create a virtual fence as geofence using the GeofenceManager instance.
+ /// A user can manage all the geofence or place related data and events.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public class VirtualPerimeter
{
private IntPtr Handle;
/// <summary>
- /// Creates a VirtualPerimeter which can be used to create virtual fence.
+ /// Creates a VirtualPerimeter which can be used to create a virtual fence.
/// </summary>
- /// <since_tizen>3</since_tizen>
- /// <param name="manager">GeofenceManager instance.</param>
- /// <exception cref="ArgumentException"> Incase of invlid parameter.</exception>
+ /// <since_tizen> 3 </since_tizen>
+ /// <param name="manager">The GeofenceManager instance.</param>
+ /// <exception cref="ArgumentException"> In case of an invalid parameter.</exception>
public VirtualPerimeter(GeofenceManager manager)
{
if (manager == null)
}
/// <summary>
- /// Creates a new place for geofencing service.
+ /// Creates a new place for the geofencing service.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
/// <param name="name">A place name to be created.</param>
- /// <returns>The place id to be newly created on success.</returns>
+ /// <returns>The place ID to be newly created on success.</returns>
/// <privilege>http://tizen.org/privilege/location</privilege>
- /// <exception cref="ArgumentException">Incase of Invalid parameter.</exception>
- /// <exception cref="InvalidOperationException">Incase of any System error.</exception>
- /// <exception cref="UnauthorizedAccessException">Incase of Privileges are not defined.</exception>
- /// <exception cref="NotSupportedException">Incase of Geofence is not supported.</exception>
+ /// <exception cref="ArgumentException">In case of an invalid parameter.</exception>
+ /// <exception cref="InvalidOperationException">In case of any system error.</exception>
+ /// <exception cref="UnauthorizedAccessException">In case privileges are not defined.</exception>
+ /// <exception cref="NotSupportedException">In case the geofence is not supported.</exception>
public int AddPlaceName(string name)
{
int placeId = 0;
}
/// <summary>
- /// Updates the place name of a given place id.
+ /// Updates the place name of a given place ID.
/// </summary>
- /// <since_tizen>3</since_tizen>
- /// <param name="placeId">The specified place id.</param>
- /// <param name="name">A new place name of the place id.</param>
+ /// <since_tizen> 3 </since_tizen>
+ /// <param name="placeId">The specified place ID.</param>
+ /// <param name="name">A new place name of the place ID.</param>
/// <privilege>http://tizen.org/privilege/location</privilege>
- /// <exception cref="ArgumentException">Incase of Invalid parameter.</exception>
- /// <exception cref="InvalidOperationException">Incase of any System error.</exception>
- /// <exception cref="UnauthorizedAccessException">Incase of Privileges are not defined.</exception>
- /// <exception cref="NotSupportedException">Incase of Geofence is not supported.</exception>
+ /// <exception cref="ArgumentException">In case of an invalid parameter.</exception>
+ /// <exception cref="InvalidOperationException">In case of any System error.</exception>
+ /// <exception cref="UnauthorizedAccessException">In case privileges are not defined.</exception>
+ /// <exception cref="NotSupportedException">In case the geofence is not supported.</exception>
public void UpdatePlace(int placeId, string name)
{
GeofenceError ret = (GeofenceError)Interop.VirtualPerimeter.UpdatePlace(Handle, placeId, name);
}
/// <summary>
- /// Removes the specific place for geofencing service.
+ /// Removes the specific place for the geofencing service.
/// </summary>
- /// <since_tizen>3</since_tizen>
- /// <param name="placeId">The specified place id.</param>
+ /// <since_tizen> 3 </since_tizen>
+ /// <param name="placeId">The specified place ID.</param>
/// <privilege>http://tizen.org/privilege/location</privilege>
- /// <exception cref="ArgumentException">Incase of Invalid parameter.</exception>
- /// <exception cref="InvalidOperationException">Incase of any System error.</exception>
- /// <exception cref="UnauthorizedAccessException">Incase of Privileges are not defined.</exception>
- /// <exception cref="NotSupportedException">Incase of Geofence is not supported.</exception>
+ /// <exception cref="ArgumentException">Incase of an invalid parameter.</exception>
+ /// <exception cref="InvalidOperationException">In case of any system error.</exception>
+ /// <exception cref="UnauthorizedAccessException">In case privileges are not defined.</exception>
+ /// <exception cref="NotSupportedException">In case the geofence is not supported.</exception>
public void RemovePlace(int placeId)
{
GeofenceError ret = (GeofenceError)Interop.VirtualPerimeter.RemovePlace(Handle, placeId);
}
/// <summary>
- /// Adds a geofence for a given geofence manager.
+ /// Adds the geofence for a given Geofence manager.
/// </summary>
- /// <since_tizen>3</since_tizen>
- /// <param name="fence">The Geofence instance to be added.</param>
- /// <returns>The geofence id to be newly created on success.</returns>
- /// <remarks> The retun value will always be a number greater than zero.</remarks>
+ /// <since_tizen> 3 </since_tizen>
+ /// <param name="fence">The geofence instance to be added.</param>
+ /// <returns>The geofence ID to be newly created on success.</returns>
+ /// <remarks> The return value will always be a number greater than zero.</remarks>
/// <privilege>http://tizen.org/privilege/location</privilege>
- /// <exception cref="ArgumentException">Incase of Invalid parameter.</exception>
- /// <exception cref="InvalidOperationException">Incase of any System error.</exception>
- /// <exception cref="UnauthorizedAccessException">Incase of Privileges are not defined.</exception>
- /// <exception cref="NotSupportedException">Incase of Geofence is not supported.</exception>
+ /// <exception cref="ArgumentException">In case of an invalid parameter.</exception>
+ /// <exception cref="InvalidOperationException">In case of any system error.</exception>
+ /// <exception cref="UnauthorizedAccessException">In case privileges are not defined.</exception>
+ /// <exception cref="NotSupportedException">In case the geofence is not supported.</exception>
public int AddGeofence(Fence fence)
{
int fenceId = 0;
}
/// <summary>
- /// Removes a geofence with a given geofence id.
+ /// Removes the geofence with a given geofence ID.
/// </summary>
- /// <since_tizen>3</since_tizen>
- /// <param name="fenceId">The specified geofence id.</param>
+ /// <since_tizen> 3 </since_tizen>
+ /// <param name="fenceId">The specified geofence ID.</param>
/// <privilege>http://tizen.org/privilege/location</privilege>
- /// <exception cref="ArgumentException">Incase of Invalid parameter.</exception>
- /// <exception cref="InvalidOperationException">Incase of any System error.</exception>
- /// <exception cref="UnauthorizedAccessException">Incase of Privileges are not defined.</exception>
- /// <exception cref="NotSupportedException">Incase of Geofence is not supported.</exception>
+ /// <exception cref="ArgumentException">In case of an invalid parameter.</exception>
+ /// <exception cref="InvalidOperationException">In case of any system error.</exception>
+ /// <exception cref="UnauthorizedAccessException">In case privileges are not defined.</exception>
+ /// <exception cref="NotSupportedException">In case the geofence is not supported.</exception>
public void RemoveGeofence(int fenceId)
{
GeofenceError ret = (GeofenceError)Interop.VirtualPerimeter.RemoveFence(Handle, fenceId);
/// <summary>
/// Gets the name of place.
/// </summary>
- /// <since_tizen>3</since_tizen>
- /// <param name="placeId">The place id.</param>
+ /// <since_tizen> 3 </since_tizen>
+ /// <param name="placeId">The place ID.</param>
/// <returns>The name of the place.</returns>
/// <privilege>http://tizen.org/privilege/location</privilege>
- /// <exception cref="ArgumentException">Incase of Invalid parameter.</exception>
- /// <exception cref="InvalidOperationException">Incase of any System error.</exception>
- /// <exception cref="UnauthorizedAccessException">Incase of Privileges are not defined.</exception>
- /// <exception cref="NotSupportedException">Incase of Geofence is not supported.</exception>
+ /// <exception cref="ArgumentException">In case of an invalid parameter.</exception>
+ /// <exception cref="InvalidOperationException">In case of any system error.</exception>
+ /// <exception cref="UnauthorizedAccessException">In case privileges are not defined.</exception>
+ /// <exception cref="NotSupportedException">In case the geofence is not supported.</exception>
public string GetPlaceName(int placeId)
{
string name = "";
}
/// <summary>
- /// Retrieves a list of places registered in the specified geofence manager.
+ /// Retrieves a list of places registered in the specified Geofence manager.
/// </summary>
- /// <since_tizen>3</since_tizen>
- /// <returns>list of places registered as PlaceData instance list.</returns>
+ /// <since_tizen> 3 </since_tizen>
+ /// <returns>List of places registered as the PlaceData instance list.</returns>
/// <privilege>http://tizen.org/privilege/location</privilege>
- /// <exception cref="InvalidOperationException">Incase of any System error.</exception>
- /// <exception cref="UnauthorizedAccessException">Incase of Privileges are not defined.</exception>
- /// <exception cref="NotSupportedException">Incase of Geofence is not supported.</exception>
+ /// <exception cref="InvalidOperationException">In case of any system error.</exception>
+ /// <exception cref="UnauthorizedAccessException">In case privileges are not defined.</exception>
+ /// <exception cref="NotSupportedException">In case the geofence is not supported.</exception>
public IEnumerable<PlaceData> GetPlaceDataList()
{
List<PlaceData> places = new List<PlaceData>();
}
/// <summary>
- /// Retrieves a list of fences registered in the specified geofence manager.
+ /// Retrieves a list of fences registered in the specified Geofence manager.
/// </summary>
- /// <since_tizen>3</since_tizen>
- /// <returns>list of FenceData instances registred for each Geofence.</returns>
+ /// <since_tizen> 3 </since_tizen>
+ /// <returns>List of FenceData instances registered for each geofence.</returns>
/// <privilege>http://tizen.org/privilege/location</privilege>
- /// <exception cref="InvalidOperationException">Incase of any System error.</exception>
- /// <exception cref="UnauthorizedAccessException">Incase of Privileges are not defined.</exception>
- /// <exception cref="NotSupportedException">Incase of Geofence is not supported.</exception>
+ /// <exception cref="InvalidOperationException">In case of any system error.</exception>
+ /// <exception cref="UnauthorizedAccessException">In case privileges are not defined.</exception>
+ /// <exception cref="NotSupportedException">In case geofence is not supported.</exception>
public IEnumerable<FenceData> GetFenceDataList()
{
List<FenceData> fences = new List<FenceData>();
/// <summary>
/// Retrieves a list of fences registered in the specified place.
/// </summary>
- /// <since_tizen>3</since_tizen>
- /// <param name="placeId"> The place id.</param>
- /// <returns>list of FenceData instances registred for each Geofence for specified place.</returns>
+ /// <since_tizen> 3 </since_tizen>
+ /// <param name="placeId"> The place ID.</param>
+ /// <returns>The list of FenceData instances registered for each geofence for the specified place.</returns>
/// <privilege>http://tizen.org/privilege/location</privilege>
- /// <exception cref="ArgumentException">Incase of Invalid parameter.</exception>
- /// <exception cref="InvalidOperationException">Incase of any System error.</exception>
- /// <exception cref="UnauthorizedAccessException">Incase of Privileges are not defined.</exception>
- /// <exception cref="NotSupportedException">Incase of Geofence is not supported.</exception>
+ /// <exception cref="ArgumentException">In case of an invalid parameter.</exception>
+ /// <exception cref="InvalidOperationException">In case of any system error.</exception>
+ /// <exception cref="UnauthorizedAccessException">In case privileges are not defined.</exception>
+ /// <exception cref="NotSupportedException">In case the geofence is not supported.</exception>
public IEnumerable<FenceData> GetGeofenceDataListByPlaceId(int placeId)
{
List<FenceData> fences = new List<FenceData>();
namespace Tizen.Maps
{
/// <summary>
- /// Class representing geographical area
+ /// The class representing a geographical area.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public class Area : IDisposable
{
internal Interop.AreaHandle handle;
/// <summary>
- /// Constructs rectangular area.
+ /// Constructs a rectangular area.
/// </summary>
- /// <since_tizen>3</since_tizen>
- /// <param name="topLeft">Top-left coordinates of the area</param>
- /// <param name="bottomRight">Bottom-left coordinate of the area</param>
+ /// <since_tizen> 3 </since_tizen>
+ /// <param name="topLeft">Top-left coordinates of the area.</param>
+ /// <param name="bottomRight">Bottom-left coordinates of the area.</param>
/// <exception cref="System.NotSupportedException">Thrown when the required feature is not supported.</exception>
- /// <exception cref="System.ArgumentException">Thrown when input coordinates are invalid</exception>
- /// <exception cref="System.InvalidOperationException">Thrown when native operation failed to allocate memory.</exception>
+ /// <exception cref="System.ArgumentException">Thrown when input coordinates are invalid.</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown when a native operation fails to allocate memory.</exception>
public Area(Geocoordinates topLeft, Geocoordinates bottomRight)
{
handle = new Interop.AreaHandle(topLeft?.handle, bottomRight?.handle);
}
/// <summary>
- /// Constructs circular area.
+ /// Constructs a circular area.
/// </summary>
- /// <since_tizen>3</since_tizen>
- /// <param name="center">Coordinates for center of the area</param>
- /// <param name="radius">Radius of the area</param>
+ /// <since_tizen> 3 </since_tizen>
+ /// <param name="center">Coordinates for center of the area.</param>
+ /// <param name="radius">Radius of the area.</param>
/// <exception cref="System.NotSupportedException">Thrown when the required feature is not supported.</exception>
- /// <exception cref="System.ArgumentException">Thrown when input coordinates are invalid</exception>
- /// <exception cref="System.InvalidOperationException">Thrown when native operation failed to allocate memory.</exception>
+ /// <exception cref="System.ArgumentException">Thrown when input coordinates are invalid.</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown when a native operation fails to allocate memory.</exception>
public Area(Geocoordinates center, double radius)
{
handle = new Interop.AreaHandle(center?.handle, radius);
}
/// <summary>
- /// Releases all resources used by this object.
+ /// Releases all the resources used by this object.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public void Dispose()
{
Dispose(true);
namespace Tizen.Maps
{
/// <summary>
- /// Direction types for route maneuver
+ /// The direction types for route maneuver.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public enum DirectionType
{
/// <summary>
- /// Indicates unknown direction.
+ /// Indicates an unknown direction.
/// </summary>
None = Interop.RouteDirection.None,
/// <summary>
- /// Indicates north direction.
+ /// Indicates the North direction.
/// </summary>
North = Interop.RouteDirection.North,
/// <summary>
- /// Indicates north-west direction.
+ /// Indicates the Northwest direction.
/// </summary>
NorthWest = Interop.RouteDirection.NorthWest,
/// <summary>
- /// Indicates north-east direction.
+ /// Indicates the Northeast direction.
/// </summary>
NorthEast = Interop.RouteDirection.NorthEast,
/// <summary>
- /// Indicates south direction.
+ /// Indicates the South direction.
/// </summary>
South = Interop.RouteDirection.South,
/// <summary>
- /// Indicates south-East direction.
+ /// Indicates the Southeast direction.
/// </summary>
SouthEast = Interop.RouteDirection.SouthEast,
/// <summary>
- /// Indicates south-West direction.
+ /// Indicates the Southwest direction.
/// </summary>
SouthWest = Interop.RouteDirection.SouthWest,
/// <summary>
- /// Indicates west direction.
+ /// Indicates the West direction.
/// </summary>
West = Interop.RouteDirection.West,
/// <summary>
- /// Indicates east direction.
+ /// Indicates the East direction.
/// </summary>
East = Interop.RouteDirection.East,
}
namespace Tizen.Maps
{
/// <summary>
- /// Allowed distance units
+ /// The allowed distance units.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public enum DistanceUnit
{
/// <summary>
namespace Tizen.Maps
{
/// <summary>
- /// Geocode request for map service
+ /// Geocode request for the map service.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public class GeocodeRequest : MapServiceRequest<Geocoordinates>
{
private Interop.GeocodeCallback _geocodeCallback;
}
else
{
- // If search is failed, the value of total is 0 and coordinates is NULL
+ // If the search fails, the value of total is 0 and coordinates is NULL.
_requestTask?.TrySetException(result.GetException(errMessage));
return false;
}
namespace Tizen.Maps
{
/// <summary>
- /// Class representing geographical coordinates.
+ /// A class representing geographical coordinates.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public class Geocoordinates : IDisposable
{
internal Interop.CoordinatesHandle handle;
/// <summary>
- /// Constructs map coordinates object.
+ /// Constructs the map coordinates object.
/// </summary>
- /// <since_tizen>3</since_tizen>
- /// <param name="latitude">Latitude value, must be between (-90.0 ~ 90.0) degrees</param>
- /// <param name="longitude">Longitude value, must be between (-180.0 ~ 180.0) degrees</param>
+ /// <since_tizen> 3 </since_tizen>
+ /// <param name="latitude">Latitude value must be between (-90.0 ~ 90.0) degrees.</param>
+ /// <param name="longitude">Longitude value must be between (-180.0 ~ 180.0) degrees.</param>
/// <exception cref="System.ArgumentException">Thrown when values for latitude and longitude are not valid.</exception>
- /// <exception cref="System.InvalidOperationException">Thrown when native operation failed to allocate memory.</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown when a native operation fails to allocate memory.</exception>
public Geocoordinates(double latitude, double longitude)
{
handle = new Interop.CoordinatesHandle(latitude, longitude);
}
/// <summary>
- /// Gets latitude of the coordinates.
+ /// Gets the latitude coordinates.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public double Latitude
{
get
}
/// <summary>
- /// Gets longitude of the coordinates.
+ /// Gets the longitude coordinates.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public double Longitude
{
get
/// <summary>
/// Returns a string that represents this object.
/// </summary>
- /// <since_tizen>3</since_tizen>
- /// <returns>Returns a string which presents this object.</returns>
+ /// <since_tizen> 3 </since_tizen>
+ /// <returns>Returns a string that represents this object.</returns>
public override string ToString()
{
return $"[{Latitude}, {Longitude}]";
}
/// <summary>
- /// Releases all resources used by this object.
+ /// Releases all the resources used by this object.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public void Dispose()
{
Dispose(true);
namespace Tizen.Maps
{
/// <summary>
- /// List of <see cref="Geocoordinates"/> objects to be used in <see cref="MapService"/> APIs
+ /// List of <see cref="Geocoordinates"/> objects to be used in <see cref="MapService"/> APIs.
/// </summary>
internal class GeocoordinatesList : IDisposable
{
}
/// <summary>
- /// Iterator for coordinates in this list
+ /// The iterator for coordinates in this list.
/// </summary>
internal IEnumerable<Geocoordinates> Coordinates
{
}
/// <summary>
- /// Releases all resources used by this object.
+ /// Releases all the resources used by this object.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public void Dispose()
{
Dispose(true);
namespace Tizen.Maps
{
/// <summary>
- /// Enumeration of user gestures over map view
+ /// Enumeration for the user gesture over a map view.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public enum GestureType
{
/// <summary>
- /// Indicates empty gesture.
+ /// Indicates the empty gesture.
/// </summary>
None = Interop.ViewGesture.None,
/// <summary>
/// </summary>
Zoom = Interop.ViewGesture.Zoom,
/// <summary>
- /// Indicates the click user gesture
+ /// Indicates the click user gesture.
/// </summary>
Click = Interop.ViewGesture.Click,
/// <summary>
- /// Indicates the double click user gesture
+ /// Indicates the double click user gesture.
/// </summary>
DoubleClick = Interop.ViewGesture.DoubleClick,
/// <summary>
- /// Indicates the two-finger click user gesture
+ /// Indicates the two-finger click user gesture.
/// </summary>
TwoFingerClick = Interop.ViewGesture.TwoFingerClick,
/// <summary>
namespace Tizen.Maps
{
/// <summary>
- /// Preferences for geocode searches
+ /// The preference for geocode searches.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public interface IGeocodePreference
{
/// <summary>
- /// Gets or sets a string that presents preferred language.
+ /// Gets or sets a string that presents the preferred language.
/// </summary>
- /// <since_tizen>3</since_tizen>
- /// <remarks>Language should be specified as an ISO 3166 alpha-2 two letter country-code
+ /// <since_tizen> 3 </since_tizen>
+ /// <remarks>Language should be specified as an ISO 3166 alpha-2 two-letter country-code
/// followed by ISO 639-1 for the two-letter language code.<br/>e.g. "ko-KR", "en-US".</remarks>
string Language { get; set; }
/// <summary>
/// Gets or sets the maximum number of results.
/// </summary>
- /// <since_tizen>3</since_tizen>
- /// <remarks>Setting negative value will not have any effect on MaxResults value.</remarks>
+ /// <since_tizen> 3 </since_tizen>
+ /// <remarks>Setting a negative value will not have any effect on MaxResults value.</remarks>
int MaxResults { get; set; }
}
}
namespace Tizen.Maps
{
/// <summary>
- /// Preferences for place searches
+ /// The preferences for a place search.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public interface IPlaceSearchPreference
{
/// <summary>
- /// Gets or sets distance unit.
+ /// Gets or sets the distance unit.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
DistanceUnit Unit { get; set; }
/// <summary>
- /// Gets or sets preferred language.
+ /// Gets or sets the preferred language.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
/// <remarks>Language should be specified as an ISO 3166 alpha-2 two letter country-code
/// followed by ISO 639-1 for the two-letter language code.<br/>e.g. "ko-KR", "en-US".</remarks>
string Language { get; set; }
/// <summary>
/// Gets or sets the maximum number of results.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
int MaxResults { get; set; }
/// <summary>
- /// Gets or sets a string that represents code of preferred country.
+ /// Gets or sets a string that represents the code of a preferred country.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
string CountryCode { get; set; }
/// <summary>
- /// Gets or sets search properties as key value pair.
+ /// Gets or sets the search properties as a key value pair.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
IReadOnlyDictionary<string, string> Properties { get; set; }
}
}
namespace Tizen.Maps
{
/// <summary>
- /// Preferences for route searches
+ /// The preferences for route search.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public interface IRouteSearchPreference
{
/// <summary>
- /// Gets or sets distance unit.
+ /// Gets or sets the distance unit.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
DistanceUnit Unit { get; set; }
/// <summary>
- /// Gets or sets route optimization.
+ /// Gets or sets the route optimization.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
RouteOptimization Optimization { get; set; }
/// <summary>
- /// Gets or sets route transport mode.
+ /// Gets or sets the route transport mode.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
TransportMode Mode { get; set; }
/// <summary>
- /// Gets or sets route feature weight.
+ /// Gets or sets the route feature weight.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
RouteFeatureWeight RouteFeatureWeight { get; set; }
/// <summary>
- /// Gets or sets route feature.
+ /// Gets or sets the route feature.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
RouteFeature RouteFeature { get; set; }
/// <summary>
- /// Gets or sets if searching for alternative routes is enabled.
+ /// Gets or sets if a search for alternative routes is enabled.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
bool SearchAlternativeRoutes { get; set; }
}
}
namespace Tizen.Maps
{
/// <summary>
- /// Event arguments for gesture type map events
+ /// Event arguments for gesture type map events.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public class MapGestureEventArgs : EventArgs
{
internal MapGestureEventArgs(IntPtr nativeHandle)
}
/// <summary>
- /// Gets type of gesture event.
+ /// Gets the type of gesture event.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public GestureType GestureType { get; }
/// <summary>
/// Gets screen coordinates in the event.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public Point Position { get; }
/// <summary>
/// Gets the number of fingers detected in the event.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public int TouchCount { get; }
/// <summary>
- /// Gets zoom factor for zoom gesture event.
+ /// Gets the zoom factor for zoom gesture event.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public double ZoomFactor { get; }
/// <summary>
- /// Gets angle of rotation for rotate gesture event.
+ /// Gets the angle of rotation for rotate gesture event.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public double RotationAngle { get; }
/// <summary>
- /// Gets geographical coordinates for the event.
+ /// Gets the geographical coordinates for the event.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public Geocoordinates Geocoordinates { get; }
}
}
namespace Tizen.Maps
{
/// <summary>
- /// Map object
+ /// The map object.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public abstract class MapObject
{
internal MapObject() { }
/// <summary>
/// Gets or sets visibility of the map object.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public abstract bool IsVisible { get; set; }
internal abstract void HandleClickedEvent();
namespace Tizen.Maps
{
/// <summary>
- /// Map service class for service request
+ /// Map service class for service request.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public partial class MapService : IDisposable
{
internal Interop.ServiceHandle handle;
/// <summary>
- /// Creates a new Maps Service object for given service provider.
+ /// Creates a new maps service object for given service provider.
/// </summary>
- /// <since_tizen>3</since_tizen>
- /// <param name="serviceProvider">A string which representing name of map service provider</param>
- /// <param name="serviceProviderKey">A string which representing certificate key to use the map service provider</param>
+ /// <since_tizen> 3 </since_tizen>
+ /// <param name="serviceProvider">A string representing the name of the map service provider.</param>
+ /// <param name="serviceProviderKey">A string representing a certificate key to use the map service provider.</param>
/// <privilege>http://tizen.org/privilege/mapservice</privilege>
/// <privilege>http://tizen.org/privilege/network.get</privilege>
/// <exception cref="System.NotSupportedException">Thrown when the required feature is not supported.</exception>
/// <exception cref="System.ArgumentException">Thrown when parameters are invalid.</exception>
- /// <exception cref="System.InvalidOperationException">Thrown when native operation failed to allocate memory, connect to service.</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown when a native operation failed to allocate memory and connect to the service.</exception>
/// <exception cref="System.UnauthorizedAccessException">Thrown when application does not have some privilege to access this method.</exception>
public MapService(string serviceProvider, string serviceProviderKey)
{
}
/// <summary>
- /// Gets list of available map service providers.
+ /// Gets the list of available map service providers.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
/// <value>The list of map service providers.</value>
/// <privilege>http://tizen.org/privilege/mapservice</privilege>
/// <exception cref="System.NotSupportedException">Thrown when the required feature is not supported.</exception>
- /// <exception cref="System.UnauthorizedAccessException">Thrown when application does not have privileges to access this property.</exception>
+ /// <exception cref="System.UnauthorizedAccessException">Thrown when application does not have privilege to access this property.</exception>
public static IEnumerable<string> Providers
{
get
}
/// <summary>
- /// Gets name of map service provider.
+ /// Gets the name of the map service provider.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public string Provider { get { return _serviceProvider; } }
/// <summary>
- /// Gets a user consent for map service provider
+ /// Gets a user consent for the map service provider
/// </summary>
/// <since_tizen> 3 </since_tizen>
/// <privilege>http://tizen.org/privilege/mapservice</privilege>
}
/// <summary>
- /// Gets and sets a string representing keys for map service provider
+ /// Gets and sets a string representing keys for the map service provider.
/// </summary>
- /// <since_tizen>3</since_tizen>
- /// <remarks>Typically, the provider key is issued by each maps provider, after signing up for a plan in the web site.
- /// Depending on the plan and its provider which you have signed, you might pay for the network traffic.</remarks>
+ /// <since_tizen> 3 </since_tizen>
+ /// <remarks>Typically, the provider key is issued by each maps provider after signing up for a plan in the website.
+ /// Depending on the plan and its provider which you have signed, you might have to pay for the network traffic.</remarks>
public string ProviderKey
{
get
}
/// <summary>
- /// Gets and sets a filter used for place search result.
+ /// Gets and sets a filter used for the place search result.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public PlaceFilter PlaceSearchFilter
{
get
}
/// <summary>
- /// Gets search preferences used for <see cref="GeocodeRequest"/> or <see cref="ReverseGeocodeRequest"/>.
+ /// Gets the search preferences used for <see cref="GeocodeRequest"/> or <see cref="ReverseGeocodeRequest"/>.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public IGeocodePreference GeocodePreferences
{
get
}
/// <summary>
- /// Gets search preferences used for <see cref="PlaceSearchRequest"/>.
+ /// Gets the search preferences used for <see cref="PlaceSearchRequest"/>.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public IPlaceSearchPreference PlaceSearchPreferences
{
get
}
/// <summary>
- /// Gets search preferences used for <see cref="RouteSearchRequest"/>.
+ /// Gets the search preferences used for <see cref="RouteSearchRequest"/>.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public IRouteSearchPreference RouteSearchPreferences
{
get
}
/// <summary>
- /// Gets and sets search preferences.
+ /// Gets and sets the search preferences.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public SearchPreference Preferences
{
get
}
/// <summary>
- /// Checks if the Maps Service supports given request.
+ /// Checks if the maps service supports the given request.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
/// <param name="type">Request type to check</param>
- /// <returns>Returns true if the Maps Service supports a request, otherwise false.</returns>
+ /// <returns>Returns true if the maps service supports a request, otherwise false.</returns>
/// <privilege>http://tizen.org/privilege/mapservice</privilege>
/// <exception cref="System.NotSupportedException">Thrown when the required feature is not supported.</exception>
/// <exception cref="System.UnauthorizedAccessException">Thrown when application does not have some privilege to access this method.</exception>
}
/// <summary>
- /// Checks if the Maps Service supports given data feature.
+ /// Checks if the maps service supports a given data feature.
/// </summary>
- /// <since_tizen>3</since_tizen>
- /// <param name="data">Data feature to check</param>
- /// <returns>Returns true if the Maps Service supports a data feature, otherwise false.</returns>
+ /// <since_tizen> 3 </since_tizen>
+ /// <param name="data">Data feature to check.</param>
+ /// <returns>Returns true if the maps service supports a data feature, otherwise false.</returns>
/// <privilege>http://tizen.org/privilege/mapservice</privilege>
/// <exception cref="System.NotSupportedException">Thrown when the required feature is not supported.</exception>
/// <exception cref="System.UnauthorizedAccessException">Thrown when application does not have some privilege to access this method.</exception>
}
/// <summary>
- /// Creates geocode search request for given free-formed address string.
+ /// Creates a geocode search request for the given free-formed address string.
/// </summary>
- /// <since_tizen>3</since_tizen>
- /// <param name="address">A string which representing free-formed address</param>
- /// <returns>GeocodeRequest object created with address string</returns>
+ /// <since_tizen> 3 </since_tizen>
+ /// <param name="address">A string representing free-formed address.</param>
+ /// <returns>Returns a GeocodeRequest object created with an address string.</returns>
public GeocodeRequest CreateGeocodeRequest(string address)
{
return new GeocodeRequest(this, address);
}
/// <summary>
- /// Creates geocode search request for given free-formed address string, within the specified boundary.
+ /// Creates a geocode search request for the given free-formed address string, within the specified boundary.
/// </summary>
- /// <since_tizen>3</since_tizen>
- /// <param name="address">A string which representing free-formed address</param>
- /// <param name="boundary">An instance of Area object which representing interested area</param>
+ /// <since_tizen> 3 </since_tizen>
+ /// <param name="address">A string representing the free-formed address.</param>
+ /// <param name="boundary">An instance of Area object representing the interested area.</param>
/// <seealso cref="Area"/>
- /// <returns>GeocodeRequest object created with address string and specified boundary</returns>
+ /// <returns>Returns a GeocodeRequest object created with an address string and a specified boundary.</returns>
public GeocodeRequest CreateGeocodeRequest(string address, Area boundary)
{
return new GeocodeRequest(this, address, boundary);
}
/// <summary>
- /// Creates geocode search request for given structured address.
+ /// Creates a geocode search request for the given structured address.
/// </summary>
- /// <since_tizen>3</since_tizen>
- /// <param name="address">A string which representing address of interest</param>
- /// <returns>Returns GeocodeRequest object created with structured address</returns>
+ /// <since_tizen> 3 </since_tizen>
+ /// <param name="address">A string representing the address of interest.</param>
+ /// <returns>Returns a GeocodeRequest object created with a structured address.</returns>
public GeocodeRequest CreateGeocodeRequest(PlaceAddress address)
{
return new GeocodeRequest(this, address);
}
/// <summary>
- /// Creates a reverse geocode search request for given latitude and longitude.
+ /// Creates a reverse geocode search request for the given latitude and longitude.
/// </summary>
- /// <since_tizen>3</since_tizen>
- /// <param name="latitude">Latitude of interested place</param>
- /// <param name="longitude">Longitude of interested place</param>
- /// <returns>Returns ReverseGeocodeRequest object created with location coordinates</returns>
+ /// <since_tizen> 3 </since_tizen>
+ /// <param name="latitude">Latitude of the interested place.</param>
+ /// <param name="longitude">Longitude of the interested place.</param>
+ /// <returns>Returns a ReverseGeocodeRequest object created with the location coordinates.</returns>
public ReverseGeocodeRequest CreateReverseGeocodeRequest(double latitude, double longitude)
{
return new ReverseGeocodeRequest(this, latitude, longitude);
}
/// <summary>
- /// Creates a reverse geocode search request for given position coordinates list.
+ /// Creates a reverse geocode search request for the given position coordinates list.
/// </summary>
- /// <since_tizen>3</since_tizen>
- /// <param name="coordinates">Coordinates list with [2 ~ 100] coordinates</param>
- /// <returns>Returns MultiReverseGeocodeRequest object created with list of location coordinates</returns>
+ /// <since_tizen> 3 </since_tizen>
+ /// <param name="coordinates">Coordinates list with [2 ~ 100] coordinates.</param>
+ /// <returns>Returns a MultiReverseGeocodeRequest object created with a list of location coordinates.</returns>
public MultiReverseGeocodeRequest CreateMultiReverseGeocodeRequest(IEnumerable<Geocoordinates> coordinates)
{
return new MultiReverseGeocodeRequest(this, coordinates);
}
/// <summary>
- /// Creates a route search request for origin and destination points.
+ /// Creates a route search request for the origin and destination points.
/// </summary>
- /// <since_tizen>3</since_tizen>
- /// <param name="from">Starting point</param>
- /// <param name="to">Destination</param>
- /// <returns>Returns RouteSearchRequest object created with origin and destination coordinates</returns>
+ /// <since_tizen> 3 </since_tizen>
+ /// <param name="from">Starting point.</param>
+ /// <param name="to">Destination.</param>
+ /// <returns>Returns a RouteSearchRequest object created with the origin and destination coordinates.</returns>
public RouteSearchRequest CreateRouteSearchRequest(Geocoordinates from, Geocoordinates to)
{
return new RouteSearchRequest(this, from, to);
}
/// <summary>
- /// Creates a place search request for specified search radius around a given coordinates position.
+ /// Creates a place search request for a specified search radius around a given coordinates position.
/// </summary>
- /// <since_tizen>3</since_tizen>
- /// <param name="coordinates">A geographical coordinates of center</param>
- /// <param name="distance">A double value which representing radius of area to search places</param>
- /// <returns>Returns PlaceSearchRequest object created with location coordinates and search radius</returns>
+ /// <since_tizen> 3 </since_tizen>
+ /// <param name="coordinates">Geographical coordinates of the center.</param>
+ /// <param name="distance">A double value representing the radius of an area to search places.</param>
+ /// <returns>Returns a PlaceSearchRequest object created with the location coordinates and search radius.</returns>
public PlaceSearchRequest CreatePlaceSearchRequest(Geocoordinates coordinates, int distance)
{
return new PlaceSearchRequest(this, coordinates, distance);
}
/// <summary>
- /// Creates a place search request for places within specified boundary.
+ /// Creates a place search request for places within a specified boundary.
/// </summary>
- /// <since_tizen>3</since_tizen>
- /// <param name="boundary">An instance of Area object which representing area to search interested places</param>
- /// <returns>Returns PlaceSearchRequest object created with specified boundary</returns>
+ /// <since_tizen> 3 </since_tizen>
+ /// <param name="boundary">An instance of Area object representing and area to search interested places.</param>
+ /// <returns>Returns a PlaceSearchRequest object created with a specified boundary.</returns>
public PlaceSearchRequest CreatePlaceSearchRequest(Area boundary)
{
return new PlaceSearchRequest(this, boundary);
}
/// <summary>
- /// Creates a place search request for free-formed address within boundary.
+ /// Creates a place search request for a free-formed address within the boundary.
/// </summary>
- /// <since_tizen>3</since_tizen>
- /// <param name="address">A string which representing free-formed address</param>
- /// <param name="boundary">An instance of Area object which representing area to search interested places</param>
- /// <returns>Returns PlaceSearchRequest object created with address string and specified boundary</returns>
+ /// <since_tizen> 3 </since_tizen>
+ /// <param name="address">A string which represents a free-formed address.</param>
+ /// <param name="boundary">An instance of area object representing an area to search interested places.</param>
+ /// <returns>Returns a PlaceSearchRequest object created with an address string and a specified boundary.</returns>
public PlaceSearchRequest CreatePlaceSearchRequest(string address, Area boundary)
{
return new PlaceSearchRequest(this, address, boundary);
}
/// <summary>
- /// Releases all resources used by this object.
+ /// Releases all the resources used by this object.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public void Dispose()
{
Dispose(true);
namespace Tizen.Maps
{
/// <summary>
- /// Base class for map service request
+ /// Base class for a map service request.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
/// <typeparam name="T"></typeparam>
public abstract class MapServiceRequest<T> : IDisposable
{
/// <summary>
/// Creates a map service request.
/// </summary>
- /// <param name="service">map service object</param>
- /// <param name="type">Request type</param>
+ /// <param name="service">Map service object.</param>
+ /// <param name="type">Request type.</param>
internal MapServiceRequest(MapService service, ServiceRequestType type)
{
_service = service;
}
/// <summary>
- /// Sends a request to map service provider.
+ /// Sends a request to the map service provider.
/// </summary>
- /// <since_tizen>3</since_tizen>
- /// <returns>Response from map service provider</returns>
+ /// <since_tizen> 3 </since_tizen>
+ /// <returns>Response from the map service provider.</returns>
/// <privilege>http://tizen.org/privilege/mapservice</privilege>
/// <privilege>http://tizen.org/privilege/internet</privilege>
/// <privilege>http://tizen.org/privilege/network.get</privilege>
/// <exception cref="System.NotSupportedException">Thrown when the required feature is not supported.</exception>
/// <exception cref="System.UnauthorizedAccessException">Thrown when application does not have some privilege to access this method.</exception>
/// <exception cref="System.InvalidOperationException">Thrown when the result is invalid.</exception>
- /// <exception cref="System.ArgumentException">Thrown when arguments are invalid</exception>
+ /// <exception cref="System.ArgumentException">Thrown when arguments are invalid.</exception>
public async Task<IEnumerable<T>> GetResponseAsync()
{
IEnumerable<T> task = null;
}
/// <summary>
- /// Releases all resources used by this object.
+ /// Releases all the resources used by this object.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public void Dispose()
{
Dispose(true);
namespace Tizen.Maps
{
/// <summary>
- /// Map View Type (theme)
+ /// The map view type (theme).
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public enum MapTypes
{
/// <summary>
- /// Indicates normal street theme.
+ /// Indicates the normal street theme.
/// </summary>
Normal = Interop.ViewType.Normal,
/// <summary>
- /// Indicates satellite theme.
+ /// Indicates the satellite theme.
/// </summary>
Satellite = Interop.ViewType.Satellite,
/// <summary>
- /// Indicates terrain theme.
+ /// Indicates the terrain theme.
/// </summary>
Terrain = Interop.ViewType.Terrain,
/// <summary>
- /// Indicates hybrid theme, has both satellite and normal theme.
+ /// Indicates the hybrid theme that has both satellite and normal theme.
/// </summary>
Hybrid = Interop.ViewType.Hybrid,
}
/// <summary>
/// Map View class to show a map on the screen.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public class MapView : Layout, IDisposable
{
internal Interop.ViewHandle handle;
private event EventHandler _viewReadyEventHandler;
/// <summary>
- /// Creates the view and link it to the instance of map service.
+ /// Creates a view and links it to the instance of a map service.
/// </summary>
- /// <since_tizen>3</since_tizen>
- /// <param name="parent">An instance of <see cref="EvasObject"/> object which map view will be drawn</param>
- /// <param name="service">An instance of <see cref="MapService"/> object</param>
+ /// <since_tizen> 3 </since_tizen>
+ /// <param name="parent">An instance of <see cref="EvasObject"/> object for which a map view will be drawn.</param>
+ /// <param name="service">An instance of <see cref="MapService"/> object.</param>
/// <privilege>http://tizen.org/privilege/mapservice</privilege>
/// <exception cref="System.NotSupportedException">Thrown when the required feature is not supported.</exception>
/// <exception cref="System.UnauthorizedAccessException">Thrown when application does not have some privilege to access this method.</exception>
- /// <exception cref="System.ArgumentException">Thrown when parameters are invalid</exception>
- /// <exception cref="System.InvalidOperationException">Thrown when native operation failed to allocate memory, connect to service</exception>
+ /// <exception cref="System.ArgumentException">Thrown when parameters are invalid.</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown when a native operation failed to allocate memory, and connect to the service.</exception>
public MapView(EvasObject parent, MapService service) : base(parent)
{
handle = new Interop.ViewHandle(service.handle, this);
}
/// <summary>
- /// Adds or removes event handlers to deliver scrolled gesture event.
+ /// Adds or removes event handlers to deliver a scrolled gesture event.
/// </summary>
- /// <value>Event handlers to get scrolled gesture event</value>
- /// <since_tizen>3</since_tizen>
+ /// <value>Event handlers to get a scrolled gesture event.</value>
+ /// <since_tizen> 3 </since_tizen>
/// <exception cref="System.NotSupportedException">Thrown when the required feature is not supported.</exception>
public event EventHandler<MapGestureEventArgs> Scrolled
{
}
/// <summary>
- /// Adds or removes event handlers to deliver zoomed gesture event.
+ /// Adds or removes event handlers to deliver a zoomed gesture event.
/// </summary>
- /// <value>Event handlers to get zoomed gesture event</value>
- /// <since_tizen>3</since_tizen>
+ /// <value>Event handlers to get a zoomed gesture event.</value>
+ /// <since_tizen> 3 </since_tizen>
/// <exception cref="System.NotSupportedException">Thrown when the required feature is not supported.</exception>
public event EventHandler<MapGestureEventArgs> TwoFingerZoomed
{
}
/// <summary>
- /// Adds or removes event handlers to deliver clicked gesture event.
+ /// Adds or removes event handlers to deliver a clicked gesture event.
/// </summary>
- /// <value>Event handlers to get clicked gesture event</value>
- /// <since_tizen>3</since_tizen>
+ /// <value>Event handlers to get a clicked gesture event.</value>
+ /// <since_tizen> 3 </since_tizen>
/// <exception cref="System.NotSupportedException">Thrown when the required feature is not supported.</exception>
public event EventHandler<MapGestureEventArgs> Clicked
{
}
/// <summary>
- /// Adds or removes event handlers to deliver double-clicked gesture event.
+ /// Adds or removes event handlers to deliver a double-clicked gesture event.
/// </summary>
- /// <value>Event handlers to get double-clicked gesture event</value>
- /// <since_tizen>3</since_tizen>
+ /// <value>Event handlers to get a double-clicked gesture event.</value>
+ /// <since_tizen> 3 </since_tizen>
/// <exception cref="System.NotSupportedException">Thrown when the required feature is not supported.</exception>
public event EventHandler<MapGestureEventArgs> DoubleClicked
{
}
/// <summary>
- /// Adds or removes event handlers to deliver clicked gesture event with two-fingers.
+ /// Adds or removes event handlers to deliver a clicked gesture event with two-fingers.
/// </summary>
- /// <value>Event handlers to get clicked gesture event</value>
- /// <since_tizen>3</since_tizen>
+ /// <value>Event handlers to get a clicked gesture event.</value>
+ /// <since_tizen> 3 </since_tizen>
/// <exception cref="System.NotSupportedException">Thrown when the required feature is not supported.</exception>
public event EventHandler<MapGestureEventArgs> TwoFingerClicked
{
}
/// <summary>
- /// Adds or removes event handlers to deliver rotated gesture event.
+ /// Adds or removes event handlers to deliver a rotated gesture event.
/// </summary>
- /// <value>Event handlers to get rotated gesture event</value>
- /// <since_tizen>3</since_tizen>
+ /// <value>Event handlers to get a rotated gesture event.</value>
+ /// <since_tizen> 3 </since_tizen>
/// <exception cref="System.NotSupportedException">Thrown when the required feature is not supported.</exception>
public event EventHandler<MapGestureEventArgs> TwoFingerRotated
{
/// <summary>
- /// Adds or removes event handlers to deliver long-pressed gesture event.
+ /// Adds or removes event handlers to deliver a long-pressed gesture event.
/// </summary>
- /// <value>Event handlers to get long-pressed gesture event</value>
- /// <since_tizen>3</since_tizen>
+ /// <value>Event handlers to get a long-pressed gesture event.</value>
+ /// <since_tizen> 3 </since_tizen>
/// <exception cref="System.NotSupportedException">Thrown when the required feature is not supported.</exception>
public event EventHandler<MapGestureEventArgs> LongPressed
{
}
/// <summary>
- /// Adds or removes event handlers to deliver a event representing the view is ready to be used.
+ /// Adds or removes event handlers to deliver an event representing a view ready to be used.
/// </summary>
- /// <value>Event handlers to get view ready event</value>
- /// <since_tizen>3</since_tizen>
+ /// <value>Event handlers to get a view ready event.</value>
+ /// <since_tizen> 3 </since_tizen>
/// <exception cref="System.NotSupportedException">Thrown when the required feature is not supported.</exception>
public event EventHandler ViewReady
{
}
/// <summary>
- /// Gets or sets current zoom level.
+ /// Gets or sets the current zoom level.
/// </summary>
- /// <value>It is an integer value that representing current zoom level.</value>
- /// <since_tizen>3</since_tizen>
+ /// <value>It is an integer value representing the current zoom level.</value>
+ /// <since_tizen> 3 </since_tizen>
/// <privilege>http://tizen.org/privilege/mapservice</privilege>
/// <privilege>http://tizen.org/privilege/internet</privilege>
/// <privilege>http://tizen.org/privilege/network.get</privilege>
}
/// <summary>
- /// Gets or sets minimum zoom level.
+ /// Gets or sets the minimum zoom level.
/// </summary>
- /// <value>It is an integer value that limits minimal zoom level within range of current map plug-in supported.</value>
- /// <since_tizen>3</since_tizen>
+ /// <value>It is an integer value that limits minimal zoom level within a range of the current map plug-in support.</value>
+ /// <since_tizen> 3 </since_tizen>
/// <privilege>http://tizen.org/privilege/mapservice</privilege>
/// <privilege>http://tizen.org/privilege/internet</privilege>
/// <privilege>http://tizen.org/privilege/network.get</privilege>
}
/// <summary>
- /// Gets or sets maximum zoom level.
+ /// Gets or sets the maximum zoom level.
/// </summary>
- /// <value>It is an integer value that limits maximum zoom level within range of current map plug-in supported.</value>
- /// <since_tizen>3</since_tizen>
+ /// <value>It is an integer value that limits maximum zoom level within a range of the current map plug-in support.</value>
+ /// <since_tizen> 3 </since_tizen>
/// <privilege>http://tizen.org/privilege/mapservice</privilege>
/// <privilege>http://tizen.org/privilege/internet</privilege>
/// <privilege>http://tizen.org/privilege/network.get</privilege>
}
/// <summary>
- /// Gets or sets orientation on the map view.
+ /// Gets or sets the orientation on the map view.
/// </summary>
- /// <value>It is an integer value from 0 to 360 that indicates orientation of the map view</value>
- /// <since_tizen>3</since_tizen>
+ /// <value>It is an integer value from 0 to 360 that indicates the orientation of the map view.</value>
+ /// <since_tizen> 3 </since_tizen>
/// <privilege>http://tizen.org/privilege/mapservice</privilege>
/// <privilege>http://tizen.org/privilege/internet</privilege>
/// <privilege>http://tizen.org/privilege/network.get</privilege>
/// <summary>
/// Gets or sets theme type of the map view.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
/// <privilege>http://tizen.org/privilege/mapservice</privilege>
/// <privilege>http://tizen.org/privilege/internet</privilege>
/// <privilege>http://tizen.org/privilege/network.get</privilege>
/// <summary>
/// Indicates whether the map should show the 3D buildings layer.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
/// <privilege>http://tizen.org/privilege/mapservice</privilege>
/// <privilege>http://tizen.org/privilege/internet</privilege>
/// <privilege>http://tizen.org/privilege/network.get</privilege>
/// <summary>
/// Indicates whether the map should show the traffic layer.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
/// <privilege>http://tizen.org/privilege/mapservice</privilege>
/// <privilege>http://tizen.org/privilege/internet</privilege>
/// <privilege>http://tizen.org/privilege/network.get</privilege>
/// <summary>
/// Indicates whether the map should show the public transit layer.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
/// <privilege>http://tizen.org/privilege/mapservice</privilege>
/// <privilege>http://tizen.org/privilege/internet</privilege>
/// <privilege>http://tizen.org/privilege/network.get</privilege>
/// <summary>
/// Indicates whether the scale-bar is enabled or not.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
/// <privilege>http://tizen.org/privilege/mapservice</privilege>
/// <privilege>http://tizen.org/privilege/internet</privilege>
/// <privilege>http://tizen.org/privilege/network.get</privilege>
/// Each language tag is composed of one or more "subtags" separated by hyphens (-).
/// Each subtag is composed of basic Latin letters or digits only.
/// For example, "ko-KR" for Korean, "en-US" for American English.</value>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
/// <privilege>http://tizen.org/privilege/mapservice</privilege>
/// <privilege>http://tizen.org/privilege/internet</privilege>
/// <privilege>http://tizen.org/privilege/network.get</privilege>
/// <summary>
/// Gets or sets geographical coordinates for map view's center.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
/// <privilege>http://tizen.org/privilege/mapservice</privilege>
/// <privilege>http://tizen.org/privilege/internet</privilege>
/// <privilege>http://tizen.org/privilege/network.get</privilege>
}
/// <summary>
- /// Gets a list of map object added to map view.
+ /// Gets a list of the map object added to map view.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public IEnumerable<MapObject> Children
{
get
}
/// <summary>
- /// Changes geographical coordinates to screen coordinates.
+ /// Changes the geographical coordinates to screen coordinates.
/// </summary>
- /// <since_tizen>3</since_tizen>
- /// <param name="coordinates">Geographical coordinates</param>
- /// <returns>Returns an instance of screen coordinates on the current screen</returns>
+ /// <since_tizen> 3 </since_tizen>
+ /// <param name="coordinates">Geographical coordinates.</param>
+ /// <returns>Returns an instance of the screen coordinates on the current screen.</returns>
/// <privilege>http://tizen.org/privilege/mapservice</privilege>
/// <exception cref="System.NotSupportedException">Thrown when the required feature is not supported.</exception>
/// <exception cref="System.UnauthorizedAccessException">Thrown when application does not have some privilege to access this method.</exception>
/// <exception cref="System.ArgumentException">Thrown when the value is invalid.</exception>
- /// <exception cref="System.InvalidOperationException">Thrown when native operation failed to allocate memory, connect to service.</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown when a native operation failed to allocate memory and connect to the service.</exception>
public Point GeolocationToScreen(Geocoordinates coordinates)
{
return handle.GeolocationToScreen(coordinates.handle);
}
/// <summary>
- /// Changes screen coordinates to geographical coordinates.
+ /// Changes the screen coordinates to geographical coordinates.
/// </summary>
- /// <since_tizen>3</since_tizen>
- /// <param name="screenCoordinates">Screen coordinates</param>
- /// <returns>Returns an instance of geographical coordinates object.</returns>
+ /// <since_tizen> 3 </since_tizen>
+ /// <param name="screenCoordinates">Screen coordinates.</param>
+ /// <returns>Returns an instance of the geographical coordinates object.</returns>
/// <privilege>http://tizen.org/privilege/mapservice</privilege>
/// <exception cref="System.NotSupportedException">Thrown when the required feature is not supported.</exception>
/// <exception cref="System.UnauthorizedAccessException">Thrown when application does not have some privilege to access this method.</exception>
/// <exception cref="System.ArgumentException">Thrown when the value is invalid.</exception>
- /// <exception cref="System.InvalidOperationException">Thrown when native operation failed to allocate memory, connect to service.</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown when a native operation failed to allocate memory and connect to the service.</exception>
public Geocoordinates ScreenToGeolocation(Point screenCoordinates)
{
return new Geocoordinates(handle.ScreenToGeolocation(screenCoordinates));
/// <summary>
/// Adds a map object to map view.
/// </summary>
- /// <since_tizen>3</since_tizen>
- /// <param name="child">An instance of map object to be added</param>
+ /// <since_tizen> 3 </since_tizen>
+ /// <param name="child">An instance of the map object to be added.</param>
/// <privilege>http://tizen.org/privilege/mapservice</privilege>
/// <exception cref="System.NotSupportedException">Thrown when the required feature is not supported.</exception>
/// <exception cref="System.UnauthorizedAccessException">Thrown when application does not have some privilege to access this method.</exception>
/// <exception cref="System.ArgumentException">Thrown when the value is invalid.</exception>
- /// <exception cref="System.InvalidOperationException">Thrown when native operation failed to allocate memory, connect to service.</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown when a native operation failed to allocate memory and connect to the service.</exception>
public void Add(MapObject child)
{
Log.Info(string.Format("Add a object"));
}
/// <summary>
- /// Removes a map object from map view.
+ /// Removes a map object from the map view.
/// </summary>
- /// <since_tizen>3</since_tizen>
- /// <param name="child">An instance of map object to be removed</param>
- /// <remarks>Once removed, the child object will be become invalid</remarks>
+ /// <since_tizen> 3 </since_tizen>
+ /// <param name="child">An instance of the map object to be removed.</param>
+ /// <remarks>Once removed, the child object will be become invalid.</remarks>
/// <privilege>http://tizen.org/privilege/mapservice</privilege>
/// <exception cref="System.NotSupportedException">Thrown when the required feature is not supported.</exception>
/// <exception cref="System.UnauthorizedAccessException">Thrown when application does not have some privilege to access this method.</exception>
/// <exception cref="System.ArgumentException">Thrown when the value is invalid.</exception>
- /// <exception cref="System.InvalidOperationException">Thrown when native operation failed to allocate memory, connect to service.</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown when native operation failed to allocate memory and connect to the service.</exception>
public void Remove(MapObject child)
{
Log.Info(string.Format("Remove a object"));
}
/// <summary>
- /// Removes all map objects from map view.
+ /// Removes all map objects from the map view.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
/// <privilege>http://tizen.org/privilege/mapservice</privilege>
/// <exception cref="System.NotSupportedException">Thrown when the required feature is not supported.</exception>
/// <exception cref="System.UnauthorizedAccessException">Thrown when application does not have some privilege to access this method.</exception>
- /// <exception cref="System.InvalidOperationException">Thrown when native operation failed to allocate memory, connect to service.</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown when a native operation failed to allocate memory and connect to the service.</exception>
public void RemoveAll()
{
Log.Info(string.Format("Remove all of objects"));
}
/// <summary>
- /// Captures a snapshot of map view
+ /// Captures a snapshot of the map view.
/// </summary>
- /// <since_tizen>3</since_tizen>
- /// <param name="type">Type of file format</param>
- /// <param name="quality">A integer value which representing quality for encoding, from 1 to 100</param>
- /// <param name="path">A string which representing The file path for snapshot</param>
+ /// <since_tizen> 3 </since_tizen>
+ /// <param name="type">Type of file format.</param>
+ /// <param name="quality">An integer value representing the quality for encoding from 1 to 100.</param>
+ /// <param name="path">A string representing the file path for a snapshot.</param>
/// <privilege>http://tizen.org/privilege/mapservice</privilege>
/// <exception cref="System.NotSupportedException">Thrown when the required feature is not supported.</exception>
/// <exception cref="System.UnauthorizedAccessException">Thrown when application does not have some privilege to access this method.</exception>
/// <exception cref="System.ArgumentException">Thrown when the value is invalid.</exception>
- /// <exception cref="System.InvalidOperationException">Thrown when native operation failed to allocate memory, connect to service.</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown when a native operation failed to allocate memory and connect to the service.</exception>
public void CaptureSnapshot(SnapshotType type, int quality, string path)
{
var err = Interop.ViewSnapshot.ViewCaptureSnapshot(handle, (Interop.ViewSnapshotFormatType)type, quality, path);
}
/// <summary>
- /// Releases all resources used by this object.
+ /// Releases all the resources used by this object.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public void Dispose()
{
Dispose(true);
namespace Tizen.Maps
{
/// <summary>
- /// Marker map object
+ /// The marker map object.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public class Marker : MapObject, IDisposable
{
internal Interop.MarkerHandle handle;
}
/// <summary>
- /// Gets or sets clicked event handlers.
+ /// Gets or sets the clicked event handlers.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public event EventHandler Clicked;
/// <summary>
- /// Gets or sets marker's visibility.
+ /// Gets or sets the marker's visibility.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public override bool IsVisible
{
get
}
/// <summary>
- /// Gets or sets geographical coordinates for this marker.
+ /// Gets or sets the geographical coordinates for this marker.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public Geocoordinates Coordinates
{
get
}
/// <summary>
- /// Gets or sets a string representing image file path for this marker.
+ /// Gets or sets a string representing the image file path for this marker.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public string ImagePath
{
get
}
/// <summary>
- /// Gets or sets screen size for this marker.
+ /// Gets or sets the screen size for this marker.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public Size MarkerSize
{
get
}
/// <summary>
- /// Gets or sets z-order for this marker.
+ /// Gets or sets the z-order for this marker.
/// </summary>
- /// <since_tizen>3</since_tizen>
- /// <value>The integer value is 0 in default, and must be in range of from -100 to 100.</value>
+ /// <since_tizen> 3 </since_tizen>
+ /// <value>The integer value is 0 by default, and must be in the range of -100 to 100.</value>
public int ZOrder
{
get
}
/// <summary>
- /// Changes marker size.
+ /// Changes the marker size.
/// </summary>
- /// <since_tizen>3</since_tizen>
- /// <param name="newSize">New size</param>
+ /// <since_tizen> 3 </since_tizen>
+ /// <param name="newSize">New size.</param>
public void Resize(Size newSize)
{
MarkerSize = newSize;
}
/// <summary>
- /// Changes marker coordinates.
+ /// Changes the marker coordinates.
/// </summary>
- /// <since_tizen>3</since_tizen>
- /// <param name="newPosition">New position for marker</param>
+ /// <since_tizen> 3 </since_tizen>
+ /// <param name="newPosition">New position for the marker.</param>
public void Move(Geocoordinates newPosition)
{
Coordinates = newPosition;
}
/// <summary>
- /// Releases all resources used by this object.
+ /// Releases all the resources used by this object.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public void Dispose()
{
Dispose(true);
}
/// <summary>
- /// Pin type marker map object
+ /// Pin type the marker map object.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public class Pin : Marker
{
private const string defaultImagePath = "/usr/share/dotnet.tizen/framework/res/maps_marker_pin_48.png";
/// <summary>
- /// Creates a Pin type marker.
+ /// Creates a pin type marker.
/// </summary>
- /// <since_tizen>3</since_tizen>
- /// <param name="coordinates">Marker coordinates</param>
+ /// <since_tizen> 3 </since_tizen>
+ /// <param name="coordinates">Marker coordinates.</param>
/// <exception cref="System.ArgumentException">Thrown when input coordinates are invalid.</exception>
public Pin(Geocoordinates coordinates)
: base(coordinates, defaultImagePath, Interop.ViewMarkerType.Pin)
}
/// <summary>
- /// Creates a Pin type marker.
+ /// Creates a pin type marker.
/// </summary>
- /// <since_tizen>3</since_tizen>
- /// <param name="coordinates">Marker coordinates</param>
- /// <param name="imagePath">Image file path for Marker</param>
+ /// <since_tizen> 3 </since_tizen>
+ /// <param name="coordinates">Marker coordinates.</param>
+ /// <param name="imagePath">Image file path for the Marker.</param>
/// <remarks>
- /// http://tizen.org/privilege/mediastorage is needed if the file path are relevant to media storage.
- /// http://tizen.org/privilege/externalstorage is needed if the file path are relevant to external storage.
+ /// http://tizen.org/privilege/mediastorage is needed if the file path is relevant to media storage.
+ /// http://tizen.org/privilege/externalstorage is needed if the file path is relevant to external storage.
/// </remarks>
/// <exception cref="System.NotSupportedException">Thrown when the required feature is not supported.</exception>
/// <exception cref="System.UnauthorizedAccessException">Thrown when application does not have some privilege to access this method.</exception>
- /// <exception cref="System.ArgumentException">Thrown when input coordinates or imagePath are invalid.</exception>
+ /// <exception cref="System.ArgumentException">Thrown when the input coordinates or imagePath is invalid.</exception>
public Pin(Geocoordinates coordinates, string imagePath)
: base(coordinates, imagePath, Interop.ViewMarkerType.Pin)
{
}
/// <summary>
- /// Sticker type marker map object
+ /// Sticker type marker map object.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public class Sticker : Marker
{
private const string defaultImagePath = "/usr/share/dotnet.tizen/framework/res/maps_marker_sticker_48.png";
/// <summary>
- /// Creates a Sticker type marker.
+ /// Creates a sticker type marker.
/// </summary>
- /// <since_tizen>3</since_tizen>
- /// <param name="coordinates">Marker coordinates</param>
+ /// <since_tizen> 3 </since_tizen>
+ /// <param name="coordinates">Marker coordinates.</param>
/// <exception cref="System.ArgumentException">Thrown when input coordinates are invalid.</exception>
public Sticker(Geocoordinates coordinates)
: base(coordinates, defaultImagePath, Interop.ViewMarkerType.Sticker)
}
/// <summary>
- /// Creates a Sticker type marker.
+ /// Creates a sticker type marker.
/// </summary>
- /// <since_tizen>3</since_tizen>
- /// <param name="coordinates">Marker coordinates</param>
- /// <param name="imagePath">Image file path for Marker</param>
+ /// <since_tizen> 3 </since_tizen>
+ /// <param name="coordinates">Marker coordinates.</param>
+ /// <param name="imagePath">Image file path for Marker.</param>
/// <remarks>
- /// http://tizen.org/privilege/mediastorage is needed if input or output path are relevant to media storage.
- /// http://tizen.org/privilege/externalstorage is needed if input or output path are relevant to external storage.
+ /// http://tizen.org/privilege/mediastorage is needed if the input or output path are relevant to media storage.
+ /// http://tizen.org/privilege/externalstorage is needed if the input or output path are relevant to external storage.
/// </remarks>
/// <exception cref="System.NotSupportedException">Thrown when the required feature is not supported.</exception>
/// <exception cref="System.UnauthorizedAccessException">Thrown when application does not have some privilege to access this method.</exception>
- /// <exception cref="System.ArgumentException">Thrown when input coordinates or imagePath are invalid.</exception>
+ /// <exception cref="System.ArgumentException">Thrown when the input coordinates or imagePath is invalid.</exception>
public Sticker(Geocoordinates coordinates, string imagePath)
: base(coordinates, imagePath, Interop.ViewMarkerType.Sticker)
{
namespace Tizen.Maps
{
/// <summary>
- /// Multiple Reverse geocode Request for Tizen map service
+ /// Multiple reverse geocode request for Tizen map service.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public class MultiReverseGeocodeRequest : MapServiceRequest<PlaceAddress>
{
private Interop.MultiReverseGeocodeCallback _geocodeCallback;
Zoom and rotation: Changing zoom and orientation of the view in response
to user gestures, such as scrolling, tapping, zooming, rotating, etc.<p/>
-Conversion of screen coordinates to geographical and vi
se versa.<p/>
+Conversion of screen coordinates to geographical and vi
ce versa.<p/>
User's gesture support:<br/>
- Receive the event of the user gesture.<br/>
namespace Tizen.Maps
{
/// <summary>
- /// Overlay map object
+ /// Overlay map object.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public class Overlay : MapObject, IDisposable
{
internal Interop.OverlayHandle handle;
/// <summary>
/// Creates a normal overlay map object.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
/// <param name="coordinates"></param>
/// <param name="objectToContain"></param>
- /// <exception cref="ArgumentException">Thrown when input coordinates or objectToContain are invalid</exception>
+ /// <exception cref="ArgumentException">Thrown when the input coordinates or objectToContain are invalid.</exception>
public Overlay(Geocoordinates coordinates, EvasObject objectToContain)
: this(coordinates, objectToContain, Interop.ViewOverlayType.Normal)
{
}
/// <summary>
- /// Gets or sets visibility of overlay map object.
+ /// Gets or sets the visibility of an overlay map object.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public override bool IsVisible
{
get { return handle.IsVisible; }
}
/// <summary>
- /// Gets or sets geographical coordinates for overlay map object.
+ /// Gets or sets geographical coordinates for an overlay map object.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public Geocoordinates Coordinates
{
get
}
/// <summary>
- /// Gets or sets minimum zoom level for overlay map object.
+ /// Gets or sets minimum zoom level for an overlay map object.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public int MinimumZoomLevel
{
get
}
/// <summary>
- /// Gets or sets maximum zoom lever for overlay map object.
+ /// Gets or sets maximum zoom lever for an overlay map object.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public int MaximumZoomLevel
{
get
}
/// <summary>
- /// Releases all resources used by this object.
+ /// Releases all the resources used by this object.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public void Dispose()
{
Dispose(true);
}
/// <summary>
- /// Bubble overlay map object
+ /// The bubble overlay map object.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public class BubbleOverlay : Overlay
{
/// <summary>
- /// Creates a Bubble overlay.
+ /// Creates a bubble overlay.
/// </summary>
- /// <since_tizen>3</since_tizen>
- /// <param name="coordinates">The geographical coordinates to be pointed</param>
- /// <param name="objectToContain">The EvasObject to be shown</param>
+ /// <since_tizen> 3 </since_tizen>
+ /// <param name="coordinates">The geographical coordinates to be pointed.</param>
+ /// <param name="objectToContain">The EvasObject to be shown.</param>
/// <exception cref="System.NotSupportedException">Thrown when the required feature is not supported.</exception>
- /// <exception cref="ArgumentException">Thrown when input coordinates or objectToContain are invalid</exception>
+ /// <exception cref="ArgumentException">Thrown when the input coordinates or objectToContain are invalid.</exception>
public BubbleOverlay(Geocoordinates coordinates, EvasObject objectToContain)
: base(coordinates, objectToContain, Interop.ViewOverlayType.Bubble)
{
}
/// <summary>
- /// Box Overlay map object
+ /// The box overlay map object.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public class BoxOverlay : Overlay
{
/// <summary>
- /// Creates a Box overlay.
+ /// Creates a box overlay.
/// </summary>
- /// <since_tizen>3</since_tizen>
- /// <param name="coordinates">The geographical coordinates to be pointed</param>
- /// <param name="objectToContain">The EvasObject to be shown</param>
+ /// <since_tizen> 3 </since_tizen>
+ /// <param name="coordinates">The geographical coordinates to be pointed.</param>
+ /// <param name="objectToContain">The EvasObject to be shown.</param>
/// <exception cref="System.NotSupportedException">Thrown when the required feature is not supported.</exception>
- /// <exception cref="ArgumentException">Thrown when input coordinates or objectToContain are invalid</exception>
+ /// <exception cref="ArgumentException">Thrown when the input coordinates or objectToContain are invalid</exception>
public BoxOverlay(Geocoordinates coordinates, EvasObject objectToContain)
: base(coordinates, objectToContain, Interop.ViewOverlayType.Box)
{
namespace Tizen.Maps
{
/// <summary>
- /// Place information, used in Place Discovery and Search
+ /// Place information, used in place discovery and search requests.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public class Place : IDisposable
{
internal Interop.PlaceHandle handle;
}
/// <summary>
- /// Gets ID string for the place.
+ /// Gets an ID string for the place.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public string Id
{
get
/// <summary>
/// Gets name string for the place.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public string Name
{
get
}
/// <summary>
- /// Gets view URI for the place.
+ /// Gets a view URI for the place.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public string Uri
{
get
}
/// <summary>
- /// Gets distance for the place from the center.
+ /// Gets a distance for the place from the center.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public int Distance
{
get
}
/// <summary>
- /// Gets geographical location for the place.
+ /// Gets a geographical location for the place.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public Geocoordinates Coordinates
{
get
}
/// <summary>
- /// Gets address for the place.
+ /// Gets an address for the place.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public PlaceAddress Address
{
get
}
/// <summary>
- /// Gets rating for the place.
+ /// Gets a rating for the place.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public PlaceRating Rating
{
get
}
/// <summary>
- /// Gets supplier link for the place.
+ /// Gets a supplier link for the place.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public PlaceLink Supplier
{
get
}
/// <summary>
- /// Gets related link for the place.
+ /// Gets a related link for the place.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public PlaceLink Related
{
get
}
/// <summary>
- /// Gets all properties attached to this place.
+ /// Gets all the properties attached to this place.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public IDictionary<string, string> Properties
{
get
}
/// <summary>
- /// Gets all categories attached to this place.
+ /// Gets all the categories attached to this place.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public IEnumerable<PlaceCategory> Categories
{
get
}
/// <summary>
- /// Gets all attributes attached to this place.
+ /// Gets all the attributes attached to this place.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public IEnumerable<PlaceAttribute> Attributes
{
get
}
/// <summary>
- /// Gets all contacts attached to this place.
+ /// Gets all the contacts attached to this place.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public IEnumerable<PlaceContact> Contacts
{
get
}
/// <summary>
- /// Gets all editorials attached to this place.
+ /// Gets all the editorials attached to this place.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public IEnumerable<PlaceEditorial> Editorials
{
get
}
/// <summary>
- /// Gets all images attached to this place.
+ /// Gets all the images attached to this place.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public IEnumerable<PlaceImage> Images
{
get
}
/// <summary>
- /// Gets all reviews attached to this place.
+ /// Gets all the reviews attached to this place.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public IEnumerable<PlaceReview> Reviews
{
get
}
/// <summary>
- /// Releases all resources used by this object.
+ /// Releases all the resources used by this object.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public void Dispose()
{
Dispose(true);
namespace Tizen.Maps
{
/// <summary>
- /// Address information for the map point used in Geocode and Reverse Geocode requests.
+ /// Address information for the map point used in geocode and reverse geocode requests.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public class PlaceAddress : IDisposable
{
internal Interop.AddressHandle handle;
/// <summary>
- /// Constructs map address object.
+ /// Constructs a map address object.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
/// <exception cref="System.InvalidOperationException">Thrown when native operation failed to allocate memory.</exception>
public PlaceAddress()
{
/// <summary>
/// Gets a building number for this address.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public string Building
{
get
/// <summary>
/// Gets a city name for this address.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public string City
{
get
/// <summary>
/// Gets a country name for this address.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public string Country
{
get
/// <summary>
/// Gets a country code for this address.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public string CountryCode
{
get
/// <summary>
/// Gets a county for this address.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public string County
{
get
/// <summary>
/// Gets a district name for this address.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public string District
{
get
/// <summary>
/// Gets a free text associated with this address.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public string FreeText
{
get
/// <summary>
/// Gets a postal code for this address.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public string PostalCode
{
get
/// <summary>
/// Gets a state name for this address.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public string State
{
get
/// <summary>
/// Gets a street name for this address.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public string Street
{
get
/// <summary>
/// Returns a string that represents this object.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
/// <returns>Returns a string which presents this object.</returns>
public override string ToString()
{
}
/// <summary>
- /// Releases all resources used by this object.
+ /// Releases all the resources used by this object.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public void Dispose()
{
Dispose(true);
namespace Tizen.Maps
{
/// <summary>
- /// List of <see cref="PlaceAddress"/> objects to be used in <see cref="MapService"/> APIs
+ /// List of <see cref="PlaceAddress"/> objects to be used in <see cref="MapService"/> APIs.
/// </summary>
internal class PlaceAddressList : IDisposable
{
}
/// <summary>
- /// Releases all resources used by this object.
+ /// Releases all the resources used by this object.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public void Dispose()
{
Dispose(true);
namespace Tizen.Maps
{
/// <summary>
- /// Place Attributes information, used in Place Discovery and Search requests
+ /// Place attributes information, used in place discovery and search requests.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public class PlaceAttribute
{
private string _id;
/// <summary>
/// Gets an ID for the place attribute.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public string Id { get { return _id; } }
/// <summary>
/// Gets a label for the place attribute.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public string Label { get { return _label; } }
/// <summary>
/// Gets a text for the place attribute.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public string Text { get { return _text; } }
/// <summary>
/// Returns a string that represents this object.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
/// <returns>Returns a string which presents this object.</returns>
public override string ToString()
{
namespace Tizen.Maps
{
/// <summary>
- /// Place Category information, used in Place Discovery and Search requests
+ /// Place category information, used in place discovery and search requests.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public class PlaceCategory : IDisposable
{
internal Interop.PlaceCategoryHandle handle;
/// <summary>
- /// Constructs search category object.
+ /// Constructs a search category object.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
/// <exception cref="System.InvalidOperationException">Thrown when native operation failed to allocate memory.</exception>
public PlaceCategory()
{
/// <summary>
/// Gets or sets an ID for this category.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public string Id
{
get { return handle.Id; }
/// <summary>
/// Gets or sets a name for this category.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public string Name
{
get { return handle.Name; }
}
/// <summary>
- /// Gets or sets an URL for this category.
+ /// Gets or sets a URL for this category.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public string Url
{
get { return handle.Url; }
/// <summary>
/// Returns a string that represents this object.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
/// <returns>Returns a string which presents this object.</returns>
public override string ToString()
{
}
/// <summary>
- /// Releases all resources used by this object.
+ /// Releases all the resources used by this object.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public void Dispose()
{
Dispose(true);
namespace Tizen.Maps
{
/// <summary>
- /// Place Contact information, used in Place Discovery and Search requests
+ /// Place contact information, used in place discovery and search requests.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public class PlaceContact
{
private string _label;
/// <summary>
/// Gets an ID for this place contact.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public string Id { get { return _type; } }
/// <summary>
/// Gets a label for this place contact.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public string Label { get { return _label; } }
/// <summary>
/// Gets a value for this place contact.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public string Value { get { return _value; } }
/// <summary>
/// Returns a string that represents this object.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
/// <returns>Returns a string which presents this object.</returns>
public override string ToString()
{
namespace Tizen.Maps
{
/// <summary>
- /// Place Editorial information, used in Place Discovery and Search requests
+ /// Place editorial information, used in place discovery and search requests.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public class PlaceEditorial
{
private string _description;
/// <summary>
/// Gets a description for this place editorial.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public string Description { get { return _description; } }
/// <summary>
/// Gets a language for this place editorial.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public string Language { get { return _language; } }
/// <summary>
/// Gets an instance of <see cref="PlaceMedia"/> object which representing media for this place editorial.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public PlaceMedia Media { get { return _media; } }
/// <summary>
/// Returns a string that represents this object.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
/// <returns>Returns a string which presents this object.</returns>
public override string ToString()
{
namespace Tizen.Maps
{
/// <summary>
- /// Place Filter information, used in Place Discovery and Search requests
+ /// Place filter information, used in place discovery and search requests.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public class PlaceFilter : IDisposable
{
internal Interop.PlaceFilterHandle handle;
/// <summary>
- /// Constructs new place filter.
+ /// Constructs a new place filter.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
/// <exception cref="System.InvalidOperationException">Thrown when native operation failed to allocate memory.</exception>
public PlaceFilter()
{
}
/// <summary>
- /// Gets or sets an free-formed address string for this place filter.
+ /// Gets or sets a free-formed address string for this place filter.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
/// <remarks>Depending on maps provider which the application has selected,
/// it may treat <see cref="PlaceFilter.Name"/>, <see cref="PlaceFilter.Keyword"/> and <see cref="PlaceFilter.Address"/>
- /// as same kind of strings to search places.</remarks>
+ /// as the same kind of strings to search places.</remarks>
public string Address
{
get
/// <summary>
/// Gets or sets an instance of <see cref="PlaceCategory"/> object for this place filter.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public PlaceCategory Category
{
get
/// <summary>
/// Gets or sets a keyword for this place filter.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
/// <remarks>Depending on maps provider which the application has selected,
/// it may treat <see cref="PlaceFilter.Name"/>, <see cref="PlaceFilter.Keyword"/> and <see cref="PlaceFilter.Address"/>
- /// as same kind of strings to search places.</remarks>
+ /// as the same kind of strings to search places.</remarks>
public string Keyword
{
get
/// <summary>
/// Gets or sets a name for this place filter.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
/// <remarks>Depending on maps provider which the application has selected,
/// it may treat <see cref="PlaceFilter.Name"/>, <see cref="PlaceFilter.Keyword"/> and <see cref="PlaceFilter.Address"/>
- /// as same kind of strings to search places.</remarks>
+ /// as the same kind of strings to search places.</remarks>
public string Name
{
get
}
/// <summary>
- /// Releases all resources used by this object.
+ /// Releases all the resources used by this object.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public void Dispose()
{
Dispose(true);
namespace Tizen.Maps
{
/// <summary>
- /// Place Image information, used in Place Discovery and Search requests
+ /// Place image information, used in place discovery and search requests.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public class PlaceImage
{
private string _id;
/// <summary>
/// Gets an ID for this place image.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public string Id { get { return _id; } }
/// <summary>
/// Gets an URL for this place image.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public string Url { get { return _url; } }
/// <summary>
- /// Gets width for this place image.
+ /// Gets the width for this place image.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public int Width { get { return _width; } }
/// <summary>
- /// Gets height for this place image.
+ /// Gets the height for this place image.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public int Height { get { return _height; } }
/// <summary>
- /// Gets an object which representing user link for this place image.
+ /// Gets an object representing the user link for this place image.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public PlaceLink UserLink { get { return _userLink; } }
/// <summary>
- /// Gets an object which representing image media for this place image.
+ /// Gets an object representing the image media for this place image.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public PlaceMedia ImageMedia { get { return _media; } }
}
}
namespace Tizen.Maps
{
/// <summary>
- /// Place Link Object information, used in Place Discovery and Search requests
+ /// Place link object information, used in place discovery and search requests.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public class PlaceLink
{
private string _id;
}
/// <summary>
- /// Gets a string which representing ID for this place link.
+ /// Gets a string representing the ID for this place link.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public string Id { get { return _id; } }
/// <summary>
- /// Gets a string which representing name for this place link.
+ /// Gets a string representing the name for this place link.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public string Name { get { return _name; } }
/// <summary>
- /// Gets a string which representing link for this place link.
+ /// Gets a string representing the link for this place link.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public string Link { get { return _link; } }
/// <summary>
- /// Gets a string which representing type for this place link.
+ /// Gets a string representing the type for this place link.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public string Type { get { return _type; } }
}
}
namespace Tizen.Maps
{
/// <summary>
- /// List of <see cref="Place"/> objects to be used in <see cref="MapService"/> APIs
+ /// List of <see cref="Place"/> objects to be used in <see cref="MapService"/> APIs.
/// </summary>
internal class PlaceList : IDisposable
{
}
/// <summary>
- /// Gets an iterator for addresses in this list.
+ /// Gets an iterator for the addresses in this list.
/// </summary>
public IEnumerable<Place> Places
{
}
/// <summary>
- /// Releases all resources used by this object.
+ /// Releases all the resources used by this object.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public void Dispose()
{
Dispose(true);
namespace Tizen.Maps
{
/// <summary>
- /// Place Media information, used in Place Discovery and Search requests
+ /// Place media information, used in place discovery and search requests.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public class PlaceMedia
{
private string _attribution;
}
/// <summary>
- /// Gets a string which representing attribution for this place media.
+ /// Gets a string representing the attribution for this place media.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public string Attribution { get { return _attribution; } }
/// <summary>
- /// Gets an instance of <see cref="PlaceLink"/> object which representing supplier for this place media.
+ /// Gets an instance of <see cref="PlaceLink"/> object representing the supplier for this place media.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public PlaceLink Supplier { get { return _supplier; } }
/// <summary>
- /// Gets an instance of <see cref="PlaceLink"/> object which representing via data for this place media.
+ /// Gets an instance of <see cref="PlaceLink"/> object representing via data for this place media.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public PlaceLink Via { get { return _via; } }
}
}
namespace Tizen.Maps
{
/// <summary>
- /// Place Rating information, used in Place Discovery and Search requests
+ /// Place rating information, used in place discovery and search requests.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public class PlaceRating
{
private int _count;
/// <summary>
/// Gets the number of users rated for this place rating.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public int UserCount { get { return _count; } }
/// <summary>
- /// Gets average value of this place rating.
+ /// Gets the average value of this place rating.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public double Average { get { return _average; } }
/// <summary>
/// Returns a string that represents this object.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
/// <returns>Returns a string which presents this object.</returns>
public override string ToString()
{
namespace Tizen.Maps
{
/// <summary>
- /// Place Review information, used in Place Discovery and Search requests
+ /// Place review information, used in place discovery and search requests.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public class PlaceReview
{
private DateTime _date;
}
/// <summary>
- /// Gets an instance of <see cref="DateTime"/> object which representing time of this review.
+ /// Gets an instance of <see cref="DateTime"/> object representing the time of this review.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public DateTime Date { get { return _date; } }
/// <summary>
- /// Gets a string which representing title of this review.
+ /// Gets a string representing the title of this review.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public string Title { get { return _title; } }
/// <summary>
- /// Gets a value which representing rating of this review.
+ /// Gets a value representing the rating of this review.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public double Rating { get { return _rating; } }
/// <summary>
- /// Gets a string which representing description of this review.
+ /// Gets a string representing the description of this review.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public string Description { get { return _description; } }
/// <summary>
- /// Gets a string which representing language of this review.
+ /// Gets a string representing the language of this review.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public string Language { get { return _language; } }
/// <summary>
- /// Gets an instance of <see cref="PlaceMedia"/> object which representing review media of this review.
+ /// Gets an instance of <see cref="PlaceMedia"/> object representing the review media of this review.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public PlaceMedia ReviewMedia { get { return _media; } }
/// <summary>
- /// Gets an instance of <see cref="PlaceLink"/> object which representing user link of this review.
+ /// Gets an instance of <see cref="PlaceLink"/> object representing the user link of this review.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public PlaceLink UserLink { get { return _userLink; } }
}
}
namespace Tizen.Maps
{
/// <summary>
- /// Place search request for Tizen map service
+ /// Place search request for Tizen map service.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public class PlaceSearchRequest : MapServiceRequest<Place>
{
private Interop.SearchPlaceCallback _placeCallback;
namespace Tizen.Maps
{
/// <summary>
- /// Polygon map object
+ /// The polygon map object.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public class Polygon : MapObject, IDisposable
{
internal Interop.PolygonHandle handle;
/// <summary>
/// Creates a polygon visual object.
/// </summary>
- /// <since_tizen>3</since_tizen>
- /// <param name="coordinates">List of geographical coordinates</param>
- /// <param name="color">Background color</param>
+ /// <since_tizen> 3 </since_tizen>
+ /// <param name="coordinates">List of geographical coordinates.</param>
+ /// <param name="color">Background color.</param>
/// <exception cref="ArgumentException">Thrown when input values are invalid.</exception>
public Polygon(IEnumerable<Geocoordinates> coordinates, Color color) : base()
{
}
/// <summary>
- /// Adds or removes clicked event handlers.
+ /// Adds or removes the clicked event handlers.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public event EventHandler Clicked;
/// <summary>
/// Gets or sets visibility for the polygon.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public override bool IsVisible
{
get { return handle.IsVisible; }
}
/// <summary>
- /// Gets or sets a list of geographical coordinates of polygon vertices.
+ /// Gets or sets a list of geographical coordinates for polygon vertices.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public IEnumerable<Geocoordinates> Coordinates
{
get
}
/// <summary>
- /// Gets or sets background color to fill the polygon.
+ /// Gets or sets a background color to fill the polygon.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public Color FillColor
{
get
}
/// <summary>
- /// Releases all resources used by this object.
+ /// Releases all the resources used by this object.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public void Dispose()
{
Dispose(true);
namespace Tizen.Maps
{
/// <summary>
- /// Polyline map object
+ /// The polyline map object.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public class Polyline : MapObject, IDisposable
{
internal Interop.PolylineHandle handle;
/// <summary>
/// Creates polyline visual object.
/// </summary>
- /// <since_tizen>3</since_tizen>
- /// <param name="coordinates">List of geographical coordinates</param>
- /// <param name="color">Line color</param>
- /// <param name="width">The width of line [1 ~ 100] (pixels)</param>
- /// <exception cref="ArgumentException">Thrown when input values are invalid</exception>
+ /// <since_tizen> 3 </since_tizen>
+ /// <param name="coordinates">List of geographical coordinates.</param>
+ /// <param name="color">Line color.</param>
+ /// <param name="width">The width of line [1 ~ 100] (pixels).</param>
+ /// <exception cref="ArgumentException">Thrown when input values are invalid.</exception>
public Polyline(List<Geocoordinates> coordinates, Color color, int width) : base()
{
var err = Interop.ErrorCode.InvalidParameter;
}
/// <summary>
- /// Adds or removes clicked event handlers.
+ /// Adds or removes the clicked event handlers.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public event EventHandler Clicked;
/// <summary>
- /// Gets or sets visibility for the polyline.
+ /// Gets or sets the visibility for polyline.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public override bool IsVisible
{
get { return handle.IsVisible; }
/// <summary>
/// Gets or sets a list of geographical coordinates for polyline vertices.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public IEnumerable<Geocoordinates> Coordinates
{
get
}
/// <summary>
- /// Gets or sets line color.
+ /// Gets or sets the line color.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public Color LineColor
{
get
}
/// <summary>
- /// Gets or sets line width from 1 to 100 pixels.
+ /// Gets or sets the line width from 1 to 100 pixels.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public int Width
{
get
}
/// <summary>
- /// Releases all resources used by this object.
+ /// Releases all the resources used by this object.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public void Dispose()
{
Dispose(true);
namespace Tizen.Maps
{
/// <summary>
- /// Reverse geocode request for map service.
+ /// Reverses the geocode request for a map service.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public class ReverseGeocodeRequest : MapServiceRequest<PlaceAddress>
{
private Interop.ReverseGeocodeCallback _geocodeCallback;
/// <summary>
/// Route information, used in Route Search requests.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public class Route : IDisposable
{
internal Interop.RouteHandle handle;
}
/// <summary>
- /// Gets an instance of <see cref="Geocoordinates"/> object which representing destination coordinates for this route.
+ /// Gets an instance of <see cref="Geocoordinates"/> object representing destination coordinates for this route.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public Geocoordinates Destination
{
get
}
/// <summary>
- /// Gets total distance for this route.
+ /// Gets the total distance for this route.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public double Distance
{
get
}
/// <summary>
- /// Get total duration to cover this route.
+ /// Get the total duration to cover this route.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public double Duration
{
get
/// <summary>
/// Gets an ID for this route.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public string Id
{
get
}
/// <summary>
- /// Gets transport mode for this route.
+ /// Gets the transport mode for this route.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public TransportMode Mode
{
get
}
/// <summary>
- /// Gets origin coordinates for this route.
+ /// Gets the origin coordinates for this route.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public Geocoordinates Origin
{
get
/// <summary>
/// Gets a coordinates list for this route.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public IEnumerable<Geocoordinates> Path
{
get
/// <summary>
/// Gets a segment list for this route.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public IEnumerable<RouteSegment> Segments
{
get
}
/// <summary>
- /// Gets distance unit for this route.
+ /// Gets the distance unit for this route.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public DistanceUnit Unit
{
get
}
/// <summary>
- /// Releases all resources used by this object.
+ /// Releases all the resources used by this object.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public void Dispose()
{
Dispose(true);
namespace Tizen.Maps
{
/// <summary>
- /// Route features, used for route search requests
+ /// Route features used for route search requests.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public enum RouteFeature
{
/// <summary>
- /// Indicates no route features (are selected).
+ /// Indicates no route features are selected.
/// </summary>
None = Interop.RouteRequestFeature.None,
/// <summary>
/// </summary>
Toll = Interop.RouteRequestFeature.Toll,
/// <summary>
- /// Indicates motorway.
+ /// Indicates a motorway.
/// </summary>
Motorway = Interop.RouteRequestFeature.MotorWay,
/// <summary>
/// </summary>
BoatFerry = Interop.RouteRequestFeature.BoatFerry,
/// <summary>
- /// Indicates rail (train) ferry.
+ /// Indicates a rail (train) ferry.
/// </summary>
RailFerry = Interop.RouteRequestFeature.RailFerry,
/// <summary>
- /// Indicates public transport.
+ /// Indicates a public transport.
/// </summary>
PublicTransit = Interop.RouteRequestFeature.PublicTransit,
/// <summary>
- /// Indicates tunnel.
+ /// Indicates a tunnel.
/// </summary>
Tunnel = Interop.RouteRequestFeature.Tunnel,
/// <summary>
- /// Indicates dirt road.
+ /// Indicates a dirt road.
/// </summary>
DirtRoad = Interop.RouteRequestFeature.DirtRoad,
/// <summary>
- /// Indicates park.
+ /// Indicates a park.
/// </summary>
Parks = Interop.RouteRequestFeature.Parks,
/// <summary>
namespace Tizen.Maps
{
/// <summary>
- /// Route feature weights used in route search requests
+ /// Route feature weights used in route search requests.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public enum RouteFeatureWeight
{
/// <summary>
namespace Tizen.Maps
{
/// <summary>
- /// Route Maneuver information, used in Route Search requests
+ /// Route maneuver information used in route search requests.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public class RouteManeuver
{
private Interop.RouteDirection _direction;
}
/// <summary>
- /// Gets direction type for this maneuver.
+ /// Gets the direction type for this maneuver.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public DirectionType Direction { get { return (DirectionType)_direction; } }
/// <summary>
- /// Gets turn type for this maneuver.
+ /// Gets the turn type for this maneuver.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public TurnInstruction Turn { get { return (TurnInstruction)_turntype; } }
/// <summary>
/// Gets a geographical coordinates position for this maneuver.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public Geocoordinates Position { get { return _coordinates; } }
/// <summary>
/// Gets a name of the road for this maneuver.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public string Road { get { return _road; } }
/// <summary>
/// Gets an instruction text for this maneuver.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public string Instruction { get { return _instruction; } }
/// <summary>
/// Gets a locale for this maneuver.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public string Locale { get { return _locale; } }
/// <summary>
- /// Gets time to next instruction for this maneuver.
+ /// Gets the time to next instruction for this maneuver.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public int TimeToNextInstruction { get { return _timeToNextInstruction; } }
/// <summary>
- /// Gets distance to next instruction for this maneuver.
+ /// Gets the distance to next instruction for this maneuver.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public double DistanceToNextInstruction { get { return _distanceToNextInstruction; } }
}
}
namespace Tizen.Maps
{
/// <summary>
- /// Allowed route optimization option used in route search requests
+ /// Allowed route optimization option used in route search requests.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
/// <remarks>
- /// Depending on loaded maps plug-in using <see cref="MapService"/>, some features may have no effect or differences with descriptions.
+ /// Depending on the loaded maps plug-in using <see cref="MapService"/>, some features might have no effect or differences with the descriptions.
/// </remarks>
public enum RouteOptimization
{
/// <summary>
- /// Indicates that searching for fastest routes.
+ /// Indicates searching for the fastest routes.
/// </summary>
Fastest = Interop.RouteOptimization.Fastest,
/// <summary>
- /// Indicates that searching for shortest routes (car mode only).
+ /// Indicates searching for the shortest routes (car mode only).
/// </summary>
Shortest = Interop.RouteOptimization.Shortest,
/// <summary>
- /// Indicates that searching for most economic routes (car mode only).
+ /// Indicates searching for the most economic routes (car mode only).
/// </summary>
Economic = Interop.RouteOptimization.Economic,
/// <summary>
- /// Indicates that searching for most scenic routes.
+ /// Indicates searching for the most scenic routes.
/// </summary>
Scenic = Interop.RouteOptimization.Scenic,
/// <summary>
- /// Indicates that searching for most fastest routes now, based on current traffic condition.
+ /// Indicates searching for most the fastest routes now, based on the current traffic condition.
/// </summary>
FastestNow = Interop.RouteOptimization.FastestNow,
/// <summary>
- /// Indicates that searching for direct drive routes.
+ /// Indicates searching for the direct drive routes.
/// </summary>
DirectDrive = Interop.RouteOptimization.DirectDrive,
}
namespace Tizen.Maps
{
/// <summary>
- /// Route search request for Tizen map service requests
+ /// Routes the search request for Tizen map service requests.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public class RouteSearchRequest : MapServiceRequest<Route>
{
private Interop.SearchRouteCallback _routeCallback;
}
/// <summary>
- /// Gets or sets a list of way-points to cover between origin and destination.
+ /// Gets or sets a list of way-points to cover between the origin and destination.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public IEnumerable<Geocoordinates> Waypoints
{
get
namespace Tizen.Maps
{
/// <summary>
- /// Place Segment information, used in Route Search requests
+ /// Place Segment information used in Route Search requests.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public class RouteSegment
{
private Geocoordinates _origin;
}
/// <summary>
- /// Gets an origin coordinates for this segment.
+ /// Gets the origin coordinates for this segment.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public Geocoordinates Origin { get { return _origin; } }
/// <summary>
- /// Gets a destination coordinates for this segment.
+ /// Gets the destination coordinates for this segment.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public Geocoordinates Destination { get { return _destination; } }
/// <summary>
- /// Gets total distance for this segment.
+ /// Gets the total distance for this segment.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public double Distance { get { return _distance; } }
/// <summary>
- /// Gets total duration to cover this segment.
+ /// Gets the total duration to cover this segment.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public double Duration { get { return _duration; } }
/// <summary>
- /// Gets a maneuver list for this segment.
+ /// Gets the maneuver list for this segment.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public IEnumerable<RouteManeuver> Maneuvers { get { return _maneuvers; } }
/// <summary>
- /// Gets a coordinates list for this segment.
+ /// Gets the coordinates list for this segment.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public IEnumerable<Geocoordinates> Path { get { return _path; } }
private Area BoundingBox { get { return _boundingBox; } }
namespace Tizen.Maps
{
/// <summary>
- /// Preferences for route search requests
+ /// Preferences for route search requests.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public class SearchPreference : IGeocodePreference, IPlaceSearchPreference, IRouteSearchPreference, IDisposable
{
internal Interop.PreferenceHandle handle;
private IDictionary<string, string> _properties = new Dictionary<string, string>();
/// <summary>
- /// Constructors a new search preference.
+ /// Constructor for a new search preference.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public SearchPreference()
{
handle = new Interop.PreferenceHandle();
}
/// <summary>
- /// Constructors a new search preference.
+ /// Constructor for a new search preference.
/// </summary>
internal SearchPreference(Interop.PreferenceHandle nativeHandle)
{
}
/// <summary>
- /// Gets or sets preferred language.
+ /// Gets or sets a preferred language.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
/// <remarks>Language should be specified as an ISO 3166 alpha-2 two letter country-code
/// followed by ISO 639-1 for the two-letter language code.<br/>e.g. "ko-KR", "en-US".</remarks>
public string Language
/// <summary>
/// Gets or sets the maximum result count for each service request.
/// </summary>
- /// <since_tizen>3</since_tizen>
- /// <remarks>Setting negative value will not have any effect on MaxResults value</remarks>
+ /// <since_tizen> 3 </since_tizen>
+ /// <remarks>Setting negative value will not have any effect on MaxResults value.</remarks>
public int MaxResults
{
get
}
/// <summary>
- /// Gets or sets distance unit.
+ /// Gets or sets the distance unit.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public DistanceUnit Unit
{
get
}
/// <summary>
- /// Gets or sets preferred country.
+ /// Gets or sets the preferred country.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public string CountryCode
{
get
}
/// <summary>
- /// Gets or sets search properties as key value pair.
+ /// Gets or sets the search properties as a key value pair.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public IReadOnlyDictionary<string, string> Properties
{
get
}
/// <summary>
- /// Gets or sets route optimization.
+ /// Gets or sets the route optimization.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public RouteOptimization Optimization
{
get
}
/// <summary>
- /// Gets or sets route transport mode.
+ /// Gets or sets the route transport mode.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public TransportMode Mode
{
get
}
/// <summary>
- /// Gets or sets route feature weight.
+ /// Gets or sets the route feature weight.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public RouteFeatureWeight RouteFeatureWeight
{
get
}
/// <summary>
- /// Gets or sets route feature.
+ /// Gets or sets the route feature.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public RouteFeature RouteFeature
{
get
}
/// <summary>
- /// Gets or sets if searching for alternative routes is enabled.
+ /// Gets or sets if the searching for alternative routes is enabled.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public bool SearchAlternativeRoutes
{
get
}
/// <summary>
- /// Releases all resources used by this object.
+ /// Releases all the resources used by this object.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public void Dispose()
{
Dispose(true);
namespace Tizen.Maps
{
/// <summary>
- /// Features available in the Map Service
+ /// Features available in the map service.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public enum ServiceData
{
/// <summary>
- /// Indicates availability of address value in the Place data.
+ /// Indicates availability of address value in the place data.
/// </summary>
PlaceAddress = Interop.ServiceData.PlaceAddress,
/// <summary>
- /// Indicates availability of rating value in the Place data.
+ /// Indicates availability of rating value in the place data.
/// </summary>
PlaceRating = Interop.ServiceData.PlaceRating,
/// <summary>
- /// Indicates availability of place category list in the Place data.
+ /// Indicates availability of place category list in the place data.
/// </summary>
PlaceCategories = Interop.ServiceData.PlaceCategories,
/// <summary>
- /// Indicates availability of place attribute list in the Place data.
+ /// Indicates availability of place attribute list in the place data.
/// </summary>
PlaceAttributes = Interop.ServiceData.PlaceAttributes,
/// <summary>
- /// Indicates availability of place contact list in the Place data.
+ /// Indicates availability of place contact list in the place data.
/// </summary>
PlaceContacts = Interop.ServiceData.PlaceContacts,
/// <summary>
- /// Indicates availability of place editorial list in the Place data.
+ /// Indicates availability of place editorial list in the place data.
/// </summary>
PlaceEditorials = Interop.ServiceData.PlaceEditorials,
/// <summary>
- /// Indicates availability of place review list in the Place data.
+ /// Indicates availability of place review list in the place data.
/// </summary>
PlaceReviews = Interop.ServiceData.PlaceReviews,
/// <summary>
- /// Indicates availability of place image in Place the data.
+ /// Indicates availability of place image in the place data.
/// </summary>
PlaceImage = Interop.ServiceData.PlaceImage,
/// <summary>
- /// Indicates availability of place supplier link value in the Place data.
+ /// Indicates availability of place supplier link value in the place data.
/// </summary>
PlaceSupplier = Interop.ServiceData.PlaceSupplier,
/// <summary>
- /// Indicates availability of related place link in the Place data.
+ /// Indicates availability of a related place link in the place data.
/// </summary>
PlaceRelated = Interop.ServiceData.PlaceRelated,
/// <summary>
- /// Indicates that the Route Data Structure is defined as a Path (a list of geographical coordinates).
+ /// Indicates that the route data structure is defined as a path (a list of geographical coordinates).
/// </summary>
RoutePath = Interop.ServiceData.RoutePath,
/// <summary>
- /// Indicates that the Route Data Structure is defined as a list of Segments while each segment is defined as a Path.
+ /// Indicates that the route data structure is defined as a list of segments while each segment is defined as a path.
/// </summary>
RouteSegmentsPath = Interop.ServiceData.RouteSegmentsPath,
/// <summary>
- /// Indicates that the Route Data Structure is defined as a list of Segments while each segment is defined as a list of Maneuvers.
+ /// Indicates that the route data structure is defined as a list of segments while each segment is defined as a list of maneuvers.
/// </summary>
RouteSegmentsManeuvers = Interop.ServiceData.RouteSegmentsManeuvers,
/// <summary>
- /// Indicates availability of traffic information on the Map.
+ /// Indicates availability of traffic information on the map.
/// </summary>
ViewTraffic = Interop.ServiceData.ViewTraffic,
/// <summary>
- /// Indicates availability of public transit information on the Map.
+ /// Indicates availability of public transit information on the map.
/// </summary>
ViewPublicTransit = Interop.ServiceData.ViewPublicTransit,
/// <summary>
- /// Indicates availability of 3D building drawable on the Map.
+ /// Indicates availability of 3D building drawable on the map.
/// </summary>
ViewBuilding = Interop.ServiceData.ViewBuilding,
/// <summary>
- /// Indicates availability of scale bar on the Map.
+ /// Indicates availability of scale bar on the map.
/// </summary>
ViewScaleBar = Interop.ServiceData.ViewScaleBar,
}
namespace Tizen.Maps
{
/// <summary>
- /// Service Requests available in the Maps Service
+ /// Service requests available in the maps service.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public enum ServiceRequestType
{
/// <summary>
- /// Indicates that service request to get position <see cref="Geocoordinates"/> for a given free-formed address string is allowed.
+ /// Indicates the service request to get position <see cref="Geocoordinates"/> for a given free-formed address string is allowed.
/// </summary>
Geocode = Interop.ServiceType.Geocode,
/// <summary>
namespace Tizen.Maps
{
/// <summary>
- /// Enumeration for snapshot file formats
+ /// Enumeration for the snapshot file formats.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public enum SnapshotType
{
/// <summary>
- /// Indicates BMP file format.
+ /// Indicates the BMP file format.
/// </summary>
BMP = Interop.ViewSnapshotFormatType.ViewSnapshotBmp,
/// <summary>
- /// Indicates JPEG file format.
+ /// Indicates the JPEG file format.
/// </summary>
JPEG = Interop.ViewSnapshotFormatType.ViewSnapshotJpeg,
}
namespace Tizen.Maps
{
/// <summary>
- /// Route types
+ /// Route types.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public enum TransportMode
{
/// <summary>
- /// Indicates that route is to be traveled by car.
+ /// Indicates that the route is to be traveled by a car.
/// </summary>
Car = Interop.RouteTransportMode.Car,
/// <summary>
- /// Indicates that route is for a pedestrian.
+ /// Indicates that the route is for a pedestrian.
/// </summary>
Pedestrian = Interop.RouteTransportMode.Pedestrian,
/// <summary>
- /// Indicates that route is for a cyclist.
+ /// Indicates that the route is for a cyclist.
/// </summary>
Bicycle = Interop.RouteTransportMode.Bicycle,
/// <summary>
- /// Indicates that route is to be traveled using public transport.
+ /// Indicates that the route is to be traveled using public transport.
/// </summary>
PublicTransit = Interop.RouteTransportMode.PublicTransit,
/// <summary>
- /// Indicates that route is for a truck.
+ /// Indicates that the route is for a truck.
/// </summary>
Truck = Interop.RouteTransportMode.Truck,
}
namespace Tizen.Maps
{
/// <summary>
- /// Turn Instruction type for route maneuver
+ /// Turns the Instruction type for route maneuver.
/// </summary>
- /// <since_tizen>3</since_tizen>
+ /// <since_tizen> 3 </since_tizen>
public enum TurnInstruction
{
/// <summary>
- /// Indicates unknown instruction.
+ /// Indicates an unknown instruction.
/// </summary>
None = Interop.RouteTurnType.None,
/// <summary>
/// </summary>
HardRight = Interop.RouteTurnType.HardRight,
/// <summary>
- /// Indicates instruction to u-turn to the right.
+ /// Indicates instruction to U-turn to the right.
/// </summary>
UturnRight = Interop.RouteTurnType.UturnRight,
/// <summary>
- /// Indicates instruction to u-turn to the left.
+ /// Indicates instruction to U-turn to the left.
/// </summary>
UturnLeft = Interop.RouteTurnType.UturnLeft,
/// <summary>
projects / platform / core / csapi / tizenfx.git / commitdiff
