Perimeter

Simple cross platform geofencing for Capacitor

Getting Started

[Build Sample App] [https://github.com/neatorobito/PicketFence]

API Reference

• checkPermissions()
• requestPermissions()
• requestForegroundPermissions()
• requestBackgroundPermissions()
• addFence(...)
• removeFence(...)
• removeAllFences()
• addListener(string, ...)
• removeAllListeners()
• getActiveFences()
• Interfaces

checkPermissions()

checkPermissions() => Promise<LocationPermissionStatus>

Get the current foreground and background location permissions status.

Returns: Promise<LocationPermissionStatus>

---

requestPermissions()

requestPermissions() => Promise<LocationPermissionStatus>

Prompt the user for access to their precise location at all times on iOS 12 or Android 9 and earlier. Attempting to use this method on a later release will fail and display an console error.

Returns: Promise<LocationPermissionStatus>

---

requestForegroundPermissions()

requestForegroundPermissions() => Promise<LocationPermissionStatus>

Prompt the user for access to their location while the app is running in the foreground. For use on iOS 13 or on Android 10 and later.

Returns: Promise<LocationPermissionStatus>

---

requestBackgroundPermissions()

requestBackgroundPermissions() => Promise<LocationPermissionStatus>

Prompt the user for access to their location while the app is running in the background. For use on iOS 13 or on Android 10 and later.

Returns: Promise<LocationPermissionStatus>

---

addFence(...)

addFence(newFence: Fence) => Promise<void>

Request that system monitor a region defined by the newFence object. When the user enters or exits your fence, you will receive a fenceEvent.

Param	Type
newFence	Fence

---

removeFence(...)

removeFence(options: { fenceUID: string; }) => Promise<void>

Stop monitoring for a fence associated with the specified identifier. If the fence cannot be found, this method will fail and display an console error.

Param	Type
options	{ fenceUID: string; }

---

removeAllFences()

removeAllFences() => Promise<void>

Stop monitoring for all active fences; stop all background location activity performed by this module.

---

addListener(string, ...)

addListener(eventName: string, listenerFunc: (event: any) => void) => Promise<PluginListenerHandle>

Add an event listener for geofencing or platform specific error events.

Param	Type
eventName	string
listenerFunc	(event: any) => void

Returns: Promise<PluginListenerHandle>

---

removeAllListeners()

removeAllListeners() => Promise<void>

Remove all geofencing event listeners

---

getActiveFences()

getActiveFences() => Promise<{ data: Array<Fence>; }>

Returns a list of all regions currently being monitored.

Returns: Promise<{ data: Fence[]; }>

---

Interfaces

PluginListenerHandle

Prop	Type
remove	() => Promise<void>

Array

Prop	Type	Description
length	number	Gets or sets the length of the array. This is a number one higher than the highest index in the array.

Method	Signature	Description
toString	() => string	Returns a string representation of an array.
toLocaleString	() => string	Returns a string representation of an array. The elements are converted to string using their toLocalString methods.
pop	() => T | undefined	Removes the last element from an array and returns it. If the array is empty, undefined is returned and the array is not modified.
push	(...items: T[]) => number	Appends new elements to the end of an array, and returns the new length of the array.
concat	(...items: ConcatArray<T>[]) => T[]	Combines two or more arrays. This method returns a new array without modifying any existing arrays.
concat	(...items: (T | ConcatArray<T>)[]) => T[]	Combines two or more arrays. This method returns a new array without modifying any existing arrays.
join	(separator?: string | undefined) => string	Adds all the elements of an array into a string, separated by the specified separator string.
reverse	() => T[]	Reverses the elements in an array in place. This method mutates the array and returns a reference to the same array.
shift	() => T | undefined	Removes the first element from an array and returns it. If the array is empty, undefined is returned and the array is not modified.
slice	(start?: number | undefined, end?: number | undefined) => T[]	Returns a copy of a section of an array. For both start and end, a negative index can be used to indicate an offset from the end of the array. For example, -2 refers to the second to last element of the array.
sort	(compareFn?: ((a: T, b: T) => number) | undefined) => this	Sorts an array in place. This method mutates the array and returns a reference to the same array.
splice	(start: number, deleteCount?: number | undefined) => T[]	Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.
splice	(start: number, deleteCount: number, ...items: T[]) => T[]	Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.
unshift	(...items: T[]) => number	Inserts new elements at the start of an array, and returns the new length of the array.
indexOf	(searchElement: T, fromIndex?: number | undefined) => number	Returns the index of the first occurrence of a value in an array, or -1 if it is not present.
lastIndexOf	(searchElement: T, fromIndex?: number | undefined) => number	Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.
every	<S extends T>(predicate: (value: T, index: number, array: T[]) => value is S, thisArg?: any) => this is S[]	Determines whether all the members of an array satisfy the specified test.
every	(predicate: (value: T, index: number, array: T[]) => unknown, thisArg?: any) => boolean	Determines whether all the members of an array satisfy the specified test.
some	(predicate: (value: T, index: number, array: T[]) => unknown, thisArg?: any) => boolean	Determines whether the specified callback function returns true for any element of an array.
forEach	(callbackfn: (value: T, index: number, array: T[]) => void, thisArg?: any) => void	Performs the specified action for each element in an array.
map	<U>(callbackfn: (value: T, index: number, array: T[]) => U, thisArg?: any) => U[]	Calls a defined callback function on each element of an array, and returns an array that contains the results.
filter	<S extends T>(predicate: (value: T, index: number, array: T[]) => value is S, thisArg?: any) => S[]	Returns the elements of an array that meet the condition specified in a callback function.
filter	(predicate: (value: T, index: number, array: T[]) => unknown, thisArg?: any) => T[]	Returns the elements of an array that meet the condition specified in a callback function.
reduce	(callbackfn: (previousValue: T, currentValue: T, currentIndex: number, array: T[]) => T) => T	Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
reduce	(callbackfn: (previousValue: T, currentValue: T, currentIndex: number, array: T[]) => T, initialValue: T) => T
reduce	<U>(callbackfn: (previousValue: U, currentValue: T, currentIndex: number, array: T[]) => U, initialValue: U) => U	Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
reduceRight	(callbackfn: (previousValue: T, currentValue: T, currentIndex: number, array: T[]) => T) => T	Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.
reduceRight	(callbackfn: (previousValue: T, currentValue: T, currentIndex: number, array: T[]) => T, initialValue: T) => T
reduceRight	<U>(callbackfn: (previousValue: U, currentValue: T, currentIndex: number, array: T[]) => U, initialValue: U) => U	Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

ConcatArray

Prop	Type
length	number

Method	Signature
join	(separator?: string | undefined) => string
slice	(start?: number | undefined, end?: number | undefined) => T[]

Copyright Mark Raymond Jr., All Rights Reserved. 2024