Modify api documentation
[platform/core/csapi/tizenfx.git] / src / Tizen.Location / Tizen.Location / LocatorHelper.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 using System;
18
19 namespace Tizen.Location
20 {
21     public static class LocatorHelper
22     {
23         /// <summary>
24         /// Checks if the specified geographical positioning type is supported or not.
25         /// </summary>
26         /// <param name="locationType"> The back-end positioning method to be used for LBS.</param>
27         /// <returns>Returns a boolean value indicating whether or not the specified method is supported.</returns>
28         public static bool IsSupportedType(LocationType locationType)
29         {
30             bool status = Interop.LocatorHelper.IsSupported((int)locationType);
31             Log.Info(Globals.LogTag, "Checking if the Location Manager type is supported ," + status);
32             return status;
33         }
34
35         /// <summary>
36         /// Checks if the specified geographical positioning type is enabled or not.
37         /// </summary>
38         /// <param name="locationType"> The back-end positioning method to be used for LBS.</param>
39         /// <returns>Returns a boolean value indicating whether or not the specified method is supported.</returns>
40         /// <exception cref="InvalidOperationException">Thrown when the operation is invalid for the current state.</exception>
41         /// <exception cref="ArgumentException">Thrown when an invalid argument is used.</exception>
42         /// <exception cref="NotSupportedException">Thrown when the location is not supported.</exception>
43         public static bool IsEnabledType(LocationType locationType)
44         {
45             Log.Info(Globals.LogTag, "Checking if the Location Manager type is Enabled");
46             bool status;
47             int ret = Interop.LocatorHelper.IsEnabled((int)locationType, out status);
48             if (((LocationError)ret != LocationError.None))
49             {
50                 Log.Error(Globals.LogTag, "Error Checking the Location Manager type is Enabled," + (LocationError)ret);
51                 throw LocationErrorFactory.ThrowLocationException(ret);
52             }
53             return status;
54         }
55     }
56 }