[API Docs] Capacitor Background Geolocation v 6.1.3
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Subscription

Object returned by BackgroundGeolocation event-listeners. Subscription contains just a single method remove, used for removing an event-listener.

In the past, one would remove event-listeners using the now-deprectated BackgroundGeolocation.removeListener.

Removing an event-listener:
example
// Event-listeners return a Subscription instance, containing a .remove() method.
const subscription = BackgroundGeolocation.onLocation(location => {
  console.log("[onLocation] ", location);
});
.
.
.
// Later, to remove the event-listener:
subscription.remove();

One might typically manage a collection of Subscription instances

example
import BackgroundGeolocation, {
  Location,
  Subscription
} from ...

// Your custom Collection of Subscription instances.
const SUBSCRIPTIONS = [];

// Your custom method to push a Subscription instance.
const subscribe = (subscription:Subscription) => {
  SUBSCRIPTIONS.push(subscription);
}

// Your custom method to interate your SUBSCRIPTIONS and .remove each.
const unsubscribe = () => {
  SUBSCRIPTIONS.forEach((subscription:Subscription) => subscription.remove());
}

const initBackgroundGeolocation = () {
  // Create event-listeners as usual, feeding the returned Subscription into
  // your custom  subscribe() method.
  subscribe(BackgroundGeolocation.onLocation((location:Location) => {
    console.log('[onLocation]', location);
  });

  subscribe(BackgroundGeolocation.onMotionChange((location:Location) => {
    console.log('[onMotionChange]', location);
  });

  subscribe(BackgroundGeolocation.onEnabledChange((enabled:boolean) => {
    console.log('[onEnabledChange]', enabled);
  });
}

const onDestroyView = () => {
  // Call your custom unsubscribe method
  unsubscribe();
}

Hierarchy

  • Subscription

Index

Methods

Methods

remove

  • remove(): void

  • Removes a BackgroundGeolocation event-listener.

    example
    // Event-listeners return a Subscription instance, containing a .remove() method.
const onLocationSubscription = BackgroundGeolocation.onLocation(location => {
  console.log("[onLocation] ", location);
});

const onGeofenceSubscription = BackgroundGeolocation.onGeofence(event => {
  console.log("[onGeofence] ", event);
});
.
.
.
// Later, removing event-listeners.
onLocationSubscription.remove();
onGeofenceSubscription.remove();

    Returns void

Generated using TypeDoc