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 ISafeLocationCallback.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 Defines the callback for the safe location module.
51 *
52 * Before enabling the safe location feature, you need to register this callback to report the device has obtained the safe location information.
53 * For details, see {@link ISafeLocationInterface}.
54 *
55 * @since 5.0
56 */
57[callback] interface ISafeLocationCallback {
58    /**
59     * @brief Called to report the safe location request result.
60     *
61     *
62     *
63     * @param ret Indicates the result of getting safe location.
64     *
65     * @return Returns <b>0</b> if the callback is invoked successfully.
66     * @return Returns a negative value if the callback fails to be invoked.
67     *
68     @since 5.0
69     */
70    OnGetSafeLocationCb([in] int res);
71}
72/** @} */
73