Class MapService

View Source

Definition

Namespace:
Tizen.Maps
Assembly:
Tizen.Maps.dll
API Level:
3

Map service class for service request.


                
C#

                

                    
Copy

                    

                

            
public class MapService : IDisposable
Inheritance
Object
MapService
Implements
IDisposable

Constructors

View Source

MapService(String, String)

Creates a new maps service object for given service provider.

Declaration

                
C#

                

                    
Copy

                    

                

            
public MapService(string serviceProvider, string serviceProviderKey)
Parameters
Type Name Description
String serviceProvider

A string representing the name of the map service provider.
String serviceProviderKey

A string representing a certificate key to use the map service provider.
Exceptions
Type Condition
NotSupportedException

Thrown when the required feature is not supported.
ArgumentException

Thrown when parameters are invalid.
InvalidOperationException

Thrown when a native operation failed to allocate memory and connect to the service.
UnauthorizedAccessException

Thrown when application does not have some privilege to access this method.
API Level: 3
Privilege Level: public
Privilege: http://tizen.org/privilege/mapservicehttp://tizen.org/privilege/network.get

Properties

View Source

GeocodePreferences

Gets the search preferences used for GeocodeRequest or ReverseGeocodeRequest.

Declaration

                
C#

                

                    
Copy

                    

                

            
public IGeocodePreference GeocodePreferences { get; }
Property Value
Type Description
IGeocodePreference
API Level: 3
View Source

PlaceSearchFilter

Gets and sets a filter used for the place search result.

Declaration

                
C#

                

                    
Copy

                    

                

            
public PlaceFilter PlaceSearchFilter { get; set; }
Property Value
Type Description
PlaceFilter
API Level: 3
View Source

PlaceSearchPreferences

Gets the search preferences used for PlaceSearchRequest.

Declaration

                
C#

                

                    
Copy

                    

                

            
public IPlaceSearchPreference PlaceSearchPreferences { get; }
Property Value
Type Description
IPlaceSearchPreference
API Level: 3
View Source

Preferences

Gets and sets the search preferences.

Declaration

                
C#

                

                    
Copy

                    

                

            
public SearchPreference Preferences { get; set; }
Property Value
Type Description
SearchPreference
API Level: 3
View Source

Provider

Gets the name of the map service provider.

Declaration

                
C#

                

                    
Copy

                    

                

            
public string Provider { get; }
Property Value
Type Description
String
API Level: 3
View Source

ProviderKey

Gets and sets a string representing keys for the map service provider.

Declaration

                
C#

                

                    
Copy

                    

                

            
public string ProviderKey { get; set; }
Property Value
Type Description
String
Remarks

Typically, the provider key is issued by each maps provider after signing up for a plan in the website. Depending on the plan and its provider which you have signed, you might have to pay for the network traffic.

API Level: 3
View Source

Providers

Gets the list of available map service providers.

Declaration

                
C#

                

                    
Copy

                    

                

            
public static IEnumerable<string> Providers { get; }
Property Value
Type Description
IEnumerable<String>

The list of map service providers.
Exceptions
Type Condition
NotSupportedException

Thrown when the required feature is not supported.
UnauthorizedAccessException

Thrown when application does not have privilege to access this property.
API Level: 3
Privilege Level: public
Privilege: http://tizen.org/privilege/mapservice
View Source

RouteSearchPreferences

Gets the search preferences used for RouteSearchRequest.

Declaration

                
C#

                

                    
Copy

                    

                

            
public IRouteSearchPreference RouteSearchPreferences { get; }
Property Value
Type Description
IRouteSearchPreference
API Level: 3
View Source

UserConsented

Gets a user consent for the map service provider

Declaration

                
C#

                

                    
Copy

                    

                

            
public bool UserConsented { get; }
Property Value
Type Description
Boolean
API Level: 4
Privilege Level: public
Privilege: http://tizen.org/privilege/mapservice

Methods

View Source

CreateGeocodeRequest(String)

Creates a geocode search request for the given free-formed address string.

Declaration

                
C#

                

                    
Copy

                    

                

            
public GeocodeRequest CreateGeocodeRequest(string address)
Parameters
Type Name Description
String address

A string representing free-formed address.
Returns
Type Description
GeocodeRequest

Returns a GeocodeRequest object created with an address string.
API Level: 3
View Source

CreateGeocodeRequest(String, Area)

Creates a geocode search request for the given free-formed address string, within the specified boundary.

Declaration

                
C#

                

                    
Copy

                    

                

            
public GeocodeRequest CreateGeocodeRequest(string address, Area boundary)
Parameters
Type Name Description
String address

A string representing the free-formed address.
Area boundary

An instance of Area object representing the interested area.
Returns
Type Description
GeocodeRequest

Returns a GeocodeRequest object created with an address string and a specified boundary.
See Also
API Level: 3
View Source

CreateGeocodeRequest(PlaceAddress)

Creates a geocode search request for the given structured address.

Declaration

                
C#

                

                    
Copy

                    

                

            
public GeocodeRequest CreateGeocodeRequest(PlaceAddress address)
Parameters
Type Name Description
PlaceAddress address

A string representing the address of interest.
Returns
Type Description
GeocodeRequest

Returns a GeocodeRequest object created with a structured address.
API Level: 3
View Source

CreateMultiReverseGeocodeRequest(IEnumerable<Geocoordinates>)

Creates a reverse geocode search request for the given position coordinates list.

