Modify documentation of APIs
[platform/core/csapi/tizenfx.git] / src / Tizen.Maps / Tizen.Maps / ServiceRequestType.cs
1 /*
2  * Copyright (c) 2016 Samsung Electronics Co., Ltd All Rights Reserved
3  *
4  * Licensed under the Apache License, Version 2.0 (the License);
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an AS IS BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16
17 namespace Tizen.Maps
18 {
19     /// <summary>
20     /// Service Requests available in the Maps Service
21     /// </summary>
22     public enum ServiceRequestType
23     {
24         /// <summary>
25         /// Indicates that service request to get position <see cref="Geocoordinates"/> for a given free-formed address string is allowed.
26         /// </summary>
27         Geocode = Interop.ServiceType.Geocode,
28         /// <summary>
29         /// Indicates that service request to get position <see cref="Geocoordinates"/>  for a given address, within the specified bounding <see cref="Area"/>, is allowed.
30         /// </summary>
31         GeocodeInsideArea = Interop.ServiceType.GeocodeInsideArea,
32         /// <summary>
33         /// Indicates that service request to get position <see cref="Geocoordinates"/> for a given <see cref="PlaceAddress"/> is allowed.
34         /// </summary>
35         GeocodeByStructuredAddress = Interop.ServiceType.GeocodeByStructuredAddress,
36         /// <summary>
37         /// Indicates that service request to get <see cref="PlaceAddress"/> for a given <see cref="Geocoordinates"/> is allowed.
38         /// </summary>
39         ReverseGeocode = Interop.ServiceType.ReverseGeocode,
40         /// <summary>
41         /// Indicates that service request to get <see cref="PlaceAddress"/> for a given <see cref="GeocoordinatesList"/> is allowed.
42         /// </summary>
43         MultiReverseGeocode = Interop.ServiceType.MultiReverseGeocode,
44
45         /// <summary>
46         /// Indicates that service request to query <see cref="Place"/> information for a given <see cref="Geocoordinates"/> is allowed.
47         /// </summary>
48         SearchPlace = Interop.ServiceType.SearchPlace,
49         /// <summary>
50         /// Indicates that service request to query <see cref="Place"/> information for a given <see cref="Area"/> is allowed.
51         /// </summary>
52         SearchPlaceByArea = Interop.ServiceType.SearchPlaceByArea,
53         /// <summary>
54         /// Indicates that service request to query <see cref="Place"/> information for a given free-formed address string is allowed.
55         /// </summary>
56         SearchPlaceByAddress = Interop.ServiceType.SearchPlaceByAddress,
57         /// <summary>
58         /// Indicates that service request to query <see cref="Place"/> information list for all places in a given <see cref="Area"/> is allowed.
59         /// </summary>
60         SearchPlaceList = Interop.ServiceType.SearchPlaceList,
61         /// <summary>
62         /// Indicates that service request to get detailed <see cref="Place"/> information for a given <see cref="PlaceUrl"/> is allowed.
63         /// </summary>
64         SearchGetPlaceDetails = Interop.ServiceType.SearchGetPlaceDetails,
65
66         /// <summary>
67         /// Indicates that service request to query <see cref="Route"/> information from a given origin <see cref="Geocoordinates"/> and destination <see cref="Geocoordinates"/> is allowed.
68         /// </summary>
69         SearchRoute = Interop.ServiceType.SearchRoute,
70         /// <summary>
71         /// Indicates that service request to query <see cref="Route"/> information passing through specified way-points <see cref="GeocoordinatesList"/> is allowed.
72         /// </summary>
73         SearchRouteWithWaypoints = Interop.ServiceType.SearchRouteWaypoints,
74
75         /// <summary>
76         /// Indicates that map view service is allowed.
77         /// </summary>
78         View = Interop.ServiceType.View,
79         /// <summary>
80         /// Indicates that map view snapshot service is allowed.
81         /// </summary>
82         ViewSnapshot = Interop.ServiceType.ViewSnapshot,
83     }
84 }