1/*
2 * Copyright (c) 2024 Huawei Device Co., Ltd.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at
6 *
7 *     http://www.apache.org/licenses/LICENSE-2.0
8 *
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
14 */
15
16 /**
17 * @addtogroup HdiLpfenceSafeLocation
18 * @{
19 *
20 * @brief Provides safe location APIs for the safe location service.
21 *
22 * @since 5.0
23 * @version 1.0
24 */
25
26/**
27 * @file ISafeLocationInterface.idl
28 *
29 * @brief Declares the callbacks for the safe location module.
30 *
31 * @since 5.0
32 * @version 1.0
33 */
34
35/**
36 * @brief Declares the path of the safe location module interface package.
37 *
38 * @since 5.0
39 */
40package ohos.hdi.location.lpfence.safe_location.v1_0;
41
42/**
43 * @brief Imports data types of the safe location module.
44 *
45 * @since 5.0
46 */
47import ohos.hdi.location.lpfence.safe_location.v1_0.SafeLocationTypes;
48
49/**
50 * @brief Imports callbacks of the safe location module.
51 *
52 * @since 5.0
53 */
54import ohos.hdi.location.lpfence.safe_location.v1_0.ISafeLocationCallback;
55
56/**
57 * @brief Provides APIs for basic safe location operations.
58 *
59 * You can use the APIs to register or unregister a callback
60 */
61interface ISafeLocationInterface {
62    /**
63     * @brief Registers a callback.
64     *
65     * Before enabling the safe location feature, you need to register a callback to report the device has obtained the safe location information.
66     *
67     * @param callbackObj Indicates the callback to register, which needs to be registered only once. For details, see {@link ISafeLocCallback}.
68     *
69     * @return Returns <b>0</b> if the operation is successful.
70     * @return Returns a negative value if the operation fails.
71     *
72     * @since 5.0
73     * @version 1.0
74     */
75    RegisterSafeLocationCallback([in] ISafeLocationCallback callbackObj);
76
77    /**
78     * @brief Unregisters a callback.
79     *
80     * When the safe location feature is no longer required or the registered callback needs to be changed, you need to unregister the callback.
81     *
82     * @param callbackObj Indicates the callback to unregister, which needs to be unregistered only once. For details, see {@link ISafeLocationCallback}.
83     *
84     * @return Returns <b>0</b> if the operation is successful.
85     * @return Returns a negative value if the operation fails.
86     *
87     * @since 5.0
88     * @version 1.0
89     */
90    UnregisterSafeLocationCallback([in] ISafeLocationCallback callbackObj);
91
92    /**
93     * @brief Obtains the latest safe location information.
94     *
95     *
96     * @return Returns <b>0</b> if the operation is successful.
97     * @return Returns a negative value if the operation fails.
98     *
99     * @since 5.0
100     * @version 1.0
101     */
102    GetSafeLocationSwitch([in] int mode);
103}
104/** @} */
105