Class GeoXpCore

constructor

• new GeoXpCore(
      config: GeoXpCoreConfig,
      options?: { autoRun?: boolean; throwErrors?: boolean },
  ): GeoXpCore

• Constructor for GeoXpCore Class

  Parameters

  • config: GeoXpCoreConfig

    GeoXpCore configuration
  • Optionaloptions: { autoRun?: boolean; throwErrors?: boolean }

    Options for GeoXpCore

    • OptionalautoRun?: boolean

      Whether to run patterns right away. Default is true

    • OptionalthrowErrors?: boolean

      Whether errors should be throw or not. Throw is default behavior

  Returns GeoXpCore

  GeoXpCore singleton instance

OptionalsetStoredVisitedSpots

getStoredVisitedSpots

• get getStoredVisitedSpots(): undefined | GetVisitedSpotsCallback

• Returns undefined | GetVisitedSpotsCallback

• set getStoredVisitedSpots(callback: GetVisitedSpotsCallback): void

• Function to get stored visited spots

  Parameters

  • callback: GetVisitedSpotsCallback

    A function that:

    • takes the ID of pattern for storage retrieval as argument
    • returns an array of stored visited spotIds for a specific pattern
    • it can also return a Promise if using an asyncronous storage method (e.g. Node fs)
    • it returns undefined is no entries correspond to the provided ID

  Returns void

running

• get running(): boolean

• Whether the patterns are currently running

  Returns boolean

canForceSpot

• canForceSpot(_spot: string | GeoXpSpot): null | string

• Checks if manual mode is available Rules are gps accuracy is really bad not too far away

  Parameters

  • _spot: string | GeoXpSpot

    spot to force

  Returns null | string

  error

disablePattern

• disablePattern(patternId: string): void

• Disables specific pattern

  Parameters

  • patternId: string

    pattern id to disable

  Returns void

enablePattern

• enablePattern(patternId: string): void

• Enables specific pattern

  Parameters

  • patternId: string

    pattern id to enable

  Returns void

forceSpot

• forceSpot(_spot: string | GeoXpSpot): null | string

• Forces spot activation Forces other spots deactivation unless overlapping

  Parameters

  • _spot: string | GeoXpSpot

    spot to force

  Returns null | string

  error

geolocationUpdate

• geolocationUpdate(location: GeoXpGeolocation): void

• Geolocation update This method triggers the spot analysis

  Phased analysys

  1. deactivate spots
  2. activate new spots, prefetch incoming spots
  3. activate spots to replay or visited
  4. set first time inside (to avoid event duplication)

  Parameters

  • location: GeoXpGeolocation

    geolocation update

  Returns void

getSpot

• getSpot(_spot: string | GeoXpSpot): undefined | GeoXpSpot

• Gets spot by id

  Parameters

  • _spot: string | GeoXpSpot

    spot to find

  Returns undefined | GeoXpSpot

  spot

getVisitedSpots

• getVisitedSpots(patternId?: string): undefined | string[]

• Gets visited spots for a given pattern If not pattern is provided, gets visited spots for all patterns

  Parameters

  • OptionalpatternId: string

    pattern id

  Returns undefined | string[]

  array of visited spots

hasActiveSpots

• hasActiveSpots(): boolean

• Checks to see if there's any active spots

  Returns boolean

  at least one spot is active

off

• off<K>(
      eventName: Key<K, GeoXpCoreEvent>,
      listener: Listener<K, GeoXpCoreEvent>,
  ): void

• Event wrapper off

  Type Parameters

  • K

  Parameters

  • eventName: Key<K, GeoXpCoreEvent>

    'incoming' | 'active' | 'inactive' | 'visited' | 'last' | 'complete'
  • listener: Listener<K, GeoXpCoreEvent>

    event listener

  Returns void

on

• on<K>(
      eventName: Key<K, GeoXpCoreEvent>,
      listener: Listener<K, GeoXpCoreEvent>,
  ): void

• Event wrapper on

  Type Parameters

  • K

  Parameters

  • eventName: Key<K, GeoXpCoreEvent>

    'incoming' | 'active' | 'inactive' | 'visited' | 'last' | 'complete'
  • listener: Listener<K, GeoXpCoreEvent>

    event listener

  Returns void

once

• once<K>(
      eventName: Key<K, GeoXpCoreEvent>,
      listener: Listener<K, GeoXpCoreEvent>,
  ): void

• Event wrapper once

  Type Parameters

  • K

  Parameters

  • eventName: Key<K, GeoXpCoreEvent>

    'incoming' | 'active' | 'inactive' | 'visited' | 'last' | 'complete'
  • listener: Listener<K, GeoXpCoreEvent>

    event listener

  Returns void

pause

• pause(): void

• Marks the instance as paused, so no spots are activated

  Returns void

reload

• reload(config: GeoXpCoreConfig): void

• Loads a new config

  Parameters

  • config: GeoXpCoreConfig

    GeoXpCore configuration

  Returns void

replaySpot

• replaySpot(_spot?: string | GeoXpSpot): void

• Marks spots as unvisited. If no spot id provided, marks all inside spots as unvisited

  Parameters

  • Optional_spot: string | GeoXpSpot

    spot to unvisit

  Returns void

run

• run(): void

• Marks the instance as running, so spots are activated

  Returns void

spotActivated

• spotActivated(_spot: string | GeoXpSpot): void

• Confirm spot content activation

  Parameters

  • _spot: string | GeoXpSpot

    activated spot

  Returns void

spotDeactivated

• spotDeactivated(_spot: string | GeoXpSpot): void

• Confirm spot deactivation (either stopped or finished)

  Parameters

  • _spot: string | GeoXpSpot

    deactivated spot

  Returns void

stopForcedSpot

• stopForcedSpot(): void

• Stops and removes any forced spot

  Returns void