Class Location

GPS/GNSS Service

Hierarchy

ComponentAbstract
- Location

Index

Constructors

constructor

new Location(obniz, info): Location
Parameters
- obniz: any
- info: any
Returns Location
Overrides ComponentAbstract.constructor
- Defined in src/obniz/libs/embeds/location.ts:37

Properties

Obniz

Obniz: Obniz

obniz to be used

`Optional` onupdate

onupdate?: ObnizLocationUpdateCallback

Simple Example

// Javascript Example
obniz.location.start();
obniz.location.onupdate = function(metrix) {
  console.log(metrix)
}

timeout

timeout: number = ...

Rsponse waiting timeout in milliseconds

`Static` prefixed

prefixed: string | boolean

Methods

addListener

addListener(event, fn, context?): Location
Parameters
- event: string
- fn: ListenerFn
- Optional context: any
Returns Location
Inherited from ComponentAbstract.addListener
- Defined in node_modules/eventemitter3/index.d.ts:33

emit

emit(event, ...args): boolean
Calls each of the listeners registered for a given event.
Parameters
- event: string
- Rest ...args: any[]
Returns boolean
Inherited from ComponentAbstract.emit
- Defined in node_modules/eventemitter3/index.d.ts:27

eventNames

eventNames(): string[]
Return an array listing the events for which the emitter has registered listeners.

Returns string[]
Inherited from ComponentAbstract.eventNames
- Defined in node_modules/eventemitter3/index.d.ts:12

fastValidate

fastValidate(commandUri, json): boolean
Parameters
- commandUri: any
- json: any
Returns boolean
Inherited from ComponentAbstract.fastValidate
- Defined in src/obniz/libs/ComponentAbstact.ts:91

listenerCount

listenerCount(event): number
Return the number of listeners listening to a given event.
Parameters
- event: string
Returns number
Inherited from ComponentAbstract.listenerCount
- Defined in node_modules/eventemitter3/index.d.ts:22

listeners

listeners(event): ListenerFn[]
Return the listeners registered for a given event.
Parameters
- event: string
Returns ListenerFn[]
Inherited from ComponentAbstract.listeners
- Defined in node_modules/eventemitter3/index.d.ts:17

notifyFromObniz

notifyFromObniz(json): void
Parameters
- json: any
Returns void
Inherited from ComponentAbstract.notifyFromObniz
- Defined in src/obniz/libs/ComponentAbstact.ts:53

off

off(event, fn?, context?, once?): Location
Parameters
- event: string
- Optional fn: ListenerFn
- Optional context: any
- Optional once: boolean
Returns Location
Inherited from ComponentAbstract.off
- Defined in node_modules/eventemitter3/index.d.ts:44

on

on(event, fn, context?): Location
Add a listener for a given event.
Parameters
- event: string
- fn: ListenerFn
- Optional context: any
Returns Location
Inherited from ComponentAbstract.on
- Defined in node_modules/eventemitter3/index.d.ts:32

once

once(event, fn, context?): Location
Add a one-time listener for a given event.
Parameters
- event: string
- fn: ListenerFn
- Optional context: any
Returns Location
Inherited from ComponentAbstract.once
- Defined in node_modules/eventemitter3/index.d.ts:38

removeAllListeners

removeAllListeners(event?): Location
Remove all listeners, or those of the specified event.
Parameters
- Optional event: string
Returns Location
Inherited from ComponentAbstract.removeAllListeners
- Defined in node_modules/eventemitter3/index.d.ts:49

removeListener

removeListener(event, fn?, context?, once?): Location
Remove the listeners of a given event.
Parameters
- event: string
- Optional fn: ListenerFn
- Optional context: any
- Optional once: boolean
Returns Location
Inherited from ComponentAbstract.removeListener
- Defined in node_modules/eventemitter3/index.d.ts:43

schemaBasePath

schemaBasePath(): string
Returns string
Overrides ComponentAbstract.schemaBasePath
- Defined in src/obniz/libs/embeds/location.ts:50

start

start(): void
Returns void
- Defined in src/obniz/libs/embeds/location.ts:54

validate

validate(commandUri, json): MultiResult
Parameters
- commandUri: any
- json: any
Returns MultiResult
Inherited from ComponentAbstract.validate
- Defined in src/obniz/libs/ComponentAbstact.ts:86

Class Location

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

obniz: any

info: any

Returns Location

Properties

Obniz

Optional onupdate

timeout

Static prefixed

Methods

addListener

Parameters

event: string

fn: ListenerFn

Optional context: any

Returns Location

emit

Parameters

event: string

Rest ...args: any[]

Returns boolean

eventNames

Returns string[]

fastValidate

Parameters

commandUri: any

json: any

Returns boolean

listenerCount

Parameters

event: string

Returns number

listeners

Parameters

event: string

Returns ListenerFn[]

notifyFromObniz

Parameters

json: any

Returns void

off

Parameters

event: string

Optional fn: ListenerFn

Optional context: any

Optional once: boolean

Returns Location

on

Parameters

event: string

fn: ListenerFn

Optional context: any

Returns Location

once

Parameters

event: string

fn: ListenerFn

Optional context: any

Returns Location

removeAllListeners

Parameters

Optional event: string

Returns Location

removeListener

Parameters

event: string

Optional fn: ListenerFn

Optional context: any

Optional once: boolean

Returns Location

schemaBasePath

Returns string

`Optional` onupdate

`Static` prefixed

`Optional` context: any

`Rest` ...args: any[]

`Optional` fn: ListenerFn

`Optional` context: any

`Optional` once: boolean

`Optional` context: any

`Optional` context: any

`Optional` event: string

`Optional` fn: ListenerFn

`Optional` context: any

`Optional` once: boolean