• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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 * @file
18 * @kit LocationKit
19 */
20
21import type FenceExtensionContext from './@ohos.app.ability.FenceExtensionContext';
22import geoLocationManager from './@ohos.geoLocationManager';
23
24/**
25 * Class of fence extension ability.
26 *
27 * @syscap SystemCapability.Location.Location.Geofence
28 * @since 14
29 */
30export default class FenceExtensionAbility {
31  /**
32   * Indicates fence extension context.
33   *
34   * @type { FenceExtensionContext }
35   * @syscap SystemCapability.Location.Location.Geofence
36   * @since 14
37   */
38  context: FenceExtensionContext;
39
40  /**
41   * Called back when geofence status is change.
42   *
43   * @param { geoLocationManager.GeofenceTransition } transition - Geofence transition status
44   * @param { Record<string, string> } additions - Indicates additional information
45   * @syscap SystemCapability.Location.Location.Geofence
46   * @since 14
47   */
48  onFenceStatusChange(transition: geoLocationManager.GeofenceTransition, additions: Record<string, string>): void;
49
50  /**
51   * Called back before a fence extension is destroyed.
52   *
53   * @syscap SystemCapability.Location.Location.Geofence
54   * @since 14
55   */
56  onDestroy(): void;
57}