-/*
+/*
* Copyright (c) 2016 Samsung Electronics Co., Ltd All Rights Reserved
*
* Licensed under the Apache License, Version 2.0 (the License);
/// <summary>
/// Utility method to check for error, returns false if failed and print warning messages
/// </summary>
- /// <returns>true in case of no error, false otherwise</returns>
+ /// <returns>Returns true in case of no error, otherwise false.</returns>
internal static bool WarnIfFailed(this Interop.ErrorCode err, string msg, [CallerFilePath] string file = "", [CallerMemberName] string func = "", [CallerLineNumber] int line = 0)
{
if (err.IsFailed())
/// <summary>
/// Utility method to check for error, returns false if failed and throw exception
/// </summary>
- /// <returns>true in case of no error</returns>
+ /// <returns>Returns true in case of no error, otherwise false.</returns>
internal static bool ThrowIfFailed(this Interop.ErrorCode err, string msg, [CallerFilePath] string file = "", [CallerMemberName] string func = "", [CallerLineNumber] int line = 0)
{
if (err.IsFailed())
default: return new System.InvalidOperationException(errMessage);
}
}
-}
\ No newline at end of file
+}
internal Interop.AreaHandle handle;
/// <summary>
- /// Constructs rectangular area
+ /// Constructs rectangular area.
/// </summary>
/// <param name="topLeft">Top left coordinate of the area</param>
/// <param name="bottomRight">Bottom left coordinate of the area</param>
- /// <exception cref="System.ArgumentException">Throws if input coordinates are invalid</exception>
- /// <exception cref="System.InvalidOperationException">Throws if native operation failed to allocate memory</exception>
+ /// <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>
public Area(Geocoordinates topLeft, Geocoordinates bottomRight)
{
handle = new Interop.AreaHandle(topLeft?.handle, bottomRight?.handle);
}
/// <summary>
- /// Constructs circular area
+ /// Constructs circular area.
/// </summary>
/// <param name="center">Coordinate for center of the area</param>
/// <param name="radius">Radius of the area</param>
- /// <exception cref="System.ArgumentException">Throws if input coordinates are invalid</exception>
- /// <exception cref="System.InvalidOperationException">Throws if native operation failed to allocate memory</exception>
+ /// <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>
public Area(Geocoordinates center, double radius)
{
handle = new Interop.AreaHandle(center?.handle, radius);
}
}
+ /// <summary>
+ /// Releases all resources used by this object.
+ /// </summary>
public void Dispose()
{
Dispose(true);
public enum DirectionType
{
/// <summary>
- /// Unknown direction
+ /// Indicates unknown direction.
/// </summary>
None = Interop.RouteDirection.None,
/// <summary>
- /// North direction
+ /// Indicates north direction.
/// </summary>
North = Interop.RouteDirection.North,
/// <summary>
- /// North-West direction
+ /// Indicates north-west direction.
/// </summary>
NorthWest = Interop.RouteDirection.NorthWest,
/// <summary>
- /// North-East direction
+ /// Indicates north-east direction.
/// </summary>
NorthEast = Interop.RouteDirection.NorthEast,
/// <summary>
- /// South direction
+ /// Indicates south direction.
/// </summary>
South = Interop.RouteDirection.South,
/// <summary>
- /// South-East direction
+ /// Indicates south-East direction.
/// </summary>
SouthEast = Interop.RouteDirection.SouthEast,
/// <summary>
- /// South-West direction
+ /// Indicates south-West direction.
/// </summary>
SouthWest = Interop.RouteDirection.SouthWest,
/// <summary>
- /// West direction
+ /// Indicates west direction.
/// </summary>
West = Interop.RouteDirection.West,
/// <summary>
- /// East direction
+ /// Indicates east direction.
/// </summary>
East = Interop.RouteDirection.East,
}
public enum DistanceUnit
{
/// <summary>
- /// Meter
+ /// Indicates meter unit.
/// </summary>
Meter = Interop.DistanceUnit.Meter,
/// <summary>
- /// Kilometer
+ /// Indicates kilometer unit.
/// </summary>
Kilometer = Interop.DistanceUnit.Kilometer,
/// <summary>
- /// Foot
+ /// Indicates foot unit.
/// </summary>
Foot = Interop.DistanceUnit.Foot,
/// <summary>
- /// Yard
+ /// Indicates yard unit.
/// </summary>
Yard = Interop.DistanceUnit.Yard,
}
namespace Tizen.Maps
{
/// <summary>
- /// Class representing geographical co-ordinates
+ /// Class representing geographical coordinates.
/// </summary>
public class Geocoordinates : IDisposable
{
internal Interop.CoordinatesHandle handle;
/// <summary>
- /// Constructs map coordinate object
+ /// Constructs map coordinate object.
/// </summary>
- /// <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">Throws if values for latitude and longitude are not valid</exception>
- /// <exception cref="System.InvalidOperationException">Throws if native operation failed to allocate memory</exception>
+ /// <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>
public Geocoordinates(double latitude, double longitude)
{
handle = new Interop.CoordinatesHandle(latitude, longitude);
}
/// <summary>
- /// Latitude for this coordinate
+ /// Gets latitude of the coordinates.
/// </summary>
public double Latitude
{
}
/// <summary>
- /// Longitude for this coordinate
+ /// Gets longitude of the coordinates.
/// </summary>
public double Longitude
{
}
/// <summary>
- /// String that represents this coordinate
+ /// Returns a string that represents this object.
/// </summary>
public override string ToString()
{
}
}
+ /// <summary>
+ /// Releases all resources used by this object.
+ /// </summary>
public void Dispose()
{
Dispose(true);
}
}
+ /// <summary>
+ /// Releases all resources used by this object.
+ /// </summary>
public void Dispose()
{
Dispose(true);
public enum GestureType
{
/// <summary>
- /// Indicates empty gesture
+ /// Indicates empty gesture.
/// </summary>
None = Interop.ViewGesture.None,
/// <summary>
- /// Indicates the move map user gesture
+ /// Indicates the move map user gesture.
/// </summary>
Scroll = Interop.ViewGesture.Scroll,
/// <summary>
- /// Indicates the zoom user gesture
+ /// Indicates the zoom user gesture.
/// </summary>
Zoom = Interop.ViewGesture.Zoom,
/// <summary>
- /// Indicates the tap user gesture
+ /// Indicates the tap user gesture.
/// </summary>
Tap = Interop.ViewGesture.Tap,
/// <summary>
- /// Indicates the double tap user gesture
+ /// Indicates the double tap user gesture.
/// </summary>
DoubleTap = Interop.ViewGesture.DoubleTap,
/// <summary>
- /// Indicates the two-finger tap user gesture
+ /// Indicates the two-finger tap user gesture.
/// </summary>
TwoFingerTap = Interop.ViewGesture.TwoFingerTap,
/// <summary>
- /// Indicates the rotation user gesture
+ /// Indicates the rotation user gesture.
/// </summary>
Rotate = Interop.ViewGesture.Rotate,
/// <summary>
- /// Indicates the long press user gesture
+ /// Indicates the long press user gesture.
/// </summary>
LongPress = Interop.ViewGesture.LongPress,
}
public interface IGeocodePreference
{
/// <summary>
- /// Preferred language
+ /// Gets or sets a string that presents preferred language.
/// </summary>
- /// <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 e.g. "ko-KR"
- /// </remarks>
+ /// <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>
- /// Maximum result count for a service request
+ /// Gets or sets the maximum number of results.
/// </summary>
- /// <remarks>Setting negative value will not have any effect on MaxResults value</remarks>
+ /// <remarks>Setting negative value will not have any effect on MaxResults value.</remarks>
int MaxResults { get; set; }
}
-}
\ No newline at end of file
+}
public interface IPlaceSearchPreference
{
/// <summary>
- /// Distance unit
+ /// Gets or sets distance unit.
/// </summary>
DistanceUnit Unit { get; set; }
/// <summary>
- /// Preferred language
+ /// Gets or sets preferred language.
/// </summary>
- /// <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 e.g. "ko-KR"
- /// </remarks>
+ /// <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>
- /// Maximum result count for a service request
+ /// Gets or sets the maximum number of results.
/// </summary>
int MaxResults { get; set; }
/// <summary>
- /// Preferred country
+ /// Gets or sets a string that represents code of preferred country.
/// </summary>
string CountryCode { get; set; }
/// <summary>
- /// Search properties as key value pair
+ /// Gets or sets search properties as key value pair.
/// </summary>
IReadOnlyDictionary<string, string> Properties { get; set; }
}
-}
\ No newline at end of file
+}
public interface IRouteSearchPreference
{
/// <summary>
- /// Distance unit
+ /// Gets or sets distance unit.
/// </summary>
DistanceUnit Unit { get; set; }
/// <summary>
- /// Selected route optimization
+ /// Gets or sets route optimization.
/// </summary>
RouteOptimization Optimization { get; set; }
/// <summary>
- /// Route transport mode
+ /// Gets or sets route transport mode.
/// </summary>
TransportMode Mode { get; set; }
/// <summary>
- /// Route feature weight
+ /// Gets or sets route feature weight.
/// </summary>
RouteFeatureWeight RouteFeatureWeight { get; set; }
/// <summary>
- /// Route feature
+ /// Gets or sets route feature.
/// </summary>
RouteFeature RouteFeature { get; set; }
/// <summary>
- /// Indicate if search for alternative routes is enabled.
+ /// Gets or sets if searching for alternative routes is enabled.
/// </summary>
bool SearchAlternativeRoutes { get; set; }
}
}
/// <summary>
- /// Type of gesture event
+ /// Gets type of gesture event.
/// </summary>
public GestureType GestureType { get; }
/// <summary>
- /// Screen coordinates for the event
+ /// Gets screen coordinates in the event.
/// </summary>
public Point Position { get; }
/// <summary>
- /// Number of fingers detected in the event
+ /// Gets the number of fingers detected in the event.
/// </summary>
public int TouchCount { get; }
/// <summary>
- /// Zoom factor for zoom gesture event
+ /// Gets zoom factor for zoom gesture event.
/// </summary>
public double ZoomFactor { get; }
/// <summary>
- /// Angle of rotation for rotate gesture event
+ /// Gets angle of rotation for rotate gesture event.
/// </summary>
public double RotationAngle { get; }
/// <summary>
- /// Geo-coordinates for the event
+ /// Gets geographical coordinates for the event.
/// </summary>
public Geocoordinates Geocoordinates { get; }
}
internal MapObject() { }
/// <summary>
- /// Map Object's visibility
+ /// Gets or sets visibility of the map object.
/// </summary>
public abstract bool IsVisible { get; set; }
+
internal abstract void HandleClickedEvent();
+
internal abstract void InvalidateMapObject();
+
internal abstract Interop.ViewObjectHandle GetHandle();
}
}
/// <summary>
- /// Creates a new Maps Service object for given service provider
+ /// Creates a new Maps Service object for given service provider.
/// </summary>
- /// <param name="serviceProvider">Name of map service provider</param>
- /// <param name="serviceProviderKey">Key string provided by map service provider</param>
- /// <exception cref="System.ArgumentException">Throws if parameters are invalid</exception>
- /// <exception cref="System.InvalidOperationException">Throws if native operation failed to allocate memory, connect to service</exception>
- /// <exception cref="System.UnauthorizedAccessException">Throws if user does not have privilege to access this API</exception>
+ /// <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>
+ /// <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.UnauthorizedAccessException">Thrown when application does not have some privilege to access this method.</exception>
public MapService(string serviceProvider, string serviceProviderKey)
{
_serviceProvider = serviceProvider;
}
/// <summary>
- /// List of available map service providers
+ /// Gets list of available map service providers.
/// </summary>
+ /// <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>
public static IEnumerable<string> Providers
{
get
}
/// <summary>
- /// Name of map service provider
+ /// Gets name of map service provider.
/// </summary>
public string Provider { get { return _serviceProvider; } }
/// <summary>
- /// Key for map service provider
+ /// Gets and sets a string representing keys for map service provider
/// </summary>
+ /// <remark>Regaularly, 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.</remark>
public string ProviderKey
{
get
}
/// <summary>
- /// Filter used for place search result
+ /// Gets and sets a filter used for place search result.
/// </summary>
public PlaceFilter PlaceSearchFilter
{
}
/// <summary>
- /// Search preferences used for Geocode/ ReverseGeocode request
+ /// Gets search preferences used for <see cref="Geocode"/> or <see cref="ReverseGeocode"/> request.
/// </summary>
public IGeocodePreference GeocodePreferences
{
}
/// <summary>
- /// Search preferences used for <see cref="Place"/> search request
+ /// Gets search preferences used for <see cref="Place"/> search request.
/// </summary>
public IPlaceSearchPreference PlaceSearchPreferences
{
}
/// <summary>
- /// Search preferences used for <see cref="Route"/> search request
+ /// Gets search preferences used for <see cref="Route"/> search request.
/// </summary>
public IRouteSearchPreference RouteSearchPreferences
{
}
/// <summary>
- /// Search preferences
+ /// Gets and sets search preferences.
/// </summary>
public SearchPreference Preferences
{
}
/// <summary>
- /// Gets the user's consent to use maps data
+ /// Gets the user's consent to use maps data.
/// </summary>
- /// <returns>true if user agreed that the application can use maps data, false otherwise</returns>
+ /// <param name="provider">A string which representing the name of maps provider</param>
+ /// <returns>Returns true if user agreed that the application can use maps data, 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>
public static async Task<bool> RequestUserConsent(string provider)
{
TaskCompletionSource<bool> tcs = new TaskCompletionSource<bool>();
}
/// <summary>
- /// Checks if the Maps Service supports given request
+ /// Checks if the Maps Service supports given request.
/// </summary>
- /// <param name="type">request type to be checked</param>
- /// <returns>true if the Maps Service supports a request, false otherwise</returns>
+ /// <param name="type">Request type to check</param>
+ /// <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>
public bool IsSupported(ServiceRequestType type)
{
bool result;
}
/// <summary>
- /// Checks if the Maps Service supports given data feature
+ /// Checks if the Maps Service supports given data feature.
/// </summary>
- /// <param name="data">data feature to be checked </param>
- /// <returns>true if the Maps Service supports a data feature, false otherwise</returns>
+ /// <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>
public bool IsSupported(ServiceData data)
{
bool result;
}
/// <summary>
- /// Creates gGeocode search request for given free-formed address string
+ /// Creates geocode search request for given free-formed address string.
/// </summary>
- /// <param name="address">Free-formed address</param>
- /// <returns>Returns GeocodeRequest object created with address string</returns>
+ /// <param name="address">A string which representing free-formed address</param>
+ /// <returns>GeocodeRequest object created with 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 geocode search request for given free-formed address string, within the specified boundary.
/// </summary>
- /// <param name="address">Free-formed address</param>
- /// <param name="boundary">Interested area</param>
- /// <returns>Returns GeocodeRequest object created with address string and specified boundary</returns>
+ /// <param name="address">A string which representing free-formed address</param>
+ /// <param name="boundary">An instance of Area object which representing interested area</param>
+ /// <seealso cref="Area">
+ /// <returns>GeocodeRequest object created with address string and 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 geocode search request for given structured address.
/// </summary>
- /// <param name="address">address of interest</param>
+ /// <param name="address">A string which representing address of interest</param>
/// <returns>Returns GeocodeRequest object created with structured address</returns>
public GeocodeRequest CreateGeocodeRequest(PlaceAddress address)
{
}
/// <summary>
- /// Creates reverse geocode search request for given latitude and longitude
+ /// Creates a reverse geocode search request for given latitude and longitude.
/// </summary>
- /// <param name="latitude">Latitude for location of interest</param>
- /// <param name="longitute">Longitude for location of interest</param>
+ /// <param name="latitude">Latitude of interested place</param>
+ /// <param name="longitute">Longitude of interested place</param>
/// <returns>Returns ReverseGeocodeRequest object created with location coordinates</returns>
public ReverseGeocodeRequest CreateReverseGeocodeRequest(double latitude, double longitute)
{
}
/// <summary>
- /// Creates reverse geocode search request for given position coordinates list
+ /// Creates a reverse geocode search request for given position coordinates list.
/// </summary>
/// <param name="coordinates">Coordinates list with [2 ~ 100] coordinates</param>
/// <returns>Returns MultiReverseGeocodeRequest object created with list of location coordinates</returns>
}
/// <summary>
- /// Creates route search request for origin and destination points
+ /// Creates a route search request for origin and destination points.
/// </summary>
- /// <param name="from">starting point</param>
- /// <param name="to">destination</param>
+ /// <param name="from">Starting point</param>
+ /// <param name="to">Destination</param>
/// <returns>Returns RouteSearchRequest object created with origin and destination coordinates</returns>
public RouteSearchRequest CreateRouteSearchRequest(Geocoordinates from, Geocoordinates to)
{
}
/// <summary>
- /// Creates place search request for specified search radius around a given coordinates position
+ /// Creates a place search request for specified search radius around a given coordinates position.
/// </summary>
- /// <param name="coordinates">Interested position</param>
- /// <param name="distance">Search radius</param>
+ /// <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>
public PlaceSearchRequest CreatePlaceSearchRequest(Geocoordinates coordinates, int distance)
{
}
/// <summary>
- /// Creates place search for places within specified boundary
+ /// Creates a place search request for places within specified boundary.
/// </summary>
- /// <param name="boundary">Interested area</param>
+ /// <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>
public PlaceSearchRequest CreatePlaceSearchRequest(Area boundary)
{
}
/// <summary>
- /// Creates place search for free formed address within boundary
+ /// Creates a place search request for free-formed address within boundary.
/// </summary>
- /// <param name="address">Free-formed address</param>
- /// <param name="boundary">Interested area</param>
+ /// <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>
public PlaceSearchRequest CreatePlaceSearchRequest(string address, Area boundary)
{
}
}
+ /// <summary>
+ /// Releases all resources used by this object.
+ /// </summary>
public void Dispose()
{
Dispose(true);
internal MapService _service;
/// <summary>
- /// Creates map service request
+ /// Creates a map service request.
/// </summary>
/// <param name="service">map service object</param>
/// <param name="type">Request type</param>
}
/// <summary>
- /// Sends request to map service provider
+ /// Sends a request to map service provider.
/// </summary>
/// <returns>Response from map service provider</returns>
- /// <exception cref="TaskCanceledException">Throws if request is canceled</exception>
- /// <exception cref="InvalidOperationException">Throws if native operation failed</exception>
- /// <exception cref="ArgumentException">Throws if arguments are invalid</exception>
+ /// <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>
public async Task<IEnumerable<T>> GetResponseAsync()
{
IEnumerable<T> task = null;
}
}
+ /// <summary>
+ /// Releases all resources used by this object.
+ /// </summary>
public void Dispose()
{
Dispose(true);
-/*
+/*
* Copyright (c) 2016 Samsung Electronics Co., Ltd All Rights Reserved
*
* Licensed under the Apache License, Version 2.0 (the License);
public enum MapTypes
{
/// <summary>
- /// Normal street theme
+ /// Indicates normal street theme.
/// </summary>
Normal = Interop.ViewType.Normal,
/// <summary>
- /// Satellite theme
+ /// Indicates satellite theme.
/// </summary>
Satellite = Interop.ViewType.Satellite,
/// <summary>
- /// Terrain theme
+ /// Indicates terrain theme.
/// </summary>
Terrain = Interop.ViewType.Terrain,
/// <summary>
- /// Hybrid theme, has both satellite and normal theme
+ /// Indicates hybrid theme, has both satellite and normal theme.
/// </summary>
Hybrid = Interop.ViewType.Hybrid,
}
-}
\ No newline at end of file
+}
namespace Tizen.Maps
{
/// <summary>
- /// Map View
+ /// Map View class to show a map on the screen.
/// </summary>
public class MapView : Layout, IDisposable
{
private event EventHandler _viewReadyEventHandler;
/// <summary>
- /// Creates the View and link it to the instance of map service
+ /// Creates the view and link it to the instance of map service.
/// </summary>
- /// <param name="parent">The evas object to be drawn</param>
- /// <param name="service">Map service</param>
+ /// <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>
+ /// <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>
public MapView(EvasObject parent, MapService service) : base(parent)
{
handle = new Interop.ViewHandle(service.handle, this);
}
/// <summary>
- /// Scrolled gesture event
+ /// Adds or removes event handlers to deliver scrolled gesture event.
/// </summary>
+ /// <value>Event handlers to get scrolled gesture event</value>
+ /// <exception cref="System.NotSupportedException">Thrown when the required feature is not supported.</exception>
public event EventHandler<MapGestureEventArgs> Scrolled
{
add
}
/// <summary>
- /// ZoomChanged gesture event
+ /// Adds or removes event handlers to deliver zoomed gesture event.
/// </summary>
+ /// <value>Event handlers to get zoomed gesture event</value>
+ /// <exception cref="System.NotSupportedException">Thrown when the required feature is not supported.</exception>
public event EventHandler<MapGestureEventArgs> ZoomChanged
{
add
}
/// <summary>
- /// Clicked gesture event
+ /// Adds or removes event handlers to deliver clicked gesture event.
/// </summary>
+ /// <value>Event handlers to get clicked gesture event</value>
+ /// <exception cref="System.NotSupportedException">Thrown when the required feature is not supported.</exception>
public event EventHandler<MapGestureEventArgs> Clicked
{
add
}
/// <summary>
- /// DoubleClicked gesture event
+ /// Adds or removes event handlers to deliver double-clicked gesture event.
/// </summary>
+ /// <value>Event handlers to get double-clicked gesture event</value>
+ /// <exception cref="System.NotSupportedException">Thrown when the required feature is not supported.</exception>
public event EventHandler<MapGestureEventArgs> DoubleClicked
{
add
}
/// <summary>
- /// TwoFingerPressed gesture event
+ /// Adds or removes event handlers to deliver clicked gesture event with two-fingers.
/// </summary>
+ /// <value>Event handlers to get clicked gesture event</value>
+ /// <exception cref="System.NotSupportedException">Thrown when the required feature is not supported.</exception>
public event EventHandler<MapGestureEventArgs> TwoFingerPressed
{
add
}
/// <summary>
- /// Rotated gesture event
+ /// Adds or removes event handlers to deliver rotated gesture event.
/// </summary>
+ /// <value>Event handlers to get rotated gesture event</value>
+ /// <exception cref="System.NotSupportedException">Thrown when the required feature is not supported.</exception>
public event EventHandler<MapGestureEventArgs> Rotated
{
add
}
}
+
/// <summary>
- /// LongPressed gesture event
+ /// Adds or removes event handlers to deliver long-pressed gesture event.
/// </summary>
+ /// <value>Event handlers to get long-pressed gesture event</value>
+ /// <exception cref="System.NotSupportedException">Thrown when the required feature is not supported.</exception>
public event EventHandler<MapGestureEventArgs> LongPressed
{
add
}
/// <summary>
- /// ViewReady gesture event
+ /// Adds or removes event handlers to deliver a event representing the view is ready to be used.
/// </summary>
+ /// <value>Event handlers to get view ready event</value>
+ /// <exception cref="System.NotSupportedException">Thrown when the required feature is not supported.</exception>
public event EventHandler ViewReady
{
add
}
/// <summary>
- /// Map View's current zoom level
+ /// Gets or sets current zoom level.
/// </summary>
+ /// <value>It is an integer value that representing current zoom level.</value>
+ /// <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>
public int ZoomLevel
{
get
}
/// <summary>
- /// Minimum zoom level for map view
+ /// Gets or sets minimum zoom level.
/// </summary>
+ /// <value>It is an integer value that limits minimal zoom level within range of current map plug-in supported.</value>
+ /// <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>
public int MinimumZoomLevel
{
get
}
/// <summary>
- /// Maximum zoom level for map view
+ /// Gets or sets maximum zoom level.
/// </summary>
+ /// <value>It is an integer value that limits maximum zoom level within range of current map plug-in supported.</value>
+ /// <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>
public int MaximumZoomLevel
{
get
}
/// <summary>
- /// orientation on the View [0 ~ 360 degrees]
+ /// Gets or sets orientation on the map view.
/// </summary>
+ /// <value>It is an integer value from 0 to 360 that indicates orientation of the map view</value>
+ /// <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>
public double Orientation
{
get
}
/// <summary>
- /// Map view type (theme)
+ /// Gets or sets theme type of the map view.
/// </summary>
+ /// <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>
public MapTypes MapType
{
get
}
/// <summary>
- /// Indicates whether the map should show the 3D buildings layer
+ /// Indicates whether the map should show the 3D buildings layer.
/// </summary>
+ /// <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>
public bool BuildingsEnabled
{
get
}
/// <summary>
- /// Indicates whether the map should show the traffic layer
+ /// Indicates whether the map should show the traffic layer.
/// </summary>
+ /// <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>
public bool TrafficEnabled
{
get
}
/// <summary>
- /// Indicates whether the map should show the public transit layer
+ /// Indicates whether the map should show the public transit layer.
/// </summary>
+ /// <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>
public bool PublicTransitEnabled
{
get
}
/// <summary>
- /// Gets whether the scale-bar is enabled or not
+ /// Indicates whether the scale-bar is enabled or not.
/// </summary>
+ /// <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>
public bool ScalebarEnabled
{
get
}
/// <summary>
- /// Map view's language
+ /// Sets language of map view.
/// </summary>
+ /// <value>The display language in the map.
+ /// A language is specified as an ISO 3166 alpha-2 two letter country-code
+ /// followed by ISO 639-1 for the two-letter language code.
+ /// 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>
+ /// <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.ArgumentException">Thrown when the value is invalid.</exception>
public string Language
{
get
}
/// <summary>
- /// Geographical coordinates for map view's center
+ /// Gets or sets geographical coordinates for map view's center.
/// </summary>
+ /// <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.ArgumentException">Thrown when the value is invalid.</exception>
public Geocoordinates Center
{
get
}
/// <summary>
- /// List of map object added to map view
+ /// Gets a list of map object added to map view.
/// </summary>
public IEnumerable<MapObject> Children
{
}
/// <summary>
- /// Changes geographical coordinates to screen coordinates
+ /// Changes geographical coordinates to screen coordinates.
/// </summary>
/// <param name="coordinates">Geographical coordinates</param>
- /// <returns></returns>
+ /// <returns>Returns an instance of 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>
public Point GeolocationToScreen(Geocoordinates coordinates)
{
return handle.GeolocationToScreen(coordinates.handle);
}
/// <summary>
- /// Changes screen coordinates to geographical coordinates
+ /// Changes screen coordinates to geographical coordinates.
/// </summary>
- /// <param name="screenCoordinates">screen coordinates</param>
- /// <returns></returns>
+ /// <param name="screenCoordinates">Screen coordinates</param>
+ /// <returns>Returns an instance of 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>
public Geocoordinates ScreenToGeolocation(Point screenCoordinates)
{
return new Geocoordinates(handle.ScreenToGeolocation(screenCoordinates));
}
/// <summary>
- /// Adds map object to map view
+ /// Adds a map object to map view.
/// </summary>
- /// <param name="child">map object to add</param>
+ /// <param name="child">An instance of 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>
public void Add(MapObject child)
{
Log.Info(string.Format("Add a object"));
}
/// <summary>
- /// Removes map object from map view
+ /// Removes a map object from map view.
/// </summary>
- /// <param name="child">map object to remove</param>
- /// <remarks>Once removed, child object will be become invalid</remarks>
+ /// <param name="child">An instance of 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>
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 map view.
/// </summary>
+ /// <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>
public void RemoveAll()
{
Log.Info(string.Format("Remove all of objects"));
}
/// <summary>
- /// Captures a snapshot of the Map View
+ /// Captures a snapshot of map view
/// </summary>
- /// <param name="type">type of file format</param>
- /// <param name="quality">quality for encoding (1~100) </param>
- /// <param name="path">The file path for snapshot</param>
+ /// <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>
+ /// <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>
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.
+ /// </summary>
public void Dispose()
{
Dispose(true);
}
/// <summary>
- /// Clicked event
+ /// Gets or sets clicked event handlers.
/// </summary>
public event EventHandler Clicked;
/// <summary>
- /// Marker's visibility
+ /// Gets or sets marker's visibility.
/// </summary>
public override bool IsVisible
{
}
/// <summary>
- /// Geographical coordinates for marker
+ /// Gets or sets geographical coordinates for this marker.
/// </summary>
public Geocoordinates Coordinates
{
}
/// <summary>
- /// Image file path for marker
+ /// Gets or sets a string representing image file path for this marker.
/// </summary>
public string ImagePath
{
}
/// <summary>
- /// Screen size for marker
+ /// Gets or sets screen size for this marker.
/// </summary>
public Size MarkerSize
{
}
/// <summary>
- /// Z-order for marker
+ /// Gets or sets z-order for this marker.
/// </summary>
+ /// <value>The integer value is 0 in default, and must be in range of from -100 to 100.</value>
public int ZOrder
{
get
}
/// <summary>
- /// Changes marker size
+ /// Changes marker size.
/// </summary>
/// <param name="newSize">New size</param>
public void Resize(Size newSize)
}
/// <summary>
- /// Changes marker coordinates
+ /// Changes marker coordinates.
/// </summary>
/// <param name="newPosition">New position for marker</param>
public void Move(Geocoordinates newPosition)
}
}
+ /// <summary>
+ /// Releases all resources used by this object.
+ /// </summary>
public void Dispose()
{
Dispose(true);
private const string defaultImagePath = "/usr/share/dotnet.tizen/framework/res/maps_marker_pin_48.png";
/// <summary>
- /// Creates Pin type parker
+ /// Creates a Pin type marker.
/// </summary>
/// <param name="coordinates">Marker coordinates</param>
- /// <exception cref="ArgumentException">Throws if input coordinates are invalid</exception>
+ /// <exception cref="System.ArgumentException">Thrown when input coordinates are invalid.</exception>
public Pin(Geocoordinates coordinates)
: base(coordinates, defaultImagePath, Interop.ViewMarkerType.Pin)
{
}
/// <summary>
- /// Creates Pin type parker
+ /// Creates a Pin type marker.
/// </summary>
/// <param name="coordinates">Marker coordinates</param>
- /// <param name="imagePath">Image path</param>
- /// <exception cref="ArgumentException">Throws if input coordinates or imagePath are invalid</exception>
+ /// <param name="imagePath">Image file path for Marker</param>
+ /// <remark>
+ /// 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.
+ /// </remark>
+ /// <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>
public Pin(Geocoordinates coordinates, string imagePath)
: base(coordinates, imagePath, Interop.ViewMarkerType.Pin)
{
private const string defaultImagePath = "/usr/share/dotnet.tizen/framework/res/maps_marker_sticker_48.png";
/// <summary>
- /// Creates Sticker type parker
+ /// Creates a Sticker type marker.
/// </summary>
/// <param name="coordinates">Marker coordinates</param>
- /// <exception cref="ArgumentException">Throws if input coordinates are invalid</exception>
+ /// <exception cref="System.ArgumentException">Thrown when input coordinates are invalid.</exception>
public Sticker(Geocoordinates coordinates)
: base(coordinates, defaultImagePath, Interop.ViewMarkerType.Sticker)
{
}
/// <summary>
- /// Creates Sticker type parker
+ /// Creates a Sticker type marker.
/// </summary>
/// <param name="coordinates">Marker coordinates</param>
- /// <param name="imagePath">Image path</param>
- /// <exception cref="ArgumentException">Throws if input coordinates or imagePath are invalid</exception>
+ /// <param name="imagePath">Image file path for Marker</param>
+ /// <remark>
+ /// 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.
+ /// </remark>
+ /// <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>
public Sticker(Geocoordinates coordinates, string imagePath)
: base(coordinates, imagePath, Interop.ViewMarkerType.Sticker)
{
<para>
To guarantee that the Maps application runs on a device with Maps profile feature,
declare the following feature requirements in the config file:<br/>
-http://tizen.org/feature/maps
+http://tizen.org/feature/maps<br/>
+http://tizen.org/feature/internet
</para>
</remarks>
internal Interop.OverlayHandle handle;
/// <summary>
- /// Creates normal overlay map object
+ /// Creates a normal overlay map object.
/// </summary>
/// <param name="coordinates"></param>
/// <param name="objectToContain"></param>
- /// <exception cref="ArgumentException">Throws if input coordinates or objectToContain are invalid</exception>
- public Overlay(Geocoordinates coordinates, EvasObject objectToContain) : this(coordinates, objectToContain, Interop.ViewOverlayType.Normal)
+ /// <exception cref="ArgumentException">Thrown when input coordinates or objectToContain are invalid</exception>
+ public Overlay(Geocoordinates coordinates, EvasObject objectToContain)
+ : this(coordinates, objectToContain, Interop.ViewOverlayType.Normal)
{
}
handle = new Interop.OverlayHandle(coordinates.handle, objectToContain, type);
}
+ /// <summary>
+ /// Gets or sets visibility of overlay map object.
+ /// </summary>
public override bool IsVisible
{
get { return handle.IsVisible; }
}
/// <summary>
- /// Geographical coordinates for overlay
+ /// Gets or sets geographical coordinates for overlay map object.
/// </summary>
public Geocoordinates Coordinates
{
}
/// <summary>
- /// Minimum zoom level for overlay
+ /// Gets or sets minimum zoom level for overlay map object.
/// </summary>
public int MinimumZoomLevel
{
}
/// <summary>
- /// Maximum zoom lever for overlay
+ /// Gets or sets maximum zoom lever for overlay map object.
/// </summary>
public int MaximumZoomLevel
{
}
}
+ /// <summary>
+ /// Releases all resources used by this object.
+ /// </summary>
public void Dispose()
{
Dispose(true);
public class BubbleOverlay : Overlay
{
/// <summary>
- /// Creates Box overlay
+ /// Creates a Bubble overlay.
/// </summary>
- /// <exception cref="ArgumentException">Throws if input coordinates or objectToContain are invalid</exception>
- public BubbleOverlay(Geocoordinates coordinates, EvasObject objectToContain) : base(coordinates, objectToContain, Interop.ViewOverlayType.Bubble)
+ /// <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>
+ public BubbleOverlay(Geocoordinates coordinates, EvasObject objectToContain)
+ : base(coordinates, objectToContain, Interop.ViewOverlayType.Bubble)
{
}
}
public class BoxOverlay : Overlay
{
/// <summary>
- /// Creates Box overlay
+ /// Creates a Box overlay.
/// </summary>
- /// <exception cref="ArgumentException">Throws if input coordinates or objectToContain are invalid</exception>
- public BoxOverlay(Geocoordinates coordinates, EvasObject objectToContain) : base(coordinates, objectToContain, Interop.ViewOverlayType.Box)
+ /// <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>
+ public BoxOverlay(Geocoordinates coordinates, EvasObject objectToContain)
+ : base(coordinates, objectToContain, Interop.ViewOverlayType.Box)
{
}
}
}
/// <summary>
- /// Place ID
+ /// Gets ID string for the place.
/// </summary>
public string Id
{
}
/// <summary>
- /// Place Name
+ /// Gets name string for the place.
/// </summary>
public string Name
{
}
/// <summary>
- /// Place URI
+ /// Gets view URI for the place.
/// </summary>
public string Uri
{
}
/// <summary>
- /// Distance from the center of the search area
+ /// Gets distance for the place from the center.
/// </summary>
public int Distance
{
}
/// <summary>
- /// Place location
+ /// Gets geographical location for the place.
/// </summary>
public Geocoordinates Coordinates
{
}
/// <summary>
- /// Place address
+ /// Gets address for the place.
/// </summary>
public PlaceAddress Address
{
}
/// <summary>
- /// Rating for the place
+ /// Gets rating for the place.
/// </summary>
public PlaceRating Rating
{
}
/// <summary>
- /// Place image supplier link
+ /// Gets supplier link for the place.
/// </summary>
public PlaceLink Supplier
{
}
/// <summary>
- /// Place image related link
+ /// Gets related link for the place.
/// </summary>
public PlaceLink Related
{
}
/// <summary>
- /// All properties attached with this place
+ /// Gets all properties attached to this place.
/// </summary>
public IDictionary<string, string> Properties
{
}
/// <summary>
- /// All categories attached with this place
+ /// Gets all categories attached to this place.
/// </summary>
public IEnumerable<PlaceCategory> Categories
{
}
/// <summary>
- /// All attributes attached with this place
+ /// Gets all attributes attached to this place.
/// </summary>
public IEnumerable<PlaceAttribute> Attributes
{
}
/// <summary>
- /// All contacts attached with this place
+ /// Gets all contacts attached to this place.
/// </summary>
public IEnumerable<PlaceContact> Contacts
{
}
/// <summary>
- /// All editorials attached with this place
+ /// Gets all editorials attached to this place.
/// </summary>
public IEnumerable<PlaceEditorial> Editorials
{
}
/// <summary>
- /// All images attached with this place
+ /// Gets all images attached to this place.
/// </summary>
public IEnumerable<PlaceImage> Images
{
}
/// <summary>
- /// All reviews attached with this place
+ /// Gets all reviews attached to this place.
/// </summary>
public IEnumerable<PlaceReview> Reviews
{
}
}
+ /// <summary>
+ /// Releases all resources used by this object.
+ /// </summary>
public void Dispose()
{
Dispose(true);
internal Interop.AddressHandle handle;
/// <summary>
- /// Construct map address object
+ /// Constructs map address object.
/// </summary>
- /// <exception cref="System.InvalidOperationException">Throws if native operation failed to allocate memory</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown when native operation failed to allocate memory.</exception>
public PlaceAddress()
{
handle = new Interop.AddressHandle();
}
/// <summary>
- /// Building number for this address
+ /// Gets a building number for this address.
/// </summary>
public string Building
{
}
/// <summary>
- /// City name for this address
+ /// Gets a city name for this address.
/// </summary>
public string City
{
}
/// <summary>
- /// Country name for this address
+ /// Gets a country name for this address.
/// </summary>
public string Country
{
}
/// <summary>
- /// Country code for this address
+ /// Gets a country code for this address.
/// </summary>
public string CountryCode
{
}
/// <summary>
- /// County for this address
+ /// Gets a county name for this address.
/// </summary>
public string County
{
}
/// <summary>
- /// District name for this address
+ /// Gets a district name for this address.
/// </summary>
public string District
{
}
/// <summary>
- /// Free text associated with this address
+ /// Gets a free text associated with this address.
/// </summary>
public string Freetext
{
}
/// <summary>
- /// Postal code for this address
+ /// Gets a postal code for this address.
/// </summary>
public string PostalCode
{
}
/// <summary>
- /// State name for this address
+ /// Gets a state name for this address.
/// </summary>
public string State
{
}
/// <summary>
- /// Street name for this address
+ /// Gets a street name for this address.
/// </summary>
public string Street
{
}
/// <summary>
- /// String that represents this address
+ /// Returns a string that represents this object.
/// </summary>
public override string ToString()
{
}
}
+ /// <summary>
+ /// Releases all resources used by this object.
+ /// </summary>
public void Dispose()
{
Dispose(true);
private List<PlaceAddress> _list;
/// <summary>
- /// Construct map address list object
+ /// Constructs a map address list object.
/// </summary>
- /// <exception cref="System.InvalidOperationException">Throws if native operation failed to allocate memory</exception>
+ /// <exception cref="System.NotSupportedException">Thrown when the required feature is not supported.</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown when native operation failed to allocate memory.</exception>
public PlaceAddressList()
{
handle = new Interop.AddressListHandle();
}
/// <summary>
- /// Iterator for addresses in this list
+ /// Gets an iterator for addresses in this list.
/// </summary>
public IEnumerable<PlaceAddress> Addresses
{
}
}
+ /// <summary>
+ /// Releases all resources used by this object.
+ /// </summary>
public void Dispose()
{
Dispose(true);
_text = nativeHandle.Text;
}
- internal PlaceAttribute(IntPtr nativeHandle, bool needToRelease) : this(new Interop.PlaceAttributeHandle(nativeHandle, needToRelease))
+ internal PlaceAttribute(IntPtr nativeHandle, bool needToRelease)
+ : this(new Interop.PlaceAttributeHandle(nativeHandle, needToRelease))
{
}
/// <summary>
- /// Place Attribute ID
+ /// Gets an ID for the place attribute.
/// </summary>
public string Id { get { return _id; } }
/// <summary>
- /// Place attribute label
+ /// Gets a label for the place attribute.
/// </summary>
public string Label { get { return _label; } }
/// <summary>
- /// Place attribute text
+ /// Gets a text for the place attribute.
/// </summary>
public string Text { get { return _text; } }
/// <summary>
- /// String that represents this attribute
+ /// Returns a string that represents this object.
/// </summary>
public override string ToString()
{
internal Interop.PlaceCategoryHandle handle;
/// <summary>
- /// Constructs search category object
+ /// Constructs search category object.
/// </summary>
- /// <exception cref="System.InvalidOperationException">Throws if native operation failed to allocate memory</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown when native operation failed to allocate memory.</exception>
public PlaceCategory()
{
handle = new Interop.PlaceCategoryHandle();
/// <summary>
- /// ID for this category
+ /// Gets or sets an ID for this category.
/// </summary>
public string Id
{
}
/// <summary>
- /// Name for this category
+ /// Gets or sets a name for this category.
/// </summary>
public string Name
{
}
/// <summary>
- /// URL for this category
+ /// Gets or sets an URL for this category.
/// </summary>
public string Url
{
}
/// <summary>
- /// String that represents this category
+ /// Returns a string that represents this object.
/// </summary>
public override string ToString()
{
}
}
+ /// <summary>
+ /// Releases all resources used by this object.
+ /// </summary>
public void Dispose()
{
Dispose(true);
}
/// <summary>
- /// Place contact type
+ /// Gets an ID for this place contact.
/// </summary>
public string Id { get { return _type; } }
/// <summary>
- /// Place contact label
+ /// Gets a label for this place contact.
/// </summary>
public string Label { get { return _label; } }
/// <summary>
- /// Place contact value
+ /// Gets a value for this place contact.
/// </summary>
public string Value { get { return _value; } }
/// <summary>
- /// String that represents this place contact
+ /// Returns a string that represents this object.
/// </summary>
public override string ToString()
{
}
/// <summary>
- /// Place editorial description
+ /// Gets a description for this place editorial.
/// </summary>
public string Description { get { return _description; } }
/// <summary>
- /// Place editorial language
+ /// Gets a language for this place editorial.
/// </summary>
public string Language { get { return _language; } }
/// <summary>
- /// Place editorial value
+ /// Gets an instance of <see cref="PlaceMedia"/> object which representing media for this place editorial.
/// </summary>
public PlaceMedia Media { get { return _media; } }
/// <summary>
- /// String that represents this place media
+ /// Returns a string that represents this object.
/// </summary>
public override string ToString()
{
internal Interop.PlaceFilterHandle handle;
/// <summary>
- /// Constructs new place filter
+ /// Constructs new place filter.
/// </summary>
- /// <exception cref="System.InvalidOperationException">Throws if native operation failed to allocate memory</exception>
+ /// <exception cref="System.InvalidOperationException">Thrown when native operation failed to allocate memory.</exception>
public PlaceFilter()
{
handle = new Interop.PlaceFilterHandle();
}
/// <summary>
- /// Filter string for place addresses
+ /// Gets or sets an free-formed address string for this place filter.
/// </summary>
+ /// <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>
public string Address
{
get
}
/// <summary>
- /// Category filter for places
+ /// Gets or sets an instance of <see cref="PlaceCategory"/> object for this place filter.
/// </summary>
public PlaceCategory Category
{
}
/// <summary>
- /// Filter keyword for place
+ /// Gets or sets a keyword for this place filter.
/// </summary>
+ /// <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>
public string Keyword
{
get
}
/// <summary>
- /// Filter string for place names
+ /// Gets or sets a name for this place filter.
/// </summary>
+ /// <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>
public string Name
{
get
}
}
+ /// <summary>
+ /// Releases all resources used by this object.
+ /// </summary>
public void Dispose()
{
Dispose(true);
}
/// <summary>
- /// Place image Id
+ /// Gets an ID for this place image.
/// </summary>
public string Id { get { return _id; } }
/// <summary>
- /// Place image URL
+ /// Gets an URL for this place image.
/// </summary>
public string Url { get { return _url; } }
/// <summary>
- /// Place image width
+ /// Gets width for this place image.
/// </summary>
public int Width { get { return _width; } }
/// <summary>
- /// Place image height
+ /// Gets height for this place image.
/// </summary>
public int Height { get { return _height; } }
/// <summary>
- /// Place image user link
+ /// Gets an object which representing user link for this place image.
/// </summary>
public PlaceLink UserLink { get { return _userLink; } }
/// <summary>
- /// Place image media
+ /// Gets an object which representing image media for this place image.
/// </summary>
public PlaceMedia ImageMedia { get { return _media; } }
}
}
/// <summary>
- /// Place link ID
+ /// Gets a string which representing ID for this place link.
/// </summary>
public string Id { get { return _id; } }
/// <summary>
- /// Place link name
+ /// Gets a string which representing name for this place link.
/// </summary>
public string Name { get { return _name; } }
/// <summary>
- /// Place link string
+ /// Gets a string which representing link for this place link.
/// </summary>
public string Link { get { return _link; } }
/// <summary>
- /// Place link type
+ /// Gets a string which representing type for this place link.
/// </summary>
public string Type { get { return _type; } }
}
}
/// <summary>
- /// Iterator for addresses in this list
+ /// Gets an iterator for addresses in this list.
/// </summary>
public IEnumerable<Place> Places
{
}
}
+ /// <summary>
+ /// Releases all resources used by this object.
+ /// </summary>
public void Dispose()
{
Dispose(true);
}
/// <summary>
- /// Place media attribution
+ /// Gets a string which representing attribution for this place media.
/// </summary>
public string Attribution { get { return _attribution; } }
/// <summary>
- /// Place media supplier value
+ /// Gets an instance of <see cref="PlaceLink"/> object which representing supplier for this place media.
/// </summary>
public PlaceLink Supplier { get { return _supplier; } }
/// <summary>
- /// Place media via value
+ /// Gets an instance of <see cref="PlaceLink"/> object which representing via data for this place media.
/// </summary>
public PlaceLink Via { get { return _via; } }
}
}
/// <summary>
- /// Number of users rated for this rating
+ /// Gets the number of users rated for this place rating.
/// </summary>
public int UserCount { get { return _count; } }
/// <summary>
- /// Average value of user rating
+ /// Gets average value of this place rating.
/// </summary>
public double Average { get { return _average; } }
/// <summary>
- /// String that represents this place rating
+ /// Returns a string that represents this object.
/// </summary>
public override string ToString()
{
}
/// <summary>
- /// Time of this review
+ /// Gets an instance of <see cref="DateTime"/> object which representing time of this review.
/// </summary>
public DateTime Date { get { return _date; } }
/// <summary>
- /// Title of this review
+ /// Gets a string which representing title of this review.
/// </summary>
public string Title { get { return _title; } }
/// <summary>
- /// Rating of this review
+ /// Gets a value which representing rating of this review.
/// </summary>
public double Rating { get { return _rating; } }
/// <summary>
- /// Description of this review
+ /// Gets a string which representing description of this review.
/// </summary>
public string Description { get { return _description; } }
/// <summary>
- /// Language of this review
+ /// Gets a string which representing language of this review.
/// </summary>
public string Language { get { return _language; } }
/// <summary>
- /// Media attached with this review
+ /// Gets an instance of <see cref="PlaceMedia"/> object which representing review media of this review.
/// </summary>
public PlaceMedia ReviewMedia { get { return _media; } }
/// <summary>
- /// User link of this review
+ /// Gets an instance of <see cref="PlaceLink"/> object which representing user link of this review.
/// </summary>
public PlaceLink UserLink { get { return _userLink; } }
}
private List<Geocoordinates> _coordinateList;
/// <summary>
- /// Creates a polygon visual object
+ /// Creates a polygon visual object.
/// </summary>
- /// <param name="coordinates">list of geographical coordinates</param>
- /// <param name="color">background color</param>
- /// <exception cref="ArgumentException">Throws if input values are invalid</exception>
+ /// <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()
{
var err = Interop.ErrorCode.InvalidParameter;
}
/// <summary>
- /// Clicked event
+ /// Adds or removes clicked event handlers.
/// </summary>
public event EventHandler Clicked;
+ /// <summary>
+ /// Gets or sets visibility for the polygon.
+ /// </summary>
public override bool IsVisible
{
get { return handle.IsVisible; }
}
/// <summary>
- /// List of geographical coordinates of polygon vertices
+ /// Gets or sets a list of geographical coordinates of polygon vertices.
/// </summary>
public IEnumerable<Geocoordinates> Coordinates
{
}
/// <summary>
- /// Background fill color
+ /// Gets or sets background color to fill the polygon.
/// </summary>
public Color FillColor
{
}
}
+ /// <summary>
+ /// Releases all resources used by this object.
+ /// </summary>
public void Dispose()
{
Dispose(true);
private List<Geocoordinates> _coordinateList;
/// <summary>
- /// Creates polyline visual object
+ /// Creates polyline visual object.
/// </summary>
/// <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">Throws if input values are invalid</exception>
+ /// <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>
- /// Clicked event
+ /// Adds or removes clicked event handlers.
/// </summary>
public event EventHandler Clicked;
}
/// <summary>
- /// List of geographical coordinates for polyline vertices
+ /// Gets or sets a list of geographical coordinates for polyline vertices.
/// </summary>
public IEnumerable<Geocoordinates> Coordinates
{
}
/// <summary>
- /// Line color
+ /// Gets or sets line color.
/// </summary>
public Color LineColor
{
}
/// <summary>
- /// line width [1 ~ 100 pixels]
+ /// Gets or sets line width from 1 to 100 pixels.
/// </summary>
public int Width
{
}
}
+ /// <summary>
+ /// Releases all resources used by this object.
+ /// </summary>
public void Dispose()
{
Dispose(true);
namespace Tizen.Maps
{
/// <summary>
- /// Reverse geocode request for Tizen map service
+ /// Reverse geocode request for map service.
/// </summary>
public class ReverseGeocodeRequest : MapServiceRequest<PlaceAddress>
{
namespace Tizen.Maps
{
/// <summary>
- /// Route information, used in Route Search requests
+ /// Route information, used in Route Search requests.
/// </summary>
public class Route : IDisposable
{
}
/// <summary>
- /// Destination coordinates for this route
+ /// Gets an instance of <see cref="Geocoordinates"/> object which representing destination coordinates for this route.
/// </summary>
public Geocoordinates Destination
{
}
/// <summary>
- /// Total distance for this route
+ /// Gets total distance for this route.
/// </summary>
public double Distance
{
}
/// <summary>
- /// Total duration to cover this route
+ /// Get total duration to cover this route.
/// </summary>
public double Duration
{
}
/// <summary>
- /// Id for this route
+ /// Gets an ID for this route.
/// </summary>
public string Id
{
}
/// <summary>
- /// Transport Mode for this route
+ /// Gets transport mode for this route.
/// </summary>
public TransportMode Mode
{
}
/// <summary>
- /// Origin coordinates for this route
+ /// Gets origin coordinates for this route.
/// </summary>
public Geocoordinates Origin
{
}
/// <summary>
- /// Coordinates list for this route
+ /// Gets a coordinates list for this route.
/// </summary>
public IEnumerable<Geocoordinates> Path
{
}
/// <summary>
- /// Segment list for this route
+ /// Gets a segment list for this route.
/// </summary>
public IEnumerable<RouteSegment> Segments
{
}
/// <summary>
- /// Distance unit for this route
+ /// Gets distance unit for this route.
/// </summary>
public DistanceUnit Unit
{
}
/// <summary>
- /// Bounding area for this route
+ /// Gets an instance of <see cref="Area"/> object which representing bounding area for this route.
/// </summary>
private Area BoundingBox
{
}
}
+ /// <summary>
+ /// Releases all resources used by this object.
+ /// </summary>
public void Dispose()
{
Dispose(true);
public enum RouteFeature
{
/// <summary>
- /// Indicates no route features (are selected)
+ /// Indicates no route features (are selected).
/// </summary>
None = Interop.RouteRequestFeature.None,
/// <summary>
- /// Indicates toll roads (toll gates/booths)
+ /// Indicates toll roads (toll gates/booths).
/// </summary>
Toll = Interop.RouteRequestFeature.Toll,
/// <summary>
- /// Indicates motorway
+ /// Indicates motorway.
/// </summary>
Motorway = Interop.RouteRequestFeature.MotorWay,
/// <summary>
- /// Indicates a boat ferry
+ /// Indicates a boat ferry.
/// </summary>
BoatFerry = Interop.RouteRequestFeature.BoatFerry,
/// <summary>
- /// Indicates rail (train) ferry
+ /// Indicates rail (train) ferry.
/// </summary>
RailFerry = Interop.RouteRequestFeature.RailFerry,
/// <summary>
- /// Indicates public transport
+ /// Indicates public transport.
/// </summary>
PublicTransit = Interop.RouteRequestFeature.PublicTransit,
/// <summary>
- /// Indicates tunnel
+ /// Indicates tunnel.
/// </summary>
Tunnel = Interop.RouteRequestFeature.Tunnel,
/// <summary>
- /// Indicates dirt road
+ /// Indicates dirt road.
/// </summary>
DirtRoad = Interop.RouteRequestFeature.DirtRoad,
/// <summary>
- /// Indicates park
+ /// Indicates park.
/// </summary>
Parks = Interop.RouteRequestFeature.Parks,
/// <summary>
- /// Indicates a high-occupancy vehicle lane
+ /// Indicates a high-occupancy vehicle lane.
/// </summary>
Hovlane = Interop.RouteRequestFeature.Hovlane,
/// <summary>
- /// Indicates stairs
+ /// Indicates stairs.
/// </summary>
Stairs = Interop.RouteRequestFeature.Stairs,
}
public enum RouteFeatureWeight
{
/// <summary>
- /// Indicates normal weighting
+ /// Indicates normal weighting.
/// </summary>
Normal = Interop.RouteFeatureWeight.Normal,
/// <summary>
- /// Indicates that a feature is preferred
+ /// Indicates that a feature is preferred.
/// </summary>
Prefer = Interop.RouteFeatureWeight.Prefer,
/// <summary>
- /// Indicates that a feature is to be avoided
+ /// Indicates that a feature is to be avoided.
/// </summary>
Avoid = Interop.RouteFeatureWeight.Avoid,
/// <summary>
- /// Indicates that soft-exclude applies to the feature
+ /// Indicates that soft-exclude applies to the feature.
/// </summary>
SoftExclude = Interop.RouteFeatureWeight.SoftExclude,
/// <summary>
- /// Indicates that the feature is to be strictly excluded
+ /// Indicates that the feature is to be strictly excluded.
/// </summary>
StrictExclude = Interop.RouteFeatureWeight.StrictExclude,
}
}
/// <summary>
- /// Direction type for this maneuver
+ /// Gets direction type for this maneuver.
/// </summary>
public DirectionType Direction { get { return (DirectionType)_direction; } }
/// <summary>
- /// Turn type for this maneuver
+ /// Gets turn type for this maneuver.
/// </summary>
public TurnInstruction Turn { get { return (TurnInstruction)_turntype; } }
/// <summary>
- /// Position for this maneuver
+ /// Gets a geographical coordinates position for this maneuver.
/// </summary>
public Geocoordinates Position { get { return _coordinates; } }
/// <summary>
- /// Name of the road for this maneuver
+ /// Gets a name of the road for this maneuver.
/// </summary>
public string Road { get { return _road; } }
/// <summary>
- /// Instruction text for this maneuver
+ /// Gets an instruction text for this maneuver.
/// </summary>
public string Instruction { get { return _instruction; } }
/// <summary>
- /// Locale for this maneuver
+ /// Gets a locale for this maneuver.
/// </summary>
public string Locale { get { return _locale; } }
/// <summary>
- /// Time to next instruction for this maneuver
+ /// Gets time to next instruction for this maneuver.
/// </summary>
public int TimeToNextInstruction { get { return _timeToNextInstruction; } }
/// <summary>
- /// Distance to next instruction for this maneuver
+ /// Gets distance to next instruction for this maneuver.
/// </summary>
public double DistanceToNextInstruction { get { return _distanceToNextInstruction; } }
}
/// <summary>
/// Allowed route optimization option used in route search requests
/// </summary>
+ /// <remark>
+ /// Depending on loaded maps plug-in using <paramref name="MapService"/>, some features may have no effect or differences with descriptions.
+ /// </remark>
public enum RouteOptimization
{
/// <summary>
- /// Search for fastest routes
+ /// Indicates that searching for fastest routes.
/// </summary>
Fastest = Interop.RouteOptimization.Fastest,
/// <summary>
- /// Search for shortest routes (car mode only)
+ /// Indicates that searching for shortest routes (car mode only).
/// </summary>
Shortest = Interop.RouteOptimization.Shortest,
/// <summary>
- /// Search for most economic routes (car mode only)
+ /// Indicates that searching for most economic routes (car mode only).
/// </summary>
Economic = Interop.RouteOptimization.Economic,
/// <summary>
- /// Search for most scenic routes
+ /// Indicates that searching for most scenic routes.
/// </summary>
Scenic = Interop.RouteOptimization.Scenic,
/// <summary>
- /// Search for most fastest routes now, based on current traffic condition
+ /// Indicates that searching for most fastest routes now, based on current traffic condition.
/// </summary>
FastestNow = Interop.RouteOptimization.FastestNow,
/// <summary>
- /// Search for direct drive routes
+ /// Indicates that searching for direct drive routes.
/// </summary>
DirectDrive = Interop.RouteOptimization.DirectDrive,
}
}
/// <summary>
- /// List of way-points to cover between origin and destination
+ /// Gets or sets a list of way-points to cover between origin and destination.
/// </summary>
public IEnumerable<Geocoordinates> Waypoints
{
}
/// <summary>
- /// Origin coordinates for this segment
+ /// Gets an origin coordinates for this segment.
/// </summary>
public Geocoordinates Origin { get { return _origin; } }
/// <summary>
- /// Destination coordinates for this segment
+ /// Gets a destination coordinates for this segment.
/// </summary>
public Geocoordinates Destination { get { return _destination; } }
/// <summary>
- /// Total distance for this segment
+ /// Gets total distance for this segment.
/// </summary>
public double Distance { get { return _distance; } }
/// <summary>
- /// Total duration to cover this segment
+ /// Gets total duration to cover this segment.
/// </summary>
public double Duration { get { return _duration; } }
/// <summary>
- /// Maneuver list for this segment path
+ /// Gets a maneuver list for this segment.
/// </summary>
public IEnumerable<RouteManeuver> Maneuvers { get { return _maneuvers; } }
/// <summary>
- /// Coordinates list for this segment path
+ /// Gets a coordinates list for this segment.
/// </summary>
public IEnumerable<Geocoordinates> Path { get { return _path; } }
- /// <summary>
- /// Bounding area for this segment
- /// </summary>
private Area BoundingBox { get { return _boundingBox; } }
}
}
private IReadOnlyDictionary<string, string> _properties = new Dictionary<string, string>();
/// <summary>
- /// Constructor for search preference
+ /// Constructors a new search preference.
/// </summary>
public SearchPreference()
{
}
/// <summary>
- /// Constructor for search preference
+ /// Constructors a new search preference.
/// </summary>
internal SearchPreference(Interop.PreferenceHandle nativeHandle)
{
}
/// <summary>
- /// Preferred language
+ /// Gets or sets preferred language.
/// </summary>
- /// <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 e.g. "ko-KR"
- /// </remarks>
+ /// <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
{
get
}
/// <summary>
- /// Maximum result count for a service request
+ /// Gets or sets the maximum result count for each service request.
/// </summary>
/// <remarks>Setting negative value will not have any effect on MaxResults value</remarks>
public int MaxResults
}
/// <summary>
- /// Distance unit
+ /// Gets or sets distance unit.
/// </summary>
public DistanceUnit Unit
{
}
/// <summary>
- /// Preferred country
+ /// Gets or sets preferred country.
/// </summary>
public string CountryCode
{
}
/// <summary>
- /// Search properties as key value pair
+ /// Gets or sets search properties as key value pair.
/// </summary>
public IReadOnlyDictionary<string, string> Properties
{
}
/// <summary>
- /// Selected route optimization
+ /// Gets or sets route optimization.
/// </summary>
public RouteOptimization Optimization
{
}
/// <summary>
- /// Route transport mode
+ /// Gets or sets route transport mode.
/// </summary>
public TransportMode Mode
{
}
/// <summary>
- /// Route feature weight
+ /// Gets or sets route feature weight.
/// </summary>
public RouteFeatureWeight RouteFeatureWeight
{
}
/// <summary>
- /// Route feature
+ /// Gets or sets route feature.
/// </summary>
public RouteFeature RouteFeature
{
}
/// <summary>
- /// Indicate if search for alternative routes is enabled.
+ /// Gets or sets if searching for alternative routes is enabled.
/// </summary>
public bool SearchAlternativeRoutes
{
}
}
+ /// <summary>
+ /// Releases all resources used by this object.
+ /// </summary>
public void Dispose()
{
Dispose(true);
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 Place the 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 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,
}
public enum ServiceRequestType
{
/// <summary>
- /// Service request to get position <see cref="Geocoordinates"/> for a given free-formed address string is allowed
+ /// Indicates that service request to get position <see cref="Geocoordinates"/> for a given free-formed address string is allowed.
/// </summary>
Geocode = Interop.ServiceType.Geocode,
/// <summary>
- /// Service request to get position <see cref="Geocoordinates"/> for a given address, within the specified bounding <see cref="Area"/>, is allowed
+ /// Indicates that service request to get position <see cref="Geocoordinates"/> for a given address, within the specified bounding <see cref="Area"/>, is allowed.
/// </summary>
GeocodeInsideArea = Interop.ServiceType.GeocodeInsideArea,
/// <summary>
- /// Service request to get position <see cref="Geocoordinates"/> for a given <see cref="PlaceAddress"/> is allowed
+ /// Indicates that service request to get position <see cref="Geocoordinates"/> for a given <see cref="PlaceAddress"/> is allowed.
/// </summary>
GeocodeByStructuredAddress = Interop.ServiceType.GeocodeByStructuredAddress,
/// <summary>
- /// Service request to get <see cref="PlaceAddress"/> for a given <see cref="Geocoordinates"/> is allowed
+ /// Indicates that service request to get <see cref="PlaceAddress"/> for a given <see cref="Geocoordinates"/> is allowed.
/// </summary>
ReverseGeocode = Interop.ServiceType.ReverseGeocode,
/// <summary>
- /// Service request to get <see cref="PlaceAddress"/> for a given <see cref="GeocoordinatesList"/> is allowed
+ /// Indicates that service request to get <see cref="PlaceAddress"/> for a given <see cref="GeocoordinatesList"/> is allowed.
/// </summary>
MultiReverseGeocode = Interop.ServiceType.MultiReverseGeocode,
/// <summary>
- /// Service request to query <see cref="Place"/> information for a given <see cref="Geocoordinates"/> is allowed
+ /// Indicates that service request to query <see cref="Place"/> information for a given <see cref="Geocoordinates"/> is allowed.
/// </summary>
SearchPlace = Interop.ServiceType.SearchPlace,
/// <summary>
- /// Service request to query <see cref="Place"/> information for a given <see cref="Area"/> is allowed
+ /// Indicates that service request to query <see cref="Place"/> information for a given <see cref="Area"/> is allowed.
/// </summary>
SearchPlaceByArea = Interop.ServiceType.SearchPlaceByArea,
/// <summary>
- /// Service request to query <see cref="Place"/> information for a given free-formed address string is allowed
+ /// Indicates that service request to query <see cref="Place"/> information for a given free-formed address string is allowed.
/// </summary>
SearchPlaceByAddress = Interop.ServiceType.SearchPlaceByAddress,
/// <summary>
- /// Service request to query <see cref="Place"/> information list for all places in a given <see cref="Area"/> is allowed
+ /// Indicates that service request to query <see cref="Place"/> information list for all places in a given <see cref="Area"/> is allowed.
/// </summary>
SearchPlaceList = Interop.ServiceType.SearchPlaceList,
/// <summary>
- /// Service request to get detailed <see cref="Place"/> information for a given <see cref="PlaceUrl"/> is allowed
+ /// Indicates that service request to get detailed <see cref="Place"/> information for a given <see cref="PlaceUrl"/> is allowed.
/// </summary>
SearchGetPlaceDetails = Interop.ServiceType.SearchGetPlaceDetails,
/// <summary>
- /// Service request to query <see cref="Route"/> information from a given origin <see cref="Geocoordinates"/> and destination <see cref="Geocoordinates"/> is allowed
+ /// Indicates that service request to query <see cref="Route"/> information from a given origin <see cref="Geocoordinates"/> and destination <see cref="Geocoordinates"/> is allowed.
/// </summary>
SearchRoute = Interop.ServiceType.SearchRoute,
/// <summary>
- /// Service request to query <see cref="Route"/> information passing through specified way-points <see cref="GeocoordinatesList"/> is allowed
+ /// Indicates that service request to query <see cref="Route"/> information passing through specified way-points <see cref="GeocoordinatesList"/> is allowed.
/// </summary>
SearchRouteWithWaypoints = Interop.ServiceType.SearchRouteWaypoints,
/// <summary>
- /// Map view service is allowed
+ /// Indicates that map view service is allowed.
/// </summary>
View = Interop.ServiceType.View,
/// <summary>
- /// Map view snapshot service is allowed
+ /// Indicates that map view snapshot service is allowed.
/// </summary>
ViewSnapshot = Interop.ServiceType.ViewSnapshot,
}
public enum SnapshotType
{
/// <summary>
- /// BMP file format
+ /// Indicates BMP file format.
/// </summary>
BMP = Interop.ViewSnapshotFormatType.ViewSnapshotBmp,
/// <summary>
- /// JPEG file format
+ /// Indicates JPEG file format.
/// </summary>
JPEG = Interop.ViewSnapshotFormatType.ViewSnapshotJpeg,
}
public enum TransportMode
{
/// <summary>
- /// Route is to be traveled by car
+ /// Indicates that route is to be traveled by car.
/// </summary>
Car = Interop.RouteTransportMode.Car,
/// <summary>
- /// Route is for a pedestrian
+ /// Indicates that route is for a pedestrian.
/// </summary>
Pedestrian = Interop.RouteTransportMode.Pedestrian,
/// <summary>
- /// Route is for a cyclist
+ /// Indicates that route is for a cyclist.
/// </summary>
Bicycle = Interop.RouteTransportMode.Bicycle,
/// <summary>
- /// Route is to be traveled using public transport
+ /// Indicates that route is to be traveled using public transport.
/// </summary>
Publictransit = Interop.RouteTransportMode.PublicTransit,
/// <summary>
- /// Route is for a truck
+ /// Indicates that route is for a truck.
/// </summary>
Truck = Interop.RouteTransportMode.Truck,
}
public enum TurnInstruction
{
/// <summary>
- /// Unknown Instruction
+ /// Indicates unknown instruction.
/// </summary>
None = Interop.RouteTurnType.None,
/// <summary>
- /// Instruction to move straight
+ /// Indicates instruction to move straight.
/// </summary>
Straight = Interop.RouteTurnType.Straight,
/// <summary>
- /// Instruction to bear right
+ /// Indicates instruction to bear right.
/// </summary>
BearRight = Interop.RouteTurnType.BearRight,
/// <summary>
- /// Instruction to turn slightly to the right
+ /// Indicates instruction to turn slightly to the right.
/// </summary>
LightRight = Interop.RouteTurnType.LightRight,
/// <summary>
- /// Instruction to turn right
+ /// Indicates instruction to turn right.
/// </summary>
Right = Interop.RouteTurnType.Right,
/// <summary>
- /// Instruction to turn hard to the right
+ /// Indicates instruction to turn hard to the right.
/// </summary>
HardRight = Interop.RouteTurnType.HardRight,
/// <summary>
- /// Instruction to u-turn to the right
+ /// Indicates instruction to u-turn to the right.
/// </summary>
UturnRight = Interop.RouteTurnType.UturnRight,
/// <summary>
- /// Instruction to u-turn to the left
+ /// Indicates instruction to u-turn to the left.
/// </summary>
UturnLeft = Interop.RouteTurnType.UturnLeft,
/// <summary>
- /// Instruction to turn hard to the left
+ /// Indicates instruction to turn hard to the left.
/// </summary>
HardLeft = Interop.RouteTurnType.HardLeft,
/// <summary>
- /// Instruction to turn left
+ /// Indicates instruction to turn left.
/// </summary>
Left = Interop.RouteTurnType.Left,
/// <summary>
- /// Instruction to turn slightly to the left
+ /// Indicates instruction to turn slightly to the left.
/// </summary>
LightLeft = Interop.RouteTurnType.LightLeft,
/// <summary>
- /// Instruction to bear left
+ /// Indicates instruction to bear left.
/// </summary>
BearLeft = Interop.RouteTurnType.BearLeft,
/// <summary>
- /// Instruction to take right fork
+ /// Indicates instruction to take right fork.
/// </summary>
RightFork = Interop.RouteTurnType.RightFork,
/// <summary>
- /// Instruction to take left fork
+ /// Indicates instruction to take left fork.
/// </summary>
LeftFork = Interop.RouteTurnType.LeftFork,
/// <summary>
- /// Instruction to take straight fork
+ /// Indicates instruction to take straight fork.
/// </summary>
StraightFork = Interop.RouteTurnType.StraightFork,
}
projects / platform / core / csapi / tizenfx.git / commitdiff