Declaration

                
C#

                

                    
Copy

                    

                

            
public MultiReverseGeocodeRequest CreateMultiReverseGeocodeRequest(IEnumerable<Geocoordinates> coordinates)
Parameters
Type Name Description
IEnumerable<Geocoordinates> coordinates

Coordinates list with [2 ~ 100] coordinates.
Returns
Type Description
MultiReverseGeocodeRequest

Returns a MultiReverseGeocodeRequest object created with a list of location coordinates.
API Level: 3
View Source

CreatePlaceSearchRequest(String, Area)

Creates a place search request for a free-formed address within the boundary.

Declaration

                
C#

                

                    
Copy

                    

                

            
public PlaceSearchRequest CreatePlaceSearchRequest(string address, Area boundary)
Parameters
Type Name Description
String address

A string which represents a free-formed address.
Area boundary

An instance of area object representing an area to search interested places.
Returns
Type Description
PlaceSearchRequest

Returns a PlaceSearchRequest object created with an address string and a specified boundary.
API Level: 3
View Source

CreatePlaceSearchRequest(Area)

Creates a place search request for places within a specified boundary.

Declaration

                
C#

                

                    
Copy

                    

                

            
public PlaceSearchRequest CreatePlaceSearchRequest(Area boundary)
Parameters
Type Name Description
Area boundary

An instance of Area object representing and area to search interested places.
Returns
Type Description
PlaceSearchRequest

Returns a PlaceSearchRequest object created with a specified boundary.
API Level: 3
View Source

CreatePlaceSearchRequest(Geocoordinates, Int32)

Creates a place search request for a specified search radius around a given coordinates position.

Declaration

                
C#

                

                    
Copy

                    

                

            
public PlaceSearchRequest CreatePlaceSearchRequest(Geocoordinates coordinates, int distance)
Parameters
Type Name Description
Geocoordinates coordinates

Geographical coordinates of the center.
Int32 distance

A double value representing the radius of an area to search places.
Returns
Type Description
PlaceSearchRequest

Returns a PlaceSearchRequest object created with the location coordinates and search radius.
API Level: 3
View Source

CreateReverseGeocodeRequest(Double, Double)

Creates a reverse geocode search request for the given latitude and longitude.

Declaration

                
C#

                

                    
Copy

                    

                

            
public ReverseGeocodeRequest CreateReverseGeocodeRequest(double latitude, double longitude)
Parameters
Type Name Description
Double latitude

Latitude of the interested place.
Double longitude

Longitude of the interested place.
Returns
Type Description
ReverseGeocodeRequest

Returns a ReverseGeocodeRequest object created with the location coordinates.
API Level: 3
View Source

CreateRouteSearchRequest(Geocoordinates, Geocoordinates)

Creates a route search request for the origin and destination points.

Declaration

                
C#

                

                    
Copy

                    

                

            
public RouteSearchRequest CreateRouteSearchRequest(Geocoordinates from, Geocoordinates to)
Parameters
Type Name Description
Geocoordinates from

Starting point.
Geocoordinates to

Destination.
Returns
Type Description
RouteSearchRequest

Returns a RouteSearchRequest object created with the origin and destination coordinates.
API Level: 3
View Source

Dispose()

Releases all the resources used by this object.

Declaration

                
C#

                

                    
Copy

                    

                

            
public void Dispose()
API Level: 3
View Source

Dispose(Boolean)

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

Declaration

                
C#

                

                    
Copy

                    

                

            
protected virtual void Dispose(bool disposing)
Parameters
Type Name Description
Boolean disposing

If true, managed and unmanaged resources can be disposed, otherwise only unmanaged resources can be disposed.
API Level: 3
View Source

Finalize()

Destroy the MapService object.

Declaration

                
C#

                

                    
Copy

                    

                

            
protected void Finalize()
View Source

IsSupported(ServiceData)

Checks if the maps service supports a given data feature.

Declaration

                
C#

                

                    
Copy

                    

                

            
public bool IsSupported(ServiceData data)
Parameters
Type Name Description
ServiceData data

Data feature to check.
Returns
Type Description
Boolean

Returns true if the maps service supports a data feature, otherwise false.
Exceptions
Type Condition
NotSupportedException

Thrown when the required feature is not supported.
UnauthorizedAccessException

Thrown when application does not have some privilege to access this method.
API Level: 3
Privilege Level: public
Privilege: http://tizen.org/privilege/mapservice
View Source

IsSupported(ServiceRequestType)

Checks if the maps service supports the given request.

Declaration

                
C#

                

                    
Copy

                    

                

            
public bool IsSupported(ServiceRequestType type)
Parameters
Type Name Description
ServiceRequestType type

Request type to check
Returns
Type Description
Boolean

Returns true if the maps service supports a request, otherwise false.
Exceptions
Type Condition
NotSupportedException

Thrown when the required feature is not supported.
UnauthorizedAccessException

Thrown when application does not have some privilege to access this method.
API Level: 3
Privilege Level: public
Privilege: http://tizen.org/privilege/mapservice
View Source

RequestUserConsent()

Gets the user's consent to use maps data.

Declaration

                
C#

                

                    
Copy

                    

                

            
public Task<bool> RequestUserConsent()
Returns
Type Description
Task<Boolean>

Returns true if user agreed that the application can use maps data, otherwise false.
Exceptions
Type Condition
NotSupportedException

Thrown when the required feature is not supported.
UnauthorizedAccessException

Thrown when application does not have some privilege to access this method.
API Level: 4
Privilege Level: public
Privilege: http://tizen.org/privilege/mapservice

Implements